netapp.ontap.na_ontap_service_policy module – NetApp ONTAP service policy configuration

Note

This module is part of the netapp.ontap collection (version 21.19.1).

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

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.

Choices:

  • no ← (default)

  • yes

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

aliases: pass

string

Password for the specified user.

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.

Choices:

  • cluster

  • svm

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.

Choices:

  • cluster_core

  • intercluster_core

  • management_core

  • management_autosupport

  • management_bgp

  • management_ems

  • management_https

  • management_ssh

  • management_portmap

  • data_core

  • data_nfs

  • data_cifs

  • data_flexcache

  • data_iscsi

  • data_s3_server

  • no_service

state

string

Whether the specified service policy should exist or not.

Choices:

  • present ← (default)

  • absent

use_rest

string

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: “auto”

username

aliases: user

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.

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.

Choices:

  • no

  • yes ← (default)

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 does not support ‘allowed-addresses’ as REST does not support it. It defaults to 0.0.0.0/0.

  • 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
    name: "{{ service_policy_name }}"
    services:
      - data_core
      - data_nfs
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete single service policy
  netapp.ontap.na_ontap_service_policy:
    state: absent
    name: "{{ service_policy_name }}"
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify single service policy
  netapp.ontap.na_ontap_service_policy:
    state: present
    name: "{{ service_policy_name }}"
    services:
      - data_core
      - data_nfs
      - data_cifs
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify service policy, remove services
  netapp.ontap.na_ontap_service_policy:
    state: present
    name: "{{ service_policy_name }}"
    services:
      - no_service
    vserver: "{{ vserver }}"

- name: Modify service policy at cluster level
  netapp.ontap.na_ontap_service_policy:
    state: present
    name: "{{ service_policy_name }}"
    ipspace: ansibleIpspace
    scope: cluster
    services:
      - management_core
      - management_autosupport
      - management_ems

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cd_action

string

whether a public key is created or deleted.

Returned: success

modify

dictionary

attributes that were modified if the key already exists.

Returned: success

Authors

  • NetApp Ansible Team (@carchi8py)