Try SpotterNetApp information gatherer
| "added in version" 2.9 of ansible.builtin"
Authors: Piotr Olczak (@dprts) <polczak@redhat.com>
preview | supported by certified
pipInstall with pip install ansible==2.9.26
This module allows you to gather various information about ONTAP configuration
- 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
https:
default: false
description:
- Enable and disable https.
- Ignored when using REST as only https is supported.
- Ignored when using SSL certificate authentication as it requires SSL.
type: bool
state:
choices:
- info
default: info
description:
- Returns "info"
type: str
ontapi:
description:
- The ontap api version to use
type: int
hostname:
description:
- The hostname or IP address of the ONTAP instance.
required: true
type: str
password:
aliases:
- pass
description:
- Password for the specified user.
type: str
use_rest:
choices:
- Never
- Always
- Auto
default: Auto
description:
- REST API if supported by the target system for all the resources and attributes
the module requires. Otherwise will revert to ZAPI.
- Always -- will always use the REST API
- Never -- will always use the ZAPI
- Auto -- will try to use the REST Api
type: str
username:
aliases:
- user
description:
- This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level
or SVM-level API is required.
- For more information, please read the documentation U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
- Two authentication methods are supported
- 1. basic authentication, using username and password,
- 2. SSL certificate authentication, using a ssl client cert file, and optionally
a private key file.
- To use a certificate, the certificate must have been installed in the ONTAP cluster,
and cert authentication must have been enabled.
type: str
http_port:
description:
- Override the default port (80 or 443) with this port
type: int
key_filepath:
description:
- path to SSL client key file.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
cert_filepath:
description:
- path to SSL client cert file (.pem).
- not supported with python 2.6.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
feature_flags:
description:
- Enable or disable a new feature.
- This can be used to enable an experimental feature or disable a new feature that
breaks backward compatibility.
- Supported keys and values are subject to change without notice. Unknown keys are
ignored.
type: dict
version_added: 20.5.0
version_added_collection: netapp.ontap
gather_subset:
default: all
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.
type: list
validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed
certificates.
type: bool
ontap_info:
description: Returns various information about NetApp cluster configuration
returned: always
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": {...} }'
type: dict