Developer Documentation
Create Locale Services
If a Tier-0 locale-services with the locale-services-id is not already present, create a new locale-services. If it already exists, replace the Tier-0 locale-services instance with the new object.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
Request Body
Request Body
Contains
LocaleServices
(required)
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"children": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"description": "string",
"display_name": "string",
"edge_cluster_path": "string",
"ha_vip_configs": [
{
"enabled": false,
"external_interface_paths": [
"string"
],
"vip_subnets": [
{
"ip_addresses": [
"string"
],
"prefix_len": 0
}
]
}
],
"id": "string",
"marked_for_delete": false,
"parent_path": "string",
"path": "string",
"preferred_edge_paths": [
"string"
],
"relative_path": "string",
"resource_type": "string",
"route_redistribution_types": [
"string"
],
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | _create_time | integer |
Timestamp of resource creation |
| optional | _create_user | string |
ID of the user who created this resource |
| optional | _last_modified_time | integer |
Timestamp of last modification |
| optional | _last_modified_user | string |
ID of the user who last modified this resource |
| optional | _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| optional | _protection | string |
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. |
| optional | _revision | integer |
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. |
| optional | _schema | string |
Schema for this resource |
| optional | _self | SelfResourceLink |
Link to this resource |
| optional | _system_owned | boolean |
Indicates system owned resource |
| optional | children | array of ChildPolicyConfigResource |
subtree for this type within policy tree containing nested elements. |
| optional | description | string |
Description of this resource |
| optional | display_name | string |
Defaults to ID if not set |
| optional | edge_cluster_path | string |
Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster. |
| optional | ha_vip_configs | array of Tier0HaVipConfig |
This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed. |
| optional | id | string |
Unique identifier of this resource |
| optional | marked_for_delete | boolean |
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. |
| optional | parent_path | string |
Path of its parent |
| optional | path | string |
Absolute path of this object |
| optional | preferred_edge_paths | array of string |
Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE, not applicable otherwise. |
| optional | relative_path | string |
Path relative from its parent |
| optional | resource_type | string |
The type of this resource. |
| optional | route_redistribution_types | array of string |
Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0. Possible values are: TIER0_CONNECTED, TIER0_DNS_FORWARDER_IP, TIER0_EXTERNAL_INTERFACE, TIER0_IPSEC_LOCAL_IP, TIER0_LOOPBACK_INTERFACE, TIER0_NAT, TIER0_ROUTER_LINK, TIER0_SEGMENT, TIER0_SERVICE_INTERFACE, TIER0_STATIC, TIER1_CONNECTED, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT, TIER1_LB_SNAT, TIER1_LB_VIP, TIER1_NAT, TIER1_SEGMENT, TIER1_SERVICE_INTERFACE, TIER1_STATIC |
| optional | tags | array of Tag |
Opaque identifiers meaningful to the API user |
Response
Response
Response BodyResponse Body
200 OK returns
LocaleServices
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"children": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"description": "string",
"display_name": "string",
"edge_cluster_path": "string",
"ha_vip_configs": [
{
"enabled": false,
"external_interface_paths": [
"string"
],
"vip_subnets": [
{
"ip_addresses": [
"string"
],
"prefix_len": 0
}
]
}
],
"id": "string",
"marked_for_delete": false,
"parent_path": "string",
"path": "string",
"preferred_edge_paths": [
"string"
],
"relative_path": "string",
"resource_type": "string",
"route_redistribution_types": [
"string"
],
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| _create_time | integer |
Timestamp of resource creation |
| _create_user | string |
ID of the user who created this resource |
| _last_modified_time | integer |
Timestamp of last modification |
| _last_modified_user | string |
ID of the user who last modified this resource |
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _protection | string |
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. |
| _revision | integer |
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. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| _system_owned | boolean |
Indicates system owned resource |
| children | array of ChildPolicyConfigResource |
subtree for this type within policy tree containing nested elements. |
| description | string |
Description of this resource |
| display_name | string |
Defaults to ID if not set |
| edge_cluster_path | string |
Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster. |
| ha_vip_configs | array of Tier0HaVipConfig |
This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed. |
| id | string |
Unique identifier of this resource |
| marked_for_delete | boolean |
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. |
| parent_path | string |
Path of its parent |
| path | string |
Absolute path of this object |
| preferred_edge_paths | array of string |
Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE, not applicable otherwise. |
| relative_path | string |
Path relative from its parent |
| resource_type | string |
The type of this resource. |
| route_redistribution_types | array of string |
Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0. Possible values are: TIER0_CONNECTED, TIER0_DNS_FORWARDER_IP, TIER0_EXTERNAL_INTERFACE, TIER0_IPSEC_LOCAL_IP, TIER0_LOOPBACK_INTERFACE, TIER0_NAT, TIER0_ROUTER_LINK, TIER0_SEGMENT, TIER0_SERVICE_INTERFACE, TIER0_STATIC, TIER1_CONNECTED, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT, TIER1_LB_SNAT, TIER1_LB_VIP, TIER1_NAT, TIER1_SEGMENT, TIER1_SERVICE_INTERFACE, TIER1_STATIC |
| tags | array of Tag |
Opaque identifiers meaningful to the API user |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | Not Found |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
On This Page
Locale Services Operations
delete
delete
delete
patch
patch
patch
