mirror of https://github.com/ansible/ansible.git
Netapp: rename _facts -> _info (#60980)
* Rename na_ontap_gather_facts -> na_ontap_info Rename netapp_e_facts -> netapp_e_info * Add changelog. * Fix sanity. * Forgot test. * Forgot to remove 'gather'. * Fix sanity ignore. * Remove netapp_e_facts from PR. * Remove superfluous version_added.pull/61206/head
Felix Fontein
5 years ago
committed by
GitHub
parent
e04b2a9697
commit
18f7c3b850
@ -0,0 +1,2 @@
|
||||
minor_changes:
|
||||
- The ``na_ontap_gather_facts`` module has been deprecated. Use ``na_ontap_info`` instead.
|
||||
@ -0,0 +1,619 @@
|
||||
#!/usr/bin/python
|
||||
|
||||
# (c) 2018 Piotr Olczak <piotr.olczak@redhat.com>
|
||||
# (c) 2018-2019, NetApp, Inc
|
||||
# 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': 'certified'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: na_ontap_info
|
||||
author: Piotr Olczak (@dprts) <polczak@redhat.com>
|
||||
extends_documentation_fragment:
|
||||
- netapp.na_ontap
|
||||
short_description: NetApp information gatherer
|
||||
description:
|
||||
- This module allows you to gather various information about ONTAP configuration
|
||||
version_added: "2.9"
|
||||
requirements:
|
||||
- netapp_lib
|
||||
options:
|
||||
state:
|
||||
type: str
|
||||
description:
|
||||
- Returns "info"
|
||||
default: "info"
|
||||
choices: ['info']
|
||||
gather_subset:
|
||||
type: list
|
||||
description:
|
||||
- When supplied, this argument will restrict the information collected
|
||||
to a given subset. Possible values for this argument include
|
||||
"aggregate_info", "cluster_node_info", "igroup_info", "lun_info", "net_dns_info",
|
||||
"net_ifgrp_info",
|
||||
"net_interface_info", "net_port_info", "nvme_info", "nvme_interface_info",
|
||||
"nvme_namespace_info", "nvme_subsystem_info", "ontap_version",
|
||||
"qos_adaptive_policy_info", "qos_policy_info", "security_key_manager_key_info",
|
||||
"security_login_account_info", "storage_failover_info", "volume_info",
|
||||
"vserver_info", "vserver_login_banner_info", "vserver_motd_info", "vserver_nfs_info"
|
||||
Can specify a list of values to include a larger subset. Values can also be used
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
- nvme is supported with ONTAP 9.4 onwards.
|
||||
- use "help" to get a list of supported information for your system.
|
||||
default: "all"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get NetApp info (Password Authentication)
|
||||
na_ontap_info:
|
||||
state: info
|
||||
hostname: "na-vsim"
|
||||
username: "admin"
|
||||
password: "admins_password"
|
||||
register: ontap_info
|
||||
- debug:
|
||||
msg: "{{ ontap_info.ontap_info }}"
|
||||
|
||||
- name: Limit Info Gathering to Aggregate Information
|
||||
na_ontap_info:
|
||||
state: info
|
||||
hostname: "na-vsim"
|
||||
username: "admin"
|
||||
password: "admins_password"
|
||||
gather_subset: "aggregate_info"
|
||||
register: ontap_info
|
||||
|
||||
- name: Limit Info Gathering to Volume and Lun Information
|
||||
na_ontap_info:
|
||||
state: info
|
||||
hostname: "na-vsim"
|
||||
username: "admin"
|
||||
password: "admins_password"
|
||||
gather_subset:
|
||||
- volume_info
|
||||
- lun_info
|
||||
register: ontap_info
|
||||
|
||||
- name: Gather all info except for volume and lun information
|
||||
na_ontap_info:
|
||||
state: info
|
||||
hostname: "na-vsim"
|
||||
username: "admin"
|
||||
password: "admins_password"
|
||||
gather_subset:
|
||||
- "!volume_info"
|
||||
- "!lun_info"
|
||||
register: ontap_info
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
ontap_info:
|
||||
description: Returns various information about NetApp cluster configuration
|
||||
returned: always
|
||||
type: dict
|
||||
sample: '{
|
||||
"ontap_info": {
|
||||
"aggregate_info": {...},
|
||||
"cluster_node_info": {...},
|
||||
"net_dns_info": {...},
|
||||
"net_ifgrp_info": {...},
|
||||
"net_interface_info": {...},
|
||||
"net_port_info": {...},
|
||||
"security_key_manager_key_info": {...},
|
||||
"security_login_account_info": {...},
|
||||
"volume_info": {...},
|
||||
"lun_info": {...},
|
||||
"storage_failover_info": {...},
|
||||
"vserver_login_banner_info": {...},
|
||||
"vserver_motd_info": {...},
|
||||
"vserver_info": {...},
|
||||
"vserver_nfs_info": {...},
|
||||
"ontap_version": {...},
|
||||
"igroup_info": {...},
|
||||
"qos_policy_info": {...},
|
||||
"qos_adaptive_policy_info": {...}
|
||||
}'
|
||||
'''
|
||||
|
||||
import traceback
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils._text import to_native
|
||||
import ansible.module_utils.netapp as netapp_utils
|
||||
|
||||
try:
|
||||
import xmltodict
|
||||
HAS_XMLTODICT = True
|
||||
except ImportError:
|
||||
HAS_XMLTODICT = False
|
||||
|
||||
try:
|
||||
import json
|
||||
HAS_JSON = True
|
||||
except ImportError:
|
||||
HAS_JSON = False
|
||||
|
||||
HAS_NETAPP_LIB = netapp_utils.has_netapp_lib()
|
||||
|
||||
|
||||
class NetAppONTAPGatherInfo(object):
|
||||
'''Class with gather info methods'''
|
||||
|
||||
def __init__(self, module):
|
||||
self.module = module
|
||||
self.netapp_info = dict()
|
||||
|
||||
# thanks to coreywan (https://github.com/ansible/ansible/pull/47016)
|
||||
# for starting this
|
||||
# min_version identifies the ontapi version which supports this ZAPI
|
||||
# use 0 if it is supported since 9.1
|
||||
self.info_subsets = {
|
||||
'net_dns_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'net-dns-get-iter',
|
||||
'attribute': 'net-dns-info',
|
||||
'field': 'vserver-name',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'net_interface_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'net-interface-get-iter',
|
||||
'attribute': 'net-interface-info',
|
||||
'field': 'interface-name',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'net_port_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'net-port-get-iter',
|
||||
'attribute': 'net-port-info',
|
||||
'field': ('node', 'port'),
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'cluster_node_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'cluster-node-get-iter',
|
||||
'attribute': 'cluster-node-info',
|
||||
'field': 'node-name',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'security_login_account_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'security-login-get-iter',
|
||||
'attribute': 'security-login-account-info',
|
||||
'field': ('vserver', 'user-name', 'application', 'authentication-method'),
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'aggregate_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'aggr-get-iter',
|
||||
'attribute': 'aggr-attributes',
|
||||
'field': 'aggregate-name',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'volume_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'volume-get-iter',
|
||||
'attribute': 'volume-attributes',
|
||||
'field': ('name', 'owning-vserver-name'),
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'lun_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'lun-get-iter',
|
||||
'attribute': 'lun-info',
|
||||
'field': 'path',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'storage_failover_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'cf-get-iter',
|
||||
'attribute': 'storage-failover-info',
|
||||
'field': 'node',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'vserver_motd_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'vserver-motd-get-iter',
|
||||
'attribute': 'vserver-motd-info',
|
||||
'field': 'vserver',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'vserver_login_banner_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'vserver-login-banner-get-iter',
|
||||
'attribute': 'vserver-login-banner-info',
|
||||
'field': 'vserver',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'security_key_manager_key_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'security-key-manager-key-get-iter',
|
||||
'attribute': 'security-key-manager-key-info',
|
||||
'field': ('node', 'key-id'),
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'vserver_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'vserver-get-iter',
|
||||
'attribute': 'vserver-info',
|
||||
'field': 'vserver-name',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'vserver_nfs_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'nfs-service-get-iter',
|
||||
'attribute': 'nfs-info',
|
||||
'field': 'vserver',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'net_ifgrp_info': {
|
||||
'method': self.get_ifgrp_info,
|
||||
'kwargs': {},
|
||||
'min_version': '0',
|
||||
},
|
||||
'ontap_version': {
|
||||
'method': self.ontapi,
|
||||
'kwargs': {},
|
||||
'min_version': '0',
|
||||
},
|
||||
'system_node_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'system-node-get-iter',
|
||||
'attribute': 'node-details-info',
|
||||
'field': 'node',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'igroup_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'igroup-get-iter',
|
||||
'attribute': 'initiator-group-info',
|
||||
'field': ('vserver', 'initiator-group-name'),
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
'qos_policy_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'qos-policy-group-get-iter',
|
||||
'attribute': 'qos-policy-group-info',
|
||||
'field': 'policy-group',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '0',
|
||||
},
|
||||
# supported in ONTAP 9.3 and onwards
|
||||
'qos_adaptive_policy_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'qos-adaptive-policy-group-get-iter',
|
||||
'attribute': 'qos-adaptive-policy-group-info',
|
||||
'field': 'policy-group',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '130',
|
||||
},
|
||||
# supported in ONTAP 9.4 and onwards
|
||||
'nvme_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'nvme-get-iter',
|
||||
'attribute': 'nvme-target-service-info',
|
||||
'field': 'vserver',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '140',
|
||||
},
|
||||
'nvme_interface_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'nvme-interface-get-iter',
|
||||
'attribute': 'nvme-interface-info',
|
||||
'field': 'vserver',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '140',
|
||||
},
|
||||
'nvme_subsystem_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'nvme-subsystem-get-iter',
|
||||
'attribute': 'nvme-subsystem-info',
|
||||
'field': 'subsystem',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '140',
|
||||
},
|
||||
'nvme_namespace_info': {
|
||||
'method': self.get_generic_get_iter,
|
||||
'kwargs': {
|
||||
'call': 'nvme-namespace-get-iter',
|
||||
'attribute': 'nvme-namespace-info',
|
||||
'field': 'path',
|
||||
'query': {'max-records': '1024'},
|
||||
},
|
||||
'min_version': '140',
|
||||
},
|
||||
}
|
||||
|
||||
if HAS_NETAPP_LIB is False:
|
||||
self.module.fail_json(msg="the python NetApp-Lib module is required")
|
||||
else:
|
||||
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module)
|
||||
|
||||
def ontapi(self):
|
||||
'''Method to get ontapi version'''
|
||||
|
||||
api = 'system-get-ontapi-version'
|
||||
api_call = netapp_utils.zapi.NaElement(api)
|
||||
try:
|
||||
results = self.server.invoke_successfully(api_call, enable_tunneling=False)
|
||||
ontapi_version = results.get_child_content('minor-version')
|
||||
return ontapi_version if ontapi_version is not None else '0'
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
self.module.fail_json(msg="Error calling API %s: %s" %
|
||||
(api, to_native(error)), exception=traceback.format_exc())
|
||||
|
||||
def call_api(self, call, query=None):
|
||||
'''Main method to run an API call'''
|
||||
|
||||
api_call = netapp_utils.zapi.NaElement(call)
|
||||
result = None
|
||||
|
||||
if query:
|
||||
for key, val in query.items():
|
||||
# Can val be nested?
|
||||
api_call.add_new_child(key, val)
|
||||
try:
|
||||
result = self.server.invoke_successfully(api_call, enable_tunneling=False)
|
||||
return result
|
||||
except netapp_utils.zapi.NaApiError as error:
|
||||
if call in ['security-key-manager-key-get-iter']:
|
||||
return result
|
||||
else:
|
||||
self.module.fail_json(msg="Error calling API %s: %s"
|
||||
% (call, to_native(error)), exception=traceback.format_exc())
|
||||
|
||||
def get_ifgrp_info(self):
|
||||
'''Method to get network port ifgroups info'''
|
||||
|
||||
try:
|
||||
net_port_info = self.netapp_info['net_port_info']
|
||||
except KeyError:
|
||||
net_port_info_calls = self.info_subsets['net_port_info']
|
||||
net_port_info = net_port_info_calls['method'](**net_port_info_calls['kwargs'])
|
||||
interfaces = net_port_info.keys()
|
||||
|
||||
ifgrps = []
|
||||
for ifn in interfaces:
|
||||
if net_port_info[ifn]['port_type'] == 'if_group':
|
||||
ifgrps.append(ifn)
|
||||
|
||||
net_ifgrp_info = dict()
|
||||
for ifgrp in ifgrps:
|
||||
query = dict()
|
||||
query['node'], query['ifgrp-name'] = ifgrp.split(':')
|
||||
|
||||
tmp = self.get_generic_get_iter('net-port-ifgrp-get', field=('node', 'ifgrp-name'),
|
||||
attribute='net-ifgrp-info', query=query)
|
||||
net_ifgrp_info = net_ifgrp_info.copy()
|
||||
net_ifgrp_info.update(tmp)
|
||||
return net_ifgrp_info
|
||||
|
||||
def get_generic_get_iter(self, call, attribute=None, field=None, query=None):
|
||||
'''Method to run a generic get-iter call'''
|
||||
|
||||
generic_call = self.call_api(call, query)
|
||||
|
||||
if call == 'net-port-ifgrp-get':
|
||||
children = 'attributes'
|
||||
else:
|
||||
children = 'attributes-list'
|
||||
|
||||
if generic_call is None:
|
||||
return None
|
||||
|
||||
if field is None:
|
||||
out = []
|
||||
else:
|
||||
out = {}
|
||||
|
||||
attributes_list = generic_call.get_child_by_name(children)
|
||||
|
||||
if attributes_list is None:
|
||||
return None
|
||||
|
||||
for child in attributes_list.get_children():
|
||||
dic = xmltodict.parse(child.to_string(), xml_attribs=False)
|
||||
|
||||
if attribute is not None:
|
||||
dic = dic[attribute]
|
||||
|
||||
if isinstance(field, str):
|
||||
unique_key = _finditem(dic, field)
|
||||
out = out.copy()
|
||||
out.update({unique_key: convert_keys(json.loads(json.dumps(dic)))})
|
||||
elif isinstance(field, tuple):
|
||||
unique_key = ':'.join([_finditem(dic, el) for el in field])
|
||||
out = out.copy()
|
||||
out.update({unique_key: convert_keys(json.loads(json.dumps(dic)))})
|
||||
else:
|
||||
out.append(convert_keys(json.loads(json.dumps(dic))))
|
||||
|
||||
return out
|
||||
|
||||
def get_all(self, gather_subset):
|
||||
'''Method to get all subsets'''
|
||||
|
||||
results = netapp_utils.get_cserver(self.server)
|
||||
cserver = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=results)
|
||||
netapp_utils.ems_log_event("na_ontap_info", cserver)
|
||||
|
||||
self.netapp_info['ontap_version'] = self.ontapi()
|
||||
|
||||
run_subset = self.get_subset(gather_subset, self.netapp_info['ontap_version'])
|
||||
if 'help' in gather_subset:
|
||||
self.netapp_info['help'] = sorted(run_subset)
|
||||
else:
|
||||
for subset in run_subset:
|
||||
call = self.info_subsets[subset]
|
||||
self.netapp_info[subset] = call['method'](**call['kwargs'])
|
||||
|
||||
return self.netapp_info
|
||||
|
||||
def get_subset(self, gather_subset, version):
|
||||
'''Method to get a single subset'''
|
||||
|
||||
runable_subsets = set()
|
||||
exclude_subsets = set()
|
||||
usable_subsets = [key for key in self.info_subsets.keys() if version >= self.info_subsets[key]['min_version']]
|
||||
if 'help' in gather_subset:
|
||||
return usable_subsets
|
||||
for subset in gather_subset:
|
||||
if subset == 'all':
|
||||
runable_subsets.update(usable_subsets)
|
||||
return runable_subsets
|
||||
if subset.startswith('!'):
|
||||
subset = subset[1:]
|
||||
if subset == 'all':
|
||||
return set()
|
||||
exclude = True
|
||||
else:
|
||||
exclude = False
|
||||
|
||||
if subset not in usable_subsets:
|
||||
if subset not in self.info_subsets.keys():
|
||||
self.module.fail_json(msg='Bad subset: %s' % subset)
|
||||
self.module.fail_json(msg='Remote system at version %s does not support %s' %
|
||||
(version, subset))
|
||||
|
||||
if exclude:
|
||||
exclude_subsets.add(subset)
|
||||
else:
|
||||
runable_subsets.add(subset)
|
||||
|
||||
if not runable_subsets:
|
||||
runable_subsets.update(usable_subsets)
|
||||
|
||||
runable_subsets.difference_update(exclude_subsets)
|
||||
|
||||
return runable_subsets
|
||||
|
||||
|
||||
# https://stackoverflow.com/questions/14962485/finding-a-key-recursively-in-a-dictionary
|
||||
def __finditem(obj, key):
|
||||
|
||||
if key in obj:
|
||||
return obj[key]
|
||||
for dummy, val in obj.items():
|
||||
if isinstance(val, dict):
|
||||
item = __finditem(val, key)
|
||||
if item is not None:
|
||||
return item
|
||||
return None
|
||||
|
||||
|
||||
def _finditem(obj, key):
|
||||
|
||||
value = __finditem(obj, key)
|
||||
if value is not None:
|
||||
return value
|
||||
raise KeyError(key)
|
||||
|
||||
|
||||
def convert_keys(d_param):
|
||||
'''Method to convert hyphen to underscore'''
|
||||
|
||||
out = {}
|
||||
if isinstance(d_param, dict):
|
||||
for key, val in d_param.items():
|
||||
val = convert_keys(val)
|
||||
out[key.replace('-', '_')] = val
|
||||
else:
|
||||
return d_param
|
||||
return out
|
||||
|
||||
|
||||
def main():
|
||||
'''Execute action'''
|
||||
|
||||
argument_spec = netapp_utils.na_ontap_host_argument_spec()
|
||||
argument_spec.update(dict(
|
||||
state=dict(type='str', default='info', choices=['info']),
|
||||
gather_subset=dict(default=['all'], type='list'),
|
||||
))
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not HAS_XMLTODICT:
|
||||
module.fail_json(msg="xmltodict missing")
|
||||
|
||||
if not HAS_JSON:
|
||||
module.fail_json(msg="json missing")
|
||||
|
||||
state = module.params['state']
|
||||
gather_subset = module.params['gather_subset']
|
||||
if gather_subset is None:
|
||||
gather_subset = ['all']
|
||||
gf_obj = NetAppONTAPGatherInfo(module)
|
||||
gf_all = gf_obj.get_all(gather_subset)
|
||||
result = {'state': state, 'changed': False}
|
||||
module.exit_json(ontap_info=gf_all, **result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in New Issue