solace / solace.pubsub_plus / 1.12.2 / module / solace_gather_facts gather broker facts Authors: Ricardo Gomez-Ulmke (@rjgu) preview | supported by communitysolace.pubsub_plus.solace_gather_facts (1.12.2) — module
Install with ansible-galaxy collection install solace.pubsub_plus:==1.12.2
collections: - name: solace.pubsub_plus version: 1.12.2
Retrieve facts from the Solace broker and set 'ansible_facts.solace'. Call at the beginning of the playbook so all subsequent tasks can use '{{ ansible_facts.solace.<path-to-fact> }}' or M(solace_get_facts) module. Supports Solace Cloud and standalone brokers. Retrieves: service/broker info, about info, virtual router name, messaging endpoints, etc.
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 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 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 use_sempv1_also: default: true description: Use the SEMPV1 API to extract the virtual router name. If set to False, functions that require the virtual router name will throw an Error. required: false type: bool secure_connection: default: false description: If true, use https rather than http. required: false type: bool solace_cloud_home: choices: - us - au - US - AU - '' description: The Solace Cloud home region. required: false type: str solace_cloud_api_token: description: - The API Token. - Generate using Solace Cloud console with the appropriate permissions for the operations you want to enable. - Either both (solace_cloud_api_token AND solace_cloud_service_id) must be provided or none. required: false type: str solace_cloud_service_id: description: - The service id in Solace Cloud. - Click on the service in Solace Cloud - the service id is in the URL. - Either both (solace_cloud_api_token AND solace_cloud_service_id) must be provided or none. required: false type: str
ansible_facts: description: 'The facts as returned by the APIs. Element: ''solace''.' elements: dict returned: success sample: ansible_facts: solace: about: api: platform: VMR sempVersion: '2.17' user: globalAccessLevel: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER msgVpns: - accessLevel: read-write msgVpnName: default isSolaceCloud: false service_facts: info: various service/broker info type: dict 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