gns3-server/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeid.rst

/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}

GET /v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}

Get an Ethernet switch instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 200: Success
• 400: Invalid request
• 404: Instance doesn't exist

Output

Name	Mandatory	Type	Description
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
name	✔	string	Ethernet switch name
node_id	✔	string	Node UUID
ports_mapping		array
project_id	✔	string	Project UUID
status		enum	Possible values: started, stopped, suspended

PUT /v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}

Update an Ethernet switch instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 200: Instance updated
• 400: Invalid request
• 404: Instance doesn't exist
• 409: Conflict

Input

Types

EthernetSwitchPort

Ethernet switch port

Name	Mandatory	Type	Description
ethertype		enum	Possible values: null, 0x8100, 0x88A8, 0x9100, 0x9200
name	✔	string	Port name
port_number	✔	integer	Port number
type	✔	enum	Possible values: access, dot1q, qinq
vlan		integer	VLAN number

Body

Name	Mandatory	Type	Description
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
name		string	Ethernet switch name
node_id		string	Node UUID
ports_mapping		array
project_id		string	Project UUID
status		enum	Possible values: started, stopped, suspended

Output

Name	Mandatory	Type	Description
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
name	✔	string	Ethernet switch name
node_id	✔	string	Node UUID
ports_mapping		array
project_id	✔	string	Project UUID
status		enum	Possible values: started, stopped, suspended

DELETE /v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}

Delete an Ethernet switch instance

Parameters

• project_id: Project UUID
• node_id: Node UUID

Response status codes

• 204: Instance deleted
• 400: Invalid request
• 404: Instance doesn't exist