ansible.builtin.na_ontap_aggregate (v2.7.7) — module

NetApp ONTAP manage aggregates.

| "added in version" 2.6 of ansible.builtin"

Authors: NetApp Ansible Team (ng-ansibleteam@netapp.com)

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.7.7

Description

Create, delete, or manage aggregates on ONTAP.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create Aggregates
  na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    disk_count: 1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Manage Aggregates
  na_ontap_aggregate:
    state: present
    service_state: offline
    unmount_volumes: true
    name: ansibleAggr
    disk_count: 1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Rename Aggregates
  na_ontap_aggregate:
    state: present
    service_state: online
    name: ansibleAggr
    rename: ansibleAggr2
    disk_count: 1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete Aggregates
  na_ontap_aggregate:
    state: absent
    service_state: offline
    unmount_volumes: true
    name: ansibleAggr
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Inputs

    
name:
    description:
    - The name of the aggregate to manage.
    required: true

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

nodes:
    description:
    - Node(s) for the aggregate to be created on.  If no node specified, mgmt lif home
      will be used.
    - If multiple nodes specified an aggr stripe will be made.

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

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

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

use_rest:
    default: auto
    description:
    - Whether to use REST or ZAPI.
    - always -- will always use the REST API if the module supports REST. A warning is
      issued if the module does not support REST. An error is issued if a module option
      is not supported in REST.
    - never -- will always use ZAPI if the module supports ZAPI.  An error may be issued
      if a REST option is not supported in ZAPI.
    - auto -- will try to use the REST API if the module supports REST and modules options
      are supported.  Reverts to ZAPI otherwise.
    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

disk_size:
    description:
    - Disk size to use in 4K block size.  Disks within 10% of specified size will be used.
    version_added: '2.7'
    version_added_collection: ansible.builtin

disk_type:
    choices:
    - ATA
    - BSAS
    - FCAL
    - FSAS
    - LUN
    - MSATA
    - SAS
    - SSD
    - VMDISK
    description:
    - Type of disk to use to build aggregate
    version_added: '2.7'
    version_added_collection: ansible.builtin

from_name:
    description:
    - Name of the aggregate to be renamed.
    version_added: '2.7'
    version_added_collection: ansible.builtin

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

raid_size:
    description:
    - Sets the maximum number of drives per raid group.
    version_added: '2.7'
    version_added_collection: ansible.builtin

raid_type:
    description:
    - Specifies the type of RAID groups to use in the new aggregate.
    - The default value is raid4 on most platforms.
    version_added: '2.7'
    version_added_collection: ansible.builtin

disk_count:
    description:
    - Number of disks to place into the aggregate, including parity disks.
    - The disks in this newly-created aggregate come from the spare disk pool.
    - The smallest disks in this pool join the aggregate first, unless the C(disk-size)
      argument is provided.
    - Either C(disk-count) or C(disks) must be supplied. Range [0..2^31-1].
    - Required when C(state=present).

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

service_state:
    choices:
    - online
    - offline
    description:
    - Whether the specified aggregate should be enabled or disabled. Creates aggregate
      if doesnt exist.

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

unmount_volumes:
    description:
    - If set to "TRUE", this option specifies that all of the volumes hosted by the given
      aggregate are to be unmounted
    - before the offline operation is executed.
    - By default, the system will reject any attempt to offline an aggregate that hosts
      one or more online volumes.
    type: bool

force_ontap_version:
    description:
    - Override the cluster ONTAP version when using REST.
    - The behavior is undefined if the version does not match the target cluster.
    - This is provided as a work-around when the cluster version cannot be read because
      of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.
    - This should be in the form 9.10 or 9.10.1 with each element being an integer number.
    - When C(use_rest) is set to auto, this may force a switch to ZAPI based on the version
      and platform capabilities.
    - Ignored with ZAPI.
    type: str
    version_added: 21.23.0
    version_added_collection: netapp.ontap