NSX-T Data Center REST API

Get workflow spec

Get workflow spec.

Request:

Method:

POST

URI Path(s):

/api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/spec/search

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

WorkflowRequestParameters+

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

CollectConfigWorkflowSpec+

DisconnectBridgeWorkflowSpec+

ExtendDvpgWorkflowSpec+

ExtendDvpgWorkflowSpec (schema)

Name	Description	Type	Notes
bridge_profile_path	Policy path to L2 Bridge profile Policy path to L2 Bridge profile. Same bridge profile can be configured on different segments. Each bridge profile on a segment must be unique. It is required if bridge mode is chosen as EDGE_BRIDGE.	string
bridging_mode	Bridging mode Bridging mode.	BridgingMode	Default: "EDGE_BRIDGE"
dhcpv4_server_ips	List of DHCPv4 server IP addresses IPs of DHCPv4 servers used by VMs connected to the DVPG in the subnet.	array of string
dhcpv6_server_ips	List of DHCPv6 server IP addresses IPs of DHCPv6 servers used by VMs connected to the DVPG in the subnet.	array of string
dvpg_id	DVPG ID DVPG ID.	string	Required
ip_subnets	A SegmentIpSubnets for the overlay segment to which the DVPG will be bridged A SegmentIpSubnets for the overlay segment to which the DVPG will be bridged.	SegmentIpSubnets	Required
overlay_transport_zone_path	Overlay transport zone path The path of overlay transport zone in which the segment will be auto created. The default overlay-TZ will be used if it is not provided.	string
project_id	Project ID Project ID.	string
segment_name_for_auto_creation	Segment name for auto creation The segment name with which to auto create a segment for bridging the DVPG. Do not set this property if an existing segment will be used to bridge the DVPG. Only one of this property or the "segment_path" property must be set.	string
segment_path	Existing segment path to bridge DVPG The path of an existing segment to bridge the DVPG. Do not set this property if a new segment will be created to bridge the DVPG. Only one of this property or the "segment_name_for_auto_creation" property must be set.	string
type	Must be set to the value ExtendDvpgWorkflowSpec	WorkflowSpecType	Required
uplink_teaming_policy_name	Uplink teaming policy name The name of switching uplink teaming policy for bridge endpoint. This name corresponds to one of the switching uplink teaming policy names listed in the VLAN transport zone specified by the property "vlan_transport_zone_path".	string
vlan_transport_zone_path	VLAN transport zone path The path of VLAN transport zone that represents the underlay L2 domain in which the DVPGs will be bridged to overlay segments. An unique VLAN transport zone should be assigned to each underlay L2 domain when needed for bridging. If two VLANs in two underlay L2 domains are combined together as one L2 broadcast-domain by certain L2 extension, the two underlay L2 domains still should have two different VLAN transport zones assigned to them. If it is not given when the 'bridging_mode' is EDGE_BRIDGE, the VLAN transport zone path in the config spec of the edge node(s) in the bridge profile of 'bridge_profile_path' will be used, or an error will be thrown if a unique VLAN transport zone path cannot be found in the spec of the edge node(s).	string

MigrateGatewayWorkflowSpec+

MigrateGatewayWorkflowSpec (schema)

Name	Description	Type	Notes
advertise_subnet_to_tier0	Advertise subnet flag If this flag is true, the segment's subnets will be advertised to the Tier-0 router connected by the Tier-1 router specified by the property "tier1_path".	boolean	Default: "True"
ipv4_gateway	IPv4 gateway Gateway IPv4 address in CIDR format.	string	Format: ipv4-cidr-block
ipv6_gateway	IPv6 gateway Gateway IPv6 address in CIDR format.	string	Format: ipv6-cidr-block
ndra_profile_path	NDRA profile path Policy path of Neighbor Discovery Router Advertisement (NDRA) profile. This profile will be applied to the downlink logical router port created in the Tier-1 router specified by the property "tier1_path". If this field is empty, the NDRA profile of the Tier-1 router will be applied. This profile must match the NDRA profile in the underlay router to which the DVPG VLAN is connected.	string
segment_path	Segment path Path of the segment which will connect to a Tier-1 router as the default gateway	string	Required
tier1_path	Tier-1 router path Path of Tier-1 router to which the segment specified by property "segment_path" will connect as default gateway.	string	Required
type	Must be set to the value MigrateGatewayWorkflowSpec	WorkflowSpecType	Required

MigrateVmsWorkflowSpec+

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors: