solace.pubsub_plus.solace_cloud_account_gather_facts (1.12.2) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: solace.pubsub_plus
      version: 1.12.2

Description

Retrieves service info (facts) about all services available in the Solace Cloud Account.

For example, use to retrieve the SEMP endpoints for a Solace Cloud service as inputs for other modules.

Inputs

    
timeout:
    default: 60
    description: Connection timeout in seconds for the http request or overall call interaction
      timeout for Solace Cloud API.
    required: false
    type: int

account_name:
    aliases:
    - name
    description:
    - The host specified in the inventory. Represents the Solace Cloud Account.
    - 'Note: Only used internally in the playbooks, so you can choose whichever name makes
      sense in your case.'
    required: true
    type: str

return_format:
    choices:
    - dict
    - list
    description:
    - The format of the returned JSON. Either as a JSON object or a JSON array.
    - 'Note: Use ''dict'' when you want to access the facts in a playbook by account_name
      (i.e. ''inventory_hostname'') directly.'
    - 'Note: Use ''list'' when you want to iterate over each service in your playbook.'
    required: true
    type: str

validate_certs:
    default: true
    description: Flag to switch validation of client certificates on/off when using a
      secure connection.
    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:
    aliases:
    - api_token
    description:
    - The API Token.
    - Generate using Solace Cloud console with the appropriate permissions for the operations
      you want to enable.
    required: true
    type: str

Outputs

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
solace_cloud_account:
  description: Contains the info from the Solace Cloud account by {_account_name_}.
  returned: success
  sample:
    solace_cloud_account:
      _account_name_:
        data_centers:
          _data_center_id_1_: '... data center info ...'
          _data_center_id_2_: '... data center info ...'
        services:
          _service_name_1_: '... service info  ...'
          _service_name_2_: '... service info  ...'
  type: dict

See also

• solace_cloud_get_facts
• solace_get_facts