LocaleServices (schema)

Locale-services configuration

Site specific configuration of Tier0 in multi-site scenario
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
bfd_profile_path Policy path of BFD profile

This profile is applied to all static route peers in this locale. BFD
profile configured on static route peers takes precedence over global
configuration. If this field is empty, a default profile is applied to
all peers.
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)
description Description of this resource string Maximum length: 1024
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
edge_cluster_path Edge cluster path

Policy path to edge cluster. Auto-assigned on Tier0 if associated
enforcement-point has only one edge cluster.
ha_vip_configs Array of HA VIP Config.

This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed.
array of Tier0HaVipConfig
id Unique identifier of this resource string Sortable
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
preferred_edge_paths Edge node path

Policy paths to edge nodes. For Tier1 gateway, the field is used to
statically assign the ordered list of up to two edge nodes for
stateful services. To enable auto allocation of nodes from the
specified edge cluster the field must be left unset. The auto
allocation of nodes is supported only for the Tier1 gateway. For
Tier0 gateway specified edge is used as a preferred edge node
when failover mode is set to PREEMPTIVE, not applicable otherwise.
array of string Maximum items: 2
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value LocaleServices string
route_redistribution_config Route Redistribution configuration

Configure all route redistribution properties like enable/disable redistributon, redistribution rule and so on.
route_redistribution_types Enable redistribution of different types of routes on Tier-0

Enable redistribution of different types of routes on Tier-0.
This property is only valid for locale-service under Tier-0.
This property is deprecated, please use "route_redistribution_config"
property to configure redistribution rules.
array of Tier0RouteRedistributionTypes Deprecated
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
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