HP BL680c XenEnterprise Management API
HP BL680c - ProLiant - G5 Manual
 |
UPC - 884420396314
View all HP BL680c manuals
Add to My Manuals
Save this manual to your list of manuals |
HP BL680c manual content summary:
- HP BL680c | XenEnterprise Management API - Page 1
XenEnterprise Management API API Revision 1.1 XenEnterprise Management API Version: API Revision 1.1 Date: 16th August 2007 Copyright c 2007 XenSource Inc, All Rights Reserved. - HP BL680c | XenEnterprise Management API - Page 2
Additional RPCs 6 1.3 Wire Protocol for Remote API Calls 7 1.3.1 Note on References vs UUIDs 8 1.3.2 Return Values/Status Codes 8 1.4 Making XML-RPC Calls 9 1.4.1 Transport Layer 9 1.4.2 Session Layer 9 1.4.3 Synchronous and Asynchronous invocation 9 1.5 Example interactive session - HP BL680c | XenEnterprise Management API - Page 3
CONTENTS CONTENTS 2.10.2 RPCs associated with class: VM metrics 99 2.11 Class: VM guest metrics 105 2.11.1 Fields for class: VM guest metrics 105 2.11.2 RPCs associated with class: VM guest metrics 105 2.12 Class: host 110 2.12.1 Fields for class: host 110 2.12.2 RPCs associated with class: - HP BL680c | XenEnterprise Management API - Page 4
270 2.31 Class: VTPM 274 2.31.1 Fields for class: VTPM 274 2.31.2 RPCs associated with class: VTPM 274 2.32 Class: console 277 2.32.1 Fields for class: console 277 2.32.2 RPCs associated with class: console 277 2.33 Class: user 282 2.33.1 Fields for class: user 282 2.33.2 RPCs associated - HP BL680c | XenEnterprise Management API - Page 5
on the server-side. Clients may obtain opaque references to these server-side objects and manually set when a new object is created, but is then Read Only for the duration of the object's life. For example, the maximum memory corresponding VM object to be updated automatically. The API reference - HP BL680c | XenEnterprise Management API - Page 6
"create" that takes as parameters all fields marked RW and ROins . The result of this RPC is that a new persistent object is created on the server-side with the specified field values. • Each class has a get by uuid(uuid) RPC that returns the object of that class that has the - HP BL680c | XenEnterprise Management API - Page 7
to remain valid after the client's session with the server has terminated. • fields named "uuid" of decimal digits (rather than using XML-RPC's built-in 32-bit i4 type). • values of enum types are RPC's Array type, so for example a value of type String Set would be transmitted like this: < - HP BL680c | XenEnterprise Management API - Page 8
and use them to lookup objects in subsequent sessions with the server. Clients may also test equality on objects by comparing UUID strings array of string values. The first element of the array is an error code; the remainder of the array are strings representing error parameters relating to that code - HP BL680c | XenEnterprise Management API - Page 9
-2e55-06b0847da503 1d401ec4-3c17-35a6-fc79-cee6bd9811fe 1.4 Making XML-RPC Calls 1.4.1 Transport Layer The following transport layers are currently supported: • HTTP/S for remote administration • HTTP over Unix domain sockets for - HP BL680c | XenEnterprise Management API - Page 10
all task IDs known to the system. The status (including any returned result and error codes) of these tasks can then be queried by accessing the fields of the server: >>> xen = xmlrpclib.Server("https://localhost:443") Acquire a session reference by logging in with a username and password (error- - HP BL680c | XenEnterprise Management API - Page 11
because the VM is a template, and so an error response has been returned. These high-level errors are returned as structured data (rather than as XML- '] >>> record['power_state'] 'Halted' >>> record['name_label'] 'XenSource P2V Server' To retrieve all the VM records in a single call: >>> records - HP BL680c | XenEnterprise Management API - Page 12
1.6. VM LIFECYCLE CHAPTER 1. INTRODUCTION powered down start(paused=true) paused start(paused=false) used; otherwise the VM will be loaded as an HVM domain, and booted using an emulated BIOS. When paravirtual booting is in use, the PV/bootloader field indicates the bootloader to use. - HP BL680c | XenEnterprise Management API - Page 13
1.7. VM BOOT PARAMETERS CHAPTER 1. INTRODUCTION Only one policy is currently defined: "BIOS order". In this case, HVM/boot params should contain one key-value pair "order" = "N" where N is the string that will be passed to QEMU. 13 - HP BL680c | XenEnterprise Management API - Page 14
metrics reported by the guest (as opposed to inferred from outside) A physical host Represents a host crash dump Represents a patch stored on a server The metrics associated with a host A physical CPU A virtual network A virtual network interface The metrics associated with a virtual network device - HP BL680c | XenEnterprise Management API - Page 15
2.2. RELATIONSHIPS BETWEEN CLASSES CHAPTER 2. API REFERENCE 2.2 Relationships Between Classes Fields that are bound together are shown in the following table: object.field PIF.bond slave of PIF.bond master of PIF.VLAN slave of host.PBDs SR.PBDs VDI.VBDs VDI.crash dumps VBD.VM crashdump.VM VIF.VM - HP BL680c | XenEnterprise Management API - Page 16
2.3. TYPES CHAPTER 2. API REFERENCE 2.2.1 List of bound fields 2.3 Types 2.3.1 Primitives The following primitive types are used to specify methods and fields in the API Reference: Type String Int Float Bool DateTime Ref (object name) Description text strings 64-bit integers IEEE double- - HP BL680c | XenEnterprise Management API - Page 17
a VIF or PIF enum host allowed operations provision Indicates this host is able to provision another VM evacuate Indicates this host is evacuating enum vm power state 17 - HP BL680c | XenEnterprise Management API - Page 18
cancel refers to the operation "cancel" enum vm operations clone copy provision start start on pause unpause clean shutdown clean reboot hard shutdown power state reset hard reboot suspend csvm resume resume on pool migrate refers to the operation "clone" refers to the operation "copy" refers to - HP BL680c | XenEnterprise Management API - Page 19
send trigger changing memory live changing shadow memory live changing VCPUs live assert operation valid update allowed operations make into crashed VM paused rename the crashed VM and start a new copy enum ip configuration mode None DHCP Static Do not acquire an IP address Acquire an IP address - HP BL680c | XenEnterprise Management API - Page 20
2.3. TYPES CHAPTER 2. API REFERENCE enum vbd mode RO only read-only access will be allowed RW read-write access will be allowed enum vbd type CD VBD will appear to guest as CD Disk VBD will appear to guest as disk 20 - HP BL680c | XenEnterprise Management API - Page 21
description Username for login. Password for login. Client API version. Return Type: session ref reference of newly created session Possible Error Codes: SESSION AUTHENTICATION FAILED RPC name: logout Overview: Log out of a session. Signature: void logout (session_id s) Return Type: void RPC - HP BL680c | XenEnterprise Management API - Page 22
2.4. CLASS: SESSION CHAPTER 2. API REFERENCE void change_password (session_id s, string old_pwd, string new_pwd) Arguments: type string string name description old pwd Old password for account new pwd New password for account Return Type: void RPC name: get uuid Overview: Get the uuid field - HP BL680c | XenEnterprise Management API - Page 23
2.4. CLASS: SESSION Arguments: type name description session ref self reference to the object Return Type: user ref value of the field CHAPTER 2. API REFERENCE RPC name: get last active Overview: Get the last active field of the given session. Signature: datetime get_last_active (session_id - HP BL680c | XenEnterprise Management API - Page 24
2.4. CLASS: SESSION Return Type: (string → string) Map value of the field CHAPTER 2. API REFERENCE RPC name: set other config Overview: Set the other config field of the given session. Signature: void set_other_config (session_id s, session ref self, (string -> string) Map value) Arguments: type - HP BL680c | XenEnterprise Management API - Page 25
2.4. CLASS: SESSION CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the session instance with the specified UUID. Signature: (session ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return Type: session - HP BL680c | XenEnterprise Management API - Page 26
reference a human-readable name a notes field containg humanreadable description list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference - HP BL680c | XenEnterprise Management API - Page 27
has failed, this field contains the set of associated error strings. Undefined otherwise. additional configuration 2.5.2 RPCs associated with class: task RPC name: create Overview: Create a new task object which must be manually destroyed. Signature: (task ref) create (session_id s, string label - HP BL680c | XenEnterprise Management API - Page 28
2.5. CLASS: TASK Possible Error Codes: OPERATION NOT ALLOWED RPC name: get all Overview: Return a list of all the tasks known to the system. Signature: ((task ref) Set) get_all (session_id s) Return - HP BL680c | XenEnterprise Management API - Page 29
2.5. CLASS: TASK Arguments: type name description task ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get name description Overview: Get the name/description field of the given task. Signature: string get_name_description (session_id s, - HP BL680c | XenEnterprise Management API - Page 30
2.5. CLASS: TASK CHAPTER 2. API REFERENCE Return Type: (string → task allowed operations) Map value of the field RPC name: get created Overview: Get the created field of the given task. Signature: datetime get_created (session_id s, task ref self) Arguments: type name description task ref self - HP BL680c | XenEnterprise Management API - Page 31
2.5. CLASS: TASK CHAPTER 2. API REFERENCE RPC name: get resident on Overview: Get the resident on field of the given task. Signature: (host ref) get_resident_on (session_id s, task ref self) Arguments: type name description task ref self reference to the object Return Type: host ref value of the fi - HP BL680c | XenEnterprise Management API - Page 32
ref self reference to the object Return Type: string value of the field RPC name: get error info Overview: Get the error info field of the given task. Signature: (string Set) get_error_info (session_id s, task ref self reference to the object Return Type: (string → string) Map value of the field 32 - HP BL680c | XenEnterprise Management API - Page 33
2.5. CLASS: TASK CHAPTER 2. API REFERENCE RPC name: set other config Overview: Set the other config field of the given task. Signature: void set_other_config (session_id s, task ref self, (string -> string) Map value) Arguments: type task ref (string → string) Map name description self reference - HP BL680c | XenEnterprise Management API - Page 34
2.5. CLASS: TASK CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the task instance with the specified UUID. Signature: (task ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return Type: task ref reference - HP BL680c | XenEnterprise Management API - Page 35
2.6. CLASS: EVENT CHAPTER 2. API REFERENCE 2.6 Class: event 2.6.1 Fields for class: event Name Description Quals RO ins RO ins RO ins RO ins RO ins RO ins event Asynchronous event registration and handling. Field Type Description id int An ID, monotonically increasing, and local to the - HP BL680c | XenEnterprise Management API - Page 36
returns a (possibly empty) batch of events. Signature: ((event record) Set) next (session_id s) Return Type: (event record) Set the batch of events Possible Error Codes: SESSION NOT REGISTERED, EVENTS LOST RPC name: get current id Overview: Return the ID of the next event to be generated by the - HP BL680c | XenEnterprise Management API - Page 37
initial authentication) The password for the master (for initial authentication) Return Type: void Possible Error Codes: JOINING HOST CANNOT CONTAIN SHARED SRS RPC name: join force Overview: Instruct host to join a new pool. Signature: void join_force (session_id s, string master_address, string - HP BL680c | XenEnterprise Management API - Page 38
master_address) Arguments: type name description string master address The hostname of the master Return Type: void RPC name: recover slaves Overview: Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M. Signature - HP BL680c | XenEnterprise Management API - Page 39
should be connected VLAN tag for the new interface Return Type: (PIF ref) Set The references of the created PIF objects Possible Error Codes: VLAN TAG INVALID RPC name: enable ha Overview: Turn on High Availability mode. Signature: void enable_ha (session_id s) Return Type: void RPC name - HP BL680c | XenEnterprise Management API - Page 40
2.7. CLASS: POOL RPC name: sync database Overview: Forcibly synchronise the database now. Signature: void sync_database (session_id s) Return Type: void CHAPTER 2. API REFERENCE RPC name: designate new master Overview: Perform an orderly handover of the role of master to the referenced host. - HP BL680c | XenEnterprise Management API - Page 41
2.7. CLASS: POOL CHAPTER 2. API REFERENCE RPC name: get uuid Overview: Get the uuid field of the given pool. Signature: string get_uuid (session_id s, pool ref self) Arguments: type name description pool ref self reference to the object Return Type: string value of the field RPC name: get name - HP BL680c | XenEnterprise Management API - Page 42
ref) get_master (session_id s, pool ref self) Arguments: type name description pool ref self reference to the object Return Type: host ref value of the field 42 - HP BL680c | XenEnterprise Management API - Page 43
2.7. CLASS: POOL CHAPTER 2. API REFERENCE RPC name: get default SR Overview: Get the default SR field of the given pool. Signature: (SR ref) get_default_SR (session_id s, pool ref self) Arguments: type name description pool ref self reference to the object Return Type: SR ref value of the field RPC - HP BL680c | XenEnterprise Management API - Page 44
2.7. CLASS: POOL CHAPTER 2. API REFERENCE RPC name: set suspend image SR Overview: Set the suspend image SR field of the given pool. Signature: void set_suspend_image_SR (session_id s, pool ref self, SR ref value) Arguments: type pool ref SR ref name description self reference to the object - HP BL680c | XenEnterprise Management API - Page 45
2.7. CLASS: POOL CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given pool. Signature: ((string -> string) Map) get_other_config (session_id s, pool ref self) Arguments: type name description pool ref self reference to the object Return Type: (string → - HP BL680c | XenEnterprise Management API - Page 46
2.7. CLASS: POOL CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field of the given pool. If the key is not in that Map, then do nothing. Signature: void remove_from_other_config (session_id s, pool ref - HP BL680c | XenEnterprise Management API - Page 47
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE 2.8 Class: pool patch 2.8.1 Fields for class: pool patch Name Description Quals RO run RO ins RO ins RO ins RO run RO run RO run RO run RO run RW pool patch Pool-wide patches. Field uuid name/label name/description version filename size pool - HP BL680c | XenEnterprise Management API - Page 48
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE RPC name: precheck Overview: Execute the precheck stage of the selected patch on a host and return its output. Signature: string precheck (session_id s, pool_patch ref self, host ref host) Arguments: type pool patch ref host ref name description - HP BL680c | XenEnterprise Management API - Page 49
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE RPC name: get all Overview: Return a list of all the pool patchs known to the system. Signature: ((pool_patch ref) Set) get_all (session_id s) Return Type: (pool patch ref) Set references to all objects RPC name: get all records Overview: Return a - HP BL680c | XenEnterprise Management API - Page 50
2.8. CLASS: POOL PATCH Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get name description Overview: Get the name/description field of the given pool patch. Signature: string get_name_description (session_id s, pool_patch ref self) Arguments: type name description - HP BL680c | XenEnterprise Management API - Page 51
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE RPC name: get pool applied Overview: Get the pool applied field of the given pool patch. Signature: bool get_pool_applied (session_id s, pool_patch ref self) Arguments: type name description pool patch ref self reference to the object Return - HP BL680c | XenEnterprise Management API - Page 52
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given pool patch. Signature: ((string -> string) Map) get_other_config (session_id s, pool_patch ref self) Arguments: type name description pool patch ref self reference to the - HP BL680c | XenEnterprise Management API - Page 53
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field of the given pool patch. If the key is not in that Map, then do nothing. Signature: void remove_from_other_config (session_id s, - HP BL680c | XenEnterprise Management API - Page 54
2.8. CLASS: POOL PATCH CHAPTER 2. API REFERENCE RPC name: get by name label Overview: Get all the pool patch instances with the given label. Signature: ((pool_patch ref) Set) get_by_name_label (session_id s, string label) Arguments: type name description string label label of object to return - HP BL680c | XenEnterprise Management API - Page 55
server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference) to a current operation enum which describes the nature of the task. Current power VM start time acts as a hard limit of the amount of memory a guest can use. New - HP BL680c | XenEnterprise Management API - Page 56
was last booted true if this is a control domain (domain 0 or a driver domain) metrics associated with this VM metrics associated with the running guest marshalled value containing VM record at time of last boot, updated dynamically to reflect the runtime state of the domain An XML - HP BL680c | XenEnterprise Management API - Page 57
Type: VM ref The reference of the newly created VM. Possible Error Codes: VM BAD POWER STATE, SR FULL, OPERATION NOT ALLOWED RPC name: copy Overview: Copied disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in - HP BL680c | XenEnterprise Management API - Page 58
checks (e.g. if the CPU the VM last booted on looks substantially different to the current one) Return Type: void Possible Error Codes: VM BAD POWER STATE, VM HVM REQUIRED, VM IS TEMPLATE, OTHER OPERATION IN PROGRESS, OPERATION NOT ALLOWED, BOOTLOADER FAILED, UNKNOWN BOOTLOADER, NO HOSTS AVAILABLE - HP BL680c | XenEnterprise Management API - Page 59
supported-e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. Signature: void clean_shutdown (session_id s, VM ref vm) Arguments: type name description VM ref vm The VM to shutdown Return Type: void Possible Error Codes: VM BAD POWER STATE - HP BL680c | XenEnterprise Management API - Page 60
: type name description VM ref vm The VM to shutdown Return Type: void Possible Error Codes: VM BAD POWER STATE, OTHER OPERATION IN PROGRESS, OPERATION NOT ALLOWED, VM IS TEMPLATE RPC name: hard shutdown Overview: Stop executing the specified VM without attempting a clean shutdown. Signature: void - HP BL680c | XenEnterprise Management API - Page 61
name: hard reboot Overview: Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM. Signature: void hard_reboot (session_id s, VM ref vm) Arguments: type name description VM ref vm The VM to reboot Return Type: void Possible Error Codes: VM BAD POWER STATE - HP BL680c | XenEnterprise Management API - Page 62
The VM to migrate The target host Extra configuration operations Return Type: void Possible Error Codes: VM BAD POWER STATE, OTHER OPERATION IN PROGRESS, VM IS TEMPLATE, OPERATION NOT ALLOWED, VM MIGRATE FAILED, VM MISSING PV DRIVERS RPC name: set VCPUs number live Overview: Set this VM's VCPUs/at - HP BL680c | XenEnterprise Management API - Page 63
string string name self key value description The VM The key The value Return Type: void RPC name: set memory target live Overview: Set the balloon driver's target on a running VM. Signature: void set_memory_target_live (session_id s, VM ref self, int target) Arguments: type VM ref int name - HP BL680c | XenEnterprise Management API - Page 64
trigger The trigger to send Return Type: void Possible Error Codes: VM BAD POWER STATE RPC name: maximise memory Overview: Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is - HP BL680c | XenEnterprise Management API - Page 65
approximate description The VM Total amount of physical RAM to fit within If false the limit is dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU the current state of the system, raising an error if the operation is invalid for some reason - HP BL680c | XenEnterprise Management API - Page 66
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: update allowed operations Overview: Recomputes the list of acceptable operations. Signature: void update_allowed_operations (session_id s, VM ref self) Arguments: type name description VM ref self reference to - HP BL680c | XenEnterprise Management API - Page 67
ref host) Arguments: type VM ref host ref name description self The VM host The host Return Type: void Possible Error Codes: HOST NOT ENOUGH FREE MEMORY, VM REQUIRES SR RPC name: atomic set resident on Overview: . Signature: void atomic_set_resident_on (session_id s, VM ref vm, host ref host - HP BL680c | XenEnterprise Management API - Page 68
2.9. CLASS: VM Return Type: (VM ref) Set references to all objects CHAPTER 2. API REFERENCE RPC name: get all records Overview: Return a map of VM references to VM records for all VMs known to the system. Signature: ((VM ref -> VM record) Map) get_all_records (session_id s) Return Type: (VM ref → - HP BL680c | XenEnterprise Management API - Page 69
VM. Signature: (vm_power_state) get_power_state (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: vm power state value of the field RPC name: get name label Overview: Get the name/label field of the given VM. Signature: string get_name_label - HP BL680c | XenEnterprise Management API - Page 70
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set name label Overview: Set the name/label field of the given VM. Signature: void set_name_label (session_id s, VM ref self, string value) Arguments: type VM ref string name description self reference to the object value New value to set - HP BL680c | XenEnterprise Management API - Page 71
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get user version Overview: Get the user version field of the given VM. Signature: int get_user_version (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: int value of the field RPC name: set - HP BL680c | XenEnterprise Management API - Page 72
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set is a template Overview: Set the is a template field of the given VM. Signature: void set_is_a_template (session_id s, VM ref self, bool value) Arguments: type VM ref bool name description self reference to the object value New value to set - HP BL680c | XenEnterprise Management API - Page 73
VM ref host ref name description self reference to the object value New value to set Return Type: void RPC name: get memory static max Overview: Get the memory/static max field of the given VM. Signature: int get_memory_static_max (session_id s, VM ref self) Arguments: type name description VM ref - HP BL680c | XenEnterprise Management API - Page 74
VM ref int name description self reference to the object value New value to set Return Type: void RPC name: get memory dynamic max Overview: Get the memory/dynamic max field of the given VM. Signature: int get_memory_dynamic_max (session_id s, VM ref self) Arguments: type name description VM ref - HP BL680c | XenEnterprise Management API - Page 75
VM ref int name description self reference to the object value New value to set Return Type: void RPC name: get memory static min Overview: Get the memory/static min field of the given VM. Signature: int get_memory_static_min (session_id s, VM ref self) Arguments: type name description VM ref self - HP BL680c | XenEnterprise Management API - Page 76
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set memory static min Overview: Set the memory/static min field of the given VM. Signature: void set_memory_static_min (session_id s, VM ref self, int value) Arguments: type VM ref int name description self reference - HP BL680c | XenEnterprise Management API - Page 77
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: add to VCPUs params Overview: Add the given key-value pair to the VCPUs/params field of the given VM. Signature: void add_to_VCPUs_params (session_id s, VM ref self, string key, string value) Arguments: type VM ref string string name self key - HP BL680c | XenEnterprise Management API - Page 78
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set VCPUs max Overview: Set the VCPUs/max field of the given VM. Signature: void set_VCPUs_max (session_id s, VM ref self, int value) Arguments: type VM ref int name description self reference to the object value New value to set Return Type: - HP BL680c | XenEnterprise Management API - Page 79
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get actions after shutdown Overview: Get the actions/after shutdown field of the given VM. Signature: (on_normal_exit) get_actions_after_shutdown (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return - HP BL680c | XenEnterprise Management API - Page 80
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set actions after reboot Overview: Set the actions/after reboot field of the given VM. Signature: void set_actions_after_reboot (session_id s, VM ref self, on_normal_exit value) Arguments: type VM ref on normal exit name description self - HP BL680c | XenEnterprise Management API - Page 81
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get consoles Overview: Get the consoles field of the given VM. Signature: ((console ref) Set) get_consoles (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: (console ref) Set value of the fi - HP BL680c | XenEnterprise Management API - Page 82
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get crash dumps Overview: Get the crash dumps field of the given VM. Signature: ((crashdump ref) Set) get_crash_dumps (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: (crashdump ref) Set - HP BL680c | XenEnterprise Management API - Page 83
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set PV bootloader Overview: Set the PV/bootloader field of the given VM. Signature: void set_PV_bootloader (session_id s, VM ref self, string value) Arguments: type VM ref string name description self reference to the object value New value to - HP BL680c | XenEnterprise Management API - Page 84
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get PV ramdisk Overview: Get the PV/ramdisk field of the given VM. Signature: string get_PV_ramdisk (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: string value of the field RPC name: set - HP BL680c | XenEnterprise Management API - Page 85
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set PV args Overview: Set the PV/args field of the given VM. Signature: void set_PV_args (session_id s, VM ref self, string value) Arguments: type VM ref string name description self reference to the object value New value to set Return Type: - HP BL680c | XenEnterprise Management API - Page 86
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get PV legacy args Overview: Get the PV/legacy args field of the given VM. Signature: string get_PV_legacy_args (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: string value of the field - HP BL680c | XenEnterprise Management API - Page 87
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set HVM boot policy Overview: Set the HVM/boot policy field of the given VM. Signature: void set_HVM_boot_policy (session_id s, VM ref self, string value) Arguments: type VM ref string name description self reference to the object value New - HP BL680c | XenEnterprise Management API - Page 88
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: add to HVM boot params Overview: Add the given key-value pair to the HVM/boot params field of the given VM. Signature: void add_to_HVM_boot_params (session_id s, VM ref self, string key, string value) Arguments: type VM ref string string name - HP BL680c | XenEnterprise Management API - Page 89
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set HVM shadow multiplier Overview: Set the HVM/shadow multiplier field of the given VM. Signature: void set_HVM_shadow_multiplier (session_id s, VM ref self, float value) Arguments: type VM ref float name description self reference to the - HP BL680c | XenEnterprise Management API - Page 90
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: add to platform Overview: Add the given key-value pair to the platform field of the given VM. Signature: void add_to_platform (session_id s, VM ref self, string key, string value) Arguments: type VM ref string string name self key value - HP BL680c | XenEnterprise Management API - Page 91
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set PCI bus Overview: Set the PCI bus field of the given VM. Signature: void set_PCI_bus (session_id s, VM ref self, string value) Arguments: type VM ref string name description self reference to the object value New value to set Return Type: - HP BL680c | XenEnterprise Management API - Page 92
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given VM. Signature: void add_to_other_config (session_id s, VM ref self, string key, string value) Arguments: type VM ref string string name self key - HP BL680c | XenEnterprise Management API - Page 93
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get domarch Overview: Get the domarch field of the given VM. Signature: string get_domarch (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: string value of the field RPC name: get last - HP BL680c | XenEnterprise Management API - Page 94
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get metrics Overview: Get the metrics field of the given VM. Signature: (VM_metrics ref) get_metrics (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: VM metrics ref value of the field RPC - HP BL680c | XenEnterprise Management API - Page 95
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get recommendations Overview: Get the recommendations field of the given VM. Signature: string get_recommendations (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: string value of the field - HP BL680c | XenEnterprise Management API - Page 96
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: set xenstore data Overview: Set the xenstore data field of the given VM. Signature: void set_xenstore_data (session_id s, VM ref self, (string -> string) Map value) Arguments: type VM ref (string → string) Map name description self reference to - HP BL680c | XenEnterprise Management API - Page 97
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: create Overview: Create a new VM instance, and return its handle. Signature: (VM ref) create (session_id s, VM record args) Arguments: type name description VM record args All constructor arguments Return Type: VM ref reference to the newly - HP BL680c | XenEnterprise Management API - Page 98
2.9. CLASS: VM CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given VM. Signature: (VM record) get_record (session_id s, VM ref self) Arguments: type name description VM ref self reference to the object Return Type: VM record all fields from - HP BL680c | XenEnterprise Management API - Page 99
Map VCPUs/flags state (int → string Set) Map string Set start time datetime install time last updated datetime datetime Description unique identifier/object reference Guest's actual memory (bytes) Current number of VCPUs Utilisation for all of guest's current VCPUs VCPU to PCPU map The - HP BL680c | XenEnterprise Management API - Page 100
description VM metrics ref self reference to the object Return Type: string value of the field RPC name: get memory actual Overview: Get the memory/actual field of the given VM metrics. Signature: int get_memory_actual (session_id s, VM_metrics ref self) Arguments: type name description VM - HP BL680c | XenEnterprise Management API - Page 101
2.10. CLASS: VM METRICS CHAPTER 2. API REFERENCE RPC name: get VCPUs utilisation Overview: Get the VCPUs/utilisation field of the given VM metrics. Signature: ((int -> float) Map) get_VCPUs_utilisation (session_id s, VM_metrics ref self) Arguments: type name description VM metrics ref self - HP BL680c | XenEnterprise Management API - Page 102
2.10. CLASS: VM METRICS CHAPTER 2. API REFERENCE RPC name: get VCPUs flags Overview: Get the VCPUs/flags field of the given VM metrics. Signature: ((int -> string Set) Map) get_VCPUs_flags (session_id s, VM_metrics ref self) Arguments: type name description VM metrics ref self reference to the - HP BL680c | XenEnterprise Management API - Page 103
VM metrics ref self reference to the object Return Type: datetime value of the field RPC name: get last updated Overview: Get the last updated field of the given VM metrics. Signature: datetime get_last_updated (session_id s, VM_metrics ref self) Arguments: type name description VM metrics - HP BL680c | XenEnterprise Management API - Page 104
2.10. CLASS: VM METRICS CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given VM metrics. Signature: (VM_metrics record) get_record (session_id s, VM_metrics ref self) Arguments: type name description VM metrics ref self reference to - HP BL680c | XenEnterprise Management API - Page 105
version (string → string) Map version of the OS PV drivers version (string → string) Map version of the PV drivers PV drivers up to date bool true if the PV drivers appear to be up to date memory (string → string) Map free/used/total memory disks (string → string) Map disk configuration/free - HP BL680c | XenEnterprise Management API - Page 106
eld name description self reference to the object RPC name: get os version Overview: Get the os version field of the given VM guest metrics. Signature: ((string ) Map value of the field RPC name: get PV drivers up to date Overview: Get the PV drivers up to date field of the given VM guest metrics. - HP BL680c | XenEnterprise Management API - Page 107
2.11. CLASS: VM GUEST METRICS Return Type: bool value of the field CHAPTER 2. API REFERENCE RPC name: get memory Overview: Get the memory field of the given VM guest metrics. Signature: ((string -> string) Map) get_memory (session_id s, VM_guest_metrics ref self) Arguments: type name - HP BL680c | XenEnterprise Management API - Page 108
ref self reference to the object Return Type: (string → string) Map value of the field RPC name: get last updated Overview: Get the last updated field of the given VM guest metrics. Signature: datetime get_last_updated (session_id s, VM_guest_metrics ref self) Arguments: type name description - HP BL680c | XenEnterprise Management API - Page 109
2.11. CLASS: VM GUEST METRICS CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given VM guest metrics. Signature: (VM_guest_metrics record) get_record (session_id s, VM_guest_metrics ref self) Arguments: type name description VM guest - HP BL680c | XenEnterprise Management API - Page 110
enabled software version other config capabilities cpu configuration sched policy supported bootloaders resident VMs logging PIFs suspend contai readable description list of the operations al state. This list is advis the server state may hav the time this field is rea links each of the runnin this - HP BL680c | XenEnterprise Management API - Page 111
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RO run boot free mem int Free memory on host at 2.12.2 RPCs associated with class: host RPC name: disable Overview: Puts the host into a state in which no new VMs can be - HP BL680c | XenEnterprise Management API - Page 112
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: reboot Overview: Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.). Signature: void reboot (session_id s, host ref host) Arguments: type name description host ref host The - HP BL680c | XenEnterprise Management API - Page 113
The keys to send Return Type: void RPC name: bugreport upload Overview: Run xen-bugtool -yestoall and upload the output to Citrix support. Signature: void bugreport_upload (session_id s, host ref host, string url, (string -> string) Map options) Arguments: type host ref string (string → string - HP BL680c | XenEnterprise Management API - Page 114
list_methods (session_id s) Return Type: string Set The name of every supported method. CHAPTER 2. API REFERENCE RPC name: license apply Overview: license file, base64 encoded Return Type: void Possible Error Codes: LICENSE PROCESSING ERROR RPC name: destroy Overview: Destroy specified host - HP BL680c | XenEnterprise Management API - Page 115
2.12. CLASS: HOST Arguments: type name description host ref host The host to evacuate Return Type: void CHAPTER 2. API REFERENCE RPC name: evacuate Overview: Disable the host and Migrate all VMs off of it, where possible. Signature: void evacuate (session_id s, host ref host) Arguments: type name - HP BL680c | XenEnterprise Management API - Page 116
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: local management reconfigure Overview: Reconfigure the management network interface. Should only be used if Host.management reconfigure is impossible because the network configuration is broken. Signature: void local_management_reconfigure ( - HP BL680c | XenEnterprise Management API - Page 117
2.12. CLASS: HOST CHAPTER 2. API REFERENCE Arguments: type host ref string name description host The host whose host name to set hostname The new host name Return Type: void RPC name: get all Overview: Return a list of all the hosts known to the system. Signature: ((host ref) Set) get_all ( - HP BL680c | XenEnterprise Management API - Page 118
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get name label Overview: Get the name/label field of the given host. Signature: string get_name_label (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: string value of the field RPC - HP BL680c | XenEnterprise Management API - Page 119
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: set name description Overview: Set the name/description field of the given host. Signature: void set_name_description (session_id s, host ref self, string value) Arguments: type host ref string name description self reference to the object - HP BL680c | XenEnterprise Management API - Page 120
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get API version major Overview: Get the API version/major field of the given host. Signature: int get_API_version_major (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: int value of - HP BL680c | XenEnterprise Management API - Page 121
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get API version vendor implementation Overview: Get the API version/vendor implementation field of the given host. Signature: ((string -> string) Map) get_API_version_vendor_implementation (session_id s, host ref self) Arguments: type name - HP BL680c | XenEnterprise Management API - Page 122
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given host. Signature: ((string -> string) Map) get_other_config (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: (string - HP BL680c | XenEnterprise Management API - Page 123
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field of the given host. If the key is not in that Map, then do nothing. Signature: void remove_from_other_config (session_id s, host ref - HP BL680c | XenEnterprise Management API - Page 124
type name description host ref self reference to the object Return Type: string value of the field RPC name: get supported bootloaders Overview: Get the supported bootloaders field of the given host. Signature: (string Set) get_supported_bootloaders (session_id s, host ref self) Arguments: type name - HP BL680c | XenEnterprise Management API - Page 125
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get logging Overview: Get the logging field of the given host. Signature: ((string -> string) Map) get_logging (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: (string → string) Map - HP BL680c | XenEnterprise Management API - Page 126
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: remove from logging Overview: Remove the given key and its corresponding value from the logging field of the given host. If the key is not in that Map, then do nothing. Signature: void remove_from_logging (session_id s, host ref self, string - HP BL680c | XenEnterprise Management API - Page 127
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: set suspend image sr Overview: Set the suspend image sr field of the given host. Signature: void set_suspend_image_sr (session_id s, host ref self, SR ref value) Arguments: type host ref SR ref name description self reference to the object - HP BL680c | XenEnterprise Management API - Page 128
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get crashdumps Overview: Get the crashdumps field of the given host. Signature: ((host_crashdump ref) Set) get_crashdumps (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: (host - HP BL680c | XenEnterprise Management API - Page 129
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get host CPUs Overview: Get the host CPUs field of the given host. Signature: ((host_cpu ref) Set) get_host_CPUs (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: (host cpu ref) Set - HP BL680c | XenEnterprise Management API - Page 130
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get address Overview: Get the address field of the given host. Signature: string get_address (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: string value of the field RPC name: set - HP BL680c | XenEnterprise Management API - Page 131
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get license params Overview: Get the license params field of the given host. Signature: ((string -> string) Map) get_license_params (session_id s, host ref self) Arguments: type name description host ref self reference to the object Return Type: - HP BL680c | XenEnterprise Management API - Page 132
2.12. CLASS: HOST CHAPTER 2. API REFERENCE RPC name: get by name label Overview: Get all the host instances with the given label. Signature: ((host ref) Set) get_by_name_label (session_id s, string label) Arguments: type name description string label label of object to return Return Type: (host - HP BL680c | XenEnterprise Management API - Page 133
2.13. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE 2.13 Class: host crashdump 2.13.1 Fields for class: host crashdump Name Description Quals RO run RO ins RO run RO run RO ins RW host crashdump Represents a host crash dump. Field Type uuid string host host ref timestamp datetime size - HP BL680c | XenEnterprise Management API - Page 134
2.13. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE ((host_crashdump ref) Set) get_all (session_id s) Return Type: (host crashdump ref) Set references to all objects RPC name: get all records Overview: Return a map of host crashdump references to host crashdump records for all host crashdumps - HP BL680c | XenEnterprise Management API - Page 135
2.13. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE RPC name: get timestamp Overview: Get the timestamp field of the given host crashdump. Signature: datetime get_timestamp (session_id s, host_crashdump ref self) Arguments: type name description host crashdump ref self reference to the - HP BL680c | XenEnterprise Management API - Page 136
2.13. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE RPC name: set other config Overview: Set the other config field of the given host crashdump. Signature: void set_other_config (session_id s, host_crashdump ref self, (string -> string) Map value) Arguments: type host crashdump ref (string → - HP BL680c | XenEnterprise Management API - Page 137
2.13. CLASS: HOST CRASHDUMP CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the host crashdump instance with the specified UUID. Signature: (host_crashdump ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return - HP BL680c | XenEnterprise Management API - Page 138
RO ins RO ins RO ins RO ins RO run RO run RO run RO run RO ins RW host patch Represents a patch stored on a server. Field Type uuid string name/label string name/description string version host filename applied timestamp applied size pool patch other config string host ref string - HP BL680c | XenEnterprise Management API - Page 139
2.14. CLASS: HOST PATCH CHAPTER 2. API REFERENCE RPC name: get all Overview: Return a list of all the host patchs known to the system. Signature: ((host_patch ref) Set) get_all (session_id s) Return Type: (host patch ref) Set references to all objects RPC name: get all records Overview: Return a - HP BL680c | XenEnterprise Management API - Page 140
2.14. CLASS: HOST PATCH Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get name description Overview: Get the name/description field of the given host patch. Signature: string get_name_description (session_id s, host_patch ref self) Arguments: type name description - HP BL680c | XenEnterprise Management API - Page 141
2.14. CLASS: HOST PATCH CHAPTER 2. API REFERENCE RPC name: get applied Overview: Get the applied field of the given host patch. Signature: bool get_applied (session_id s, host_patch ref self) Arguments: type name description host patch ref self reference to the object Return Type: bool value - HP BL680c | XenEnterprise Management API - Page 142
2.14. CLASS: HOST PATCH CHAPTER 2. API REFERENCE RPC name: get pool patch Overview: Get the pool patch field of the given host patch. Signature: (pool_patch ref) get_pool_patch (session_id s, host_patch ref self) Arguments: type name description host patch ref self reference to the object - HP BL680c | XenEnterprise Management API - Page 143
2.14. CLASS: HOST PATCH CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given host patch. Signature: void add_to_other_config (session_id s, host_patch ref self, string key, string value) Arguments: type host patch ref - HP BL680c | XenEnterprise Management API - Page 144
2.14. CLASS: HOST PATCH CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given host patch. Signature: (host_patch record) get_record (session_id s, host_patch ref self) Arguments: type name description host patch ref self reference to - HP BL680c | XenEnterprise Management API - Page 145
string unique identifier/object reference memory/total int Host's total memory (bytes) memory/free int Host's free memory (bytes) live bool Pool master thinks this host is live last updated datetime Time at which this information was last updated 2.15.2 RPCs associated with class: host - HP BL680c | XenEnterprise Management API - Page 146
description host metrics ref self reference to the object Return Type: int value of the field RPC name: get memory free Overview: Get the memory/free field of the given host metrics. Signature: int get_memory_free (session_id s, host_metrics ref self) Arguments: type name description host - HP BL680c | XenEnterprise Management API - Page 147
2.15. CLASS: HOST METRICS CHAPTER 2. API REFERENCE RPC name: get last updated Overview: Get the last updated field of the given host metrics. Signature: datetime get_last_updated (session_id s, host_metrics ref self) Arguments: type name description host metrics ref self reference to the - HP BL680c | XenEnterprise Management API - Page 148
2.16. CLASS: HOST CPU CHAPTER 2. API REFERENCE 2.16 Class: host cpu 2.16.1 Fields for class: host cpu Name Description Quals RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run RO run host cpu A physical CPU. Field Type uuid string host host ref number int - HP BL680c | XenEnterprise Management API - Page 149
2.16. CLASS: HOST CPU CHAPTER 2. API REFERENCE RPC name: get uuid Overview: Get the uuid field of the given host cpu. Signature: string get_uuid (session_id s, host_cpu ref self) Arguments: type name description host cpu ref self reference to the object Return Type: string value of the field - HP BL680c | XenEnterprise Management API - Page 150
2.16. CLASS: HOST CPU CHAPTER 2. API REFERENCE RPC name: get vendor Overview: Get the vendor field of the given host cpu. Signature: string get_vendor (session_id s, host_cpu ref self) Arguments: type name description host cpu ref self reference to the object Return Type: string value of the - HP BL680c | XenEnterprise Management API - Page 151
2.16. CLASS: HOST CPU CHAPTER 2. API REFERENCE RPC name: get family Overview: Get the family field of the given host cpu. Signature: int get_family (session_id s, host_cpu ref self) Arguments: type name description host cpu ref self reference to the object Return Type: int value of the field - HP BL680c | XenEnterprise Management API - Page 152
2.16. CLASS: HOST CPU CHAPTER 2. API REFERENCE RPC name: get flags Overview: Get the flags field of the given host cpu. Signature: string get_flags (session_id s, host_cpu ref self) Arguments: type name description host cpu ref self reference to the object Return Type: string value of the field - HP BL680c | XenEnterprise Management API - Page 153
2.16. CLASS: HOST CPU CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the host cpu instance with the specified UUID. Signature: (host_cpu ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return Type: host - HP BL680c | XenEnterprise Management API - Page 154
reference a human-readable name a notes field containg humanreadable description list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference - HP BL680c | XenEnterprise Management API - Page 155
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE RPC name: get uuid Overview: Get the uuid field of the given network. Signature: string get_uuid (session_id s, network ref self) Arguments: type name description network ref self reference to the object Return Type: string value of the field RPC - HP BL680c | XenEnterprise Management API - Page 156
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE RPC name: get name description Overview: Get the name/description field of the given network. Signature: string get_name_description (session_id s, network ref self) Arguments: type name description network ref self reference to the object Return - HP BL680c | XenEnterprise Management API - Page 157
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE RPC name: get current operations Overview: Get the current operations field of the given network. Signature: ((string -> network_operations) Map) get_current_operations (session_id s, network ref self) Arguments: type name description network ref - HP BL680c | XenEnterprise Management API - Page 158
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given network. Signature: ((string -> string) Map) get_other_config (session_id s, network ref self) Arguments: type name description network ref self reference to the object - HP BL680c | XenEnterprise Management API - Page 159
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field of the given network. If the key is not in that Map, then do nothing. Signature: void remove_from_other_config (session_id s, - HP BL680c | XenEnterprise Management API - Page 160
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE RPC name: destroy Overview: Destroy the specified network instance. Signature: void destroy (session_id s, network ref self) Arguments: type name description network ref self reference to the object Return Type: void RPC name: get by uuid - HP BL680c | XenEnterprise Management API - Page 161
2.17. CLASS: NETWORK CHAPTER 2. API REFERENCE ((network ref) Set) get_by_name_label (session_id s, string label) Arguments: type name description string label label of object to return Return Type: (network ref) Set references to objects with matching names 161 - HP BL680c | XenEnterprise Management API - Page 162
advisory only and the server state may have changed by code associated with last attach-operation (erased on reboot) error/success information associated with last attach-operation status (erased on reboot) Device runtime properties QoS algorithm to use parameters for chosen QoS algorithm supported - HP BL680c | XenEnterprise Management API - Page 163
2.18. CLASS: VIF type name description VIF ref self The VIF to hotplug Return Type: void CHAPTER 2. API REFERENCE RPC name: unplug Overview: Hot-unplug the specified VIF, dynamically unattaching it from the running VM. Signature: void unplug (session_id s, VIF ref self) Arguments: type name - HP BL680c | XenEnterprise Management API - Page 164
2.18. CLASS: VIF Arguments: type name description VIF ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get allowed operations Overview: Get the allowed operations field of the given VIF. Signature: ((vif_operations) Set) - HP BL680c | XenEnterprise Management API - Page 165
2.18. CLASS: VIF Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get network Overview: Get the network field of the given VIF. Signature: (network ref) get_network (session_id s, VIF ref self) Arguments: type name description VIF ref self reference to the object Return Type - HP BL680c | XenEnterprise Management API - Page 166
2.18. CLASS: VIF RPC name: get MTU Overview: Get the MTU field of the given VIF. Signature: int get_MTU (session_id s, VIF ref self) Arguments: type name description VIF ref self reference to the object Return Type: int value of the field CHAPTER 2. API REFERENCE RPC name: get other config Overview: - HP BL680c | XenEnterprise Management API - Page 167
2.18. CLASS: VIF CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given VIF. Signature: void add_to_other_config (session_id s, VIF ref self, string key, string value) Arguments: type VIF ref string string name self - HP BL680c | XenEnterprise Management API - Page 168
2.18. CLASS: VIF CHAPTER 2. API REFERENCE RPC name: get status code Overview: Get the status code field of the given VIF. Signature: int get_status_code (session_id s, VIF ref self) Arguments: type name description VIF ref self reference to the object Return Type: - HP BL680c | XenEnterprise Management API - Page 169
2.18. CLASS: VIF CHAPTER 2. API REFERENCE RPC name: get qos algorithm type Overview: Get the qos/algorithm type field of the given VIF. Signature: string get_qos_algorithm_type (session_id s, VIF ref self) Arguments: type name description VIF ref self reference to the object Return Type: string - HP BL680c | XenEnterprise Management API - Page 170
2.18. CLASS: VIF CHAPTER 2. API REFERENCE RPC name: set qos algorithm params Overview: Set the qos/algorithm params field of the given VIF. Signature: void set_qos_algorithm_params (session_id s, VIF ref self, (string -> string) Map value) Arguments: type VIF ref (string → string) Map name - HP BL680c | XenEnterprise Management API - Page 171
2.18. CLASS: VIF CHAPTER 2. API REFERENCE RPC name: get qos supported algorithms Overview: Get the qos/supported algorithms field of the given VIF. Signature: (string Set) get_qos_supported_algorithms (session_id s, VIF ref self) Arguments: type name description VIF ref self reference to the object - HP BL680c | XenEnterprise Management API - Page 172
2.18. CLASS: VIF RPC name: destroy Overview: Destroy the specified VIF instance. Signature: void destroy (session_id s, VIF ref self) Arguments: type name description VIF ref self reference to the object Return Type: void CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to - HP BL680c | XenEnterprise Management API - Page 173
identifier/object reference io/read kbs float Read bandwidth (KiB/s) io/write kbs float Write bandwidth (KiB/s) last updated datetime Time at which this information was last updated 2.19.2 RPCs associated with class: VIF metrics RPC name: get all Overview: Return a list of all the VIF metrics - HP BL680c | XenEnterprise Management API - Page 174
VIF metrics ref self reference to the object Return Type: float value of the field RPC name: get last updated Overview: Get the last updated field of the given VIF metrics. Signature: datetime get_last_updated (session_id s, VIF_metrics ref self) Arguments: type name description VIF metrics - HP BL680c | XenEnterprise Management API - Page 175
2.19. CLASS: VIF METRICS CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the VIF metrics instance with the specified UUID. Signature: (VIF_metrics ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return - HP BL680c | XenEnterprise Management API - Page 176
interface currently attached bool true if this interface is online ip configuration mode ip configuration mode Sets if and how this interface DNS string IP address of DNS servers to use bond slave of Bond ref indicates which bond this interface is part of bond master of (Bond ref - HP BL680c | XenEnterprise Management API - Page 177
Possible Error Codes: VLAN Codes: PIF IS PHYSICAL RPC name: reconfigure ip Overview: Reconfigure the IP address settings for this interface. Signature: void reconfigure_ip (session_id s, PIF ref self, ip_configuration_mode mode, string IP, string netmask, Arguments: type PIF ref ip configuration - HP BL680c | XenEnterprise Management API - Page 178
2.20. CLASS: PIF CHAPTER 2. API REFERENCE RPC name: scan Overview: Scan for physical interfaces on a host and create PIF objects to represent them. Signature: void scan (session_id s, host ref host) Arguments: type name description host ref host The host on which to scan Return Type: void RPC - HP BL680c | XenEnterprise Management API - Page 179
2.20. CLASS: PIF RPC name: get all Overview: Return a list of all the PIFs known to the system. Signature: ((PIF ref) Set) get_all (session_id s) Return Type: (PIF ref) Set references to all objects CHAPTER 2. API REFERENCE RPC name: get all records Overview: Return a map of PIF references to PIF - HP BL680c | XenEnterprise Management API - Page 180
2.20. CLASS: PIF value of the field CHAPTER 2. API REFERENCE RPC name: get network Overview: Get the network field of the given PIF. Signature: (network ref) get_network (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: network ref value - HP BL680c | XenEnterprise Management API - Page 181
2.20. CLASS: PIF RPC name: get MTU Overview: Get the MTU field of the given PIF. Signature: int get_MTU (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: int value of the field CHAPTER 2. API REFERENCE RPC name: get VLAN Overview: Get the - HP BL680c | XenEnterprise Management API - Page 182
of the given PIF. Signature: (ip_configuration_mode) get_ip_configuration_mode (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: ip configuration mode value of the field 182 - HP BL680c | XenEnterprise Management API - Page 183
2.20. CLASS: PIF RPC name: get IP Overview: Get the IP field of the given PIF. Signature: string get_IP (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get netmask Overview: - HP BL680c | XenEnterprise Management API - Page 184
2.20. CLASS: PIF RPC name: get DNS Overview: Get the DNS field of the given PIF. Signature: string get_DNS (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get bond slave of - HP BL680c | XenEnterprise Management API - Page 185
2.20. CLASS: PIF CHAPTER 2. API REFERENCE RPC name: get VLAN master of Overview: Get the VLAN master of field of the given PIF. Signature: (VLAN ref) get_VLAN_master_of (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: VLAN ref value of - HP BL680c | XenEnterprise Management API - Page 186
2.20. CLASS: PIF CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given PIF. Signature: ((string -> string) Map) get_other_config (session_id s, PIF ref self) Arguments: type name description PIF ref self reference to the object Return Type: (string → - HP BL680c | XenEnterprise Management API - Page 187
2.20. CLASS: PIF CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field of the given PIF. If the key is not in that Map, then do nothing. Signature: void remove_from_other_config (session_id s, PIF ref self, - HP BL680c | XenEnterprise Management API - Page 188
duplex capability of the link (if available) pci bus path string PCI bus path of the pif (if available) last updated datetime Time at which this information was last updated 2.21.2 RPCs associated with class: PIF metrics RPC name: get all Overview: Return a list of all the PIF metrics instances - HP BL680c | XenEnterprise Management API - Page 189
2.21. CLASS: PIF METRICS CHAPTER 2. API REFERENCE RPC name: get uuid Overview: Get the uuid field of the given PIF metrics. Signature: string get_uuid (session_id s, PIF_metrics ref self) Arguments: type name description PIF metrics ref self reference to the object Return Type: string value - HP BL680c | XenEnterprise Management API - Page 190
2.21. CLASS: PIF METRICS CHAPTER 2. API REFERENCE RPC name: get carrier Overview: Get the carrier field of the given PIF metrics. Signature: bool get_carrier (session_id s, PIF_metrics ref self) Arguments: type name description PIF metrics ref self reference to the object Return Type: bool - HP BL680c | XenEnterprise Management API - Page 191
2.21. CLASS: PIF METRICS CHAPTER 2. API REFERENCE RPC name: get device id Overview: Get the device id field of the given PIF metrics. Signature: string get_device_id (session_id s, PIF_metrics ref self) Arguments: type name description PIF metrics ref self reference to the object Return Type: - HP BL680c | XenEnterprise Management API - Page 192
PIF metrics ref self reference to the object Return Type: string value of the field RPC name: get last updated Overview: Get the last updated field of the given PIF metrics. Signature: datetime get_last_updated (session_id s, PIF_metrics ref self) Arguments: type name description PIF metrics - HP BL680c | XenEnterprise Management API - Page 193
2.21. CLASS: PIF METRICS CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the PIF metrics instance with the specified UUID. Signature: (PIF_metrics ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return - HP BL680c | XenEnterprise Management API - Page 194
string PIF ref (PIF ref) Set (string → string) Map Description unique identifier/object reference The bonded interface The interfaces which are part of this bond additional configuration 2.22.2 RPCs associated with class: Bond RPC name: create Overview: Create an interface bond. Signature: (Bond - HP BL680c | XenEnterprise Management API - Page 195
2.22. CLASS: BOND RPC name: get all Overview: Return a list of all the Bonds known to the system. Signature: ((Bond ref) Set) get_all (session_id s) Return Type: (Bond ref) Set references to all objects CHAPTER 2. API REFERENCE RPC name: get all records Overview: Return a map of Bond references to - HP BL680c | XenEnterprise Management API - Page 196
2.22. CLASS: BOND value of the field CHAPTER 2. API REFERENCE RPC name: get slaves Overview: Get the slaves field of the given Bond. Signature: ((PIF ref) Set) get_slaves (session_id s, Bond ref self) Arguments: type name description Bond ref self reference to the object Return Type: (PIF ref) Set - HP BL680c | XenEnterprise Management API - Page 197
2.22. CLASS: BOND CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given Bond. Signature: void add_to_other_config (session_id s, Bond ref self, string key, string value) Arguments: type Bond ref string string name - HP BL680c | XenEnterprise Management API - Page 198
2.22. CLASS: BOND CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given Bond. Signature: (Bond record) get_record (session_id s, Bond ref self) Arguments: type name description Bond ref self reference to the object Return Type: Bond record - HP BL680c | XenEnterprise Management API - Page 199
2.23. CLASS: VLAN CHAPTER 2. API REFERENCE 2.23 Class: VLAN 2.23.1 Fields for class: VLAN Name Description Quals RO run RO ins RO run RO ins RW VLAN A VLAN mux/demux. Field Type uuid string tagged PIF PIF ref untagged PIF PIF ref tag int other config (string → string) Map Description - HP BL680c | XenEnterprise Management API - Page 200
2.23. CLASS: VLAN ((VLAN ref) Set) get_all (session_id s) Return Type: (VLAN ref) Set references to all objects CHAPTER 2. API REFERENCE RPC name: get all records Overview: Return a map of VLAN references to VLAN records for all VLANs known to the system. Signature: ((VLAN ref -> VLAN record) Map) - HP BL680c | XenEnterprise Management API - Page 201
2.23. CLASS: VLAN CHAPTER 2. API REFERENCE RPC name: get untagged PIF Overview: Get the untagged PIF field of the given VLAN. Signature: (PIF ref) get_untagged_PIF (session_id s, VLAN ref self) Arguments: type name description VLAN ref self reference to the object Return Type: PIF ref value of the - HP BL680c | XenEnterprise Management API - Page 202
2.23. CLASS: VLAN CHAPTER 2. API REFERENCE RPC name: set other config Overview: Set the other config field of the given VLAN. Signature: void set_other_config (session_id s, VLAN ref self, (string -> string) Map value) Arguments: type VLAN ref (string → string) Map name description self - HP BL680c | XenEnterprise Management API - Page 203
2.23. CLASS: VLAN CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the VLAN instance with the specified UUID. Signature: (VLAN ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return Type: VLAN ref - HP BL680c | XenEnterprise Management API - Page 204
string string string version string required api version string configuration (string → string) Map capabilities other config this plugin Version of the plugin Minimum SM API version required on the server names and descriptions of device config keys capabilities of the SM plugin additional - HP BL680c | XenEnterprise Management API - Page 205
2.24. CLASS: SM RPC name: get uuid Overview: Get the uuid field of the given SM. Signature: string get_uuid (session_id s, SM ref self) Arguments: type name description SM ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get name label - HP BL680c | XenEnterprise Management API - Page 206
2.24. CLASS: SM RPC name: get type Overview: Get the type field of the given SM. Signature: string get_type (session_id s, SM ref self) Arguments: type name description SM ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get vendor Overview: - HP BL680c | XenEnterprise Management API - Page 207
2.24. CLASS: SM CHAPTER 2. API REFERENCE RPC name: get version Overview: Get the version field of the given SM. Signature: string get_version (session_id s, SM ref self) Arguments: type name description SM ref self reference to the object Return Type: string value of the field RPC name: get - HP BL680c | XenEnterprise Management API - Page 208
2.24. CLASS: SM CHAPTER 2. API REFERENCE RPC name: get capabilities Overview: Get the capabilities field of the given SM. Signature: (string Set) get_capabilities (session_id s, SM ref self) Arguments: type name description SM ref self reference to the object Return Type: string Set value of the fi - HP BL680c | XenEnterprise Management API - Page 209
2.24. CLASS: SM CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given SM. Signature: void add_to_other_config (session_id s, SM ref self, string key, string value) Arguments: type SM ref string string name self key - HP BL680c | XenEnterprise Management API - Page 210
2.24. CLASS: SM CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given SM. Signature: (SM record) get_record (session_id s, SM ref self) Arguments: type name description SM ref self reference to the object Return Type: SM record all fields - HP BL680c | XenEnterprise Management API - Page 211
reference a human-readable name a notes field containg humanreadable description list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. links each of the running tasks using this object (by reference - HP BL680c | XenEnterprise Management API - Page 212
backend specific configuration options Return Type: SR ref The reference of the newly created Storage Repository. Possible Error Codes: SR UNKNOWN DRIVER RPC name: introduce Overview: Introduce a new Storage Repository into the managed system. Signature: (SR ref) introduce (session_id s, string - HP BL680c | XenEnterprise Management API - Page 213
new storage repository The type of the SR; used to specify the SR backend driver to use The type of the new SRs content, if required (e.g. ISOs) name description SR ref sr The SR to destroy Return Type: void Possible Error Codes: SR HAS PBD RPC name: forget Overview: Removing specified SR- - HP BL680c | XenEnterprise Management API - Page 214
supported types Overview: Return a set of all the SR types supported by the system. Signature: (string Set) get_supported_types (session_id s) Return Type: string Set the supported returning results that will guide the user in improving driver The type of the SR; used to specify the SR backend driver - HP BL680c | XenEnterprise Management API - Page 215
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: set shared Overview: Sets the shared flag on the SR. Signature: void set_shared (session_id s, SR ref sr, bool value) Arguments: type SR ref bool name description sr The SR value True if the SR is shared Return Type: void RPC name: set - HP BL680c | XenEnterprise Management API - Page 216
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: set physical utilisation Overview: Sets the SR's physical utilisation field. Signature: void set_physical_utilisation (session_id s, SR ref self, int value) Arguments: type SR ref int name description self The SR to modify value The new value - HP BL680c | XenEnterprise Management API - Page 217
2.25. CLASS: SR value of the field CHAPTER 2. API REFERENCE RPC name: get name label Overview: Get the name/label field of the given SR. Signature: string get_name_label (session_id s, SR ref self) Arguments: type name description SR ref self reference to the object Return Type: string value of the - HP BL680c | XenEnterprise Management API - Page 218
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: set name description Overview: Set the name/description field of the given SR. Signature: void set_name_description (session_id s, SR ref self, string value) Arguments: type SR ref string name description self reference to the object value New - HP BL680c | XenEnterprise Management API - Page 219
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: get VDIs Overview: Get the VDIs field of the given SR. Signature: ((VDI ref) Set) get_VDIs (session_id s, SR ref self) Arguments: type name description SR ref self reference to the object Return Type: (VDI ref) Set value of the field RPC name: get - HP BL680c | XenEnterprise Management API - Page 220
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: get physical utilisation Overview: Get the physical utilisation field of the given SR. Signature: int get_physical_utilisation (session_id s, SR ref self) Arguments: type name description SR ref self reference to the object Return Type: int value - HP BL680c | XenEnterprise Management API - Page 221
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: get content type Overview: Get the content type field of the given SR. Signature: string get_content_type (session_id s, SR ref self) Arguments: type name description SR ref self reference to the object Return Type: string value of the field RPC - HP BL680c | XenEnterprise Management API - Page 222
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: set other config Overview: Set the other config field of the given SR. Signature: void set_other_config (session_id s, SR ref self, (string -> string) Map value) Arguments: type SR ref (string → string) Map name description self reference to the - HP BL680c | XenEnterprise Management API - Page 223
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: get sm config Overview: Get the sm config field of the given SR. Signature: ((string -> string) Map) get_sm_config (session_id s, SR ref self) Arguments: type name description SR ref self reference to the object Return Type: (string → string) Map - HP BL680c | XenEnterprise Management API - Page 224
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: remove from sm config Overview: Remove the given key and its corresponding value from the sm config field of the given SR. If the key is not in that Map, then do nothing. Signature: void remove_from_sm_config (session_id s, SR ref self, string key) - HP BL680c | XenEnterprise Management API - Page 225
2.25. CLASS: SR CHAPTER 2. API REFERENCE RPC name: get by name label Overview: Get all the SR instances with the given label. Signature: ((SR ref) Set) get_by_name_label (session_id s, string label) Arguments: type name description string label label of object to return Return Type: (SR ref) Set - HP BL680c | XenEnterprise Management API - Page 226
of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. not present on disk References the parent disk, if this VDI is part of a chain data to be inserted into the xenstore tree (/local/domain/0/backend - HP BL680c | XenEnterprise Management API - Page 227
Overview: Take an exact copy of the VDI and return a reference to the new disk. If any driver params are specified then these are passed through to the storage-specific substrate driver that implements the clone operation. NB the clone lives in the same Storage Repository as its parent. Signature - HP BL680c | XenEnterprise Management API - Page 228
to insert into xenstore Storage-specific config Return Type: VDI ref The ref of the newly created VDI record. Possible Error Codes: SR OPERATION NOT SUPPORTED RPC name: db introduce Overview: Create a new VDI record in the database only. Signature: (VDI ref) db_introduce (session_id s, string uuid - HP BL680c | XenEnterprise Management API - Page 229
ref vdi The VDI to forget about Return Type: void RPC name: copy Overview: Make a fresh VDI in the specified SR and copy the supplied VDI's data to the new disk. Signature: (VDI ref) copy (session_id s, VDI ref vdi, SR ref sr) Arguments: type VDI ref SR ref name description - HP BL680c | XenEnterprise Management API - Page 230
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: set managed Overview: Sets the VDI's managed field. Signature: void set_managed (session_id s, VDI ref self, bool value) Arguments: type VDI ref bool name description self The VDI to modify value The new value of the VDI's managed field Return - HP BL680c | XenEnterprise Management API - Page 231
2.26. CLASS: VDI CHAPTER 2. API REFERENCE void set_missing (session_id s, VDI ref self, bool value) Arguments: type VDI ref bool name description self The VDI to modify value The new value of the VDI's missing field Return Type: void RPC name: set virtual size Overview: Sets the VDI's virtual - HP BL680c | XenEnterprise Management API - Page 232
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: get all records Overview: Return a map of VDI references to VDI records for all VDIs known to the system. Signature: ((VDI ref -> VDI record) Map) get_all_records (session_id s) Return Type: (VDI ref → VDI record) Map records of all objects RPC - HP BL680c | XenEnterprise Management API - Page 233
2.26. CLASS: VDI Arguments: type VDI ref string name description self reference to the object value New value to set Return Type: void CHAPTER 2. API REFERENCE RPC name: get name description Overview: Get the name/description field of the given VDI. Signature: string get_name_description ( - HP BL680c | XenEnterprise Management API - Page 234
2.26. CLASS: VDI Return Type: (vdi operations) Set value of the field CHAPTER 2. API REFERENCE RPC name: get current operations Overview: Get the current operations field of the given VDI. Signature: ((string -> vdi_operations) Map) get_current_operations (session_id s, VDI ref self) Arguments: type - HP BL680c | XenEnterprise Management API - Page 235
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: get crash dumps Overview: Get the crash dumps field of the given VDI. Signature: ((crashdump ref) Set) get_crash_dumps (session_id s, VDI ref self) Arguments: type name description VDI ref self reference to the object Return Type: (crashdump ref) - HP BL680c | XenEnterprise Management API - Page 236
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: get type Overview: Get the type field of the given VDI. Signature: (vdi_type) get_type (session_id s, VDI ref self) Arguments: type name description VDI ref self reference to the object Return Type: vdi type value of the field RPC name: get - HP BL680c | XenEnterprise Management API - Page 237
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: get read only Overview: Get the read only field of the given VDI. Signature: bool get_read_only (session_id s, VDI ref self) Arguments: type name description VDI ref self reference to the object Return Type: bool value of the field RPC name: get - HP BL680c | XenEnterprise Management API - Page 238
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given VDI. Signature: void add_to_other_config (session_id s, VDI ref self, string key, string value) Arguments: type VDI ref string string name self - HP BL680c | XenEnterprise Management API - Page 239
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: get location Overview: Get the location field of the given VDI. Signature: string get_location (session_id s, VDI ref self) Arguments: type name description VDI ref self reference to the object Return Type: string value of the field RPC name: get - HP BL680c | XenEnterprise Management API - Page 240
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: get parent Overview: Get the parent field of the given VDI. Signature: (VDI ref) get_parent (session_id s, VDI ref self) Arguments: type name description VDI ref self reference to the object Return Type: VDI ref value of the field RPC name: get - HP BL680c | XenEnterprise Management API - Page 241
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: add to xenstore data Overview: Add the given key-value pair to the xenstore data field of the given VDI. Signature: void add_to_xenstore_data (session_id s, VDI ref self, string key, string value) Arguments: type VDI ref string string name - HP BL680c | XenEnterprise Management API - Page 242
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: set sm config Overview: Set the sm config field of the given VDI. Signature: void set_sm_config (session_id s, VDI ref self, (string -> string) Map value) Arguments: type VDI ref (string → string) Map name description self reference to the - HP BL680c | XenEnterprise Management API - Page 243
2.26. CLASS: VDI CHAPTER 2. API REFERENCE RPC name: create Overview: Create a new VDI instance, and return its handle. Signature: (VDI ref) create (session_id s, VDI record args) Arguments: type name description VDI record args All constructor arguments Return Type: VDI ref reference to the - HP BL680c | XenEnterprise Management API - Page 244
2.26. CLASS: VDI CHAPTER 2. API REFERENCE (VDI record) get_record (session_id s, VDI ref self) Arguments: type name description VDI ref self reference to the object Return Type: VDI record all fields from the object RPC name: get by name label Overview: Get all the VDI instances with the given - HP BL680c | XenEnterprise Management API - Page 245
advisory only and the server state may have changed support hotunplug true if a storage level lock was acquired if true this represents an empty drive true if the VBD is reserved pending a reboot/migrate additional configuration is the device currently attached (erased on reboot) error/success code - HP BL680c | XenEnterprise Management API - Page 246
type VBD ref VDI ref name description vbd The vbd representing the CDROM-like device vdi The new VDI to 'insert' Return Type: void Possible Error Codes: VBD NOT REMOVABLE MEDIA, VBD NOT EMPTY RPC name: plug Overview: Hotplug the specified VBD, dynamically attaching it to the running VM. Signature - HP BL680c | XenEnterprise Management API - Page 247
2.27. CLASS: VBD CHAPTER 2. API REFERENCE Arguments: type name description VBD ref self The VBD to hot-unplug Return Type: void Possible Error Codes: DEVICE DETACH REJECTED, DEVICE ALREADY DETACHED RPC name: unplug force Overview: Forcibly unplug the specified VBD. Signature: void unplug_force ( - HP BL680c | XenEnterprise Management API - Page 248
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: get all records Overview: Return a map of VBD references to VBD records for all VBDs known to the system. Signature: ((VBD ref -> VBD record) Map) get_all_records (session_id s) Return Type: (VBD ref → VBD record) Map records of all objects RPC - HP BL680c | XenEnterprise Management API - Page 249
2.27. CLASS: VBD Arguments: type name description VBD ref self reference to the object Return Type: (string → vbd operations) Map value of the field CHAPTER 2. API REFERENCE RPC name: get VM Overview: Get the VM field of the given VBD. Signature: (VM ref) get_VM (session_id s, VBD ref self) - HP BL680c | XenEnterprise Management API - Page 250
2.27. CLASS: VBD Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get userdevice Overview: Get the userdevice field of the given VBD. Signature: string get_userdevice (session_id s, VBD ref self) Arguments: type name description VBD ref self reference to the object Return - HP BL680c | XenEnterprise Management API - Page 251
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: set bootable Overview: Set the bootable field of the given VBD. Signature: void set_bootable (session_id s, VBD ref self, bool value) Arguments: type VBD ref bool name description self reference to the object value New value to set Return - HP BL680c | XenEnterprise Management API - Page 252
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: get type Overview: Get the type field of the given VBD. Signature: (vbd_type) get_type (session_id s, VBD ref self) Arguments: type name description VBD ref self reference to the object Return Type: vbd type value of the field RPC name: set type - HP BL680c | XenEnterprise Management API - Page 253
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: set unpluggable Overview: Set the unpluggable field of the given VBD. Signature: void set_unpluggable (session_id s, VBD ref self, bool value) Arguments: type VBD ref bool name description self reference to the object value New value to set - HP BL680c | XenEnterprise Management API - Page 254
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given VBD. Signature: ((string -> string) Map) get_other_config (session_id s, VBD ref self) Arguments: type name description VBD ref self reference to the object Return Type: (string → - HP BL680c | XenEnterprise Management API - Page 255
: type name description VBD ref self reference to the object Return Type: bool value of the field RPC name: get status code Overview: Get the status code field of the given VBD. Signature: int get_status_code (session_id s, VBD ref self) Arguments: type name description VBD ref self reference to - HP BL680c | XenEnterprise Management API - Page 256
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: get status detail Overview: Get the status detail field of the given VBD. Signature: string get_status_detail (session_id s, VBD ref self) Arguments: type name description VBD ref self reference to the object Return Type: string value of the field - HP BL680c | XenEnterprise Management API - Page 257
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: set qos algorithm type Overview: Set the qos/algorithm type field of the given VBD. Signature: void set_qos_algorithm_type (session_id s, VBD ref self, string value) Arguments: type VBD ref string name description self reference to the object - HP BL680c | XenEnterprise Management API - Page 258
string name description self reference to the object key Key to remove Return Type: void RPC name: get qos supported algorithms Overview: Get the qos/supported algorithms field of the given VBD. Signature: (string Set) get_qos_supported_algorithms (session_id s, VBD ref self) Arguments: type name - HP BL680c | XenEnterprise Management API - Page 259
2.27. CLASS: VBD CHAPTER 2. API REFERENCE RPC name: get metrics Overview: Get the metrics field of the given VBD. Signature: (VBD_metrics ref) get_metrics (session_id s, VBD ref self) Arguments: type name description VBD ref self reference to the object Return Type: VBD metrics ref value of the fi - HP BL680c | XenEnterprise Management API - Page 260
2.27. CLASS: VBD CHAPTER 2. API REFERENCE (VBD ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return Type: VBD ref reference to the object RPC name: get record Overview: Get a record containing the current state of the given VBD. - HP BL680c | XenEnterprise Management API - Page 261
identifier/object reference io/read kbs float Read bandwidth (KiB/s) io/write kbs float Write bandwidth (KiB/s) last updated datetime Time at which this information was last updated 2.28.2 RPCs associated with class: VBD metrics RPC name: get all Overview: Return a list of all the VBD metrics - HP BL680c | XenEnterprise Management API - Page 262
VBD metrics ref self reference to the object Return Type: float value of the field RPC name: get last updated Overview: Get the last updated field of the given VBD metrics. Signature: datetime get_last_updated (session_id s, VBD_metrics ref self) Arguments: type name description VBD metrics - HP BL680c | XenEnterprise Management API - Page 263
2.28. CLASS: VBD METRICS CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the VBD metrics instance with the specified UUID. Signature: (VBD_metrics ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return - HP BL680c | XenEnterprise Management API - Page 264
: void plug (session_id s, PBD ref self) Arguments: type name description PBD ref self The PBD to activate Return Type: void Possible Error Codes: SR UNKNOWN DRIVER RPC name: unplug Overview: Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned. Signature: void - HP BL680c | XenEnterprise Management API - Page 265
2.29. CLASS: PBD CHAPTER 2. API REFERENCE RPC name: set device config Overview: Sets the PBD's device config field. Signature: void set_device_config (session_id s, PBD ref self, (string -> string) Map value) Arguments: type PBD ref (string → string) Map name description self The PBD to modify - HP BL680c | XenEnterprise Management API - Page 266
2.29. CLASS: PBD value of the field CHAPTER 2. API REFERENCE RPC name: get host Overview: Get the host field of the given PBD. Signature: (host ref) get_host (session_id s, PBD ref self) Arguments: type name description PBD ref self reference to the object Return Type: host ref value of the field - HP BL680c | XenEnterprise Management API - Page 267
2.29. CLASS: PBD CHAPTER 2. API REFERENCE RPC name: get currently attached Overview: Get the currently attached field of the given PBD. Signature: bool get_currently_attached (session_id s, PBD ref self) Arguments: type name description PBD ref self reference to the object Return Type: bool value - HP BL680c | XenEnterprise Management API - Page 268
2.29. CLASS: PBD CHAPTER 2. API REFERENCE RPC name: add to other config Overview: Add the given key-value pair to the other config field of the given PBD. Signature: void add_to_other_config (session_id s, PBD ref self, string key, string value) Arguments: type PBD ref string string name self - HP BL680c | XenEnterprise Management API - Page 269
2.29. CLASS: PBD RPC name: destroy Overview: Destroy the specified PBD instance. Signature: void destroy (session_id s, PBD ref self) Arguments: type name description PBD ref self reference to the object Return Type: void CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to - HP BL680c | XenEnterprise Management API - Page 270
2.30. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE 2.30 Class: crashdump 2.30.1 Fields for class: crashdump Name Description Quals RO run RO ins RO ins RW crashdump A VM crashdump. Field Type uuid string VM VM ref VDI VDI ref other config (string → string) Map Description unique identifi - HP BL680c | XenEnterprise Management API - Page 271
2.30. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE RPC name: get uuid Overview: Get the uuid field of the given crashdump. Signature: string get_uuid (session_id s, crashdump ref self) Arguments: type name description crashdump ref self reference to the object Return Type: string value of the fi - HP BL680c | XenEnterprise Management API - Page 272
2.30. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given crashdump. Signature: ((string -> string) Map) get_other_config (session_id s, crashdump ref self) Arguments: type name description crashdump ref self reference to the - HP BL680c | XenEnterprise Management API - Page 273
2.30. CLASS: CRASHDUMP CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field of the given crashdump. If the key is not in that Map, then do nothing. Signature: void remove_from_other_config (session_id s, - HP BL680c | XenEnterprise Management API - Page 274
2.31. CLASS: VTPM CHAPTER 2. API REFERENCE 2.31 Class: VTPM 2.31.1 Fields for class: VTPM Name Description Quals RO run RO ins RO ins VTPM A virtual TPM device. Field Type Description uuid string unique identifier/object reference VM VM ref the virtual machine backend VM ref the domain - HP BL680c | XenEnterprise Management API - Page 275
2.31. CLASS: VTPM Arguments: type name description VTPM ref self reference to the object Return Type: VM ref value of the field CHAPTER 2. API REFERENCE RPC name: create Overview: Create a new VTPM instance, and return its handle. Signature: (VTPM ref) create (session_id s, VTPM record args) - HP BL680c | XenEnterprise Management API - Page 276
2.31. CLASS: VTPM reference to the object CHAPTER 2. API REFERENCE RPC name: get record Overview: Get a record containing the current state of the given VTPM. Signature: (VTPM record) get_record (session_id s, VTPM ref self) Arguments: type name description VTPM ref self reference to the object - HP BL680c | XenEnterprise Management API - Page 277
identifier/object reference the protocol used by this console URI for the console service VM to which this console is attached additional configuration port in dom0 on which the console server is listening 2.32.2 RPCs associated with class: console RPC name: get all Overview: Return a list of all - HP BL680c | XenEnterprise Management API - Page 278
2.32. CLASS: CONSOLE Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: get protocol Overview: Get the protocol field of the given console. - HP BL680c | XenEnterprise Management API - Page 279
2.32. CLASS: CONSOLE CHAPTER 2. API REFERENCE RPC name: get other config Overview: Get the other config field of the given console. Signature: ((string -> string) Map) get_other_config ( - HP BL680c | XenEnterprise Management API - Page 280
2.32. CLASS: CONSOLE CHAPTER 2. API REFERENCE RPC name: remove from other config Overview: Remove the given key and its corresponding value from the other config field - HP BL680c | XenEnterprise Management API - Page 281
2.32. CLASS: CONSOLE CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the console instance with the specified UUID. Signature: (console ref) - HP BL680c | XenEnterprise Management API - Page 282
2.33. CLASS: USER CHAPTER 2. API REFERENCE 2.33 Class: user 2.33.1 Fields for class: user Name Description Quals RO run RO ins RW user A user of the system. Field Type Description uuid string unique identifier/object reference short name string short name (e.g. userid) fullname string full - HP BL680c | XenEnterprise Management API - Page 283
2.33. CLASS: USER Arguments: type name description user ref self reference to the object Return Type: string value of the field CHAPTER 2. API REFERENCE RPC name: set fullname Overview: Set the fullname field of the given user. Signature: void set_fullname (session_id s, user ref self, string - HP BL680c | XenEnterprise Management API - Page 284
2.33. CLASS: USER Return Type: void CHAPTER 2. API REFERENCE RPC name: get by uuid Overview: Get a reference to the user instance with the specified UUID. Signature: (user ref) get_by_uuid (session_id s, string uuid) Arguments: type name description string uuid UUID of object to return Return Type: - HP BL680c | XenEnterprise Management API - Page 285
the server may send an XML-RPC Fault response, or the client may simulate the same. The client must be prepared to handle these errors, array of string values. The first element of the array is an error code; the remainder of the array are strings representing error parameters relating to that code - HP BL680c | XenEnterprise Management API - Page 286
Error Codes BACKUP SCRIPT FAILED The backup could not be performed because the backup script failed. No parameters. BOOTLOADER FAILED The bootloader returned an error cannot be evacuated. Signature: CANNOT_EVACUATE_HOST(errors) CANNOT FETCH PATCH The requested update could to be obtained from the - HP BL680c | XenEnterprise Management API - Page 287
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE CANNOT FIND PATCH The requested update could not be found. This can occur when you designate a new master or xe patch-clean. Please upload the update again No parameters. CANNOT FIND STATE PARTITION This operation could not be performed because the - HP BL680c | XenEnterprise Management API - Page 288
2.34. ERROR HANDLING DEVICE ALREADY ATTACHED The device is already attached to a VM Signature: DEVICE_ALREADY_ATTACHED(device) CHAPTER 2. API REFERENCE DEVICE ALREADY DETACHED The device is not currently - HP BL680c | XenEnterprise Management API - Page 289
a duplicate Signature: DUPLICATE_VM(vm) EVENTS LOST Some events have been lost from the queue and cannot be retrieved. No parameters. FIELD TYPE ERROR The value specified is of the wrong type Signature: FIELD_TYPE_ERROR(field) HANDLE INVALID You gave an invalid object reference. The object may - HP BL680c | XenEnterprise Management API - Page 290
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE HA HOST IS ARMED The operation could not be performed while the host is still armed; it must be disarmed first - HP BL680c | XenEnterprise Management API - Page 291
2.34. ERROR HANDLING HOSTS NOT HOMOGENEOUS The hosts in this pool are not homogeneous. Signature: HOSTS_NOT_HOMOGENEOUS(reason) CHAPTER 2. API REFERENCE HOST BROKEN This host failed in the - HP BL680c | XenEnterprise Management API - Page 292
34. ERROR HANDLING that it cannot talk back to the slave on the supplied management IP address. Signature: HOST_MASTER_CANNOT_TALK_BACK(ip) HOST NOT is not disabled. No parameters. HOST NOT ENOUGH FREE MEMORY Not enough host memory is available to perform this operation No parameters. HOST - HP BL680c | XenEnterprise Management API - Page 293
master says the host is not known to it. Perhaps the Host was deleted from the master's database? Signature: HOST_UNKNOWN_TO_MASTER(host) IMPORT ERROR The VM could not be imported; is the file corrupt? Signature: IMPORT_ERROR(msg) IMPORT INCOMPATIBLE VERSION The import failed because this export - HP BL680c | XenEnterprise Management API - Page 294
HANDLING CHAPTER 2. API REFERENCE INTERNAL ERROR The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem. Signature: INTERNAL_ERROR(message) INVALID DEVICE The device name is invalid Signature: INVALID_DEVICE(device - HP BL680c | XenEnterprise Management API - Page 295
pool. No parameters. JOINING HOST SERVICE FAILED There was an error connecting to the host. the service contacted didn't reply properly. No parameters. LICENCE RESTRICTION This operation is not allowed under your license. Please contact your support representative. No parameters. LICENSE CANNOT - HP BL680c | XenEnterprise Management API - Page 296
allow it No parameters. LICENSE EXPIRED Your license has expired. Please contact your support representative. No parameters. LICENSE PROCESSING ERROR There was an error processing your license. Please contact your support representative. No parameters. LOCATION NOT UNIQUE A VDI with the specified - HP BL680c | XenEnterprise Management API - Page 297
2.34. ERROR HANDLING MAC STILL EXISTS The MAC address specified still exists on this host. Signature: MAC_STILL_EXISTS(MAC) CHAPTER 2. API REFERENCE MAP DUPLICATE KEY You tried - HP BL680c | XenEnterprise Management API - Page 298
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE NETWORK CONTAINS PIF The network contains active EMERGENCY MODE This pool is not in emergency mode. No parameters. NOT SUPPORTED DURING UPGRADE This operation is not supported during an upgrade No parameters. NO HOSTS AVAILABLE There were no hosts - HP BL680c | XenEnterprise Management API - Page 299
2.34. ERROR HANDLING OBJECT NOLONGER EXISTS The specified object no longer exists. No parameters. ONLY ALLOWED ON OEM EDITION This command is only allowed on the - HP BL680c | XenEnterprise Management API - Page 300
precheck stage failed with an unknown error. See attached info for more details. Signature: PATCH_PRECHECK_FAILED_UNKNOWN_ERROR(patch, info) PATCH PRECHECK FAILED VM RUNNING The patch precheck stage failed: there are one or more VMs still running on the server. All VMs must be suspended before - HP BL680c | XenEnterprise Management API - Page 301
member interfaces No parameters. PIF CANNOT BOND CROSS HOST You cannot bond interfaces across different hosts. No parameters. PIF CONFIGURATION ERROR An unknown error occurred while attempting to configure an interface. Signature: PIF_CONFIGURATION_ERROR(PIF, msg) PIF DEVICE NOT FOUND The specified - HP BL680c | XenEnterprise Management API - Page 302
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE PIF HAS NO NETWORK CONFIGURATION PIF has no IP configuration (mode curently set to 'none') No parameters. PIF IS MANAGEMENT INTERFACE PIF is the management interface. Signature: PIF_IS_MANAGEMENT_INTERFACE(PIF) - HP BL680c | XenEnterprise Management API - Page 303
. SESSION INVALID You gave an invalid session reference. It may have been invalidated by a server restart, or timed out. You should get a new session handle, using one of the session.login calls. This error does not invalidate the current connection. The handle parameter echoes the bad value given - HP BL680c | XenEnterprise Management API - Page 304
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE SESSION NOT REGISTERED This session is not registered to receive events. You must call event.register before event.next. The session - HP BL680c | XenEnterprise Management API - Page 305
2.34. ERROR HANDLING SR HAS NO PBDS The SR has no attached PBDs Signature: (sr, host) SR OPERATION NOT SUPPORTED The SR backend does not support the operation (check the SR's allowed operations) Signature: SR_OPERATION_NOT_SUPPORTED(sr) SR UNKNOWN DRIVER The SR could not be connected - HP BL680c | XenEnterprise Management API - Page 306
2.34. ERROR HANDLING SR UUID EXISTS An host failed. A diagnostic reason suitable for support organisations is also returned. Signature: SYSTEM_STATUS_RETRIEVAL_FAILED(reason TASK_CANCELLED(task) TOO BUSY The request was rejected because the server is too busy. No parameters. TOO MANY PENDING TASKS - HP BL680c | XenEnterprise Management API - Page 307
. ERROR HANDLING UNKNOWN BOOTLOADER The requested bootloader is unknown Signature: UNKNOWN_BOOTLOADER(vm, bootloader) CHAPTER 2. API REFERENCE UUID INVALID The uuid you supplied was invalid. Signature: UUID_INVALID(type, uuid) VALUE NOT SUPPORTED You attempted to set a value that is not supported - HP BL680c | XenEnterprise Management API - Page 308
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE VBD NOT REMOVABLE MEDIA Media could not be ejected because it is not removable Signature: VBD_NOT_REMOVABLE_MEDIA(vbd) VBD NOT UNPLUGGABLE Drive could not be hot-unplugged because it is not marked as unpluggable Signature: VBD_NOT_UNPLUGGABLE(vbd) - HP BL680c | XenEnterprise Management API - Page 309
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE VDI LOCATION MISSING This operation cannot be performed because the specified VDI could not be found in the specified - HP BL680c | XenEnterprise Management API - Page 310
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE VM BAD POWER STATE You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected - HP BL680c | XenEnterprise Management API - Page 311
The specified VM has too little memory to be started. Signature: VM_MEMORY_SIZE_TOO_LOW(vm) CHAPTER 2. API REFERENCE VM MIGRATE FAILED An error occurred during the migration process. Signature: VM_MIGRATE_FAILED(vm, source, destination, msg) VM MISSING PV DRIVERS You attempted an operation on a VM - HP BL680c | XenEnterprise Management API - Page 312
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE VM OLD PV DRIVERS You attempted an operation on a VM which requires a more recent version of the PV drivers. Please upgrade your PV drivers. Signature: VM_OLD_PV_DRIVERS(vm, major, minor) VM REQUIRES NETWORK You attempted to run a VM on a host which - HP BL680c | XenEnterprise Management API - Page 313
2.34. ERROR HANDLING CHAPTER 2. API REFERENCE VM UNSAFE BOOT You attempted an operation on a VM that was judged to be unsafe by the server. This can happen if ' option. Signature: VM_UNSAFE_BOOT(vm) XMLRPC UNMARSHAL FAILURE The server failed to unmarshal the XMLRPC message; it was expecting one
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
 |
 |
XenEnterprise Management API
API Revision 1.1
XenEnterprise Management API
Version: API Revision 1.1
Date: 16th August 2007
Copyright c
°
2007 XenSource Inc, All Rights Reserved.