solace_get_bridge_remote_subscriptions – get list of remote subscriptions on a bridge

Get a list of Remote Subscription objects configured on a Bridge.

Implements the config and monitor API.

Retrieves all objects that match the criteria defined in the ‘where’ clause and returns the fields defined in the ‘select’ parameter.

Examples

- name: get list of remote subscriptions
  solace_get_bridge_remote_subscriptions:
    api: config
    bridge_name: foo
    bridge_virtual_router: auto

- name: get list of remote subscriptions
  solace_get_bridge_remote_subscriptions:
    api: monitor
    bridge_name: foo
    bridge_virtual_router: auto

Notes

Note

See Also

See also

Parameters

api (optional)

The API the query should run against.

type: str
default: config
choices: config, monitor
bridge_name (required)

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

type: str
bridge_virtual_router (optional)

The bridge 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
page_count (optional)

The number of results to be fetched from broker in single call. Note: always returns the entire result set by following the cursor.

type: int
default: 100
password (optional)

Administrator password for Solace Broker.

type: str
default: admin
port (optional)

Management port of Solace Broker.

type: int
default: 8080
query_params (optional)

The query parameters.

type: dict
default: {}
select (optional)

Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter.

type: list
default: []
where (optional)

Include in the response only objects where certain conditions are true. See the the documentation for the where parameter.

Note: URL encoded automatically, you can safely use ‘/, <, <=, >, >=, != .. ‘

type: list
default: []
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
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

result_list

The list of objects found containing requested fields. Payload depends on API called.

returned: success
type: list
result_list_count

Number of items in result_list.

returned: success
type: int
rc

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

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

The response from the HTTP call in case of error.

returned: error
type: dict