[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create Security Policy Rule
DescriptionUpdate the rule. Create new rule if a rule with the rule-id is not already present.
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.
Response
Response
Response BodyResponse Body
200 OK
Returns
Rule
of type(s) application/json
This response body class contains all of the following:
BaseRule, InlineRule1
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 -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -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 -OriginSiteId "MyOriginSiteId" -OwnerId "MyOwnerId" -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -RemotePath "MyRemotePath" -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-UpdateSecurityRule -domainId "MydomainId" -securityPolicyId "MysecurityPolicyId" -ruleId "MyruleId" -rule $rule
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,"action":"ALLOW","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_groups":["string"],"destinations_excluded":false,"direction":"IN","disabled":false,"display_name":"string","id":"string","ip_protocol":"IPV4","logged":false,"marked_for_delete":false,"notes":"string","parent_path":"string","path":"string","profiles":["string"],"relative_path":"string","resource_type":"string","scope":["string"],"sequence_number":0,"services":["string"],"source_groups":["string"],"sources_excluded":false,"tag":"string","tags":[{"scope":"string","tag":"string"}]}' 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: create-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
