community.general.na_ontap_gather_facts (2.5.9) — module

Install collection

Install with ansible-galaxy collection install community.general:==2.5.9

Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

This module allows you to gather various information about ONTAP configuration

Requirements

• A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
• Ansible 2.6
• Python2 netapp-lib (2017.10.30) or later. Install using 'pip install netapp-lib'
• Python3 netapp-lib (2018.11.13) or later. Install using 'pip install netapp-lib'
• To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;'
• netapp_lib

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get NetApp info (Password Authentication)
  community.general.na_ontap_gather_facts:
    state: info
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- ansible.builtin.debug:
    var: ontap_facts

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Limit Fact Gathering to Aggregate Information
  community.general.na_ontap_gather_facts:
    state: info
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset: "aggregate_info"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Limit Fact Gathering to Volume and Lun Information
  community.general.na_ontap_gather_facts:
    state: info
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset:
      - volume_info
      - lun_info

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather all facts except for volume and lun information
  community.general.na_ontap_gather_facts:
    state: info
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset:
      - "!volume_info"
      - "!lun_info"

Inputs

    
https:
    default: false
    description:
    - Enable and disable https
    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.
    required: true
    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/).
    required: true
    type: str

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

gather_subset:
    default: all
    description:
    - When supplied, this argument will restrict the facts collected to a given subset.  Possible
      values for this argument include C(aggregate_info), C(cluster_node_info), C(igroup_info),
      C(lun_info), C(net_dns_info), C(net_ifgrp_info), C(net_interface_info), C(net_port_info),
      C(nvme_info), C(nvme_interface_info), C(nvme_namespace_info), C(nvme_subsystem_info),
      C(ontap_version), C(qos_adaptive_policy_info), C(qos_policy_info), C(security_key_manager_key_info),
      C(security_login_account_info), C(storage_failover_info), C(volume_info), C(vserver_info),
      C(vserver_login_banner_info), C(vserver_motd_info), C(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 C(help) to get a list of supported facts for your system.
    elements: str
    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

Outputs

ontap_facts:
  description: Returns various information about NetApp cluster configuration
  returned: always
  sample: '{ "ontap_facts": { "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