LocaleServices

Site specific configuration of Tier0 in multi-site scenario


Properties

integer
_create_time Optional

Timestamp of resource creation


string
_create_user Optional

ID of the user who created this resource


integer
_last_modified_time Optional

Timestamp of last modification


string
_last_modified_user Optional

ID of the user who last modified this resource


array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_protection Optional

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.


integer
_revision Optional

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.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


boolean
_system_owned Optional

Indicates system owned resource


children Optional

subtree for this type within policy tree containing nested elements.


string
description Optional

Description of this resource


string
display_name Optional

Defaults to ID if not set


string
edge_cluster_path Optional

Policy path to edge cluster. Auto-assigned on Tier0 if associated enforcement-point has only one edge cluster.


array of Tier0HaVipConfig
ha_vip_configs Optional

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.


string
id Optional

Unique identifier of this resource


boolean
marked_for_delete Optional

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.


string
parent_path Optional

Path of its parent


string
path Optional

Absolute path of this object


array of string
preferred_edge_paths Optional

Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE, not applicable otherwise.


string
relative_path Optional

Path relative from its parent


string
resource_type Optional

The type of this resource.


array of string
route_redistribution_types Optional

Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0.

Possible values are: TIER0_STATICTIER0_CONNECTEDTIER0_EXTERNAL_INTERFACETIER0_SEGMENTTIER0_ROUTER_LINKTIER0_SERVICE_INTERFACETIER0_LOOPBACK_INTERFACETIER0_DNS_FORWARDER_IPTIER0_IPSEC_LOCAL_IPTIER0_NATTIER1_NATTIER1_STATICTIER1_LB_VIPTIER1_LB_SNATTIER1_DNS_FORWARDER_IPTIER1_CONNECTEDTIER1_SERVICE_INTERFACETIER1_SEGMENTTIER1_IPSEC_LOCAL_ENDPOINT


array of Tag
tags Optional

Opaque identifiers meaningful to the API user

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"
        }
    ]
}
Feedback

Was this page helpful?