api.node.vm

/node/(hostname)/vm

api.node.vm.views.node_vm_list(*args, **kwargs)

List (GET) VMs existing on a specific compute node (hostname).

GET /node/(hostname)/vm
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname (string) – required - Node hostname
  • data.full (boolean) – Return list of objects with some VM details (default: false)
  • data.extended (boolean) – Return list of objects with extended VM details (default: false)
  • data.order_by (string) – Available fields for sorting: hostname (default: hostname)
Status Codes:

/node/(hostname)/vm-harvest

api.node.vm.views.harvest_vm(*args, **kwargs)

Fetch server metadata from compute node and create server(s) in the DB (POST).

POST /node/(hostname)/vm-harvest
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname (string) – required - Node hostname
  • data.vm (string) – Optional server uuid. Fetch all servers defined on the compute node if not provided
Status Codes: