Docs4dev
Docs
ansible / 2.10 / collections / community / general / na_cdot_volume_module.html

community.general.na_cdot_volume – Manage NetApp cDOT volumes

Note

This plugin is part of the community.general collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.na_cdot_volume.

DEPRECATED

Removed in

version 2.0.0

Why

Updated modules released with increased functionality

Alternative

Use netapp.ontap.na_ontap_volume instead.

Synopsis

  • Create or destroy volumes on NetApp cDOT

Requirements

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

  • A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 8.3
  • Ansible 2.2
  • netapp-lib (2015.9.25). Install using ‘pip install netapp-lib’

Parameters

Parameter Choices/Defaults Comments
aggregate_name
string
The name of the aggregate the flexvol should exist on. Required when state=present.
export_policy
string
Default:
"default"
Export policy to set for the specified junction path.
hostname
string / required
The hostname or IP address of the ONTAP instance.
infinite
boolean
    Choices:
  • no ←
  • yes
Set True if the volume is an Infinite Volume.
junction_path
string
Junction path where to mount the volume
name
string / required
The name of the volume to manage.
online
boolean
    Choices:
  • no
  • yes ←
Whether the specified volume is online, or not.
password
string / required
Password for the specified user.

aliases: pass
size
string
The size of the volume in (size_unit). Required when state=present.
size_unit
string
    Choices:
  • bytes
  • b
  • kb
  • mb
  • gb ←
  • tb
  • pb
  • eb
  • zb
  • yb
The unit used to interpret the size parameter.
snapshot_policy
string
Default:
"default"
Snapshot policy to set for the specified volume.
state
string / required
    Choices:
  • present
  • absent
Whether the specified volume should exist or not.
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
vserver
string / required
Name of the vserver to use.

Notes

Note

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

Examples

- name: Create FlexVol
  community.general.na_cdot_volume:
    state: present
    name: ansibleVolume
    infinite: False
    aggregate_name: aggr1
    size: 20
    size_unit: mb
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    junction_path: /ansibleVolume
    export_policy: all_nfs_networks
    snapshot_policy: daily

- name: Make FlexVol offline
  community.general.na_cdot_volume:
    state: present
    name: ansibleVolume
    infinite: False
    online: False
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Status

  • This module will be removed in version 2.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/na_cdot_volume_module.html