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

URL

PATCH

https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/communication-maps/{communication-map-id}/communication-entries/{communication-entry-id}

Path Parameters

Required	Parameter Name	Type	Description
required	domain-id	string	Not available
required	communication-map-id	string	Not available
required	communication-entry-id	string	Not available

Request Body

Contains CommunicationEntry (required)

{
    "_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"
        }
    ]
}

Required	Property Name	Type	Description
optional	_create_time	integer	Timestamp of resource creation
optional	_create_user	string	ID of the user who created this resource
optional	_last_modified_time	integer	Timestamp of last modification
optional	_last_modified_user	string	ID of the user who last modified this resource
optional	_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
optional	_protection	string	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.
optional	_revision	integer	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.
optional	_schema	string	Schema for this resource
optional	_self	SelfResourceLink	Link to this resource
optional	_system_owned	boolean	Indicates system owned resource
optional	action	string	The action to be applied to all the services. Possible values are: ALLOW, DROP, REJECT
optional	children	array of ChildPolicyConfigResource	subtree for this type within policy tree containing nested elements.
optional	description	string	Description of this resource
optional	destination_groups	array of string	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.
optional	direction	string	Define direction of traffic. Possible values are: IN, IN_OUT, OUT
optional	disabled	boolean	Flag to disable the rule. Default is enabled.
optional	display_name	string	Defaults to ID if not set
optional	id	string	Unique identifier of this resource
optional	logged	boolean	Flag to enable packet logging. Default is disabled.
optional	marked_for_delete	boolean	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.
optional	notes	string	Text for additional notes on changes.
optional	parent_path	string	Path of its parent
optional	path	string	Absolute path of this object
optional	relative_path	string	Path relative from its parent
optional	resource_type	string	The type of this resource.
optional	scope	array of string	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.
optional	sequence_number	integer	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
optional	services	array of string	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.
optional	source_groups	array of string	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.
optional	tag	string	User level field which will be printed in CLI and packet logs.
optional	tags	array of Tag	Opaque identifiers meaningful to the API user

Response

200 OK

Operation doesn't return any data structure.

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

Code	Returns	Description
503	ServiceUnavailable	The server is currently unavailable (because it is overloaded or down for maintenance).
400	BadRequest	The request cannot be fulfilled due to bad syntax.
403	Forbidden	The server understood the request, but is refusing to fulfill it.
404	NotFound	The requested resource could not be found but may be available again in the future.
412	PreconditionFailed	Not available
500	InternalServerError	The server encountered an unexpected condition which prevented it from fulfilling the request.

Communication Maps Operations

delete

Delete Communication Entry

delete

Delete Communication Map For Domain

get

Get Communication Entry

get

Get Communication Map For Domain

get

List Communication Entries

get

List Communication Maps For Domain

patch

Patch Communication Entry

patch

Patch Communication Map For Domain

post

Revise Communication Entry

post

Set Communication Map Precedence

put

Update Communication Entry

put

Update Communication Map For Domain

Patch Communication Entry

On This Page

Request

URL

Path Parameters

Request Body

Response

cURL Command

Errors

On This Page

Communication Maps Operations

Was this page helpful?