| _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 |
| address_bindings |
Address bindings for the Segment
Static address binding used for the Segment. This field is deprecated and will be removed in a future release. Please use address_bindings in SegmentPort to configure static bindings. |
array of PortAddressBindingEntry |
Deprecated
Maximum items: 512 |
| admin_state |
Represents Desired state of the Segment |
string |
Enum: UP, DOWN
Default: "UP" |
| advanced_config |
Advanced configuration for Segment
Advanced configuration for Segment.
|
SegmentAdvancedConfig |
|
| bridge_profiles |
Bridge Profile Configuration
Multiple distinct L2 bridge profiles can be configured. |
array of BridgeProfileConfig |
|
| 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)
ChildDhcpStaticBindingConfig
ChildSegmentDiscoveryProfileBindingMap
ChildSegmentMonitoringProfileBindingMap
ChildSegmentPort
ChildSegmentQoSProfileBindingMap
ChildSegmentSecurityProfileBindingMap
ChildStaticARPConfig |
|
| connectivity_path |
Policy path to the connecting Tier-0 or Tier-1
Policy path to the connecting Tier-0 or Tier-1. Valid only for
segments created under Infra.
|
string |
|
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| dhcp_config_path |
Policy path to DHCP configuration
Policy path to DHCP server or relay configuration to use for all
IPv4 & IPv6 subnets configured on this segment.
|
string |
|
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| domain_name |
DNS domain name |
string |
|
| evpn_segment |
Evpn Segment Flag.
Flag to indicate if the Segment is a Child-Segment of type EVPN. |
boolean |
Readonly |
| evpn_tenant_config_path |
Policy path to the EvpnTenantConfig
Policy path to the EvpnTenantConfig resource. Supported only for Route-Server Evpn Mode.
Supported only for Overlay Segments. This will be populated for both Parent and Child segments
participating in Evpn Route-Server Mode.
|
string |
|
| extra_configs |
Extra configs on Segment
This property could be used for vendor specific configuration in key value
string pairs, the setting in extra_configs will be automatically inheritted
by segment ports in the Segment.
|
array of SegmentExtraConfig |
|
| federation_config |
Federation releated config
Additional config for federation. |
FederationConnectivityConfig |
Readonly |
| id |
Unique identifier of this resource |
string |
Sortable |
| l2_extension |
Configuration for extending Segment through L2 VPN |
L2Extension |
|
| ls_id |
Pre-created logical switch id for Segment
This property is deprecated. The property will continue to work as
expected for existing segments. The segments that are newly created
with ls_id will be ignored.
Sepcify pre-creted logical switch id for Segment.
|
string |
Deprecated |
| mac_pool_id |
Allocation mac pool associated with the Segment
Mac pool id that associated with a Segment. |
string |
|
| 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" |
| metadata_proxy_paths |
Metadata Proxy Configuration Paths
Policy path to metadata proxy configuration. Multiple distinct MD proxies can be configured. |
array of string |
|
| overlay_id |
Overlay connectivity ID for this Segment
Used for overlay connectivity of segments. The overlay_id
should be allocated from the pool as definied by enforcement-point.
If not provided, it is auto-allocated from the default pool on the
enforcement-point.
|
int |
Minimum: 0
Maximum: 2147483647 |
| 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 |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| replication_mode |
Replication mode of the Segment
If this field is not set for overlay segment, then the default of MTEP
will be used.
|
string |
Enum: MTEP, SOURCE
Default: "MTEP" |
| resource_type |
Must be set to the value Segment |
string |
|
| subnets |
Subnet configuration. Max 1 subnet |
array of SegmentSubnet |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| transport_zone_path |
Policy path to the transport zone
Policy path to the transport zone. Supported for VLAN backed segments
as well as Overlay Segments.
- This field is required for VLAN backed Segments.
- For overlay Segments, it is auto assigned if only one transport zone
exists in the enforcement point. Default transport zone is auto
assigned for overlay segments if none specified.
|
string |
|
| type |
Segment type
Segment type based on configuration.
|
string |
Readonly
Enum: ROUTED, EXTENDED, ROUTED_AND_EXTENDED, DISCONNECTED |
| 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 |
| vlan_ids |
VLAN ids for VLAN backed Segment
VLAN ids for a VLAN backed Segment.
Can be a VLAN id or a range of VLAN ids specified with '-' in between.
|
array of string |
|