api.mon.vm

/mon/vm/(hostname_or_uuid)/monitoring

api.mon.vm.views.mon_vm_define(*args, **kwargs)

Show (GET) or update (PUT) a VM’s monitoring interface definition.

Note

A VM’s monitoring interface is automatically created for every monitored VM.

GET /mon/vm/(hostname_or_uuid)/monitoring
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname_or_uuid (string) – required - Server hostname or uuid
  • data.active (boolean) – Display currently active VM monitoring definition in the monitoring system (default: false)
Status Codes:
PUT /mon/vm/(hostname_or_uuid)/monitoring

Note

Please use PUT /vm/(hostname_or_uuid) to update the monitoring interface definition of an already deployed VM after changing any of the VM’s monitoring interface attributes.

Note

By setting the value of port, dns, useip and/or proxy parameter(s) to null, the parameter(s) will be set to a default value.

DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname_or_uuid (string) – required - Server hostname or uuid
  • data.ip (string) – IPv4 address used for monitoring (automatically updated by vm_define_nic())
  • data.port (integer) – Port number used for monitoring (default: 10050)
  • data.dns (string) – Server hostname (FQDN) used for monitoring connections when useip is false or ip is not set (default: hostname)
  • data.useip (boolean) – Whether the monitoring connection should be made via the IP address (default: true)
  • data.proxy (string) – Name or ID of the monitoring proxy that is used to monitor the host (default: ‘’ => disabled)
  • data.hostgroups (array) – Custom VM monitoring hostgroups; same as monitoring_hostgroups in vm_define() (default: [])
  • data.templates (array) – Custom VM monitoring templates; same as monitoring_templates in vm_define() (default: [])
Status Codes:

/mon/vm/(hostname_or_uuid)/sla/(yyyymm)

api.mon.vm.views.mon_vm_sla(*args, **kwargs)

Get (GET) SLA for requested server and month.

GET /mon/vm/(hostname_or_uuid)/sla/(yyyymm)
DC-bound?:
Permissions:
Asynchronous?:
  • ✓ - SLA value is retrieved from monitoring server
  • ✗ - SLA value is cached
Parameters:
  • hostname_or_uuid (string) – required - Server hostname or uuid
  • yyyymm (integer) – required - Time period in YYYYMM format
Status Codes:

/mon/vm/(hostname_or_uuid)/history/(graph)

api.mon.vm.views.mon_vm_history(*args, **kwargs)

Get (GET) monitoring history for requested server and graph name.

GET /mon/vm/(hostname_or_uuid)/history/(graph)
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • hostname_or_uuid (string) – required - Server hostname or uuid
  • graph (string) – required - Graph identificator. One of:
cpu-usage - Total compute node CPU consumed by the VM.
cpu-waittime - Total amount of time spent in CPU run queue by the VM.
cpu-load - 1-minute load average.
mem-usage - Total compute node physical memory consumed by the VM.
swap-usage - Total compute node swap space used by the VM.
net-bandwidth - The amount of received and sent network traffic through the virtual network interface. requires data.nic_id
net-packets - The amount of received and sent packets through the virtual network interface. requires data.nic_id
disk-throughput (KVM only) - The amount of written and read data on the virtual hard drive. requires data.disk_id
disk-io (KVM only) - The amount of write and read I/O operations performed on the virtual hard drive. requires data.disk_id
fs-throughput (SunOS and Linux Zone only) - The amount of written and read data on the virtual hard drive. requires data.disk_id
fs-io (SunOS and Linux Zone only) - The amount of write and read I/O operations performed on the virtual hard drive. requires data.disk_id
vm-disk-logical-throughput - Aggregated disk throughput on the logical layer (with acceleration mechanisms included).
vm-disk-logical-io - Aggregated amount or read and write I/O operations on the logical layer (with acceleration mechanisms included).
vm-disk-physical-throughput - Aggregated disk throughput on the physical (disk) layer.
vm-disk-physical-io - Aggregated amount of read and write I/O operations on the physical (disk) layer.
vm-disk-io-operations - Aggregated amount of disk I/O operations by latency on the logical layer (with acceleration mechanisms included).
Parameters:
  • data.since (integer) – Return only values that have been received after the given timestamp (default: now - 1 hour)
  • data.until (integer) – Return only values that have been received before the given timestamp (default: now)
  • data.disk_id (integer) – used only with disk-throughput, disk-io, fs-throughput, fs-io graphs to specify ID of the disk for which graph should be retrieved.
  • data.nic_id (integer) – only used with net-bandwidth, net-packets graphs to specify ID of the NIC for which graph should be retrieved.
Status Codes: