netapp.azure.azure_rm_netapp_snapshot module – Manage NetApp Azure Files Snapshot
Note
This module is part of the netapp.azure collection (version 21.10.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install netapp.azure
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.azure.azure_rm_netapp_snapshot
.
Note
The netapp.azure collection is considered unmaintained and will be removed from Ansible 10. See the discussion thread for more information.
New in netapp.azure 19.10.0
Synopsis
Create and delete NetApp Azure Snapshot.
Requirements
The below requirements are needed on the host that executes this module.
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
For authentication with Azure NetApp log in before you run your tasks or playbook with
az login
.Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Python azure-mgmt-netapp. Install using ‘pip install azure-mgmt-netapp’
Python azure-mgmt. Install using ‘pip install azure-mgmt’
The host that executes this module must have the azure.azcollection collection installed via galaxy
azure >= 2.0.0
python >= 2.7
Parameters
Parameter |
Comments |
---|---|
The name of the NetApp account. |
|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Resource location. Required for create. |
|
Parent argument. |
|
Parent argument. |
|
The name of the snapshot. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
The name of the capacity pool. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of the resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State State Choices:
|
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The name of the volume. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
The modules prefixed with azure_rm_netapp are built to support the Cloud Volume Services for Azure NetApp Files.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.- Sign in with Azure CLI
How to authenticate using the
az login
command.
Examples
- name: Create Azure NetApp Snapshot
netapp.azure.azure_rm_netapp_snapshot:
resource_group: myResourceGroup
account_name: tests-netapp
pool_name: tests-pool
volume_name: tests-volume2
name: tests-snapshot
location: eastus
- name: Delete Azure NetApp Snapshot
netapp.azure.azure_rm_netapp_snapshot:
state: absent
resource_group: myResourceGroup
account_name: tests-netapp
pool_name: tests-pool
volume_name: tests-volume2
name: tests-snapshot