NSX-T Data Center REST API

PortMirroringSession (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "PortMirroringSession", 
  "module_id": "PortMirroring", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "computed": true, 
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "direction": {
      "$ref": "DirectionType, 
      "required": true, 
      "title": "Port mirroring session direction"
    }, 
    "display_name": {
      "can_sort": true, 
      "computed": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "encapsulation_vlan_id": {
      "$ref": "VlanID, 
      "description": "Only for Remote SPAN Port Mirror.", 
      "required": false, 
      "title": "Encapsulation VLAN ID"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "mirror_destination": {
      "$ref": "MirrorDestination, 
      "required": true, 
      "title": "Mirror destination"
    }, 
    "mirror_sources": {
      "items": {
        "$ref": "MirrorSource
      }, 
      "minItems": 1, 
      "required": true, 
      "title": "Mirror sources", 
      "type": "array"
    }, 
    "port_mirroring_filters": {
      "description": "An array of 5-tuples used to filter packets for the mirror session, if not provided, all the packets will be mirrored.", 
      "items": {
        "$ref": "PortMirroringFilter
      }, 
      "required": false, 
      "title": "Port mirror filter for this session", 
      "type": "array"
    }, 
    "preserve_original_vlan": {
      "default": false, 
      "required": false, 
      "title": "Only for Remote SPAN Port Mirror. Whether to preserve original VLAN.", 
      "type": "boolean"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "session_type": {
      "$ref": "PortMirroringSessionType, 
      "default": "LocalPortMirrorSession", 
      "description": "If this property is unset, this session will be treated as LocalPortMirrorSession.", 
      "required": false, 
      "title": "Port mirroring session type"
    }, 
    "snap_length": {
      "description": "If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored.", 
      "maximum": 65535, 
      "minimum": 60, 
      "required": false, 
      "title": "Maximum packet length for packet truncation", 
      "type": "integer"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tcp_ip_stack": {
      "description": "If set to mirror, mirror packet will be sent via dedicated mirror stack to destination; If set to default, mirror packet will be sent via default stack; So far, the value mirror can only be chosen in L3PortMirrorSession.", 
      "enum": [
        "Default", 
        "Mirror"
      ], 
      "required": false, 
      "title": "TCP/IP Stack", 
      "type": "string"
    }
  }, 
  "type": "object"
}