os_server_info – Retrieve information about one or more compute instances¶
Synopsis¶
- Retrieve information about server instances from OpenStack.
- This module was called
os_server_facts
before Ansible 2.9, returningansible_facts
. Note that the os_server_info module no longer returnsansible_facts
!
Aliases: os_server_facts
Requirements¶
The below requirements are needed on the host that executes this module.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7
Parameters¶
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¶
# Gather information about all servers named <web*> that are in an active state:
- os_server_info:
cloud: rax-dfw
server: web*
filters:
vm_state: active
register: result
- debug:
msg: "{{ result.openstack_servers }}"
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Monty (@emonty)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.