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

Note

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

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_service_policy.

New in netapp.ontap 21.7.0

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 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

additional_services

list / elements=string

added in netapp.ontap 22.0.0

As an alternative to updating the known_services, new services can be specified here.

cert_filepath

string

added in netapp.ontap 20.6.0

path to SSL client cert file (.pem).

not supported with python 2.6.

feature_flags

dictionary

added in netapp.ontap 20.5.0

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.

force_ontap_version

string

added in netapp.ontap 21.23.0

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 use_rest is set to auto, this may force a switch to ZAPI based on the version and platform capabilities.

Ignored with ZAPI.

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:

  • false ← (default)

  • true

ipspace

string

Name of the ipspace.

Required for cluster-scoped service policies.

Optional for SVM-scoped service policies.

key_filepath

string

added in netapp.ontap 20.6.0

path to SSL client key file.

known_services

list / elements=string

added in netapp.ontap 22.0.0

List of known services in 9.12.1

An error is raised if any service in services is not in this list or new_services.

Modify this list to restrict the services you want to support if needed.

Default: ["cluster_core", "intercluster_core", "management_core", "management_autosupport", "management_bgp", "management_ems", "management_https", "management_http", "management_ssh", "management_portmap", "data_core", "data_nfs", "data_cifs", "data_flexcache", "data_iscsi", "data_s3_server", "data_dns_server", "data_fpolicy_client", "management_ntp_client", "management_dns_client", "management_ad_client", "management_ldap_client", "management_nis_client", "management_snmp_server", "management_rsh_server", "management_telnet_server", "management_ntp_server", "data_nvme_tcp", "backup_ndmp_control", "management_log_forwarding"]

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 when no_service is present.

Note - not all versions of ONTAP support all values, and new ones may be added.

See known_services and additional_services to address unknow service errors.

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:

  • false

  • true ← (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.

  • 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 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)