Documentation
  • Docs »
  • na_ontap_flexcache – NetApp ONTAP FlexCache - create/delete relationship

na_ontap_flexcache – NetApp ONTAP FlexCache - create/delete relationship

New in version 2.8.

Synopsis

  • Create/Delete FlexCache volume relationships

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
aggr_list
-
List of aggregates to host target FlexCache volume.
aggr_list_multiplier
-
Aggregate list repeat count.
auto_provision_as
-
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.
force_offline
boolean
    Choices:
  • no ←
  • yes
Offline FlexCache volume before deleting the FlexCache relationship.
The volume will be destroyed and data can be lost.
force_unmount
boolean
    Choices:
  • no ←
  • yes
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
    Choices:
  • no ←
  • yes
Enable and disable https
junction_path
-
Junction path of the cache volume.
ontapi
integer
The ontap api version to use
origin_cluster
-
Name of the origin cluster for the FlexCache.
Defaults to cluster associated with target vserver if absent.
Not used for creation.
origin_volume
-
Name of the origin volume for the FlexCache.
Required for creation.
origin_vserver
-
Name of the origin vserver for the FlexCache.
Required for creation.
password
string / required
Password for the specified user.

aliases: pass
size
-
Size of cache volume.
size_unit
-
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter.
state
-
    Choices:
  • present ←
  • absent
Whether the specified relationship should exist or not.
time_out
-
Default:
180
time to wait for flexcache creation or deletion in seconds
if 0, the request is asynchronous
default is set to 3 minutes
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.
volume
- / required
Name of the target volume for the FlexCache.
vserver
- / required
Name of the target vserver for the FlexCache.
Note that hostname, username, password are intended for the target vserver.

Notes

Note

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

Examples

- name: Create FlexCache
  na_ontap_FlexCache:
    state: present
    origin_volume: test_src
    volume: 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
    volume: test_dest
    vserver: ansible_dest
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Status

Authors

Hint

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