Skip to content

Endpoint Group

Location in GUI: Application Management » Schemas

Diagram

application_profiles (ndo.schemas.templates)

Section titled “application_profiles (ndo.schemas.templates)”
NameTypeConstraintMandatoryDefault Value
endpoint_groupsList[endpoint_groups]No

endpoint_groups (ndo.schemas.templates.application_profiles)

Section titled “endpoint_groups (ndo.schemas.templates.application_profiles)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,64}$No
usegBooleantrue, falseNofalse
intra_epg_isolationBooleantrue, falseNofalse
proxy_arpBooleantrue, falseNofalse
preferred_groupBooleantrue, falseNofalse
bridge_domainClass[bridge_domain]No
vrfClass[vrf]No
subnetsList[subnets]No
contractsClass[contracts]No
sitesList[sites]No

bridge_domain (ndo.schemas.templates.application_profiles.endpoint_groups)

Section titled “bridge_domain (ndo.schemas.templates.application_profiles.endpoint_groups)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
schemaStringNo
templateStringNo

vrf (ndo.schemas.templates.application_profiles.endpoint_groups)

Section titled “vrf (ndo.schemas.templates.application_profiles.endpoint_groups)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
schemaStringNo
templateStringNo

subnets (ndo.schemas.templates.application_profiles.endpoint_groups)

Section titled “subnets (ndo.schemas.templates.application_profiles.endpoint_groups)”
NameTypeConstraintMandatoryDefault Value
ipIPYes
scopeChoiceprivate, publicNoprivate
sharedBooleantrue, falseNofalse
no_default_gatewayBooleantrue, falseNofalse
primaryBooleantrue, falseNofalse

contracts (ndo.schemas.templates.application_profiles.endpoint_groups)

Section titled “contracts (ndo.schemas.templates.application_profiles.endpoint_groups)”
NameTypeConstraintMandatoryDefault Value
consumersList[consumers]No
providersList[providers]No

sites (ndo.schemas.templates.application_profiles.endpoint_groups)

Section titled “sites (ndo.schemas.templates.application_profiles.endpoint_groups)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
physical_domainsList[physical_domains]No
vmware_vmm_domainsList[vmware_vmm_domains]No
static_portsList[static_ports]No
static_leafsList[static_leafs]No
subnetsList[subnets]No
selectorsList[selectors]No

consumers (ndo.schemas.templates.application_profiles.endpoint_groups.contracts)

Section titled “consumers (ndo.schemas.templates.application_profiles.endpoint_groups.contracts)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
schemaStringNo
templateStringNo

providers (ndo.schemas.templates.application_profiles.endpoint_groups.contracts)

Section titled “providers (ndo.schemas.templates.application_profiles.endpoint_groups.contracts)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
schemaStringNo
templateStringNo

physical_domains (ndo.schemas.templates.application_profiles.endpoint_groups.sites)

Section titled “physical_domains (ndo.schemas.templates.application_profiles.endpoint_groups.sites)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
deployment_immediacyChoiceimmediate, lazyNolazy
resolution_immediacyChoiceimmediate, lazy, pre-provisionNoimmediate

vmware_vmm_domains (ndo.schemas.templates.application_profiles.endpoint_groups.sites)

Section titled “vmware_vmm_domains (ndo.schemas.templates.application_profiles.endpoint_groups.sites)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
deployment_immediacyChoiceimmediate, lazyNolazy
resolution_immediacyChoiceimmediate, lazy, pre-provisionNopre-provision
custom_epg_nameStringRegex: ^.{1,80}$No
vlan_modeChoicestatic, dynamicNodynamic
vlanIntegermin: 1, max: 4096No
u_segmentationBooleantrue, falseNofalse
useg_vlanIntegermin: 1, max: 4096No

static_ports (ndo.schemas.templates.application_profiles.endpoint_groups.sites)

Section titled “static_ports (ndo.schemas.templates.application_profiles.endpoint_groups.sites)”
NameTypeConstraintMandatoryDefault Value
typeChoiceport, vpc, pcNoport
podIntegermin: 1, max: 255No
nodeIntegermin: 1, max: 4000No
fexIntegermin: 101, max: 199No
fex_2Integermin: 101, max: 199No
node_1Integermin: 1, max: 4000No
node_2Integermin: 1, max: 4000No
portIntegermin: 1, max: 127No
sub_portIntegermin: 1, max: 16No
moduleIntegermin: 1, max: 9No
channelStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
vlanIntegermin: 1, max: 4096Yes
useg_vlanIntegermin: 1, max: 4096No
deployment_immediacyChoiceimmediate, lazyNolazy
modeChoiceregular, native, untaggedNoregular

