Patch Communication Entry
Patch the CommunicationEntry. If a communication entry for the given communication-entry-id is not present, the object will get created and if it is present it will be updated. This is a full replace This API is deprecated. Please use the following API instead. PATCH /infra/domains/domain-id/security-policies/security-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}
Parameters
Parameters
string
domain-id
Required
No description available
string
communication-map-id
Required
No description available
string
communication-entry-id
Required
No description available
Request Body
Request Body
CommunicationEntry (required)
integer
_create_time
Optional
Timestamp of resource creation
string
_create_user
Optional
ID of the user who created this resource
integer
_last_modified_time
Optional
Timestamp of last modification
string
_last_modified_user
Optional
ID of the user who last modified this resource
array of
ResourceLink
_links
Optional
The server will populate this field when returing the resource. Ignored on PUT and POST.
string
_protection
Optional
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
integer
_revision
Optional
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
string
_schema
Optional
Schema for this resource
boolean
_system_owned
Optional
Indicates system owned resource
string
action
Optional
The action to be applied to all the services.
Possible values are: ALLOW, DROP, REJECT
array of
ChildPolicyConfigResource
children
Optional
subtree for this type within policy tree containing nested elements.
string
description
Optional
Description of this resource
array of
string
destination_groups
Optional
We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
string
direction
Optional
Define direction of traffic.
Possible values are: IN, OUT, IN_OUT
boolean
disabled
Optional
Flag to disable the rule. Default is enabled.
string
display_name
Optional
Defaults to ID if not set
string
id
Optional
Unique identifier of this resource
boolean
logged
Optional
Flag to enable packet logging. Default is disabled.
boolean
marked_for_delete
Optional
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.
string
notes
Optional
Text for additional notes on changes.
string
parent_path
Optional
Path of its parent
string
path
Optional
Absolute path of this object
string
relative_path
Optional
Path relative from its parent
string
resource_type
Optional
The type of this resource.
array of
string
scope
Optional
The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs.
integer
sequence_number
Optional
This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple communication entries with the same sequence number then their order is not deterministic. If a specific order of communication entry is desired, then one has to specify unique sequence numbers or use the POST request on the communication entry entity with a query parameter action=revise to let the framework assign a sequence number
array of
string
services
Optional
In order to specify all services, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
array of
string
source_groups
Optional
We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant “ANY”. This is case insensitive. If “ANY” is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
string
tag
Optional
User level field which will be printed in CLI and packet logs.
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,"action":"string","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":"string","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}
Errors
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).
On This Page
Communication Maps Operations
delete
