Create Tier1 Policy Service Instance
Create Tier1 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.
Request
URI
PUT
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-instances/{service-instance-id}
COPY
Path Parameters
string
tier-1-id
Required
Tier-1 id
string
locale-service-id
Required
Locale service id
string
service-instance-id
Required
Tier1 Service instance id
Request Body
PolicyServiceInstance of type(s) application/json
Optional
This request body class requires all of the following: BasePolicyServiceInstance , InlinePolicyServiceInstance1
{
"_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"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_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"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"deployment_mode": "string",
"partner_service_name": "string",
"transport_type": "string",
"attributes": [
{
"attribute_type": "string",
"display_name": "string",
"key": "string",
"read_only": false,
"value": "string"
}
],
"compute_id": "string",
"context_id": "string",
"deployment_spec_name": "string",
"deployment_template_name": "string",
"failure_policy": "string",
"primary_gateway_address": "string",
"primary_interface_mgmt_ip": "string",
"primary_interface_network": "string",
"primary_portgroup_id": "string",
"primary_subnet_mask": "string",
"secondary_gateway_address": "string",
"secondary_interface_mgmt_ip": "string",
"secondary_interface_network": "string",
"secondary_portgroup_id": "string",
"secondary_subnet_mask": "string",
"storage_id": "string"
}
Responses
200
OK
Returns PolicyServiceInstance of type(s) application/json
This response body class contains all of the following: BasePolicyServiceInstance , InlinePolicyServiceInstance1
{
"_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"
}
],
"parent_path": "string",
"path": "string",
"relative_path": "string",
"children": [
{
"_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"
}
],
"marked_for_delete": false
}
],
"marked_for_delete": false,
"deployment_mode": "string",
"partner_service_name": "string",
"transport_type": "string",
"attributes": [
{
"attribute_type": "string",
"display_name": "string",
"key": "string",
"read_only": false,
"value": "string"
}
],
"compute_id": "string",
"context_id": "string",
"deployment_spec_name": "string",
"deployment_template_name": "string",
"failure_policy": "string",
"primary_gateway_address": "string",
"primary_interface_mgmt_ip": "string",
"primary_interface_network": "string",
"primary_portgroup_id": "string",
"primary_subnet_mask": "string",
"secondary_gateway_address": "string",
"secondary_interface_mgmt_ip": "string",
"secondary_interface_network": "string",
"secondary_portgroup_id": "string",
"secondary_subnet_mask": "string",
"storage_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"
}
]
}
On This Page
Tier 1s Operations
PUT
Create Or Replace Tier1 Interface
PUT
Create Or Replace Tier1 Locale Services
PUT
Create Tier1 Policy Service Instance
DELETE
Delete Tier1 Interface
DELETE
Delete Tier1 Locale Services
DELETE
Delete Tier1 Locale Services Flood Protection Profile Binding
DELETE
Delete Tier1 Locale Services Session Timer Profile Binding
DELETE
Delete Tier1 Policy Service Instance
GET
Get Tier1 Interface Statistics
GET
Get Tier1IP Sec Vpn Session Statistics
GET
Get Tier1IP Sec Vpn Session Status
GET
Get Tier1 Locale Services Flood Protection Profile Binding
GET
Get Tier1 Locale Services Session Timer Profile Binding
GET
Get Tier1 Policy Service Instance Statistics
GET
List Tier1 Locale Services
PATCH
Patch Tier1 Interface
PATCH
Patch Tier1 Locale Services
PATCH
Patch Tier1 Locale Services Flood Protection Profile Binding Map
PATCH
Patch Tier1 Locale Services Session Timer Profile Binding Map
PATCH
Patch Tier1 Policy Service Instance
GET
Read All Policy Service Instances For Tier1
GET
Read Tier1 Interface
GET
Read Tier1 Locale Services
GET
Read Tier1 Policy Service Instance
PUT
Update Tier1 Locale Services Flood Protection Profile Binding
PUT
Update Tier1 Locale Services Session Timer Profile Binding
GET
View Tier1 Locale Services Gateway Firewall