Skip to main content

Endpoint Group

Location in GUI: Tenants » XXX » Application Profiles » XXX » Application EPGs

Diagram​

Classes​

application_profiles (apic.tenants)​

NameTypeConstraintMandatoryDefault Value
endpoint_groupsList[endpoint_groups]No

endpoint_groups (apic.tenants.application_profiles)​

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
aliasStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
ndo_managedBooleantrue, falseNofalse
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$No
flood_in_encapBooleantrue, falseNofalse
intra_epg_isolationBooleantrue, falseNofalse
preferred_groupBooleantrue, falseNofalse
proxy_arpBooleantrue, falseNofalse
bridge_domainStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
physical_domainsListString[Regex: ^[a-zA-Z0-9_.:-]{1,64}$]No
vmware_vmm_domainsList[vmware_vmm_domains]No
static_portsList[static_ports]No
static_leafsList[static_leafs]No
static_endpointsList[static_endpoints]No
subnetsList[subnets]No
contractsClass[contracts]No
qos_classChoicelevel1, level2, level3, level4, level5, level6, unspecifiedNounspecified
custom_qos_policyStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
tagsListString[Regex: ^[a-zA-Z0-9_.-]{1,64}$]No
trust_control_policyStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
l4l7_virtual_ipsList[l4l7_virtual_ips]No
l4l7_address_poolsList[l4l7_address_pools]No
expected_stateClass[expected_state]No

