[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Create Port Mirroring Profile

Description

Create or Replace port mirroring profile. Packets will be mirrored from source group, segment, port to destination group. Realized entities of this API can be found using the path of monitoring profile binding map that is used to apply this profile.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}
Copy

Path Parameters

Path Parameters

string
port-mirroring-profile-id Required

Port Mirroring Profiles Id


Request Body

Request Body

PortMirroringProfile of type(s) application/json Required
This request body class requires all of the following: PolicyConfigResource, InlinePortMirroringProfile1
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PortMirroringProfile of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlinePortMirroringProfile1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

PowerCLI Client SDK Example

$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$IPAddresses = Initialize-IPAddresses -_IpAddresses "My_IpAddresses"
$PortMirrorFilter = Initialize-PortMirrorFilter -DestinationIps $IPAddresses -DestinationPorts "MyDestinationPorts" -Protocol "TCP" -SourceIps $IPAddresses -SourcePorts "MySourcePorts"
$PortMirroringProfile = Initialize-PortMirroringProfile -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -DestinationGroup "MyDestinationGroup" -Direction "INGRESS" -EncapsulationType "GRE" -ErspanId 0 -FilterAction "INCLUDE" -GreKey 0 -PortMirroringFilters $PortMirrorFilter -ProfileType "REMOTE_L3_SPAN" -SnapLength 0 -TcpIpStack "Default"
Invoke-CreateOrReplacePortMirroringProfile -portMirroringProfileId "MyportMirroringProfileId" -portMirroringProfile $portMirroringProfile -_override $true

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-port-mirroring-profile
x-vmw-nsx-module: PolicyPortMirroring


Feedback

Was this page helpful?