VSPAN Session

Version:

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » VSPAN » VSPAN Sessions

Diagram

Classes

vspan (apic.access_policies)

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

sessions (apic.access_policies.vspan)

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
admin_state	Boolean	`true`, `false`	No	`true`
sources	List	`[sources]`	No
destination	Class	`[destination]`	Yes

sources (apic.access_policies.vspan.sessions)

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
direction	Choice	`in`, `out`, `both`	Yes	`both`
access_paths	List	`[access_paths]`	No
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
endpoint	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

destination (apic.access_policies.vspan.sessions)

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

access_paths (apic.access_policies.vspan.sessions.sources)

Name	Type	Constraint	Mandatory	Default Value
node_id	Integer	min: `1`, max: `4000`	No
node2_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	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
type	Choice	`access`, `vpc`, `pc`	No

Examples

apic:
  access_policies:
    vspan:
      sessions:
        - name: SESSION1
          destination:
            name: DST_GRP1
          sources:
            - name: SRC1
              direction: both
              tenant: ABC
              application_profile: AP1
              endpoint_group: EPG1
              endpoint: 00:50:56:96:6B:4F
              access_paths:
                - node_id: 101
                  port: 1

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » VSPAN » VSPAN Sessions

Diagram

Classes

vspan (apic.access_policies)

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

sessions (apic.access_policies.vspan)

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
admin_state	Boolean	`true`, `false`	No	`true`
sources	List	`[sources]`	No
destination	Class	`[destination]`	Yes

sources (apic.access_policies.vspan.sessions)

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
direction	Choice	`in`, `out`, `both`	Yes	`both`
access_paths	List	`[access_paths]`	No
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
endpoint	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

destination (apic.access_policies.vspan.sessions)

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

access_paths (apic.access_policies.vspan.sessions.sources)

Name	Type	Constraint	Mandatory	Default Value
node_id	Integer	min: `1`, max: `4000`	No
node2_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	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
type	Choice	`access`, `vpc`, `pc`	No

Examples

apic:
  access_policies:
    vspan:
      sessions:
        - name: SESSION1
          destination:
            name: DST_GRP1
          sources:
            - name: SRC1
              direction: both
              tenant: ABC
              application_profile: AP1
              endpoint_group: EPG1
              endpoint: 00:50:56:96:6B:4F
              access_paths:
                - node_id: 101
                  port: 1

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » VSPAN » VSPAN Sessions

Diagram

Classes

vspan (apic.access_policies)

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

sessions (apic.access_policies.vspan)

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
admin_state	Boolean	`true`, `false`	No	`true`
sources	List	`[sources]`	No
destination	Class	`[destination]`	Yes

sources (apic.access_policies.vspan.sessions)

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
direction	Choice	`in`, `out`, `both`	Yes	`both`
access_paths	List	`[access_paths]`	No
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
endpoint	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

destination (apic.access_policies.vspan.sessions)

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

access_paths (apic.access_policies.vspan.sessions.sources)

Name	Type	Constraint	Mandatory	Default Value
node_id	Integer	min: `1`, max: `4000`	No
node2_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	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
type	Choice	`access`, `vpc`, `pc`	No

Examples

apic:
  access_policies:
    vspan:
      sessions:
        - name: SESSION1
          destination:
            name: DST_GRP1
          sources:
            - name: SRC1
              direction: both
              tenant: ABC
              application_profile: AP1
              endpoint_group: EPG1
              endpoint: 00:50:56:96:6B:4F
              access_paths:
                - node_id: 101
                  port: 1

Location in GUI: Fabric » Access Policies » Policies » Troubleshooting » VSPAN » VSPAN Sessions

Diagram

Classes

vspan (apic.access_policies)

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

sessions (apic.access_policies.vspan)

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
admin_state	Boolean		No	`true`
sources	List	`[sources]`	No
destination	Class	`[destination]`	Yes

sources (apic.access_policies.vspan.sessions)

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
direction	Choice	`in`, `out`, `both`	Yes	`both`
access_paths	List	`[access_paths]`	No
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
endpoint	String	Regex: `^[a-zA-Z0-9_.:-]{1,64}$`	No

destination (apic.access_policies.vspan.sessions)

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

access_paths (apic.access_policies.vspan.sessions.sources)

Name	Type	Constraint	Mandatory	Default Value
node_id	Integer	min: `1`, max: `4000`	No
node2_id	Integer	min: `1`, max: `4000`	No
pod_id	Integer	min: `1`, max: `255`	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
type	Choice	`access`, `vpc`, `pc`	No

Examples

apic:
  access_policies:
    vspan:
      sessions:
        - name: SESSION1
          destination:
            name: DST_GRP1
          sources:
            - name: SRC1
              direction: both
              tenant: ABC
              application_profile: AP1
              endpoint_group: EPG1
              endpoint: 00:50:56:96:6B:4F
              access_paths:
                - node_id: 101
                  port: 1