Access SPAN Destination Groups

Version:

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » SPAN » SPAN Destination Groups

Diagram

Classes

span (apic.access_policies)

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

destination_groups (apic.access_policies.span)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
node_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	No
sub_port	Integer	min: `1`, max: `16`	No
module	Integer	min: `1`, max: `9`	No	`1`
port	Integer	min: `1`, max: `127`	No
channel	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip	IP		No
source_prefix	String		No
dscp	Any	Choice[`unspecified`, `CS0`, `CS1`, `AF11`, `AF12`, `AF13`, `CS2`, `AF21`, `AF22`, `AF23`, `CS3`, `AF31`, `AF32`, `AF33`, `CS4`, `AF41`, `AF42`, `AF43`, `CS5`, `VA`, `EF`, `CS6`, `CS7`] or Integer[min: `0`, max: `63`]	No	`unspecified`
flow_id	Integer	min: `1`, max: `1023`	No	`1`
mtu	Integer	min: `64`, max: `9216`	No	`1518`
ttl	Integer	min: `1`, max: `255`	No	`64`
version	Choice	`1`, `2`	No	`2`
enforce_version	Boolean	`true`, `false`	No	`false`
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
application_profile	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_group	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

Examples

Example-1: This example demonstrates how to configure a SPAN destination group under access policies for ERSPAN. The destination group Lf1011-EPC-CP-DstGrp defines the ERSPAN collector with IP 192.168.101.151. The source_prefix 10.1.1.1 specifies the ERSPAN source IP. The MTU is set to 9216 to support jumbo frames. By default, the ERSPAN version is 2; in this example, it is explicitly set to 1. The tenant mgmt, application_profile Mgmt-AP, and endpoint_group VLAN-1001-EPG identify the EPG used to reach the collector. The collector IP must be reachable and learned in this EPG.

apic:
  access_policies:
    span:
      destination_groups:
        - name: Lf1011-EPC-CP-DstGrp
          description: ERSPAN destination group for the EPC-CP collector.
          ip: 192.168.101.151
          source_prefix: 10.1.1.1
          mtu: 9216
          version: 1
          tenant: mgmt
          application_profile: Mgmt-AP
          endpoint_group: VLAN-1001-EPG

Example-2: This example demonstrates how to configure a local SPAN destination group under access policies. The destination group Local-Span-DstGrp directs mirrored traffic to a physical interface on a specific leaf. The node_id and port fields identify the egress interface used for the SPAN destination (port 10 on node 1011). Because this is local SPAN, ERSPAN-specific fields such as ip, source_prefix, and version are not required. By default, the destination interface MTU is 1518 unless explicitly specified.

apic:
  access_policies:
    span:
      destination_groups:
        - name: Local-Span-DstGrp
          description: Local SPAN Destination Group
          node_id: 1011
          port: 10

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » SPAN » SPAN Destination Groups

Diagram

Classes

span (apic.access_policies)

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

destination_groups (apic.access_policies.span)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
node_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	No
sub_port	Integer	min: `1`, max: `16`	No
module	Integer	min: `1`, max: `9`	No	`1`
port	Integer	min: `1`, max: `127`	No
channel	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip	IP		No
source_prefix	String		No
dscp	Any	Choice[`unspecified`, `CS0`, `CS1`, `AF11`, `AF12`, `AF13`, `CS2`, `AF21`, `AF22`, `AF23`, `CS3`, `AF31`, `AF32`, `AF33`, `CS4`, `AF41`, `AF42`, `AF43`, `CS5`, `VA`, `EF`, `CS6`, `CS7`] or Integer[min: `0`, max: `63`]	No	`unspecified`
flow_id	Integer	min: `1`, max: `1023`	No	`1`
mtu	Integer	min: `64`, max: `9216`	No	`1518`
ttl	Integer	min: `1`, max: `255`	No	`64`
version	Choice	`1`, `2`	No	`2`
enforce_version	Boolean	`true`, `false`	No	`false`
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
application_profile	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_group	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

Examples

apic:
  access_policies:
    span:
      destination_groups:
        - name: TAP1
          description: My_SPAN_Destination
          node_id: 101
          port: 10

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » SPAN » SPAN Destination Groups

Diagram

Classes

span (apic.access_policies)

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

destination_groups (apic.access_policies.span)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
node_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	No
sub_port	Integer	min: `1`, max: `16`	No
module	Integer	min: `1`, max: `9`	No	`1`
port	Integer	min: `1`, max: `127`	No
channel	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip	IP		No
source_prefix	String		No
dscp	Any	Choice[`unspecified`, `CS0`, `CS1`, `AF11`, `AF12`, `AF13`, `CS2`, `AF21`, `AF22`, `AF23`, `CS3`, `AF31`, `AF32`, `AF33`, `CS4`, `AF41`, `AF42`, `AF43`, `CS5`, `VA`, `EF`, `CS6`, `CS7`] or Integer[min: `0`, max: `63`]	No	`unspecified`
flow_id	Integer	min: `1`, max: `1023`	No	`1`
mtu	Integer	min: `64`, max: `9216`	No	`1518`
ttl	Integer	min: `1`, max: `255`	No	`64`
version	Choice	`1`, `2`	No	`2`
enforce_version	Boolean	`true`, `false`	No	`false`
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
application_profile	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_group	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

Examples

apic:
  access_policies:
    span:
      destination_groups:
        - name: TAP1
          description: My_SPAN_Destination
          node_id: 101
          port: 10

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » SPAN » SPAN Destination Groups

Diagram

Classes

span (apic.access_policies)

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

destination_groups (apic.access_policies.span)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	Yes
description	String	Regex: `^[a-zA-Z0-9\\!#$%()*,-./:;@ _{\|}~?&+]{1,128}$`	No
node_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	No
sub_port	Integer	min: `1`, max: `16`	No
module	Integer	min: `1`, max: `9`	No	`1`
port	Integer	min: `1`, max: `127`	No
channel	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
ip	IP		No
source_prefix	String		No
dscp	Any	Choice[`unspecified`, `CS0`, `CS1`, `AF11`, `AF12`, `AF13`, `CS2`, `AF21`, `AF22`, `AF23`, `CS3`, `AF31`, `AF32`, `AF33`, `CS4`, `AF41`, `AF42`, `AF43`, `CS5`, `VA`, `EF`, `CS6`, `CS7`] or Integer[min: `0`, max: `63`]	No	`unspecified`
flow_id	Integer	min: `1`, max: `1023`	No	`1`
mtu	Integer	min: `64`, max: `9216`	No	`1518`
ttl	Integer	min: `1`, max: `255`	No	`64`
version	Choice	`1`, `2`	No	`2`
enforce_version	Boolean		No	`false`
tenant	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
application_profile	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No
endpoint_group	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

Examples

apic:
  access_policies:
    span:
      destination_groups:
        - name: TAP1
          description: My_SPAN_Destination
          node_id: 101
          port: 10