mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
db451bf68a
Check mode has only been added for some _info and _facts modules in a bugfix (#5969)
Check mode has only been added for some _info and _facts modules in a bugfix.
(cherry picked from commit 867aee606e)
116 lines
3.5 KiB
Python
116 lines
3.5 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright (c) 2016-2017 Hewlett Packard Enterprise Development LP
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: oneview_fcoe_network_info
|
|
short_description: Retrieve the information about one or more of the OneView FCoE Networks
|
|
description:
|
|
- Retrieve the information about one or more of the FCoE Networks from OneView.
|
|
- This module was called C(oneview_fcoe_network_facts) before Ansible 2.9, returning C(ansible_facts).
|
|
Note that the M(community.general.oneview_fcoe_network_info) module no longer returns C(ansible_facts)!
|
|
requirements:
|
|
- hpOneView >= 2.0.1
|
|
author:
|
|
- Felipe Bulsoni (@fgbulsoni)
|
|
- Thiago Miotto (@tmiotto)
|
|
- Adriane Cardozo (@adriane-cardozo)
|
|
attributes:
|
|
check_mode:
|
|
version_added: 3.3.0
|
|
# This was backported to 2.5.4 and 1.3.11 as well, since this was a bugfix
|
|
options:
|
|
name:
|
|
description:
|
|
- FCoE Network name.
|
|
type: str
|
|
extends_documentation_fragment:
|
|
- community.general.oneview
|
|
- community.general.oneview.factsparams
|
|
- community.general.attributes
|
|
- community.general.attributes.info_module
|
|
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Gather information about all FCoE Networks
|
|
community.general.oneview_fcoe_network_info:
|
|
config: /etc/oneview/oneview_config.json
|
|
delegate_to: localhost
|
|
register: result
|
|
|
|
- name: Print fetched information about FCoE Networks
|
|
ansible.builtin.debug:
|
|
msg: "{{ result.fcoe_networks }}"
|
|
|
|
- name: Gather paginated, filtered and sorted information about FCoE Networks
|
|
community.general.oneview_fcoe_network_info:
|
|
config: /etc/oneview/oneview_config.json
|
|
params:
|
|
start: 0
|
|
count: 3
|
|
sort: 'name:descending'
|
|
filter: 'vlanId=2'
|
|
delegate_to: localhost
|
|
register: result
|
|
|
|
- name: Print fetched information about paginated, filtered and sorted list of FCoE Networks
|
|
ansible.builtin.debug:
|
|
msg: "{{ result.fcoe_networks }}"
|
|
|
|
- name: Gather information about a FCoE Network by name
|
|
community.general.oneview_fcoe_network_info:
|
|
config: /etc/oneview/oneview_config.json
|
|
name: Test FCoE Network Information
|
|
delegate_to: localhost
|
|
register: result
|
|
|
|
- name: Print fetched information about FCoE Network found by name
|
|
ansible.builtin.debug:
|
|
msg: "{{ result.fcoe_networks }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
fcoe_networks:
|
|
description: Has all the OneView information about the FCoE Networks.
|
|
returned: Always, but can be null.
|
|
type: dict
|
|
'''
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase
|
|
|
|
|
|
class FcoeNetworkInfoModule(OneViewModuleBase):
|
|
def __init__(self):
|
|
argument_spec = dict(
|
|
name=dict(type='str'),
|
|
params=dict(type='dict'),
|
|
)
|
|
|
|
super(FcoeNetworkInfoModule, self).__init__(
|
|
additional_arg_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
def execute_module(self):
|
|
|
|
if self.module.params['name']:
|
|
fcoe_networks = self.oneview_client.fcoe_networks.get_by('name', self.module.params['name'])
|
|
else:
|
|
fcoe_networks = self.oneview_client.fcoe_networks.get_all(**self.facts_params)
|
|
|
|
return dict(changed=False, fcoe_networks=fcoe_networks)
|
|
|
|
|
|
def main():
|
|
FcoeNetworkInfoModule().run()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|