openstack.cloud.server_info module – Retrieve information about one or more compute instances

Note

This module is part of the openstack.cloud collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. 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 openstack.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: openstack.cloud.server_info.

Synopsis

  • Retrieve information about server instances from OpenStack.

Requirements

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

Parameters

Parameter

Comments

all_projects

boolean

Whether to list servers from all projects or just the current auth scoped project.

Choices:

  • false ← (default)

  • true

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, user_domain_name or 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.

detailed

boolean

when true, return additional detail about servers at the expense of additional API calls.

Choices:

  • false ← (default)

  • true

filters

dictionary

Used for further filtering of results. Either a string containing a JMESPath expression or a dictionary of meta data. Elements of the latter may, themselves, be dictionaries.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

name

aliases: server

string

restrict results to servers with names or UUID matching this glob expression such as web*.

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "INFO" ← (default)

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

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 true.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

Notes

Note

  • The result contains a list of servers.

  • 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

- name: Gather information about all 'web*' servers in active state
  openstack.cloud.server_info:
    cloud: devstack
    name: web*
    filters:
      vm_state: active

- name: Filter servers with nested dictionaries
  openstack.cloud.server_info:
    cloud: devstack
    filters:
      metadata:
        key1: value1
        key2: value2

Return Values

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

Key

Description

servers

list / elements=dictionary

List of servers matching the filters

Returned: always

access_ipv4

string

IPv4 address that should be used to access this server. May be automatically set by the provider.

Returned: success

access_ipv6

string

IPv6 address that should be used to access this server. May be automatically set by the provider.

Returned: success

addresses

dictionary

A dictionary of addresses this server can be accessed through. The dictionary contains keys such as ‘private’ and ‘public’, each containing a list of dictionaries for addresses of that type. The addresses are contained in a dictionary with keys ‘addr’ and ‘version’, which is either 4 or 6 depending on the protocol of the IP address.

Returned: success

admin_password

string

When a server is first created, it provides the administrator password.

Returned: success

attached_volumes

list / elements=string

A list of an attached volumes. Each item in the list contains at least an ‘id’ key to identify the specific volumes.

Returned: success

availability_zone

string

The name of the availability zone this server is a part of.

Returned: success

block_device_mapping

string

Enables fine grained control of the block device mapping for an instance. This is typically used for booting servers from volumes.

Returned: success

compute_host

string

The name of the compute host on which this instance is running. Appears in the response for administrative users only.

Returned: success

config_drive

string

Indicates whether or not a config drive was used for this server.

Returned: success

created_at

string

Timestamp of when the server was created.

Returned: success

description

string

The description of the server. Before microversion 2.19 this was set to the server name.

Returned: success

disk_config

string

The disk configuration. Either AUTO or MANUAL.

Returned: success

flavor

dictionary

The flavor property as returned from server.

Returned: success

flavor_id

string

The flavor reference, as a ID or full URL, for the flavor to use for this server.

Returned: success

has_config_drive

string

Indicates whether a configuration drive enables metadata injection. Not all cloud providers enable this feature.

Returned: success

host_id

string

An ID representing the host of this server.

Returned: success

host_status

string

The host status.

Returned: success

hostname

string

The hostname set on the instance when it is booted. By default, it appears in the response for administrative users only.

Returned: success

hypervisor_hostname

string

The hypervisor host name. Appears in the response for administrative users only.

Returned: success

id

string

ID of the server.

Returned: success

image

dictionary

The image property as returned from server.

Returned: success

image_id

string

The image reference, as a ID or full URL, for the image to use for this server.

Returned: success

instance_name

string

The instance name. The Compute API generates the instance name from the instance name template. Appears in the response for administrative users only.

Returned: success

is_locked

boolean

The locked status of the server

Returned: success

kernel_id

string

The UUID of the kernel image when using an AMI. Will be null if not. By default, it appears in the response for administrative users only.

Returned: success

key_name

string

The name of an associated keypair.

Returned: success

launch_index

integer

When servers are launched via multiple create, this is the sequence in which the servers were launched. By default, it appears in the response for administrative users only.

Returned: success

launched_at

string

The timestamp when the server was launched.

Returned: success

string

A list of dictionaries holding links relevant to this server.

Returned: success

max_count

string

The maximum number of servers to create.

Returned: success

metadata

dictionary

List of tag strings.

Returned: success

min_count

string

The minimum number of servers to create.

Returned: success

name

string

Name of the server

Returned: success

networks

string

A networks object. Required parameter when there are multiple networks defined for the tenant. When you do not specify the networks parameter, the server attaches to the only network created for the current tenant.

Returned: success

power_state

string

The power state of this server.

Returned: success

progress

integer

While the server is building, this value represents the percentage of completion. Once it is completed, it will be 100.

Returned: success

project_id

string

The ID of the project this server is associated with.

Returned: success

ramdisk_id

string

The UUID of the ramdisk image when using an AMI. Will be null if not. By default, it appears in the response for administrative users only.

Returned: success

reservation_id

string

The reservation id for the server. This is an id that can be useful in tracking groups of servers created with multiple create, that will all have the same reservation_id. By default, it appears in the response for administrative users only.

Returned: success

root_device_name

string

The root device name for the instance By default, it appears in the response for administrative users only.

Returned: success

scheduler_hints

dictionary

The dictionary of data to send to the scheduler.

Returned: success

security_groups

list / elements=dictionary

A list of applicable security groups. Each group contains keys for: description, name, id, and rules.

Returned: success

server_groups

list / elements=string

The UUIDs of the server groups to which the server belongs. Currently this can contain at most one entry.

Returned: success

status

string

The state this server is in. Valid values include ‘ACTIVE’, ‘BUILDING’, ‘DELETED’, ‘ERROR’, ‘HARD_REBOOT’, ‘PASSWORD’, ‘PAUSED’, ‘REBOOT’, ‘REBUILD’, ‘RESCUED’, ‘RESIZED’, ‘REVERT_RESIZE’, ‘SHUTOFF’, ‘SOFT_DELETED’, ‘STOPPED’, ‘SUSPENDED’, ‘UNKNOWN’, or ‘VERIFY_RESIZE’.

Returned: success

tags

list / elements=string

A list of associated tags.

Returned: success

task_state

string

The task state of this server.

Returned: success

terminated_at

string

The timestamp when the server was terminated (if it has been).

Returned: success

trusted_image_certificates

list / elements=string

A list of trusted certificate IDs, that were used during image signature verification to verify the signing certificate.

Returned: success

updated_at

string

Timestamp of when this server was last updated.

Returned: success

user_data

string

Configuration information or scripts to use upon launch. Base64 encoded.

Returned: success

user_id

string

The ID of the owners of this server.

Returned: success

vm_state

string

The VM state of this server.

Returned: success

volumes

list / elements=string

Same as attached_volumes.

Returned: success

Authors

  • OpenStack Ansible SIG