uSeg Endpoint Group

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

Diagram

Classes

application_profiles (apic.tenants)

Name	Type	Constraint	Mandatory	Default Value
useg_endpoint_groups	List	`[useg_endpoint_groups]`	No

useg_endpoint_groups (apic.tenants.application_profiles)

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
flood_in_encap	Boolean	`true`, `false`	No	`false`
intra_epg_isolation	Boolean	`true`, `false`	No	`false`
preferred_group	Boolean	`true`, `false`	No	`false`
bridge_domain	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
physical_domains	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
vmware_vmm_domains	List	`[vmware_vmm_domains]`	No
static_leafs	List	`[static_leafs]`	No
subnets	List	`[subnets]`	No
contracts	Class	`[contracts]`	No
qos_class	Choice	`level1`, `level2`, `level3`, `level4`, `level5`, `level6`, `unspecified`	No	`level3`
custom_qos_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
tags	List	String[Regex: `^[a-zA-Z0-9_.-]{1,64}$`]	No
trust_control_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
l4l7_address_pools	List	`[l4l7_address_pools]`	No

vmware_vmm_domains (apic.tenants.application_profiles.useg_endpoint_groups)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
deployment_immediacy	Choice	`immediate`, `lazy`	No	`immediate`
elag	String	Regex: `^[a-zA-Z0-9_.:-]{1,16}$`	No
netflow	Boolean	`true`, `false`	No	`false`
active_uplinks_order	String	Regex: `^(\d+(,\d+)*)?$`	No
standby_uplinks	String	Regex: `^(\d+(,\d+)*)?$`	No

static_leafs (apic.tenants.application_profiles.useg_endpoint_groups)

Name	Type	Constraint	Mandatory	Default Value
node_id	Integer	min: `1`, max: `4000`	Yes
pod_id	Integer	min: `1`, max: `255`	No

subnets (apic.tenants.application_profiles.useg_endpoint_groups)

Name	Type	Constraint	Mandatory	Default Value
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
ip	IP		Yes
public	Boolean	`true`, `false`	No	`false`
shared	Boolean	`true`, `false`	No	`false`
igmp_querier	Boolean	`true`, `false`	No	`false`
nd_ra_prefix	Boolean	`true`, `false`	No	`true`
no_default_gateway	Boolean	`true`, `false`	No	`false`
virtual	Boolean	`true`, `false`	No	`false`
next_hop_ip	IP		No
anycast_mac	MAC		No
nlb_mode	Choice	`mode-mcast-igmp`, `mode-uc`, `mode-mcast-static`	No
nlb_group	IP		No	`0.0.0.0`
nlb_mac	MAC		No	`00:00:00:00:00:00`
ip_pools	List	`[ip_pools]`	No
nd_ra_prefix_policy	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

contracts (apic.tenants.application_profiles.useg_endpoint_groups)

Name	Type	Constraint	Mandatory
consumers	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
providers	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
imported_consumers	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
intra_epgs	List	String[Regex: `^[a-zA-Z0-9_.:-]{1,64}$`]	No
masters	List	`[masters]`	No

l4l7_address_pools (apic.tenants.application_profiles.useg_endpoint_groups)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
gateway_address	IP		Yes
from	IP		No
to	IP		No

ip_pools (apic.tenants.application_profiles.useg_endpoint_groups.subnets)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
start_ip	IP		No	`0.0.0.0`
end_ip	IP		No	`0.0.0.0`
dns_search_suffix	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
dns_server	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
dns_suffix	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
wins_server	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

masters (apic.tenants.application_profiles.useg_endpoint_groups.contracts)

Name	Type	Constraint	Mandatory	Default Value
application_profile	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_group	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes

Examples

Simple example:

apic:
  tenants:
    - name: ABC
      application_profiles:
        - name: AP1
          useg_endpoint_groups:
            - name: uSeg_EPG1
              bridge_domain: BD1
              physical_domains:
                - PHY1
              static_leafs:
                - node_id: 102
              contracts:
                consumers:
                  - CON1
              useg_attributes:
                ip_statements:
                  - name: ip_1
                    use_epg_subnet: false
                    ip: 5.50.6.128/25
                mac_statements:
                  - name: mac_1
                    mac: 02:42:68:22:58:D1

