netapp.ontap.na_ontap_snmp module – NetApp ONTAP SNMP user
Note
This module is part of the netapp.ontap collection (version 22.14.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_snmp.
New in netapp.ontap 2.6.0
Synopsis
Create/Delete SNMP user.
Requirements
The below requirements are needed on the host that executes this module.
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.
Parameters
Parameter |
Comments |
|---|---|
Access control for the community. The only supported value is ‘ro’ (read-only). Ignored with REST. Choices:
|
|
Authentication method for SNMP user. Only supported with REST. The default value is community. Choices:
|
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
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. |
|
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 Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
path to SSL client key file. |
|
The ontap api version to use |
|
Password for the specified user. |
|
The name of the SNMP user to manage. |
|
Specify only when This option defines the SNMPv3 credentials for an SNMPv3 user or also called usm user. Only supported with REST. |
|
Authentication protocol password. |
|
Authentication protocol for SNMPv3. Choices:
|
|
Privacy protocol password. |
|
Privacy protocol for SNMPv3. Choices:
|
|
Whether the specified SNMP user should exist or not. Choices:
|
|
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. Default: |
|
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 https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
Notes
Note
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: Create SNMP community (ZAPI only)
netapp.ontap.na_ontap_snmp:
state: present
snmp_username: communityName
access_control: 'ro'
use_rest: never
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create SNMP community (snmpv1 or snmpv2) (REST only)
netapp.ontap.na_ontap_snmp:
state: present
snmp_username: communityName
use_rest: always
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create SNMP user (snmpv3) (REST only)
netapp.ontap.na_ontap_snmp:
state: present
snmp_username: username
use_rest: always
authentication_method: usm
snmpv3:
authentication_protocol: sha
authentication_password: humTdumt*@t0nAwa21
privacy_protocol: aes128
privacy_password: p@**GOandCLCt*300
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete SNMP community (ZAPI only)
netapp.ontap.na_ontap_snmp:
state: absent
snmp_username: communityName
access_control: 'ro'
use_rest: never
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete SNMP community (snmpv1 or snmpv2) (REST only)
netapp.ontap.na_ontap_snmp:
state: absent
snmp_username: communityName
use_rest: always
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete SNMP user (snmpv3) (REST only)
netapp.ontap.na_ontap_snmp:
state: absent
snmp_username: username
use_rest: always
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"