W3cubDocs

/Ansible

netapp.aws.aws_netapp_cvs_active_directory – NetApp AWS CloudVolumes Service Manage Active Directory.

Note

This plugin is part of the netapp.aws collection (version 21.6.0).

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.aws.

To use it in a playbook, specify: netapp.aws.aws_netapp_cvs_active_directory.

New in version 2.9.0: of netapp.aws

Synopsis

  • Create, Update, Delete ActiveDirectory on AWS Cloud Volumes Service.

Parameters

Parameter Choices/Defaults Comments
api_key
string / required
The access key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API.
api_url
string / required
The url to the AWSCVS Web Services Proxy or Embedded Web Services API.
DNS
string
DNS server address for the Active Directory domain
Required when state=present
Required when state=present, to modify ActiveDirectory properties.
domain
string
Name of the Active Directory domain
feature_flags
dictionary
added in 21.6.0 of netapp.aws
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.
trace_apis can be set to true to enable tracing, data is written to /tmp/um_apis.log.
netBIOS
string
NetBIOS name of the server.
password
string
Password of the Active Directory domain administrator
Required when state=present, to modify ActiveDirectory properties
region
string / required
The region to which the Active Directory credentials are associated.
secret_key
string / required
The secret_key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API.
state
string / required
    Choices:
  • present
  • absent
Whether the specified ActiveDirectory should exist or not.
username
string
Username of the Active Directory domain administrator
validate_certs
boolean
    Choices:
  • no
  • yes
Should https certificates be validated?

Notes

Note

  • The modules prefixed with aws_cvs_netapp are built to Manage AWS Cloud Volumes Service .

Examples

- name: Create Active Directory
  aws_netapp_cvs_active_directory.py:
    state: present
    region: us-east-1
    DNS: 101.102.103.123
    domain: mydomain.com
    password: netapp1!
    netBIOS: testing
    username: user1
    api_url : My_CVS_Hostname
    api_key: My_API_Key
    secret_key : My_Secret_Key

- name: Update Active Directory
  aws_netapp_cvs_active_directory.py:
    state: present
    region: us-east-1
    DNS: 101.102.103.123
    domain: mydomain.com
    password: netapp2!
    netBIOS: testingBIOS
    username: user2
    api_url : My_CVS_Hostname
    api_key: My_API_Key
    secret_key : My_Secret_Key

- name: Delete Active Directory
  aws_netapp_cvs_active_directory.py:
    state: absent
    region: us-east-1
    domain: mydomain.com
    api_url : My_CVS_Hostname
    api_key: My_API_Key
    secret_key : My_Secret_Key

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/aws/aws_netapp_cvs_active_directory_module.html