mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-04 07:19:10 -07:00
Unflatmap community.general (#5461)
* Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
This commit is contained in:
parent
2b0bebc8fc
commit
b531ecdc9b
1033 changed files with 4802 additions and 1989 deletions
123
plugins/modules/oneview_san_manager_info.py
Normal file
123
plugins/modules/oneview_san_manager_info.py
Normal file
|
@ -0,0 +1,123 @@
|
|||
#!/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_san_manager_info
|
||||
short_description: Retrieve information about one or more of the OneView SAN Managers
|
||||
description:
|
||||
- Retrieve information about one or more of the SAN Managers from OneView
|
||||
- This module was called C(oneview_san_manager_facts) before Ansible 2.9, returning C(ansible_facts).
|
||||
Note that the M(community.general.oneview_san_manager_info) module no longer returns C(ansible_facts)!
|
||||
requirements:
|
||||
- hpOneView >= 2.0.1
|
||||
author:
|
||||
- Felipe Bulsoni (@fgbulsoni)
|
||||
- Thiago Miotto (@tmiotto)
|
||||
- Adriane Cardozo (@adriane-cardozo)
|
||||
options:
|
||||
provider_display_name:
|
||||
description:
|
||||
- Provider Display Name.
|
||||
type: str
|
||||
params:
|
||||
description:
|
||||
- List of params to delimit, filter and sort the list of resources.
|
||||
- "params allowed:
|
||||
- C(start): The first item to return, using 0-based indexing.
|
||||
- C(count): The number of resources to return.
|
||||
- C(query): A general query string to narrow the list of resources returned.
|
||||
- C(sort): The sort order of the returned data set."
|
||||
type: dict
|
||||
extends_documentation_fragment:
|
||||
- community.general.oneview
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Gather information about all SAN Managers
|
||||
community.general.oneview_san_manager_info:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
delegate_to: localhost
|
||||
register: result
|
||||
|
||||
- name: Print fetched information about SAN Managers
|
||||
ansible.builtin.debug:
|
||||
msg: "{{ result.san_managers }}"
|
||||
|
||||
- name: Gather paginated, filtered and sorted information about SAN Managers
|
||||
community.general.oneview_san_manager_info:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
params:
|
||||
start: 0
|
||||
count: 3
|
||||
sort: name:ascending
|
||||
query: isInternal eq false
|
||||
delegate_to: localhost
|
||||
register: result
|
||||
|
||||
- name: Print fetched information about paginated, filtered and sorted list of SAN Managers
|
||||
ansible.builtin.debug:
|
||||
msg: "{{ result.san_managers }}"
|
||||
|
||||
- name: Gather information about a SAN Manager by provider display name
|
||||
community.general.oneview_san_manager_info:
|
||||
config: /etc/oneview/oneview_config.json
|
||||
provider_display_name: Brocade Network Advisor
|
||||
delegate_to: localhost
|
||||
register: result
|
||||
|
||||
- name: Print fetched information about SAN Manager found by provider display name
|
||||
ansible.builtin.debug:
|
||||
msg: "{{ result.san_managers }}"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
san_managers:
|
||||
description: Has all the OneView information about the SAN Managers.
|
||||
returned: Always, but can be null.
|
||||
type: dict
|
||||
'''
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.oneview import OneViewModuleBase
|
||||
|
||||
|
||||
class SanManagerInfoModule(OneViewModuleBase):
|
||||
argument_spec = dict(
|
||||
provider_display_name=dict(type='str'),
|
||||
params=dict(type='dict')
|
||||
)
|
||||
|
||||
def __init__(self):
|
||||
super(SanManagerInfoModule, self).__init__(
|
||||
additional_arg_spec=self.argument_spec,
|
||||
supports_check_mode=True,
|
||||
)
|
||||
self.resource_client = self.oneview_client.san_managers
|
||||
|
||||
def execute_module(self):
|
||||
if self.module.params.get('provider_display_name'):
|
||||
provider_display_name = self.module.params['provider_display_name']
|
||||
san_manager = self.oneview_client.san_managers.get_by_provider_display_name(provider_display_name)
|
||||
if san_manager:
|
||||
resources = [san_manager]
|
||||
else:
|
||||
resources = []
|
||||
else:
|
||||
resources = self.oneview_client.san_managers.get_all(**self.facts_params)
|
||||
|
||||
return dict(changed=False, san_managers=resources)
|
||||
|
||||
|
||||
def main():
|
||||
SanManagerInfoModule().run()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Add table
Add a link
Reference in a new issue