Tier0Interface (schema)

Tier-0 interface configuration

Tier-0 interface configuration for external connectivity.
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
access_vlan_id Vlan id

Vlan id.
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
description Description of this resource string Maximum length: 1024
dhcp_relay_path policy path of referenced dhcp-relay-config

Policy path of dhcp-relay-config to be attached to this Interface.
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
edge_cluster_member_index Association of interface with edge cluster member

Specify association of interface with edge cluster member.
This property is deprecated, use edge_path instead. When both
properties are specifed, only edge_path property is used.
int Deprecated
Minimum: 0
edge_path Policy path to edge node

Policy path to edge node to handle external connectivity.
Required when interface type is EXTERNAL.
id Unique identifier of this resource string Sortable
igmp_local_join_groups IGMP local join groups configuration

IGMP local join groups configuration.
array of IPv4Address
ipv6_profile_paths IPv6 NDRA profile configuration

Configuration IPv6 NDRA profile. Only one
NDRA profile can be configured.
array of string Minimum items: 0
Maximum items: 1
ls_id Logical switch id to attach tier-0 interface

Specify logical switch to which tier-0 interface is connected for
external access.
This property is deprecated, use segment_path instead. Both
properties cannot be used together.
string Deprecated
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"
mtu MTU size

Maximum transmission unit (MTU) specifies the size of the largest
packet that a network protocol can transmit.
int Minimum: 64
multicast Multicast PIM configuration

Multicast PIM configuration.
ospf OSPF configuration

OSPF configuration.
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
proxy_arp_filters List of proxy Address Resolution Protocol Filters

Array of prefix lists used to specify filtering for ARP proxy.
Prefixes in this array are used to configure ARP proxy entries on Tier-0
gateway (for uplinks).
array of string Minimum items: 0
Maximum items: 1
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value Tier0Interface string
segment_path Segment to attach tier-0 interface

Specify Segment to which this interface is connected to.
Either segment_path or ls_id property is required.
subnets IP address and subnet specification for interface

Specify IP address and network prefix for interface.
array of InterfaceSubnet Required
Minimum items: 1
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
type Interface type

Interface type
Default: "EXTERNAL"
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
urpf_mode Unicast Reverse Path Forwarding mode string Enum: NONE, STRICT
Default: "STRICT"