1. DL manuals
  2. XenSource
  3. Desktop
  4. DL385 - ProLiant - G5
  5. Manual

XenSource DL385 - ProLiant - G5 Manual

Manual is about: XenEnterprise Management API

Summary of DL385 - ProLiant - G5

  • 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..

  • Page 2

    Contents 1 introduction 5 1.1 rpcs associated with fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.2 rpcs associated with classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.2.1 additional rpcs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ....

  • 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....

  • Page 4

    Contents contents 2.28.2 rpcs associated with class: vbd metrics . . . . . . . . . . . . . . . . . . . 261 2.29 class: pbd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 2.29.1 fields for class: pbd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264 ...

  • Page 5

    Chapter 1 introduction this document defines the xenenterprise management api—an api for remotely configuring and controlling virtualised guests running on a xen-enabled cluster. The api is presented here as a set of remote procedure calls, with a wire format based upon xml-rpc. No specific language...

  • Page 6

    1.1. Rpcs associated with fields chapter 1. Introduction 1.1 rpcs associated with fields each field, f, has an rpc accessor associated with it that returns f’s value: • “get f(ref x)”: takes a ref that refers to an object and returns the value of f. Each field, f, with attribute rw and whose outermo...

  • Page 7

    1.3. Wire protocol for remote api calls chapter 1. Introduction 1.3 wire protocol for remote api calls api calls are sent over a network to a xen-enabled host using the xml-rpc protocol. In this section we describe how the higher-level types used in our api reference are mapped to primitive xml-rpc ...

  • Page 8

    1.3. Wire protocol for remote api calls chapter 1. Introduction john 1.2 • our void type is transmitted as an empty string. 1.3.1 note on references vs uuids references are opaque types — encoded as xml-rpc strings on the wire — understood only by the particular server which generated them. Servers ...

  • Page 9

    1.4. Making xml-rpc calls chapter 1. Introduction value 81547a35-205c-a551-c577-00b982c5fe00 61c85a22-05da-b8a2-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 administra...

  • Page 10

    1.5. Example interactive session chapter 1. Introduction returns a set of 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 task object in the usual way. Note that, in order to get a consiste...

  • Page 11

    1.5. Example interactive session chapter 1. Introduction in this case the start message has been rejected, 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-rpc faults), allowing them to be internatio...

  • Page 12

    1.6. Vm lifecycle chapter 1. Introduction powered down paused start(paused=true) running start(paused=false) resume suspended suspend cleanshutdown / hardshutdown pause suspend resume(paused=true) resume(paused=false) figure 1.1: vm lifecycle 1.6 vm lifecycle figure 1.1 shows the states that a vm ca...

  • 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.

  • Page 14

    Chapter 2 api reference 2.1 classes the following classes are defined: name description session a session task a long-running asynchronous task event asynchronous event registration and handling pool pool-wide information pool patch pool-wide patches vm a virtual machine (or ’guest’) vm metrics the ...

  • 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 object.Field relationship pif.Bond slave of bond.Slaves one-to-many pif.Bond master of bond.Master many-to-one pif.Vlan slave of...

  • 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 description string text strings int 64-bit integers float ieee double-precision floating-point numbers bool boolea...

  • Page 17

    2.3. Types chapter 2. Api reference enum vdi operations scan scanning backends for new or deleted vdis clone cloning the vdi copy copying the vdi resize resizing the vdi snapshot snapshotting the vdi destroy destroying the vdi forget forget about the vdi force unlock forcibly unlocking the vdi enum ...

  • Page 18

    2.3. Types chapter 2. Api reference halted vm is offline and not using any resources paused all resources have been allocated but the vm itself is paused and its vcpus are not running running running suspended vm state has been saved to disk and it is nolonger running. Note that disks remain in-use ...

  • Page 19

    2.3. Types chapter 2. Api reference migrate refers to the operation “migrate” statistics refers to the operation “statistics” get boot record refers to the operation “get boot record” send sysrq refers to the operation “send sysrq” send trigger refers to the operation “send trigger” changing memory ...

  • 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

  • Page 21

    2.4. Class: session chapter 2. Api reference 2.4 class: session 2.4.1 fields for class: session name session description a session. Quals field type description ro run uuid string unique identifier/object reference ro run this host host ref currently connected host ro run this user user ref currentl...

  • Page 22

    2.4. Class: session chapter 2. Api reference void change_password (session_id s, string old_pwd, string new_pwd) arguments: type name description string old pwd old password for account string new pwd new password for account return type: void rpc name: get uuid overview: get the uuid field of the g...

  • Page 23

    2.4. Class: session chapter 2. Api reference arguments: type name description session ref self reference to the object return type: user ref value of the field rpc name: get last active overview: get the last active field of the given session. Signature: datetime get_last_active (session_id s, sessi...

  • Page 24

    2.4. Class: session chapter 2. Api reference return type: (string → string) map value of the field 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 nam...

  • 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 re...

  • Page 26

    2.5. Class: task chapter 2. Api reference 2.5 class: task 2.5.1 fields for class: task name task description a long-running asynchronous task. Quals field type description ro run uuid string unique identifier/object reference ro run name/label string a human-readable name ro run name/description str...

  • Page 27

    2.5. Class: task chapter 2. Api reference ro run error info string set if the task has failed, this field contains the set of associated error strings. Undefined otherwise. Rw other config (string → string) map additional configuration 2.5.2 rpcs associated with class: task rpc name: create overview...

  • Page 28

    2.5. Class: task chapter 2. Api reference 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 type: (task ref) set references to all objects rpc name: get all records ove...

  • Page 29

    2.5. Class: task chapter 2. Api reference arguments: type name description task ref self reference to the object return type: string value of the field rpc name: get name description overview: get the name/description field of the given task. Signature: string get_name_description (session_id s, tas...

  • 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 refer...

  • 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 fie...

  • Page 32

    2.5. Class: task chapter 2. Api reference rpc name: get result overview: get the result field of the given task. Signature: string get_result (session_id s, task ref self) arguments: type name description task ref self reference to the object return type: string value of the field rpc name: get erro...

  • 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 name description task ref self reference to the object (string → s...

  • 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 ...

  • Page 35

    2.6. Class: event chapter 2. Api reference 2.6 class: event 2.6.1 fields for class: event name event description asynchronous event registration and handling. Quals field type description ro ins id int an id, monotonically increasing, and local to the current session ro ins timestamp datetime the ti...

  • Page 36

    2.6. Class: event chapter 2. Api reference rpc name: next overview: blocking call which 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 n...

  • Page 37

    2.7. Class: pool chapter 2. Api reference 2.7 class: pool 2.7.1 fields for class: pool name pool description pool-wide information. Quals field type description ro run uuid string unique identifier/object reference rw name label string short name rw name description string description ro run master ...

  • Page 38

    2.7. Class: pool chapter 2. Api reference return type: void rpc name: eject overview: instruct a pool master to eject a host from the pool. Signature: void eject (session_id s, host ref host) arguments: type name description host ref host the host to eject return type: void rpc name: emergency trans...

  • Page 39

    2.7. Class: pool chapter 2. Api reference return type: (host ref) set list of hosts whose master address were succesfully reset rpc name: create vlan overview: create pifs, mapping a network to the same physical interface/vlan on each host. Signature: ((pif ref) set) create_vlan (session_id s, strin...

  • Page 40

    2.7. Class: pool chapter 2. Api reference rpc name: sync database overview: forcibly synchronise the database now. Signature: void sync_database (session_id s) return type: void rpc name: designate new master overview: perform an orderly handover of the role of master to the referenced host. Signatu...

  • 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 label...

  • Page 42

    2.7. Class: pool chapter 2. Api reference rpc name: get name description overview: get the name description field of the given pool. Signature: string get_name_description (session_id s, pool ref self) arguments: type name description pool ref self reference to the object return type: string value o...

  • 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 ...

  • 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 name description pool ref self reference to the object sr ref value ne...

  • 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 ...

  • 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 self...

  • 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 pool patch description pool-wide patches. Quals field type description ro run uuid string unique identifier/object reference ro ins name/label string a human-readable name ro ins name/descri...

  • 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 name description pool patch ref self the patch ...

  • 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 map ...

  • Page 50

    2.8. Class: pool patch chapter 2. Api reference return type: string value of the field 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 pool pat...

  • 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 type: bool...

  • 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 obje...

  • 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, p...

  • 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 return...

  • Page 55

    2.9. Class: vm chapter 2. Api reference 2.9 class: vm 2.9.1 fields for class: vm name vm description a virtual machine (or ’guest’). Quals field type description ro run uuid string unique identifier/object reference ro run allowed operations (vm operations) set list of the operations allowed in this...

  • Page 56

    2.9. Class: vm chapter 2. Api reference rw vcpus/max int max number of vcpus rw vcpus/at startup int boot number of vcpus rw actions/after shutdown on normal exit action to take after the guest has shutdown itself rw actions/after reboot on normal exit action to take after the guest has re- booted i...

  • Page 57

    2.9. Class: vm chapter 2. Api reference clones the specified vm, making a new vm. Clone automatically exploits the capabilities of the underlying storage repository in which the vm’s disk images are stored (e.G. Copy on write). This function can only be called when the vm is in the halted state. Sig...

  • Page 58

    2.9. Class: vm chapter 2. Api reference return type: void possible error codes: vm bad power state , sr full, operation not allowed rpc name: start overview: start the specified vm. This function can only be called with the vm is in the halted state. Signature: void start (session_id s, vm ref vm, b...

  • Page 59

    2.9. Class: vm chapter 2. Api reference rpc name: pause overview: pause the specified vm. This can only be called when the specified vm is in the running state. Signature: void pause (session_id s, vm ref vm) arguments: type name description vm ref vm the vm to pause return type: void possible error...

  • Page 60

    2.9. Class: vm chapter 2. Api reference rpc name: clean reboot overview: attempt to cleanly shutdown the specified vm (note: this may not be 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_reboot (session...

  • Page 61

    2.9. Class: vm chapter 2. Api reference rpc 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: v...

  • Page 62

    2.9. Class: vm chapter 2. Api reference return type: void possible error codes: vm bad power state , operation not allowed, vm is template rpc name: resume on overview: awaken the specified vm and resume it on a particular host. This can only be called when the specified vm is in the suspended state...

  • Page 63

    2.9. Class: vm chapter 2. Api reference void set_vcpus_number_live (session_id s, vm ref self, int nvcpu) arguments: type name description vm ref self the vm int nvcpu the number of vcpus return type: void rpc name: add to vcpus params live overview: add the given key-value pair to vm.Vcpus params, ...

  • Page 64

    2.9. Class: vm chapter 2. Api reference arguments: type name description vm ref self the vm float multiplier the new shadow multiplier to set return type: void rpc name: send sysrq overview: send the given key as a sysrq to this vm. The key is specified as a single character (a string of length 1). ...

  • Page 65

    2.9. Class: vm chapter 2. Api reference int maximise_memory (session_id s, vm ref self, int total, bool approximate) arguments: type name description vm ref self the vm int total total amount of physical ram to fit within bool approximate if false the limit is calculated with the guest’s current exa...

  • 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 the object return type: void rpc name: g...

  • Page 67

    2.9. Class: vm chapter 2. Api reference ((host ref) set) get_possible_hosts (session_id s, vm ref vm) arguments: type name description vm ref vm the vm return type: (host ref) set the possible hosts rpc name: assert can boot here overview: returns an error if the vm could not boot on this host for s...

  • Page 68

    2.9. Class: vm chapter 2. Api reference return type: (vm ref) set references to all objects 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 → vm...

  • Page 69

    2.9. Class: vm chapter 2. Api reference rpc name: get current operations overview: get the current operations field of the given vm. Signature: ((string -> vm_operations) map) get_current_operations (session_id s, vm ref self) arguments: type name description vm ref self reference to the object retu...

  • 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 name description vm ref self reference to the object string value new value to set return type...

  • 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 ...

  • 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 name description vm ref self reference to the object bool value new value to set return...

  • Page 73

    2.9. Class: vm chapter 2. Api reference rpc name: get affinity overview: get the affinity field of the given vm. Signature: (host ref) get_affinity (session_id s, vm ref self) arguments: type name description vm ref self reference to the object return type: host ref value of the field rpc name: set ...

  • Page 74

    2.9. Class: vm chapter 2. Api reference rpc name: set memory static max overview: set the memory/static max field of the given vm. Signature: void set_memory_static_max (session_id s, vm ref self, int value) arguments: type name description vm ref self reference to the object int value new value to ...

  • Page 75

    2.9. Class: vm chapter 2. Api reference rpc name: get memory dynamic min overview: get the memory/dynamic min field of the given vm. Signature: int get_memory_dynamic_min (session_id s, vm ref self) arguments: type name description vm ref self reference to the object return type: int value of the fi...

  • 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 name description vm ref self reference to the object int value new value to ...

  • 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 name description vm ref self reference to ...

  • 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 name description vm ref self reference to the object int value new value to set return type: void rp...

  • 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 ...

  • 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 name description vm ref self reference to the object on ...

  • 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...

  • 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 va...

  • 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 name description vm ref self reference to the object string value new value to set re...

  • 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 ...

  • 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 name description vm ref self reference to the object string value new value to set return type: void rp...

  • 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 rp...

  • 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 name description vm ref self reference to the object string value new value to ...

  • 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 name description vm ref self refe...

  • 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 name description vm ref self reference to the object float val...

  • 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 name description vm ref self reference to the object s...

  • 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 name description vm ref self reference to the object string value new value to set return type: void rp...

  • 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 name description vm ref self reference to ...

  • 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 boot...

  • 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 n...

  • 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...

  • 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 name description vm ref self reference to the object (string → string...

  • 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 created o...

  • 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 ...

  • Page 99

    2.10. Class: vm metrics chapter 2. Api reference 2.10 class: vm metrics 2.10.1 fields for class: vm metrics name vm metrics description the metrics associated with a vm. Quals field type description ro run uuid string unique identifier/object reference ro run memory/actual int guest’s actual memory ...

  • Page 100

    2.10. Class: vm metrics chapter 2. Api reference rpc name: get uuid overview: get the uuid field of the given vm metrics. Signature: string get_uuid (session_id s, vm_metrics ref self) arguments: type name description vm metrics ref self reference to the object return type: string value of the field...

  • 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 reference...

  • 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 objec...

  • Page 103

    2.10. Class: vm metrics chapter 2. Api reference rpc name: get install time overview: get the install time field of the given vm metrics. Signature: datetime get_install_time (session_id s, vm_metrics ref self) arguments: type name description vm metrics ref self reference to the object return type:...

  • 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 the objec...

  • Page 105

    2.11. Class: vm guest metrics chapter 2. Api reference 2.11 class: vm guest metrics 2.11.1 fields for class: vm guest metrics name vm guest metrics description the metrics reported by the guest (as opposed to inferred from outside). Quals field type description ro run uuid string unique identifier/o...

  • Page 106

    2.11. Class: vm guest metrics chapter 2. Api reference arguments: type name description vm guest metrics ref self reference to the object return type: string value of the field rpc name: get os version overview: get the os version field of the given vm guest metrics. Signature: ((string -> string) m...

  • Page 107

    2.11. Class: vm guest metrics chapter 2. Api reference return type: bool value of the field 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 description vm ...

  • Page 108

    2.11. Class: vm guest metrics chapter 2. Api reference rpc name: get other overview: get the other field of the given vm guest metrics. Signature: ((string -> string) map) get_other (session_id s, vm_guest_metrics ref self) arguments: type name description vm guest metrics ref self reference to the ...

  • 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 metrics r...

  • Page 110

    2.12. Class: host chapter 2. Api reference 2.12 class: host 2.12.1 fields for class: host name host description a physical host. Quals field type description ro run uuid string unique identifier/object reference rw name/label string a human-readable name rw name/description string a notes field cont...

  • 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 started. Currently active vms on the host continue to execute. Signature: void disable ...

  • 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 hos...

  • Page 113

    2.12. Class: host chapter 2. Api reference rpc name: get log overview: get the host’s log file. Signature: string get_log (session_id s, host ref host) arguments: type name description host ref host the host to query return type: string the contents of the host’s primary log file rpc name: send debu...

  • Page 114

    2.12. Class: host chapter 2. Api reference rpc name: list methods overview: list all supported methods. Signature: (string set) list_methods (session_id s) return type: string set the name of every supported method. Rpc name: license apply overview: apply a new license to a host. Signature: void lic...

  • Page 115

    2.12. Class: host chapter 2. Api reference arguments: type name description host ref host the host to evacuate return type: void 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 de...

  • 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 (sessio...

  • Page 117

    2.12. Class: host chapter 2. Api reference arguments: type name description host ref host the host whose host name to set string 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 (session_i...

  • 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 n...

  • 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 name description host ref self reference to the object string value n...

  • 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 ...

  • 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 descrip...

  • 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...

  • 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 sel...

  • Page 124

    2.12. Class: host chapter 2. Api reference rpc name: get sched policy overview: get the sched policy field of the given host. Signature: string get_sched_policy (session_id s, host ref self) arguments: type name description host ref self reference to the object return type: string value of the field...

  • 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 ...

  • 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 key) ...

  • 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 name description host ref self reference to the object sr ref value n...

  • 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 crash...

  • 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 v...

  • 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 ...

  • 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: (...

  • 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 ref)...

  • 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 host crashdump description represents a host crash dump. Quals field type description ro run uuid string unique identifier/object reference ro ins host host ref host the crash...

  • 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 known...

  • 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 object retur...

  • 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 name description host crashdump ref...

  • 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 r...

  • Page 138

    2.14. Class: host patch chapter 2. Api reference 2.14 class: host patch 2.14.1 fields for class: host patch name host patch description represents a patch stored on a server. Quals field type description ro run uuid string unique identifier/object reference ro ins name/label string a human-readable ...

  • 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 map...

  • Page 140

    2.14. Class: host patch chapter 2. Api reference return type: string value of the field 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 host pa...

  • 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 of the ...

  • 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 return typ...

  • 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 name description ...

  • 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 the objec...

  • Page 145

    2.15. Class: host metrics chapter 2. Api reference 2.15 class: host metrics 2.15.1 fields for class: host metrics name host metrics description the metrics associated with a host. Quals field type description ro run uuid string unique identifier/object reference ro run memory/total int host’s total ...

  • Page 146

    2.15. Class: host metrics chapter 2. Api reference return type: string value of the field rpc name: get memory total overview: get the memory/total field of the given host metrics. Signature: int get_memory_total (session_id s, host_metrics ref self) arguments: type name description host metrics ref...

  • 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 object retu...

  • 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 host cpu description a physical cpu. Quals field type description ro run uuid string unique identifier/object reference ro run host host ref the host the cpu is in ro run number int the number ...

  • 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 rpc nam...

  • 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 field r...

  • 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 rpc nam...

  • 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 rpc ...

  • 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 c...

  • Page 154

    2.17. Class: network chapter 2. Api reference 2.17 class: network 2.17.1 fields for class: network name network description a virtual network. Quals field type description ro run uuid string unique identifier/object reference rw name/label string a human-readable name rw name/description string a no...

  • 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 name: g...

  • 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 type: s...

  • 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 self re...

  • 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 return t...

  • 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, networ...

  • 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 overview: get a...

  • 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.

  • Page 162

    2.18. Class: vif chapter 2. Api reference 2.18 class: vif 2.18.1 fields for class: vif name vif description a virtual network interface. Quals field type description ro run uuid string unique identifier/object reference ro run allowed operations (vif operations) set list of the operations allowed in...

  • Page 163

    2.18. Class: vif chapter 2. Api reference type name description vif ref self the vif to hotplug return type: void 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 descript...

  • Page 164

    2.18. Class: vif chapter 2. Api reference arguments: type name description vif ref self reference to the object return type: string value of the field rpc name: get allowed operations overview: get the allowed operations field of the given vif. Signature: ((vif_operations) set) get_allowed_operation...

  • Page 165

    2.18. Class: vif chapter 2. Api reference return type: string value of the field 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...

  • Page 166

    2.18. Class: vif chapter 2. Api reference 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 rpc name: get other config overview:...

  • 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 name description vif ref self referenc...

  • 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: int value of the field rpc name: ge...

  • 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 valu...

  • 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 name description vif ref self reference to t...

  • 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 ...

  • Page 172

    2.18. Class: vif chapter 2. Api reference 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 rpc name: get by uuid overview: get a reference to th...

  • Page 173

    2.19. Class: vif metrics chapter 2. Api reference 2.19 class: vif metrics 2.19.1 fields for class: vif metrics name vif metrics description the metrics associated with a virtual network device. Quals field type description ro run uuid string unique identifier/object reference ro run io/read kbs floa...

  • Page 174

    2.19. Class: vif metrics chapter 2. Api reference value of the field rpc name: get io read kbs overview: get the io/read kbs field of the given vif metrics. Signature: float get_io_read_kbs (session_id s, vif_metrics ref self) arguments: type name description vif metrics ref self reference to the ob...

  • 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 typ...

  • Page 176

    2.20. Class: pif chapter 2. Api reference 2.20 class: pif 2.20.1 fields for class: pif name pif description a physical network interface (note separate vlans are represented as several pifs). Quals field type description ro run uuid string unique identifier/object reference ro ins device string mach...

  • Page 177

    2.20. Class: pif chapter 2. Api reference type name description string device physical interface on which to create the vlan interface network ref network network to which this interface should be con- nected host ref host physical machine to which this pif is con- nected int vlan vlan tag for the n...

  • 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 name: ...

  • Page 179

    2.20. Class: pif chapter 2. Api reference 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 rpc name: get all records overview: return a map of pif references to pif re...

  • Page 180

    2.20. Class: pif chapter 2. Api reference value of the field 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 ...

  • Page 181

    2.20. Class: pif chapter 2. Api reference 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 rpc name: get vlan overview: get the...

  • Page 182

    2.20. Class: pif chapter 2. Api reference rpc name: get physical overview: get the physical field of the given pif. Signature: bool get_physical (session_id s, pif ref self) arguments: type name description pif ref self reference to the object return type: bool value of the field rpc name: get curre...

  • Page 183

    2.20. Class: pif chapter 2. Api reference 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 rpc name: get netmask overview: g...

  • Page 184

    2.20. Class: pif chapter 2. Api reference 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 rpc name: get bond slave of ov...

  • 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 t...

  • 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 → s...

  • 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, ...

  • Page 188

    2.21. Class: pif metrics chapter 2. Api reference 2.21 class: pif metrics 2.21.1 fields for class: pif metrics name pif metrics description the metrics associated with a physical network interface. Quals field type description ro run uuid string unique identifier/object reference ro run io/read kbs ...

  • 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 of the f...

  • 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 value of ...

  • 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: string...

  • Page 192

    2.21. Class: pif metrics chapter 2. Api reference rpc name: get duplex overview: get the duplex field of the given pif metrics. Signature: bool get_duplex (session_id s, pif_metrics ref self) arguments: type name description pif metrics ref self reference to the object return type: bool value of the...

  • 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 typ...

  • Page 194

    2.22. Class: bond chapter 2. Api reference 2.22 class: bond 2.22.1 fields for class: bond name bond description . Quals field type description ro run uuid string unique identifier/object reference ro ins master pif ref the bonded interface ro run slaves (pif ref) set the interfaces which are part of...

  • Page 195

    2.22. Class: bond chapter 2. Api reference 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 rpc name: get all records overview: return a map of bond references to b...

  • Page 196

    2.22. Class: bond chapter 2. Api reference value of the field 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 v...

  • 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 name description bond ref self refe...

  • 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 all...

  • Page 199

    2.23. Class: vlan chapter 2. Api reference 2.23 class: vlan 2.23.1 fields for class: vlan name vlan description a vlan mux/demux. Quals field type description ro run uuid string unique identifier/object reference ro ins tagged pif pif ref interface on which traffic is tagged ro run untagged pif pif ...

  • Page 200

    2.23. Class: vlan chapter 2. Api reference ((vlan ref) set) get_all (session_id s) return type: (vlan ref) set references to all objects 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) g...

  • 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 f...

  • 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 name description vlan ref self reference to the object (string → ...

  • 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 reference...

  • Page 204

    2.24. Class: sm chapter 2. Api reference 2.24 class: sm 2.24.1 fields for class: sm name sm description a storage manager plugin. Quals field type description ro run uuid string unique identifier/object reference ro run name/label string a human-readable name ro run name/description string a notes f...

  • Page 205

    2.24. Class: sm chapter 2. Api reference 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 rpc name: get name label overvi...

  • Page 206

    2.24. Class: sm chapter 2. Api reference 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 rpc name: get vendor overview: ...

  • 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 required...

  • 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 fie...

  • 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 name description sm ref self reference to...

  • 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 from...

  • Page 211

    2.25. Class: sr chapter 2. Api reference 2.25 class: sr 2.25.1 fields for class: sr name sr description a storage repository. Quals field type description ro run uuid string unique identifier/object reference rw name/label string a human-readable name rw name/description string a notes field contain...

  • Page 212

    2.25. Class: sr chapter 2. Api reference type name description host ref host the host to create/make the sr on (string → string) map device config the device config string that will be passed to backend sr driver int physical size the physical size of the new storage repository string name label the...

  • Page 213

    2.25. Class: sr chapter 2. Api reference arguments: type name description host ref host the host to create/make the sr on (string → string) map device config the device config string that will be passed to backend sr driver int physical size the physical size of the new storage repository string nam...

  • Page 214

    2.25. Class: sr chapter 2. Api reference rpc name: get 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 sr types rpc name: scan overview: refreshes the list of vdis ass...

  • 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 name description sr ref sr the sr bool value true if the sr is shared return type: void rpc name: set physical size...

  • 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 name description sr ref self the sr to modify int value the new value of the...

  • Page 217

    2.25. Class: sr chapter 2. Api reference value of the field 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 ...

  • 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 name description sr ref self reference to the object string value new value...

  • 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 p...

  • 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 of...

  • 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 nam...

  • 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 name description sr ref self reference to the object (string → string) ...

  • 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 va...

  • 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) ...

  • 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 ref...

  • Page 226

    2.26. Class: vdi chapter 2. Api reference 2.26 class: vdi 2.26.1 fields for class: vdi name vdi description a virtual disk image. Quals field type description ro run uuid string unique identifier/object reference rw name/label string a human-readable name rw name/description string a notes field con...

  • Page 227

    2.26. Class: vdi chapter 2. Api reference 2.26.2 rpcs associated with class: vdi rpc name: snapshot overview: take a read-only snapshot of the vdi, returning a reference to the snapshot. If any driver params are specified then these are passed through to the storage-specific substrate driver that ta...

  • Page 228

    2.26. Class: vdi chapter 2. Api reference arguments: type name description vdi ref vdi the vdi to resize int size the new size of the vdi return type: void rpc name: introduce overview: create a new vdi record in the database only. Signature: (vdi ref) introduce (session_id s, string uuid, string na...

  • Page 229

    2.26. Class: vdi chapter 2. Api reference type name description string uuid the uuid of the disk to introduce string name label the name of the disk record string name description the description of the disk record sr ref sr the sr that the vdi is in vdi type type the type of the vdi bool sharable t...

  • 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 name description vdi ref self the vdi to modify bool value the new value of the vdi’s managed field return type...

  • Page 231

    2.26. Class: vdi chapter 2. Api reference void set_missing (session_id s, vdi ref self, bool value) arguments: type name description vdi ref self the vdi to modify bool value the new value of the vdi’s missing field return type: void rpc name: set virtual size overview: sets the vdi’s virtual size f...

  • 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 nam...

  • Page 233

    2.26. Class: vdi chapter 2. Api reference arguments: type name description vdi ref self reference to the object string value new value to set return type: void rpc name: get name description overview: get the name/description field of the given vdi. Signature: string get_name_description (session_id...

  • Page 234

    2.26. Class: vdi chapter 2. Api reference return type: (vdi operations) set value of the field 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...

  • 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) s...

  • 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 sharabl...

  • 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 ot...

  • 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 name description vdi ref self referenc...

  • 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 m...

  • 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 xen...

  • 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 name description vdi ref self refer...

  • 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 name description vdi ref self reference to the object (string → string) map v...

  • 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 newly cr...

  • 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 label...

  • Page 245

    2.27. Class: vbd chapter 2. Api reference 2.27 class: vbd 2.27.1 fields for class: vbd name vbd description a virtual block device. Quals field type description ro run uuid string unique identifier/object reference ro run allowed operations (vbd operations) set list of the operations allowed in this...

  • Page 246

    2.27. Class: vbd chapter 2. Api reference remove the media from the device and leave it empty. Signature: void eject (session_id s, vbd ref vbd) arguments: type name description vbd ref vbd the vbd representing the cdrom-like device return type: void possible error codes: vbd not removable media , v...

  • 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 (ses...

  • 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 nam...

  • Page 249

    2.27. Class: vbd chapter 2. Api reference arguments: type name description vbd ref self reference to the object return type: (string → vbd operations) map value of the field rpc name: get vm overview: get the vm field of the given vbd. Signature: (vm ref) get_vm (session_id s, vbd ref self) argument...

  • Page 250

    2.27. Class: vbd chapter 2. Api reference return type: string value of the field 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 ty...

  • 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 name description vbd ref self reference to the object bool value new value to set return type: voi...

  • 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 ov...

  • 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 name description vbd ref self reference to the object bool value new value to set return ...

  • 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 → s...

  • Page 255

    2.27. Class: vbd 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 vbd. If the key is not in that map, then do nothing. Signature: void remove_from_other_config (session_id s, vbd ref self, ...

  • 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 ...

  • 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 name description vbd ref self reference to the object string value...

  • Page 258

    2.27. Class: vbd chapter 2. Api reference rpc name: add to qos algorithm params overview: add the given key-value pair to the qos/algorithm params field of the given vbd. Signature: void add_to_qos_algorithm_params (session_id s, vbd ref self, string key, string value) arguments: type name descripti...

  • 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 fiel...

  • 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. Si...

  • Page 261

    2.28. Class: vbd metrics chapter 2. Api reference 2.28 class: vbd metrics 2.28.1 fields for class: vbd metrics name vbd metrics description the metrics associated with a virtual block device. Quals field type description ro run uuid string unique identifier/object reference ro run io/read kbs float ...

  • Page 262

    2.28. Class: vbd metrics chapter 2. Api reference value of the field rpc name: get io read kbs overview: get the io/read kbs field of the given vbd metrics. Signature: float get_io_read_kbs (session_id s, vbd_metrics ref self) arguments: type name description vbd metrics ref self reference to the ob...

  • 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 typ...

  • Page 264

    2.29. Class: pbd chapter 2. Api reference 2.29 class: pbd 2.29.1 fields for class: pbd name pbd description the physical block devices through which hosts access srs. Quals field type description ro run uuid string unique identifier/object reference ro ins host host ref physical machine on which the...

  • 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 name description pbd ref self the pbd to modify (string → string) map value...

  • Page 266

    2.29. Class: pbd chapter 2. Api reference value of the field 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 rp...

  • 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 of...

  • 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 name description pbd ref self referenc...

  • Page 269

    2.29. Class: pbd chapter 2. Api reference 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 rpc name: get by uuid overview: get a reference to th...

  • Page 270

    2.30. Class: crashdump chapter 2. Api reference 2.30 class: crashdump 2.30.1 fields for class: crashdump name crashdump description a vm crashdump. Quals field type description ro run uuid string unique identifier/object reference ro ins vm vm ref the virtual machine ro ins vdi vdi ref the virtual d...

  • 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 field rpc...

  • 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 object ...

  • 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 crash- dump. If the key is not in that map, then do nothing. Signature: void remove_from_other_config (session_id s, ...

  • Page 274

    2.31. Class: vtpm chapter 2. Api reference 2.31 class: vtpm 2.31.1 fields for class: vtpm name vtpm description a virtual tpm device. Quals field type description ro run uuid string unique identifier/object reference ro ins vm vm ref the virtual machine ro ins backend vm ref the domain where the bac...

  • Page 275

    2.31. Class: vtpm chapter 2. Api reference arguments: type name description vtpm ref self reference to the object return type: vm ref value of the field rpc name: create overview: create a new vtpm instance, and return its handle. Signature: (vtpm ref) create (session_id s, vtpm record args) argumen...

  • Page 276

    2.31. Class: vtpm chapter 2. Api reference reference to the object 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 retu...

  • Page 277

    2.32. Class: console chapter 2. Api reference 2.32 class: console 2.32.1 fields for class: console name console description a console. Quals field type description ro run uuid string unique identifier/object reference ro run protocol console protocol the protocol used by this console ro run location...

  • Page 278

    2.32. Class: console chapter 2. Api reference return type: string value of the field rpc name: get protocol overview: get the protocol field of the given console. Signature: (console_protocol) get_protocol (session_id s, console ref self) arguments: type name description console ref self reference t...

  • 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 (session_id s, console ref self) arguments: type name description console ref self reference to the object return t...

  • 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 of the given console. If the key is not in that map, then do nothing. Signature: void remove_from_other_config (session_id s, consol...

  • 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) get_by_uuid (session_id s, string uuid) arguments: type name description string uuid uuid of object to return return type: console r...

  • Page 282

    2.33. Class: user chapter 2. Api reference 2.33 class: user 2.33.1 fields for class: user name user description a user of the system. Quals field type description ro run uuid string unique identifier/object reference ro ins short name string short name (e.G. Userid) rw fullname string full name 2.33...

  • Page 283

    2.33. Class: user chapter 2. Api reference arguments: type name description user ref self reference to the object return type: string value of the field rpc name: set fullname overview: set the fullname field of the given user. Signature: void set_fullname (session_id s, user ref self, string value)...

  • Page 284

    2.33. Class: user chapter 2. Api reference return type: void 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: ...

  • Page 285

    2.34. Error handling chapter 2. Api reference 2.34 error handling when a low-level transport error occurs, or a request is malformed at the http or xml-rpc level, 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, t...

  • Page 286

    2.34. Error handling chapter 2. Api reference 2.34.1 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 signature: bootloader_failed(vm, msg) cannot contact host cannot forward message...

  • 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 state...

  • Page 288

    2.34. Error handling chapter 2. Api reference device already attached the device is already attached to a vm signature: device_already_attached(device) device already detached the device is not currently attached signature: device_already_detached(device) device already exists a device with the name...

  • Page 289

    2.34. Error handling chapter 2. Api reference duplicate vm cannot restore this vm because it would create 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 si...

  • 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 signature: ha_host_is_armed(host) ha is enabled the operation could not be performed because ha is enabled on the pool no parameters. Ha not en...

  • Page 291

    2.34. Error handling chapter 2. Api reference hosts not homogeneous the hosts in this pool are not homogeneous. Signature: hosts_not_homogeneous(reason) host broken this host failed in the middle of an automatic failover operation and needs to retry the failover action no parameters. Host cannot att...

  • Page 292

    2.34. Error handling chapter 2. Api reference host in emergency mode cannot perform operation as the host is running in emergency mode. No parameters. Host in use this operation cannot be completed as the host is in use by (at least) the object of type and ref echoed below. Signature: host_in_use(ho...

  • Page 293

    2.34. Error handling chapter 2. Api reference host offline you attempted an operation which involves a host which could not be contacted. Signature: host_offline(host) host still booting the host is still booting. No parameters. Host unknown to master the master says the host is not known to it. Per...

  • Page 294

    2.34. Error 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...

  • Page 295

    2.34. Error handling chapter 2. Api reference joining host cannot be master of other hosts the host joining the pool cannot already be a master of another pool. No parameters. Joining host cannot contain shared srs the host joining the pool cannot contain any shared storage. No parameters. Joining h...

  • Page 296

    2.34. Error handling chapter 2. Api reference license does not support pooling this host cannot join a pool because it’s license does not support pooling no parameters. License does not support xha xha cannot be enabled because this host’s license does not allow it no parameters. License expired you...

  • Page 297

    2.34. Error handling chapter 2. Api reference mac still exists the mac address specified still exists on this host. Signature: mac_still_exists(mac) map duplicate key you tried to add a key-value pair to a map, but that key is already there. Signature: map_duplicate_key(type, param_name, uuid, key) ...

  • Page 298

    2.34. Error handling chapter 2. Api reference network contains pif the network contains active pifs and cannot be deleted. Signature: network_contains_pif(pifs) network contains vif the network contains active vifs and cannot be deleted. Signature: network_contains_vif(vifs) not allowed on oem editi...

  • Page 299

    2.34. Error handling chapter 2. Api reference object nolonger exists the specified object no longer exists. No parameters. Only allowed on oem edition this command is only allowed on the oem edition. Signature: only_allowed_on_oem_edition(command) operation not allowed you attempted an operation tha...

  • Page 300

    2.34. Error handling chapter 2. Api reference patch apply failed the patch apply failed. Please see attached output. Signature: patch_apply_failed(output) patch is applied the specified patch is applied and cannot be destroyed. No parameters. Patch precheck failed prerequisite missing the patch prec...

  • Page 301

    2.34. Error handling chapter 2. Api reference pbd exists a pbd already exists connecting the sr to the host signature: pbd_exists(sr, host, pbd) permission denied caller not allowed to perform this operation. Signature: permission_denied(message) pif already bonded this operation cannot be performed...

  • 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) pif is physical you tried to destroy a pif,...

  • Page 303

    2.34. Error handling chapter 2. Api reference restore incompatible version the restore could not be performed because this backup has been created by a different (incom- patible) product verion no parameters. Restore script failed the restore could not be performed because the restore script failed....

  • 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 handle you are using is echoed. Signature: session_not_registered(handle) slave requires management interface the managem...

  • Page 305

    2.34. Error handling chapter 2. Api reference sr has no pbds the sr has no attached pbds signature: sr_has_no_pbds(sr) sr has pbd the sr is still connected to a host via a pbd. It cannot be destroyed. Signature: sr_has_pbd(sr) sr not empty the sr operation cannot be performed because the sr is not e...

  • Page 306

    2.34. Error handling chapter 2. Api reference sr uuid exists an sr with that uuid already exists. Signature: sr_uuid_exists(uuid) sr vdi locking failed the operation could not proceed because necessary vdis were already locked at the storage level. No parameters. System status must use tar on oem yo...

  • Page 307

    2.34. Error handling chapter 2. Api reference unknown bootloader the requested bootloader is unknown signature: unknown_bootloader(vm, bootloader) 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 supporte...

  • 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) vbd tr...

  • 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 sr signature: vdi_location_missing(sr, location) vdi missing this operation cannot be performed because the specified vdi could not be f...

  • 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 and actual vm s...

  • Page 311

    2.34. Error handling chapter 2. Api reference vm memory size too low the specified vm has too little memory to be started. Signature: vm_memory_size_too_low(vm) vm migrate failed an error occurred during the migration process. Signature: vm_migrate_failed(vm, source, destination, msg) vm missing pv ...

  • 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 does...

  • 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 the vm would run on a cpu that has a potentially incompatable set of feature flags to those the vm requires. If you want to override this war...