NSX-T Data Center REST API

Update global ServiceInsertion status for a context (Removed in 4.0)

Update global serviceinsertion status for supported context
types e.g. 'north_south'
Please use 'north_south' context to update status of SI NFV
usecase (rule applied on T0/T1 uplink with redirect_to service
chain).
Deprecated: The PUT service insertion status API is deprecated. Please use the policy service insertion configuration status API.

Request:

Method:

PUT

URI Path(s):

/api/v1/serviceinsertion/status/{context-type}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ServiceInsertionStatus+

ServiceInsertionStatus (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
context	Service Insertion Context Type Type of service insertion contexts.	ServiceInsertionContextType	Required
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
global_status	Service Insertion Status Type service insertion status for a context type (e.g. east_west traffic).	ServiceInsertionStatusType	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ServiceInsertionStatus	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

{ "id": "5863495c-ffe8-4d44-8ea7-371f9fe2d97f", "display_name": "Service Insertion Enable/Disable Status", "global_status": "DISABLED", "context": "north_south", "_create_user": "system", "_create_time": 1498679696805, "_last_modified_user": "system", "_last_modified_time": 1498679696805, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceInsertionStatus+

ServiceInsertionStatus (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
context	Service Insertion Context Type Type of service insertion contexts.	ServiceInsertionContextType	Required
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
global_status	Service Insertion Status Type service insertion status for a context type (e.g. east_west traffic).	ServiceInsertionStatusType	Required
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value ServiceInsertionStatus	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "ServiceInsertionStatus", "display_name": "Service Insertion Enable/Disable Status", "id": "5863495c-ffe8-4d44-8ea7-371f9fe2d97f", "global_status": "DISABLED", "_create_time": 1498679696805, "context": "north_south", "_last_modified_user": "admin", "_system_owned": false, "_last_modified_time": 1498698220680, "_protection": "NOT_PROTECTED", "_revision": 1 }

Required Permissions:

crud

Feature:

service_insertion_config

Additional Errors:

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