netapp.ontap.na_ontap_flexcache – NetApp ONTAP FlexCache - create/delete relationship¶
Note
This plugin is part of the netapp.ontap collection (version 21.4.0).
To install it use: ansible-galaxy collection install netapp.ontap
.
To use it in a playbook, specify: netapp.ontap.na_ontap_flexcache
.
New in version 2.8.0: of netapp.ontap
Synopsis¶
Create/Delete FlexCache volume relationships.
This module does not modify an existing FlexCache volume with two exceptions.
When using REST, a prepopulate can be started on an exising FlexCache volume.
When using REST, the volume can be mounted or unmounted. Set path to ‘’ to unmount it.
It is required the volume is mounted to prepopulate it.
Some actions are also available through the na_ontap_volume.
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 | |
---|---|---|---|
aggr_list
list
/ elements=string
|
List of aggregates to host target FlexCache volume.
aliases: aggregates |
||
aggr_list_multiplier
integer
|
Aggregate list repeat count.
REST - Number of FlexCache constituents per aggregate when the
aggregates field is mentioned.aliases: constituents_per_aggregate |
||
auto_provision_as
string
|
Use this parameter to automatically select existing aggregates for volume provisioning. Eg flexgroup
Note that the fastest aggregate type with at least one aggregate on each node of the cluster will be selected.
Ignored when using REST - omit aggr_list for automatic selection.
|
||
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.
|
||
force_offline
boolean
|
|
Offline FlexCache volume before deleting the FlexCache relationship.
The volume will be destroyed and data can be lost.
|
|
force_unmount
boolean
|
|
Unmount FlexCache volume. Delete the junction path at which the volume is mounted before deleting the FlexCache relationship.
|
|
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.
|
|
junction_path
string
|
Junction path of the cache volume.
aliases: path |
||
key_filepath
string
added in 20.6.0 of netapp.ontap
|
path to SSL client key file.
|
||
name
string
/ required
added in 21.3.0 of netapp.ontap
|
Name of the target volume for the FlexCache.
aliases: volume |
||
ontapi
integer
|
The ontap api version to use
|
||
origin_cluster
string
|
Name of the origin cluster for the FlexCache.
Defaults to cluster associated with target vserver if absent.
Not used for creation.
|
||
origin_volume
string
|
Name of the origin volume for the FlexCache.
Required for creation.
|
||
origin_vserver
string
|
Name of the origin vserver for the FlexCache.
Required for creation.
|
||
password
string
|
Password for the specified user.
aliases: pass |
||
prepopulate
dictionary
added in 21.3.0 of netapp.ontap
|
prepopulate FlexCache with data from origin volume.
requires ONTAP 9.8 or later, and REST support.
dir_paths must be set for this option to be effective.
|
||
dir_paths
list
/ elements=string / required
|
List of directory paths in the owning SVM's namespace at which the FlexCache volume is mounted.
Path must begin with '/'.
|
||
exclude_dir_paths
list
/ elements=string
|
Directory path which needs to be excluded from prepopulation.
Path must begin with '/'.
Requires ONTAP 9.9 or later.
|
||
force_prepopulate_if_already_created
boolean
|
|
by default, this module will start a prepopulate task each time it is called, and is not idempotent.
if set to false, the prepopulate task is not started if the FlexCache already exists.
|
|
recurse
boolean
|
|
Specifies whether or not the prepopulate action should search through the directory-path recursively.
If not set, the default value 'true' is used.
|
|
size
integer
|
Size of cache volume.
|
||
size_unit
string
|
|
The unit used to interpret the size parameter.
|
|
state
string
|
|
Whether the specified relationship should exist or not.
|
|
time_out
integer
|
Default: 180
|
time to wait for flexcache creation or deletion in seconds
if 0, the request is asynchronous
default is set to 3 minutes
|
|
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
/ required
|
Name of the target vserver for the FlexCache.
Note that hostname, username, password are intended for the target vserver.
|
Examples¶
- name: Create FlexCache
na_ontap_FlexCache:
state: present
origin_volume: test_src
name: test_dest
origin_vserver: ansible_src
vserver: ansible_dest
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete FlexCache
na_ontap_FlexCache:
state: absent
name: test_dest
vserver: ansible_dest
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
Authors¶
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>