Create Service Definition
Create a Service Definition on given enforcement point.
Request
URI
POST
https://nsxmanager.your.domain/policy/api/v1/enforcement-points/{enforcement-point-id}/service-definitions
COPY
Path Parameters
string
enforcement-point-id
Required
Enforcement point id
Request Body
ServiceDefinition of type(s) application/json
Optional
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"attachment_point": [
"string"
],
"functionalities": [
"string"
],
"implementations": [
"string"
],
"on_failure_policy": "string",
"service_capability": {
"can_decrement_si": false,
"nsh_liveness_support_enabled": false
},
"service_deployment_spec": {
"deployment_specs": [
{
"host_type": "string",
"min_host_version": "string",
"name": "string",
"ovf_url": "string",
"service_form_factor": "string"
}
],
"deployment_template": [
{
"attributes": [
{
"attribute_type": "string",
"display_name": "string",
"key": "string",
"read_only": false,
"value": "string"
}
],
"name": "string"
}
],
"nic_metadata_list": [
{
"interface_index": 0,
"interface_label": "string",
"interface_type": "string",
"transports": [
"string"
],
"user_configurable": false
}
],
"svm_version": "string"
},
"service_manager_id": "string",
"transports": [
"string"
],
"vendor_id": "string"
}
Responses
201
Created
Returns ServiceDefinition of type(s) application/json
This response body class contains all of the following: ManagedResource , InlineServiceDefinition1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_revision": 0,
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_protection": "string",
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"attachment_point": [
"string"
],
"functionalities": [
"string"
],
"implementations": [
"string"
],
"on_failure_policy": "string",
"service_capability": {
"can_decrement_si": false,
"nsh_liveness_support_enabled": false
},
"service_deployment_spec": {
"deployment_specs": [
{
"host_type": "string",
"min_host_version": "string",
"name": "string",
"ovf_url": "string",
"service_form_factor": "string"
}
],
"deployment_template": [
{
"attributes": [
{
"attribute_type": "string",
"display_name": "string",
"key": "string",
"read_only": false,
"value": "string"
}
],
"name": "string"
}
],
"nic_metadata_list": [
{
"interface_index": 0,
"interface_label": "string",
"interface_type": "string",
"transports": [
"string"
],
"user_configurable": false
}
],
"svm_version": "string"
},
"service_manager_id": "string",
"transports": [
"string"
],
"vendor_id": "string"
}
400
Returns BadRequest of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
403
Returns Forbidden of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
404
Returns NotFound of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
412
Returns PreconditionFailed of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
500
Returns InternalServerError of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}
503
Returns ServiceUnavailable of type(s) application/json
This response body class contains all of the following: RelatedApiError , InlineApiError1
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
}