[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create Port Mirroring Profile
DescriptionCreate 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
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PortMirroringProfile
of type(s) application/json
This response body class contains all of the following:
PolicyConfigResource, InlinePortMirroringProfile1
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-nullResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-nullSelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-nullTag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-nullPolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-nullChildPolicyConfigResource -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-nullIPAddresses -_IpAddresses "My_IpAddresses"
$PortMirrorFilter = Initialize-nullPortMirrorFilter -DestinationIps $IPAddresses -DestinationPorts "MyDestinationPorts" -Protocol "TCP" -SourceIps $IPAddresses -SourcePorts "MySourcePorts"
$PortMirroringProfile = Initialize-nullPortMirroringProfile -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 -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -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 '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","destination_group":"string","direction":"INGRESS","display_name":"string","encapsulation_type":"GRE","erspan_id":0,"gre_key":0,"id":"string","marked_for_delete":false,"parent_path":"string","path":"string","profile_type":"REMOTE_L3_SPAN","relative_path":"string","resource_type":"string","snap_length":0,"tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/port-mirroring-profiles/{port-mirroring-profile-id}
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
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
