Get Tier 0

{
    "_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"
    ]
}

integer

_create_time Optional

Timestamp of resource creation

string

_create_user Optional

ID of the user who created this resource

integer

_last_modified_time Optional

Timestamp of last modification

string

_last_modified_user Optional

ID of the user who last modified this resource

array of ResourceLink

_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

string

_protection Optional

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.

integer

_revision Optional

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.

string

_schema Optional

Schema for this resource

SelfResourceLink

_self Optional

Link to this resource

boolean

_system_owned Optional

Indicates system owned resource

array of ChildPolicyConfigResource

children Optional

subtree for this type within policy tree containing nested elements.

boolean

default_rule_logging Optional

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.

string

description Optional

Description of this resource

array of string

dhcp_config_paths Optional

DHCP configuration for Segments connected to Tier-0. DHCP service is configured in relay mode.

boolean

disable_firewall Optional

Disable or enable gateway fiewall.

string

display_name Optional

Defaults to ID if not set

string

failover_mode Optional

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: PREEMPTIVE, NON_PREEMPTIVE

boolean

force_whitelisting Optional

This filed is deprecated and recommended to change Rule action filed. Note that this filed is not synchornied with default rule field.

string

ha_mode Optional

Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE.

Possible values are: ACTIVE_ACTIVE, ACTIVE_STANDBY

string

id Optional

Unique identifier of this resource

array of string

internal_transit_subnets Optional

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.

array of string

ipv6_profile_paths Optional

IPv6 NDRA and DAD profiles configuration on Tier0. Either or both NDRA and/or DAD profiles can be configured.

boolean

marked_for_delete Optional

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.

string

parent_path Optional

Path of its parent

string

path Optional

Absolute path of this object

string

relative_path Optional

Path relative from its parent

string

resource_type Optional

The type of this resource.

array of Tag

tags Optional

Opaque identifiers meaningful to the API user

array of string

transit_subnets Optional

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.

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}

Errors

InternalServerError

500

The server encountered an unexpected condition which prevented it from fulfilling the request.

ServiceUnavailable

503

The server is currently unavailable (because it is overloaded or down for maintenance).

BadRequest

400

The request cannot be fulfilled due to bad syntax.

Forbidden

403

The server understood the request, but is refusing to fulfill it.

Not available

404

The requested resource could not be found but may be available again in the future.

PreconditionFailed

412

Not available

Properties Operations

put

Create Tier 0

delete

Delete Tier 0

get

Get Tier 0

get

List Tier 0s

patch

Update Tier 0

Get Tier 0

On This Page

Request

URL

Parameters

Response

Response Body

cURL Command

Errors

On This Page

Properties Operations

Was this page helpful?