[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update Security Policy Rule
DescriptionPatch the rule. If Rule corresponding to the the given rule-id is not present, the object will get created and if it is present it will be updated. This is a full replace
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}
Path Parameters
Path Parameters
string
domain-id
Required
string
security-policy-id
Required
string
rule-id
Required
Request Body
Request Body
Rule
of type(s) application/json
Required
This request body class requires all of the following:
BaseRule, InlineRule1
Authentication
This operation uses the following authentication methods.
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
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
$ServiceEntry = Initialize-nullServiceEntry -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 "IPProtocolServiceEntry" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false
$Rule = Initialize-nullRule -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 -DestinationGroups "MyDestinationGroups" -DestinationsExcluded $false -Direction "IN" -Disabled $false -IpProtocol "IPV4" -IsDefault $false -Logged $false -Notes "MyNotes" -Profiles "MyProfiles" -RuleId 0 -Scope "MyScope" -SequenceNumber 0 -ServiceEntries $ServiceEntry -Services "MyServices" -SourceGroups "MySourceGroups" -SourcesExcluded $false -Tag "MyTag" -Action "ALLOW"
Invoke-PatchSecurityRule -domainId "MydomainId" -securityPolicyId "MysecurityPolicyId" -ruleId "MyruleId" -rule $rule
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/security-policies/{security-policy-id}/rules/{rule-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-security-policy-rule
x-vmw-nsx-module: DfwSecurityPolicy
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Domains Operations
delete
delete
patch
