opentelekomcloud.cloud.as_instance_info module -- Query Instances in an AS Group.

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: opentelekomcloud.cloud.as_instance_info.

New in opentelekomcloud.cloud 0.8.0

Synopsis

• This interface is used to query Instances in an AS Group based on search criteria.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.6

• openstacksdk >= 0.36.0

Parameters

Parameter	Comments
api_timeout integer	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.
auth dictionary	Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or 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.
auth_type string	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 auth parameter should be updated accordingly.
ca_cert aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
cloud any	Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
health_status string	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. Choices: "initializing" "normal" "error"
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
lifecycle_state string	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. Choices: "inservice" "pending" "removing"
limit integer	Specifies the number of query records. The value range is 0 to 100. Default: 20
region_name string	Name of the region.
scaling_group string / required	Specifies the AS group name or ID.
sdk_log_level string	Log level of the OpenStackSDK Choices: "ERROR" "WARN" ← (default) "INFO" "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
start_number integer	Specifies the start line number. Default: 0
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: false true
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (default)

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
scaling_instances complex	Query Instances in an AS Group based on search criteria. Returned: success
limit integer	Specifies the maximum number of resources to be queried. Returned: success Sample: 10
scaling_group_instances complex	Specifies details about the instances in the AS group. Returned: success
create_time string	Specifies the time when the instance is added to the AS group. The time format complies with UTC. Returned: success Sample: "2021-02-23T06:47:33Z"
health_status string	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. Returned: success Sample: "NORMAL"
instance_id string	Specifies the instance ID. Returned: success Sample: "b25c1589-c96c-465b-9fef-d06540d1945c"
instance_name string	Specifies the instance name. Returned: success Sample: "discuz_3D210808"
lifecycle_state string	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. Returned: success Sample: "INSERVICE"
protect_from_scaling_down boolean	Specifies the instance protection status. Returned: success Sample: true
scaling_configuration_id string	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. Returned: success Sample: "ca3dcd84-d197-4c4f-af2a-cf8ba39696ac"
scaling_configuration_name string	Specifies the AS configuration name. Returned: success Sample: "test_config"
scaling_group_id string	Specifies the ID of the AS group to which the instance belongs. Returned: success Sample: "e5d27f5c-dd76-4a61-b4bc-a67c5686719a"
scaling_group_name string	Specifies the name of the AS group to which the instance belongs. Supports fuzzy search. Returned: success Sample: "test_group_name"
start_number integer	Specifies the start line number. Returned: success Sample: 10
total_number integer	Specifies the total number of query records. Returned: success Sample: 1

Authors

• Irina Pereiaslavskaia (@irina-pereiaslavskaia)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b