edit_lab_node
Edit an existing lab node's properties like name, icon, RAM, CPU, and more. Automatically stops the node if needed, and prevents accidental duplicate names.
Instructions
Edit an existing node by id. Only supplied fields are changed.
Covers every node field EVE-NG's own "Edit Node" dialog
exposes (see get_node_template's options for the full
reference) -- name, icon, image, ram/cpu/cpulimit/ethernet,
console/config, canvas position, delay, the QEMU-specific
fields, disable_offload, sat, eth_format/eth_name, and
rdp_user/rdp_password (for rdp/rdp-tls console nodes).
Deliberately excludes uuid -- an identity field EVE-NG assigns
itself, not something meant to be user-edited.
Targets exactly one node -- for ram/cpu/ethernet/icon/image across every node sharing a template at once, see edit_lab_nodes_by_template. For delay specifically with bulk ordering/incrementing across many nodes, see change_node_delay.
EVE-NG requires a node to be stopped to edit it, on both PRO and Community (unlike connect_interface's wiring, which PRO allows on running nodes). This checks the node's current status first and stops it automatically if needed, before applying the edit -- you don't have to stop it yourself first.
If name is being changed and another node already has that
exact name (case-insensitive), this does NOT rename it --
EVE-NG allows duplicate node names, but silently creating one
seems worth avoiding by default. It returns status
"confirmation_required" naming the conflicting node; call
again with either a different name, or the same name plus
confirm_duplicate_name=true to use it anyway.
Args:
lab_path: Full path to the .unl lab file.
node_id: Id of the node to edit (see list_lab_nodes).
name: New name, if changing.
icon: New icon filename, if changing.
image: New image filename, if changing -- must be one of
the template's own valid images (see get_node_template).
ram: New RAM in MB, if changing.
cpu: New vCPU count, if changing.
cpulimit: New CPU limit toggle (0/1), if changing.
ethernet: New ethernet interface count, if changing.
console: New console type ("telnet"/"vnc"/"rdp"/"rdp-tls"), if changing.
config: New config state ("Unconfigured"/"Saved"), if changing.
left: New canvas position from the left, if changing.
top: New canvas position from the top, if changing.
delay: New startup delay in seconds, if changing.
disable_offload: New disable-offload toggle (0/1), if changing.
sat: New satellite setting, if changing.
eth_format: New interface name format string, if changing.
eth_name: New explicit interface names list, if changing.
firstmac: New first interface MAC address, if changing.
qemu_version: New QEMU version, if changing.
qemu_arch: New QEMU architecture, if changing.
qemu_nic: New QEMU NIC model, if changing.
qemu_options: New custom QEMU options string, if changing.
rdp_user: New RDP username (rdp/rdp-tls console nodes), if changing.
rdp_password: New RDP password (rdp/rdp-tls console nodes), if changing.
confirm_duplicate_name: Set true to use name even if
another node already has it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cpu | No | ||
| ram | No | ||
| sat | No | ||
| top | No | ||
| icon | No | ||
| left | No | ||
| name | No | ||
| delay | No | ||
| image | No | ||
| config | No | ||
| console | No | ||
| node_id | Yes | ||
| cpulimit | No | ||
| eth_name | No | ||
| ethernet | No | ||
| firstmac | No | ||
| lab_path | Yes | ||
| qemu_nic | No | ||
| rdp_user | No | ||
| qemu_arch | No | ||
| eth_format | No | ||
| qemu_options | No | ||
| qemu_version | No | ||
| rdp_password | No | ||
| disable_offload | No | ||
| confirm_duplicate_name | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||