XenSource DL385 - ProLiant - G5 Manual Download Page 21

Page: 21 / 313

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

run

uuid

string

unique identifier/object reference

run

this host

host ref

Currently connected host

run

this user

user ref

Currently connected user

run

last active

datetime

Timestamp for last time session was
active

run

pool

bool

True if this session relates to a intra-
pool login, false otherwise

other config

(string

→

string) Map

additional configuration

2.4.2

RPCs associated with class: session

RPC name: login with password

Overview:

Attempt to authenticate the user, returning a session reference if successful.

Signature:

(session ref) login_with_password (string uname, string pwd, string version)

Arguments:

type

name

description

string

uname

Username for login.

string

pwd

Password for login.

string

version

Client API version.

Return Type:

session ref

reference of newly created session

Possible Error Codes:

SESSION AUTHENTICATION FAILED

RPC name: logout

Overview:

Log out of a session.

Signature:

void logout (session_id s)

Return Type:

void

RPC name: change password

Overview:

Change the account password; if your session is authenticated with root priviledges then the
old pwd is validated and the new pwd is set regardless.

Signature:

Summary of Contents for DL385 - ProLiant - G5

Page 2: ...ields 16 2 3 Types 16 2 3 1 Primitives 16 2 3 2 Higher order types 16 2 3 3 Enumeration types 16 2 4 Class session 21 2 4 1 Fields for class session 21 2 4 2 RPCs associated with class session 21 2 5...

Page 3: ...twork 154 2 18 Class VIF 162 2 18 1 Fields for class VIF 162 2 18 2 RPCs associated with class VIF 162 2 19 Class VIF metrics 173 2 19 1 Fields for class VIF metrics 173 2 19 2 RPCs associated with cl...

Page 4: ...crashdump 270 2 30 2 RPCs associated with class crashdump 270 2 31 Class VTPM 274 2 31 1 Fields for class VTPM 274 2 31 2 RPCs associated with class VTPM 274 2 32 Class console 277 2 32 1 Fields for...

Page 5: ...field must be manually set when a new object is created but is then Read Only for the duration of the object s life For example the maximum memory addressable by a guest is set before the guest boots...

Page 6: ...ite a set f Ref x v RPC function is also provided This sets field f on object x to value v 1 2 RPCs associated with classes Each class has a constructor RPC named create that takes as parameters all f...

Page 7: ...has terminated fields named uuid of type String are mapped to the XML RPC String type The string itself is the OSF DCE UUID presentation format as output by uuidgen etc ints are all assumed to be 64 b...

Page 8: ...omparing UUID strings The API provides mechanisms for translating between UUIDs and opaque references Each class that contains a UUID field provides A get by uuid method that takes a UUID u and return...

Page 9: ...on_id session 1 4 3 Synchronous and Asynchronous invocation Each method call apart from methods on Session and Task objects and getters and set ters derived from fields can be made either synchronousl...

Page 10: ...session xen session login_with_password user passwd Value When serialised this call looks like the following xml version 1 0 methodCall methodName session login_with_password methodName params param...

Page 11: ...onalised Rather than querying fields individually whole records may be returned at once To retrieve the record of a single object as a python dictionary record xen VM get_record session all_templates...

Page 12: ...n of pygrub will be used or a full path within the control domain to some other bootloader The other fields PV kernel PV ramdisk PV args and PV bootloader args will be passed to the bootloader unmodif...

Page 13: ...OT 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...

Page 14: ...n a server host metrics The metrics associated with a host host cpu A physical CPU network A virtual network VIF A virtual network interface VIF metrics The metrics associated with a virtual network d...

Page 15: ...etwork network VIFs one to many PIF host host PIFs one to many PIF network network PIFs one to many SR VDIs VDI SR many to one VTPM VM VM VTPMs one to many console VM VM consoles one to many host resi...

Page 16: ...th list of elements of type t Map a b a table mapping values of type a to values of type b 2 3 3 Enumeration types The following enumeration types are used enum event operation add An object has been...

Page 17: ...gging a PBD into this SR unplug Unplugging a PBD from this SR vdi create Creating a new VDI vdi introduce Introducing a new VDI vdi destroy Destroying a VDI vdi resize Resizing a VDI vdi clone Clonein...

Page 18: ...ully failure task has failed cancelling task is being cancelled cancelled task has been cancelled enum task allowed operations cancel refers to the operation cancel enum vm operations clone refers to...

Page 19: ...ork stream destroy refers to the act of uninstalling the VM enum on normal exit destroy destroy the VM state restart restart the VM enum on crash behaviour destroy destroy the VM state coredump and de...

Page 20: ...ES 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...

Page 21: ...ith class session RPC name login with password Overview Attempt to authenticate the user returning a session reference if successful Signature session ref login_with_password string uname string pwd s...

Page 22: ...ion_id s session ref self Arguments type name description session ref self reference to the object Return Type string value of the field RPC name get this host Overview Get the this host field of the...

Page 23: ...n ref self reference to the object Return Type datetime value of the field RPC name get pool Overview Get the pool field of the given session Signature bool get_pool session_id s session ref self Argu...

Page 24: ...o the other config field of the given session Signature void add_to_other_config session_id s session ref self string key string value Arguments type name description session ref self reference to the...

Page 25: ...ents type name description string uuid UUID of object to return Return Type session ref reference to the object RPC name get record Overview Get a record containing the current state of the given sess...

Page 26: ...s type current status of the task ROrun session session ref the session that created the task ROrun resident on host ref the host on which the task is running ROrun progress float if the task is still...

Page 27: ...el for the new task string description longer description for the new task Return Type task ref The reference of the created task object RPC name destroy Overview Destroy the task object Signature voi...

Page 28: ...records for all tasks known to the system Signature task ref task record Map get_all_records session_id s Return Type task ref task record Map records of all objects RPC name get uuid Overview Get the...

Page 29: ...value of the field RPC name get allowed operations Overview Get the allowed operations field of the given task Signature task_allowed_operations Set get_allowed_operations session_id s task ref self...

Page 30: ...time value of the field RPC name get finished Overview Get the finished field of the given task Signature datetime get_finished session_id s task ref self Arguments type name description task ref self...

Page 31: ...of the field RPC name get progress Overview Get the progress field of the given task Signature float get_progress session_id s task ref self Arguments type name description task ref self reference to...

Page 32: ...rview Get the error info field of the given task Signature string Set get_error_info session_id s task ref self Arguments type name description task ref self reference to the object Return Type string...

Page 33: ...eld of the given task Signature void add_to_other_config session_id s task ref self string key string value Arguments type name description task ref self reference to the object string key Key to add...

Page 34: ...t a record containing the current state of the given task Signature task record get_record session_id s task ref self Arguments type name description task ref self reference to the object Return Type...

Page 35: ...the object that changed ROins obj uuid string The uuid of the object that changed 2 6 2 RPCs associated with class event RPC name register Overview Registers this session with the event system Specify...

