NSX-T Data Center REST API
ServiceChain (schema)
Service Chain
Service chain is a set of network Services. A Service chain is made up of ordered list of service profiles belonging to any same or different services.
| 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 |