Back to top

Ports

Port 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