Data Object - VMwareVspanSession
- Property of
- See also
- vSphere API 5.0
The VMwareVspanSession data object
defines the configuration of a VLAN Services and Protocols for Advanced Networks
(VSPAN) session. You use a VSPAN session for the following operations:
- To mirror network traffic (inbound/outbound) from a set of source
entities to a set of destination entities.
- To assist in troubleshooting.
- As input for security and other network analysis appliances.
The type of entities that you can specify as source or destination is determined
by the session type. You can use uplink distributed virtual ports only for
mixed destination mirror VSPAN sessions (mixedDestMirror).
For all sessions except mixedDestMirror sessions, you cannot
use uplink distributed virtual ports as destination ports.
sessionType is required for vSphere Distributed Switch 5.1 and later,
ignored for prior version if set.
||Distributed Ports + Uplink Ports Name
||Uplink Ports Name
The description for the session.
Destination ports that received the mirrored packets.
You cannot use wild card ports as destination ports. If wildcardPortConnecteeType
is set in the value, the reconfigure
operation will raise a fault. Also any port designated in the value of
this property can not match the wild card source port in any of the
Distributed Port Mirroring session.
Whether the session is enabled.
VLAN ID used to encapsulate the mirrored traffic.
The generated key as the identifier for the session.
An integer that describes how much of each frame to mirror. If unset, all
of the frame would be mirrored. Setting this property to a smaller value
is useful when the consumer will look only at the headers.
The value cannot be less than 60.
The display name.
Whether or not destination ports can send and receive "normal" traffic.
Setting this to false will make mirror ports be used solely for mirroring
and not double as normal access ports.
Sampling rate of the session. If its value is n, one of every n
packets is mirrored.
Valid values are between 1 to 65535, and default value is 1.
Since vSphere API 5.1
Type of the session. See
for valid values.
Default value is mixedDestMirror if unspecified in a VSPAN create operation.
Since vSphere API 5.1
Source ports for which received packets are mirrored.
Source ports for which transmitted packets are mirrored.
Whether to strip the original VLAN tag. if false, the original VLAN tag
will be preserved on the mirrored traffic. If encapsulationVlanId
has been set and this property is false, the frames will be double tagged
with the original VLAN ID as the inner tag.
Properties inherited from DynamicData
Show WSDL type definition