[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update Communication Entry
DescriptionUpdate the CommunicationEntry. If a CommunicationEntry with the communication-entry-id is not already present, this API fails with a 404. Creation of CommunicationEntries is not allowed using this API. This API is deprecated. Please use the following API instead PUT /infra/domains/domain-id/security-policies/securit-policy-id/rules/rule-id
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/communication-maps/{communication-map-id}/communication-entries/{communication-entry-id}
Path Parameters
Path Parameters
string
domain-id
Required
string
communication-map-id
Required
string
communication-entry-id
Required
Request Body
Request Body
CommunicationEntry
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlineCommunicationEntry1
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
CommunicationEntry
of type(s) application/json
This response body class contains all of the following:
PolicyConfigResource, InlineCommunicationEntry1
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
$CommunicationEntry = Initialize-nullCommunicationEntry -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 -Action "ALLOW" -DestinationGroups "MyDestinationGroups" -Direction "IN" -Disabled $false -Logged $false -Notes "MyNotes" -Scope "MyScope" -SequenceNumber 0 -Services "MyServices" -SourceGroups "MySourceGroups" -Tag "MyTag"
Invoke-UpdateCommunicationEntry -domainId "MydomainId" -communicationMapId "MycommunicationMapId" -communicationEntryId "MycommunicationEntryId" -communicationEntry $communicationEntry
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"],"direction":"IN","disabled":false,"display_name":"string","id":"string","logged":false,"marked_for_delete":false,"notes":"string","parent_path":"string","path":"string","relative_path":"string","resource_type":"string","scope":["string"],"sequence_number":0,"services":["string"],"source_groups":["string"],"tag":"string","tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/communication-maps/{communication-map-id}/communication-entries/{communication-entry-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated: null
x-vmw-doc-operation: update-communication-entry
x-vmw-nsx-module: PolicyDfw
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Domains Operations
delete