Page 36: ...ts Signature event record Set next session_id s Return Type event record Set the batch of events Possible Error Codes SESSION NOT REGISTERED EVENTS LOST RPC name get current id Overview Return the ID...

Page 37: ...pool Signature void join session_id s string master_address string master_username string master_password Arguments type name description string master address The hostname of the master of the pool t...

Page 38: ...ng master Signature void emergency_transition_to_master session_id s Return Type void RPC name emergency reset master Overview Instruct a slave already in a pool that the master has changed Signature...

Page 39: ...ame description string device physical interface on which to create the VLAN interface network ref network network to which this interface should be con nected int VLAN VLAN tag for the new interface...

Page 40: ...st ref host Arguments type name description host ref host The host who should become the new master Return Type void RPC name get all Overview Return a list of all the pools known to the system Signat...

Page 41: ...l Overview Get the name label field of the given pool Signature string get_name_label session_id s pool ref self Arguments type name description pool ref self reference to the object Return Type strin...

Page 42: ...set name description Overview Set the name description field of the given pool Signature void set_name_description session_id s pool ref self string value Arguments type name description pool ref self...

Page 43: ...R Overview Set the default SR field of the given pool Signature void set_default_SR session_id s pool ref self SR ref value Arguments type name description pool ref self reference to the object SR ref...

Page 44: ...name get crash dump SR Overview Get the crash dump SR field of the given pool Signature SR ref get_crash_dump_SR session_id s pool ref self Arguments type name description pool ref self reference to...

Page 45: ...eld of the given pool Signature void set_other_config session_id s pool ref self string string Map value Arguments type name description pool ref self reference to the object string string Map value N...

Page 46: ...ring key Key to remove Return Type void RPC name get by uuid Overview Get a reference to the pool instance with the specified UUID Signature pool ref get_by_uuid session_id s string uuid Arguments typ...

Page 47: ...to ROrun after apply guidance after apply guidance Set What the client should do after this patch has been applied RW other config string string Map additional configuration 2 8 2 RPCs associated with...

Page 48: ...output of the patch prechecks RPC name clean Overview Removes the patch s files from all hosts in the pool but does not remove the database entries Signature void clean session_id s pool_patch ref sel...

Page 49: ...pool_patch record Map get_all_records session_id s Return Type pool patch ref pool patch record Map records of all objects RPC name get uuid Overview Get the uuid field of the given pool patch Signat...

Page 50: ...urn Type string value of the field RPC name get version Overview Get the version field of the given pool patch Signature string get_version session_id s pool_patch ref self Arguments type name descrip...

Page 51: ...field of the given pool patch Signature host_patch ref Set get_host_patches session_id s pool_patch ref self Arguments type name description pool patch ref self reference to the object Return Type hos...

Page 52: ...the given pool patch Signature void set_other_config session_id s pool_patch ref self string string Map value Arguments type name description pool patch ref self reference to the object string string...

Page 53: ...to remove Return Type void RPC name get by uuid Overview Get a reference to the pool patch instance with the specified UUID Signature pool_patch ref get_by_uuid session_id s string uuid Arguments typ...

Page 54: ...iew 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 retur...

Page 55: ...ed only for cloning other VMs ROrun suspend VDI VDI ref The VDI that a suspend image is stored on Only has meaning if VM is currently suspended ROrun resident on host ref the host the VM is currently...

Page 56: ...HVM boot params RW HVM shadow multiplier float multiplier applied to the amount of shadow that will be made available to the guest RW platform string string Map platform specific configuration RW PCI...

Page 57: ...itory in which the VM s disk images are stored Instead copy guarantees that the disk images of the newly created VM will be full disks i e not part of a CoW chain This function can only be called when...

Page 58: ...ED VM IS TEMPLATE OTHER OPERATION IN PROGRESS OPERATION NOT ALLOWED BOOTLOADER FAILED UNKNOWN BOOTLOADER NO HOSTS AVAILABLE LICENCE RESTRICTION RPC name start on Overview Start the specified VM on a p...

Page 59: ...in the Paused state Signature void unpause session_id s VM ref vm Arguments type name description VM ref vm The VM to unpause Return Type void Possible Error Codes VM BAD POWER STATE OPERATION NOT AL...

Page 60: ...Stop executing the specified VM without attempting a clean shutdown Signature void hard_shutdown session_id s VM ref vm Arguments type name description VM ref vm The VM to destroy Return Type void Pos...

Page 61: ...suspend session_id s VM ref vm Arguments type name description VM ref vm The VM to suspend Return Type void Possible Error Codes VM BAD POWER STATE OTHER OPERATION IN PROGRESS OPERATION NOT ALLOWED VM...

Page 62: ...y checks e g if the CPU the VM was running on looks substantially different to the current one Return Type void Possible Error Codes VM BAD POWER STATE OPERATION NOT ALLOWED VM IS TEMPLATE RPC name po...

Page 63: ...ring key string value Arguments type name description VM ref self The VM string key The key string value The value Return Type void RPC name set memory target live Overview Set the balloon driver s ta...

Page 64: ...id Possible Error Codes VM BAD POWER STATE RPC name send trigger Overview Send the named trigger to this VM This can only be called when the specified VM is in the Running state Signature void send_tr...

Page 65: ...state initialised when the VM boots and updated to reflect runtime configuration changes e g CPU hotplug Signature VM record get_boot_record session_id s VM ref self Arguments type name description VM...

Page 66: ...evice field can take Signature string Set get_allowed_VBD_devices session_id s VM ref vm Arguments type name description VM ref vm The VM to query Return Type string Set The allowed values RPC name ge...

Page 67: ...s VM ref self host ref host Arguments type name description VM ref self The VM host ref host The host Return Type void Possible Error Codes HOST NOT ENOUGH FREE MEMORY VM REQUIRES SR RPC name atomic...

Page 68: ...cts RPC name get uuid Overview Get the uuid field of the given VM Signature string get_uuid session_id s VM ref self Arguments type name description VM ref self reference to the object Return Type str...

Page 69: ...value of the field RPC name get power state Overview Get the power state field of the given VM Signature vm_power_state get_power_state session_id s VM ref self Arguments type name description VM ref...

Page 70: ...escription Overview Get the name description field of the given VM Signature string get_name_description session_id s VM ref self Arguments type name description VM ref self reference to the object Re...

Page 71: ...ser version Overview Set the user version field of the given VM Signature void set_user_version session_id s VM ref self int value Arguments type name description VM ref self reference to the object i...

Page 72: ...void RPC name get suspend VDI Overview Get the suspend VDI field of the given VM Signature VDI ref get_suspend_VDI session_id s VM ref self Arguments type name description VM ref self reference to the...

Page 73: ...ty Overview Set the affinity field of the given VM Signature void set_affinity session_id s VM ref self host ref value Arguments type name description VM ref self reference to the object host ref valu...

Page 74: ...memory dynamic max Overview Get the memory dynamic max field of the given VM Signature int get_memory_dynamic_max session_id s VM ref self Arguments type name description VM ref self reference to the...

