NSX-T Data Center REST API
ServiceInstance (schema)
Normal Instance of a service
The deployment of a registered service. Service instance is instantiation of service. It is the most used type of instance. It is a default instance to be used when NSX handles lifecycle of appliance. Deployment and appliance related all the information is necessary.
| 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 |
| attachment_point | Attachment Point Attachment point to be used by this service instance for deploying the Service-VM. |
string | Required Enum: TIER0_LR, TIER1_LR, SERVICE_PLANE, HOST |
| deployed_to | Deployed-to object list List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion. |
array of ResourceReference | Required Minimum items: 1 Maximum items: 128 |
| deployment_mode | Deployment Mode Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode. |
string | Required Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY" |
| deployment_spec_name | Deployment Spec Name Name of the deployment spec to be used by this service instance. |
string | 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 |
| id | Unique identifier of this resource | string | Sortable |
| implementation_type | Implementation Type Implementation to be used by this service instance for deploying the Service-VM. |
string | Required Enum: NORTH_SOUTH, EAST_WEST |
| instance_deployment_config | Instance Deployment Config Instance Deployment Config contains the information to be injected during Service-VM deployment. This field is optional if the service only caters to functionality EPP(Endpoint Protection) and MPS. |
InstanceDeploymentConfig | |
| instance_deployment_template | Instance Deployment Template The deployment template to be used by this service instance. The attribute values specific to this instance can be added. |
DeploymentTemplate | Required |
| on_failure_policy | On Failure Policy Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to. |
string | Enum: ALLOW, BLOCK |
| resource_type | Must be set to the value ServiceInstance | ServiceInstanceResourceType | Required |
| service_deployment_id | Id of the Service Deployment using which the instances were deployed Id of the Service Deployment using which the instances were deployed. Its available only for instances that were deployed using service deployment API. |
string | Readonly |
| service_id | Service Id The Service to which the service instance is associated. |
string | Readonly |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| transport_type | Transport Type Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS. |
string | Required Enum: L2_BRIDGE, L3_ROUTED, NSH, NA |