solace_cloud_get_services – get all services in Solace Cloud

Get a list of all services’ details in the Solace Cloud account.

Examples

hosts: all
gather_facts: no
any_errors_fatal: true
collections:
  - solace.pubsub_plus
tasks:
  - name: "solace_cloud_get_services"
    solace_cloud_get_services:
      api_token: "{{ api_token }}"
    register: result

  - set_fact:
      service_list: "{{ result.result_list }}"

  - name: "Loop: Get Service for all Services By serviceId"
    solace_cloud_get_service:
      api_token: "{{ api_token }}"
      service_id: "{{ service.serviceId }}"
    loop: "{{ service_list }}"
    loop_control:
      loop_var: service

Notes

Note

Module Solace Cloud API: https://docs.solace.com/Solace-Cloud/ght_use_rest_api_services.htm

Parameters

solace_cloud_api_token (required)

The API Token.

Generate using Solace Cloud console with the appropriate permissions for the operations you want to enable.

type: str

aliases: api_token

solace_cloud_home (optional)

The Solace Cloud home region.

type: str

choices: us, au, US, AU,

timeout (optional)

Connection timeout in seconds for the http request or overall call interaction timeout for Solace Cloud API.

type: int

default: 60

validate_certs (optional)

Flag to switch validation of client certificates on/off when using a secure connection.

type: bool

default: True

Return Values

result_list

The list of objects found containing requested fields. Results differ based on the api called.

returned: success

type: list

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