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

Create IPFIX L2 Collector Profile

Description

Create or Replace IPFIX collector profile. IPFIX data will be sent to IPFIX collector.

Request

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/ipfix-l2-collector-profiles/{ipfix-l2-collector-profile-id}
Copy

Path Parameters

Path Parameters

string
ipfix-l2-collector-profile-id Required

IPFIX collector profile id


Request Body

Request Body

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

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

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

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
$IPFIXL2Collector = Initialize-nullIPFIXL2Collector -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 -CollectorIpAddress "MyCollectorIpAddress" -CollectorPort 0
$IPFIXL2CollectorProfile = Initialize-nullIPFIXL2CollectorProfile -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 -IpfixL2Collectors $IPFIXL2Collector
Invoke-CreateOrReplaceIPFIXL2CollectorProfile -ipfixL2CollectorProfileId "MyipfixL2CollectorProfileId" -iPFIXL2CollectorProfile $iPFIXL2CollectorProfile -_override $true

cURL Command

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-ipfix-l2-collector-profile
x-vmw-nsx-module: PolicyIPFIXSwitch


Feedback

Was this page helpful?