Page 75: ...dynamic min Overview Set the memory dynamic min field of the given VM Signature void set_memory_dynamic_min session_id s VM ref self int value Arguments type name description VM ref self reference to...

Page 76: ...ams Overview Get the VCPUs params field of the given VM Signature string string Map get_VCPUs_params session_id s VM ref self Arguments type name description VM ref self reference to the object Return...

Page 77: ...om VCPUs params Overview Remove the given key and its corresponding value from the VCPUs params field of the given VM If the key is not in that Map then do nothing Signature void remove_from_VCPUs_par...

Page 78: ...at startup Overview Get the VCPUs at startup field of the given VM Signature int get_VCPUs_at_startup session_id s VM ref self Arguments type name description VM ref self reference to the object Retu...

Page 79: ...n Overview Set the actions after shutdown field of the given VM Signature void set_actions_after_shutdown session_id s VM ref self on_normal_exit value Arguments type name description VM ref self refe...

Page 80: ...ash Overview Get the actions after crash field of the given VM Signature on_crash_behaviour get_actions_after_crash session_id s VM ref self Arguments type name description VM ref self reference to th...

Page 81: ...of the field RPC name get VIFs Overview Get the VIFs field of the given VM Signature VIF ref Set get_VIFs session_id s VM ref self Arguments type name description VM ref self reference to the object R...

Page 82: ...e field RPC name get VTPMs Overview Get the VTPMs field of the given VM Signature VTPM ref Set get_VTPMs session_id s VM ref self Arguments type name description VM ref self reference to the object Re...

Page 83: ...void RPC name get PV kernel Overview Get the PV kernel field of the given VM Signature string get_PV_kernel session_id s VM ref self Arguments type name description VM ref self reference to the objec...

Page 84: ...e set PV ramdisk Overview Set the PV ramdisk field of the given VM Signature void set_PV_ramdisk session_id s VM ref self string value Arguments type name description VM ref self reference to the obje...

Page 85: ...s Overview Get the PV bootloader args field of the given VM Signature string get_PV_bootloader_args session_id s VM ref self Arguments type name description VM ref self reference to the object Return...

Page 86: ...acy args Overview Set the PV legacy args field of the given VM Signature void set_PV_legacy_args session_id s VM ref self string value Arguments type name description VM ref self reference to the obje...

Page 87: ...erview Get the HVM boot params field of the given VM Signature string string Map get_HVM_boot_params session_id s VM ref self Arguments type name description VM ref self reference to the object Return...

Page 88: ...verview Remove the given key and its corresponding value from the HVM boot params field of the given VM If the key is not in that Map then do nothing Signature void remove_from_HVM_boot_params session...

Page 89: ...C name get platform Overview Get the platform field of the given VM Signature string string Map get_platform session_id s VM ref self Arguments type name description VM ref self reference to the objec...

Page 90: ...om platform Overview Remove the given key and its corresponding value from the platform field of the given VM If the key is not in that Map then do nothing Signature void remove_from_platform session_...

Page 91: ...Get the other config field of the given VM Signature string string Map get_other_config session_id s VM ref self Arguments type name description VM ref self reference to the object Return Type string...

Page 92: ...ove from other config Overview Remove the given key and its corresponding value from the other config field of the given VM If the key is not in that Map then do nothing Signature void remove_from_oth...

Page 93: ...ew Get the last boot CPU flags field of the given VM Signature string string Map get_last_boot_CPU_flags session_id s VM ref self Arguments type name description VM ref self reference to the object Re...

Page 94: ...verview Get the guest metrics field of the given VM Signature VM_guest_metrics ref get_guest_metrics session_id s VM ref self Arguments type name description VM ref self reference to the object Return...

Page 95: ...s Overview Set the recommendations field of the given VM Signature void set_recommendations session_id s VM ref self string value Arguments type name description VM ref self reference to the object st...

Page 96: ...field of the given VM Signature void add_to_xenstore_data session_id s VM ref self string key string value Arguments type name description VM ref self reference to the object string key Key to add str...

Page 97: ...y the specified VM The VM is completely removed from the system This function can only be called when the VM is in the Halted State Signature void destroy session_id s VM ref self Arguments type name...

Page 98: ...ype name description VM ref self reference to the object Return Type VM record all fields from the object RPC name get by name label Overview Get all the VM instances with the given label Signature VM...

Page 99: ...nning ROrun state string Set The state of the guest eg blocked dying etc ROrun start time datetime Time at which this VM was last booted ROrun install time datetime Time at which the VM was installed...

Page 100: ...actual Overview Get the memory actual field of the given VM metrics Signature int get_memory_actual session_id s VM_metrics ref self Arguments type name description VM metrics ref self reference to th...

Page 101: ...get VCPUs CPU Overview Get the VCPUs CPU field of the given VM metrics Signature int int Map get_VCPUs_CPU session_id s VM_metrics ref self Arguments type name description VM metrics ref self referenc...

Page 102: ...field RPC name get state Overview Get the state field of the given VM metrics Signature string Set get_state session_id s VM_metrics ref self Arguments type name description VM metrics ref self refere...

Page 103: ...updated Overview Get the last updated field of the given VM metrics Signature datetime get_last_updated session_id s VM_metrics ref self Arguments type name description VM metrics ref self reference t...

Page 104: ...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...

Page 105: ...ation ROrun other string string Map anything else ROrun last updated datetime Time at which this information was last updated 2 11 2 RPCs associated with class VM guest metrics RPC name get all Overvi...

Page 106: ...tring string Map value of the field RPC name get PV drivers version Overview Get the PV drivers version field of the given VM guest metrics Signature string string Map get_PV_drivers_version session_i...

Page 107: ...name get disks Overview Get the disks field of the given VM guest metrics Signature string string Map get_disks session_id s VM_guest_metrics ref self Arguments type name description VM guest metrics...

Page 108: ...Overview Get the last updated field of the given VM guest metrics Signature datetime get_last_updated session_id s VM_guest_metrics ref self Arguments type name description VM guest metrics ref self r...

Page 109: ...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 ref sel...

Page 110: ...version strings RW other config string string Map additional configuration ROins capabilities string Set Xen capabilities ROrun cpu configuration string string Map The CPU configu this host May c such...

Page 111: ...ost ref host The Host to disable Return Type void RPC name enable Overview Puts the host into a state in which new VMs can be started Signature void enable session_id s host ref host Arguments type na...

Page 112: ...ref host The Host to reboot Return Type void RPC name dmesg Overview Get the host xen dmesg Signature string dmesg session_id s host ref host Arguments type name description host ref host The Host to...

Page 113: ...nature void send_debug_keys session_id s host ref host string keys Arguments type name description host ref host The host string keys The keys to send Return Type void RPC name bugreport upload Overvi...

Page 114: ...ts type name description host ref host The host to upload the license to string contents The contents of the license file base64 en coded Return Type void Possible Error Codes LICENSE PROCESSING ERROR...

Page 115: ...ame syslog reconfigure Overview Re configure syslog logging Signature void syslog_reconfigure session_id s host ref host Arguments type name description host ref host Tell the host to reread its Host...

