| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _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
entity.
|
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. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| advanced_config |
Advanced configuration for tier-0
NSX specific configuration for tier-0 |
Tier0AdvancedConfig |
|
| 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. Note that
this type is applicable to be used in Hierarchical API only.
|
array of ChildPolicyConfigResource
(Abstract type: pass one of the following concrete types)
ChildCommunityList
ChildEvpnConfig
ChildIPSecVpnService
ChildL2VPNService
ChildLocaleServices
ChildPolicyDnsForwarder
ChildPolicyInterVrfRoutingConfig
ChildPrefixList
ChildStaticRoutes
ChildTier0RouteMap
ChildTier0SecurityFeatures |
|
| 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
Sortable |
| dhcp_config_paths |
DHCP configuration for Segments connected to Tier-0
DHCP configuration for Segments connected to Tier-0. DHCP service is
configured 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
Sortable |
| failover_mode |
Failover mode
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.
|
string |
Enum: PREEMPTIVE, NON_PREEMPTIVE
Default: "NON_PREEMPTIVE" |
| 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 synchronized with default rule field.
|
boolean |
Deprecated
Default: "False" |
| ha_mode |
High-availability Mode for Tier-0
Specify high-availability mode for Tier-0. Default is ACTIVE_ACTIVE.
When ha_mode is changed from ACTIVE_ACTIVE to ACTIVE_STANDBY,
inter SR iBGP (in BGP) is disabled.
Changing ha_mode from ACTIVE_STANDBY to ACTIVE_ACTIVE will enable
inter SR iBGP (in BGP) and previously configured preferred edge nodes
(in Tier0 locale-service) are removed.
|
string |
Enum: ACTIVE_ACTIVE, ACTIVE_STANDBY
Default: "ACTIVE_ACTIVE" |
| id |
Unique identifier of this resource |
string |
Sortable |
| internal_transit_subnets |
Internal transit subnets in CIDR format
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 |
Maximum items: 1 |
| intersite_config |
Inter site routing configuration
Inter site routing configuration when the gateway is streched. |
IntersiteGatewayConfig |
|
| ipv6_profile_paths |
IPv6 NDRA and DAD profiles configuration
IPv6 NDRA and DAD profiles configuration on Tier0. 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" |
| origin_site_id |
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
|
string |
Readonly |
| 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" |
| owner_id |
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
|
string |
Readonly |
| 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 |
| rd_admin_field |
Route distinguisher administrator address
If you are using EVPN service, then route distinguisher administrator address
should be defined if you need auto generation of route distinguisher on your
VRF configuration.
|
IPAddress |
|
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated their
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| remote_path |
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
|
string |
Readonly |
| resource_type |
Must be set to the value Tier0 |
string |
|
| stateful_services |
Enable/disable stateful services
For ACTIVE-ACTIVE, this is used to enable/disable stateful services.
|
Tier0StatefulServicesConfig |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| transit_subnets |
Transit subnets in CIDR format
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.
When modifying, for stateful active-active Tier-0 number of IPs should be at least
attached Tier-1s count * 16 and for other type of Tier-0 number of IPs should be at
least attached Tier-1s count * 2.
Modification not allowed if there are child tier-0 VRFs and there are
any Tier-1s connected to those VRFs.
The value in VRF tier-0 is always inherited from the parent.
|
array of string |
|
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entities 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 |
| vrf_config |
VRF config
VRF config, required for VRF Tier0. |
Tier0VrfConfig |
|
| vrf_transit_subnets |
VRF transit subnets in CIDR format
Specify subnets that are used to assign addresses to logical links
connecting default T0 and child VRFs.
When not specified, subnet 169.254.2.0/23 is assigned by default.
|
array of string |
Maximum items: 1 |