Port Mirroring
CreatePortMirror
Creates a port mirror. For
example,
CreatePortMirror mirrorNetworkUuid=c1da6a9a815f3b17be87c19f9a43fe77Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| mirrorNetworkUuid | The mirror network UUID. | 3.7.0 | ||
| name | The resource name. | Yes | 3.7.0 | |
| description | The detailed description of the resource. | Yes | 3.7.0 | |
| stateEvent | The state of the flow mirror. | Yes |
|
3.7.0 |
| resourceUuid | Yes | 3.7.0 | ||
| tagUuids | Yes | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
QueryPortMirror
Queries a port mirror. For example,
QueryPortMirrorPrimitive Fields of Query
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| sessions | Port Mirror Session Inventory | The port mirror sessions. | 3.7.0 |
UpdatePortMirror
Updates a port mirror. For
example,
UpdatePortMirror uuid=2bafc0057bac3a6294a24a48c079c738Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| name | The resource name. | Yes | 3.7.0 | |
| description | The detailed description of the resource. | Yes | 3.7.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
DeletePortMirror
Deletes a port mirror. For
example,
DeletePortMirror uuid=b4959c6b70c836508290dce51e9a1394Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| deleteMode | Yes | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
CreatePortMirrorSession
Creates a port mirror session. For
example,
CreatePortMirrorSession portMirrorUuid=d848a38e94c53c9dafbb422f5e534237 name=session type=Ingress srcEndPoint=404d456d595a3fcf8e758dc864a47c2e dstEndPoint=5ffb697b680d3d76bf3c50f344d5f742Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| portMirrorUuid | The port mirror UUID. | 3.7.0 | ||
| name | The resource name. | 3.7.0 | ||
| description | The detailed description of the resource. | Yes | 3.7.0 | |
| type | The session type. |
|
3.7.0 | |
| srcEndPoint | The source endpoint of the mirror session. | 3.7.0 | ||
| dstEndPoint | The destination endpoint of the mirror session. | 3.7.0 | ||
| resourceUuid | Yes | 3.7.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.7.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
QueryPortMirrorSession
Queries a port mirror session. For
example,
QueryPortMirrorSession Primitive Fields of Query
ChangePortMirrorState
Changes the state of a port mirror. For
example,
ChangePortMirrorState uuid=8752424e2b1e398a9d28fbb076cff81f stateEvent=enableParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| stateEvent | The state event. |
|
3.7.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
DeletePortMirrorSession
Deletes a port mirror session. For
example,
DeletePortMirrorSession uuid=3c1f4de89ffd3f83932bbd95321dbf20 Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.7.0 | ||
| deleteMode | Yes | 3.7.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
GetCandidateVmNicsForPortMirror
Obtains the VM NICs that can use the port mirror service in the system. For
example,
GetCandidateVmNicsForPortMirror portMirrorUuid=35f9487b28bf3ef3995bdaa9b0c7e14c type=sourceParameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| portMirrorUuid | The port mirror UUID. | 3.7.0 | ||
| type | The NIC type. |
|
3.7.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.7.0 | |
| timeout | Yes |
QueryPortMirrorNetworkUsedIp
Queries the IP address that is allocated to a port mirror network. For
example,
QueryPortMirrorNetworkUsedIp