na_ontap_net_routes – NetApp ONTAP network routes

New in version 2.6.

Synopsis

  • Modify ONTAP network routes.

Requirements

The below requirements are needed on the host that executes this module.

  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward

  • Ansible 2.6

  • Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’

  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’

  • 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
destination
- / required
Specify the route destination.
Example 10.7.125.5/20, fd20:13::/64.
from_destination
-
added in 2.8
Specify the route destination that should be changed.
new_destination was removed to fix idempotency issues. To rename destination the original goes to from_destination and the new goes to destination.
from_gateway
-
added in 2.8
Specify the route gateway that should be changed.
from_metric
-
added in 2.8
Specify the route metric that should be changed.
gateway
- / required
Specify the route gateway.
Example 10.7.125.1, fd20:13::1.
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
metric
-
Specify the route metric.
If this field is not provided the default will be set to 20.
ontapi
integer
The ontap api version to use
password
string / required
Password for the specified user.

aliases: pass
state
-
    Choices:
  • present ←
  • absent
Whether you want to create or delete a network route.
username
string / required
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/.

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.
vserver
- / required
The name of the vserver.

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: create route
  na_ontap_net_routes:
    state: present
    vserver: "{{ Vserver name }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    destination: 10.7.125.5/20
    gateway: 10.7.125.1
    metric: 30

Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.