Tier1 (schema)


Tier-1 instance configuration.
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

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
string Readonly
_revision Generation of this resource config

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 Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
arp_limit ARP limit per transport node

Maximum number of ARP entries per transport node.
int Minimum: 5000
Maximum: 50000
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
(Abstract type: pass one of the following concrete types)
default_rule_logging Enable logging for whitelisted rule

Indicates if logging should be enabled for the default whitelisting rule. This field is
deprecated and recommended to change Rule logging field. Note that this
field is not synchronized with default logging field.
boolean Deprecated
Default: "False"
description Description of this resource string Maximum length: 1024
dhcp_config_paths DHCP configuration for Segments connected to Tier-1

DHCP configuration for Segments connected to Tier-1. DHCP service is
enabled in relay mode.
array of string Minimum items: 0
Maximum items: 1
disable_firewall Disable gateway firewall

Disable or enable gateway fiewall.
boolean Default: "False"
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
enable_standby_relocation Flag to enable standby service router relocation.

Flag to enable standby service router relocation.
Standby relocation is not enabled until edge cluster is configured
for Tier1.
boolean Default: "False"
failover_mode Failover mode

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
federation_config Federation releated config

Additional config for federation.
FederationGatewayConfig Readonly
force_whitelisting Flag to add whitelisting FW rule during realization

This field is deprecated and recommended to change Rule action field.
Note that this field is not synchornied with default rule field.
boolean Deprecated
Default: "False"
id Unique identifier of this resource string Sortable
intersite_config Inter site routing configuration

Inter site routing configuration when the gateway is streched.
ipv6_profile_paths IPv6 NDRA and DAD profiles configuration

Configuration IPv6 NDRA and DAD profiles. Either or both
NDRA and/or DAD profiles can be configured.
array of string Minimum items: 0
Maximum items: 2
marked_for_delete Indicates whether the intent object is marked for deletion

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.
boolean Readonly
Default: "False"
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
pool_allocation Edge node allocation size

Supports edge node allocation at different sizes for routing and
load balancer service to meet performance and scalability requirements.
ROUTING: Allocate edge node to provide routing services.
LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE: Specify size of load balancer
service that will be configured on TIER1 gateway.
Default: "ROUTING"
qos_profile Gateway QoS Profile configuration

QoS Profile configuration for Tier1 router link connected to Tier0 gateway.
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Tier1 string
route_advertisement_rules Route advertisement rules and filtering array of RouteAdvertisementRule
route_advertisement_types Enable different types of route advertisements

Enable different types of route advertisements.
When not specified, routes to IPSec VPN local-endpoint subnets
(TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.
array of Tier1RouteAdvertisentTypes
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
tier0_path Tier-1 connectivity to Tier-0

Specify Tier-1 connectivity to Tier-0 instance.
type Tier1 type

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.
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly