solace_bridge – bridge

Configure a Bridge object. Allows addition, removal and update of a Bridge Object in an idempotent manner.

Before configuring a Bridge object, consider deleting it first. This ensures that the set-up starts completely fresh. For example, adding a new remote vpn to a bridge will not result in any existing remote vpns to be deleted. This could mean that invalid remote vpns are ‘hanging around’, causing the bridge to be not operational.

Examples

hosts: all
gather_facts: no
any_errors_fatal: true
collections:
- solace.pubsub_plus
module_defaults:
  solace_bridge:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
    msg_vpn: "{{ vpn }}"
tasks:
- name: delete the bridge first  - starting fresh
  solace_bridge:
    name: foo
    state: absent

- name: add
  solace_bridge:
    name: foo
    bridge_virtual_router: auto
    settings:
      enabled: false
      remoteAuthenticationBasicClientUsername: default
      remoteAuthenticationBasicPassword: password
      remoteAuthenticationScheme: basic

- name: update
  solace_bridge:
    name: foo
    bridge_virtual_router: auto
    settings:
      enabled: true

- name: remove
  solace_bridge:
    name: foo
    bridge_virtual_router: auto
    state: absent

Notes

Note

See Also

See also

Parameters

bridge_virtual_router (optional)

The virtual router. Maps to ‘bridgeVirtualRouter’ in the API.

type: str
default: auto
choices: primary, backup, auto
aliases: virtual_router
host (optional)

Hostname of Solace Broker.

type: str
default: localhost
msg_vpn (required)

The message vpn.

type: str
name (required)

The bridge name. Maps to ‘bridgeName’ in the API.

type: str
password (optional)

Administrator password for Solace Broker.

type: str
default: admin
port (optional)

Management port of Solace Broker.

type: int
default: 8080
reverse_proxy (optional)

Use a reverse proxy / api gateway. Note: Experimental. Not permitted for Solace Cloud API.

type: dict
headers (optional)

Additional headers to add to the http call. Example: ‘apiKey: {my-api-key}’.

type: dict
x-asc-module (optional)

Flag for the module to add the header ‘x-asc-module:{module-name}’ to the http call with it’s module name.

type: bool
default: False
x-asc-module-op (optional)

Flag for the module to add the header ‘x-asc-module-op:{module operation}’ to the http call with the module’s operation.

type: bool
default: False
query_params (optional)

Additional query paramters to add to the URL. Example: ‘apiCode: {my-api-code}’.

type: dict
semp_base_path (optional)

Base path prepended to all SEMP calls. Example: ‘my/base/path’. Resulting URL will be: http(s)://{host}:{port}/{semp_base_path}/{module-semp-call-path}

type: str
use_basic_auth (optional)

Flag to use basic authentication in the http(s) call or not. Uses ‘username’/’password’.

type: bool
default: False
secure_connection (optional)

If true, use https rather than http.

type: bool
default: False
sempv2_settings (optional)

JSON dictionary of additional configuration for the SEMP V2 API. See Reference documentation.

type: dict
aliases: settings
state (optional)

Target state.

type: str
default: present
choices: present, absent
timeout (optional)

Connection timeout in seconds for the http request.

type: int
default: 10
username (optional)

Administrator username for Solace Broker.

type: str
default: admin
validate_certs (optional)

Flag to switch validation of client certificates on/off when using a secure connection.

type: bool
default: True
x_broker (optional)

Custom HTTP header with the broker virtual router id, if using a SEMPv2 Proxy/agent infrastructure.

type: str

Return Values

response

The response from the Solace Sempv2 request.

returned: success
type: dict
msg

The response from the HTTP call in case of error.

returned: error
type: dict
rc

Return code. rc=0 on success, rc=1 on error.

returned: always
type: int
sample:
  {
  "error": {
    "rc": 1
  },
  "success": {
    "rc": 0
  }
}