solace.pubsub_plus.solace_get_queues (1.0.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: solace.pubsub_plus
      version: 1.0.0

Description

Get a list of Queue objects.

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.

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

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

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

Outputs

result_list:
  description: The list of objects found containing requested fields. Results differ
    based on the api called.
  elements: dict
  returned: success
  sample:
    config_api:
      result_list:
      - eventMsgSpoolUsageThreshold:
          clearPercent: 50
          setPercent: 60
        queueName: foo
    monitor_api:
      result_list:
      - accessType: exclusive
        alreadyBoundBindFailureCount: 0
        averageRxByteRate: 0
        averageRxMsgRate: 0
        averageTxByteRate: 0
        averageTxMsgRate: 0
        bindRequestCount: 0
        bindSuccessCount: 0
        bindTimeForwardingMode: store-and-forward
        clientProfileDeniedDiscardedMsgCount: 0
        consumerAckPropagationEnabled: true
        createdByManagement: true
        deadMsgQueue: '#DEAD_MSG_QUEUE'
        deletedMsgCount: 0
        destinationGroupErrorDiscardedMsgCount: 0
        disabledBindFailureCount: 0
        disabledDiscardedMsgCount: 0
        durable: true
        egressEnabled: true
        eventBindCountThreshold:
          clearPercent: 60
          setPercent: 80
  type: list
result_list_count:
  description: Number of items in result_list.
  returned: success
  sample:
    result_list_count: 2
  type: int

See also

• solace_queue