Page 116: ...C name management disable Overview Disable the management network interface Signature void management_disable session_id s Return Type void RPC name get system status capabilities Overview Signature s...

Page 117: ...t ref Set references to all objects RPC name get all records Overview Return a map of host references to host records for all hosts known to the system Signature host ref host record Map get_all_recor...

Page 118: ...l Overview Set the name label field of the given host Signature void set_name_label session_id s host ref self string value Arguments type name description host ref self reference to the object string...

Page 119: ...operations field of the given host Signature host_allowed_operations Set get_allowed_operations session_id s host ref self Arguments type name description host ref self reference to the object Return...

Page 120: ...I version minor Overview Get the API version minor field of the given host Signature int get_API_version_minor session_id s host ref self Arguments type name description host ref self reference to the...

Page 121: ...tring Map value of the field RPC name get enabled Overview Get the enabled field of the given host Signature bool get_enabled session_id s host ref self Arguments type name description host ref self r...

Page 122: ...eld of the given host Signature void set_other_config session_id s host ref self string string Map value Arguments type name description host ref self reference to the object string string Map value N...

Page 123: ...ey Key to remove Return Type void RPC name get capabilities Overview Get the capabilities field of the given host Signature string Set get_capabilities session_id s host ref self Arguments type name d...

Page 124: ...oaders Overview Get the supported bootloaders field of the given host Signature string Set get_supported_bootloaders session_id s host ref self Arguments type name description host ref self reference...

Page 125: ...d of the given host Signature void set_logging session_id s host ref self string string Map value Arguments type name description host ref self reference to the object string string Map value New valu...

Page 126: ...object string key Key to remove Return Type void RPC name get PIFs Overview Get the PIFs field of the given host Signature PIF ref Set get_PIFs session_id s host ref self Arguments type name descript...

Page 127: ...name get crash dump sr Overview Get the crash dump sr field of the given host Signature SR ref get_crash_dump_sr session_id s host ref self Arguments type name description host ref self reference to...

Page 128: ...he field RPC name get patches Overview Get the patches field of the given host Signature host_patch ref Set get_patches session_id s host ref self Arguments type name description host ref self referen...

Page 129: ...RPC name get hostname Overview Get the hostname field of the given host Signature string get_hostname session_id s host ref self Arguments type name description host ref self reference to the object...

Page 130: ...s Overview Set the address field of the given host Signature void set_address session_id s host ref self string value Arguments type name description host ref self reference to the object string value...

Page 131: ...get by uuid Overview Get a reference to the host instance with the specified UUID Signature host ref get_by_uuid session_id s string uuid Arguments type name description string uuid UUID of object to...

Page 132: ...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 Retu...

Page 133: ...ost crashdump RPC name destroy Overview Destroy specified host crash dump removing it from the disk Signature void destroy session_id s host_crashdump ref self Arguments type name description host cra...

Page 134: ...Type host crashdump ref host crashdump record Map records of all objects RPC name get uuid Overview Get the uuid field of the given host crashdump Signature string get_uuid session_id s host_crashdum...

Page 135: ...ze Overview Get the size field of the given host crashdump Signature int get_size session_id s host_crashdump ref self Arguments type name description host crashdump ref self reference to the object R...

Page 136: ...given host crashdump Signature void add_to_other_config session_id s host_crashdump ref self string key string value Arguments type name description host crashdump ref self reference to the object st...

Page 137: ...name description string uuid UUID of object to return Return Type host crashdump ref reference to the object RPC name get record Overview Get a record containing the current state of the given host cr...

Page 138: ...Time the patch was applied ROrun size int Size of the patch ROins pool patch pool patch ref The patch applied RW other config string string Map additional configuration 2 14 2 RPCs associated with cla...

Page 139: ...host_patch record Map get_all_records session_id s Return Type host patch ref host patch record Map records of all objects RPC name get uuid Overview Get the uuid field of the given host patch Signat...

Page 140: ...ype string value of the field RPC name get version Overview Get the version field of the given host patch Signature string get_version session_id s host_patch ref self Arguments type name description...

Page 141: ...estamp applied Overview Get the timestamp applied field of the given host patch Signature datetime get_timestamp_applied session_id s host_patch ref self Arguments type name description host patch ref...

Page 142: ...the other config field of the given host patch Signature string string Map get_other_config session_id s host_patch ref self Arguments type name description host patch ref self reference to the object...

Page 143: ...iew Remove the given key and its corresponding value from the other config field of the given host patch If the key is not in that Map then do nothing Signature void remove_from_other_config session_i...

Page 144: ...name description host patch ref self reference to the object Return Type host patch record all fields from the object RPC name get by name label Overview Get all the host patch instances with the give...

Page 145: ...s RPC name get all Overview Return a list of all the host metrics instances known to the system Signature host_metrics ref Set get_all session_id s Return Type host metrics ref Set references to all o...

Page 146: ...value of the field RPC name get memory free Overview Get the memory free field of the given host metrics Signature int get_memory_free session_id s host_metrics ref self Arguments type name descripti...

Page 147: ...eference to the host metrics instance with the specified UUID Signature host_metrics ref get_by_uuid session_id s string uuid Arguments type name description string uuid UUID of object to return Retur...

Page 148: ...of the physical CPU ROrun stepping string the stepping of the physical CPU ROrun flags string the flags of the physical CPU a de coded version of the features field ROrun features string the physical...

Page 149: ...RPC name get host Overview Get the host field of the given host cpu Signature host ref get_host session_id s host_cpu ref self Arguments type name description host cpu ref self reference to the object...

Page 150: ...PC name get speed Overview Get the speed field of the given host cpu Signature int get_speed session_id s host_cpu ref self Arguments type name description host cpu ref self reference to the object Re...

Page 151: ...name get model Overview Get the model field of the given host cpu Signature int get_model session_id s host_cpu ref self Arguments type name description host cpu ref self reference to the object Retu...

Page 152: ...features Overview Get the features field of the given host cpu Signature string get_features session_id s host_cpu ref self Arguments type name description host cpu ref self reference to the object R...

Page 153: ...nts type name description string uuid UUID of object to return Return Type host cpu ref reference to the object RPC name get record Overview Get a record containing the current state of the given host...

Page 154: ...using this object by reference to a cur rent operation enum which describes the nature of the task ROrun VIFs VIF ref Set list of connected vifs ROrun PIFs PIF ref Set list of connected pifs RW other...

Page 155: ...verview Get the name label field of the given network Signature string get_name_label session_id s network ref self Arguments type name description network ref self reference to the object Return Type...

Page 156: ...he name description field of the given network Signature void set_name_description session_id s network ref self string value Arguments type name description network ref self reference to the object s...

Page 157: ...rk operations Map value of the field RPC name get VIFs Overview Get the VIFs field of the given network Signature VIF ref Set get_VIFs session_id s network ref self Arguments type name description net...

Page 158: ...of the given network Signature void set_other_config session_id s network ref self string string Map value Arguments type name description network ref self reference to the object string string Map v...

