ansible.builtin.na_ontap_gather_facts (v2.7.7) — module

Install Ansible via pip

Install with pip install ansible==2.7.7

Description

This module allows you to gather various information about ONTAP configuration

Requirements

• Ansible 2.9 or later - 2.12 or later is recommended.
• Python3 - 3.9 or later is recommended.
• When using ZAPI, netapp-lib 2018.11.13 or later (install using 'pip install netapp-lib'), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues
• a physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later
• 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)
  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.

- debug:
    var: ontap_facts

Inputs

    
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"
    required: false

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:
    default: auto
    description:
    - Whether to use REST or ZAPI.
    - always -- will always use the REST API if the module supports REST. A warning is
      issued if the module does not support REST. An error is issued if a module option
      is not supported in REST.
    - never -- will always use ZAPI if the module supports ZAPI.  An error may be issued
      if a REST option is not supported in ZAPI.
    - auto -- will try to use the REST API if the module supports REST and modules options
      are supported.  Reverts to ZAPI otherwise.
    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

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

force_ontap_version:
    description:
    - Override the cluster ONTAP version when using REST.
    - The behavior is undefined if the version does not match the target cluster.
    - This is provided as a work-around when the cluster version cannot be read because
      of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.
    - This should be in the form 9.10 or 9.10.1 with each element being an integer number.
    - When C(use_rest) is set to auto, this may force a switch to ZAPI based on the version
      and platform capabilities.
    - Ignored with ZAPI.
    type: str
    version_added: 21.23.0
    version_added_collection: netapp.ontap

Outputs

ontap_facts:
  description: Returns various information about NetApp cluster configuration
  returned: always
  sample: '{ "ontap_facts": { "aggregate_info": {...}, "cluster_node_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": {...} }'
  type: dict