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

Update Segment Security Profile

Description

Create a new segment security profile if the segment security profile with given id does not exist. Otherwise, PATCH the existing segment security profile

Request

Request

URL

URL


patch
https://nsxmanager.your.domain/policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
Copy

Path Parameters

Path Parameters

string
segment-security-profile-id Required

Segment security profile id


Request Body

Request Body

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

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

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
$TrafficRateLimits = Initialize-nullTrafficRateLimits -RxBroadcast 0 -RxMulticast 0 -TxBroadcast 0 -TxMulticast 0
$SegmentSecurityProfile = Initialize-nullSegmentSecurityProfile -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 -BpduFilterAllow "MyBpduFilterAllow" -BpduFilterEnable $false -DhcpClientBlockEnabled $false -DhcpClientBlockV6Enabled $false -DhcpServerBlockEnabled $false -DhcpServerBlockV6Enabled $false -NonIpTrafficBlockEnabled $false -RaGuardEnabled $false -RateLimits $TrafficRateLimits -RateLimitsEnabled $false
Invoke-PatchSegmentSecurityProfile -segmentSecurityProfileId "MysegmentSecurityProfileId" -segmentSecurityProfile $segmentSecurityProfile -_override $true

cURL Command

curl -X PATCH -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,"bpdu_filter_allow":["string"],"bpdu_filter_enable":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","dhcp_client_block_enabled":false,"dhcp_client_block_v6_enabled":false,"dhcp_server_block_enabled":false,"dhcp_server_block_v6_enabled":false,"display_name":"string","id":"string","marked_for_delete":false,"non_ip_traffic_block_enabled":false,"parent_path":"string","path":"string","ra_guard_enabled":false,"rate_limits":{"rx_broadcast":0,"rx_multicast":0,"tx_broadcast":0,"tx_multicast":0},"rate_limits_enabled":false,"relative_path":"string","resource_type":"string","tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-segment-security-profile
x-vmw-nsx-module: PolicySegmentSecurity


Feedback

Was this page helpful?