This repository has been archived by the owner on Feb 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 36
azure_rm_netapp_capacity_pool
Chris Archibald edited this page Mar 18, 2021
·
1 revision
.. Document meta
:orphan:
.. Anchors
.. _ansible_collections.netapp.azure.azure_rm_netapp_capacity_pool_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
netapp.azure.azure_rm_netapp_capacity_pool -- Manage NetApp Azure Files capacity pool +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the netapp.azure collection <https://galaxy.ansible.com/netapp/azure>_ (version 21.3.0).
To install it use: :code:`ansible-galaxy collection install netapp.azure`.
To use it in a playbook, specify: :code:`netapp.azure.azure_rm_netapp_capacity_pool`.
.. version_added
.. versionadded:: 19.10.0 of netapp.azure
.. contents:: :local: :depth: 1
.. Deprecated
.. Description
- Create and delete NetApp Azure capacity pool. Provide the Resource group name for the capacity pool to be created.
- Resize NetApp Azure capacity pool
.. Aliases
.. Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
- Python azure-mgmt. Install using 'pip install azure-mgmt'
- Python azure-mgmt-netapp. Install using 'pip install azure-mgmt-netapp'
- For authentication with Azure NetApp log in before you run your tasks or playbook with
az login.
.. Options
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-account_name"></div>
<b>account_name</b>
<a class="ansibleOptionLink" href="#parameter-account_name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span> </div>
</td>
<td>
</td>
<td>
<div>The name of the NetApp account.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-location"></div>
<b>location</b>
<a class="ansibleOptionLink" href="#parameter-location" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Resource location.</div>
<div>Required for create.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span> </div>
</td>
<td>
</td>
<td>
<div>The name of the capacity pool.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-resource_group"></div>
<b>resource_group</b>
<a class="ansibleOptionLink" href="#parameter-resource_group" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span> </div>
</td>
<td>
</td>
<td>
<div>Name of the resource group.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-service_level"></div>
<b>service_level</b>
<a class="ansibleOptionLink" href="#parameter-service_level" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">
added in 20.5.0 of netapp.azure
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>Standard</li>
<li>Premium</li>
<li>Ultra</li>
</ul>
</td>
<td>
<div>The service level of the file system.</div>
<div>Required for create.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-size"></div>
<b>size</b>
<a class="ansibleOptionLink" href="#parameter-size" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">1</div>
</td>
<td>
<div>Provisioned size of the pool (in chunks). Allowed values are in 4TiB chunks.</div>
<div>Provide number to be multiplied to 4TiB.</div>
<div>Required for create.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-state"></div>
<b>state</b>
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>present</b> ←</div></li>
<li>absent</li>
</ul>
</td>
<td>
<div>State <code>present</code> will check that the capacity pool exists with the requested configuration.</div>
<div>State <code>absent</code> will delete the capacity pool.</div>
</td>
</tr>
</table>
<br/>
.. Notes
.. note::
- The modules prefixed with azure_rm_netapp are built to support the Cloud Volume Services for Azure NetApp Files.
.. Seealso
.. seealso::
Sign in with Azure CLI <https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest>_
How to authenticate using the az login command.
.. Examples
.. code-block:: yaml+jinja
- name: Create Azure NetApp capacity pool
azure_rm_netapp_capacity_pool:
resource_group: myResourceGroup
account_name: tests-netapp
name: tests-pool
location: eastus
size: 2
service_level: Standard
- name: Resize Azure NetApp capacity pool
azure_rm_netapp_capacity_pool:
resource_group: myResourceGroup
account_name: tests-netapp
name: tests-pool
location: eastus
size: 3
service_level: Standard
- name: Delete Azure NetApp capacity pool
azure_rm_netapp_capacity_pool:
state: absent
resource_group: myResourceGroup
account_name: tests-netapp
name: tests-pool
.. Facts
.. Return values
.. Status (Presently only deprecated)
.. Authors
Authors
- NetApp Ansible Team (@carchi8py) <[email protected]>
.. Parsing errors
Need Help? Join Netapp.Io Slack Channel #configurationmgmt
AWS
Azure
- azure_rm_netapp_account
- azure_rm_netapp_capacity_pool
- azure_rm_netapp_snapshot
- azure_rm_netapp_volume
Cloud Manager
- na_cloudmanager_aggregate
- na_cloudmanager_cifs_server
- na_cloudmanager_connector_aws
- na_cloudmanager_connector_azure
- na_cloudmanager_connector_gcp
- na_cloudmanager_cvo_aws
- na_cloudmanager_cvo_azure
- na_cloudmanager_cvo_gcp
- na_cloudmanager_info
- na_cloudmanager_nss_account
- na_cloudmanager_volume
ElementSW
ONTAP
StorageGrid
Um Info