Page 159: ...he object string key Key to remove Return Type void RPC name get bridge Overview Get the bridge field of the given network Signature string get_bridge session_id s network ref self Arguments type name...

Page 160: ...e network ref get_by_uuid session_id s string uuid Arguments type name description string uuid UUID of object to return Return Type network ref reference to the object RPC name get record Overview Get...

Page 161: ...ER 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...

Page 162: ...dress of virtual in terface as exposed to guest ROins MTU int MTU in octets ROrun reserved bool true if the VIF is reserved pending a reboot migrate RW other config string string Map additional config...

Page 163: ...Type void RPC name get all Overview Return a list of all the VIFs known to the system Signature VIF ref Set get_all session_id s Return Type VIF ref Set references to all objects RPC name get all rec...

Page 164: ...ence to the object Return Type vif operations Set value of the field RPC name get current operations Overview Get the current operations field of the given VIF Signature string vif_operations Map get_...

Page 165: ...urn Type network ref value of the field RPC name get VM Overview Get the VM field of the given VIF Signature VM ref get_VM session_id s VIF ref self Arguments type name description VIF ref self refere...

Page 166: ...g field of the given VIF Signature string string Map get_other_config session_id s VIF ref self Arguments type name description VIF ref self reference to the object Return Type string string Map value...

Page 167: ...Overview Remove the given key and its corresponding value from the other config field of the given VIF If the key is not in that Map then do nothing Signature void remove_from_other_config session_id...

Page 168: ...view Get the status detail field of the given VIF Signature string get_status_detail session_id s VIF ref self Arguments type name description VIF ref self reference to the object Return Type string v...

Page 169: ...ew Set the qos algorithm type field of the given VIF Signature void set_qos_algorithm_type session_id s VIF ref self string value Arguments type name description VIF ref self reference to the object s...

Page 170: ...ms field of the given VIF Signature void add_to_qos_algorithm_params session_id s VIF ref self string key string value Arguments type name description VIF ref self reference to the object string key K...

Page 171: ...he field RPC name get metrics Overview Get the metrics field of the given VIF Signature VIF_metrics ref get_metrics session_id s VIF ref self Arguments type name description VIF ref self reference to...

Page 172: ...to the VIF instance with the specified UUID Signature VIF ref get_by_uuid session_id s string uuid Arguments type name description string uuid UUID of object to return Return Type VIF ref reference to...

Page 173: ...ew Return a list of all the VIF metrics instances known to the system Signature VIF_metrics ref Set get_all session_id s Return Type VIF metrics ref Set references to all objects RPC name get all reco...

Page 174: ...e get io write kbs Overview Get the io write kbs field of the given VIF metrics Signature float get_io_write_kbs session_id s VIF_metrics ref self Arguments type name description VIF metrics ref self...

Page 175: ...ype name description string uuid UUID of object to return Return Type VIF metrics ref reference to the object RPC name get record Overview Get a record containing the current state of the given VIF me...

Page 176: ...his interface is online ROrun ip configuration mode ip configuration mode Sets if and how this interface gets an IP address ROrun IP string IP address ROrun netmask string IP netmask ROrun gateway str...

Page 177: ...ded it is a VLAN interface Signature void destroy session_id s PIF ref self Arguments type name description PIF ref self the PIF object to destroy Return Type void Possible Error Codes PIF IS PHYSICAL...

Page 178: ...erface Signature PIF ref introduce session_id s host ref host string MAC string device Arguments type name description host ref host The host on which the interface exists string MAC The MAC address o...

Page 179: ...PIF record Map get_all_records session_id s Return Type PIF ref PIF record Map records of all objects RPC name get uuid Overview Get the uuid field of the given PIF Signature string get_uuid session_...

Page 180: ...k ref value of the field RPC name get host Overview Get the host field of the given PIF Signature host ref get_host session_id s PIF ref self Arguments type name description PIF ref self reference to...

Page 181: ...get VLAN Overview Get the VLAN field of the given PIF Signature int get_VLAN session_id s PIF ref self Arguments type name description PIF ref self reference to the object Return Type int value of th...

Page 182: ...currently attached field of the given PIF Signature bool get_currently_attached session_id s PIF ref self Arguments type name description PIF ref self reference to the object Return Type bool value of...

Page 183: ...ame get netmask Overview Get the netmask field of the given PIF Signature string get_netmask session_id s PIF ref self Arguments type name description PIF ref self reference to the object Return Type...

Page 184: ...view Get the bond slave of field of the given PIF Signature Bond ref get_bond_slave_of session_id s PIF ref self Arguments type name description PIF ref self reference to the object Return Type Bond r...

Page 185: ...name get VLAN slave of Overview Get the VLAN slave of field of the given PIF Signature VLAN ref Set get_VLAN_slave_of session_id s PIF ref self Arguments type name description PIF ref self reference...

Page 186: ...ield of the given PIF Signature void set_other_config session_id s PIF ref self string string Map value Arguments type name description PIF ref self reference to the object string string Map value New...

Page 187: ...string key Key to remove Return Type void RPC name get by uuid Overview Get a reference to the PIF instance with the specified UUID Signature PIF ref get_by_uuid session_id s string uuid Arguments typ...

Page 188: ...speed int Speed of the link if available ROrun duplex bool Full duplex capability of the link if available ROrun pci bus path string PCI bus path of the pif if available ROrun last updated datetime T...

Page 189: ...bs Overview Get the io read kbs field of the given PIF metrics Signature float get_io_read_kbs session_id s PIF_metrics ref self Arguments type name description PIF metrics ref self reference to the o...

Page 190: ...or id Overview Get the vendor id field of the given PIF metrics Signature string get_vendor_id session_id s PIF_metrics ref self Arguments type name description PIF metrics ref self reference to the o...

Page 191: ...name get device name Overview Get the device name field of the given PIF metrics Signature string get_device_name session_id s PIF_metrics ref self Arguments type name description PIF metrics ref sel...

Page 192: ...Overview Get the pci bus path field of the given PIF metrics Signature string get_pci_bus_path session_id s PIF_metrics ref self Arguments type name description PIF metrics ref self reference to the o...

Page 193: ...ype name description string uuid UUID of object to return Return Type PIF metrics ref reference to the object RPC name get record Overview Get a record containing the current state of the given PIF me...

Page 194: ...nd Signature Bond ref create session_id s network ref network PIF ref Set members string MAC Arguments type name description network ref network Network to add the bonded PIF to PIF ref Set members PI...

Page 195: ...Bond record Map get_all_records session_id s Return Type Bond ref Bond record Map records of all objects RPC name get uuid Overview Get the uuid field of the given Bond Signature string get_uuid sessi...

Page 196: ...w Get the other config field of the given Bond Signature string string Map get_other_config session_id s Bond ref self Arguments type name description Bond ref self reference to the object Return Type...

Page 197: ...Overview Remove the given key and its corresponding value from the other config field of the given Bond If the key is not in that Map then do nothing Signature void remove_from_other_config session_i...

Page 198: ...rd 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 objec...

