L2VpnService (schema)

L2VPN Service

Defines if service running as server or client Also defines all the common properties for the multiple L2VpnSessions associated with this service.
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
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_full_mesh Enable full mesh topology

Full mesh topology auto disables traffic replication between connected
peers. However, this property is deprecated. Please refer enable_hub
property instead to control client to client forwarding via the server.
The value of enable_full_mesh will not be used anymore. If enable_hub
is not provided explicitly, the default value of it will be used.
boolean Deprecated
Default: "False"
enable_hub Enable client to client forwarding via server

This property only applies in SERVER mode. If set to true,
traffic from any client will be replicated to all other clients.
If set to false, traffic received from clients is only replicated
to the local VPN endpoint.
boolean Default: "False"
id Unique identifier of this resource string Sortable
logical_router_id Logical router id

Logical router id
string Required
logical_tap_ip_pool IP Pool for Logical Taps

IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap.
array of IPv4CIDRBlock
mode L2VPN Service Mode

Specify an L2VPN service mode as SERVER or CLIENT. L2VPN service
in SERVER mode requires user to configure L2VPN session explicitly.
L2VPN service in CLIENT mode can use peercode generated from SERVER
to configure L2VPN session.
string Enum: SERVER, CLIENT
Default: "SERVER"
resource_type Must be set to the value L2VpnService string
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30