NSX-T Data Center REST API

Create service instance

Create service instance.
Please note that, only display_name, description and deployment_spec_name
are allowed to be modified in an exisiting entity. If the deployment spec
name is changed, it will trigger the upgrade operation for the SVMs.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-instances/{service-instance-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

PolicyServiceInstance+

PolicyServiceInstance (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
attributes	Deployment Template attributes List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.	array of Attribute	Required Maximum items: 128
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
compute_id	Id of the compute resource. Id of the compute(ResourcePool) to which this service needs to be deployed.	string	Required
context_id	Id of the compute manager UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.	string
deployment_mode	Deployment Mode Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
deployment_spec_name	Name of the Deployment Specification Form factor for the deployment of partner service.	string	Required
deployment_template_name	Name of the Deployment Template Template for the deployment of partnet service.	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
failure_policy	Failure policy for the Service VM Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.	string	Enum: ALLOW, BLOCK Default: "BLOCK"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
partner_service_name	Name of Partner Service Unique name of Partner Service in the Marketplace	string	Required
path	Absolute path of this object Absolute path of this object	string	Readonly
primary_gateway_address	Gateway for primary management console Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.	IPElement
primary_interface_mgmt_ip	Management IP Address of primary interface of the Service Management IP Address of primary interface of the Service	IPElement	Required
primary_interface_network	Path of the segment to which primary interface of the Service VM needs to be connected Path of the segment to which primary interface of the Service VM needs to be connected	string
primary_portgroup_id	Id of the standard or ditsributed port group for primary management console Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can't be passed in the same request.	string
primary_subnet_mask	Subnet for primary management console IP Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.	IPElement
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value PolicyServiceInstance	string
secondary_gateway_address	Gateway for secondary management console Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.	IPElement
secondary_interface_mgmt_ip	Management IP Address of secondary interface of the Service Management IP Address of secondary interface of the Service	IPElement
secondary_interface_network	Path of segment to which secondary interface of the Service VM needs to be connected Path of segment to which secondary interface of the Service VM needs to be connected	string
secondary_portgroup_id	Id of the standard or ditsributed port group for secondary management console Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can't be passed in the same request.	string
secondary_subnet_mask	Subnet for secondary management console IP Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.	IPElement
storage_id	Id of the storage Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used while deploying Service-VM.	string	Enum: L2_BRIDGE, L3_ROUTED Default: "L2_BRIDGE"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Request:

{ "resource_type": "PolicyServiceInstance", "description": "PAN partner service", "id": "pan-service-instance", "display_name": "pan-service-instance", "path": "/infra/domains/D1/service-instances/PAN-1", "partner_service_name": "NS Service_automation", "deployment_mode": "ACTIVE_STANDBY", "transport_type": "L2_BRIDGE" "primary_interface_network": "/infra/tier-1s/TIER-1-LR-1/segments/SI_SEGMENT", "primary_interface_mgmt_ip": "2.1.1.4", "primary_gateway_address": "2.1.1.1", "primary_subnet_mask": "255.255.255.0", "secondary_interface_network": "/infra/tier-1s/TIER-1-LR-1/segments/SI_SEGMENT", "secondary_interface_mgmt_ip": "2.1.1.5", "secondary_gateway_address": "2.1.1.1", "secondary_subnet_mask": "255.255.255.0", "failure_policy": "BLOCK", "context_id": "3910b71f-0f10-47c7-bffc-2c996da30563", "compute_id": "3910b71f-0f10-47c7-bffc-2c996da30563:domain-c16", "storage_id": "datastore-12", "deployment_spec_name": "NS_DepSpec", "deployment_template_name": "NS_DepTemp", "attributes": [ { "key": "LicenseKey", "display_name": "License", "value": "adklfjakldfjlkajfkl", "attribute_type": "STRING", "read_only": false } ], "_revision":0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyServiceInstance+

PolicyServiceInstance (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
attributes	Deployment Template attributes List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance.	array of Attribute	Required Maximum items: 128
children	Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.	array of ChildPolicyConfigResource Children are not allowed for this type
compute_id	Id of the compute resource. Id of the compute(ResourcePool) to which this service needs to be deployed.	string	Required
context_id	Id of the compute manager UUID of VCenter/Compute Manager as seen on NSX Manager, to which this service needs to be deployed.	string
deployment_mode	Deployment Mode Deployment mode specifies how the partner appliance will be deployed i.e. in HA or standalone mode.	string	Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
deployment_spec_name	Name of the Deployment Specification Form factor for the deployment of partner service.	string	Required
deployment_template_name	Name of the Deployment Template Template for the deployment of partnet service.	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
failure_policy	Failure policy for the Service VM Failure policy for the Service VM. If this values is not provided, it will be defaulted to FAIL_CLOSE.	string	Enum: ALLOW, BLOCK Default: "BLOCK"
id	Unique identifier of this resource	string	Sortable
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
origin_site_id	A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.	string	Readonly
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
owner_id	A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.	string	Readonly
parent_path	Path of its parent Path of its parent	string	Readonly
partner_service_name	Name of Partner Service Unique name of Partner Service in the Marketplace	string	Required
path	Absolute path of this object Absolute path of this object	string	Readonly
primary_gateway_address	Gateway for primary management console Gateway address for primary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.	IPElement
primary_interface_mgmt_ip	Management IP Address of primary interface of the Service Management IP Address of primary interface of the Service	IPElement	Required
primary_interface_network	Path of the segment to which primary interface of the Service VM needs to be connected Path of the segment to which primary interface of the Service VM needs to be connected	string
primary_portgroup_id	Id of the standard or ditsributed port group for primary management console Id of the standard or ditsributed port group for primary management console. Please note that only 1 of the 2 values from 1. primary_interface_network 2. primary_portgroup_id are allowed to be passed. Both can't be passed in the same request.	string
primary_subnet_mask	Subnet for primary management console IP Subnet for primary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.	IPElement
realization_id	A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent.	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_path	Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM.	string	Readonly
resource_type	Must be set to the value PolicyServiceInstance	string
secondary_gateway_address	Gateway for secondary management console Gateway address for secondary management console. If the provided segment already has gateway, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have gateway, this field must be provided.	IPElement
secondary_interface_mgmt_ip	Management IP Address of secondary interface of the Service Management IP Address of secondary interface of the Service	IPElement
secondary_interface_network	Path of segment to which secondary interface of the Service VM needs to be connected Path of segment to which secondary interface of the Service VM needs to be connected	string
secondary_portgroup_id	Id of the standard or ditsributed port group for secondary management console Id of the standard or ditsributed port group for secondary management console. Please note that only 1 of the 2 values from 1. secondary_interface_network 2. secondary_portgroup_id are allowed to be passed. Both can't be passed in the same request.	string
secondary_subnet_mask	Subnet for secondary management console IP Subnet for secondary management console IP. If the provided segment already has subnet, this field can be omitted. But if it is provided, it takes precedence always. However, if provided segment does not have subnet, this field must be provided.	IPElement
storage_id	Id of the storage Id of the storage(Datastore). VC moref of Datastore to which this service needs to be deployed.	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used while deploying Service-VM.	string	Enum: L2_BRIDGE, L3_ROUTED Default: "L2_BRIDGE"
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Response:

{ "resource_type": "PolicyServiceInstance", "description": "PAN partner service", "id": "pan-service-instance", "display_name": "pan-service-instance", "path": "/infra/domains/D1/service-instances/PAN-1", "partner_service_name": "NS Service_automation", "deployment_mode": "ACTIVE_STANDBY", "transport_type": "L2_BRIDGE" "primary_interface_network": "/infra/tier-1s/TIER-1-LR-1/segments/SI_SEGMENT", "primary_interface_mgmt_ip": "2.1.1.4", "primary_gateway_address": "2.1.1.1", "primary_subnet_mask": "255.255.255.0", "secondary_interface_network": "/infra/tier-1s/TIER-1-LR-1/segments/SI_SEGMENT", "secondary_interface_mgmt_ip": "2.1.1.5", "secondary_gateway_address": "2.1.1.1", "secondary_subnet_mask": "255.255.255.0", "failure_policy": "BLOCK", "context_id": "3910b71f-0f10-47c7-bffc-2c996da30563", "compute_id": "3910b71f-0f10-47c7-bffc-2c996da30563:domain-c16", "storage_id": "datastore-12", "deployment_spec_name": "NS_DepSpec", "deployment_template_name": "NS_DepTemp", "attributes": [ { "key": "LicenseKey", "display_name": "License", "value": "adklfjakldfjlkajfkl", "attribute_type": "STRING", "read_only": false } ], "_system_owned": false, "_create_user": "admin", "_create_time": 1516274764993, "_last_modified_user": "admin", "_last_modified_time": 1516274764993, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

crud

Feature:

policy_si

Additional Errors:

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