os_server_facts returns facts about multiple servers
have `os_server_facts` call `list_servers` rather than `get_server`, and treat the `server` parameter as a wildcard pattern. This permits one to get facts on a single server: - os_server: server: webserver1 On mutiple servers: - os_server: server: webserver* Or on all servers: - os_server: Introduces a `detailed` parameter to request additional server details at the cost of additional API calls.
This commit is contained in:
parent
caf6115f43
commit
35240830f6
1 changed files with 39 additions and 18 deletions
|
@ -15,6 +15,8 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with this software. If not, see <http://www.gnu.org/licenses/>.
|
# along with this software. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import fnmatch
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import shade
|
import shade
|
||||||
from shade import meta
|
from shade import meta
|
||||||
|
@ -25,34 +27,47 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: os_server_facts
|
module: os_server_facts
|
||||||
short_description: Retrieve facts about a compute instance
|
short_description: Retrieve facts about one or more compute instances
|
||||||
extends_documentation_fragment: openstack
|
|
||||||
version_added: "2.0"
|
version_added: "2.0"
|
||||||
author: "Monty Taylor (@emonty)"
|
|
||||||
description:
|
description:
|
||||||
- Retrieve facts about a server instance from OpenStack.
|
- Retrieve facts about server instances from OpenStack.
|
||||||
notes:
|
notes:
|
||||||
- Facts are placed in the C(openstack) variable.
|
- This module creates a new top-level C(openstack_servers) fact, which
|
||||||
|
contains a list of servers.
|
||||||
|
requirements:
|
||||||
|
- "python >= 2.6"
|
||||||
|
- "shade"
|
||||||
options:
|
options:
|
||||||
server:
|
server:
|
||||||
description:
|
description:
|
||||||
- Name or ID of the instance
|
- restrict results to servers with names matching
|
||||||
required: true
|
this glob expression (e.g., C<web*>).
|
||||||
requirements: ["shade"]
|
required: false
|
||||||
|
default: None
|
||||||
|
detailed:
|
||||||
|
description:
|
||||||
|
- when true, return additional detail about servers at the expense
|
||||||
|
of additional API calls.
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
extends_documentation_fragment: openstack
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
# Gather facts about a previously created server named vm1
|
# Gather facts about all servers named C<web*>:
|
||||||
- os_server_facts:
|
- os_server_facts:
|
||||||
cloud: rax-dfw
|
cloud: rax-dfw
|
||||||
server: vm1
|
server: web*
|
||||||
- debug: var=openstack
|
- debug:
|
||||||
|
var: openstack_servers
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
|
|
||||||
argument_spec = openstack_full_argument_spec(
|
argument_spec = openstack_full_argument_spec(
|
||||||
server=dict(required=True),
|
server=dict(required=False),
|
||||||
|
detailed=dict(required=False, type='bool'),
|
||||||
)
|
)
|
||||||
module_kwargs = openstack_module_kwargs()
|
module_kwargs = openstack_module_kwargs()
|
||||||
module = AnsibleModule(argument_spec, **module_kwargs)
|
module = AnsibleModule(argument_spec, **module_kwargs)
|
||||||
|
@ -62,10 +77,16 @@ def main():
|
||||||
|
|
||||||
try:
|
try:
|
||||||
cloud = shade.openstack_cloud(**module.params)
|
cloud = shade.openstack_cloud(**module.params)
|
||||||
server = cloud.get_server(module.params['server'])
|
openstack_servers = cloud.list_servers(
|
||||||
hostvars = dict(openstack=meta.get_hostvars_from_server(
|
detailed=module.params['detailed'])
|
||||||
cloud, server))
|
|
||||||
module.exit_json(changed=False, ansible_facts=hostvars)
|
if module.params['server']:
|
||||||
|
# filter servers by name
|
||||||
|
pattern = module.params['server']
|
||||||
|
openstack_servers = [server for server in openstack_servers
|
||||||
|
if fnmatch.fnmatch(server['name'], pattern)]
|
||||||
|
module.exit_json(changed=False, ansible_facts=dict(
|
||||||
|
openstack_servers=openstack_servers))
|
||||||
|
|
||||||
except shade.OpenStackCloudException as e:
|
except shade.OpenStackCloudException as e:
|
||||||
module.fail_json(msg=e.message)
|
module.fail_json(msg=e.message)
|
||||||
|
@ -73,5 +94,5 @@ def main():
|
||||||
# this is magic, see lib/ansible/module_common.py
|
# this is magic, see lib/ansible/module_common.py
|
||||||
from ansible.module_utils.basic import *
|
from ansible.module_utils.basic import *
|
||||||
from ansible.module_utils.openstack import *
|
from ansible.module_utils.openstack import *
|
||||||
main()
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
|
|
Loading…
Reference in a new issue