NSX-T Data Center REST API
PktCaptureSession (schema)
Packet capture response information
Packet capture session information.
| 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 |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| endtime | End time in epoch millisecond Timestamp when session was stopped in epoch millisecond. |
EpochMsTimestamp | |
| errormsg | Error messasge in capture Error messasge in capture. |
string | |
| filelocation | Packet capture file location Packet capture file location. |
string | |
| filesize | Packet capture file Size in bytes Packet capture file Size in bytes. |
int | |
| id | Unique identifier of this resource | string | Sortable |
| request | Packet capture request Packet capture request information. |
PktCaptureRequest | Required |
| resource_type | Must be set to the value PktCaptureSession | string | |
| sessionid | Packet capture session id Packet capture session id. |
string | Required |
| sessionname | Packet capture session name Packet capture session name. |
string | |
| sessionstatus | Packet capture session status Packet capture session status. |
string | Required Enum: CREATED, STARTED, STOPPED, FINISHED, ERROR |
| starttime | Start time in epoch millisecond Timestamp when session was created in epoch millisecond. |
EpochMsTimestamp | |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |