netapp.ontap.na_ontap_mav_config module – NetApp ONTAP multi-admin verification (MAV) global setting
Note
This module is part of the netapp.ontap collection (version 23.1.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_mav_config.
New in netapp.ontap 23.0.0
Synopsis
Enable/disable multi-admin verification (MAV) configuration.
Multi-admin verification is not required to enable the feature. However, it is required to disable the feature.
Multi-admin verification is required for any modification to be done while multi-admin approval is enabled.
Until the pending request gets approved, request info is returned in the module output. Once approved the module needs to be run again to apply the intended updates.
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.
netapp-lib only when using ZAPI (install using ‘pip install netapp-lib’), Please note that netapp-lib is deprecated and no longer maintained. Proceed at your own risk.
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 |
|---|---|
Specifies the time, in ISO-8601 duration format, that the approvers have after a new execution request is submitted to approve or disapprove the request before the request expires. The default value is one hour (PT1H), the minimum supported value is one second (PT1S), and the maximum supported value is 14 days (P14D). |
|
Specifies the list of global approval groups which are inherited by the rule if the approval-groups is not provided for the rule. The default value is an empty list. |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Specifies whether multi-admin approval is currently configured or not. By default, the feature is disabled and the value is set to false. Choices:
|
|
Specifies the time, in ISO-8601 duration format, that the authorized users have after a request is approved to execute the requested operation before the request expires. The default value is one hour (PT1H), the minimum supported value is one second (PT1S), and the maximum supported value is 14 days (P14D). |
|
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. |
|
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. |
|
Password for the specified user. |
|
Specifies the required number of approvers to approve the request which is inherited by the rule if required-approvers is not provided for the rule. The default and minimum number of required approvers is 1. |
|
Modify MAV global setting, only present is supported. Choices:
|
|
This module only supports REST. always – will always use the REST API. A warning is issued if the module does not support REST. 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
Only supported with REST and requires ONTAP 9.11.1 or later.
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: Enable multi-admin approval
netapp.ontap.na_ontap_mav_config:
state: present
enabled: true
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always
- name: Update MAV configuration
netapp.ontap.na_ontap_mav_config:
state: present
approval_groups: ["group1", "group2"]
execution_expiry: "P14D"
approval_expiry: "P14D"
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always
# this generates multi-admin-verify request which needs approval
- name: Disable multi-admin approval
netapp.ontap.na_ontap_mav_config:
state: present
enabled: false
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: "{{ validate_certs }}"
use_rest: always
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Returns multi-admin-verify request information while trying to disable MAV global setting, empty for enable or modify operations. Returned: always Sample: |