solace_dmr_cluster_link_remote_address – remote address for dmr cluster link

Allows addition, removal and configuration of Remote Address Objects on a DRM Cluster Link.

Examples

hosts: all
gather_facts: no
any_errors_fatal: true
collections:
- solace.pubsub_plus
module_defaults:
  solace_dmr_cluster_link_remote_address:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
tasks:
  - name: Remove 'remoteNode' DMR Link Remote address
    solace_dmr_cluster_link_remote_address:
      name: 192.168.0.34
      remote_node_name: remoteNode
      dmr_cluster_name: foo
      state: absent

  - name: Add 'remoteNode' DMR Link Remote address
    solace_dmr_cluster_link_remote_address:
      name: 192.168.0.34
      remote_node_name: remoteNode
      dmr_cluster_name: foo
      state: present

Notes

Note

• Module Sempv2 Config: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/config/index.html#/dmrCluster/createDmrClusterLinkRemoteAddress

• Sempv2 Config Reference: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/config/index.html#/

• Sempv2 Monitor Reference: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/monitor/index.html#/

• Sempv2 Action Reference: https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/action/index.html#/

See Also

See also

• solace_dmr_cluster – dmr cluster

• solace_dmr_cluster_link – link on a dmr cluster

• solace_get_dmr_cluster_link_remote_addresses – get list of remote addresses on a dmr cluster link

Parameters

dmr_cluster_name (required)

The name of the DMR cluster. Maps to ‘dmrClusterName’ in the API.

type: str

host (optional)

Hostname of Solace Broker.

type: str

default: localhost

name (required)

The FQDN or IP address (and optional port) of the remote node. Maps to ‘remoteAddress’ in the API.

type: str

aliases: remote_address

password (optional)

Administrator password for Solace Broker.

type: str

default: admin

port (optional)

Management port of Solace Broker.

type: int

default: 8080

remote_node_name (required)

The name of the remote node. Maps to ‘remoteNodeName’ in the API.

type: str

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
  }
}