Back to top

Virtual Networks

Virtual Network Management

Assign a port to virtual network
/ports/{id}/assign

Assign a port for a hardware to virtual network.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    string  (required) in query

    Virtual Network ID

  • Response  200   ok
  • {
    	"id": "string",
    	"type": "string",
    	"name": "string",
    	"data": "object",
    	"hardware": {
    		"href": "string"
    	},
    	"connected_port": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Unassign a port
/ports/{id}/unassign

Unassign a port for a hardware.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    string  (required) in query

    Virtual Network ID

  • Response  200   ok
  • {
    	"id": "string",
    	"type": "string",
    	"name": "string",
    	"data": "object",
    	"hardware": {
    		"href": "string"
    	},
    	"connected_port": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Disabling bonding
/ports/{id}/disbond

Disabling bonding for one or all ports

  • Parameters
  • id
    string  (required) in path

    Port UUID

    bulk_disable
    boolean in query

    disable both ports

  • Response  200   ok
  • {
    	"id": "string",
    	"type": "string",
    	"name": "string",
    	"data": "object",
    	"hardware": {
    		"href": "string"
    	},
    	"connected_port": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Enabling bonding
/ports/{id}/bond

Enabling bonding for one or all ports

  • Parameters
  • id
    string  (required) in path

    Port UUID

    bulk_enable
    boolean in query

    enable both ports

  • Response  200   ok
  • {
    	"id": "string",
    	"type": "string",
    	"name": "string",
    	"data": "object",
    	"hardware": {
    		"href": "string"
    	},
    	"connected_port": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve all virtual networks
GET
/projects/{id}/virtual-networks

Provides a list of virtual networks for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"virtual_networks": [
    		{
    			"id": "string",
    			"description": "string",
    			"vxlan": "integer",
    			"facility": {
    				"href": "string"
    			},
    			"assigned_to": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create an virtual network
/projects/{id}/virtual-networks

Creates an virtual network.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    virtual_network
     (required) in body

    Virtual Network to create

    {
    	"project_id": "string",
    	"description": "string",
    	"facility": "string",
    	"vxlan": "integer",
    	"vlan": "integer"
    }
  • Response  201   created
  • {
    	"id": "string",
    	"description": "string",
    	"vxlan": "integer",
    	"facility": {
    		"href": "string"
    	},
    	"assigned_to": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete a virtual network
/virtual-networks/{id}

Deletes a virtual network.

  • Parameters
  • id
    string  (required) in path

    Virtual Network UUID

  • Response  200   ok
  • {
    	"id": "string",
    	"description": "string",
    	"vxlan": "integer",
    	"facility": {
    		"href": "string"
    	},
    	"assigned_to": {
    		"href": "string"
    	},
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity