solace / solace.pubsub_plus / 1.12.2 / module / solace_get_available check if broker semp & spool is available Authors: Ricardo Gomez-Ulmke (@rjgu) preview | supported by communitysolace.pubsub_plus.solace_get_available (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
Check if broker service is reachable via SEMP and if the spool is ready. Calls "GET /about/api" and creates/deletes a test queue.
To check, evaluate the return ``is_available``. ``rc==1`` is only set in case of a module or API error.
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 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 wait_timeout_seconds: default: 600 description: - Number of seconds to run tests for SEMP and spool availability. Polls every 5 seconds for `wait_timeout_seconds` until service is available. - Value must be `> 0`. required: false type: int
is_available: description: Flag indicating whether broker service is available. returned: always type: bool is_semp_available: description: Flag indicating whether broker service SEMP is available. returned: always type: bool is_spool_available: description: Flag indicating whether broker service spool is available. returned: always type: bool msg: description: Details in case of an 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