api.node.define

/node/define

api.node.define.views.node_define_list(*args, **kwargs)

List (GET) all node definitions.

GET /node/define
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • data.full (boolean) – Return list of objects with node network and storage definition details (default: false)
  • data.order_by (string) – Available fields for sorting: hostname (default: hostname)
Status Codes:

/node/(hostname)/define

api.node.define.views.node_define(*args, **kwargs)

Show (GET), update (PUT) or delete (DELETE) a node definition.

GET /node/(hostname)/define
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname (string) – required - Node hostname
Status Codes:
PUT /node/(hostname)/define
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname (string) – required - Node hostname
  • data.status (integer) – Compute node status (DB only) (1 - maintenance, 2 - online)
  • data.is_compute (boolean) – Compute capability
  • data.is_backup (boolean) – Backup capability
  • data.note (string) – Custom text information about this compute node
  • data.owner (string) – Node owner
  • data.address (string) – Node IP address used for communication between compute nodes, in particular for: VM VNC console, VM backups, VM migration, VM replication, VM snapshot restore and image creation, internal VM and compute node monitoring. WARNING: Changing this IP address may lead to unexpected behaviour.
  • data.cpu_coef (float) – Coefficient for calculating the total number of virtual CPUs
  • data.ram_coef (float) – Coefficient for calculating the maximum amount of memory available for virtual machines
  • data.monitoring_hostgroups (array) – Custom compute node monitoring hostgroups
  • data.monitoring_templates (array) – Custom compute node monitoring templates
Status Codes:
DELETE /node/(hostname)/define
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname (string) – required - Node hostname
  • data.force (boolean) – Force delete even when compute node has existing servers and backups. Use with caution! (default: false)
Status Codes: