Tier1

Tier-1 instance configuration.


Properties

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


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


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-1. DHCP service is enabled in relay mode.


boolean
disable_firewall Optional

Disable or enable gateway fiewall.


string
display_name Optional

Defaults to ID if not set


boolean
enable_standby_relocation Optional

Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.


string
failover_mode Optional

Determines the behavior when a Tier-1 instance 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. Only applicable when edge cluster is configured in Tier1 locale-service.

Possible values are: PREEMPTIVENON_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
id Optional

Unique identifier of this resource


array of string
ipv6_profile_paths Optional

Configuration IPv6 NDRA and DAD profiles. 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.


route_advertisement_rules Optional

Route advertisement rules and filtering


array of string
route_advertisement_types Optional

Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.

Possible values are: TIER1_STATIC_ROUTESTIER1_CONNECTEDTIER1_NATTIER1_LB_VIPTIER1_LB_SNATTIER1_DNS_FORWARDER_IPTIER1_IPSEC_LOCAL_ENDPOINT


array of Tag
tags Optional

Opaque identifiers meaningful to the API user


string
tier0_path Optional

Specify Tier-1 connectivity to Tier-0 instance.


string
type Optional

Tier1 connectivity type for reference. Property value is not validated with Tier1 configuration. ROUTED: Tier1 is connected to Tier0 gateway and routing is enabled. ISOLATED: Tier1 is not connected to any Tier0 gateway. NATTED: Tier1 is in ROUTED type with NAT configured locally.

Possible values are: ROUTEDISOLATEDNATTED

Property Of

ChildTier1
Parameter To

Create Tier1
Update Tier1
Returned By

Get Tier1
Create Tier1
Extends

PolicyConfigResource

JSON Example

{
    "_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",
    "enable_standby_relocation": false,
    "failover_mode": "string",
    "force_whitelisting": false,
    "id": "string",
    "ipv6_profile_paths": [
        "string"
    ],
    "marked_for_delete": false,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "route_advertisement_rules": [
        {
            "action": "string",
            "name": "string",
            "prefix_operator": "string",
            "route_advertisement_types": [
                "string"
            ],
            "subnets": [
                "string"
            ]
        }
    ],
    "route_advertisement_types": [
        "string"
    ],
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "tier0_path": "string",
    "type": "string"
}
Feedback

Was this page helpful?