NSX-T Data Center REST API
PortMirroringSession (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource 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. |
string | Readonly |
| _revision | Generation of this resource config 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. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| direction | Port mirroring session direction | DirectionType | Required |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| encapsulation_vlan_id | Encapsulation VLAN ID Only for Remote SPAN Port Mirror. |
VlanID | |
| id | Unique identifier of this resource | string | Sortable |
| mirror_destination | Mirror destination | MirrorDestination (Abstract type: pass one of the following concrete types) IPMirrorDestination LogicalPortMirrorDestination PnicMirrorDestination |
Required |
| mirror_sources | Mirror sources | array of MirrorSource (Abstract type: pass one of the following concrete types) LogicalPortMirrorSource LogicalSwitchMirrorSource PnicMirrorSource VlanMirrorSource |
Required Minimum items: 1 |
| port_mirroring_filters | Port mirror filter for this session An array of 5-tuples used to filter packets for the mirror session, if not provided, all the packets will be mirrored. |
array of PortMirroringFilter | |
| preserve_original_vlan | Only for Remote SPAN Port Mirror. Whether to preserve original VLAN. | boolean | Default: "False" |
| resource_type | Must be set to the value PortMirroringSession | string | |
| session_type | Port mirroring session type If this property is unset, this session will be treated as LocalPortMirrorSession. |
PortMirroringSessionType | Default: "LocalPortMirrorSession" |
| snap_length | Maximum packet length for packet truncation If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored. |
integer | Minimum: 60 Maximum: 65535 |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| tcp_ip_stack | TCP/IP Stack 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. |
string | Enum: Default, Mirror |