ansible-later/env_27/lib/python2.7/site-packages/ansible/modules/remote_management/oneview/oneview_logical_interconnect_group_facts.py
2019-04-11 13:00:36 +02:00

111 lines
3.0 KiB
Python

#!/usr/bin/python
# Copyright: (c) 2016-2017, Hewlett Packard Enterprise Development LP
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = '''
---
module: oneview_logical_interconnect_group_facts
short_description: Retrieve facts about one or more of the OneView Logical Interconnect Groups
description:
- Retrieve facts about one or more of the Logical Interconnect Groups from OneView
version_added: "2.5"
requirements:
- hpOneView >= 2.0.1
author:
- Felipe Bulsoni (@fgbulsoni)
- Thiago Miotto (@tmiotto)
- Adriane Cardozo (@adriane-cardozo)
options:
name:
description:
- Logical Interconnect Group name.
extends_documentation_fragment:
- oneview
- oneview.factsparams
'''
EXAMPLES = '''
- name: Gather facts about all Logical Interconnect Groups
oneview_logical_interconnect_group_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
- debug: var=logical_interconnect_groups
- name: Gather paginated, filtered and sorted facts about Logical Interconnect Groups
oneview_logical_interconnect_group_facts:
params:
start: 0
count: 3
sort: name:descending
filter: name=LIGName
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
- debug: var=logical_interconnect_groups
- name: Gather facts about a Logical Interconnect Group by name
oneview_logical_interconnect_group_facts:
name: logical lnterconnect group name
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
- debug: var=logical_interconnect_groups
'''
RETURN = '''
logical_interconnect_groups:
description: Has all the OneView facts about the Logical Interconnect Groups.
returned: Always, but can be null.
type: dict
'''
from ansible.module_utils.oneview import OneViewModuleBase
class LogicalInterconnectGroupFactsModule(OneViewModuleBase):
def __init__(self):
argument_spec = dict(
name=dict(type='str'),
params=dict(type='dict'),
)
super(LogicalInterconnectGroupFactsModule, self).__init__(additional_arg_spec=argument_spec)
def execute_module(self):
if self.module.params.get('name'):
ligs = self.oneview_client.logical_interconnect_groups.get_by('name', self.module.params['name'])
else:
ligs = self.oneview_client.logical_interconnect_groups.get_all(**self.facts_params)
return dict(changed=False, ansible_facts=dict(logical_interconnect_groups=ligs))
def main():
LogicalInterconnectGroupFactsModule().run()
if __name__ == '__main__':
main()