Try SpotterQuery Instances in an AS Group.
| "added in version" 0.8.0 of opentelekomcloud.cloud"
Authors: Irina Pereiaslavskaia (@irina-pereiaslavskaia)
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2
collections:
- name: opentelekomcloud.cloud
version: 0.14.2This interface is used to query Instances in an AS Group based on search criteria.
# Get Instances in an AS Group
- opentelekomcloud.cloud.as_instance_info:
scaling_group: "89af599d-a8ab-4c29-a063-0b719ed77e8e"
register: as_instances
# Get Instances in an AS Group
- opentelekomcloud.cloud.as_instance_info:
scaling_group: "test_group"
start_number: 2
limit: 20
register: as_instances
# Get Instances in an AS Group
- opentelekomcloud.cloud.as_instance_info:
scaling_group: "89af599d-a8ab-4c29-a063-0b719ed77e8e"
start_number: 2
limit: 20
register: as_instances
auth:
description:
- Dictionary containing auth information as needed by the cloud's auth plugin strategy.
For the default I(password) plugin, this would contain I(auth_url), I(username),
I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
param will need to contain whatever parameters that auth plugin requires. This parameter
is not needed if a named cloud is provided or OpenStack OS_* environment variables
are present.
type: dict
wait:
default: true
description:
- Should ansible wait until the requested resource is complete.
type: bool
cloud:
description:
- Named cloud or cloud config to operate against. If I(cloud) is a string, it references
a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
provided or if OpenStack OS_* environment variables are present. If I(cloud) is
a dict, it contains a complete cloud configuration like would be in a section of
clouds.yaml.
type: raw
limit:
default: 20
description:
- Specifies the number of query records.
- The value range is 0 to 100.
type: int
ca_cert:
aliases:
- cacert
description:
- A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
type: str
timeout:
default: 180
description:
- How long should ansible wait for the requested resource.
type: int
auth_type:
description:
- Name of the auth plugin to use. If the cloud uses something other than password
authentication, the name of the plugin should be indicated here and the contents
of the I(auth) parameter should be updated accordingly.
type: str
interface:
aliases:
- endpoint_type
choices:
- admin
- internal
- public
default: public
description:
- Endpoint URL type to fetch from the service catalog.
type: str
client_key:
aliases:
- key
description:
- A path to a client key to use as part of the SSL transaction.
type: str
api_timeout:
description:
- How long should the socket layer wait before timing out for API calls. If this is
omitted, nothing will be passed to the requests library.
type: int
client_cert:
aliases:
- cert
description:
- A path to a client certificate to use as part of the SSL transaction.
type: str
region_name:
description:
- Name of the region.
type: str
sdk_log_path:
description:
- Path to the logfile of the OpenStackSDK. If empty no log is written
type: str
start_number:
default: 0
description:
- Specifies the start line number.
type: int
health_status:
choices:
- initializing
- normal
- error
description:
- Specifies the instance health status.
- If it set to INITIALIZING, the instance is initializing.
- If it set to NORMAL, the instance is normal.
- If it set to ERROR, the instance is abnormal.
type: str
scaling_group:
description:
- Specifies the AS group name or ID.
required: true
type: str
sdk_log_level:
choices:
- ERROR
- WARN
- INFO
- DEBUG
default: WARN
description: Log level of the OpenStackSDK
type: str
validate_certs:
aliases:
- verify
description:
- Whether or not SSL API requests should be verified.
- Before Ansible 2.3 this defaulted to C(yes).
type: bool
lifecycle_state:
choices:
- inservice
- pending
- removing
description:
- Specifies the instance lifecycle status in the AS group.
- If it set to INSERVICE, the instance is enabled.
- If it set to PENDING, the instance is being added to the AS group.
- If it set to REMOVING, the instance is being removed from the AS group.
type: str
scaling_instances:
contains:
limit:
description:
- Specifies the maximum number of resources to be queried.
sample: 10
type: int
scaling_group_instances:
contains:
create_time:
description:
- Specifies the time when the instance is added to the AS group.
- The time format complies with UTC.
sample: '2021-02-23T06:47:33Z'
type: str
health_status:
description:
- Specifies the instance health status.
- INITIALIZING means that the instance is being initialized.
- NORMAL means that the instance is functional.
- ERROR means that the instance is faulty.
sample: NORMAL
type: str
instance_id:
description:
- Specifies the instance ID.
sample: b25c1589-c96c-465b-9fef-d06540d1945c
type: str
instance_name:
description:
- Specifies the instance name.
sample: discuz_3D210808
type: str
lifecycle_state:
description:
- Specifies the instance lifecycle status in the AS group.
- INSERVICE means that the instance is enabled.
- PENDING means that the instance is being added to the AS group.
- REMOVING means that the instance is being removed from the AS group.
sample: INSERVICE
type: str
protect_from_scaling_down:
description:
- Specifies the instance protection status.
sample: 'true'
type: bool
scaling_configuration_id:
description:
- Specifies the AS configuration ID.
- If the returned value is not empty, the instance is an ECS
automatically created in a scaling action.
- If the returned value is empty, the instance is an ECS manually
added to the AS group.
sample: ca3dcd84-d197-4c4f-af2a-cf8ba39696ac
type: str
scaling_configuration_name:
description:
- Specifies the AS configuration name.
sample: test_config
type: str
scaling_group_id:
description:
- Specifies the ID of the AS group to which the instance belongs.
sample: e5d27f5c-dd76-4a61-b4bc-a67c5686719a
type: str
scaling_group_name:
description:
- Specifies the name of the AS group to which the instance belongs.
- Supports fuzzy search.
sample: test_group_name
type: str
description:
- Specifies details about the instances in the AS group.
returned: success
type: complex
start_number:
description:
- Specifies the start line number.
sample: 10
type: int
total_number:
description:
- Specifies the total number of query records.
sample: 1
type: int
description:
- Query Instances in an AS Group based on search criteria.
returned: success
type: complex