{
"additionalProperties": false,
"description": "Tier-1 instance configuration.",
"extends": {
"$ref": "PolicyConfigResource
},
"id": "Tier1",
"module_id": "PolicyConnectivity",
"policy_hierarchical_children": [
"ChildIPSecVpnService",
"ChildL2VPNService",
"ChildLocaleServices",
"ChildPolicyDnsForwarder",
"ChildSecurityFeatures",
"ChildSegment",
"ChildStaticRoutes"
],
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "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.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "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.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"arp_limit": {
"description": "Maximum number of ARP entries per transport node.",
"maximum": 50000,
"minimum": 5000,
"required": false,
"title": "ARP limit per transport node",
"type": "int"
},
"children": {
"description": "Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.",
"items": {
"$ref": "ChildPolicyConfigResource
},
"required": false,
"title": "Subtree for this type within policy tree",
"type": "array"
},
"default_rule_logging": {
"default": false,
"deprecated": true,
"description": "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.",
"required": false,
"title": "Enable logging for whitelisted rule",
"type": "boolean"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"dhcp_config_paths": {
"description": "DHCP configuration for Segments connected to Tier-1. DHCP service is enabled in relay mode.",
"items": {
"type": "string"
},
"maxItems": 1,
"minItems": 0,
"required": false,
"title": "DHCP configuration for Segments connected to Tier-1",
"type": "array",
"x-vmw-cross-reference": [
{
"leftType": [
"Tier1"
],
"relationshipType": "DHCP_SERVER_CONFIG_RELATIONSHIP",
"rightType": [
"DhcpServerConfig"
]
},
{
"leftType": [
"Tier1"
],
"relationshipType": "DHCP_RELAY_CONFIG_RELATIONSHIP",
"rightType": [
"DhcpRelayConfig"
]
}
]
},
"disable_firewall": {
"default": false,
"description": "Disable or enable gateway fiewall.",
"required": false,
"title": "Disable gateway firewall",
"type": "boolean"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enable_standby_relocation": {
"default": false,
"description": "Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.",
"required": false,
"title": "Flag to enable standby service router relocation.",
"type": "boolean"
},
"failover_mode": {
"default": "NON_PREEMPTIVE",
"description": "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.",
"enum": [
"PREEMPTIVE",
"NON_PREEMPTIVE"
],
"required": false,
"title": "Failover mode",
"type": "string"
},
"federation_config": {
"$ref": "FederationGatewayConfig,
"description": "Additional config for federation.",
"readonly": true,
"title": "Federation releated config"
},
"force_whitelisting": {
"default": false,
"deprecated": true,
"description": "This field is deprecated and recommended to change Rule action field. Note that this field is not synchornied with default rule field.",
"required": false,
"title": "Flag to add whitelisting FW rule during realization",
"type": "boolean"
},
"ha_mode": {
"description": "Specify high-availability mode for Tier-1.",
"enum": [
"ACTIVE_STANDBY",
"ACTIVE_ACTIVE"
],
"required": false,
"title": "High-availability Mode for Tier-1",
"type": "string"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"intersite_config": {
"$ref": "IntersiteGatewayConfig,
"description": "Inter site routing configuration when the gateway is streched.",
"required": false,
"title": "Inter site routing configuration"
},
"ipv6_profile_paths": {
"description": "Configuration IPv6 NDRA and DAD profiles. Either or both NDRA and/or DAD profiles can be configured.",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 0,
"required": false,
"title": "IPv6 NDRA and DAD profiles configuration",
"type": "array",
"x-vmw-cross-reference": [
{
"leftType": [
"Tier1"
],
"relationshipType": "IPV6_NDRA_PROFILE_RELATIONSHIP",
"rightType": [
"Ipv6NdraProfile"
]
},
{
"leftType": [
"Tier1"
],
"relationshipType": "IPV6_DAD_PROFILE_RELATIONSHIP",
"rightType": [
"Ipv6DadProfile"
]
}
]
},
"marked_for_delete": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether the intent object is marked for deletion",
"type": "boolean"
},
"origin_site_id": {
"description": "This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for knowing which site owns an object",
"type": "string"
},
"overridden": {
"default": false,
"description": "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.",
"readonly": true,
"required": false,
"title": "Indicates whether this object is the overridden intent object",
"type": "boolean"
},
"owner_id": {
"description": "This is a UUID generated by the system for knowing who owns this object. This is used in NSX+.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for the ownership of an object",
"type": "string"
},
"parent_path": {
"description": "Path of its parent",
"readonly": true,
"required": false,
"title": "Path of its parent",
"type": "string"
},
"path": {
"description": "Absolute path of this object",
"readonly": true,
"required": false,
"title": "Absolute path of this object",
"type": "string"
},
"pool_allocation": {
"default": "ROUTING",
"description": "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.",
"enum": [
"ROUTING",
"LB_SMALL",
"LB_MEDIUM",
"LB_LARGE",
"LB_XLARGE"
],
"required": false,
"title": "Edge node allocation size",
"type": "string"
},
"qos_profile": {
"$ref": "GatewayQosProfileConfig,
"description": "QoS Profile configuration for Tier1 router link connected to Tier0 gateway.",
"required": false,
"title": "Gateway QoS Profile configuration"
},
"realization_id": {
"description": "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.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system for realizing intent",
"type": "string"
},
"relative_path": {
"description": "Path relative from its parent",
"readonly": true,
"required": false,
"title": "Relative path of this object",
"type": "string"
},
"remote_path": {
"description": "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.",
"readonly": true,
"required": false,
"title": "Path of the object on the remote end.",
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"route_advertisement_rules": {
"items": {
"$ref": "RouteAdvertisementRule
},
"required": false,
"title": "Route advertisement rules and filtering",
"type": "array"
},
"route_advertisement_types": {
"description": "Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.",
"items": {
"$ref": "Tier1RouteAdvertisentTypes
},
"required": false,
"title": "Enable different types of route advertisements",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"tier0_path": {
"description": "The reference to the Tier-0 instance using the policy path of the Tier-0 or label of type Provider. Specify the Tier-1 connectivity to Tier-0 instance. .",
"required": false,
"title": "Tier-1 connectivity to Tier-0",
"type": "string",
"x-vmw-cross-reference": [
{
"leftType": [
"Tier1"
],
"relationshipType": "PROVIDER_NETWORK_RELATIONSHIP",
"rightType": [
"Tier0"
]
},
{
"leftType": [
"Tier1"
],
"relationshipType": "NETWORK_PROVIDER_LABEL_RELATIONSHIP",
"rightType": [
"Label"
]
}
]
},
"type": {
"description": "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.",
"enum": [
"ROUTED",
"ISOLATED",
"NATTED"
],
"required": false,
"title": "Tier1 type",
"type": "string"
},
"unique_id": {
"description": "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.",
"readonly": true,
"required": false,
"title": "A unique identifier assigned by the system",
"type": "string"
}
},
"title": "Tier-1",
"type": "object"
}