VMwareDVSVspanConfigSpec

VMwareDVSVspanConfigSpec
VMwareDVSVspanConfigSpec

This class defines the configuration of a Distributed Port Mirroring session.

A Distributed Port Mirroring session

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "vspanSession": {
        "_typeName": "string",
        "key": "string",
        "name": "string",
        "description": "string",
        "enabled": false,
        "sourcePortTransmitted": {
            "_typeName": "string",
            "portKey": [
                "string"
            ],
            "uplinkPortName": [
                "string"
            ],
            "wildcardPortConnecteeType": [
                "string"
            ],
            "vlans": [
                0
            ],
            "ipAddress": [
                "string"
            ]
        },
        "sourcePortReceived": {
            "_typeName": "string",
            "portKey": [
                "string"
            ],
            "uplinkPortName": [
                "string"
            ],
            "wildcardPortConnecteeType": [
                "string"
            ],
            "vlans": [
                0
            ],
            "ipAddress": [
                "string"
            ]
        },
        "destinationPort": {
            "_typeName": "string",
            "portKey": [
                "string"
            ],
            "uplinkPortName": [
                "string"
            ],
            "wildcardPortConnecteeType": [
                "string"
            ],
            "vlans": [
                0
            ],
            "ipAddress": [
                "string"
            ]
        },
        "encapsulationVlanId": 0,
        "stripOriginalVlan": false,
        "mirroredPacketLength": 0,
        "normalTrafficAllowed": false,
        "sessionType": "string",
        "samplingRate": 0,
        "encapType": "string",
        "erspanId": 0,
        "erspanCOS": 0,
        "erspanGraNanosec": false,
        "netstack": "string"
    },
    "operation": "string"
}
vspanSession
Required

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.

Session Type Source Destination
mixedDestMirror Distributed Ports Distributed Ports + Uplink Ports Name
dvPortMirror Distributed Ports Distributed Ports
remoteMirrorSource Distributed Ports Uplink Ports Name
remoteMirrorDest VLAN Distributed Ports
encapRemoteMirrorSource Distributed Ports IP address
string
operation
Required

Operation type, see ConfigSpecOperationEnum for valid values.