/ home / solace / solace.pubsub_plus / 1.12.2 / module / solace_get_bridge_remote_subscriptions

solace.pubsub_plus.solace_get_bridge_remote_subscriptions (1.12.2) — module

get list of remote subscriptions on a bridge

Authors: Ricardo Gomez-Ulmke (@rjgu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install solace.pubsub_plus:==1.12.2

Add to requirements.yml

  collections:
    - name: solace.pubsub_plus
      version: 1.12.2

Description

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.

Usage examples

Scanned by Steampunk Spotter


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

Scanned by Steampunk Spotter

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

Inputs

    
api:
    choices:
    - config
    - monitor
    default: config
    description: The API the query should run against.
    required: false
    type: str

host:
    default: localhost
    description: Hostname of Solace Broker.
    required: false
    type: str

port:
    default: 8080
    description: Management port of Solace Broker.
    required: false
    type: int

msg_vpn:
    description: The message vpn.
    required: true
    type: str

timeout:
    default: 10
    description: Connection timeout in seconds for the http request.
    required: false
    type: int

password:
    default: admin
    description: Administrator password for Solace Broker.
    required: false
    type: str

username:
    default: admin
    description: Administrator username for Solace Broker.
    required: false
    type: str

x_broker:
    description: Custom HTTP header with the broker virtual router id, if using a SEMPv2
      Proxy/agent infrastructure.
    required: false
    type: str

page_count:
    default: 100
    description: 'The number of results to be fetched from broker in single call. Note:
      always returns the entire result set by following the cursor.'
    required: false
    type: int

bridge_name:
    description: The bridge. Maps to 'bridgeName' in the API.
    required: true
    type: str

query_params:
    default: {}
    description: The query parameters.
    required: false
    suboptions:
      select:
        default: []
        description: 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.
        elements: str
        type: list
      where:
        default: []
        description:
        - 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 ''/, <, <=, >, >=, != ..
          '''
        elements: str
        type: list
    type: dict

reverse_proxy:
    description: 'Use a reverse proxy / api gateway. Note: B(Experimental. Not permitted
      for Solace Cloud API).'
    required: false
    suboptions:
      headers:
        description: 'Additional headers to add to the http call. Example: ''apiKey: {my-api-key}''.'
        required: false
        suboptions:
          x-asc-module:
            default: false
            description: Flag for the module to add the header 'x-asc-module:{module-name}'
              to the http call with it's module name.
            required: false
            type: bool
          x-asc-module-op:
            default: false
            description: Flag for the module to add the header 'x-asc-module-op:{module
              operation}' to the http call with the module's operation.
            required: false
            type: bool
        type: dict
      query_params:
        description: 'Additional query paramters to add to the URL. Example: ''apiCode:
          {my-api-code}''.'
        required: false
        type: dict
      semp_base_path:
        description: '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}'
        required: false
        type: str
      use_basic_auth:
        default: false
        description: Flag to use basic authentication in the http(s) call or not. Uses
          'username'/'password'.
        required: false
        type: bool
    type: dict

validate_certs:
    default: true
    description: Flag to switch validation of client certificates on/off when using a
      secure connection.
    required: false
    type: bool

secure_connection:
    default: false
    description: If true, use https rather than http.
    required: false
    type: bool

bridge_virtual_router:
    aliases:
    - virtual_router
    choices:
    - primary
    - backup
    - auto
    default: auto
    description: The bridge virtual router. Maps to 'bridgeVirtualRouter' in the API.
    required: false
    type: str

Outputs

msg:
  description: The response from the HTTP call in case of error.
  returned: error
  type: dict
rc:
  description: Return code. rc=0 on success, rc=1 on error.
  returned: always
  sample:
    error:
      rc: 1
    success:
      rc: 0
  type: int
result_list:
  description: The list of objects found containing requested fields. Payload depends
    on API called.
  elements: dict
  returned: success
  type: list
result_list_count:
  description: Number of items in result_list.
  returned: success
  type: int

See also