solace_get_magic_queues – get ‘magic’ queues

Get a list of ‘magic’ Queue Objects that are generated by the Broker, e.g. #mqtt, #rdp, …

Examples

hosts: all
gather_facts: no
any_errors_fatal: true
collections:
- solace.pubsub_plus
module_defaults:
  solace_mqtt_session:
    host: "{{ sempv2_host }}"
    port: "{{ sempv2_port }}"
    secure_connection: "{{ sempv2_is_secure_connection }}"
    username: "{{ sempv2_username }}"
    password: "{{ sempv2_password }}"
    timeout: "{{ sempv2_timeout }}"
    msg_vpn: "{{ vpn }}"
  solace_get_magic_queues:
    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: create mqtt session
  solace_mqtt_session:
    name: foo
    state: present

- name: get magic queue
  solace_get_magic_queues:
    where_name: "#mqtt/*"
  register: result

- name: print result
  debug:
    msg:
    - "{{ result.result_list }}"
    - "{{ result.result_list_count }}"

Notes

Note

See Also

See also

Parameters

host (optional)

Hostname of Solace Broker.

type: str
default: localhost
msg_vpn (required)

The message vpn.

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
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
where_name (required)

Query for queue name. Maps to <name> in the API.

Examples: #mqtt/*, #rdp/*

type: str
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
sample:
  [
  {
    "info": {
      "access-type": "exclusive",
      "bind-count": "0",
      "current-spool-usage-in-mb": "0",
      "durable": "true",
      "egress-config-status": "Down",
      "egress-selector-present": "No",
      "high-water-mark-in-mb": "0",
      "ingress-config-status": "Down",
      "message-vpn": "default",
      "num-messages-spooled": "0",
      "topic-subscription-count": "3",
      "type": "Primary"
    },
    "name": "#mqtt/foo/180"
  }
]
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