Page 199: ...AN RPC name create Overview Create a VLAN mux demuxer Signature VLAN ref create session_id s PIF ref tagged_PIF int tag network ref network Arguments type name description PIF ref tagged PIF PIF which...

Page 200: ...AN ref VLAN record Map records of all objects RPC name get uuid Overview Get the uuid field of the given VLAN Signature string get_uuid session_id s VLAN ref self Arguments type name description VLAN...

Page 201: ...RPC name get tag Overview Get the tag field of the given VLAN Signature int get_tag session_id s VLAN ref self Arguments type name description VLAN ref self reference to the object Return Type int val...

Page 202: ...eld of the given VLAN Signature void add_to_other_config session_id s VLAN ref self string key string value Arguments type name description VLAN ref self reference to the object string key Key to add...

Page 203: ...Arguments type name description string uuid UUID of object to return Return Type VLAN ref reference to the object RPC name get record Overview Get a record containing the current state of the given VL...

Page 204: ...in ROrun required api version string Minimum SM API version required on the server ROrun configuration string string Map names and descriptions of device con fig keys ROrun capabilities string Set cap...

Page 205: ...abel Overview Get the name label field of the given SM Signature string get_name_label session_id s SM ref self Arguments type name description SM ref self reference to the object Return Type string v...

Page 206: ...name get vendor Overview Get the vendor field of the given SM Signature string get_vendor session_id s SM ref self Arguments type name description SM ref self reference to the object Return Type stri...

Page 207: ...erview Get the required api version field of the given SM Signature string get_required_api_version session_id s SM ref self Arguments type name description SM ref self reference to the object Return...

Page 208: ...ew Get the other config field of the given SM Signature string string Map get_other_config session_id s SM ref self Arguments type name description SM ref self reference to the object Return Type stri...

Page 209: ...ig Overview Remove the given key and its corresponding value from the other config field of the given SM If the key is not in that Map then do nothing Signature void remove_from_other_config session_i...

Page 210: ...ype name description SM ref self reference to the object Return Type SM record all fields from the object RPC name get by name label Overview Get all the SM instances with the given label Signature SM...

Page 211: ...Orun virtual allocation int sum of virtual sizes of all VDIs in this storage repository in bytes ROrun physical utilisation int physical space currently utilised on this storage repository in bytes No...

Page 212: ...R UNKNOWN DRIVER RPC name introduce Overview Introduce a new Storage Repository into the managed system Signature SR ref introduce session_id s string uuid string name_label string name_description st...

Page 213: ...Map sm config Storage backend specific configuration options Return Type string The uuid of the newly created Storage Repository RPC name destroy Overview Destroy specified SR removing SR record from...

Page 214: ...t of the SRs present of this type on the device if any If the device config is partial then a backend specific scan will be performed returning results that will guide the user in improving the device...

Page 215: ...s physical size field Signature void set_physical_size 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 SR s physical size...

Page 216: ...a list of all the SRs known to the system Signature SR ref Set get_all session_id s Return Type SR ref Set references to all objects RPC name get all records Overview Return a map of SR references to...

Page 217: ...t name label Overview Set the name label field of the given SR Signature void set_name_label session_id s SR ref self string value Arguments type name description SR ref self reference to the object s...

Page 218: ...the allowed operations field of the given SR Signature storage_operations Set get_allowed_operations session_id s SR ref self Arguments type name description SR ref self reference to the object Return...

Page 219: ...et PBDs Overview Get the PBDs field of the given SR Signature PBD ref Set get_PBDs session_id s SR ref self Arguments type name description SR ref self reference to the object Return Type PBD ref Set...

Page 220: ...alue of the field RPC name get physical size Overview Get the physical size field of the given SR Signature int get_physical_size session_id s SR ref self Arguments type name description SR ref self r...

Page 221: ...name get shared Overview Get the shared field of the given SR Signature bool get_shared session_id s SR ref self Arguments type name description SR ref self reference to the object Return Type bool va...

Page 222: ...field of the given SR Signature void add_to_other_config session_id s SR ref self string key string value Arguments type name description SR ref self reference to the object string key Key to add stri...

Page 223: ...ield of the given SR Signature void set_sm_config session_id s SR ref self string string Map value Arguments type name description SR ref self reference to the object string string Map value New value...

Page 224: ...ing key Key to remove Return Type void RPC name get by uuid Overview Get a reference to the SR instance with the specified UUID Signature SR ref get_by_uuid session_id s string uuid Arguments type nam...

Page 225: ...el 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...

Page 226: ...fer to this disk ROins virtual size int size of disk as presented to the guest in bytes Note that depending on storage backend type requested size may not be respected exactly ROrun physical utilisati...

Page 227: ...y storage type specific snapshot options Return Type VDI ref The ID of the newly created VDI RPC name clone Overview Take an exact copy of the VDI and return a reference to the new disk If any driver...

Page 228: ...isk record SR ref SR The SR that the VDI is in vdi type type The type of the VDI bool sharable true if this disk may be shared bool read only true if this disk may ONLY be mounted read only string str...

Page 229: ...g string Map xenstore data Data to insert into xenstore string string Map sm config Storage specific config Return Type VDI ref The ref of the newly created VDI record RPC name db forget Overview Remo...

Page 230: ...rview Removes a VDI record from the database Signature void forget session_id s VDI ref vdi Arguments type name description VDI ref vdi The VDI to forget about Return Type void RPC name set read only...

Page 231: ...description VDI ref self The VDI to modify int value The new value of the VDI s virtual size Return Type void RPC name set physical utilisation Overview Sets the VDI s physical utilisation field Signa...

Page 232: ...ure string get_uuid 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 name label Overview Get the name l...

Page 233: ...e object Return Type string value of the field RPC name set name description Overview Set the name description field of the given VDI Signature void set_name_description session_id s VDI ref self stri...

Page 234: ...o the object Return Type string vdi operations Map value of the field RPC name get SR Overview Get the SR field of the given VDI Signature SR ref get_SR session_id s VDI ref self Arguments type name d...

Page 235: ...C name get virtual size Overview Get the virtual size field of the given VDI Signature int get_virtual_size session_id s VDI ref self Arguments type name description VDI ref self reference to the obje...

Page 236: ...get sharable Overview Get the sharable field of the given VDI Signature bool get_sharable session_id s VDI ref self Arguments type name description VDI ref self reference to the object Return Type boo...

Page 237: ...ther config field of the given VDI Signature string string Map get_other_config session_id s VDI ref self Arguments type name description VDI ref self reference to the object Return Type string string...

Page 238: ...er config Overview Remove the given key and its corresponding value from the other config field of the given VDI If the key is not in that Map then do nothing Signature void remove_from_other_config s...

Page 239: ...e field RPC name get managed Overview Get the managed field of the given VDI Signature bool get_managed session_id s VDI ref self Arguments type name description VDI ref self reference to the object R...

Page 240: ...tore data field of the given VDI Signature string string Map get_xenstore_data session_id s VDI ref self Arguments type name description VDI ref self reference to the object Return Type string string...

