NSX-T Data Center REST API

ExtendDvpgWorkflowSpec (type)

{
  "additionalProperties": false, 
  "description": "Extend DVPG workflow spec.", 
  "extends": {
    "$ref": "WorkflowSpec
  }, 
  "id": "ExtendDvpgWorkflowSpec", 
  "module_id": "OverlayAdoption", 
  "polymorphic-type-descriptor": {
    "type-identifier": "ExtendDvpgWorkflowSpec"
  }, 
  "properties": {
    "bridge_profile_path": {
      "description": "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.", 
      "readonly": false, 
      "required": false, 
      "title": "Policy path to L2 Bridge profile", 
      "type": "string"
    }, 
    "bridging_mode": {
      "$ref": "BridgingMode, 
      "default": "EDGE_BRIDGE", 
      "description": "Bridging mode.", 
      "readonly": false, 
      "required": false, 
      "title": "Bridging mode"
    }, 
    "dhcpv4_server_ips": {
      "description": "IPs of DHCPv4 servers used by VMs connected to the DVPG in the subnet.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of DHCPv4 server IP addresses", 
      "type": "array"
    }, 
    "dhcpv6_server_ips": {
      "description": "IPs of DHCPv6 servers used by VMs connected to the DVPG in the subnet.", 
      "items": {
        "type": "string"
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of DHCPv6 server IP addresses", 
      "type": "array"
    }, 
    "dvpg_id": {
      "description": "DVPG ID.", 
      "readonly": false, 
      "required": true, 
      "title": "DVPG ID", 
      "type": "string"
    }, 
    "ip_subnets": {
      "$ref": "SegmentIpSubnets, 
      "description": "A SegmentIpSubnets for the overlay segment to which the DVPG will be bridged.", 
      "readonly": false, 
      "required": true, 
      "title": "A SegmentIpSubnets for the overlay segment to which the DVPG will be bridged"
    }, 
    "overlay_transport_zone_path": {
      "description": "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.", 
      "readonly": false, 
      "required": false, 
      "title": "Overlay transport zone path", 
      "type": "string"
    }, 
    "project_id": {
      "description": "Project ID.", 
      "readonly": false, 
      "required": false, 
      "title": "Project ID", 
      "type": "string"
    }, 
    "segment_name_for_auto_creation": {
      "description": "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.", 
      "readonly": false, 
      "required": false, 
      "title": "Segment name for auto creation", 
      "type": "string"
    }, 
    "segment_path": {
      "description": "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.", 
      "readonly": false, 
      "required": false, 
      "title": "Existing segment path to bridge DVPG", 
      "type": "string"
    }, 
    "type": {
      "$ref": "WorkflowSpecType, 
      "description": "Workflow spec type.", 
      "readonly": false, 
      "required": true, 
      "title": "Workflow spec type"
    }, 
    "uplink_teaming_policy_name": {
      "description": "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\".", 
      "readonly": false, 
      "required": false, 
      "title": "Uplink teaming policy name", 
      "type": "string"
    }, 
    "vlan_transport_zone_path": {
      "description": "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).", 
      "readonly": false, 
      "required": false, 
      "title": "VLAN transport zone path", 
      "type": "string"
    }
  }, 
  "title": "Extend DVPG workflow spec", 
  "type": "object"
}