netapp.azure.azure_rm_netapp_snapshot – Manage NetApp Azure Files Snapshot

Note

This plugin is part of the netapp.azure collection (version 21.8.1).

To install it use: ansible-galaxy collection install netapp.azure.

To use it in a playbook, specify: netapp.azure.azure_rm_netapp_snapshot.

New in version 19.10.0: of netapp.azure

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 Choices/Defaults Comments
account_name
string / required
The name of the NetApp account.
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
string
added in 0.0.1 of netapp.azure
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of netapp.azure
Default:
"latest"
Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
auth_source
string
added in 0.0.1 of netapp.azure
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The msi was added in Ansible 2.6.
cert_validation_mode
string
added in 0.0.1 of netapp.azure
    Choices:
  • ignore
  • validate
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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of netapp.azure
Default:
"AzureCloud"
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
location
string
Resource location.
Required for create.
log_mode
string
Parent argument.
log_path
string
Parent argument.
name
string / required
The name of the snapshot.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
pool_name
string / required
The name of the capacity pool.
profile
string
Security profile found in ~/.azure/credentials file.
resource_group
string / required
Name of the resource group.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
State present will check that the snapshot exists with the requested configuration.
State absent will delete the snapshot.
subscription_id
string
Your Azure subscription Id.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
volume_name
string / required
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

Authors