Developer Documentation
Get Tier 0
Read Tier-0
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
Response
Response
Response BodyResponse Body
200 OK returns
Tier0
{
"_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"
}
]
}
],
"default_rule_logging": false,
"description": "string",
"dhcp_config_paths": [
"string"
],
"disable_firewall": false,
"display_name": "string",
"failover_mode": "string",
"force_whitelisting": false,
"ha_mode": "string",
"id": "string",
"internal_transit_subnets": [
"string"
],
"ipv6_profile_paths": [
"string"
],
"marked_for_delete": false,
"parent_path": "string",
"path": "string",
"relative_path": "string",
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
],
"transit_subnets": [
"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. |
| default_rule_logging | boolean |
Indicates if logging should be enabled for the default whitelisting rule. This filed is deprecated and recommended to change Rule logging filed. Note that this filed is not synchornied with default logging field. |
| description | string |
Description of this resource |
| dhcp_config_paths | array of string |
DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode. |
| disable_firewall | boolean |
Disable or enable gateway fiewall. |
| display_name | string |
Defaults to ID if not set |
| failover_mode | string |
Determines the behavior when a Tier-0 instance in ACTIVE-STANDBY high-availability mode restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. This property is not used when the ha_mode property is set to ACTIVE_ACTIVE. Only applicable when edge cluster is configured in Tier0 locale-service. Possible values are: NON_PREEMPTIVE, PREEMPTIVE |
| force_whitelisting | boolean |
This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field. |
| ha_mode | string |
Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE. Possible values are: ACTIVE_ACTIVE, ACTIVE_STANDBY |
| id | string |
Unique identifier of this resource |
| internal_transit_subnets | array of string |
Specify subnets that are used to assign addresses to logical links connecting service routers and distributed routers. Only IPv4 addresses are supported. When not specified, subnet 169.254.0.0/24 is assigned by default in ACTIVE_ACTIVE HA mode or 169.254.0.0/28 in ACTIVE_STANDBY mode. |
| ipv6_profile_paths | array of string |
IPv6 NDRA and DAD profiles configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured. |
| 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 |
| relative_path | string |
Path relative from its parent |
| resource_type | string |
The type of this resource. |
| tags | array of Tag |
Opaque identifiers meaningful to the API user |
| transit_subnets | array of string |
Specify transit subnets that are used to assign addresses to logical links connecting tier-0 and tier-1s. Both IPv4 and IPv6 addresses are supported. When not specified, subnet 100.64.0.0/16 is configured by default. |
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). |