vmware_vmm_domains (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
u_segmentationBooleantrue, falseNofalse
delimiterStringRegex: ^[|~!@^+=]$No
vlanIntegermin: 1, max: 4096No
primary_vlanIntegermin: 1, max: 4096No
secondary_vlanIntegermin: 1, max: 4096No
netflowBooleantrue, falseNofalse
deployment_immediacyChoiceimmediate, lazyNolazy
resolution_immediacyChoiceimmediate, lazy, pre-provisionNopre-provision
allow_promiscuousChoicereject, acceptNoreject
forged_transmitsChoicereject, acceptNoreject
mac_changesChoicereject, acceptNoreject
elagStringRegex: ^[a-zA-Z0-9_.:-]{1,16}$No
active_uplinks_orderStringRegex: ^(\d+(,\d+)*)?$No
standby_uplinksStringRegex: ^(\d+(,\d+)*)?$No
custom_epg_nameStringRegex: ^.{1,80}$No

static_ports (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
node_idIntegermin: 1, max: 4000No
node2_idIntegermin: 1, max: 4000No
fex_idIntegermin: 101, max: 199No
fex2_idIntegermin: 101, max: 199No
pod_idIntegermin: 1, max: 255No
moduleIntegermin: 1, max: 9No1
portIntegermin: 1, max: 127No
sub_portIntegermin: 1, max: 16No
channelStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
vlanIntegermin: 1, max: 4096Yes
primary_vlanIntegermin: 1, max: 4096No
deployment_immediacyChoiceimmediate, lazyNolazy
modeChoiceregular, native, untaggedNoregular
ptpClass[ptp]No
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$No

static_leafs (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
node_idIntegermin: 1, max: 4000Yes
pod_idIntegermin: 1, max: 255No
vlanIntegermin: 1, max: 4096Yes
deployment_immediacyChoiceimmediate, lazyNolazy
modeChoiceregular, native, untaggedNoregular

static_endpoints (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
aliasStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
vlanIntegermin: 1, max: 4096No
macMACYes
ipIPNo0.0.0.0
typeChoicesilent-host, tep, vepYes
node_idIntegermin: 1, max: 4000No
node2_idIntegermin: 1, max: 4000No
pod_idIntegermin: 1, max: 255No
moduleIntegermin: 1, max: 9No1
portIntegermin: 1, max: 127No
channelStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
additional_ipsListIPNo

subnets (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$No
ipIPYes
publicBooleantrue, falseNofalse
sharedBooleantrue, falseNofalse
igmp_querierBooleantrue, falseNofalse
nd_ra_prefixBooleantrue, falseNotrue
no_default_gatewayBooleantrue, falseNofalse
virtualBooleantrue, falseNofalse
next_hop_ipIPNo
anycast_macMACNo
nlb_modeChoicemode-mcast-igmp, mode-uc, mode-mcast-staticNo
nlb_groupIPNo0.0.0.0
nlb_macMACNo00:00:00:00:00:00
ip_poolsList[ip_pools]No
nd_ra_prefix_policyStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
ip_dataplane_learningBooleantrue, falseNo

contracts (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
consumersListString[Regex: ^[a-zA-Z0-9_.:-]{1,64}$]No
providersListString[Regex: ^[a-zA-Z0-9_.:-]{1,64}$]No
imported_consumersListString[Regex: ^[a-zA-Z0-9_.:-]{1,64}$]No
intra_epgsListString[Regex: ^[a-zA-Z0-9_.:-]{1,64}$]No
mastersList[masters]No

l4l7_virtual_ips (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
ipIPYes
descriptionStringRegex: ^[a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]{1,128}$No

l4l7_address_pools (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
gateway_addressIPYes
fromIPNo
toIPNo

expected_state (apic.tenants.application_profiles.endpoint_groups)​

NameTypeConstraintMandatoryDefault Value
minimum_healthIntegermin: 0, max: 100No
maximum_critical_faultsIntegermin: 0No
maximum_major_faultsIntegermin: 0No
maximum_minor_faultsIntegermin: 0No

ptp (apic.tenants.application_profiles.endpoint_groups.static_ports)​

NameTypeConstraintMandatoryDefault Value
modeChoicemulticast, multicast-master, unicast-masterNomulticast
source_ipIPNo0.0.0.0
profileStringRegex: ^[a-zA-Z0-9_.:-]{1,16}$Yes

ip_pools (apic.tenants.application_profiles.endpoint_groups.subnets)​

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes
start_ipIPNo0.0.0.0
end_ipIPNo0.0.0.0
dns_search_suffixStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
dns_serverStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
dns_suffixStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
wins_serverStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No

masters (apic.tenants.application_profiles.endpoint_groups.contracts)​

NameTypeConstraintMandatoryDefault Value
application_profileStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$No
endpoint_groupStringRegex: ^[a-zA-Z0-9_.:-]{1,64}$Yes

Examples​

Simple example:

apic:
  tenants:
    - name: ABC
      application_profiles:
        - name: AP1
          endpoint_groups:
            - name: EPG1
              bridge_domain: BD1
              physical_domains:
                - PHY1
              static_ports:
                - node_id: 101
                  port: 10
                  vlan: 135
              contracts:
                consumers:
                  - CON1

Full example:

apic:
  tenants:
    - name: ABC
      application_profiles:
        - name: AP1
          endpoint_groups:
            - name: EPG1
              bridge_domain: BD1
              flood_in_encap: false
              intra_epg_isolation: false
              preferred_group: false
              physical_domains:
                - PHY1
              vmware_vmm_domains:
                - name: VMM1
                  u_segmentation: true
                  delimiter: '|'
                  vlan:
                  primary_vlan: 100
                  secondary_vlan: 101
                  netflow: false
                  deployment_immediacy: lazy
                  resolution_immediacy: immediate
                  allow_promiscuous: reject
                  forged_transmits: reject
                  mac_changes: reject
                  elag: ELAGCustom
                  active_uplinks_order: 1,2
                  standby_uplinks: 3,4
              static_ports:
                - node_id: 101
                  description: Static Port Description
                  port: 10
                  vlan: 135
                  mode: regular
                  deployment_immediacy: lazy
              static_leafs:
                - pod_id: 1
                  node_id: 101
                  vlan: 135
                  primary_vlan: 136
                  mode: regular
                  deployment_immediacy: lazy
              static_endpoints:
                - name: ST_EP1
                  mac: 00:00:00:00:00:01
                  ip: 1.1.1.1
                  type: silent-host
                  vlan: 123
                  node_id: 101
                  port: 1
              contracts:
                consumers:
                  - CON1
                providers:
                  - CON1
                imported_consumers:
                  - IMPORT-CON1
                intra_epgs:
                  - CON1
              subnets:
                - ip: 5.50.5.1/30
                  description: My Desc
                  public: true
                  shared: true
                  igmp_querier: true
                  nd_ra_prefix: true
                  no_default_gateway: false
                - ip: 5.50.5.5/32
                  no_default_gateway: true
                  next_hop_ip: 8.8.8.8
                  ips_pools:
                    - name: POOL1
                      start_ip: 172.16.0.1
                      end_ip: 172.16.0.10
                      dns_server: dns.cisco.com
                      dns_search_suffix: cisco
                      dns_suffix: cisco
                      wins_server: wins
                - ip: fd00:0:abcd:2::2/64
                  description: My IPv6 Desc
                  public: true
                  shared: false
                  igmp_querier: true
                  nd_ra_prefix: true
                  no_default_gateway: true
                  nd_ra_prefix_policy: ND-RA-PREFIX1
                  ip_dataplane_learning: false
              tags:
                - tag1
                - tag2
              l4l7_virtual_ips:
                - ip: 11.11.11.11
                  description: My LB VIP
              l4l7_address_pools:
                - name: L4L7_POOL1
                  gateway_address: 11.11.11.254/24
                  from: 11.11.11.100
                  to: 11.11.11.200