InlineNsxSegment1

InlineNsxSegment1
InlineNsxSegment1
JSON Example
{
    "address_bindings": [
        {
            "ip_address": "string",
            "mac_address": "string",
            "vlan_id": 0
        }
    ],
    "admin_state": "string",
    "advanced_config": {
        "address_pool_paths": [
            "string"
        ],
        "hybrid": false,
        "inter_router": false,
        "local_egress": false,
        "local_egress_routing_policies": [
            {
                "nexthop_address": "string",
                "prefix_list_paths": [
                    "string"
                ]
            }
        ],
        "multicast": false,
        "ndra_profile_path": "string",
        "node_local_switch": false,
        "origin_id": "string",
        "origin_type": "string",
        "uplink_teaming_policy_name": "string",
        "urpf_mode": "string"
    },
    "bridge_profiles": [
        {
            "bridge_profile_path": "string",
            "uplink_teaming_policy_name": "string",
            "vlan_ids": [
                "string"
            ],
            "vlan_transport_zone_path": "string"
        }
    ],
    "connectivity_path": "string",
    "dhcp_config_path": "string",
    "domain_name": "string",
    "evpn_segment": false,
    "evpn_tenant_config_path": "string",
    "extra_configs": [
        {
            "config_pair": {
                "key": "string",
                "value": "string"
            }
        }
    ],
    "federation_config": {
        "global_overlay_id": 0
    },
    "l2_extension": {
        "l2vpn_path": "string",
        "l2vpn_paths": [
            "string"
        ],
        "local_egress": {
            "optimized_ips": [
                "string"
            ]
        },
        "tunnel_id": 0
    },
    "ls_id": "string",
    "mac_pool_id": "string",
    "metadata_proxy_paths": [
        "string"
    ],
    "overlay_id": 0,
    "replication_mode": "string",
    "subnets": [
        {
            "dhcp_config": {
                "dns_servers": [
                    "string"
                ],
                "lease_time": 0,
                "resource_type": "string",
                "server_address": "string"
            },
            "dhcp_ranges": [
                "string"
            ],
            "gateway_address": "string",
            "network": "string"
        }
    ],
    "transport_zone_path": "string",
    "type": "string",
    "vlan_ids": [
        "string"
    ]
}
address_bindings
Optional
Constraints: maxItems: 512

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.

string
admin_state
Optional
Constraints: default: UP

Admin state represents desired state of segment. It does not reflect the state of other logical entities connected/attached to the segment.

Enumeration: UP, DOWN
advanced_config
Optional

Advanced configuration for Segment

bridge_profiles
Optional

Multiple distinct L2 bridge profiles can be configured.

string
connectivity_path
Optional

Policy path to the connecting Tier-0 or Tier-1. Valid only for segments created under Infra. This field can only be used for overlay segments. VLAN backed segments cannot have connectivity path set.

string
dhcp_config_path
Optional

Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.

string
domain_name
Optional

DNS domain name

boolean
evpn_segment
Read-Only  

Flag to indicate if the Segment is a Child-Segment of type EVPN.

string
evpn_tenant_config_path
Optional

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.

extra_configs
Optional

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.

federation_config
Optional

Additional configuration required for federation.

l2_extension
Optional

Segment specific L2 VPN configuration

string
ls_id
Optional

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
mac_pool_id
Optional

Mac pool id that associated with a Segment.

array of string
metadata_proxy_paths
Optional

Policy path to metadata proxy configuration. Multiple distinct MD proxies can be configured.

integer As int32 As int32
overlay_id
Optional
Constraints: minimum: 0 maximum: 2147483647

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.

string
replication_mode
Optional
Constraints: default: MTEP

If this field is not set for overlay segment, then the default of MTEP will be used.

Enumeration: MTEP, SOURCE
subnets
Optional

Subnet configuration. Max 1 subnet

string
transport_zone_path
Optional

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
Read-Only  

Segment type based on configuration.

Enumeration: ROUTED, EXTENDED, ROUTED_AND_EXTENDED, DISCONNECTED
array of string
vlan_ids
Optional

VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with '-' in between.

Used By