mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-03-27 05:53:02 +00:00
e4be201f20
With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: Ia53c2c34436c7a72080602f5699e82d20f677b8b
93 lines
2.6 KiB
Python
93 lines
2.6 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: server_info
|
|
short_description: Retrieve information about one or more compute instances
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Retrieve information about server instances from OpenStack.
|
|
- This module was called C(os_server_facts) before Ansible 2.9, returning C(ansible_facts).
|
|
Note that the M(openstack.cloud.server_info) module no longer returns C(ansible_facts)!
|
|
notes:
|
|
- The result contains a list of servers.
|
|
options:
|
|
server:
|
|
description:
|
|
- restrict results to servers with names or UUID matching
|
|
this glob expression (e.g., <web*>).
|
|
type: str
|
|
detailed:
|
|
description:
|
|
- when true, return additional detail about servers at the expense
|
|
of additional API calls.
|
|
type: bool
|
|
default: 'no'
|
|
filters:
|
|
description:
|
|
- restrict results to servers matching a dictionary of
|
|
filters
|
|
type: dict
|
|
all_projects:
|
|
description:
|
|
- Whether to list servers from all projects or just the current auth
|
|
scoped project.
|
|
type: bool
|
|
default: 'no'
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Gather information about all servers named <web*> that are in an active state:
|
|
- openstack.cloud.server_info:
|
|
cloud: rax-dfw
|
|
server: web*
|
|
filters:
|
|
vm_state: active
|
|
register: result
|
|
- debug:
|
|
msg: "{{ result.openstack_servers }}"
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class ServerInfoModule(OpenStackModule):
|
|
|
|
deprecated_names = ('os_server_info', 'openstack.cloud.os_server_info')
|
|
|
|
argument_spec = dict(
|
|
server=dict(required=False),
|
|
detailed=dict(required=False, type='bool', default=False),
|
|
filters=dict(required=False, type='dict', default=None),
|
|
all_projects=dict(required=False, type='bool', default=False),
|
|
)
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
|
|
kwargs = self.check_versioned(
|
|
detailed=self.params['detailed'],
|
|
filters=self.params['filters'],
|
|
all_projects=self.params['all_projects']
|
|
)
|
|
if self.params['server']:
|
|
kwargs['name_or_id'] = self.params['server']
|
|
openstack_servers = self.conn.search_servers(**kwargs)
|
|
self.exit(changed=False, openstack_servers=openstack_servers)
|
|
|
|
|
|
def main():
|
|
module = ServerInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|