Skip to content

Latest commit

 

History

History
339 lines (319 loc) · 13 KB

avi_cluster.rst

File metadata and controls

339 lines (319 loc) · 13 KB

vmware.alb.avi_cluster

Module for setup of Cluster Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
name
str
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
nodes
list
required: true
- Minimum of 1 items required.
- Maximum of 7 items allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
rejoin_nodes_automatically
bool
- Re-join cluster nodes automatically in the event one of the node is reset to factory.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
virtual_ip
dict
- A v4 virtual ip address.
- This v4 ip address will be dynamically reconfigured so that it always is the ip of the cluster leader.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
virtual_ip6
dict
- A v6 virtual ip address.
- This v6 ip address will be dynamically reconfigured so that it always is the ip of the cluster leader.
- Field introduced in 30.2.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create Cluster object
      avi_cluster:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_cluster

Authors