solace / solace.pubsub_plus / 1.0.0 / module / solace_get_client_usernames get client usernames Authors: Ricardo Gomez-Ulmke (@rjgu) preview | supported by communitysolace.pubsub_plus.solace_get_client_usernames (1.0.0) — module
Install with ansible-galaxy collection install solace.pubsub_plus:==1.0.0
collections: - name: solace.pubsub_plus version: 1.0.0
Get a list of Client Username 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.
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
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