static_leafs (ndo.schemas.templates.application_profiles.endpoint_groups.sites)

Section titled “static_leafs (ndo.schemas.templates.application_profiles.endpoint_groups.sites)”
NameTypeConstraintMandatoryDefault Value
podIntegermin: 1, max: 255No
nodeIntegermin: 1, max: 4000Yes
vlanIntegermin: 1, max: 4096Yes

subnets (ndo.schemas.templates.application_profiles.endpoint_groups.sites)

Section titled “subnets (ndo.schemas.templates.application_profiles.endpoint_groups.sites)”
NameTypeConstraintMandatoryDefault Value
ipIPYes
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,64}$No
scopeChoiceprivate, publicNoprivate
sharedBooleantrue, falseNofalse
no_default_gatewayBooleantrue, falseNofalse
primaryBooleantrue, falseNofalse

selectors (ndo.schemas.templates.application_profiles.endpoint_groups.sites)

Section titled “selectors (ndo.schemas.templates.application_profiles.endpoint_groups.sites)”
NameTypeConstraintMandatoryDefault Value
nameStringYes
expressionsList[expressions]No

expressions (ndo.schemas.templates.application_profiles.endpoint_groups.sites.selectors)

Section titled “expressions (ndo.schemas.templates.application_profiles.endpoint_groups.sites.selectors)”
NameTypeConstraintMandatoryDefault Value
keyChoiceipAddress, regionYes
operatorChoiceequals, notEqualsYes
valueStringYes

Example-1: Here is an example of an Endpoint Group(EPG) named Database_VMM under the OnPrem Tenant/Schema and the Prod_VMM application profile. Two contracts, database_access_contract and web_traffic_contract are provided and consumed to facilitate communication with other EPGs. The contracts are defined in the Site_A template. Further details on the contracts are explained in the contract section.

The subnets are defined with the scope set to private, and the no_default_gateway flag is set to true, indicating that the gateway is managed either at the Bridge Domain level or externally.

This EPG is used to host endpoints from the VMM domain with dynamic VLAN allocation and immediate deployment policy.

ndo:
schemas:
- name: OnPrem
templates:
- name: Site_A
application_profiles:
- name: PROD_VMM
endpoint_groups:
- name: Database_VMM
preferred_group: false
bridge_domain:
name: Database_BD
schema: OnPrem
template: Site_A
contracts:
providers:
- name: database_access_contract
template: TEMPLATE1
consumers:
- name: web_traffic_contract
template: TEMPLATE1
subnets:
- ip: 2.2.2.2/24
scope: private
no_default_gateway: true
sites:
- name: Site_A
vmware_vmm_domains:
- name: ANS-VMM1
deployment_immediacy: immediate
resolution_immediacy: immediate
vlan_mode: dynamic

Example-2: The example below demonstrates configuring a EndPoint Group(EPG) named Web under the application profile Prod and schema Azure. Two contracts, web_traffic_contract and database_access_contract are provided and consumed to facilitate communication with other EPGs. The contracts are defined in the Site_A template.

The phyical domain Prod_PHY is attached to the EPG to enable VLAN encapsulation 1001 to be pushed to the leaf switches and the physical endpoints attached to ACI.

The static bindings are defined under the EPG as shown below. In this example, there are two bindings: one with a VPC using Leafs 101 and 102 of Pod-1 with an Interface Polixy Group(IPG) named VPC_IPG defined under the channel and an encapsulation VLAN of 1001; and the other as as an individual port 1 on leaf 103 with deployment immediacy set to immediate, indicating the policy is programmed into hardware as soon as it is downloaded to the leaf switches rather than waiting for the first packet to hit this policy.

ndo:
schemas:
- name: Azure
templates:
- name: Site_A
application_profiles:
- name: Prod
endpoint_groups:
- name: Web
bridge_domain:
name: Web_BD
contracts:
providers:
- name: web_traffic_contract
template: Site_A
consumers:
- name: database_access_contract
template: Site_A
sites:
- name: Site_A
physical_domains:
- name: Prod_PHY
deployment_immediacy: immediate
resolution_immediacy: immediate
static_ports:
- vlan: 1001
pod: 1
- type: vpc
node_1: 101
node_2: 102
channel: VPC_IPG
static_ports:
- vlan: 1001
pod: 1
node: 103
port: 1
deployment_immediacy: immediate