Full example:

apic:
  tenants:
    - name: ABC
      application_profiles:
        - name: AP1
          useg_endpoint_groups:
            - name: uSeg_EPG1
              bridge_domain: BD1
              flood_in_encap: false
              intra_epg_isolation: false
              preferred_group: false
              trust_control_policy: TRUST_ALL
              qos_class: level3
              custom_qos_policy: QOS_POL
              physical_domains:
                - PHY1
              vmware_vmm_domains:
                - name: VMM1
                  netflow: false
                  deployment_immediacy: lazy
                  elag: ELAGCustom
                  active_uplinks_order: 1,2
                  standby_uplinks: 3,4
              static_leafs:
                - node_id: 102
              contracts:
                consumers:
                  - CON1
                providers:
                  - CON1
                imported_consumers:
                  - IMPORT-CON1
                intra_epgs:
                  - CON1
                masters:
                  - application_profile: AP1
                    endpoint_group: EPG1
              useg_attributes:
                match_type: any
                ip_statements:
                  - name: ip_1
                    use_epg_subnet: false
                    ip: 5.50.6.128/25
                  - name: ip_2
                    use_epg_subnet: true
                mac_statements:
                  - name: mac_1
                    mac: 02:42:68:22:58:D1
                  - name: mac_2
                    mac: 02:42:68:22:58:D2
                vm_statements:
                  - name: vm_name
                    value: BackEnd
                    operator: startsWith
                  - name: operating_system
                    value: Win11
                    type: guest-os
                    operator: contains
                  - name: hypervisor_identifier
                    value: ESXi
                    type: hv
                    operator: endsWith
                  - name: vm_identifier
                    value: Cluster1
                    type: vm
                  - name: vnic_dn
                    type: vnic
                    value: vnic1
                  - name: vmm_domain
                    type: domain
                    value: VMM_DOMAIN
                  - name: datacenter
                    type: rootContName
                    value: DC1
                  - name: custom_attribute
                    type: custom-label
                    label: attr_label
                    value: attr_value0
                  - name: tag
                    type: tag
                    category: attr_tag
                    value: attr_value1
                  - name: vm_folder
                    type: vm-folder
                    value: data
                  - name: vm_folder_path
                    type: vmfolder-path
                    value: /folder/data
              subnets:
                - ip: 5.50.6.1/30
                  description: My Desc
                  public: true
                  shared: true
                  igmp_querier: true
                  nd_ra_prefix: true
                  no_default_gateway: false
                - ip: 5.50.6.5/32
                  no_default_gateway: true
                  next_hop_ip: 8.8.8.8
                  ip_pools:
                    - name: POOL1
                      start_ip: 172.16.1.1
                      end_ip: 172.16.1.10
                      dns_server: dns.cisco.com
                      dns_search_suffix: cisco
                      dns_suffix: cisco
                      wins_server: wins
                    - name: POOL2
                - ip: 5.50.6.6/32
                  no_default_gateway: true
                  anycast_mac: 00:00:00:01:02:03
                - ip: 5.50.6.7/32
                  no_default_gateway: true
                  nlb_mode: mode-mcast-igmp
                  nlb_group: 230.1.1.1
                - ip: 5.50.6.8/32
                  no_default_gateway: true
                  nlb_mode: mode-uc
                  nlb_mac: 00:00:00:01:01:01
                - ip: 5.50.6.9/32
                  no_default_gateway: true
                  nlb_mode: mode-mcast-static
                  nlb_mac: 03:00:0C:CC:CC:CC
                - 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: false
                  nd_ra_prefix_policy: ND_RA_PREFIX1
              tags:
                - tag1
                - tag2
              l4l7_address_pools:
                - name: L4L7_POOL1
                  gateway_address: 11.11.12.254/24
                  from: 11.11.12.100
                  to: 11.11.12.200