as_instance_info

updated: None

as_instance_info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

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

New in version 0.8.0: of opentelekomcloud.cloud

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 Choices/Defaults 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
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
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
    Choices:
  • initializing
  • normal
  • error
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.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
lifecycle_state
string
    Choices:
  • inservice
  • pending
  • removing
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.
limit
integer
Default:
20
Specifies the number of query records.
The value range is 0 to 100.
region_name
string
Name of the region.
scaling_group
string / required
Specifies the AS group name or ID.
start_number
integer
Default:
0
Specifies the start line number.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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 Returned Description
scaling_instances
complex
success
Query Instances in an AS Group based on search criteria.
 
limit
integer
success
Specifies the maximum number of resources to be queried.

Sample:
10
 
scaling_group_instances
complex
success
Specifies details about the instances in the AS group.
   
create_time
string
success
Specifies the time when the instance is added to the AS group.
The time format complies with UTC.

Sample:
2021-02-23T06:47:33Z
   
health_status
string
success
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
   
instance_id
string
success
Specifies the instance ID.

Sample:
b25c1589-c96c-465b-9fef-d06540d1945c
   
instance_name
string
success
Specifies the instance name.

Sample:
discuz_3D210808
   
lifecycle_state
string
success
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
   
protect_from_scaling_down
boolean
success
Specifies the instance protection status.

Sample:
true
   
scaling_configuration_id
string
success
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
   
scaling_configuration_name
string
success
Specifies the AS configuration name.

Sample:
test_config
   
scaling_group_id
string
success
Specifies the ID of the AS group to which the instance belongs.

Sample:
e5d27f5c-dd76-4a61-b4bc-a67c5686719a
   
scaling_group_name
string
success
Specifies the name of the AS group to which the instance belongs.
Supports fuzzy search.

Sample:
test_group_name
 
start_number
integer
success
Specifies the start line number.

Sample:
10
 
total_number
integer
success
Specifies the total number of query records.

Sample:
1


Authors

  • Irina Pereiaslavskaia (@irina-pereiaslavskaia)

updated: None