Skip to content

Latest commit

 

History

History
408 lines (387 loc) · 16.2 KB

avi_tenant.rst

File metadata and controls

408 lines (387 loc) · 16.2 KB

vmware.alb.avi_tenant

Module for setup of Tenant 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.
attrs
list
- Key/value tenant attributes.
- Field introduced in 30.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
config_settings
dict
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
created_by
str
- Creator of this tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enforce_label_group
bool
- The referred label groups are enforced on the tenant if this is set to true.if this is set to false, the label groups are suggested for the
- tenant.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
label_group_refs
list
- The label_groups to be enforced on the tenant.
- This is strictly enforced only if enforce_label_group is set to true.
- It is a reference to an object of type labelgroup.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
local
bool
- 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.
name
str
required: true
- 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.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "{{ username }}"
      password: "{{ password }}"
      controller: "{{ controller }}"
      api_version: "{{ api_version }}"
  tasks:
    - name: Create Tenant using Service Engines in provider mode
      avi_tenant:
        avi_credentials: "{{ avi_credentials }}"
        config_settings:
          se_in_provider_context: false
          tenant_access_to_provider_se: true
          tenant_vrf: false
        description: VCenter, Open Stack, AWS Virtual services
        local: true
        name: Demo

Authors