EdgeCluster (schema)

Name Description Type Notes
_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
allocation_rules Allocation rules for auto placement

Set of allocation rules and respected action for auto placement of
logical router, DHCP and MDProxy on edge cluster members.
array of AllocationRule
cluster_profile_bindings Edge cluster profile bindings array of ClusterProfileTypeIdEntry
deployment_type Edge cluster deployment type

This field is a readonly field which shows the deployment_type of members.
It returns UNKNOWN if there are no members, and returns VIRTUAL_MACHINE|
PHYSICAL_MACHINE if all edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
It returns HYBRID if the cluster contains edge members of both types
VIRTUAL_MACHINE and PHYSICAL_MACHINE.
EdgeDeploymentType Readonly
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
enable_inter_site_forwarding Flag to enable inter site forwarding

Flag should be only use in federation for inter site l2 and l3 forwarding.
Before enabling this flag, all the edge cluster members must have remote
tunnel endpoint configured. TIER0/TIER1 logical routers managed by GM
must be associated with edge cluster which has inter-site forwarding
enabled.
boolean Readonly
id Unique identifier of this resource string Sortable
member_node_type Node type of the cluster members

Edge cluster is homogenous collection of transport nodes.
Hence all transport nodes of the cluster must be of same type.
This readonly field shows the type of transport nodes.
EdgeClusterNodeType Readonly
members Edge cluster members

EdgeCluster only supports homogeneous members.
These member should be backed by either EdgeNode or PublicCloudGatewayNode.
TransportNode type of these nodes should be the same.
DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is
recommended to be the same. EdgeCluster supports members of different
deployment types.
array of EdgeClusterMember
node_rtep_ips Remote tunnel endpoint ip address.

List of remote tunnel endpoint ipaddress configured on edge cluster for each transport node.
array of NodeRtepIpsConfig Readonly
resource_type Must be set to the value EdgeCluster string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30