NSX-T Data Center REST API

Update IDFW compute collection (Deprecated)

Enable/disable individual compute collections for IDFW.
Deprecated:
Use the following Policy API -
PUT/PATCH /policy/api/v1/infra/settings/firewall/idfw/cluster/

Request:

Method:

PUT

URI Path(s):

/api/v1/idfw/idfw-compute-collections/<cc-ext-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

IdfwEnabledComputeCollection+

IdfwEnabledComputeCollection (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource 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.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
compute_collection_id	Compute collection ID Compute collection ID.	string	Required
compute_collection_name	Compute collection name Compute collection name.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enabled/disabled Compute collection enabled status (true=Enabled / false=Disabled).	boolean	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value IdfwEnabledComputeCollection	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/idfw/idfw-compute-collections/840927af-a0e1-4342-b4b3-2491f38e157d:domain-c8 { "_revision" : 0, "compute_collection_id" : "840927af-a0e1-4342-b4b3-2491f38e157d:domain-c8", "enabled" : true, "_create_time": 1537790838188, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_last_modified_time": 1537790838188, "_create_user": "admin" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

IdfwEnabledComputeCollection+

IdfwEnabledComputeCollection (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource 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.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
compute_collection_id	Compute collection ID Compute collection ID.	string	Required
compute_collection_name	Compute collection name Compute collection name.	string
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Enabled/disabled Compute collection enabled status (true=Enabled / false=Disabled).	boolean	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value IdfwEnabledComputeCollection	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "_revision" : 1, "compute_collection_id" : "840927af-a0e1-4342-b4b3-2491f38e157d:domain-c8", "enabled" : true "_create_time": 1537790838188, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_last_modified_time": 1537790838188, "_create_user": "admin" }

Required Permissions:

crud

Feature:

identity_firewall

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable