ansible.builtin.na_ontap_flexcache (v2.9.26) — module

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

Create/Delete FlexCache volume relationships

Requirements

• 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.
• Ansible 2.6
• Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.
• 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'
• netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
• To enable http on the cluster you must run the following commands 'set -privilege advanced;' 'system services web modify -http-enabled true;'

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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 }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - name: Delete FlexCache
      na_ontap_FlexCache:
        state: absent
        volume: test_dest
        vserver: ansible_dest
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"

Inputs

    
size:
    description:
    - Size of cache volume.

https:
    default: false
    description:
    - Enable and disable https.
    - Ignored when using REST as only https is supported.
    - Ignored when using SSL certificate authentication as it requires SSL.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified relationship should exist or not.

ontapi:
    description:
    - The ontap api version to use
    type: int

volume:
    description:
    - Name of the target volume for the FlexCache.
    required: true

vserver:
    description:
    - Name of the target vserver for the FlexCache.
    - Note that hostname, username, password are intended for the target vserver.
    required: true

hostname:
    description:
    - The hostname or IP address of the ONTAP instance.
    required: true
    type: str

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    type: str

time_out:
    default: 180
    description:
    - time to wait for flexcache creation or deletion in seconds
    - if 0, the request is asynchronous
    - default is set to 3 minutes

use_rest:
    choices:
    - Never
    - Always
    - Auto
    default: Auto
    description:
    - 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
    type: str

username:
    aliases:
    - user
    description:
    - 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 U(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.
    type: str

aggr_list:
    description:
    - List of aggregates to host target FlexCache volume.

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

size_unit:
    choices:
    - bytes
    - b
    - kb
    - mb
    - gb
    - tb
    - pb
    - eb
    - zb
    - yb
    default: gb
    description:
    - The unit used to interpret the size parameter.

key_filepath:
    description:
    - path to SSL client key file.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

cert_filepath:
    description:
    - path to SSL client cert file (.pem).
    - not supported with python 2.6.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

feature_flags:
    description:
    - 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.
    type: dict
    version_added: 20.5.0
    version_added_collection: netapp.ontap

force_offline:
    default: false
    description:
    - Offline FlexCache volume before deleting the FlexCache relationship.
    - The volume will be destroyed and data can be lost.
    type: bool

force_unmount:
    default: false
    description:
    - Unmount FlexCache volume. Delete the junction path at which the volume is mounted
      before deleting the FlexCache relationship.
    type: bool

junction_path:
    description:
    - Junction path of the cache volume.

origin_volume:
    description:
    - Name of the origin volume for the FlexCache.
    - Required for creation.

origin_cluster:
    description:
    - Name of the origin cluster for the FlexCache.
    - Defaults to cluster associated with target vserver if absent.
    - Not used for creation.

origin_vserver:
    description:
    - Name of the origin vserver for the FlexCache.
    - Required for creation.

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(False) used on personally controlled sites using self-signed
      certificates.
    type: bool

auto_provision_as:
    description:
    - 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.

aggr_list_multiplier:
    description:
    - Aggregate list repeat count.