Tenant

Version:

Tenant is a logical container used to segment and isolate network resources, policies, and configurations. Tenants allow multiple organizations, departments, or applications to securely share the same physical infrastructure while maintaining independent network and security policies.

Location in GUI: Tenants

Diagram

Classes

tenants (apic)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
alias	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
managed	Boolean	`true`, `false`	No	`true`
security_domains	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No

Examples

Example-1: This example defines a tenant named ABC with an alias ABC-ALIAS and a description. The tenant is associated with the security domain SECURITY-DOMAIN1. This configuration will create or manage the tenant, and associate it with the SECURITY-DOMAIN1 security domain.

apic:
  tenants:
    - name: ABC
      alias: ABC-ALIAS
      description: My Description
      security_domains:
        - SECURITY-DOMAIN1

Example-2: This example creates a tenant named FINANCE with the alias FIN-ALIAS and the description. The tenant is associated with two security domains: FIN_SEC_DOMAIN and AUDIT_SEC_DOMAIN.

apic:
  tenants:
    - name: FINANCE
      alias: FIN-ALIAS
      description: Finance Department Tenant
      security_domains:
        - FIN_SEC_DOMAIN
        - AUDIT_SEC_DOMAIN

The managed flag indicates if a tenant should be created/modified/deleted or is assumed to exist already and just acts a container for other objects. This flag is only relevant for Terraform.

Location in GUI: Tenants

Diagram

Classes

tenants (apic)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
alias	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
managed	Boolean	`true`, `false`	No	`true`
security_domains	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No

Examples

apic:
  tenants:
    - name: ABC
      alias: ABC-ALIAS
      description: My Description
      security_domains:
        - SECURITY-DOMAIN1

The managed flag indicates if a tenant should be created/modified/deleted or is assumed to exist already and just acts a container for other objects. This flag is only relevant for Terraform.

Location in GUI: Tenants

Diagram

Classes

tenants (apic)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
alias	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
managed	Boolean	`true`, `false`	No	`true`
security_domains	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No

Examples

apic:
  tenants:
    - name: ABC
      alias: ABC-ALIAS
      description: My Description
      security_domains:
        - SECURITY-DOMAIN1

The managed flag indicates if a tenant should be created/modified/deleted or is assumed to exist already and just acts a container for other objects. This flag is only relevant for Terraform.

Location in GUI: Tenants

Diagram

Classes

tenants (apic)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
alias	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
managed	Boolean	`true`, `false`	No	`true`
security_domains	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No

Examples

apic:
  tenants:
    - name: ABC
      alias: ABC-ALIAS
      description: My Description
      security_domains:
        - SECURITY-DOMAIN1