Documentation

avi_tenant - Module for setup of Tenant Avi RESTful Object

New in version 2.3.

Synopsis

Options

parameter required default choices comments
config_settings
 no
Tenantconfiguration settings for tenant.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
created_by
 no
Creator of this tenant.
description
 no
User defined description for the object.
local
 no
Boolean flag to set local.
Default value when not specified in API or module is interpreted by Avi Controller as True.
name
 yes
Name of the object.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
 no present
  • absent
  • 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_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.

Examples

- name: Create Tenant using Service Engines in provider mode
  avi_tenant:
    controller: ''
    password: ''
    username: ''
    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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj Tenant (api/tenant) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.