LocaleServices

Site specific configuration of Tier0 in multi-site scenario

Properties

Required	Property Name	Type	Description
optional	_create_time	integer	Timestamp of resource creation
optional	_create_user	string	ID of the user who created this resource
optional	_last_modified_time	integer	Timestamp of last modification
optional	_last_modified_user	string	ID of the user who last modified this resource
optional	_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
optional	_protection	string	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.
optional	_revision	integer	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.
optional	_schema	string	Schema for this resource
optional	_self	SelfResourceLink	Link to this resource
optional	_system_owned	boolean	Indicates system owned resource
optional	children	array of ChildPolicyConfigResource	subtree for this type within policy tree containing nested elements.
optional	description	string	Description of this resource
optional	display_name	string	Defaults to ID if not set
optional	edge_cluster_path	string	Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster.
optional	ha_vip_configs	array of Tier0HaVipConfig	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.
optional	id	string	Unique identifier of this resource
optional	marked_for_delete	boolean	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.
optional	parent_path	string	Path of its parent
optional	path	string	Absolute path of this object
optional	preferred_edge_paths	array of string	Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE, not applicable otherwise.
optional	relative_path	string	Path relative from its parent
optional	resource_type	string	The type of this resource.
optional	route_redistribution_types	array of string	Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0.
optional	tags	array of Tag	Opaque identifiers meaningful to the API user

Property of

ChildLocaleServices
LocaleServicesListResult

Parameter To

Update Locale Services
Create Locale Services
Update Locale Services
Create Locale Services

Returned By

Get Locale Services
Create Locale Services
Create Locale Services
Get Locale Services

Extends

PolicyConfigResource

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "edge_cluster_path": "string",
    "ha_vip_configs": [
        {
            "enabled": false,
            "external_interface_paths": [
                "string"
            ],
            "vip_subnets": [
                {
                    "ip_addresses": [
                        "string"
                    ],
                    "prefix_len": 0
                }
            ]
        }
    ],
    "id": "string",
    "marked_for_delete": false,
    "parent_path": "string",
    "path": "string",
    "preferred_edge_paths": [
        "string"
    ],
    "relative_path": "string",
    "resource_type": "string",
    "route_redistribution_types": [
        "string"
    ],
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}