New in version 2.4.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_version | no | Avi API version of to use for Avi API and objects. | ||
| controller | no | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. | ||
| name | yes | Name of the object. | ||
| nodes | no | List of clusternode. | ||
| password | no | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. | ||
| rejoin_nodes_automatically | no | Re-join cluster nodes automatically in the event one of the node is reset to factory. Default value when not specified in API or module is interpreted by Avi Controller as True. | ||
| state | no | present |
| The state that should be applied on the entity. |
| tenant | no | admin | Name of tenant used for all Avi API calls and context of object. | |
| tenant_ref | no | It is a reference to an object of type tenant. | ||
| tenant_uuid | no | UUID of tenant used for all Avi API calls and context of object. | ||
| url | no | Avi controller URL of the object. | ||
| username | no | Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME. | ||
| uuid | no | Unique object identifier of the object. | ||
| virtual_ip | no | A virtual ip address. This ip address will be dynamically reconfigured so that it always is the ip of the cluster leader. |
- name: Example to create Cluster object
avi_cluster:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_cluster
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| obj | Cluster (api/cluster) object | success, changed | dict |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/avi_cluster_module.html