netapp.ontap.na_ontap_service_policy – NetApp ONTAP service policy configuration
Note
This plugin is part of the netapp.ontap collection (version 21.12.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
.
To use it in a playbook, specify: netapp.ontap.na_ontap_service_policy
.
New in version 21.7.0: of netapp.ontap
Synopsis
- Add, modify, or remove service policies.
- This module requires ONTAP 9.8 or later, and only supports REST.
Requirements
The below requirements are needed on the host that executes this module.
- Ansible 2.9
- Python3 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.
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cert_filepath string added in 20.6.0 of netapp.ontap | path to SSL client cert file (.pem). not supported with python 2.6. | |
feature_flags dictionary added in 20.5.0 of netapp.ontap | 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. | |
hostname string / required | The hostname or IP address of the ONTAP instance. | |
http_port integer | Override the default port (80 or 443) with this port | |
https boolean |
| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. |
ipspace string | Name of the ipspace. Required for cluster-scoped service policies. Optional for SVM-scoped service policies. | |
key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | |
name string / required | The name of the service policy. | |
ontapi integer | The ontap api version to use | |
password string | Password for the specified user. aliases: pass | |
scope string |
| Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster". svm is assumed if vserver is set. cluster is assumed is vserver is not set. |
services list / elements=string |
| List of services to associate to this service policy. To remove all services, use "no_service". No other value is allowed if no_service is present. |
state string |
| Whether the specified service policy should exist or not. |
use_rest string | Default: "auto" | 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 |
username string | 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://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. aliases: user | |
validate_certs boolean |
| If set to no , the SSL certificates will not be validated.This should only set to False used on personally controlled sites using self-signed certificates. |
vserver string | The name of the vserver to use. Omit this option for cluster scoped user accounts. |
Notes
Note
- This module supports check_mode.
- This module is not idempotent if index is omitted.
- The modules prefixed with na_ontap are built to support the ONTAP storage platform.
Examples
- name: Create service policy netapp.ontap.na_ontap_service_policy: state: present account: SampleUser index: 0 public_key: "{{ netapp_service_policy }}" vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete single service policy netapp.ontap.na_ontap_service_policy: state: absent account: SampleUser vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify single service policy netapp.ontap.na_ontap_service_policy: state: present account: SampleUser comment: ssh key for XXXX index: 0 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cd_action string | success | whether a public key is created or deleted. |
modify dictionary | success | attributes that were modified if the key already exists. |
Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_service_policy_module.html