Skip to content
This repository has been archived by the owner on Feb 24, 2022. It is now read-only.

azure_rm_netapp_account

Chris Archibald edited this page Mar 18, 2021 · 1 revision
orphan:

netapp.azure.azure_rm_netapp_account -- Manage NetApp Azure Files Account

Note

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

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

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

.. versionadded:: 19.10.0 of netapp.azure

  • Create and delete NetApp Azure account. Provide the Resource group name for the NetApp account to be created.

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.
Parameter Choices/Defaults Comments
active_directories
list / elements=dictionary
added in 21.2.0 of netapp.azure
list of active directory dictionaries.
The list is currently limited to a single active directory (ANF or Azure limit of one AD per subscription).
active_directory_id
string
not used for create. Not needed for join.
ad_name
string
added in 21.3.0 of netapp.azure
Name of the active directory machine. Used only while creating kerberos volume.
aes_encryption
boolean
    Choices:
  • no
  • yes
If enabled, AES encryption will be enabled for SMB communication.
dns
list / elements=string
list of DNS addresses. Required for create or join.
domain
string
Fully Qualified Active Directory DNS Domain Name. Required for create or join.
kdc_ip
string
added in 21.3.0 of netapp.azure
kdc server IP addresses for the active directory machine. Used only while creating kerberos volume.
ldap_signing
boolean
    Choices:
  • no
  • yes
Specifies whether or not the LDAP traffic needs to be signed.
organizational_unit
string
LDAP Path for the Organization Unit where SMB Server machine accounts will be created (i.e. OU=SecondLevel,OU=FirstLevel).
password
string
see username. If password is present, the module is not idempotent, as we cannot check the current value. Required for create or join.
server_root_ca_certificate
string
added in 21.3.0 of netapp.azure
When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.
site
string
The Active Directory site the service will limit Domain Controller discovery to.
smb_server_name
string
Prefix for creating the SMB server's computer account name in the Active Directory domain. Required for create or join.
username
string
Credentials that have permissions to create SMB server machine account in the AD domain. Required for create or join.
debug
boolean
    Choices:
  • no ←
  • yes
output details about current account if it exists.
location
string
Resource location.
Required for create.
name
string / required
The name of the NetApp account.
resource_group
string / required
Name of the resource group.
state
string
    Choices:
  • absent
  • present ←
State present will check that the NetApp account exists with the requested configuration.
State absent will delete the NetApp account.
tags
dictionary
added in 20.5.0 of netapp.azure
name/value pairs that enable you to categorize resources.
view consolidated billing by applying the same tag to multiple resources and resource groups.
Tag names are case-insensitive and tag values are case-sensitive.

Note

  • The modules prefixed with azure_rm_netapp are built to support the Cloud Volume Services for Azure NetApp Files.
.. 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.

- name: Create NetApp Azure Account
  azure_rm_netapp_account:
    resource_group: myResourceGroup
    name: testaccount
    location: eastus
    tags: {'abc': 'xyz', 'cba': 'zyx'}

- name: Modify Azure NetApp account (Join AD)
  azure_rm_netapp_account:
    resource_group: myResourceGroup
    name: testaccount
    location: eastus
    active_directories:
      - site: ln
        dns: 10.10.10.10
        domain: domain.com
        smb_server_name: dummy
        password: xxxxxx
        username: laurentn

- name: Delete NetApp Azure Account
  azure_rm_netapp_account:
    state: absent
    resource_group: myResourceGroup
    name: testaccount
    location: eastus

- name: Create Azure NetApp account (with AD)
  azure_rm_netapp_account:
    resource_group: laurentngroupnodash
    name: tests-netapp11
    location: eastus
    tags:
      creator: laurentn
      use: Ansible
    active_directories:
      - site: ln
        dns: 10.10.10.10
        domain: domain.com
        smb_server_name: dummy
        password: xxxxxx
        username: laurentn

Authors