Page 241: ...a Overview Remove the given key and its corresponding value from the xenstore data field of the given VDI If the key is not in that Map then do nothing Signature void remove_from_xenstore_data session...

Page 242: ...ld of the given VDI Signature void add_to_sm_config session_id s VDI ref self string key string value Arguments type name description VDI ref self reference to the object string key Key to add string...

Page 243: ...troy the specified VDI instance Signature void destroy session_id s VDI ref self Arguments type name description VDI ref self reference to the object Return Type void RPC name get by uuid Overview Get...

Page 244: ...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 Signature VDI ref Set get_by_name_label session_id s string...

Page 245: ...type vbd type how the VBD will appear to the guest e g disk or CD RW unpluggable bool true if this VBD will support hot unplug ROrun storage lock bool true if a storage level lock was ac quired ROins...

Page 246: ...VBD ref vbd VDI ref vdi Arguments type name description VBD ref vbd The vbd representing the CDROM like device VDI ref vdi The new VDI to insert Return Type void Possible Error Codes VBD NOT REMOVABLE...

Page 247: ...ame description VBD ref self The VBD to forcibly unplug Return Type void RPC name assert attachable Overview Throws an error if this VBD could not be attached to this VM if the VM were running Intende...

Page 248: ...self Arguments type name description VBD 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...

Page 249: ...ription VBD ref self reference to the object Return Type VM ref value of the field RPC name get VDI Overview Get the VDI field of the given VBD Signature VDI ref get_VDI session_id s VBD ref self Argu...

Page 250: ...f the field RPC name set userdevice Overview Set the userdevice field of the given VBD Signature void set_userdevice session_id s VBD ref self string value Arguments type name description VBD ref self...

Page 251: ...e void RPC name get mode Overview Get the mode field of the given VBD Signature vbd_mode get_mode session_id s VBD ref self Arguments type name description VBD ref self reference to the object Return...

Page 252: ...type Overview Set the type field of the given VBD Signature void set_type session_id s VBD ref self vbd_type value Arguments type name description VBD ref self reference to the object vbd type value...

Page 253: ...eturn Type void RPC name get storage lock Overview Get the storage lock field of the given VBD Signature bool get_storage_lock session_id s VBD ref self Arguments type name description VBD ref self re...

Page 254: ...ield of the given VBD Signature void set_other_config session_id s VBD ref self string string Map value Arguments type name description VBD ref self reference to the object string string Map value New...

Page 255: ...o the object string key Key to remove Return Type void RPC name get currently attached Overview Get the currently attached field of the given VBD Signature bool get_currently_attached session_id s VBD...

Page 256: ...verview Get the runtime properties field of the given VBD Signature string string Map get_runtime_properties session_id s VBD ref self Arguments type name description VBD ref self reference to the obj...

Page 257: ...Get the qos algorithm params field of the given VBD Signature string string Map get_qos_algorithm_params session_id s VBD ref self Arguments type name description VBD ref self reference to the object...

Page 258: ...ew Remove the given key and its corresponding value from the qos algorithm params field of the given VBD If the key is not in that Map then do nothing Signature void remove_from_qos_algorithm_params s...

Page 259: ...ew VBD instance and return its handle Signature VBD ref create session_id s VBD record args Arguments type name description VBD record args All constructor arguments Return Type VBD ref reference to t...

Page 260: ...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 Signature VBD record get_record session_id s VBD...

Page 261: ...w Return a list of all the VBD metrics instances known to the system Signature VBD_metrics ref Set get_all session_id s Return Type VBD metrics ref Set references to all objects RPC name get all recor...

Page 262: ...e get io write kbs Overview Get the io write kbs field of the given VBD metrics Signature float get_io_write_kbs session_id s VBD_metrics ref self Arguments type name description VBD metrics ref self...

Page 263: ...ype name description string uuid UUID of object to return Return Type VBD metrics ref reference to the object RPC name get record Overview Get a record containing the current state of the given VBD me...

Page 264: ...Orun currently attached bool is the SR currently attached on this host RW other config string string Map additional configuration 2 29 2 RPCs associated with class PBD RPC name plug Overview Activate...

Page 265: ...list of all the PBDs known to the system Signature PBD ref Set get_all session_id s Return Type PBD ref Set references to all objects RPC name get all records Overview Return a map of PBD references t...

Page 266: ...name get SR Overview Get the SR field of the given PBD Signature SR ref get_SR session_id s PBD ref self Arguments type name description PBD ref self reference to the object Return Type SR ref value...

Page 267: ...view Get the other config field of the given PBD Signature string string Map get_other_config session_id s PBD ref self Arguments type name description PBD ref self reference to the object Return Type...

Page 268: ...Overview Remove the given key and its corresponding value from the other config field of the given PBD If the key is not in that Map then do nothing Signature void remove_from_other_config session_id...

Page 269: ...to the PBD instance with the specified UUID Signature PBD ref get_by_uuid session_id s string uuid Arguments type name description string uuid UUID of object to return Return Type PBD ref reference to...

Page 270: ...specified crashdump Signature void destroy session_id s crashdump ref self Arguments type name description crashdump ref self The crashdump to destroy Return Type void RPC name get all Overview Retur...

Page 271: ...eld RPC name get VM Overview Get the VM field of the given crashdump Signature VM ref get_VM session_id s crashdump ref self Arguments type name description crashdump ref self reference to the object...

Page 272: ...f the given crashdump Signature void set_other_config session_id s crashdump ref self string string Map value Arguments type name description crashdump ref self reference to the object string string M...

Page 273: ...ey to remove Return Type void RPC name get by uuid Overview Get a reference to the crashdump instance with the specified UUID Signature crashdump ref get_by_uuid session_id s string uuid Arguments typ...

Page 274: ...uuid Overview Get the uuid field of the given VTPM Signature string get_uuid session_id s VTPM ref self Arguments type name description VTPM ref self reference to the object Return Type string value o...

Page 275: ...All constructor arguments Return Type VTPM ref reference to the newly created object RPC name destroy Overview Destroy the specified VTPM instance Signature void destroy session_id s VTPM ref self Ar...

Page 276: ...ame 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...

Page 277: ...listening 2 32 2 RPCs associated with class console RPC name get all Overview Return a list of all the consoles known to the system Signature console ref Set get_all session_id s Return Type console...

Page 278: ...onsole protocol value of the field RPC name get location Overview Get the location field of the given console Signature string get_location session_id s console ref self Arguments type name descriptio...

Page 279: ...of the given console Signature void set_other_config session_id s console ref self string string Map value Arguments type name description console ref self reference to the object string string Map v...

Page 280: ...f reference to the object string key Key to remove Return Type void RPC name create Overview Create a new console instance and return its handle Signature console ref create session_id s console recor...

Page 281: ...ents type name description string uuid UUID of object to return Return Type console ref reference to the object RPC name get record Overview Get a record containing the current state of the given cons...

Page 282: ...d field of the given user Signature string get_uuid session_id s user ref self Arguments type name description user ref self reference to the object Return Type string value of the field RPC name get...

