gns3-server/docs/api/vpcsvpcsidnio.rst

/vpcs/{vpcs_id}/nio

POST /vpcs/{vpcs_id}/nio

ADD NIO to a VPCS

Parameters

• vpcs_id: Id of VPCS instance

Response status codes

• 201: Success of creation of NIO
• 409: Conflict

Input

Types

Ethernet

Generic Ethernet Network Input/Output

Name	Mandatory	Type	Description
ethernet_device	✔	string	Ethernet device name e.g. eth0
type	✔	enum	Possible values: nio_generic_ethernet

LinuxEthernet

Linux Ethernet Network Input/Output

Name	Mandatory	Type	Description
ethernet_device	✔	string	Ethernet device name e.g. eth0
type	✔	enum	Possible values: nio_linux_ethernet

NULL

NULL Network Input/Output

Name	Mandatory	Type	Description
type	✔	enum	Possible values: nio_null

TAP

TAP Network Input/Output

Name	Mandatory	Type	Description
tap_device	✔	string	TAP device name e.g. tap0
type	✔	enum	Possible values: nio_tap

UDP

UDP Network Input/Output

Name	Mandatory	Type	Description
lport	✔	integer	Local port
rhost	✔	string	Remote host
rport	✔	integer	Remote port
type	✔	enum	Possible values: nio_udp

UNIX

UNIX Network Input/Output

Name	Mandatory	Type	Description
local_file	✔	string	path to the UNIX socket file (local)
remote_file	✔	string	path to the UNIX socket file (remote)
type	✔	enum	Possible values: nio_unix

VDE

VDE Network Input/Output

Name	Mandatory	Type	Description
control_file	✔	string	path to the VDE control file
local_file	✔	string	path to the VDE control file
type	✔	enum	Possible values: nio_vde

Body

Name	Mandatory	Type	Description
id	✔	integer	VPCS device instance ID
nio	✔	UDP, Ethernet, LinuxEthernet, TAP, UNIX, VDE, NULL	Network Input/Output
port	✔	integer	Port number
port_id	✔	integer	Unique port identifier for the VPCS instance

Sample session

examples/post_vpcsvpcsidnio.txt