NSX-T Data Center REST API

Update an existing Service Deployment (Deprecated)

Update an existing Service Deployment. Deprecated: This API is deprecated since only property we can change on service deployment is display name, which is used for the SVM name. Changing the name will cause the name of the deployment to go out of sync with the deployed VM.

Request:

Method:

PUT

URI Path(s):

/api/v1/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ServiceDeployment+

ServiceDeployment (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
clustered_deployment_count	Clustered Deployment Count Number of instances in case of clustered deployment.	integer	Minimum: 1 Maximum: 10 Default: "1"
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. Service Attachment in case of E-W ServiceInsertion.	array of ResourceReference	Minimum items: 1 Maximum items: 128
deployment_mode	Deployment Mode Mode of deployment. Currently, only stand alone deployment is supported. It is a single VM deployed through this deployment spec. In future, HA configurations will be supported here.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "STAND_ALONE"
deployment_spec_name	Deployment Spec Name Name of the deployment spec to be used for deployment, which specifies the OVF provided by the partner and the form factor.	string	Required
deployment_type	Deployment Type Specifies whether the service VM should be deployed on each host such that it provides partner service locally on the host, or whether the service VMs can be deployed as a cluster. If deployment_type is CLUSTERED, then the clustered_deployment_count should be provided.	string	Enum: HOSTLOCAL, CLUSTERED Default: "CLUSTERED"
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
instance_deployment_template	Instance Deployment Template The deployment template to be used during the deployment to provide customized attributes to the service VM.	DeploymentTemplate	Required
perimeter	Deployment perimeter This indicates the deployment perimeter, such as a VC cluster or a host.	string	Enum: CLUSTER, HOST Default: "HOST"
resource_type	Must be set to the value ServiceDeployment	string
service_deployment_config	Service Deployment Config Deployment Config contains the deployment specification, such as the storage and network to be used along with the cluster where the service VM can be deployed.	ServiceDeploymentConfig	Required
service_id	Service Id The Service to which the service deployment is associated.	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/services/65a60890-6f48-418d-a7d5-5aaf65f2344b/service-deployments/01dfa028-bc90-4be4-bda1-a98b4eb65856 { "perimeter": "CLUSTER", "deployment_type": "HOSTLOCAL", "clustered_deployment_count": 1, "deployment_spec_name": "GISpec", "deployment_mode": "STAND_ALONE", "instance_deployment_template": { "name": "GI_GOLD", "attributes": [ { "key": "netmask0", "display_name": "netmask0", "value": "", "attribute_type": "STRING" }, { "key": "vc_password", "display_name": "vc_password", "value": "", "attribute_type": "STRING" } ] }, "service_deployment_config": { "compute_manager_id": "f42c11d3-fe88-46d4-a1e5-b9f73a30c31a", "compute_collection_id": "f42c11d3-fe88-46d4-a1e5-b9f73a30c31a:domain-c7", "storage_id": "datastore-30", "vm_nic_info": { "nic_infos": [ { "nic_metadata": { "interface_label": "eth0", "interface_index": 0, "interface_type": "MANAGEMENT" }, "ip_pool_id": "a3cf1339-9cf7-4834-88ec-d4ad813bd130", "network_id": "network-28" } ] } }, "service_id": "7007c838-d605-458c-9bef-c068364f2efd", "resource_type": "ServiceDeployment", "id": "78e1a4fa-57e0-493c-9325-c8c508b01002", "display_name": "78e1a4fa-57e0-493c-9325-c8c508b01002", "_create_user": "admin", "_create_time": 1543558304751, "_last_modified_user": "admin", "_last_modified_time": 1543558304751, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceDeployment+

ServiceDeployment (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
clustered_deployment_count	Clustered Deployment Count Number of instances in case of clustered deployment.	integer	Minimum: 1 Maximum: 10 Default: "1"
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. Service Attachment in case of E-W ServiceInsertion.	array of ResourceReference	Minimum items: 1 Maximum items: 128
deployment_mode	Deployment Mode Mode of deployment. Currently, only stand alone deployment is supported. It is a single VM deployed through this deployment spec. In future, HA configurations will be supported here.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "STAND_ALONE"
deployment_spec_name	Deployment Spec Name Name of the deployment spec to be used for deployment, which specifies the OVF provided by the partner and the form factor.	string	Required
deployment_type	Deployment Type Specifies whether the service VM should be deployed on each host such that it provides partner service locally on the host, or whether the service VMs can be deployed as a cluster. If deployment_type is CLUSTERED, then the clustered_deployment_count should be provided.	string	Enum: HOSTLOCAL, CLUSTERED Default: "CLUSTERED"
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
instance_deployment_template	Instance Deployment Template The deployment template to be used during the deployment to provide customized attributes to the service VM.	DeploymentTemplate	Required
perimeter	Deployment perimeter This indicates the deployment perimeter, such as a VC cluster or a host.	string	Enum: CLUSTER, HOST Default: "HOST"
resource_type	Must be set to the value ServiceDeployment	string
service_deployment_config	Service Deployment Config Deployment Config contains the deployment specification, such as the storage and network to be used along with the cluster where the service VM can be deployed.	ServiceDeploymentConfig	Required
service_id	Service Id The Service to which the service deployment is associated.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "perimeter": "CLUSTER", "deployment_type": "HOSTLOCAL", "clustered_deployment_count": 1, "deployment_spec_name": "GISpec", "deployment_mode": "STAND_ALONE", "instance_deployment_template": { "name": "GI_GOLD", "attributes": [ { "key": "DNS", "display_name": "DNS", "value": "", "attribute_type": "STRING" }, { "key": "sva_key", "display_name": "sva_key", "value": "", "attribute_type": "STRING" } ] }, "service_deployment_config": { "compute_manager_id": "f42c11d3-fe88-46d4-a1e5-b9f73a30c31a", "compute_collection_id": "f42c11d3-fe88-46d4-a1e5-b9f73a30c31a:domain-c7", "storage_id": "datastore-30", "vm_nic_info": { "nic_infos": [ { "nic_metadata": { "interface_label": "eth0", "interface_index": 0, "interface_type": "MANAGEMENT" }, "ip_pool_id": "a3cf1339-9cf7-4834-88ec-d4ad813bd130", "network_id": "network-28" } ] } }, "service_id": "c729678f-443a-4822-bdd2-aadd7a483e5a", "resource_type": "ServiceDeployment", "id": "e6c2693f-2335-43de-8885-95db0b7c7478", "display_name": "e6c2693f-2335-43de-8885-95db0b7c7478", "_create_user": "admin", "_create_time": 1543950168765, "_last_modified_user": "admin", "_last_modified_time": 1543950168765, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

crud

Feature:

service_insertion_deployment

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