W3cubDocs

/Ansible

netapp.ontap.na_ontap_service_processor_network – NetApp ONTAP service processor network

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

New in version 2.6.0: of netapp.ontap

Synopsis

  • Modify a ONTAP service processor network

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
address_type
string / required
    Choices:
  • ipv4
  • ipv6
Specify address class.
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
dhcp
string
    Choices:
  • v4
  • none
Specify dhcp type.
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.
gateway_ip_address
string
Specify the gateway ip.
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
    Choices:
  • no ←
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
ip_address
string
Specify the service processor ip address.
is_enabled
boolean / required
    Choices:
  • no
  • yes
Specify whether to enable or disable the service processor network.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
netmask
string
Specify the service processor netmask.
node
string / required
The node where the service processor network should be enabled
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
prefix_length
integer
Specify the service processor prefix_length.
state
string
    Choices:
  • present ←
Whether the specified service processor network 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
    Choices:
  • no
  • yes ←
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.
wait_for_completion
boolean
added in 2.8.0 of netapp.ontap
    Choices:
  • no ←
  • yes
Set this parameter to 'true' for synchronous execution (wait until SP status is successfully updated)
Set this parameter to 'false' for asynchronous execution
For asynchronous, execution exits as soon as the request is sent, without checking SP status

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: Modify Service Processor Network
  na_ontap_service_processor_network:
    state: present
    address_type: ipv4
    is_enabled: true
    dhcp: v4
    node: "{{ netapp_node }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

Authors

© 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_processor_network_module.html