gns3-server/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst
Julien Duponchelle 3deb555981
Update the doc for GNS3 2.0
Fix #495
2016-06-08 18:12:22 +02:00

25 KiB

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

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

Get a Dynamips VM 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
auto_delete_disks boolean Automatically delete nvram and disk files
aux ['integer', 'null'] Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
node_directory string
node_id string Node UUID
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string Path to the IOS private configuration file
private_config_base64 string Private configuration base64 encoded
project_id string Project UUID
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file
startup_config_base64 string Startup configuration base64 encoded
status enum Possible values: started, stopped, suspended
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0

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

Update a Dynamips VM 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

Name Mandatory Type Description
auto_delete_disks boolean Automatically delete nvram and disk files
aux integer Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer Dynamips ID
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string Path to the IOS private configuration file.
private_config_base64 string Private configuration base64 encoded
private_config_content string Content of IOS private configuration file
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file.
startup_config_base64 string Startup configuration base64 encoded
startup_config_content string Content of IOS startup configuration file
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0

Output

Name Mandatory Type Description
auto_delete_disks boolean Automatically delete nvram and disk files
aux ['integer', 'null'] Auxiliary console TCP port
chassis string Cisco router chassis model
clock_divisor integer Clock divisor
console integer Console TCP port
console_type enum Possible values: telnet
disk0 integer Disk0 size in MB
disk1 integer Disk1 size in MB
dynamips_id integer ID to use with Dynamips
exec_area integer Exec area value
idlemax integer Idlemax value
idlepc string Idle-PC value
idlesleep integer Idlesleep value
image string Path to the IOS image
image_md5sum ['string', 'null'] Checksum of the IOS image
iomem integer I/O memory percentage
mac_addr string Base MAC address
midplane enum Possible values: std, vxr
mmap boolean MMAP feature
name string Dynamips VM instance name
node_directory string
node_id string Node UUID
npe enum Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2
nvram integer Amount of NVRAM in KB
platform string Cisco router platform
power_supplies array Power supplies status
private_config string Path to the IOS private configuration file
private_config_base64 string Private configuration base64 encoded
project_id string Project UUID
ram integer Amount of RAM in MB
sensors array Temperature sensors
slot0 Network module slot 0
slot1 Network module slot 1
slot2 Network module slot 2
slot3 Network module slot 3
slot4 Network module slot 4
slot5 Network module slot 5
slot6 Network module slot 6
sparsemem boolean Sparse memory feature
startup_config string Path to the IOS startup configuration file
startup_config_base64 string Startup configuration base64 encoded
status enum Possible values: started, stopped, suspended
system_id string System ID
wic0 Network module WIC slot 0
wic1 Network module WIC slot 0
wic2 Network module WIC slot 0

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

Delete a Dynamips VM instance

Parameters

  • project_id: Project UUID
  • node_id: Node UUID

Response status codes

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