Page 283: ...f self reference to the object string value New value to set Return Type void RPC name create Overview Create a new user instance and return its handle Signature user ref create session_id s user reco...

Page 284: ...ng uuid Arguments type name description string uuid UUID of object to return Return Type user ref reference to the object RPC name get record Overview Get a record containing the current state of the...

Page 285: ...se to allow better automatic response to failures proper internationalisation of any error message and easier debugging On the wire these are transmitted like this struct member name Status name value...

Page 286: ...t forward messages because the host cannot be contacted The host may be switched off or there may be network connectivity problems Signature CANNOT_CONTACT_HOST host CANNOT EVACUATE HOST This host can...

Page 287: ...No parameters CANNOT PLUG VIF Cannot plug VIF Signature CANNOT_PLUG_VIF VIF CHANGE PASSWORD REJECTED The system rejected the password change request perhaps the new password was too short Signature CH...

Page 288: ...evice with the name given already exists on the selected VM Signature DEVICE_ALREADY_EXISTS device DEVICE ATTACH TIMEOUT A timeout happened while attempting to attach a device to a VM Signature DEVICE...

Page 289: ...nvalid object reference The object may have recently been deleted The class parameter gives the type of reference given and the handle parameter echoes the bad value given Signature HANDLE_INVALID cla...

Page 290: ...d on the Pool No parameters HA NOT INSTALLED The operation could not be performed because the HA software is not installed on this host Signature HA_NOT_INSTALLED host HA NO PLAN Cannot find a plan fo...

Page 291: ...g this may be because attaching the network on this host would require other networks that are currently active to be taken down Signature HOST_CANNOT_ATTACH_NETWORK host network HOST CANNOT DESTROY S...

Page 292: ...ly on a slave Please pass API calls via the master host Signature HOST_IS_SLAVE Master IP address HOST MASTER CANNOT TALK BACK The master reports that it cannot talk back to the slave on the supplied...

Page 293: ...not known to it Perhaps the Host was deleted from the master s database Signature HOST_UNKNOWN_TO_MASTER host IMPORT ERROR The VM could not be imported is the file corrupt Signature IMPORT_ERROR msg...

Page 294: ...name is invalid Signature INVALID_DEVICE device INVALID IP ADDRESS SPECIFIED A required parameter contained an invalid IP address Signature INVALID_IP_ADDRESS_SPECIFIED parameter INVALID PATCH The upl...

Page 295: ...S WITH CURRENT OPERATIONS The host joining the pool cannot have any VMs with active tasks No parameters JOINING HOST CONNECTION FAILED There was an error connecting to the host while joining it in the...

Page 296: ...has expired Please contact your support representative No parameters LICENSE PROCESSING ERROR There was an error processing your license Please contact your support representative No parameters LOCAT...

Page 297: ...call a method that does not exist The method name that you used is echoed Signature MESSAGE_METHOD_UNKNOWN method MESSAGE PARAMETER COUNT MISMATCH You tried to call a method with the incorrect number...

Page 298: ...NOT ALLOWED ON OEM EDITION This command is not allowed on the OEM edition Signature NOT_ALLOWED_ON_OEM_EDITION command NOT IMPLEMENTED The function is not implemented Signature NOT_IMPLEMENTED functio...

Page 299: ...RATION NOT ALLOWED You attempted an operation that was not allowed Signature OPERATION_NOT_ALLOWED reason OTHER OPERATION IN PROGRESS Another operation involving the object is currently in progress Si...

Page 300: ...id_list PATCH PRECHECK FAILED UNKNOWN ERROR The patch precheck stage failed with an unknown error See attached info for more details Signature PATCH_PRECHECK_FAILED_UNKNOWN_ERROR patch info PATCH PREC...

Page 301: ...annot be performed because the pif is bonded Signature PIF_ALREADY_BONDED PIF PIF BOND NEEDS MORE MEMBERS A bond must consist of at least two member interfaces No parameters PIF CANNOT BOND CROSS HOST...

Page 302: ...t represents an aspect of the physical host configuration and so cannot be destroyed The parameter echoes the PIF handle you gave Signature PIF_IS_PHYSICAL PIF PIF VLAN EXISTS You tried to create a PI...

Page 303: ...mentioned in the backup are No parameters RESTORE TARGET MISSING DEVICE The restore could not be performed because a network interface is missing Signature RESTORE_TARGET_MISSING_DEVICE device SESSION...

Page 304: ...erface on a slave cannot be disabled because the slave would enter emergency mode No parameters SR ATTACH FAILED Attaching this SR failed Signature SR_ATTACH_FAILED sr SR BACKEND FAILURE There was an...

Page 305: ...ed because the SR is not empty No parameters SR NOT SHARABLE The PBD could not be plugged because the SR is in use by another host and is not marked as sharable Signature SR_NOT_SHARABLE sr host SR OP...

Page 306: ...ystem status from an OEM host No parameters SYSTEM STATUS RETRIEVAL FAILED Retrieving system status from the host failed A diagnostic reason suitable for support organisa tions is also returned Signat...

Page 307: ...ted by this implementation The fully qualified field name and the value that you tried to set are returned Also returned is a developer only diagnostic reason Signature VALUE_NOT_SUPPORTED field value...

Page 308: ...BD TRAY LOCKED This VM has locked the DVD drive tray so the disk cannot be ejected Signature VBD_TRAY_LOCKED vbd VDI IN USE This operation cannot be performed because this VDI is in use by some other...

Page 309: ...ignature VDI_MISSING sr vdi VDI NOT AVAILABLE This operation cannot be performed because this VDI could not be properly attached to the VM Signature VDI_NOT_AVAILABLE vdi VDI READONLY The operation re...

Page 310: ...xpected actual VM CANNOT DELETE DEFAULT TEMPLATE You cannot delete the specified default template Signature VM_CANNOT_DELETE_DEFAULT_TEMPLATE vm VM DUPLICATE VBD DEVICE The specified VM has a duplicat...

Page 311: ...ce destination msg VM MISSING PV DRIVERS You attempted an operation on a VM which requires PV drivers to be installed but the drivers were not detected Signature VM_MISSING_PV_DRIVERS vm VM NO CRASHDU...

Page 312: ...ached to the Network Signature VM_REQUIRES_NETWORK vm network VM REQUIRES SR You attempted to run a VM on a host which doesn t have access to an SR needed by the VM The VM has at least one VBD attache...

Page 313: ...on a CPU that has a potentially incompatable set of feature flags to those the VM requires If you want to override this warning then use the force option Signature VM_UNSAFE_BOOT vm XMLRPC UNMARSHAL...

Search results

Summary of Contents for DL385 - ProLiant - G5

Reviews:

Related manuals for DL385 - ProLiant - G5

Brands by name

Popular brands

XenSource DL385 - ProLiant - G5, Manual

Search results

Summary of Contents for DL385 - ProLiant - G5

Reviews:

Related manuals for DL385 - ProLiant - G5

Brands by name

Popular brands