Add Service Chain

Adds a new service chain. Service Chains is can contain profile belonging
to same or different Service(s). It represents a redirection target for a Rule.

Request:

Method:

POST

URI Path(s):

/api/v1/serviceinsertion/service-chains

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ServiceChain+

ServiceChain (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
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
forward_path_service_profiles	Forward path service profiles List of ServiceInsertionServiceProfiles that constitutes the the service chain. The forward path service profiles are applied to ingress traffic.	array of ResourceReference	Required Maximum items: 4
id	Unique identifier of this resource	string	Sortable
on_failure_policy	On Failure Policy Failure policy for the service tells datapath, the action to take i.e to allow or block traffic during failure scenarios.	string	Enum: ALLOW, BLOCK Default: "ALLOW"
path_selection_policy	Path Selection Policy Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - means to prefer local service insances. REMOTE - preference is to redirect to the SVM co-located on the same host.	string	Enum: ANY, LOCAL, REMOTE Default: "ANY"
resource_type	Must be set to the value ServiceChain	string
reverse_path_service_profiles	Reverse path service profiles List of ServiceInsertionServiceProfiles id. Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.	array of ResourceReference	Maximum items: 4
service_attachments	Service Attachment list Service attachment specifies the scope i.e Service plane at which the SVMs are deployed.	array of ResourceReference	Required Minimum items: 1 Maximum items: 1
service_chain_id	Service chain id A unique id generated for every service chain. This is not a uuid.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

POST https://<nsx-mgr>/api/v1/serviceinsertion/service-chains { "display_name": "ServiceChain1", "description": "SC for East-West Service Insertion", "on_failure_policy": "ALLOW", "path_selection_policy": "LOCAL", "service_attachments": [{ "target_display_name": "SA1", "target_type": "ServiceAttachment", "target_id": "0e982c85-4212-4780-b402-b51a92c8f82f" }], "forward_path_service_profiles": [{ "target_display_name": "SP1", "target_type": "abc", "target_id": "e871abac-c654-430b-b5d5-955cc1894e7f" }], "reverse_path_service_profiles": [{ "target_display_name": "SP1", "target_type": "ServiceProfile", "target_id": "e871abac-c654-430b-b5d5-955cc1894e7f" }] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceChain+

ServiceChain (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
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
forward_path_service_profiles	Forward path service profiles List of ServiceInsertionServiceProfiles that constitutes the the service chain. The forward path service profiles are applied to ingress traffic.	array of ResourceReference	Required Maximum items: 4
id	Unique identifier of this resource	string	Sortable
on_failure_policy	On Failure Policy Failure policy for the service tells datapath, the action to take i.e to allow or block traffic during failure scenarios.	string	Enum: ALLOW, BLOCK Default: "ALLOW"
path_selection_policy	Path Selection Policy Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - means to prefer local service insances. REMOTE - preference is to redirect to the SVM co-located on the same host.	string	Enum: ANY, LOCAL, REMOTE Default: "ANY"
resource_type	Must be set to the value ServiceChain	string
reverse_path_service_profiles	Reverse path service profiles List of ServiceInsertionServiceProfiles id. Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.	array of ResourceReference	Maximum items: 4
service_attachments	Service Attachment list Service attachment specifies the scope i.e Service plane at which the SVMs are deployed.	array of ResourceReference	Required Minimum items: 1 Maximum items: 1
service_chain_id	Service chain id A unique id generated for every service chain. This is not a uuid.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "service_attachments": [ { "target_id": "7a985edb-fa65-4868-b324-617ffa445401", "target_display_name": "7a985edb-fa65-4868-b324-617ffa445401", "target_type": "ServiceAttachment" } ], "forward_path_service_profiles": [ { "target_id": "38b87e06-cb4d-4568-9be0-59be8ab12df9", "target_display_name": "38b87e06-cb4d-4568-9be0-59be8ab12df9", "target_type": "ServiceProfile" } ], "reverse_path_service_profiles": [ { "target_id": "38b87e06-cb4d-4568-9be0-59be8ab12df9", "target_display_name": "38b87e06-cb4d-4568-9be0-59be8ab12df9", "target_type": "ServiceProfile" } ], "service_chain_id": "1", "on_failure_policy": "ALLOW", "path_selection_policy": "LOCAL", "resource_type": "ServiceChain", "id": "4427205b-689d-453e-8644-c6db96f9f53a", "display_name": "ServiceChain1", "description": "SC for East-West Service Insertion", "_create_user": "admin", "_create_time": 1546634221612, "_last_modified_user": "admin", "_last_modified_time": 1546634221612, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Add Service Chain

Request:

ServiceChain (schema)

Example Request:

Successful Response:

ServiceChain (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: