xenAPI

package module
v0.0.0-...-a9c4b93 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 12, 2017 License: MIT Imports: 7 Imported by: 3

README

Go XenAPI client library

This is a client library for the Xapi toolstack (http://xapi-project.github.io/).

This library covers the entire XenAPI and I have successfully used it to implement a Terraform plugin that interfaces Citrix XenServer. That being said, this library is not production-ready yet. Use it at your own risk, and don't expect everything in this library to work out of the box.

Usage example

The following example demonstrates how to instruct XenServer to start a VM with a given name label:

package main

import (
    "fmt"
    "github.com/amfranz/go-xen-api-client"
)

const XEN_API_URL string = "https://IP.OF.XEN.SERVER"
const XEN_API_USERNAME string = "USERNAME"
const XEN_API_PASSWORD string = "PASSWORD"
const VM_NAME_LABEL = "VM NAME LABEL"

func main() {
    xapi, err := xenAPI.NewClient(XEN_API_URL, nil)
    if err != nil {
        panic(err)
    }

    session, err := xapi.Session.LoginWithPassword(XEN_API_USERNAME, XEN_API_PASSWORD, "1.0", "example")
    if err != nil {
        panic(err)
    }

    vms, err := xapi.VM.GetByNameLabel(session, VM_NAME_LABEL)
    if err != nil {
        panic(err)
    }

    if len(vms) == 0 {
        panic(fmt.Errorf("No VM template with name label %q has been found", VM_NAME_LABEL))
    }

    if len(vms) > 1 {
        panic(fmt.Errorf("More than one VM with name label %q has been found", VM_NAME_LABEL))
    }

    vm := vms[0]

    xapi.VM.Start(session, vm, false, false)
    if err != nil {
        panic(err)
    }

    err = xapi.Session.Logout(session)
    if err != nil {
        panic(err)
    }
}

Project status

The most important missing pieces before this library is production-ready are:

  • A strategy how to handle the differences in the XenAPI versions.
  • Tests, at least for the various data type conversions.
  • Embed XenAPI documentation as GoDoc in the generated code.
  • Better error messages.
  • Usage examples.

Contributions welcome!

Please note that I want to keep this library lean. I envision it to merely provide a one-to-one mapping of XenAPI functions to Go functions. Because of this, I will likely not accept pull requests that implement higher level functionality.

Implementation notes

Most of the code in this library is generated from a description of the XenAPI. This description is the file xenapi.json, the source of which is the XenAPI documentation at http://xapi-project.github.io/:

The list of error code constants in error.go is borrowed from xapi-projects OCaml client:

Documentation

Index

Constants

View Source 
const (
	ERR_MESSAGE_DEPRECATED = "MESSAGE_DEPRECATED"
	ERR_MESSAGE_REMOVED    = "MESSAGE_REMOVED"

	ERR_PERMISSION_DENIED                  = "PERMISSION_DENIED"
	ERR_INTERNAL_ERROR                     = "INTERNAL_ERROR"
	ERR_MAP_DUPLICATE_KEY                  = "MAP_DUPLICATE_KEY"
	ERR_DB_UNIQUENESS_CONSTRAINT_VIOLATION = "DB_UNIQUENESS_CONSTRAINT_VIOLATION"
	ERR_LOCATION_NOT_UNIQUE                = "LOCATION_NOT_UNIQUE"
	ERR_MESSAGE_METHOD_UNKNOWN             = "MESSAGE_METHOD_UNKNOWN"
	ERR_MESSAGE_PARAMETER_COUNT_MISMATCH   = "MESSAGE_PARAMETER_COUNT_MISMATCH"
	ERR_VALUE_NOT_SUPPORTED                = "VALUE_NOT_SUPPORTED"
	ERR_INVALID_VALUE                      = "INVALID_VALUE"
	ERR_MEMORY_CONSTRAINT_VIOLATION        = "MEMORY_CONSTRAINT_VIOLATION"
	ERR_FIELD_TYPE_ERROR                   = "FIELD_TYPE_ERROR"
	ERR_SESSION_AUTHENTICATION_FAILED      = "SESSION_AUTHENTICATION_FAILED"
	ERR_SESSION_INVALID                    = "SESSION_INVALID"
	ERR_CHANGE_PASSWORD_REJECTED           = "CHANGE_PASSWORD_REJECTED"
	ERR_USER_IS_NOT_LOCAL_SUPERUSER        = "USER_IS_NOT_LOCAL_SUPERUSER"
	ERR_CANNOT_CONTACT_HOST                = "CANNOT_CONTACT_HOST"
	ERR_NOT_SUPPORTED_DURING_UPGRADE       = "NOT_SUPPORTED_DURING_UPGRADE"

	ERR_HANDLE_INVALID = "HANDLE_INVALID"
	ERR_UUID_INVALID   = "UUID_INVALID"

	ERR_VM_HVM_REQUIRED  = "VM_HVM_REQUIRED"
	ERR_VM_NO_VCPUS      = "VM_NO_VCPUS"
	ERR_VM_TOOMANY_VCPUS = "VM_TOO_MANY_VCPUS"
	ERR_VM_IS_PROTECTED  = "VM_IS_PROTECTED"

	ERR_HOST_IN_USE                     = "HOST_IN_USE"
	ERR_HOST_IN_EMERGENCY_MODE          = "HOST_IN_EMERGENCY_MODE"
	ERR_HOST_CANNOT_READ_METRICS        = "HOST_CANNOT_READ_METRICS"
	ERR_HOST_DISABLED                   = "HOST_DISABLED"
	ERR_HOST_DISABLED_UNTIL_REBOOT      = "HOST_DISABLED_UNTIL_REBOOT"
	ERR_HOST_NOT_DISABLED               = "HOST_NOT_DISABLED"
	ERR_HOST_NOT_LIVE                   = "HOST_NOT_LIVE"
	ERR_HOST_IS_LIVE                    = "HOST_IS_LIVE"
	ERR_HOST_POWER_ON_MODE_DISABLED     = "HOST_POWER_ON_MODE_DISABLED"
	ERR_HOST_NOT_ENOUGH_FREE_MEMORY     = "HOST_NOT_ENOUGH_FREE_MEMORY"
	ERR_NO_HOSTS_AVAILABLE              = "NO_HOSTS_AVAILABLE"
	ERR_HOST_OFFLINE                    = "HOST_OFFLINE"
	ERR_HOST_CANNOT_DESTROY_SELF        = "HOST_CANNOT_DESTROY_SELF"
	ERR_HOST_IS_SLAVE                   = "HOST_IS_SLAVE"
	ERR_HOST_NAME_INVALID               = "HOST_NAME_INVALID"
	ERR_HOST_HAS_RESIDENT_VMS           = "HOST_HAS_RESIDENT_VMS"
	ERR_HOSTS_FAILED_TO_ENABLE_CACHING  = "HOSTS_FAILED_TO_ENABLE_CACHING"
	ERR_HOSTS_FAILED_TO_DISABLE_CACHING = "HOSTS_FAILED_TO_DISABLE_CACHING"
	ERR_HOST_CANNOT_SEE_SR              = "HOST_CANNOT_SEE_SR"

	// (* HOST ERRORS WHICH EXPLAIN WHY THE HOST IS IN EMERGENCY MODE *)
	ERR_HOST_ITS_OWN_SLAVE = "HOST_ITS_OWN_SLAVE"
	ERR_HOST_STILL_BOOTING = "HOST_STILL_BOOTING"

	// (* LICENSE *)
	ERR_HOST_HAS_NO_MANAGEMENT_IP    = "HOST_HAS_NO_MANAGEMENT_IP"
	ERR_HOST_MASTER_CANNOT_TALK_BACK = "HOST_MASTER_CANNOT_TALK_BACK"
	ERR_HOST_UNKNOWN_TO_MASTER       = "HOST_UNKNOWN_TO_MASTER"

	// (* SHOULD BE FENCED *)
	ERR_HOST_BROKEN                         = "HOST_BROKEN"
	ERR_INTERFACE_HAS_NO_IP                 = "INTERFACE_HAS_NO_IP"
	ERR_INVALID_IP_ADDRESS_SPECIFIED        = "INVALID_IP_ADDRESS_SPECIFIED"
	ERR_PIF_HAS_NO_NETWORK_CONFIGURATION    = "PIF_HAS_NO_NETWORK_CONFIGURATION"
	ERR_PIF_HAS_NO_V6_NETWORK_CONFIGURATION = "PIF_HAS_NO_V6_NETWORK_CONFIGURATION"

	ERR_DEVICE_ATTACH_TIMEOUT  = "DEVICE_ATTACH_TIMEOUT"
	ERR_DEVICE_DETACH_TIMEOUT  = "DEVICE_DETACH_TIMEOUT"
	ERR_DEVICE_DETACH_REJECTED = "DEVICE_DETACH_REJECTED"

	ERR_OPERATION_NOT_ALLOWED                                                       = "OPERATION_NOT_ALLOWED"
	ERR_OPERATION_BLOCKED                                                           = "OPERATION_BLOCKED"
	ERR_NETWORK_ALREADY_CONNECTED                                                   = "NETWORK_ALREADY_CONNECTED"
	ERR_CANNOT_DESTROY_SYSTEM_NETWORK                                               = "CANNOT_DESTROY_SYSTEM_NETWORK"
	ERR_PIF_IS_PHYSICAL                                                             = "PIF_IS_PHYSICAL"
	ERR_PIF_IS_VLAN                                                                 = "PIF_IS_VLAN"
	ERR_PIF_VLAN_EXISTS                                                             = "PIF_VLAN_EXISTS"
	ERR_PIF_VLAN_STILL_EXISTS                                                       = "PIF_VLAN_STILL_EXISTS"
	ERR_PIF_DEVICE_NOT_FOUND                                                        = "PIF_DEVICE_NOT_FOUND"
	ERR_PIF_ALREADY_BONDED                                                          = "PIF_ALREADY_BONDED"
	ERR_PIF_CANNOT_BOND_CROSS_HOST                                                  = "PIF_CANNOT_BOND_CROSS_HOST"
	ERR_PIF_BOND_NEEDS_MORE_MEMBERS                                                 = "PIF_BOND_NEEDS_MORE_MEMBERS"
	ERR_PIF_CONFIGURATION_ERROR                                                     = "PIF_CONFIGURATION_ERROR"
	ERR_PIF_IS_MANAGEMENT_IFACE                                                     = "PIF_IS_MANAGEMENT_INTERFACE"
	ERR_PIF_INCOMPATIBLE_PRIMARY_ADDRESS_TYPE                                       = "PIF_INCOMPATIBLE_PRIMARY_ADDRESS_TYPE"
	ERR_REQUIRED_PIF_IS_UNPLUGGED                                                   = "REQUIRED_PIF_IS_UNPLUGGED"
	ERR_PIF_DOES_NOT_ALLOW_UNPLUG                                                   = "PIF_DOES_NOT_ALLOW_UNPLUG"
	ERR_PIF_UNMANAGED                                                               = "PIF_UNMANAGED"
	ERR_CANNOT_PLUG_BOND_SLAVE                                                      = "CANNOT_PLUG_BOND_SLAVE"
	ERR_CANNOT_ADD_VLAN_TO_BOND_SLAVE                                               = "CANNOT_ADD_VLAN_TO_BOND_SLAVE"
	ERR_CANNOT_ADD_TUNNEL_TO_BOND_SLAVE                                             = "CANNOT_ADD_TUNNEL_TO_BOND_SLAVE"
	ERR_CANNOT_CHANGE_PIF_PROPERTIES                                                = "CANNOT_CHANGE_PIF_PROPERTIES"
	ERR_INCOMPATIBLE_PIF_PROPERTIES                                                 = "INCOMPATIBLE_PIF_PROPERTIES"
	ERR_SLAVE_REQUIRES_MANAGEMENT_IFACE                                             = "SLAVE_REQUIRES_MANAGEMENT_INTERFACE"
	ERR_VIF_IN_USE                                                                  = "VIF_IN_USE"
	ERR_CANNOT_PLUG_VIF                                                             = "CANNOT_PLUG_VIF"
	ERR_MAC_STILL_EXISTS                                                            = "MAC_STILL_EXISTS"
	ERR_MAC_DOES_NOT_EXIST                                                          = "MAC_DOES_NOT_EXIST"
	ERR_MAC_INVALID                                                                 = "MAC_INVALID"
	ERR_DUPLICATE_PIF_DEVICE_NAME                                                   = "DUPLICATE_PIF_DEVICE_NAME"
	ERR_COULD_NOT_FIND_NETWORK_INTERFACE_WITH_SPECIFIED_DEVICE_NAME_AND_MAC_ADDRESS = "COULD_NOT_FIND_NETWORK_INTERFACE_WITH_SPECIFIED_DEVICE_NAME_AND_MAC_ADDRESS"

	ERR_OPENVSWITCH_NOT_ACTIVE                                                   = "OPENVSWITCH_NOT_ACTIVE"
	ERR_TRANSPORT_PIF_NOT_CONFIGURED                                             = "TRANSPORT_PIF_NOT_CONFIGURED"
	ERR_IS_TUNNEL_ACCESS_PIF                                                     = "IS_TUNNEL_ACCESS_PIF"
	ERR_PIF_TUNNEL_STILL_EXISTS                                                  = "PIF_TUNNEL_STILL_EXISTS"
	ERR_BRIDGE_NOT_AVAILABLE                                                     = "BRIDGE_NOT_AVAILABLE"
	ERR_VLAN_TAG_INVALID                                                         = "VLAN_TAG_INVALID"
	ERR_VM_BAD_POWER_STATE                                                       = "VM_BAD_POWER_STATE"
	ERR_VM_IS_TEMPLATE                                                           = "VM_IS_TEMPLATE"
	ERR_VM_IS_SNAPSHOT                                                           = "VM_IS_SNAPSHOT"
	ERR_OTHER_OPERATION_IN_PROGRESS                                              = "OTHER_OPERATION_IN_PROGRESS"
	ERR_VBD_NOT_REMOVABLE_MEDIA                                                  = "VBD_NOT_REMOVABLE_MEDIA"
	ERR_VBD_NOT_UNPLUGGABLE                                                      = "VBD_NOT_UNPLUGGABLE"
	ERR_VBD_NOT_EMPTY                                                            = "VBD_NOT_EMPTY"
	ERR_VBD_IS_EMPTY                                                             = "VBD_IS_EMPTY"
	ERR_VBD_TRAY_LOCKED                                                          = "VBD_TRAY_LOCKED"
	ERR_VBD_MISSING                                                              = "VBD_MISSING"
	ERR_VM_NO_EMPTY_CD_VBD                                                       = "VM_NO_EMPTY_CD_VBD"
	ERR_VM_SNAPSHOT_FAILED                                                       = "VM_SNAPSHOT_FAILED"
	ERR_VM_SNAPSHOT_WITH_QUIESCE_FAILED                                          = "VM_SNAPSHOT_WITH_QUIESCE_FAILED"
	ERR_VM_SNAPSHOT_WITH_QUIESCE_TIMEOUT                                         = "VM_SNAPSHOT_WITH_QUIESCE_TIMEOUT"
	ERR_VM_SNAPSHOT_WITH_QUIESCE_PLUGIN_DOES_NOT_RESPOND                         = "VM_SNAPSHOT_WITH_QUIESCE_PLUGIN_DEOS_NOT_RESPOND"
	ERR_VM_SNAPSHOT_WITH_QUIESCE_NOT_SUPPORTED                                   = "VM_SNAPSHOT_WITH_QUIESCE_NOT_SUPPORTED"
	ERR_XEN_VSS_REQ_ERROR_INIT_FAILED                                            = "XEN_VSS_REQ_ERROR_INIT_FAILED"
	ERR_XEN_VSS_REQ_ERROR_PROV_NOT_LOADED                                        = "XEN_VSS_REQ_ERROR_PROV_NOT_LOADED"
	ERR_XEN_VSS_REQ_ERROR_NO_VOLUMES_SUPPORTED                                   = "XEN_VSS_REQ_ERROR_NO_VOLUMES_SUPPORTED"
	ERR_XEN_VSS_REQ_ERROR_START_SNAPSHOT_SET_FAILED                              = "XEN_VSS_REQ_ERROR_START_SNAPSHOT_SET_FAILED"
	ERR_XEN_VSS_REQ_ERROR_ADDING_VOLUME_TO_SNAPSET_FAILED                        = "XEN_VSS_REQ_ERROR_ADDING_VOLUME_TO_SNAPSET_FAILED"
	ERR_XEN_VSS_REQ_ERROR_PREPARING_WRITERS                                      = "XEN_VSS_REQ_ERROR_PREPARING_WRITERS"
	ERR_XEN_VSS_REQ_ERROR_CREATING_SNAPSHOT                                      = "XEN_VSS_REQ_ERROR_CREATING_SNAPSHOT"
	ERR_XEN_VSS_REQ_ERROR_CREATING_SNAPSHOT_XML_STRING                           = "XEN_VSS_REQ_ERROR_CREATING_SNAPSHOT_XML_STRING"
	ERR_VM_REVERT_FAILED                                                         = "VM_REVERT_FAILED"
	ERR_VM_CHECKPOINT_SUSPEND_FAILED                                             = "VM_CHECKPOINT_SUSPEND_FAILED"
	ERR_VM_CHECKPOINT_RESUME_FAILED                                              = "VM_CHECKPOINT_RESUME_FAILED"
	ERR_VM_UNSAFE_BOOT                                                           = "VM_UNSAFE_BOOT"
	ERR_VM_REQUIRES_SR                                                           = "VM_REQUIRES_SR"
	ERR_VM_REQUIRES_VDI                                                          = "VM_REQUIRES_VDI"
	ERR_VM_REQUIRES_NET                                                          = "VM_REQUIRES_NETWORK"
	ERR_VM_REQUIRES_GPU                                                          = "VM_REQUIRES_GPU"
	ERR_VM_REQUIRES_VGPU                                                         = "VM_REQUIRES_VGPU"
	ERR_VM_REQUIRES_IOMMU                                                        = "VM_REQUIRES_IOMMU"
	ERR_VM_HOST_INCOMPATIBLE_VERSION                                             = "VM_HOST_INCOMPATIBLE_VERSION"
	ERR_VM_HOST_INCOMPATIBLE_VIRTUAL_HARDWARE_PLATFORM_VERSION                   = "VM_HOST_INCOMPATIBLE_VIRTUAL_HARDWARE_PLATFORM_VERSION"
	ERR_VM_HAS_PCI_ATTACHED                                                      = "VM_HAS_PCI_ATTACHED"
	ERR_VM_HAS_VGPU                                                              = "VM_HAS_VGPU"
	ERR_HOST_CANNOT_ATTACH_NETWORK                                               = "HOST_CANNOT_ATTACH_NETWORK"
	ERR_VM_NO_SUSPEND_SR                                                         = "VM_NO_SUSPEND_SR"
	ERR_VM_NO_CRASHDUMP_SR                                                       = "VM_NO_CRASHDUMP_SR"
	ERR_VM_MIGRATE_FAILED                                                        = "VM_MIGRATE_FAILED"
	ERR_VM_MISSING_PV_DRIVERS                                                    = "VM_MISSING_PV_DRIVERS"
	ERR_VM_FAILED_SHUTDOWN_ACK                                                   = "VM_FAILED_SHUTDOWN_ACKNOWLEDGMENT"
	ERR_VM_OLD_PV_DRIVERS                                                        = "VM_OLD_PV_DRIVERS"
	ERR_VM_LACKS_FEATURE_SHUTDOWN                                                = "VM_LACKS_FEATURE_SHUTDOWN"
	ERR_VM_LACKS_FEATURE_SUSPEND                                                 = "VM_LACKS_FEATURE_SUSPEND"
	ERR_VM_LACKS_FEATURE_VCPU_HOTPLUG                                            = "VM_LACKS_FEATURE_VCPU_HOTPLUG"
	ERR_VM_CANNOT_DELETE_DEFAULT_TEMPLATE                                        = "VM_CANNOT_DELETE_DEFAULT_TEMPLATE"
	ERR_VM_MEMORY_SIZE_TOO_LOW                                                   = "VM_MEMORY_SIZE_TOO_LOW"
	ERR_VM_MEMORY_TARGET_WAIT_TIMEOUT                                            = "VM_MEMORY_TARGET_WAIT_TIMEOUT"
	ERR_VM_SHUTDOWN_TIMEOUT                                                      = "VM_SHUTDOWN_TIMEOUT"
	ERR_VM_DUPLICATE_VBD_DEVICE                                                  = "VM_DUPLICATE_VBD_DEVICE"
	ERR_ILLEGAL_VBD_DEVICE                                                       = "ILLEGAL_VBD_DEVICE"
	ERR_VM_NOT_RESIDENT_HERE                                                     = "VM_NOT_RESIDENT_HERE"
	ERR_VM_CRASHED                                                               = "VM_CRASHED"
	ERR_VM_REBOOTED                                                              = "VM_REBOOTED"
	ERR_VM_HALTED                                                                = "VM_HALTED"
	ERR_VM_ATTACHED_TO_MORE_THAN_ONE_VDI_WITH_TIMEOFFSET_MARKED_AS_RESET_ON_BOOT = "VM_ATTACHED_TO_MORE_THAN_ONE_VDI_WITH_TIMEOFFSET_MARKED_AS_RESET_ON_BOOT"
	ERR_VMS_FAILED_TO_COOPERATE                                                  = "VMS_FAILED_TO_COOPERATE"
	ERR_VM_PV_DRIVERS_IN_USE                                                     = "VM_PV_DRIVERS_IN_USE"
	ERR_DOMAIN_EXISTS                                                            = "DOMAIN_EXISTS"
	ERR_CANNOT_RESET_CONTROL_DOMAIN                                              = "CANNOT_RESET_CONTROL_DOMAIN"
	ERR_NOT_SYSTEM_DOMAIN                                                        = "NOT_SYSTEM_DOMAIN"
	ERR_ONLY_PROVISION_TEMPLATE                                                  = "PROVISION_ONLY_ALLOWED_ON_TEMPLATE"
	ERR_ONLY_REVERT_SNAPSHOT                                                     = "REVERT_ONLY_ALLOWED_ON_SNAPSHOT"
	ERR_PROVISION_FAILED_OUT_OF_SPACE                                            = "PROVISION_FAILED_OUT_OF_SPACE"
	ERR_BOOTLOADER_FAILED                                                        = "BOOTLOADER_FAILED"
	ERR_UNKNOWN_BOOTLOADER                                                       = "UNKNOWN_BOOTLOADER"
	ERR_OBJECT_NOLONGER_EXISTS                                                   = "OBJECT_NOLONGER_EXISTS"
	ERR_SR_ATTACH_FAILED                                                         = "SR_ATTACH_FAILED"
	ERR_SR_FULL                                                                  = "SR_FULL"
	ERR_SR_HAS_PBD                                                               = "SR_HAS_PBD"
	ERR_SR_REQUIRES_UPGRADE                                                      = "SR_REQUIRES_UPGRADE"
	ERR_SR_IS_CACHE_SR                                                           = "SR_IS_CACHE_SR"
	ERR_VDI_IN_USE                                                               = "VDI_IN_USE"
	ERR_VDI_IS_SHARABLE                                                          = "VDI_IS_SHARABLE"
	ERR_VDI_READONLY                                                             = "VDI_READONLY"
	ERR_VDI_TOO_SMALL                                                            = "VDI_TOO_SMALL"
	ERR_VDI_NOT_SPARSE                                                           = "VDI_NOT_SPARSE"
	ERR_VDI_IS_A_PHYSICAL_DEVICE                                                 = "VDI_IS_A_PHYSICAL_DEVICE"
	ERR_VDI_IS_NOT_ISO                                                           = "VDI_IS_NOT_ISO"
	ERR_VBD_CDS_MUST_BE_READONLY                                                 = "VBD_CDS_MUST_BE_READONLY"

	// (* CA-83260 *)
	ERR_DISK_VBD_MUST_BE_READWRITE_FOR_HVM           = "DISK_VBD_MUST_BE_READWRITE_FOR_HVM"
	ERR_HOST_CD_DRIVE_EMPTY                          = "HOST_CD_DRIVE_EMPTY"
	ERR_VDI_NOT_AVAILABLE                            = "VDI_NOT_AVAILABLE"
	ERR_VDI_HAS_RRDS                                 = "VDI_HAS_RRDS"
	ERR_VDI_LOCATION_MISSING                         = "VDI_LOCATION_MISSING"
	ERR_VDI_CONTENT_ID_MISSING                       = "VDI_CONTENT_ID_MISSING"
	ERR_VDI_MISSING                                  = "VDI_MISSING"
	ERR_VDI_INCOMPATIBLE_TYPE                        = "VDI_INCOMPATIBLE_TYPE"
	ERR_VDI_NOT_MANAGED                              = "VDI_NOT_MANAGED"
	ERR_VDI_IO_ERROR                                 = "VDI_IO_ERROR"
	ERR_VDI_ON_BOOT_MODE_INCOMPATIBLE_WITH_OPERATION = "VDI_ON_BOOT_MODE_INCOMPATIBLE_WITH_OPERATION"
	ERR_VDI_NOT_IN_MAP                               = "VDI_NOT_IN_MAP"
	ERR_CANNOT_CREATE_STATE_FILE                     = "CANNOT_CREATE_STATE_FILE"

	ERR_OPERATION_PARTIALLY_FAILED = "OPERATION_PARTIALLY_FAILED"

	ERR_SR_UUID_EXISTS             = "SR_UUID_EXISTS"
	ERR_SR_NO_PBDS                 = "SR_HAS_NO_PBDS"
	ERR_SR_HAS_MULTIPLE_PBDS       = "SR_HAS_MULTIPLE_PBDS"
	ERR_SR_BACKEND_FAILURE         = "SR_BACKEND_FAILURE"
	ERR_SR_UNKNOWN_DRIVER          = "SR_UNKNOWN_DRIVER"
	ERR_SR_VDI_LOCKING_FAILED      = "SR_VDI_LOCKING_FAILED"
	ERR_SR_NOT_EMPTY               = "SR_NOT_EMPTY"
	ERR_SR_DEVICE_IN_USE           = "SR_DEVICE_IN_USE"
	ERR_SR_OPERATION_NOT_SUPPORTED = "SR_OPERATION_NOT_SUPPORTED"
	ERR_SR_NOT_SHARABLE            = "SR_NOT_SHARABLE"
	ERR_SR_INDESTRUCTIBLE          = "SR_INDESTRUCTIBLE"
	ERR_SR_DETACHED_ON_MASTER      = "SR_DETACHED_ON_MASTER"
	ERR_SR_ATTACHED_ON_SLAVE       = "SR_ATTACHED_ON_SLAVE"
	ERR_CLUSTERED_SR_DEGRADED      = "CLUSTERED_SR_DEGRADED"

	ERR_SM_PLUGIN_COMMUNICATION_FAILURE = "SM_PLUGIN_COMMUNICATION_FAILURE"

	ERR_PBD_EXISTS = "PBD_EXISTS"

	ERR_NOT_IMPLEMENTED                  = "NOT_IMPLEMENTED"
	ERR_DEVICE_ALREADY_ATTACHED          = "DEVICE_ALREADY_ATTACHED"
	ERR_DEVICE_ALREADY_DETACHED          = "DEVICE_ALREADY_DETACHED"
	ERR_DEVICE_ALREADY_EXISTS            = "DEVICE_ALREADY_EXISTS"
	ERR_DEVICE_NOT_ATTACHED              = "DEVICE_NOT_ATTACHED"
	ERR_NETWORK_CONTAINS_PIF             = "NETWORK_CONTAINS_PIF"
	ERR_NETWORK_CONTAINS_VIF             = "NETWORK_CONTAINS_VIF"
	ERR_GPU_GROUP_CONTAINS_VGPU          = "GPU_GROUP_CONTAINS_VGPU"
	ERR_GPU_GROUP_CONTAINS_PGPU          = "GPU_GROUP_CONTAINS_PGPU"
	ERR_GPU_GROUP_CONTAINS_NO_PGPUS      = "GPU_GROUP_CONTAINS_NO_PGPUS"
	ERR_INVALID_DEVICE                   = "INVALID_DEVICE"
	ERR_EVENTS_LOST                      = "EVENTS_LOST"
	ERR_EVENT_SUBSCRIPTION_PARSE_FAILURE = "EVENT_SUBSCRIPTION_PARSE_FAILURE"
	ERR_EVENT_FROM_TOKEN_PARSE_FAILURE   = "EVENT_FROM_TOKEN_PARSE_FAILURE"
	ERR_SESSION_NOT_REGISTERED           = "SESSION_NOT_REGISTERED"

	ERR_PGPU_IN_USE_BY_VM                          = "PGPU_IN_USE_BY_VM"
	ERR_PGPU_NOT_COMPATIBLE_WITH_GPU_GROUP         = "PGPU_NOT_COMPATIBLE_WITH_GPU_GROUP"
	ERR_PGPU_INSUFFICIENT_CAPACITY_FOR_VGPU        = "PGPU_INSUFFICIENT_CAPACITY_FOR_VGPU"
	ERR_VGPU_TYPE_NOT_ENABLED                      = "VGPU_TYPE_NOT_ENABLED"
	ERR_VGPU_TYPE_NOT_SUPPORTED                    = "VGPU_TYPE_NOT_SUPPORTED"
	ERR_VGPU_TYPE_NOT_COMPATIBLE_WITH_RUNNING_TYPE = "VGPU_TYPE_NOT_COMPATIBLE_WITH_RUNNING_TYPE"

	ERR_IMPORT_ERROR_GENERIC                  = "IMPORT_ERROR"
	ERR_IMPORT_ERROR_PREMATURE_EOF            = "IMPORT_ERROR_PREMATURE_EOF"
	ERR_IMPORT_ERROR_SOME_CHECKSUMS_FAILED    = "IMPORT_ERROR_SOME_CHECKSUMS_FAILED"
	ERR_IMPORT_ERROR_CANNOT_HANDLE_CHUNKED    = "IMPORT_ERROR_CANNOT_HANDLE_CHUNKED"
	ERR_IMPORT_ERROR_FAILED_TO_FIND_OBJECT    = "IMPORT_ERROR_FAILED_TO_FIND_OBJECT"
	ERR_IMPORT_ERROR_ATTACHED_DISKS_NOT_FOUND = "IMPORT_ERROR_ATTACHED_DISKS_NOT_FOUND"
	ERR_IMPORT_ERROR_UNEXPECTED_FILE          = "IMPORT_ERROR_UNEXPECTED_FILE"
	ERR_IMPORT_INCOMPATIBLE_VERSION           = "IMPORT_INCOMPATIBLE_VERSION"

	ERR_RESTORE_INCOMPATIBLE_VERSION         = "RESTORE_INCOMPATIBLE_VERSION"
	ERR_RESTORE_TARGET_MISSING_DEVICE        = "RESTORE_TARGET_MISSING_DEVICE"
	ERR_RESTORE_TARGET_MGMT_IF_NOT_IN_BACKUP = "RESTORE_TARGET_MGMT_IF_NOT_IN_BACKUP"

	ERR_POOL_NOT_IN_EMERGENCY_MODE                                = "NOT_IN_EMERGENCY_MODE"
	ERR_POOL_HOSTS_NOT_COMPATIBLE                                 = "HOSTS_NOT_COMPATIBLE"
	ERR_POOL_HOSTS_NOT_HOMOGENEOUS                                = "HOSTS_NOT_HOMOGENEOUS"
	ERR_POOL_JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS               = "JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS"
	ERR_POOL_JOINING_HOST_CANNOT_CONTAIN_NETWORK_BOND             = "JOINING_HOST_CANNOT_CONTAIN_NETWORK_BOND"
	ERR_POOL_JOINING_HOST_CANNOT_HAVE_RUNNING_OR_SUSPENDED_VMS    = "JOINING_HOST_CANNOT_HAVE_RUNNING_OR_SUSPENDED_VMS"
	ERR_POOL_JOINING_HOST_CANNOT_HAVE_RUNNING_VMS                 = "JOINING_HOST_CANNOT_HAVE_RUNNING_VMS"
	ERR_POOL_JOINING_HOST_CANNOT_HAVE_VMS_WITH_CURRENT_OPERATIONS = "JOINING_HOST_CANNOT_HAVE_VMS_WITH_CURRENT_OPERATIONS"
	ERR_POOL_JOINING_HOST_CANNOT_BE_MASTER_OF_OTHER_HOSTS         = "JOINING_HOST_CANNOT_BE_MASTER_OF_OTHER_HOSTS"
	ERR_POOL_JOINING_HOST_CONNECTION_FAILED                       = "JOINING_HOST_CONNECTION_FAILED"
	ERR_POOL_JOINING_HOST_SERVICE_FAILED                          = "JOINING_HOST_SERVICE_FAILED"
	ERR_POOL_JOINING_HOST_MUST_HAVE_PHYSICAL_MANAGEMENT_NIC       = "POOL_JOINING_HOST_MUST_HAVE_PHYSICAL_MANAGEMENT_NIC"
	ERR_POOL_JOINING_EXTERNAL_AUTH_MISMATCH                       = "POOL_JOINING_EXTERNAL_AUTH_MISMATCH"
	ERR_POOL_JOINING_HOST_MUST_HAVE_SAME_PRODUCT_VERSION          = "POOL_JOINING_HOST_MUST_HAVE_SAME_PRODUCT_VERSION"

	// (*WORKLOAD BALANCING*)
	ERR_WLB_NOT_INITIALIZED                 = "WLB_NOT_INITIALIZED"
	ERR_WLB_DISABLED                        = "WLB_DISABLED"
	ERR_WLB_CONNECTION_REFUSED              = "WLB_CONNECTION_REFUSED"
	ERR_WLB_UNKNOWN_HOST                    = "WLB_UNKNOWN_HOST"
	ERR_WLB_TIMEOUT                         = "WLB_TIMEOUT"
	ERR_WLB_AUTHENTICATION_FAILED           = "WLB_AUTHENTICATION_FAILED"
	ERR_WLB_MALFORMED_REQUEST               = "WLB_MALFORMED_REQUEST"
	ERR_WLB_MALFORMED_RESPONSE              = "WLB_MALFORMED_RESPONSE"
	ERR_WLB_XENSERVER_CONNECTION_REFUSED    = "WLB_XENSERVER_CONNECTION_REFUSED"
	ERR_WLB_XENSERVER_UNKNOWN_HOST          = "WLB_XENSERVER_UNKNOWN_HOST"
	ERR_WLB_XENSERVER_TIMEOUT               = "WLB_XENSERVER_TIMEOUT"
	ERR_WLB_XENSERVER_AUTHENTICATION_FAILED = "WLB_XENSERVER_AUTHENTICATION_FAILED"
	ERR_WLB_XENSERVER_MALFORMED_RESPONSE    = "WLB_XENSERVER_MALFORMED_RESPONSE"
	ERR_WLB_INTERNAL_ERROR                  = "WLB_INTERNAL_ERROR"
	ERR_WLB_URL_INVALID                     = "WLB_URL_INVALID"
	ERR_WLB_CONNECTION_RESET                = "WLB_CONNECTION_RESET"

	ERR_SR_NOT_SHARED = "SR_NOT_SHARED"

	ERR_DEFAULT_SR_NOT_FOUND = "DEFAULT_SR_NOT_FOUND"

	ERR_TASK_CANCELLED = "TASK_CANCELLED"

	ERR_TOO_MANY_PENDING_TASKS = "TOO_MANY_PENDING_TASKS"
	ERR_TOO_BUSY               = "TOO_BUSY"

	ERR_OUT_OF_SPACE                               = "OUT_OF_SPACE"
	ERR_INVALID_PATCH                              = "INVALID_PATCH"
	ERR_INVALID_PATCH_WITH_LOG                     = "INVALID_PATCH_WITH_LOG"
	ERR_PATCH_ALREADY_EXISTS                       = "PATCH_ALREADY_EXISTS"
	ERR_PATCH_IS_APPLIED                           = "PATCH_IS_APPLIED"
	ERR_CANNOT_FIND_PATCH                          = "CANNOT_FIND_PATCH"
	ERR_CANNOT_FETCH_PATCH                         = "CANNOT_FETCH_PATCH"
	ERR_PATCH_ALREADY_APPLIED                      = "PATCH_ALREADY_APPLIED"
	ERR_PATCH_PRECHECK_FAILED_UNKNOWN_ERROR        = "PATCH_PRECHECK_FAILED_UNKNOWN_ERROR"
	ERR_PATCH_PRECHECK_FAILED_PREREQUISITE_MISSING = "PATCH_PRECHECK_FAILED_PREREQUISITE_MISSING"
	ERR_PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION = "PATCH_PRECHECK_FAILED_WRONG_SERVER_VERSION"
	ERR_PATCH_PRECHECK_FAILED_WRONG_SERVER_BUILD   = "PATCH_PRECHECK_FAILED_WRONG_SERVER_BUILD"
	ERR_PATCH_PRECHECK_FAILED_VM_RUNNING           = "PATCH_PRECHECK_FAILED_VM_RUNNING"
	ERR_PATCH_PRECHECK_FAILED_OUT_OF_SPACE         = "PATCH_PRECHECK_FAILED_OUT_OF_SPACE"
	ERR_PATCH_PRECHECK_TOOLS_ISO_MOUNTED           = "PATCH_PRECHECK_FAILED_ISO_MOUNTED"
	ERR_PATCH_APPLY_FAILED                         = "PATCH_APPLY_FAILED"
	ERR_PATCH_APPLY_FAILED_BACKUP_FILES_EXIST      = "PATCH_APPLY_FAILED_BACKUP_FILES_EXIST"
	ERR_CANNOT_FIND_OEM_BACKUP_PARTITION           = "CANNOT_FIND_OEM_BACKUP_PARTITION"
	ERR_ONLY_ALLOWED_ON_OEM_EDITION                = "ONLY_ALLOWED_ON_OEM_EDITION"
	ERR_NOT_ALLOWED_ON_OEM_EDITION                 = "NOT_ALLOWED_ON_OEM_EDITION"
	ERR_CANNOT_FIND_STATE_PARTITION                = "CANNOT_FIND_STATE_PARTITION"
	ERR_BACKUP_SCRIPT_FAILED                       = "BACKUP_SCRIPT_FAILED"
	ERR_RESTORE_SCRIPT_FAILED                      = "RESTORE_SCRIPT_FAILED"

	ERR_LICENSE_EXPIRED                  = "LICENSE_EXPIRED"
	ERR_LICENSE_RESTRICTION              = "LICENCE_RESTRICTION"
	ERR_LICENSE_DOES_NOT_SUPPORT_POOLING = "LICENSE_DOES_NOT_SUPPORT_POOLING"
	ERR_LICENSE_HOST_POOL_MISMATCH       = "LICENSE_HOST_POOL_MISMATCH"
	ERR_LICENSE_PROCESSING_ERROR         = "LICENSE_PROCESSING_ERROR"
	ERR_LICENSE_CANNOT_DOWNGRADE_IN_POOL = "LICENSE_CANNOT_DOWNGRADE_WHILE_IN_POOL"
	ERR_LICENSE_DOES_NOT_SUPPORT_XHA     = "LICENSE_DOES_NOT_SUPPORT_XHA"

	ERR_V6D_FAILURE                = "V6D_FAILURE"
	ERR_INVALID_EDITION            = "INVALID_EDITION"
	ERR_MISSING_CONNECTION_DETAILS = "MISSING_CONNECTION_DETAILS"
	ERR_LICENSE_CHECKOUT_ERROR     = "LICENSE_CHECKOUT_ERROR"
	ERR_LICENSE_FILE_DEPRECATED    = "LICENSE_FILE_DEPRECATED"
	ERR_ACTIVATION_WHILE_NOT_FREE  = "ACTIVATION_WHILE_NOT_FREE"

	ERR_FEATURE_RESTRICTED = "FEATURE_RESTRICTED"

	ERR_XMLRPC_UNMARSHAL_FAILURE = "XMLRPC_UNMARSHAL_FAILURE"

	ERR_DUPLICATE_VM       = "DUPLICATE_VM"
	ERR_DUPLICATE_MAC_SEED = "DUPLICATE_MAC_SEED"

	ERR_CLIENT_ERROR = "CLIENT_ERROR"

	ERR_BALLOONING_DISABLED = "BALLOONING_DISABLED"

	ERR_HA_HOST_IS_ARMED         = "HA_HOST_IS_ARMED"
	ERR_HA_IS_ENABLED            = "HA_IS_ENABLED"
	ERR_HA_NOT_ENABLED           = "HA_NOT_ENABLED"
	ERR_HA_ENABLE_IN_PROGRESS    = "HA_ENABLE_IN_PROGRESS"
	ERR_HA_DISABLE_IN_PROGRESS   = "HA_DISABLE_IN_PROGRESS"
	ERR_HA_NOT_INSTALLED         = "HA_NOT_INSTALLED"
	ERR_HA_HOST_CANNOT_SEE_PEERS = "HA_HOST_CANNOT_SEE_PEERS"
	ERR_HA_TOO_FEW_HOSTS         = "HA_TOO_FEW_HOSTS"
	ERR_HA_SHOULD_BE_FENCED      = "HA_SHOULD_BE_FENCED"

	ERR_HA_ABORT_NEW_MASTER = "HA_ABORT_NEW_MASTER"

	ERR_HA_NO_PLAN                              = "HA_NO_PLAN"
	ERR_HA_LOST_STATEFILE                       = "HA_LOST_STATEFILE"
	ERR_HA_POOL_IS_ENABLED_BUT_HOST_IS_DISABLED = "HA_POOL_IS_ENABLED_BUT_HOST_IS_DISABLED"

	ERR_HA_HEARTBEAT_DAEMON_STARTUP_FAILED = "HA_HEARTBEAT_DAEMON_STARTUP_FAILED"
	ERR_HA_HOST_CANNOT_ACCESS_STATEFILE    = "HA_HOST_CANNOT_ACCESS_STATEFILE"

	ERR_HA_FAILED_TO_FORM_LIVESET = "HA_FAILED_TO_FORM_LIVESET"

	ERR_HA_CANNOT_CHANGE_BOND_STATUS_OF_MGMT_IFACE = "HA_CANNOT_CHANGE_BOND_STATUS_OF_MGMT_IFACE"

	// (* CA-16480: PREVENT CONFIGURATION ERRORS WHICH NULLIFY XHA GOODNESS *)
	ERR_HA_CONSTRAINT_VIOLATION_SR_NOT_SHARED      = "HA_CONSTRAINT_VIOLATION_SR_NOT_SHARED"
	ERR_HA_CONSTRAINT_VIOLATION_NETWORK_NOT_SHARED = "HA_CONSTRAINT_VIOLATION_NETWORK_NOT_SHARED"

	ERR_HA_OPERATION_WOULD_BREAK_FAILOVER_PLAN = "HA_OPERATION_WOULD_BREAK_FAILOVER_PLAN"

	ERR_INCOMPATIBLE_STATEFILE_SR         = "INCOMPATIBLE_STATEFILE_SR"
	ERR_INCOMPATIBLE_CLUSTER_STACK_ACTIVE = "INCOMPATIBLE_CLUSTER_STACK_ACTIVE"

	ERR_CANNOT_EVACUATE_HOST      = "CANNOT_EVACUATE_HOST"
	ERR_HOST_EVACUATE_IN_PROGRESS = "HOST_EVACUATE_IN_PROGRESS"

	ERR_SYSTEM_STATUS_RETRIEVAL_FAILED    = "SYSTEM_STATUS_RETRIEVAL_FAILED"
	ERR_SYSTEM_STATUS_MUST_USE_TAR_ON_OEM = "SYSTEM_STATUS_MUST_USE_TAR_ON_OEM"

	ERR_XAPI_HOOK_FAILED = "XAPI_HOOK_FAILED"

	ERR_NO_LOCAL_STORAGE = "NO_LOCAL_STORAGE"

	ERR_XENAPI_MISSING_PLUGIN = "XENAPI_MISSING_PLUGIN"
	ERR_XENAPI_PLUGIN_FAILURE = "XENAPI_PLUGIN_FAILURE"

	ERR_SR_ATTACHED     = "SR_ATTACHED"
	ERR_SR_NOT_ATTACHED = "SR_NOT_ATTACHED"

	ERR_DOMAIN_BUILDER_ERROR = "DOMAIN_BUILDER_ERROR"

	ERR_AUTH_ALREADY_ENABLED                         = "AUTH_ALREADY_ENABLED"
	ERR_AUTH_UNKNOWN_TYPE                            = "AUTH_UNKNOWN_TYPE"
	ERR_AUTH_IS_DISABLED                             = "AUTH_IS_DISABLED"
	ERR_AUTH_ENABLE_FAILED                           = "AUTH_ENABLE_FAILED"
	ERR_AUTH_ENABLE_FAILED_WRONG_CREDENTIALS         = "AUTH_ENABLE_FAILED_WRONG_CREDENTIALS"
	ERR_AUTH_ENABLE_FAILED_PERMISSION_DENIED         = "AUTH_ENABLE_FAILED_PERMISSION_DENIED"
	ERR_AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED      = "AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED"
	ERR_AUTH_ENABLE_FAILED_UNAVAILABLE               = "AUTH_ENABLE_FAILED_UNAVAILABLE"
	ERR_AUTH_ENABLE_FAILED_INVALID_OU                = "AUTH_ENABLE_FAILED_INVALID_OU"
	ERR_AUTH_DISABLE_FAILED                          = "AUTH_DISABLE_FAILED"
	ERR_AUTH_DISABLE_FAILED_WRONG_CREDENTIALS        = "AUTH_DISABLE_FAILED_WRONG_CREDENTIALS"
	ERR_AUTH_DISABLE_FAILED_PERMISSION_DENIED        = "AUTH_DISABLE_FAILED_PERMISSION_DENIED"
	ERR_POOL_AUTH_ALREADY_ENABLED                    = "POOL_AUTH_ALREADY_ENABLED"
	ERR_POOL_AUTH_ENABLE_FAILED                      = "POOL_AUTH_ENABLE_FAILED"
	ERR_POOL_AUTH_ENABLE_FAILED_WRONG_CREDENTIALS    = "POOL_AUTH_ENABLE_FAILED_WRONG_CREDENTIALS"
	ERR_POOL_AUTH_ENABLE_FAILED_PERMISSION_DENIED    = "POOL_AUTH_ENABLE_FAILED_PERMISSION_DENIED"
	ERR_POOL_AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED = "POOL_AUTH_ENABLE_FAILED_DOMAIN_LOOKUP_FAILED"
	ERR_POOL_AUTH_ENABLE_FAILED_UNAVAILABLE          = "POOL_AUTH_ENABLE_FAILED_UNAVAILABLE"
	ERR_POOL_AUTH_ENABLE_FAILED_INVALID_OU           = "POOL_AUTH_ENABLE_FAILED_INVALID_OU"
	ERR_POOL_AUTH_ENABLE_FAILED_DUPLICATE_HOSTNAME   = "POOL_AUTH_ENABLE_FAILED_DUPLICATE_HOSTNAME"
	ERR_POOL_AUTH_DISABLE_FAILED                     = "POOL_AUTH_DISABLE_FAILED"
	ERR_POOL_AUTH_DISABLE_FAILED_WRONG_CREDENTIALS   = "POOL_AUTH_DISABLE_FAILED_WRONG_CREDENTIALS"
	ERR_POOL_AUTH_DISABLE_FAILED_PERMISSION_DENIED   = "POOL_AUTH_DISABLE_FAILED_PERMISSION_DENIED"
	ERR_SUBJECT_CANNOT_BE_RESOLVED                   = "SUBJECT_CANNOT_BE_RESOLVED"
	ERR_AUTH_SERVICE_ERROR                           = "AUTH_SERVICE_ERROR"
	ERR_SUBJECT_ALREADY_EXISTS                       = "SUBJECT_ALREADY_EXISTS"
	ERR_ROLE_NOT_FOUND                               = "ROLE_NOT_FOUND"
	ERR_ROLE_ALREADY_EXISTS                          = "ROLE_ALREADY_EXISTS"
	ERR_RBAC_PERMISSION_DENIED                       = "RBAC_PERMISSION_DENIED"

	ERR_CERTIFICATE_DOES_NOT_EXIST  = "CERTIFICATE_DOES_NOT_EXIST"
	ERR_CERTIFICATE_ALREADY_EXISTS  = "CERTIFICATE_ALREADY_EXISTS"
	ERR_CERTIFICATE_NAME_INVALID    = "CERTIFICATE_NAME_INVALID"
	ERR_CERTIFICATE_CORRUPT         = "CERTIFICATE_CORRUPT"
	ERR_CERTIFICATE_LIBRARY_CORRUPT = "CERTIFICATE_LIBRARY_CORRUPT"
	ERR_CRL_DOES_NOT_EXIST          = "CRL_DOES_NOT_EXIST"
	ERR_CRL_ALREADY_EXISTS          = "CRL_ALREADY_EXISTS"
	ERR_CRL_NAME_INVALID            = "CRL_NAME_INVALID"
	ERR_CRL_CORRUPT                 = "CRL_CORRUPT"

	ERR_VMPP_HAS_VM                            = "VMPP_HAS_VM"
	ERR_VMPP_ARCHIVE_MORE_FREQUENT_THAN_BACKUP = "VMPP_ARCHIVE_MORE_FREQUENT_THAN_BACKUP"
	ERR_VM_ASSIGNED_TO_PROTECTION_POLICY       = "VM_ASSIGNED_TO_PROTECTION_POLICY"

	ERR_SSL_VERIFY_ERROR = "SSL_VERIFY_ERROR"

	ERR_CANNOT_ENABLE_REDO_LOG = "CANNOT_ENABLE_REDO_LOG"
	ERR_REDO_LOG_IS_ENABLED    = "REDO_LOG_IS_ENABLED"

	ERR_VM_BIOS_STRINGS_ALREADY_SET = "VM_BIOS_STRINGS_ALREADY_SET"

	ERR_INVALID_FEATURE_STRING            = "INVALID_FEATURE_STRING"
	ERR_CPU_FEATURE_MASKING_NOT_SUPPORTED = "CPU_FEATURE_MASKING_NOT_SUPPORTED"

	ERR_FEATURE_REQUIRES_HVM = "FEATURE_REQUIRES_HVM"

	// (* DISASTER RECOVERY *)
	ERR_VDI_CONTAINS_METADATA_OF_THIS_POOL       = "VDI_CONTAINS_METADATA_OF_THIS_POOL"
	ERR_NO_MORE_REDO_LOGS_ALLOWED                = "NO_MORE_REDO_LOGS_ALLOWED"
	ERR_COULD_NOT_IMPORT_DATABASE                = "COULD_NOT_IMPORT_DATABASE"
	ERR_VM_INCOMPATIBLE_WITH_THIS_HOST           = "VM_INCOMPATIBLE_WITH_THIS_HOST"
	ERR_CANNOT_DESTROY_DISASTER_RECOVERY_TASK    = "CANNOT_DESTROY_DISASTER_RECOVERY_TASK"
	ERR_VM_IS_PART_OF_AN_APPLIANCE               = "VM_IS_PART_OF_AN_APPLIANCE"
	ERR_VM_TO_IMPORT_IS_NOT_NEWER_VERSION        = "VM_TO_IMPORT_IS_NOT_NEWER_VERSION"
	ERR_SUSPEND_VDI_REPLACEMENT_IS_NOT_IDENTICAL = "SUSPEND_VDI_REPLACEMENT_IS_NOT_IDENTICAL"
	ERR_VDI_COPY_FAILED                          = "VDI_COPY_FAILED"

	ERR_VDI_NEEDS_VM_FOR_MIGRATE  = "VDI_NEEDS_VM_FOR_MIGRATE"
	ERR_VM_HAS_TOO_MANY_SNAPSHOTS = "VM_HAS_TOO_MANY_SNAPSHOTS"
	ERR_VM_HAS_CHECKPOINT         = "VM_HAS_CHECKPOINT"

	ERR_MIRROR_FAILED                 = "MIRROR_FAILED"
	ERR_TOO_MANY_STORAGE_MIGRATES     = "TOO_MANY_STORAGE_MIGRATES"
	ERR_SR_DOES_NOT_SUPPORT_MIGRATION = "SR_DOES_NOT_SUPPORT_MIGRATION"
	ERR_UNIMPLEMENTED_IN_SM_BACKEND   = "UNIMPLEMENTED_IN_SM_BACKEND"

	ERR_VM_CALL_PLUGIN_RATE_LIMIT = "VM_CALL_PLUGIN_RATE_LIMIT"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type APIResult 

type APIResult struct {
	Value interface{}
}

type AfterApplyGuidance 

type AfterApplyGuidance string
const (
	// This patch requires HVM guests to be restarted once applied.
	AfterApplyGuidanceRestartHVM AfterApplyGuidance = "restartHVM"
	// This patch requires PV guests to be restarted once applied.
	AfterApplyGuidanceRestartPV AfterApplyGuidance = "restartPV"
	// This patch requires the host to be restarted once applied.
	AfterApplyGuidanceRestartHost AfterApplyGuidance = "restartHost"
	// This patch requires XAPI to be restarted once applied.
	AfterApplyGuidanceRestartXAPI AfterApplyGuidance = "restartXAPI"
)

type AllocationAlgorithm 

type AllocationAlgorithm string
const (
	// vGPUs of a given type are allocated evenly across supporting pGPUs.
	AllocationAlgorithmBreadthFirst AllocationAlgorithm = "breadth_first"
	// vGPUs of a given type are allocated on supporting pGPUs until they are full.
	AllocationAlgorithmDepthFirst AllocationAlgorithm = "depth_first"
)

type AsyncAuthClass 

type AsyncAuthClass struct {
	// contains filtered or unexported fields
}

Management of remote authentication services

func (AsyncAuthClass) GetGroupMembership 

func (_class AsyncAuthClass) GetGroupMembership(sessionID SessionRef, subjectIdentifier string) (_retval TaskRef, _err error)

This calls queries the external directory service to obtain the transitively-closed set of groups that the the subject_identifier is member of.

func (AsyncAuthClass) GetSubjectIdentifier 

func (_class AsyncAuthClass) GetSubjectIdentifier(sessionID SessionRef, subjectName string) (_retval TaskRef, _err error)

This call queries the external directory service to obtain the subject_identifier as a string from the human-readable subject_name

func (AsyncAuthClass) GetSubjectInformationFromIdentifier 

func (_class AsyncAuthClass) GetSubjectInformationFromIdentifier(sessionID SessionRef, subjectIdentifier string) (_retval TaskRef, _err error)

This call queries the external directory service to obtain the user information (e.g. username, organization etc) from the specified subject_identifier

type AsyncBlobClass 

type AsyncBlobClass struct {
	// contains filtered or unexported fields
}

A placeholder for a binary blob

func (AsyncBlobClass) Create 

func (_class AsyncBlobClass) Create(sessionID SessionRef, mimeType string, public bool) (_retval TaskRef, _err error)

Create a placeholder for a binary blob

func (AsyncBlobClass) Destroy 

func (_class AsyncBlobClass) Destroy(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

func (AsyncBlobClass) GetAll 

func (_class AsyncBlobClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the blobs known to the system.

func (AsyncBlobClass) GetAllRecords 

func (_class AsyncBlobClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of blob references to blob records for all blobs known to the system.

func (AsyncBlobClass) GetByNameLabel 

func (_class AsyncBlobClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the blob instances with the given label.

func (AsyncBlobClass) GetByUUID 

func (_class AsyncBlobClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the blob instance with the specified UUID.

func (AsyncBlobClass) GetLastUpdated 

func (_class AsyncBlobClass) GetLastUpdated(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the last_updated field of the given blob.

func (AsyncBlobClass) GetMimeType 

func (_class AsyncBlobClass) GetMimeType(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the mime_type field of the given blob.

func (AsyncBlobClass) GetNameDescription 

func (_class AsyncBlobClass) GetNameDescription(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the name/description field of the given blob.

func (AsyncBlobClass) GetNameLabel 

func (_class AsyncBlobClass) GetNameLabel(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the name/label field of the given blob.

func (AsyncBlobClass) GetPublic 

func (_class AsyncBlobClass) GetPublic(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the public field of the given blob.

func (AsyncBlobClass) GetRecord 

func (_class AsyncBlobClass) GetRecord(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given blob.

func (AsyncBlobClass) GetSize 

func (_class AsyncBlobClass) GetSize(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the size field of the given blob.

func (AsyncBlobClass) GetUUID 

func (_class AsyncBlobClass) GetUUID(sessionID SessionRef, self BlobRef) (_retval TaskRef, _err error)

Get the uuid field of the given blob.

func (AsyncBlobClass) SetNameDescription 

func (_class AsyncBlobClass) SetNameDescription(sessionID SessionRef, self BlobRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given blob.

func (AsyncBlobClass) SetNameLabel 

func (_class AsyncBlobClass) SetNameLabel(sessionID SessionRef, self BlobRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given blob.

func (AsyncBlobClass) SetPublic 

func (_class AsyncBlobClass) SetPublic(sessionID SessionRef, self BlobRef, value bool) (_retval TaskRef, _err error)

Set the public field of the given blob.

type AsyncBondClass 

type AsyncBondClass struct {
	// contains filtered or unexported fields
}

func (AsyncBondClass) AddToOtherConfig 

func (_class AsyncBondClass) AddToOtherConfig(sessionID SessionRef, self BondRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given Bond.

func (AsyncBondClass) Create 

func (_class AsyncBondClass) Create(sessionID SessionRef, network NetworkRef, members []PIFRef, mac string, mode BondMode, properties map[string]string) (_retval TaskRef, _err error)

Create an interface bond

func (AsyncBondClass) Destroy 

func (_class AsyncBondClass) Destroy(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Destroy an interface bond

func (AsyncBondClass) GetAll 

func (_class AsyncBondClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the Bonds known to the system.

func (AsyncBondClass) GetAllRecords 

func (_class AsyncBondClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of Bond references to Bond records for all Bonds known to the system.

func (AsyncBondClass) GetByUUID 

func (_class AsyncBondClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the Bond instance with the specified UUID.

func (AsyncBondClass) GetLinksUp 

func (_class AsyncBondClass) GetLinksUp(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the links_up field of the given Bond.

func (AsyncBondClass) GetMaster 

func (_class AsyncBondClass) GetMaster(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the master field of the given Bond.

func (AsyncBondClass) GetMode 

func (_class AsyncBondClass) GetMode(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the mode field of the given Bond.

func (AsyncBondClass) GetOtherConfig 

func (_class AsyncBondClass) GetOtherConfig(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the other_config field of the given Bond.

func (AsyncBondClass) GetPrimarySlave 

func (_class AsyncBondClass) GetPrimarySlave(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the primary_slave field of the given Bond.

func (AsyncBondClass) GetProperties 

func (_class AsyncBondClass) GetProperties(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the properties field of the given Bond.

func (AsyncBondClass) GetRecord 

func (_class AsyncBondClass) GetRecord(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given Bond.

func (AsyncBondClass) GetSlaves 

func (_class AsyncBondClass) GetSlaves(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the slaves field of the given Bond.

func (AsyncBondClass) GetUUID 

func (_class AsyncBondClass) GetUUID(sessionID SessionRef, self BondRef) (_retval TaskRef, _err error)

Get the uuid field of the given Bond.

func (AsyncBondClass) RemoveFromOtherConfig 

func (_class AsyncBondClass) RemoveFromOtherConfig(sessionID SessionRef, self BondRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncBondClass) SetMode 

func (_class AsyncBondClass) SetMode(sessionID SessionRef, self BondRef, value BondMode) (_retval TaskRef, _err error)

Change the bond mode

func (AsyncBondClass) SetOtherConfig 

func (_class AsyncBondClass) SetOtherConfig(sessionID SessionRef, self BondRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given Bond.

func (AsyncBondClass) SetProperty 

func (_class AsyncBondClass) SetProperty(sessionID SessionRef, self BondRef, name string, value string) (_retval TaskRef, _err error)

Set the value of a property of the bond

type AsyncConsoleClass 

type AsyncConsoleClass struct {
	// contains filtered or unexported fields
}

A console

func (AsyncConsoleClass) AddToOtherConfig 

func (_class AsyncConsoleClass) AddToOtherConfig(sessionID SessionRef, self ConsoleRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given console.

func (AsyncConsoleClass) Create 

func (_class AsyncConsoleClass) Create(sessionID SessionRef, args ConsoleRecord) (_retval TaskRef, _err error)

Create a new console instance, and return its handle. The constructor args are: other_config* (* = non-optional).

func (AsyncConsoleClass) Destroy 

func (_class AsyncConsoleClass) Destroy(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Destroy the specified console instance.

func (AsyncConsoleClass) GetAll 

func (_class AsyncConsoleClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the consoles known to the system.

func (AsyncConsoleClass) GetAllRecords 

func (_class AsyncConsoleClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of console references to console records for all consoles known to the system.

func (AsyncConsoleClass) GetByUUID 

func (_class AsyncConsoleClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the console instance with the specified UUID.

func (AsyncConsoleClass) GetLocation 

func (_class AsyncConsoleClass) GetLocation(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Get the location field of the given console.

func (AsyncConsoleClass) GetOtherConfig 

func (_class AsyncConsoleClass) GetOtherConfig(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Get the other_config field of the given console.

func (AsyncConsoleClass) GetProtocol 

func (_class AsyncConsoleClass) GetProtocol(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Get the protocol field of the given console.

func (AsyncConsoleClass) GetRecord 

func (_class AsyncConsoleClass) GetRecord(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given console.

func (AsyncConsoleClass) GetUUID 

func (_class AsyncConsoleClass) GetUUID(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Get the uuid field of the given console.

func (AsyncConsoleClass) GetVM 

func (_class AsyncConsoleClass) GetVM(sessionID SessionRef, self ConsoleRef) (_retval TaskRef, _err error)

Get the VM field of the given console.

func (AsyncConsoleClass) RemoveFromOtherConfig 

func (_class AsyncConsoleClass) RemoveFromOtherConfig(sessionID SessionRef, self ConsoleRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncConsoleClass) SetOtherConfig 

func (_class AsyncConsoleClass) SetOtherConfig(sessionID SessionRef, self ConsoleRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given console.

type AsyncCrashdumpClass 

type AsyncCrashdumpClass struct {
	// contains filtered or unexported fields
}

A VM crashdump

func (AsyncCrashdumpClass) AddToOtherConfig 

func (_class AsyncCrashdumpClass) AddToOtherConfig(sessionID SessionRef, self CrashdumpRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given crashdump.

func (AsyncCrashdumpClass) Destroy 

func (_class AsyncCrashdumpClass) Destroy(sessionID SessionRef, self CrashdumpRef) (_retval TaskRef, _err error)

Destroy the specified crashdump

func (AsyncCrashdumpClass) GetAll 

func (_class AsyncCrashdumpClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the crashdumps known to the system.

func (AsyncCrashdumpClass) GetAllRecords 

func (_class AsyncCrashdumpClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of crashdump references to crashdump records for all crashdumps known to the system.

func (AsyncCrashdumpClass) GetByUUID 

func (_class AsyncCrashdumpClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the crashdump instance with the specified UUID.

func (AsyncCrashdumpClass) GetOtherConfig 

func (_class AsyncCrashdumpClass) GetOtherConfig(sessionID SessionRef, self CrashdumpRef) (_retval TaskRef, _err error)

Get the other_config field of the given crashdump.

func (AsyncCrashdumpClass) GetRecord 

func (_class AsyncCrashdumpClass) GetRecord(sessionID SessionRef, self CrashdumpRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given crashdump.

func (AsyncCrashdumpClass) GetUUID 

func (_class AsyncCrashdumpClass) GetUUID(sessionID SessionRef, self CrashdumpRef) (_retval TaskRef, _err error)

Get the uuid field of the given crashdump.

func (AsyncCrashdumpClass) GetVDI 

func (_class AsyncCrashdumpClass) GetVDI(sessionID SessionRef, self CrashdumpRef) (_retval TaskRef, _err error)

Get the VDI field of the given crashdump.

func (AsyncCrashdumpClass) GetVM 

func (_class AsyncCrashdumpClass) GetVM(sessionID SessionRef, self CrashdumpRef) (_retval TaskRef, _err error)

Get the VM field of the given crashdump.

func (AsyncCrashdumpClass) RemoveFromOtherConfig 

func (_class AsyncCrashdumpClass) RemoveFromOtherConfig(sessionID SessionRef, self CrashdumpRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given crashdump. If the key is not in that Map, then do nothing.

func (AsyncCrashdumpClass) SetOtherConfig 

func (_class AsyncCrashdumpClass) SetOtherConfig(sessionID SessionRef, self CrashdumpRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given crashdump.

type AsyncDRTaskClass 

type AsyncDRTaskClass struct {
	// contains filtered or unexported fields
}

DR task

func (AsyncDRTaskClass) Create 

func (_class AsyncDRTaskClass) Create(sessionID SessionRef, atype string, deviceConfig map[string]string, whitelist []string) (_retval TaskRef, _err error)

Create a disaster recovery task which will query the supplied list of devices

func (AsyncDRTaskClass) Destroy 

func (_class AsyncDRTaskClass) Destroy(sessionID SessionRef, self DRTaskRef) (_retval TaskRef, _err error)

Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required

func (AsyncDRTaskClass) GetAll 

func (_class AsyncDRTaskClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the DR_tasks known to the system.

func (AsyncDRTaskClass) GetAllRecords 

func (_class AsyncDRTaskClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of DR_task references to DR_task records for all DR_tasks known to the system.

func (AsyncDRTaskClass) GetByUUID 

func (_class AsyncDRTaskClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the DR_task instance with the specified UUID.

func (AsyncDRTaskClass) GetIntroducedSRs 

func (_class AsyncDRTaskClass) GetIntroducedSRs(sessionID SessionRef, self DRTaskRef) (_retval TaskRef, _err error)

Get the introduced_SRs field of the given DR_task.

func (AsyncDRTaskClass) GetRecord 

func (_class AsyncDRTaskClass) GetRecord(sessionID SessionRef, self DRTaskRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given DR_task.

func (AsyncDRTaskClass) GetUUID 

func (_class AsyncDRTaskClass) GetUUID(sessionID SessionRef, self DRTaskRef) (_retval TaskRef, _err error)

Get the uuid field of the given DR_task.

type AsyncDataSourceClass 

type AsyncDataSourceClass struct {
	// contains filtered or unexported fields
}

Data sources for logging in RRDs

type AsyncEventClass 

type AsyncEventClass struct {
	// contains filtered or unexported fields
}

Asynchronous event registration and handling

func (AsyncEventClass) From 

func (_class AsyncEventClass) From(sessionID SessionRef, classes []string, token string, timeout float64) (_retval TaskRef, _err error)

Blocking call which returns a new token and a (possibly empty) batch of events. The returned token can be used in subsequent calls to this function.

Errors: 

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.
EVENTS_LOST - Some events have been lost from the queue and cannot be retrieved.

func (AsyncEventClass) GetCurrentID 

func (_class AsyncEventClass) GetCurrentID(sessionID SessionRef) (_retval TaskRef, _err error)

Return the ID of the next event to be generated by the system

func (AsyncEventClass) Inject 

func (_class AsyncEventClass) Inject(sessionID SessionRef, class string, ref string) (_retval TaskRef, _err error)

Injects an artificial event on the given object and return the corresponding ID

func (AsyncEventClass) Next 

func (_class AsyncEventClass) Next(sessionID SessionRef) (_retval TaskRef, _err error)

Blocking call which returns a (possibly empty) batch of events. This method is only recommended for legacy use. New development should use event.from which supercedes this method.

Errors: 

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.
EVENTS_LOST - Some events have been lost from the queue and cannot be retrieved.

func (AsyncEventClass) Register 

func (_class AsyncEventClass) Register(sessionID SessionRef, classes []string) (_retval TaskRef, _err error)

Registers this session with the event system. Specifying * as the desired class will register for all classes.

func (AsyncEventClass) Unregister 

func (_class AsyncEventClass) Unregister(sessionID SessionRef, classes []string) (_retval TaskRef, _err error)

Unregisters this session with the event system

type AsyncGPUGroupClass 

type AsyncGPUGroupClass struct {
	// contains filtered or unexported fields
}

A group of compatible GPUs across the resource pool

func (AsyncGPUGroupClass) AddToOtherConfig 

func (_class AsyncGPUGroupClass) AddToOtherConfig(sessionID SessionRef, self GPUGroupRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given GPU_group.

func (AsyncGPUGroupClass) Create 

func (_class AsyncGPUGroupClass) Create(sessionID SessionRef, nameLabel string, nameDescription string, otherConfig map[string]string) (_retval TaskRef, _err error)

func (AsyncGPUGroupClass) Destroy 

func (_class AsyncGPUGroupClass) Destroy(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

func (AsyncGPUGroupClass) GetAll 

func (_class AsyncGPUGroupClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the GPU_groups known to the system.

func (AsyncGPUGroupClass) GetAllRecords 

func (_class AsyncGPUGroupClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of GPU_group references to GPU_group records for all GPU_groups known to the system.

func (AsyncGPUGroupClass) GetAllocationAlgorithm 

func (_class AsyncGPUGroupClass) GetAllocationAlgorithm(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the allocation_algorithm field of the given GPU_group.

func (AsyncGPUGroupClass) GetByNameLabel 

func (_class AsyncGPUGroupClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the GPU_group instances with the given label.

func (AsyncGPUGroupClass) GetByUUID 

func (_class AsyncGPUGroupClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the GPU_group instance with the specified UUID.

func (AsyncGPUGroupClass) GetEnabledVGPUTypes 

func (_class AsyncGPUGroupClass) GetEnabledVGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the enabled_VGPU_types field of the given GPU_group.

func (AsyncGPUGroupClass) GetGPUTypes 

func (_class AsyncGPUGroupClass) GetGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the GPU_types field of the given GPU_group.

func (AsyncGPUGroupClass) GetNameDescription 

func (_class AsyncGPUGroupClass) GetNameDescription(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the name/description field of the given GPU_group.

func (AsyncGPUGroupClass) GetNameLabel 

func (_class AsyncGPUGroupClass) GetNameLabel(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the name/label field of the given GPU_group.

func (AsyncGPUGroupClass) GetOtherConfig 

func (_class AsyncGPUGroupClass) GetOtherConfig(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the other_config field of the given GPU_group.

func (AsyncGPUGroupClass) GetPGPUs 

func (_class AsyncGPUGroupClass) GetPGPUs(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the PGPUs field of the given GPU_group.

func (AsyncGPUGroupClass) GetRecord 

func (_class AsyncGPUGroupClass) GetRecord(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given GPU_group.

func (AsyncGPUGroupClass) GetRemainingCapacity 

func (_class AsyncGPUGroupClass) GetRemainingCapacity(sessionID SessionRef, self GPUGroupRef, vgpuType VGPUTypeRef) (_retval TaskRef, _err error)

func (AsyncGPUGroupClass) GetSupportedVGPUTypes 

func (_class AsyncGPUGroupClass) GetSupportedVGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the supported_VGPU_types field of the given GPU_group.

func (AsyncGPUGroupClass) GetUUID 

func (_class AsyncGPUGroupClass) GetUUID(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the uuid field of the given GPU_group.

func (AsyncGPUGroupClass) GetVGPUs 

func (_class AsyncGPUGroupClass) GetVGPUs(sessionID SessionRef, self GPUGroupRef) (_retval TaskRef, _err error)

Get the VGPUs field of the given GPU_group.

func (AsyncGPUGroupClass) RemoveFromOtherConfig 

func (_class AsyncGPUGroupClass) RemoveFromOtherConfig(sessionID SessionRef, self GPUGroupRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given GPU_group. If the key is not in that Map, then do nothing.

func (AsyncGPUGroupClass) SetAllocationAlgorithm 

func (_class AsyncGPUGroupClass) SetAllocationAlgorithm(sessionID SessionRef, self GPUGroupRef, value AllocationAlgorithm) (_retval TaskRef, _err error)

Set the allocation_algorithm field of the given GPU_group.

func (AsyncGPUGroupClass) SetNameDescription 

func (_class AsyncGPUGroupClass) SetNameDescription(sessionID SessionRef, self GPUGroupRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given GPU_group.

func (AsyncGPUGroupClass) SetNameLabel 

func (_class AsyncGPUGroupClass) SetNameLabel(sessionID SessionRef, self GPUGroupRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given GPU_group.

func (AsyncGPUGroupClass) SetOtherConfig 

func (_class AsyncGPUGroupClass) SetOtherConfig(sessionID SessionRef, self GPUGroupRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given GPU_group.

type AsyncHostCPUClass 

type AsyncHostCPUClass struct {
	// contains filtered or unexported fields
}

A physical CPU

func (AsyncHostCPUClass) AddToOtherConfig 

func (_class AsyncHostCPUClass) AddToOtherConfig(sessionID SessionRef, self HostCPURef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given host_cpu.

func (AsyncHostCPUClass) GetAll 

func (_class AsyncHostCPUClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the host_cpus known to the system.

func (AsyncHostCPUClass) GetAllRecords 

func (_class AsyncHostCPUClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of host_cpu references to host_cpu records for all host_cpus known to the system.

func (AsyncHostCPUClass) GetByUUID 

func (_class AsyncHostCPUClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the host_cpu instance with the specified UUID.

func (AsyncHostCPUClass) GetFamily 

func (_class AsyncHostCPUClass) GetFamily(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the family field of the given host_cpu.

func (AsyncHostCPUClass) GetFeatures 

func (_class AsyncHostCPUClass) GetFeatures(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the features field of the given host_cpu.

func (AsyncHostCPUClass) GetFlags 

func (_class AsyncHostCPUClass) GetFlags(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the flags field of the given host_cpu.

func (AsyncHostCPUClass) GetHost 

func (_class AsyncHostCPUClass) GetHost(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the host field of the given host_cpu.

func (AsyncHostCPUClass) GetModel 

func (_class AsyncHostCPUClass) GetModel(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the model field of the given host_cpu.

func (AsyncHostCPUClass) GetModelname 

func (_class AsyncHostCPUClass) GetModelname(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the modelname field of the given host_cpu.

func (AsyncHostCPUClass) GetNumber 

func (_class AsyncHostCPUClass) GetNumber(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the number field of the given host_cpu.

func (AsyncHostCPUClass) GetOtherConfig 

func (_class AsyncHostCPUClass) GetOtherConfig(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the other_config field of the given host_cpu.

func (AsyncHostCPUClass) GetRecord 

func (_class AsyncHostCPUClass) GetRecord(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get a record containing the current state of the given host_cpu.

func (AsyncHostCPUClass) GetSpeed 

func (_class AsyncHostCPUClass) GetSpeed(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the speed field of the given host_cpu.

func (AsyncHostCPUClass) GetStepping 

func (_class AsyncHostCPUClass) GetStepping(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the stepping field of the given host_cpu.

func (AsyncHostCPUClass) GetUUID 

func (_class AsyncHostCPUClass) GetUUID(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the uuid field of the given host_cpu.

func (AsyncHostCPUClass) GetUtilisation 

func (_class AsyncHostCPUClass) GetUtilisation(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the utilisation field of the given host_cpu.

func (AsyncHostCPUClass) GetVendor 

func (_class AsyncHostCPUClass) GetVendor(sessionID SessionRef, self HostCPURef) (_retval TaskRef, _err error)

Get the vendor field of the given host_cpu.

func (AsyncHostCPUClass) RemoveFromOtherConfig 

func (_class AsyncHostCPUClass) RemoveFromOtherConfig(sessionID SessionRef, self HostCPURef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given host_cpu. If the key is not in that Map, then do nothing.

func (AsyncHostCPUClass) SetOtherConfig 

func (_class AsyncHostCPUClass) SetOtherConfig(sessionID SessionRef, self HostCPURef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given host_cpu.

type AsyncHostClass 

type AsyncHostClass struct {
	// contains filtered or unexported fields
}

A physical host

func (AsyncHostClass) AddTags 

func (_class AsyncHostClass) AddTags(sessionID SessionRef, self HostRef, value string) (_retval TaskRef, _err error)

Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.

func (AsyncHostClass) AddToGuestVCPUsParams 

func (_class AsyncHostClass) AddToGuestVCPUsParams(sessionID SessionRef, self HostRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the guest_VCPUs_params field of the given host.

func (AsyncHostClass) AddToLicenseServer 

func (_class AsyncHostClass) AddToLicenseServer(sessionID SessionRef, self HostRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the license_server field of the given host.

func (AsyncHostClass) AddToLogging 

func (_class AsyncHostClass) AddToLogging(sessionID SessionRef, self HostRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the logging field of the given host.

func (AsyncHostClass) AddToOtherConfig 

func (_class AsyncHostClass) AddToOtherConfig(sessionID SessionRef, self HostRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given host.

func (AsyncHostClass) ApplyEdition 

func (_class AsyncHostClass) ApplyEdition(sessionID SessionRef, host HostRef, edition string, force bool) (_retval TaskRef, _err error)

Change to another edition, or reactivate the current edition after a license has expired. This may be subject to the successful checkout of an appropriate license.

func (AsyncHostClass) AssertCanEvacuate 

func (_class AsyncHostClass) AssertCanEvacuate(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Check this host can be evacuated.

func (AsyncHostClass) BackupRrds 

func (_class AsyncHostClass) BackupRrds(sessionID SessionRef, host HostRef, delay float64) (_retval TaskRef, _err error)

This causes the RRDs to be backed up to the master

func (AsyncHostClass) BugreportUpload 

func (_class AsyncHostClass) BugreportUpload(sessionID SessionRef, host HostRef, url string, options map[string]string) (_retval TaskRef, _err error)

Run xen-bugtool --yestoall and upload the output to Citrix support

func (AsyncHostClass) CallPlugin 

func (_class AsyncHostClass) CallPlugin(sessionID SessionRef, host HostRef, plugin string, fn string, args map[string]string) (_retval TaskRef, _err error)

Call a XenAPI plugin on this host

func (AsyncHostClass) ComputeFreeMemory 

func (_class AsyncHostClass) ComputeFreeMemory(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Computes the amount of free memory on the host.

func (AsyncHostClass) ComputeMemoryOverhead 

func (_class AsyncHostClass) ComputeMemoryOverhead(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Computes the virtualization memory overhead of a host.

func (AsyncHostClass) CreateNewBlob 

func (_class AsyncHostClass) CreateNewBlob(sessionID SessionRef, host HostRef, name string, mimeType string, public bool) (_retval TaskRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this host

func (AsyncHostClass) DeclareDead 

func (_class AsyncHostClass) DeclareDead(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Declare that a host is dead. This is a dangerous operation, and should only be called if the administrator is absolutely sure the host is definitely dead

func (AsyncHostClass) Destroy 

func (_class AsyncHostClass) Destroy(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Destroy specified host record in database

func (AsyncHostClass) Disable 

func (_class AsyncHostClass) Disable(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.

func (AsyncHostClass) DisableDisplay 

func (_class AsyncHostClass) DisableDisplay(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Disable console output to the physical display device next time this host boots

func (AsyncHostClass) DisableExternalAuth 

func (_class AsyncHostClass) DisableExternalAuth(sessionID SessionRef, host HostRef, config map[string]string) (_retval TaskRef, _err error)

This call disables external authentication on the local host

func (AsyncHostClass) DisableLocalStorageCaching 

func (_class AsyncHostClass) DisableLocalStorageCaching(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Disable the use of a local SR for caching purposes

func (AsyncHostClass) Dmesg 

func (_class AsyncHostClass) Dmesg(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Get the host xen dmesg.

func (AsyncHostClass) DmesgClear 

func (_class AsyncHostClass) DmesgClear(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Get the host xen dmesg, and clear the buffer.

func (AsyncHostClass) EmergencyHaDisable 

func (_class AsyncHostClass) EmergencyHaDisable(sessionID SessionRef) (_retval TaskRef, _err error)

This call disables HA on the local host. This should only be used with extreme care.

func (AsyncHostClass) Enable 

func (_class AsyncHostClass) Enable(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Puts the host into a state in which new VMs can be started.

func (AsyncHostClass) EnableDisplay 

func (_class AsyncHostClass) EnableDisplay(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Enable console output to the physical display device next time this host boots

func (AsyncHostClass) EnableExternalAuth 

func (_class AsyncHostClass) EnableExternalAuth(sessionID SessionRef, host HostRef, config map[string]string, serviceName string, authType string) (_retval TaskRef, _err error)

This call enables external authentication on a host

func (AsyncHostClass) EnableLocalStorageCaching 

func (_class AsyncHostClass) EnableLocalStorageCaching(sessionID SessionRef, host HostRef, sr SRRef) (_retval TaskRef, _err error)

Enable the use of a local SR for caching purposes

func (AsyncHostClass) Evacuate 

func (_class AsyncHostClass) Evacuate(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Migrate all VMs off of this host, where possible.

func (AsyncHostClass) ForgetDataSourceArchives 

func (_class AsyncHostClass) ForgetDataSourceArchives(sessionID SessionRef, host HostRef, dataSource string) (_retval TaskRef, _err error)

Forget the recorded statistics related to the specified data source

func (AsyncHostClass) GetAPIVersionMajor 

func (_class AsyncHostClass) GetAPIVersionMajor(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the API_version/major field of the given host.

func (AsyncHostClass) GetAPIVersionMinor 

func (_class AsyncHostClass) GetAPIVersionMinor(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the API_version/minor field of the given host.

func (AsyncHostClass) GetAPIVersionVendor 

func (_class AsyncHostClass) GetAPIVersionVendor(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the API_version/vendor field of the given host.

func (AsyncHostClass) GetAPIVersionVendorImplementation 

func (_class AsyncHostClass) GetAPIVersionVendorImplementation(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the API_version/vendor_implementation field of the given host.

func (AsyncHostClass) GetAddress 

func (_class AsyncHostClass) GetAddress(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the address field of the given host.

func (AsyncHostClass) GetAll 

func (_class AsyncHostClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the hosts known to the system.

func (AsyncHostClass) GetAllRecords 

func (_class AsyncHostClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of host references to host records for all hosts known to the system.

func (AsyncHostClass) GetAllowedOperations 

func (_class AsyncHostClass) GetAllowedOperations(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given host.

func (AsyncHostClass) GetBiosStrings 

func (_class AsyncHostClass) GetBiosStrings(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the bios_strings field of the given host.

func (AsyncHostClass) GetBlobs 

func (_class AsyncHostClass) GetBlobs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the blobs field of the given host.

func (AsyncHostClass) GetByNameLabel 

func (_class AsyncHostClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the host instances with the given label.

func (AsyncHostClass) GetByUUID 

func (_class AsyncHostClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the host instance with the specified UUID.

func (AsyncHostClass) GetCPUConfiguration 

func (_class AsyncHostClass) GetCPUConfiguration(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the cpu_configuration field of the given host.

func (AsyncHostClass) GetCPUInfo 

func (_class AsyncHostClass) GetCPUInfo(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the cpu_info field of the given host.

func (AsyncHostClass) GetCapabilities 

func (_class AsyncHostClass) GetCapabilities(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the capabilities field of the given host.

func (AsyncHostClass) GetChipsetInfo 

func (_class AsyncHostClass) GetChipsetInfo(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the chipset_info field of the given host.

func (AsyncHostClass) GetCrashDumpSr 

func (_class AsyncHostClass) GetCrashDumpSr(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the crash_dump_sr field of the given host.

func (AsyncHostClass) GetCrashdumps 

func (_class AsyncHostClass) GetCrashdumps(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the crashdumps field of the given host.

func (AsyncHostClass) GetCurrentOperations 

func (_class AsyncHostClass) GetCurrentOperations(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the current_operations field of the given host.

func (AsyncHostClass) GetDataSources 

func (_class AsyncHostClass) GetDataSources(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

func (AsyncHostClass) GetDisplay 

func (_class AsyncHostClass) GetDisplay(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the display field of the given host.

func (AsyncHostClass) GetEdition 

func (_class AsyncHostClass) GetEdition(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the edition field of the given host.

func (AsyncHostClass) GetEnabled 

func (_class AsyncHostClass) GetEnabled(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the enabled field of the given host.

func (AsyncHostClass) GetExternalAuthConfiguration 

func (_class AsyncHostClass) GetExternalAuthConfiguration(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the external_auth_configuration field of the given host.

func (AsyncHostClass) GetExternalAuthServiceName 

func (_class AsyncHostClass) GetExternalAuthServiceName(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the external_auth_service_name field of the given host.

func (AsyncHostClass) GetExternalAuthType 

func (_class AsyncHostClass) GetExternalAuthType(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the external_auth_type field of the given host.

func (AsyncHostClass) GetGuestVCPUsParams 

func (_class AsyncHostClass) GetGuestVCPUsParams(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the guest_VCPUs_params field of the given host.

func (AsyncHostClass) GetHaNetworkPeers 

func (_class AsyncHostClass) GetHaNetworkPeers(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the ha_network_peers field of the given host.

func (AsyncHostClass) GetHaStatefiles 

func (_class AsyncHostClass) GetHaStatefiles(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the ha_statefiles field of the given host.

func (AsyncHostClass) GetHostCPUs 

func (_class AsyncHostClass) GetHostCPUs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the host_CPUs field of the given host.

func (AsyncHostClass) GetHostname 

func (_class AsyncHostClass) GetHostname(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the hostname field of the given host.

func (AsyncHostClass) GetLicenseParams 

func (_class AsyncHostClass) GetLicenseParams(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the license_params field of the given host.

func (AsyncHostClass) GetLicenseServer 

func (_class AsyncHostClass) GetLicenseServer(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the license_server field of the given host.

func (AsyncHostClass) GetLocalCacheSr 

func (_class AsyncHostClass) GetLocalCacheSr(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the local_cache_sr field of the given host.

func (AsyncHostClass) GetLog 

func (_class AsyncHostClass) GetLog(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Get the host's log file

func (AsyncHostClass) GetLogging 

func (_class AsyncHostClass) GetLogging(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the logging field of the given host.

func (AsyncHostClass) GetManagementInterface 

func (_class AsyncHostClass) GetManagementInterface(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Returns the management interface for the specified host

func (AsyncHostClass) GetMemoryOverhead 

func (_class AsyncHostClass) GetMemoryOverhead(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the memory/overhead field of the given host.

func (AsyncHostClass) GetMetrics 

func (_class AsyncHostClass) GetMetrics(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the metrics field of the given host.

func (AsyncHostClass) GetNameDescription 

func (_class AsyncHostClass) GetNameDescription(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the name/description field of the given host.

func (AsyncHostClass) GetNameLabel 

func (_class AsyncHostClass) GetNameLabel(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the name/label field of the given host.

func (AsyncHostClass) GetOtherConfig 

func (_class AsyncHostClass) GetOtherConfig(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the other_config field of the given host.

func (AsyncHostClass) GetPBDs 

func (_class AsyncHostClass) GetPBDs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the PBDs field of the given host.

func (AsyncHostClass) GetPCIs 

func (_class AsyncHostClass) GetPCIs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the PCIs field of the given host.

func (AsyncHostClass) GetPGPUs 

func (_class AsyncHostClass) GetPGPUs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the PGPUs field of the given host.

func (AsyncHostClass) GetPIFs 

func (_class AsyncHostClass) GetPIFs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the PIFs field of the given host.

func (AsyncHostClass) GetPatches 

func (_class AsyncHostClass) GetPatches(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the patches field of the given host.

func (AsyncHostClass) GetPowerOnConfig 

func (_class AsyncHostClass) GetPowerOnConfig(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the power_on_config field of the given host.

func (AsyncHostClass) GetPowerOnMode 

func (_class AsyncHostClass) GetPowerOnMode(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the power_on_mode field of the given host.

func (AsyncHostClass) GetRecord 

func (_class AsyncHostClass) GetRecord(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given host.

func (AsyncHostClass) GetResidentVMs 

func (_class AsyncHostClass) GetResidentVMs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the resident_VMs field of the given host.

func (AsyncHostClass) GetSchedPolicy 

func (_class AsyncHostClass) GetSchedPolicy(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the sched_policy field of the given host.

func (AsyncHostClass) GetServerCertificate 

func (_class AsyncHostClass) GetServerCertificate(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Get the installed server SSL certificate.

func (AsyncHostClass) GetServerLocaltime 

func (_class AsyncHostClass) GetServerLocaltime(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

This call queries the host's clock for the current time in the host's local timezone

func (AsyncHostClass) GetServertime 

func (_class AsyncHostClass) GetServertime(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

This call queries the host's clock for the current time

func (AsyncHostClass) GetSoftwareVersion 

func (_class AsyncHostClass) GetSoftwareVersion(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the software_version field of the given host.

func (AsyncHostClass) GetSslLegacy 

func (_class AsyncHostClass) GetSslLegacy(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the ssl_legacy field of the given host.

func (AsyncHostClass) GetSupportedBootloaders 

func (_class AsyncHostClass) GetSupportedBootloaders(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the supported_bootloaders field of the given host.

func (AsyncHostClass) GetSuspendImageSr 

func (_class AsyncHostClass) GetSuspendImageSr(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the suspend_image_sr field of the given host.

func (AsyncHostClass) GetSystemStatusCapabilities 

func (_class AsyncHostClass) GetSystemStatusCapabilities(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

func (AsyncHostClass) GetTags 

func (_class AsyncHostClass) GetTags(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the tags field of the given host.

func (AsyncHostClass) GetUUID 

func (_class AsyncHostClass) GetUUID(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the uuid field of the given host.

func (AsyncHostClass) GetUncooperativeResidentVMs 

func (_class AsyncHostClass) GetUncooperativeResidentVMs(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Return a set of VMs which are not co-operating with the host's memory control system

func (AsyncHostClass) GetVirtualHardwarePlatformVersions 

func (_class AsyncHostClass) GetVirtualHardwarePlatformVersions(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Get the virtual_hardware_platform_versions field of the given host.

func (AsyncHostClass) GetVmsWhichPreventEvacuation 

func (_class AsyncHostClass) GetVmsWhichPreventEvacuation(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Return a set of VMs which prevent the host being evacuated, with per-VM error codes

func (AsyncHostClass) LicenseApply 

func (_class AsyncHostClass) LicenseApply(sessionID SessionRef, host HostRef, contents string) (_retval TaskRef, _err error)

Apply a new license to a host

Errors: 

LICENSE_PROCESSING_ERROR - There was an error processing your license.  Please contact your support representative.

func (AsyncHostClass) ListMethods 

func (_class AsyncHostClass) ListMethods(sessionID SessionRef) (_retval TaskRef, _err error)

List all supported methods

func (AsyncHostClass) LocalManagementReconfigure 

func (_class AsyncHostClass) LocalManagementReconfigure(sessionID SessionRef, iface string) (_retval TaskRef, _err error)

Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.

func (AsyncHostClass) ManagementDisable 

func (_class AsyncHostClass) ManagementDisable(sessionID SessionRef) (_retval TaskRef, _err error)

Disable the management network interface

func (AsyncHostClass) ManagementReconfigure 

func (_class AsyncHostClass) ManagementReconfigure(sessionID SessionRef, pif PIFRef) (_retval TaskRef, _err error)

Reconfigure the management network interface

func (AsyncHostClass) MigrateReceive 

func (_class AsyncHostClass) MigrateReceive(sessionID SessionRef, host HostRef, network NetworkRef, options map[string]string) (_retval TaskRef, _err error)

Prepare to receive a VM, returning a token which can be passed to VM.migrate.

func (AsyncHostClass) PowerOn 

func (_class AsyncHostClass) PowerOn(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Attempt to power-on the host (if the capability exists).

func (AsyncHostClass) QueryDataSource 

func (_class AsyncHostClass) QueryDataSource(sessionID SessionRef, host HostRef, dataSource string) (_retval TaskRef, _err error)

Query the latest value of the specified data source

func (AsyncHostClass) Reboot 

func (_class AsyncHostClass) Reboot(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)

func (AsyncHostClass) RecordDataSource 

func (_class AsyncHostClass) RecordDataSource(sessionID SessionRef, host HostRef, dataSource string) (_retval TaskRef, _err error)

Start recording the specified data source

func (AsyncHostClass) RefreshPackInfo 

func (_class AsyncHostClass) RefreshPackInfo(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Refresh the list of installed Supplemental Packs.

func (AsyncHostClass) RemoveFromGuestVCPUsParams 

func (_class AsyncHostClass) RemoveFromGuestVCPUsParams(sessionID SessionRef, self HostRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the guest_VCPUs_params field of the given host. If the key is not in that Map, then do nothing.

func (AsyncHostClass) RemoveFromLicenseServer 

func (_class AsyncHostClass) RemoveFromLicenseServer(sessionID SessionRef, self HostRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the license_server field of the given host. If the key is not in that Map, then do nothing.

func (AsyncHostClass) RemoveFromLogging 

func (_class AsyncHostClass) RemoveFromLogging(sessionID SessionRef, self HostRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncHostClass) RemoveFromOtherConfig 

func (_class AsyncHostClass) RemoveFromOtherConfig(sessionID SessionRef, self HostRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncHostClass) RemoveTags 

func (_class AsyncHostClass) RemoveTags(sessionID SessionRef, self HostRef, value string) (_retval TaskRef, _err error)

Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.

func (AsyncHostClass) ResetCPUFeatures 

func (_class AsyncHostClass) ResetCPUFeatures(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Remove the feature mask, such that after a reboot all features of the CPU are enabled.

func (AsyncHostClass) RestartAgent 

func (_class AsyncHostClass) RestartAgent(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.

func (AsyncHostClass) RetrieveWlbEvacuateRecommendations 

func (_class AsyncHostClass) RetrieveWlbEvacuateRecommendations(sessionID SessionRef, self HostRef) (_retval TaskRef, _err error)

Retrieves recommended host migrations to perform when evacuating the host from the wlb server. If a VM cannot be migrated from the host the reason is listed instead of a recommendation.

func (AsyncHostClass) SendDebugKeys 

func (_class AsyncHostClass) SendDebugKeys(sessionID SessionRef, host HostRef, keys string) (_retval TaskRef, _err error)

Inject the given string as debugging keys into Xen

func (AsyncHostClass) SetAddress 

func (_class AsyncHostClass) SetAddress(sessionID SessionRef, self HostRef, value string) (_retval TaskRef, _err error)

Set the address field of the given host.

func (AsyncHostClass) SetCPUFeatures 

func (_class AsyncHostClass) SetCPUFeatures(sessionID SessionRef, host HostRef, features string) (_retval TaskRef, _err error)

Set the CPU features to be used after a reboot, if the given features string is valid.

func (AsyncHostClass) SetCrashDumpSr 

func (_class AsyncHostClass) SetCrashDumpSr(sessionID SessionRef, self HostRef, value SRRef) (_retval TaskRef, _err error)

Set the crash_dump_sr field of the given host.

func (AsyncHostClass) SetDisplay 

func (_class AsyncHostClass) SetDisplay(sessionID SessionRef, self HostRef, value HostDisplay) (_retval TaskRef, _err error)

Set the display field of the given host.

func (AsyncHostClass) SetGuestVCPUsParams 

func (_class AsyncHostClass) SetGuestVCPUsParams(sessionID SessionRef, self HostRef, value map[string]string) (_retval TaskRef, _err error)

Set the guest_VCPUs_params field of the given host.

func (AsyncHostClass) SetHostname 

func (_class AsyncHostClass) SetHostname(sessionID SessionRef, self HostRef, value string) (_retval TaskRef, _err error)

Set the hostname field of the given host.

func (AsyncHostClass) SetHostnameLive 

func (_class AsyncHostClass) SetHostnameLive(sessionID SessionRef, host HostRef, hostname string) (_retval TaskRef, _err error)

Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.

Errors: 

HOST_NAME_INVALID - The host name is invalid.

func (AsyncHostClass) SetLicenseServer 

func (_class AsyncHostClass) SetLicenseServer(sessionID SessionRef, self HostRef, value map[string]string) (_retval TaskRef, _err error)

Set the license_server field of the given host.

func (AsyncHostClass) SetLogging 

func (_class AsyncHostClass) SetLogging(sessionID SessionRef, self HostRef, value map[string]string) (_retval TaskRef, _err error)

Set the logging field of the given host.

func (AsyncHostClass) SetNameDescription 

func (_class AsyncHostClass) SetNameDescription(sessionID SessionRef, self HostRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given host.

func (AsyncHostClass) SetNameLabel 

func (_class AsyncHostClass) SetNameLabel(sessionID SessionRef, self HostRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given host.

func (AsyncHostClass) SetOtherConfig 

func (_class AsyncHostClass) SetOtherConfig(sessionID SessionRef, self HostRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given host.

func (AsyncHostClass) SetPowerOnMode 

func (_class AsyncHostClass) SetPowerOnMode(sessionID SessionRef, self HostRef, powerOnMode string, powerOnConfig map[string]string) (_retval TaskRef, _err error)

Set the power-on-mode, host, user and password

func (AsyncHostClass) SetSslLegacy 

func (_class AsyncHostClass) SetSslLegacy(sessionID SessionRef, self HostRef, value bool) (_retval TaskRef, _err error)

Enable/disable SSLv3 for interoperability with older versions of XenServer

func (AsyncHostClass) SetSuspendImageSr 

func (_class AsyncHostClass) SetSuspendImageSr(sessionID SessionRef, self HostRef, value SRRef) (_retval TaskRef, _err error)

Set the suspend_image_sr field of the given host.

func (AsyncHostClass) SetTags 

func (_class AsyncHostClass) SetTags(sessionID SessionRef, self HostRef, value []string) (_retval TaskRef, _err error)

Set the tags field of the given host.

func (AsyncHostClass) Shutdown 

func (_class AsyncHostClass) Shutdown(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)

func (AsyncHostClass) ShutdownAgent 

func (_class AsyncHostClass) ShutdownAgent(sessionID SessionRef) (_retval TaskRef, _err error)

Shuts the agent down after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.

func (AsyncHostClass) SyncData 

func (_class AsyncHostClass) SyncData(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host

func (AsyncHostClass) SyslogReconfigure 

func (_class AsyncHostClass) SyslogReconfigure(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Re-configure syslog logging

type AsyncHostCrashdumpClass 

type AsyncHostCrashdumpClass struct {
	// contains filtered or unexported fields
}

Represents a host crash dump

func (AsyncHostCrashdumpClass) AddToOtherConfig 

func (_class AsyncHostCrashdumpClass) AddToOtherConfig(sessionID SessionRef, self HostCrashdumpRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given host_crashdump.

func (AsyncHostCrashdumpClass) Destroy 

func (_class AsyncHostCrashdumpClass) Destroy(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Destroy specified host crash dump, removing it from the disk.

func (AsyncHostCrashdumpClass) GetAll 

func (_class AsyncHostCrashdumpClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the host_crashdumps known to the system.

func (AsyncHostCrashdumpClass) GetAllRecords 

func (_class AsyncHostCrashdumpClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of host_crashdump references to host_crashdump records for all host_crashdumps known to the system.

func (AsyncHostCrashdumpClass) GetByUUID 

func (_class AsyncHostCrashdumpClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the host_crashdump instance with the specified UUID.

func (AsyncHostCrashdumpClass) GetHost 

func (_class AsyncHostCrashdumpClass) GetHost(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Get the host field of the given host_crashdump.

func (AsyncHostCrashdumpClass) GetOtherConfig 

func (_class AsyncHostCrashdumpClass) GetOtherConfig(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Get the other_config field of the given host_crashdump.

func (AsyncHostCrashdumpClass) GetRecord 

func (_class AsyncHostCrashdumpClass) GetRecord(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given host_crashdump.

func (AsyncHostCrashdumpClass) GetSize 

func (_class AsyncHostCrashdumpClass) GetSize(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Get the size field of the given host_crashdump.

func (AsyncHostCrashdumpClass) GetTimestamp 

func (_class AsyncHostCrashdumpClass) GetTimestamp(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Get the timestamp field of the given host_crashdump.

func (AsyncHostCrashdumpClass) GetUUID 

func (_class AsyncHostCrashdumpClass) GetUUID(sessionID SessionRef, self HostCrashdumpRef) (_retval TaskRef, _err error)

Get the uuid field of the given host_crashdump.

func (AsyncHostCrashdumpClass) RemoveFromOtherConfig 

func (_class AsyncHostCrashdumpClass) RemoveFromOtherConfig(sessionID SessionRef, self HostCrashdumpRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given host_crashdump. If the key is not in that Map, then do nothing.

func (AsyncHostCrashdumpClass) SetOtherConfig 

func (_class AsyncHostCrashdumpClass) SetOtherConfig(sessionID SessionRef, self HostCrashdumpRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given host_crashdump.

func (AsyncHostCrashdumpClass) Upload 

func (_class AsyncHostCrashdumpClass) Upload(sessionID SessionRef, self HostCrashdumpRef, url string, options map[string]string) (_retval TaskRef, _err error)

Upload the specified host crash dump to a specified URL

type AsyncHostMetricsClass 

type AsyncHostMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a host

func (AsyncHostMetricsClass) AddToOtherConfig 

func (_class AsyncHostMetricsClass) AddToOtherConfig(sessionID SessionRef, self HostMetricsRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given host_metrics.

func (AsyncHostMetricsClass) GetAll 

func (_class AsyncHostMetricsClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the host_metrics instances known to the system.

func (AsyncHostMetricsClass) GetAllRecords 

func (_class AsyncHostMetricsClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of host_metrics references to host_metrics records for all host_metrics instances known to the system.

func (AsyncHostMetricsClass) GetByUUID 

func (_class AsyncHostMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the host_metrics instance with the specified UUID.

func (AsyncHostMetricsClass) GetLastUpdated 

func (_class AsyncHostMetricsClass) GetLastUpdated(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get the last_updated field of the given host_metrics.

func (AsyncHostMetricsClass) GetLive 

func (_class AsyncHostMetricsClass) GetLive(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get the live field of the given host_metrics.

func (AsyncHostMetricsClass) GetMemoryFree 

func (_class AsyncHostMetricsClass) GetMemoryFree(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get the memory/free field of the given host_metrics.

func (AsyncHostMetricsClass) GetMemoryTotal 

func (_class AsyncHostMetricsClass) GetMemoryTotal(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get the memory/total field of the given host_metrics.

func (AsyncHostMetricsClass) GetOtherConfig 

func (_class AsyncHostMetricsClass) GetOtherConfig(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get the other_config field of the given host_metrics.

func (AsyncHostMetricsClass) GetRecord 

func (_class AsyncHostMetricsClass) GetRecord(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given host_metrics.

func (AsyncHostMetricsClass) GetUUID 

func (_class AsyncHostMetricsClass) GetUUID(sessionID SessionRef, self HostMetricsRef) (_retval TaskRef, _err error)

Get the uuid field of the given host_metrics.

func (AsyncHostMetricsClass) RemoveFromOtherConfig 

func (_class AsyncHostMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self HostMetricsRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given host_metrics. If the key is not in that Map, then do nothing.

func (AsyncHostMetricsClass) SetOtherConfig 

func (_class AsyncHostMetricsClass) SetOtherConfig(sessionID SessionRef, self HostMetricsRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given host_metrics.

type AsyncHostPatchClass 

type AsyncHostPatchClass struct {
	// contains filtered or unexported fields
}

Represents a patch stored on a server

func (AsyncHostPatchClass) AddToOtherConfig 

func (_class AsyncHostPatchClass) AddToOtherConfig(sessionID SessionRef, self HostPatchRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given host_patch.

func (AsyncHostPatchClass) Apply 

func (_class AsyncHostPatchClass) Apply(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Apply the selected patch and return its output

func (AsyncHostPatchClass) Destroy 

func (_class AsyncHostPatchClass) Destroy(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch

func (AsyncHostPatchClass) GetAll 

func (_class AsyncHostPatchClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the host_patchs known to the system.

func (AsyncHostPatchClass) GetAllRecords 

func (_class AsyncHostPatchClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of host_patch references to host_patch records for all host_patchs known to the system.

func (AsyncHostPatchClass) GetApplied 

func (_class AsyncHostPatchClass) GetApplied(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the applied field of the given host_patch.

func (AsyncHostPatchClass) GetByNameLabel 

func (_class AsyncHostPatchClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the host_patch instances with the given label.

func (AsyncHostPatchClass) GetByUUID 

func (_class AsyncHostPatchClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the host_patch instance with the specified UUID.

func (AsyncHostPatchClass) GetHost 

func (_class AsyncHostPatchClass) GetHost(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the host field of the given host_patch.

func (AsyncHostPatchClass) GetNameDescription 

func (_class AsyncHostPatchClass) GetNameDescription(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the name/description field of the given host_patch.

func (AsyncHostPatchClass) GetNameLabel 

func (_class AsyncHostPatchClass) GetNameLabel(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the name/label field of the given host_patch.

func (AsyncHostPatchClass) GetOtherConfig 

func (_class AsyncHostPatchClass) GetOtherConfig(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the other_config field of the given host_patch.

func (AsyncHostPatchClass) GetPoolPatch 

func (_class AsyncHostPatchClass) GetPoolPatch(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the pool_patch field of the given host_patch.

func (AsyncHostPatchClass) GetRecord 

func (_class AsyncHostPatchClass) GetRecord(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given host_patch.

func (AsyncHostPatchClass) GetSize 

func (_class AsyncHostPatchClass) GetSize(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the size field of the given host_patch.

func (AsyncHostPatchClass) GetTimestampApplied 

func (_class AsyncHostPatchClass) GetTimestampApplied(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the timestamp_applied field of the given host_patch.

func (AsyncHostPatchClass) GetUUID 

func (_class AsyncHostPatchClass) GetUUID(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the uuid field of the given host_patch.

func (AsyncHostPatchClass) GetVersion 

func (_class AsyncHostPatchClass) GetVersion(sessionID SessionRef, self HostPatchRef) (_retval TaskRef, _err error)

Get the version field of the given host_patch.

func (AsyncHostPatchClass) RemoveFromOtherConfig 

func (_class AsyncHostPatchClass) RemoveFromOtherConfig(sessionID SessionRef, self HostPatchRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncHostPatchClass) SetOtherConfig 

func (_class AsyncHostPatchClass) SetOtherConfig(sessionID SessionRef, self HostPatchRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given host_patch.

type AsyncMessageClass 

type AsyncMessageClass struct {
	// contains filtered or unexported fields
}

An message for the attention of the administrator

func (AsyncMessageClass) Create 

func (_class AsyncMessageClass) Create(sessionID SessionRef, name string, priority int, cls Cls, objUUID string, body string) (_retval TaskRef, _err error)

func (AsyncMessageClass) Destroy 

func (_class AsyncMessageClass) Destroy(sessionID SessionRef, self MessageRef) (_retval TaskRef, _err error)

func (AsyncMessageClass) Get 

func (_class AsyncMessageClass) Get(sessionID SessionRef, cls Cls, objUUID string, since time.Time) (_retval TaskRef, _err error)

func (AsyncMessageClass) GetAll 

func (_class AsyncMessageClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

func (AsyncMessageClass) GetAllRecords 

func (_class AsyncMessageClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

func (AsyncMessageClass) GetAllRecordsWhere 

func (_class AsyncMessageClass) GetAllRecordsWhere(sessionID SessionRef, expr string) (_retval TaskRef, _err error)

func (AsyncMessageClass) GetByUUID 

func (_class AsyncMessageClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

func (AsyncMessageClass) GetRecord 

func (_class AsyncMessageClass) GetRecord(sessionID SessionRef, self MessageRef) (_retval TaskRef, _err error)

func (AsyncMessageClass) GetSince 

func (_class AsyncMessageClass) GetSince(sessionID SessionRef, since time.Time) (_retval TaskRef, _err error)

type AsyncNetworkClass 

type AsyncNetworkClass struct {
	// contains filtered or unexported fields
}

A virtual network

func (AsyncNetworkClass) AddTags 

func (_class AsyncNetworkClass) AddTags(sessionID SessionRef, self NetworkRef, value string) (_retval TaskRef, _err error)

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing.

func (AsyncNetworkClass) AddToOtherConfig 

func (_class AsyncNetworkClass) AddToOtherConfig(sessionID SessionRef, self NetworkRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given network.

func (AsyncNetworkClass) Create 

func (_class AsyncNetworkClass) Create(sessionID SessionRef, args NetworkRecord) (_retval TaskRef, _err error)

Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config*, tags (* = non-optional).

func (AsyncNetworkClass) CreateNewBlob 

func (_class AsyncNetworkClass) CreateNewBlob(sessionID SessionRef, network NetworkRef, name string, mimeType string, public bool) (_retval TaskRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this pool

func (AsyncNetworkClass) Destroy 

func (_class AsyncNetworkClass) Destroy(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Destroy the specified network instance.

func (AsyncNetworkClass) GetAll 

func (_class AsyncNetworkClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the networks known to the system.

func (AsyncNetworkClass) GetAllRecords 

func (_class AsyncNetworkClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of network references to network records for all networks known to the system.

func (AsyncNetworkClass) GetAllowedOperations 

func (_class AsyncNetworkClass) GetAllowedOperations(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given network.

func (AsyncNetworkClass) GetAssignedIps 

func (_class AsyncNetworkClass) GetAssignedIps(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the assigned_ips field of the given network.

func (AsyncNetworkClass) GetBlobs 

func (_class AsyncNetworkClass) GetBlobs(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the blobs field of the given network.

func (AsyncNetworkClass) GetBridge 

func (_class AsyncNetworkClass) GetBridge(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the bridge field of the given network.

func (AsyncNetworkClass) GetByNameLabel 

func (_class AsyncNetworkClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the network instances with the given label.

func (AsyncNetworkClass) GetByUUID 

func (_class AsyncNetworkClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the network instance with the specified UUID.

func (AsyncNetworkClass) GetCurrentOperations 

func (_class AsyncNetworkClass) GetCurrentOperations(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the current_operations field of the given network.

func (AsyncNetworkClass) GetDefaultLockingMode 

func (_class AsyncNetworkClass) GetDefaultLockingMode(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the default_locking_mode field of the given network.

func (AsyncNetworkClass) GetMTU 

func (_class AsyncNetworkClass) GetMTU(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the MTU field of the given network.

func (AsyncNetworkClass) GetNameDescription 

func (_class AsyncNetworkClass) GetNameDescription(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the name/description field of the given network.

func (AsyncNetworkClass) GetNameLabel 

func (_class AsyncNetworkClass) GetNameLabel(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the name/label field of the given network.

func (AsyncNetworkClass) GetOtherConfig 

func (_class AsyncNetworkClass) GetOtherConfig(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the other_config field of the given network.

func (AsyncNetworkClass) GetPIFs 

func (_class AsyncNetworkClass) GetPIFs(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the PIFs field of the given network.

func (AsyncNetworkClass) GetRecord 

func (_class AsyncNetworkClass) GetRecord(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given network.

func (AsyncNetworkClass) GetTags 

func (_class AsyncNetworkClass) GetTags(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the tags field of the given network.

func (AsyncNetworkClass) GetUUID 

func (_class AsyncNetworkClass) GetUUID(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the uuid field of the given network.

func (AsyncNetworkClass) GetVIFs 

func (_class AsyncNetworkClass) GetVIFs(sessionID SessionRef, self NetworkRef) (_retval TaskRef, _err error)

Get the VIFs field of the given network.

func (AsyncNetworkClass) RemoveFromOtherConfig 

func (_class AsyncNetworkClass) RemoveFromOtherConfig(sessionID SessionRef, self NetworkRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncNetworkClass) RemoveTags 

func (_class AsyncNetworkClass) RemoveTags(sessionID SessionRef, self NetworkRef, value string) (_retval TaskRef, _err error)

Remove the given value from the tags field of the given network. If the value is not in that Set, then do nothing.

func (AsyncNetworkClass) SetDefaultLockingMode 

func (_class AsyncNetworkClass) SetDefaultLockingMode(sessionID SessionRef, network NetworkRef, value NetworkDefaultLockingMode) (_retval TaskRef, _err error)

Set the default locking mode for VIFs attached to this network

func (AsyncNetworkClass) SetMTU 

func (_class AsyncNetworkClass) SetMTU(sessionID SessionRef, self NetworkRef, value int) (_retval TaskRef, _err error)

Set the MTU field of the given network.

func (AsyncNetworkClass) SetNameDescription 

func (_class AsyncNetworkClass) SetNameDescription(sessionID SessionRef, self NetworkRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given network.

func (AsyncNetworkClass) SetNameLabel 

func (_class AsyncNetworkClass) SetNameLabel(sessionID SessionRef, self NetworkRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given network.

func (AsyncNetworkClass) SetOtherConfig 

func (_class AsyncNetworkClass) SetOtherConfig(sessionID SessionRef, self NetworkRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given network.

func (AsyncNetworkClass) SetTags 

func (_class AsyncNetworkClass) SetTags(sessionID SessionRef, self NetworkRef, value []string) (_retval TaskRef, _err error)

Set the tags field of the given network.

type AsyncPBDClass 

type AsyncPBDClass struct {
	// contains filtered or unexported fields
}

The physical block devices through which hosts access SRs

func (AsyncPBDClass) AddToOtherConfig 

func (_class AsyncPBDClass) AddToOtherConfig(sessionID SessionRef, self PBDRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given PBD.

func (AsyncPBDClass) Create 

func (_class AsyncPBDClass) Create(sessionID SessionRef, args PBDRecord) (_retval TaskRef, _err error)

Create a new PBD instance, and return its handle. The constructor args are: host*, SR*, device_config*, other_config (* = non-optional).

func (AsyncPBDClass) Destroy 

func (_class AsyncPBDClass) Destroy(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Destroy the specified PBD instance.

func (AsyncPBDClass) GetAll 

func (_class AsyncPBDClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the PBDs known to the system.

func (AsyncPBDClass) GetAllRecords 

func (_class AsyncPBDClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of PBD references to PBD records for all PBDs known to the system.

func (AsyncPBDClass) GetByUUID 

func (_class AsyncPBDClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the PBD instance with the specified UUID.

func (AsyncPBDClass) GetCurrentlyAttached 

func (_class AsyncPBDClass) GetCurrentlyAttached(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get the currently_attached field of the given PBD.

func (AsyncPBDClass) GetDeviceConfig 

func (_class AsyncPBDClass) GetDeviceConfig(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get the device_config field of the given PBD.

func (AsyncPBDClass) GetHost 

func (_class AsyncPBDClass) GetHost(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get the host field of the given PBD.

func (AsyncPBDClass) GetOtherConfig 

func (_class AsyncPBDClass) GetOtherConfig(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get the other_config field of the given PBD.

func (AsyncPBDClass) GetRecord 

func (_class AsyncPBDClass) GetRecord(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given PBD.

func (AsyncPBDClass) GetSR 

func (_class AsyncPBDClass) GetSR(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get the SR field of the given PBD.

func (AsyncPBDClass) GetUUID 

func (_class AsyncPBDClass) GetUUID(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Get the uuid field of the given PBD.

func (AsyncPBDClass) Plug 

func (_class AsyncPBDClass) Plug(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Activate the specified PBD, causing the referenced SR to be attached and scanned

Errors: 

SR_UNKNOWN_DRIVER - The SR could not be connected because the driver was not recognised.

func (AsyncPBDClass) RemoveFromOtherConfig 

func (_class AsyncPBDClass) RemoveFromOtherConfig(sessionID SessionRef, self PBDRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncPBDClass) SetDeviceConfig 

func (_class AsyncPBDClass) SetDeviceConfig(sessionID SessionRef, self PBDRef, value map[string]string) (_retval TaskRef, _err error)

Sets the PBD's device_config field

func (AsyncPBDClass) SetOtherConfig 

func (_class AsyncPBDClass) SetOtherConfig(sessionID SessionRef, self PBDRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given PBD.

func (AsyncPBDClass) Unplug 

func (_class AsyncPBDClass) Unplug(sessionID SessionRef, self PBDRef) (_retval TaskRef, _err error)

Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned

type AsyncPCIClass 

type AsyncPCIClass struct {
	// contains filtered or unexported fields
}

A PCI device

func (AsyncPCIClass) AddToOtherConfig 

func (_class AsyncPCIClass) AddToOtherConfig(sessionID SessionRef, self PCIRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given PCI.

func (AsyncPCIClass) GetAll 

func (_class AsyncPCIClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the PCIs known to the system.

func (AsyncPCIClass) GetAllRecords 

func (_class AsyncPCIClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of PCI references to PCI records for all PCIs known to the system.

func (AsyncPCIClass) GetByUUID 

func (_class AsyncPCIClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the PCI instance with the specified UUID.

func (AsyncPCIClass) GetClassName 

func (_class AsyncPCIClass) GetClassName(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the class_name field of the given PCI.

func (AsyncPCIClass) GetDependencies 

func (_class AsyncPCIClass) GetDependencies(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the dependencies field of the given PCI.

func (AsyncPCIClass) GetDeviceName 

func (_class AsyncPCIClass) GetDeviceName(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the device_name field of the given PCI.

func (AsyncPCIClass) GetHost 

func (_class AsyncPCIClass) GetHost(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the host field of the given PCI.

func (AsyncPCIClass) GetOtherConfig 

func (_class AsyncPCIClass) GetOtherConfig(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the other_config field of the given PCI.

func (AsyncPCIClass) GetPciID 

func (_class AsyncPCIClass) GetPciID(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the pci_id field of the given PCI.

func (AsyncPCIClass) GetRecord 

func (_class AsyncPCIClass) GetRecord(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given PCI.

func (AsyncPCIClass) GetSubsystemDeviceName 

func (_class AsyncPCIClass) GetSubsystemDeviceName(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the subsystem_device_name field of the given PCI.

func (AsyncPCIClass) GetSubsystemVendorName 

func (_class AsyncPCIClass) GetSubsystemVendorName(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the subsystem_vendor_name field of the given PCI.

func (AsyncPCIClass) GetUUID 

func (_class AsyncPCIClass) GetUUID(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the uuid field of the given PCI.

func (AsyncPCIClass) GetVendorName 

func (_class AsyncPCIClass) GetVendorName(sessionID SessionRef, self PCIRef) (_retval TaskRef, _err error)

Get the vendor_name field of the given PCI.

func (AsyncPCIClass) RemoveFromOtherConfig 

func (_class AsyncPCIClass) RemoveFromOtherConfig(sessionID SessionRef, self PCIRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given PCI. If the key is not in that Map, then do nothing.

func (AsyncPCIClass) SetOtherConfig 

func (_class AsyncPCIClass) SetOtherConfig(sessionID SessionRef, self PCIRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given PCI.

type AsyncPGPUClass 

type AsyncPGPUClass struct {
	// contains filtered or unexported fields
}

A physical GPU (pGPU)

func (AsyncPGPUClass) AddEnabledVGPUTypes 

func (_class AsyncPGPUClass) AddEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value VGPUTypeRef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) AddToOtherConfig 

func (_class AsyncPGPUClass) AddToOtherConfig(sessionID SessionRef, self PGPURef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given PGPU.

func (AsyncPGPUClass) DisableDom0Access 

func (_class AsyncPGPUClass) DisableDom0Access(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) EnableDom0Access 

func (_class AsyncPGPUClass) EnableDom0Access(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) GetAll 

func (_class AsyncPGPUClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the PGPUs known to the system.

func (AsyncPGPUClass) GetAllRecords 

func (_class AsyncPGPUClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of PGPU references to PGPU records for all PGPUs known to the system.

func (AsyncPGPUClass) GetByUUID 

func (_class AsyncPGPUClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the PGPU instance with the specified UUID.

func (AsyncPGPUClass) GetDom0Access 

func (_class AsyncPGPUClass) GetDom0Access(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the dom0_access field of the given PGPU.

func (AsyncPGPUClass) GetEnabledVGPUTypes 

func (_class AsyncPGPUClass) GetEnabledVGPUTypes(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the enabled_VGPU_types field of the given PGPU.

func (AsyncPGPUClass) GetGPUGroup 

func (_class AsyncPGPUClass) GetGPUGroup(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the GPU_group field of the given PGPU.

func (AsyncPGPUClass) GetHost 

func (_class AsyncPGPUClass) GetHost(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the host field of the given PGPU.

func (AsyncPGPUClass) GetIsSystemDisplayDevice 

func (_class AsyncPGPUClass) GetIsSystemDisplayDevice(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the is_system_display_device field of the given PGPU.

func (AsyncPGPUClass) GetOtherConfig 

func (_class AsyncPGPUClass) GetOtherConfig(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the other_config field of the given PGPU.

func (AsyncPGPUClass) GetPCI 

func (_class AsyncPGPUClass) GetPCI(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the PCI field of the given PGPU.

func (AsyncPGPUClass) GetRecord 

func (_class AsyncPGPUClass) GetRecord(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get a record containing the current state of the given PGPU.

func (AsyncPGPUClass) GetRemainingCapacity 

func (_class AsyncPGPUClass) GetRemainingCapacity(sessionID SessionRef, self PGPURef, vgpuType VGPUTypeRef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) GetResidentVGPUs 

func (_class AsyncPGPUClass) GetResidentVGPUs(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the resident_VGPUs field of the given PGPU.

func (AsyncPGPUClass) GetSupportedVGPUMaxCapacities 

func (_class AsyncPGPUClass) GetSupportedVGPUMaxCapacities(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the supported_VGPU_max_capacities field of the given PGPU.

func (AsyncPGPUClass) GetSupportedVGPUTypes 

func (_class AsyncPGPUClass) GetSupportedVGPUTypes(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the supported_VGPU_types field of the given PGPU.

func (AsyncPGPUClass) GetUUID 

func (_class AsyncPGPUClass) GetUUID(sessionID SessionRef, self PGPURef) (_retval TaskRef, _err error)

Get the uuid field of the given PGPU.

func (AsyncPGPUClass) RemoveEnabledVGPUTypes 

func (_class AsyncPGPUClass) RemoveEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value VGPUTypeRef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) RemoveFromOtherConfig 

func (_class AsyncPGPUClass) RemoveFromOtherConfig(sessionID SessionRef, self PGPURef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given PGPU. If the key is not in that Map, then do nothing.

func (AsyncPGPUClass) SetEnabledVGPUTypes 

func (_class AsyncPGPUClass) SetEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value []VGPUTypeRef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) SetGPUGroup 

func (_class AsyncPGPUClass) SetGPUGroup(sessionID SessionRef, self PGPURef, value GPUGroupRef) (_retval TaskRef, _err error)

func (AsyncPGPUClass) SetOtherConfig 

func (_class AsyncPGPUClass) SetOtherConfig(sessionID SessionRef, self PGPURef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given PGPU.

type AsyncPIFClass 

type AsyncPIFClass struct {
	// contains filtered or unexported fields
}

A physical network interface (note separate VLANs are represented as several PIFs)

func (AsyncPIFClass) AddToOtherConfig 

func (_class AsyncPIFClass) AddToOtherConfig(sessionID SessionRef, self PIFRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given PIF.

func (AsyncPIFClass) CreateVLAN 

func (_class AsyncPIFClass) CreateVLAN(sessionID SessionRef, device string, network NetworkRef, host HostRef, vlan int) (_retval TaskRef, _err error)

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead

Errors: 

VLAN_TAG_INVALID - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.  The parameter echoes the VLAN tag you gave.

func (AsyncPIFClass) DbForget 

func (_class AsyncPIFClass) DbForget(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Destroy a PIF database record.

func (AsyncPIFClass) DbIntroduce 

func (_class AsyncPIFClass) DbIntroduce(sessionID SessionRef, device string, network NetworkRef, host HostRef, mac string, mtu int, vlan int, physical bool, ipConfigurationMode IPConfigurationMode, ip string, netmask string, gateway string, dns string, bondSlaveOf BondRef, vlanMasterOf VLANRef, management bool, otherConfig map[string]string, disallowUnplug bool, ipv6ConfigurationMode Ipv6ConfigurationMode, ipv6 []string, ipv6Gateway string, primaryAddressType PrimaryAddressType, managed bool, properties map[string]string) (_retval TaskRef, _err error)

Create a new PIF record in the database only

func (AsyncPIFClass) Destroy 

func (_class AsyncPIFClass) Destroy(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead

Errors: 

PIF_IS_PHYSICAL - You tried to destroy a PIF, but it represents an aspect of the physical host configuration, and so cannot be destroyed.  The parameter echoes the PIF handle you gave.

func (AsyncPIFClass) Forget 

func (_class AsyncPIFClass) Forget(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Destroy the PIF object matching a particular network interface

Errors: 

PIF_TUNNEL_STILL_EXISTS - Operation cannot proceed while a tunnel exists on this interface.

func (AsyncPIFClass) GetAll 

func (_class AsyncPIFClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the PIFs known to the system.

func (AsyncPIFClass) GetAllRecords 

func (_class AsyncPIFClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of PIF references to PIF records for all PIFs known to the system.

func (AsyncPIFClass) GetBondMasterOf 

func (_class AsyncPIFClass) GetBondMasterOf(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the bond_master_of field of the given PIF.

func (AsyncPIFClass) GetBondSlaveOf 

func (_class AsyncPIFClass) GetBondSlaveOf(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the bond_slave_of field of the given PIF.

func (AsyncPIFClass) GetByUUID 

func (_class AsyncPIFClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the PIF instance with the specified UUID.

func (AsyncPIFClass) GetCapabilities 

func (_class AsyncPIFClass) GetCapabilities(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the capabilities field of the given PIF.

func (AsyncPIFClass) GetCurrentlyAttached 

func (_class AsyncPIFClass) GetCurrentlyAttached(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the currently_attached field of the given PIF.

func (AsyncPIFClass) GetDNS 

func (_class AsyncPIFClass) GetDNS(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the DNS field of the given PIF.

func (AsyncPIFClass) GetDevice 

func (_class AsyncPIFClass) GetDevice(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the device field of the given PIF.

func (AsyncPIFClass) GetDisallowUnplug 

func (_class AsyncPIFClass) GetDisallowUnplug(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the disallow_unplug field of the given PIF.

func (AsyncPIFClass) GetGateway 

func (_class AsyncPIFClass) GetGateway(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the gateway field of the given PIF.

func (AsyncPIFClass) GetHost 

func (_class AsyncPIFClass) GetHost(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the host field of the given PIF.

func (AsyncPIFClass) GetIP 

func (_class AsyncPIFClass) GetIP(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the IP field of the given PIF.

func (AsyncPIFClass) GetIPConfigurationMode 

func (_class AsyncPIFClass) GetIPConfigurationMode(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the ip_configuration_mode field of the given PIF.

func (AsyncPIFClass) GetIPv6 

func (_class AsyncPIFClass) GetIPv6(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the IPv6 field of the given PIF.

func (AsyncPIFClass) GetIpv6ConfigurationMode 

func (_class AsyncPIFClass) GetIpv6ConfigurationMode(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the ipv6_configuration_mode field of the given PIF.

func (AsyncPIFClass) GetIpv6Gateway 

func (_class AsyncPIFClass) GetIpv6Gateway(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the ipv6_gateway field of the given PIF.

func (AsyncPIFClass) GetMAC 

func (_class AsyncPIFClass) GetMAC(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the MAC field of the given PIF.

func (AsyncPIFClass) GetMTU 

func (_class AsyncPIFClass) GetMTU(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the MTU field of the given PIF.

func (AsyncPIFClass) GetManaged 

func (_class AsyncPIFClass) GetManaged(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the managed field of the given PIF.

func (AsyncPIFClass) GetManagement 

func (_class AsyncPIFClass) GetManagement(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the management field of the given PIF.

func (AsyncPIFClass) GetMetrics 

func (_class AsyncPIFClass) GetMetrics(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the metrics field of the given PIF.

func (AsyncPIFClass) GetNetmask 

func (_class AsyncPIFClass) GetNetmask(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the netmask field of the given PIF.

func (AsyncPIFClass) GetNetwork 

func (_class AsyncPIFClass) GetNetwork(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the network field of the given PIF.

func (AsyncPIFClass) GetOtherConfig 

func (_class AsyncPIFClass) GetOtherConfig(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the other_config field of the given PIF.

func (AsyncPIFClass) GetPhysical 

func (_class AsyncPIFClass) GetPhysical(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the physical field of the given PIF.

func (AsyncPIFClass) GetPrimaryAddressType 

func (_class AsyncPIFClass) GetPrimaryAddressType(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the primary_address_type field of the given PIF.

func (AsyncPIFClass) GetProperties 

func (_class AsyncPIFClass) GetProperties(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the properties field of the given PIF.

func (AsyncPIFClass) GetRecord 

func (_class AsyncPIFClass) GetRecord(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given PIF.

func (AsyncPIFClass) GetTunnelAccessPIFOf 

func (_class AsyncPIFClass) GetTunnelAccessPIFOf(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the tunnel_access_PIF_of field of the given PIF.

func (AsyncPIFClass) GetTunnelTransportPIFOf 

func (_class AsyncPIFClass) GetTunnelTransportPIFOf(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the tunnel_transport_PIF_of field of the given PIF.

func (AsyncPIFClass) GetUUID 

func (_class AsyncPIFClass) GetUUID(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the uuid field of the given PIF.

func (AsyncPIFClass) GetVLAN 

func (_class AsyncPIFClass) GetVLAN(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the VLAN field of the given PIF.

func (AsyncPIFClass) GetVLANMasterOf 

func (_class AsyncPIFClass) GetVLANMasterOf(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the VLAN_master_of field of the given PIF.

func (AsyncPIFClass) GetVLANSlaveOf 

func (_class AsyncPIFClass) GetVLANSlaveOf(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Get the VLAN_slave_of field of the given PIF.

func (AsyncPIFClass) Introduce 

func (_class AsyncPIFClass) Introduce(sessionID SessionRef, host HostRef, mac string, device string, managed bool) (_retval TaskRef, _err error)

Create a PIF object matching a particular network interface

func (AsyncPIFClass) Plug 

func (_class AsyncPIFClass) Plug(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Attempt to bring up a physical interface

Errors: 

TRANSPORT_PIF_NOT_CONFIGURED - The tunnel transport PIF has no IP configuration set.

func (AsyncPIFClass) ReconfigureIP 

func (_class AsyncPIFClass) ReconfigureIP(sessionID SessionRef, self PIFRef, mode IPConfigurationMode, ip string, netmask string, gateway string, dns string) (_retval TaskRef, _err error)

Reconfigure the IP address settings for this interface

func (AsyncPIFClass) ReconfigureIpv6 

func (_class AsyncPIFClass) ReconfigureIpv6(sessionID SessionRef, self PIFRef, mode Ipv6ConfigurationMode, ipv6 string, gateway string, dns string) (_retval TaskRef, _err error)

Reconfigure the IPv6 address settings for this interface

func (AsyncPIFClass) RemoveFromOtherConfig 

func (_class AsyncPIFClass) RemoveFromOtherConfig(sessionID SessionRef, self PIFRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncPIFClass) Scan 

func (_class AsyncPIFClass) Scan(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Scan for physical interfaces on a host and create PIF objects to represent them

func (AsyncPIFClass) SetDisallowUnplug 

func (_class AsyncPIFClass) SetDisallowUnplug(sessionID SessionRef, self PIFRef, value bool) (_retval TaskRef, _err error)

Set the disallow_unplug field of the given PIF.

func (AsyncPIFClass) SetOtherConfig 

func (_class AsyncPIFClass) SetOtherConfig(sessionID SessionRef, self PIFRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given PIF.

func (AsyncPIFClass) SetPrimaryAddressType 

func (_class AsyncPIFClass) SetPrimaryAddressType(sessionID SessionRef, self PIFRef, primaryAddressType PrimaryAddressType) (_retval TaskRef, _err error)

Change the primary address type used by this PIF

func (AsyncPIFClass) SetProperty 

func (_class AsyncPIFClass) SetProperty(sessionID SessionRef, self PIFRef, name string, value string) (_retval TaskRef, _err error)

Set the value of a property of the PIF

func (AsyncPIFClass) Unplug 

func (_class AsyncPIFClass) Unplug(sessionID SessionRef, self PIFRef) (_retval TaskRef, _err error)

Attempt to bring down a physical interface

type AsyncPIFMetricsClass 

type AsyncPIFMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a physical network interface

func (AsyncPIFMetricsClass) AddToOtherConfig 

func (_class AsyncPIFMetricsClass) AddToOtherConfig(sessionID SessionRef, self PIFMetricsRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetAll 

func (_class AsyncPIFMetricsClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the PIF_metrics instances known to the system.

func (AsyncPIFMetricsClass) GetAllRecords 

func (_class AsyncPIFMetricsClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of PIF_metrics references to PIF_metrics records for all PIF_metrics instances known to the system.

func (AsyncPIFMetricsClass) GetByUUID 

func (_class AsyncPIFMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the PIF_metrics instance with the specified UUID.

func (AsyncPIFMetricsClass) GetCarrier 

func (_class AsyncPIFMetricsClass) GetCarrier(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the carrier field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetDeviceID 

func (_class AsyncPIFMetricsClass) GetDeviceID(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the device_id field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetDeviceName 

func (_class AsyncPIFMetricsClass) GetDeviceName(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the device_name field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetDuplex 

func (_class AsyncPIFMetricsClass) GetDuplex(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the duplex field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetIoReadKbs 

func (_class AsyncPIFMetricsClass) GetIoReadKbs(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the io/read_kbs field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetIoWriteKbs 

func (_class AsyncPIFMetricsClass) GetIoWriteKbs(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the io/write_kbs field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetLastUpdated 

func (_class AsyncPIFMetricsClass) GetLastUpdated(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the last_updated field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetOtherConfig 

func (_class AsyncPIFMetricsClass) GetOtherConfig(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the other_config field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetPciBusPath 

func (_class AsyncPIFMetricsClass) GetPciBusPath(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the pci_bus_path field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetRecord 

func (_class AsyncPIFMetricsClass) GetRecord(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetSpeed 

func (_class AsyncPIFMetricsClass) GetSpeed(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the speed field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetUUID 

func (_class AsyncPIFMetricsClass) GetUUID(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the uuid field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetVendorID 

func (_class AsyncPIFMetricsClass) GetVendorID(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the vendor_id field of the given PIF_metrics.

func (AsyncPIFMetricsClass) GetVendorName 

func (_class AsyncPIFMetricsClass) GetVendorName(sessionID SessionRef, self PIFMetricsRef) (_retval TaskRef, _err error)

Get the vendor_name field of the given PIF_metrics.

func (AsyncPIFMetricsClass) RemoveFromOtherConfig 

func (_class AsyncPIFMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self PIFMetricsRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given PIF_metrics. If the key is not in that Map, then do nothing.

func (AsyncPIFMetricsClass) SetOtherConfig 

func (_class AsyncPIFMetricsClass) SetOtherConfig(sessionID SessionRef, self PIFMetricsRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given PIF_metrics.

type AsyncPoolClass 

type AsyncPoolClass struct {
	// contains filtered or unexported fields
}

Pool-wide information

func (AsyncPoolClass) AddTags 

func (_class AsyncPoolClass) AddTags(sessionID SessionRef, self PoolRef, value string) (_retval TaskRef, _err error)

Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing.

func (AsyncPoolClass) AddToGuiConfig 

func (_class AsyncPoolClass) AddToGuiConfig(sessionID SessionRef, self PoolRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the gui_config field of the given pool.

func (AsyncPoolClass) AddToHealthCheckConfig 

func (_class AsyncPoolClass) AddToHealthCheckConfig(sessionID SessionRef, self PoolRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the health_check_config field of the given pool.

func (AsyncPoolClass) AddToOtherConfig 

func (_class AsyncPoolClass) AddToOtherConfig(sessionID SessionRef, self PoolRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given pool.

func (AsyncPoolClass) ApplyEdition 

func (_class AsyncPoolClass) ApplyEdition(sessionID SessionRef, self PoolRef, edition string) (_retval TaskRef, _err error)

Apply an edition to all hosts in the pool

func (AsyncPoolClass) CertificateInstall 

func (_class AsyncPoolClass) CertificateInstall(sessionID SessionRef, name string, cert string) (_retval TaskRef, _err error)

Install an SSL certificate pool-wide.

func (AsyncPoolClass) CertificateList 

func (_class AsyncPoolClass) CertificateList(sessionID SessionRef) (_retval TaskRef, _err error)

List all installed SSL certificates.

func (AsyncPoolClass) CertificateSync 

func (_class AsyncPoolClass) CertificateSync(sessionID SessionRef) (_retval TaskRef, _err error)

Sync SSL certificates from master to slaves.

func (AsyncPoolClass) CertificateUninstall 

func (_class AsyncPoolClass) CertificateUninstall(sessionID SessionRef, name string) (_retval TaskRef, _err error)

Remove an SSL certificate.

func (AsyncPoolClass) CreateNewBlob 

func (_class AsyncPoolClass) CreateNewBlob(sessionID SessionRef, pool PoolRef, name string, mimeType string, public bool) (_retval TaskRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this pool

func (AsyncPoolClass) CreateVLAN 

func (_class AsyncPoolClass) CreateVLAN(sessionID SessionRef, device string, network NetworkRef, vlan int) (_retval TaskRef, _err error)

Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead.

Errors: 

VLAN_TAG_INVALID - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.  The parameter echoes the VLAN tag you gave.

func (AsyncPoolClass) CreateVLANFromPIF 

func (_class AsyncPoolClass) CreateVLANFromPIF(sessionID SessionRef, pif PIFRef, network NetworkRef, vlan int) (_retval TaskRef, _err error)

Create a pool-wide VLAN by taking the PIF.

Errors: 

VLAN_TAG_INVALID - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.  The parameter echoes the VLAN tag you gave.

func (AsyncPoolClass) CrlInstall 

func (_class AsyncPoolClass) CrlInstall(sessionID SessionRef, name string, cert string) (_retval TaskRef, _err error)

Install an SSL certificate revocation list, pool-wide.

func (AsyncPoolClass) CrlList 

func (_class AsyncPoolClass) CrlList(sessionID SessionRef) (_retval TaskRef, _err error)

List all installed SSL certificate revocation lists.

func (AsyncPoolClass) CrlUninstall 

func (_class AsyncPoolClass) CrlUninstall(sessionID SessionRef, name string) (_retval TaskRef, _err error)

Remove an SSL certificate revocation list.

func (AsyncPoolClass) DeconfigureWlb 

func (_class AsyncPoolClass) DeconfigureWlb(sessionID SessionRef) (_retval TaskRef, _err error)

Permanently deconfigures workload balancing monitoring on this pool

func (AsyncPoolClass) DesignateNewMaster 

func (_class AsyncPoolClass) DesignateNewMaster(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Perform an orderly handover of the role of master to the referenced host.

func (AsyncPoolClass) DetectNonhomogeneousExternalAuth 

func (_class AsyncPoolClass) DetectNonhomogeneousExternalAuth(sessionID SessionRef, pool PoolRef) (_retval TaskRef, _err error)

This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts

func (AsyncPoolClass) DisableExternalAuth 

func (_class AsyncPoolClass) DisableExternalAuth(sessionID SessionRef, pool PoolRef, config map[string]string) (_retval TaskRef, _err error)

This call disables external authentication on all the hosts of the pool

func (AsyncPoolClass) DisableHa 

func (_class AsyncPoolClass) DisableHa(sessionID SessionRef) (_retval TaskRef, _err error)

Turn off High Availability mode

func (AsyncPoolClass) DisableLocalStorageCaching 

func (_class AsyncPoolClass) DisableLocalStorageCaching(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

This call disables pool-wide local storage caching

func (AsyncPoolClass) DisableRedoLog 

func (_class AsyncPoolClass) DisableRedoLog(sessionID SessionRef) (_retval TaskRef, _err error)

Disable the redo log if in use, unless HA is enabled.

func (AsyncPoolClass) DisableSslLegacy 

func (_class AsyncPoolClass) DisableSslLegacy(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Sets ssl_legacy true on each host: see Host.ssl_legacy

func (AsyncPoolClass) Eject 

func (_class AsyncPoolClass) Eject(sessionID SessionRef, host HostRef) (_retval TaskRef, _err error)

Instruct a pool master to eject a host from the pool

func (AsyncPoolClass) EmergencyResetMaster 

func (_class AsyncPoolClass) EmergencyResetMaster(sessionID SessionRef, masterAddress string) (_retval TaskRef, _err error)

Instruct a slave already in a pool that the master has changed

func (AsyncPoolClass) EmergencyTransitionToMaster 

func (_class AsyncPoolClass) EmergencyTransitionToMaster(sessionID SessionRef) (_retval TaskRef, _err error)

Instruct host that's currently a slave to transition to being master

func (AsyncPoolClass) EnableExternalAuth 

func (_class AsyncPoolClass) EnableExternalAuth(sessionID SessionRef, pool PoolRef, config map[string]string, serviceName string, authType string) (_retval TaskRef, _err error)

This call enables external authentication on all the hosts of the pool

func (AsyncPoolClass) EnableHa 

func (_class AsyncPoolClass) EnableHa(sessionID SessionRef, heartbeatSrs []SRRef, configuration map[string]string) (_retval TaskRef, _err error)

Turn on High Availability mode

func (AsyncPoolClass) EnableLocalStorageCaching 

func (_class AsyncPoolClass) EnableLocalStorageCaching(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

This call attempts to enable pool-wide local storage caching

func (AsyncPoolClass) EnableRedoLog 

func (_class AsyncPoolClass) EnableRedoLog(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Enable the redo log on the given SR and start using it, unless HA is enabled.

func (AsyncPoolClass) EnableSslLegacy 

func (_class AsyncPoolClass) EnableSslLegacy(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Sets ssl_legacy true on each host: see Host.ssl_legacy

func (AsyncPoolClass) GetAll 

func (_class AsyncPoolClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the pools known to the system.

func (AsyncPoolClass) GetAllRecords 

func (_class AsyncPoolClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of pool references to pool records for all pools known to the system.

func (AsyncPoolClass) GetAllowedOperations 

func (_class AsyncPoolClass) GetAllowedOperations(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given pool.

func (AsyncPoolClass) GetBlobs 

func (_class AsyncPoolClass) GetBlobs(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the blobs field of the given pool.

func (AsyncPoolClass) GetByUUID 

func (_class AsyncPoolClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the pool instance with the specified UUID.

func (AsyncPoolClass) GetCrashDumpSR 

func (_class AsyncPoolClass) GetCrashDumpSR(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the crash_dump_SR field of the given pool.

func (AsyncPoolClass) GetCurrentOperations 

func (_class AsyncPoolClass) GetCurrentOperations(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the current_operations field of the given pool.

func (AsyncPoolClass) GetDefaultSR 

func (_class AsyncPoolClass) GetDefaultSR(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the default_SR field of the given pool.

func (AsyncPoolClass) GetGuiConfig 

func (_class AsyncPoolClass) GetGuiConfig(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the gui_config field of the given pool.

func (AsyncPoolClass) GetHaAllowOvercommit 

func (_class AsyncPoolClass) GetHaAllowOvercommit(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_allow_overcommit field of the given pool.

func (AsyncPoolClass) GetHaClusterStack 

func (_class AsyncPoolClass) GetHaClusterStack(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_cluster_stack field of the given pool.

func (AsyncPoolClass) GetHaConfiguration 

func (_class AsyncPoolClass) GetHaConfiguration(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_configuration field of the given pool.

func (AsyncPoolClass) GetHaEnabled 

func (_class AsyncPoolClass) GetHaEnabled(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_enabled field of the given pool.

func (AsyncPoolClass) GetHaHostFailuresToTolerate 

func (_class AsyncPoolClass) GetHaHostFailuresToTolerate(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_host_failures_to_tolerate field of the given pool.

func (AsyncPoolClass) GetHaOvercommitted 

func (_class AsyncPoolClass) GetHaOvercommitted(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_overcommitted field of the given pool.

func (AsyncPoolClass) GetHaPlanExistsFor 

func (_class AsyncPoolClass) GetHaPlanExistsFor(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_plan_exists_for field of the given pool.

func (AsyncPoolClass) GetHaStatefiles 

func (_class AsyncPoolClass) GetHaStatefiles(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the ha_statefiles field of the given pool.

func (AsyncPoolClass) GetHealthCheckConfig 

func (_class AsyncPoolClass) GetHealthCheckConfig(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the health_check_config field of the given pool.

func (AsyncPoolClass) GetLicenseState 

func (_class AsyncPoolClass) GetLicenseState(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

This call returns the license state for the pool

func (AsyncPoolClass) GetMaster 

func (_class AsyncPoolClass) GetMaster(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the master field of the given pool.

func (AsyncPoolClass) GetMetadataVDIs 

func (_class AsyncPoolClass) GetMetadataVDIs(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the metadata_VDIs field of the given pool.

func (AsyncPoolClass) GetNameDescription 

func (_class AsyncPoolClass) GetNameDescription(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the name_description field of the given pool.

func (AsyncPoolClass) GetNameLabel 

func (_class AsyncPoolClass) GetNameLabel(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the name_label field of the given pool.

func (AsyncPoolClass) GetOtherConfig 

func (_class AsyncPoolClass) GetOtherConfig(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the other_config field of the given pool.

func (AsyncPoolClass) GetRecord 

func (_class AsyncPoolClass) GetRecord(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given pool.

func (AsyncPoolClass) GetRedoLogEnabled 

func (_class AsyncPoolClass) GetRedoLogEnabled(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the redo_log_enabled field of the given pool.

func (AsyncPoolClass) GetRedoLogVdi 

func (_class AsyncPoolClass) GetRedoLogVdi(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the redo_log_vdi field of the given pool.

func (AsyncPoolClass) GetRestrictions 

func (_class AsyncPoolClass) GetRestrictions(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the restrictions field of the given pool.

func (AsyncPoolClass) GetSuspendImageSR 

func (_class AsyncPoolClass) GetSuspendImageSR(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the suspend_image_SR field of the given pool.

func (AsyncPoolClass) GetTags 

func (_class AsyncPoolClass) GetTags(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the tags field of the given pool.

func (AsyncPoolClass) GetUUID 

func (_class AsyncPoolClass) GetUUID(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the uuid field of the given pool.

func (AsyncPoolClass) GetVswitchController 

func (_class AsyncPoolClass) GetVswitchController(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the vswitch_controller field of the given pool.

func (AsyncPoolClass) GetWlbEnabled 

func (_class AsyncPoolClass) GetWlbEnabled(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the wlb_enabled field of the given pool.

func (AsyncPoolClass) GetWlbURL 

func (_class AsyncPoolClass) GetWlbURL(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the wlb_url field of the given pool.

func (AsyncPoolClass) GetWlbUsername 

func (_class AsyncPoolClass) GetWlbUsername(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the wlb_username field of the given pool.

func (AsyncPoolClass) GetWlbVerifyCert 

func (_class AsyncPoolClass) GetWlbVerifyCert(sessionID SessionRef, self PoolRef) (_retval TaskRef, _err error)

Get the wlb_verify_cert field of the given pool.

func (AsyncPoolClass) HaComputeHypotheticalMaxHostFailuresToTolerate 

func (_class AsyncPoolClass) HaComputeHypotheticalMaxHostFailuresToTolerate(sessionID SessionRef, configuration map[VMRef]string) (_retval TaskRef, _err error)

Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs

func (AsyncPoolClass) HaComputeMaxHostFailuresToTolerate 

func (_class AsyncPoolClass) HaComputeMaxHostFailuresToTolerate(sessionID SessionRef) (_retval TaskRef, _err error)

Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs

func (AsyncPoolClass) HaComputeVMFailoverPlan 

func (_class AsyncPoolClass) HaComputeVMFailoverPlan(sessionID SessionRef, failedHosts []HostRef, failedVms []VMRef) (_retval TaskRef, _err error)

Return a VM failover plan assuming a given subset of hosts fail

func (AsyncPoolClass) HaFailoverPlanExists 

func (_class AsyncPoolClass) HaFailoverPlanExists(sessionID SessionRef, n int) (_retval TaskRef, _err error)

Returns true if a VM failover plan exists for up to 'n' host failures

func (AsyncPoolClass) HaPreventRestartsFor 

func (_class AsyncPoolClass) HaPreventRestartsFor(sessionID SessionRef, seconds int) (_retval TaskRef, _err error)

When this call returns the VM restart logic will not run for the requested number of seconds. If the argument is zero then the restart thread is immediately unblocked

func (AsyncPoolClass) InitializeWlb 

func (_class AsyncPoolClass) InitializeWlb(sessionID SessionRef, wlbURL string, wlbUsername string, wlbPassword string, xenserverUsername string, xenserverPassword string) (_retval TaskRef, _err error)

Initializes workload balancing monitoring on this pool with the specified wlb server

func (AsyncPoolClass) Join 

func (_class AsyncPoolClass) Join(sessionID SessionRef, masterAddress string, masterUsername string, masterPassword string) (_retval TaskRef, _err error)

Instruct host to join a new pool

Errors: 

JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS - The host joining the pool cannot contain any shared storage.

func (AsyncPoolClass) JoinForce 

func (_class AsyncPoolClass) JoinForce(sessionID SessionRef, masterAddress string, masterUsername string, masterPassword string) (_retval TaskRef, _err error)

Instruct host to join a new pool

func (AsyncPoolClass) RecoverSlaves 

func (_class AsyncPoolClass) RecoverSlaves(sessionID SessionRef) (_retval TaskRef, _err error)

Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.

func (AsyncPoolClass) RemoveFromGuiConfig 

func (_class AsyncPoolClass) RemoveFromGuiConfig(sessionID SessionRef, self PoolRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the gui_config field of the given pool. If the key is not in that Map, then do nothing.

func (AsyncPoolClass) RemoveFromHealthCheckConfig 

func (_class AsyncPoolClass) RemoveFromHealthCheckConfig(sessionID SessionRef, self PoolRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the health_check_config field of the given pool. If the key is not in that Map, then do nothing.

func (AsyncPoolClass) RemoveFromOtherConfig 

func (_class AsyncPoolClass) RemoveFromOtherConfig(sessionID SessionRef, self PoolRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncPoolClass) RemoveTags 

func (_class AsyncPoolClass) RemoveTags(sessionID SessionRef, self PoolRef, value string) (_retval TaskRef, _err error)

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.

func (AsyncPoolClass) RetrieveWlbConfiguration 

func (_class AsyncPoolClass) RetrieveWlbConfiguration(sessionID SessionRef) (_retval TaskRef, _err error)

Retrieves the pool optimization criteria from the workload balancing server

func (AsyncPoolClass) RetrieveWlbRecommendations 

func (_class AsyncPoolClass) RetrieveWlbRecommendations(sessionID SessionRef) (_retval TaskRef, _err error)

Retrieves vm migrate recommendations for the pool from the workload balancing server

func (AsyncPoolClass) SendTestPost 

func (_class AsyncPoolClass) SendTestPost(sessionID SessionRef, host string, port int, body string) (_retval TaskRef, _err error)

Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.

func (AsyncPoolClass) SendWlbConfiguration 

func (_class AsyncPoolClass) SendWlbConfiguration(sessionID SessionRef, config map[string]string) (_retval TaskRef, _err error)

Sets the pool optimization criteria for the workload balancing server

func (AsyncPoolClass) SetCrashDumpSR 

func (_class AsyncPoolClass) SetCrashDumpSR(sessionID SessionRef, self PoolRef, value SRRef) (_retval TaskRef, _err error)

Set the crash_dump_SR field of the given pool.

func (AsyncPoolClass) SetDefaultSR 

func (_class AsyncPoolClass) SetDefaultSR(sessionID SessionRef, self PoolRef, value SRRef) (_retval TaskRef, _err error)

Set the default_SR field of the given pool.

func (AsyncPoolClass) SetGuiConfig 

func (_class AsyncPoolClass) SetGuiConfig(sessionID SessionRef, self PoolRef, value map[string]string) (_retval TaskRef, _err error)

Set the gui_config field of the given pool.

func (AsyncPoolClass) SetHaAllowOvercommit 

func (_class AsyncPoolClass) SetHaAllowOvercommit(sessionID SessionRef, self PoolRef, value bool) (_retval TaskRef, _err error)

Set the ha_allow_overcommit field of the given pool.

func (AsyncPoolClass) SetHaHostFailuresToTolerate 

func (_class AsyncPoolClass) SetHaHostFailuresToTolerate(sessionID SessionRef, self PoolRef, value int) (_retval TaskRef, _err error)

Set the maximum number of host failures to consider in the HA VM restart planner

func (AsyncPoolClass) SetHealthCheckConfig 

func (_class AsyncPoolClass) SetHealthCheckConfig(sessionID SessionRef, self PoolRef, value map[string]string) (_retval TaskRef, _err error)

Set the health_check_config field of the given pool.

func (AsyncPoolClass) SetNameDescription 

func (_class AsyncPoolClass) SetNameDescription(sessionID SessionRef, self PoolRef, value string) (_retval TaskRef, _err error)

Set the name_description field of the given pool.

func (AsyncPoolClass) SetNameLabel 

func (_class AsyncPoolClass) SetNameLabel(sessionID SessionRef, self PoolRef, value string) (_retval TaskRef, _err error)

Set the name_label field of the given pool.

func (AsyncPoolClass) SetOtherConfig 

func (_class AsyncPoolClass) SetOtherConfig(sessionID SessionRef, self PoolRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given pool.

func (AsyncPoolClass) SetSuspendImageSR 

func (_class AsyncPoolClass) SetSuspendImageSR(sessionID SessionRef, self PoolRef, value SRRef) (_retval TaskRef, _err error)

Set the suspend_image_SR field of the given pool.

func (AsyncPoolClass) SetTags 

func (_class AsyncPoolClass) SetTags(sessionID SessionRef, self PoolRef, value []string) (_retval TaskRef, _err error)

Set the tags field of the given pool.

func (AsyncPoolClass) SetVswitchController 

func (_class AsyncPoolClass) SetVswitchController(sessionID SessionRef, address string) (_retval TaskRef, _err error)

Set the IP address of the vswitch controller.

func (AsyncPoolClass) SetWlbEnabled 

func (_class AsyncPoolClass) SetWlbEnabled(sessionID SessionRef, self PoolRef, value bool) (_retval TaskRef, _err error)

Set the wlb_enabled field of the given pool.

func (AsyncPoolClass) SetWlbVerifyCert 

func (_class AsyncPoolClass) SetWlbVerifyCert(sessionID SessionRef, self PoolRef, value bool) (_retval TaskRef, _err error)

Set the wlb_verify_cert field of the given pool.

func (AsyncPoolClass) SyncDatabase 

func (_class AsyncPoolClass) SyncDatabase(sessionID SessionRef) (_retval TaskRef, _err error)

Forcibly synchronise the database now

func (AsyncPoolClass) TestArchiveTarget 

func (_class AsyncPoolClass) TestArchiveTarget(sessionID SessionRef, self PoolRef, config map[string]string) (_retval TaskRef, _err error)

This call tests if a location is valid

type AsyncPoolPatchClass 

type AsyncPoolPatchClass struct {
	// contains filtered or unexported fields
}

Pool-wide patches

func (AsyncPoolPatchClass) AddToOtherConfig 

func (_class AsyncPoolPatchClass) AddToOtherConfig(sessionID SessionRef, self PoolPatchRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given pool_patch.

func (AsyncPoolPatchClass) Apply 

func (_class AsyncPoolPatchClass) Apply(sessionID SessionRef, self PoolPatchRef, host HostRef) (_retval TaskRef, _err error)

Apply the selected patch to a host and return its output

func (AsyncPoolPatchClass) Clean 

func (_class AsyncPoolPatchClass) Clean(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Removes the patch's files from the server

func (AsyncPoolPatchClass) CleanOnHost 

func (_class AsyncPoolPatchClass) CleanOnHost(sessionID SessionRef, self PoolPatchRef, host HostRef) (_retval TaskRef, _err error)

Removes the patch's files from the specified host

func (AsyncPoolPatchClass) Destroy 

func (_class AsyncPoolPatchClass) Destroy(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches.

func (AsyncPoolPatchClass) GetAfterApplyGuidance 

func (_class AsyncPoolPatchClass) GetAfterApplyGuidance(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the after_apply_guidance field of the given pool_patch.

func (AsyncPoolPatchClass) GetAll 

func (_class AsyncPoolPatchClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the pool_patchs known to the system.

func (AsyncPoolPatchClass) GetAllRecords 

func (_class AsyncPoolPatchClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.

func (AsyncPoolPatchClass) GetByNameLabel 

func (_class AsyncPoolPatchClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the pool_patch instances with the given label.

func (AsyncPoolPatchClass) GetByUUID 

func (_class AsyncPoolPatchClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the pool_patch instance with the specified UUID.

func (AsyncPoolPatchClass) GetHostPatches 

func (_class AsyncPoolPatchClass) GetHostPatches(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the host_patches field of the given pool_patch.

func (AsyncPoolPatchClass) GetNameDescription 

func (_class AsyncPoolPatchClass) GetNameDescription(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the name/description field of the given pool_patch.

func (AsyncPoolPatchClass) GetNameLabel 

func (_class AsyncPoolPatchClass) GetNameLabel(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the name/label field of the given pool_patch.

func (AsyncPoolPatchClass) GetOtherConfig 

func (_class AsyncPoolPatchClass) GetOtherConfig(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the other_config field of the given pool_patch.

func (AsyncPoolPatchClass) GetPoolApplied 

func (_class AsyncPoolPatchClass) GetPoolApplied(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the pool_applied field of the given pool_patch.

func (AsyncPoolPatchClass) GetRecord 

func (_class AsyncPoolPatchClass) GetRecord(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given pool_patch.

func (AsyncPoolPatchClass) GetSize 

func (_class AsyncPoolPatchClass) GetSize(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the size field of the given pool_patch.

func (AsyncPoolPatchClass) GetUUID 

func (_class AsyncPoolPatchClass) GetUUID(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the uuid field of the given pool_patch.

func (AsyncPoolPatchClass) GetVersion 

func (_class AsyncPoolPatchClass) GetVersion(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Get the version field of the given pool_patch.

func (AsyncPoolPatchClass) PoolApply 

func (_class AsyncPoolPatchClass) PoolApply(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output

func (AsyncPoolPatchClass) PoolClean 

func (_class AsyncPoolPatchClass) PoolClean(sessionID SessionRef, self PoolPatchRef) (_retval TaskRef, _err error)

Removes the patch's files from all hosts in the pool, but does not remove the database entries

func (AsyncPoolPatchClass) Precheck 

func (_class AsyncPoolPatchClass) Precheck(sessionID SessionRef, self PoolPatchRef, host HostRef) (_retval TaskRef, _err error)

Execute the precheck stage of the selected patch on a host and return its output

func (AsyncPoolPatchClass) RemoveFromOtherConfig 

func (_class AsyncPoolPatchClass) RemoveFromOtherConfig(sessionID SessionRef, self PoolPatchRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncPoolPatchClass) SetOtherConfig 

func (_class AsyncPoolPatchClass) SetOtherConfig(sessionID SessionRef, self PoolPatchRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given pool_patch.

type AsyncRoleClass 

type AsyncRoleClass struct {
	// contains filtered or unexported fields
}

A set of permissions associated with a subject

func (AsyncRoleClass) GetAll 

func (_class AsyncRoleClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the roles known to the system.

func (AsyncRoleClass) GetAllRecords 

func (_class AsyncRoleClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of role references to role records for all roles known to the system.

func (AsyncRoleClass) GetByNameLabel 

func (_class AsyncRoleClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the role instances with the given label.

func (AsyncRoleClass) GetByPermission 

func (_class AsyncRoleClass) GetByPermission(sessionID SessionRef, permission RoleRef) (_retval TaskRef, _err error)

This call returns a list of roles given a permission

func (AsyncRoleClass) GetByPermissionNameLabel 

func (_class AsyncRoleClass) GetByPermissionNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

This call returns a list of roles given a permission name

func (AsyncRoleClass) GetByUUID 

func (_class AsyncRoleClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the role instance with the specified UUID.

func (AsyncRoleClass) GetNameDescription 

func (_class AsyncRoleClass) GetNameDescription(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

Get the name/description field of the given role.

func (AsyncRoleClass) GetNameLabel 

func (_class AsyncRoleClass) GetNameLabel(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

Get the name/label field of the given role.

func (AsyncRoleClass) GetPermissions 

func (_class AsyncRoleClass) GetPermissions(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

This call returns a list of permissions given a role

func (AsyncRoleClass) GetPermissionsNameLabel 

func (_class AsyncRoleClass) GetPermissionsNameLabel(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

This call returns a list of permission names given a role

func (AsyncRoleClass) GetRecord 

func (_class AsyncRoleClass) GetRecord(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given role.

func (AsyncRoleClass) GetSubroles 

func (_class AsyncRoleClass) GetSubroles(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

Get the subroles field of the given role.

func (AsyncRoleClass) GetUUID 

func (_class AsyncRoleClass) GetUUID(sessionID SessionRef, self RoleRef) (_retval TaskRef, _err error)

Get the uuid field of the given role.

type AsyncSMClass 

type AsyncSMClass struct {
	// contains filtered or unexported fields
}

A storage manager plugin

func (AsyncSMClass) AddToOtherConfig 

func (_class AsyncSMClass) AddToOtherConfig(sessionID SessionRef, self SMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given SM.

func (AsyncSMClass) GetAll 

func (_class AsyncSMClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the SMs known to the system.

func (AsyncSMClass) GetAllRecords 

func (_class AsyncSMClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of SM references to SM records for all SMs known to the system.

func (AsyncSMClass) GetByNameLabel 

func (_class AsyncSMClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the SM instances with the given label.

func (AsyncSMClass) GetByUUID 

func (_class AsyncSMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the SM instance with the specified UUID.

func (AsyncSMClass) GetCapabilities 

func (_class AsyncSMClass) GetCapabilities(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the capabilities field of the given SM.

func (AsyncSMClass) GetConfiguration 

func (_class AsyncSMClass) GetConfiguration(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the configuration field of the given SM.

func (AsyncSMClass) GetCopyright 

func (_class AsyncSMClass) GetCopyright(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the copyright field of the given SM.

func (AsyncSMClass) GetDriverFilename 

func (_class AsyncSMClass) GetDriverFilename(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the driver_filename field of the given SM.

func (AsyncSMClass) GetFeatures 

func (_class AsyncSMClass) GetFeatures(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the features field of the given SM.

func (AsyncSMClass) GetNameDescription 

func (_class AsyncSMClass) GetNameDescription(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the name/description field of the given SM.

func (AsyncSMClass) GetNameLabel 

func (_class AsyncSMClass) GetNameLabel(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the name/label field of the given SM.

func (AsyncSMClass) GetOtherConfig 

func (_class AsyncSMClass) GetOtherConfig(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the other_config field of the given SM.

func (AsyncSMClass) GetRecord 

func (_class AsyncSMClass) GetRecord(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given SM.

func (AsyncSMClass) GetRequiredAPIVersion 

func (_class AsyncSMClass) GetRequiredAPIVersion(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the required_api_version field of the given SM.

func (AsyncSMClass) GetRequiredClusterStack 

func (_class AsyncSMClass) GetRequiredClusterStack(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the required_cluster_stack field of the given SM.

func (AsyncSMClass) GetType 

func (_class AsyncSMClass) GetType(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the type field of the given SM.

func (AsyncSMClass) GetUUID 

func (_class AsyncSMClass) GetUUID(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the uuid field of the given SM.

func (AsyncSMClass) GetVendor 

func (_class AsyncSMClass) GetVendor(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the vendor field of the given SM.

func (AsyncSMClass) GetVersion 

func (_class AsyncSMClass) GetVersion(sessionID SessionRef, self SMRef) (_retval TaskRef, _err error)

Get the version field of the given SM.

func (AsyncSMClass) RemoveFromOtherConfig 

func (_class AsyncSMClass) RemoveFromOtherConfig(sessionID SessionRef, self SMRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncSMClass) SetOtherConfig 

func (_class AsyncSMClass) SetOtherConfig(sessionID SessionRef, self SMRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given SM.

type AsyncSRClass 

type AsyncSRClass struct {
	// contains filtered or unexported fields
}

A storage repository

func (AsyncSRClass) AddTags 

func (_class AsyncSRClass) AddTags(sessionID SessionRef, self SRRef, value string) (_retval TaskRef, _err error)

Add the given value to the tags field of the given SR. If the value is already in that Set, then do nothing.

func (AsyncSRClass) AddToOtherConfig 

func (_class AsyncSRClass) AddToOtherConfig(sessionID SessionRef, self SRRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given SR.

func (AsyncSRClass) AddToSmConfig 

func (_class AsyncSRClass) AddToSmConfig(sessionID SessionRef, self SRRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the sm_config field of the given SR.

func (AsyncSRClass) AssertCanHostHaStatefile 

func (_class AsyncSRClass) AssertCanHostHaStatefile(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not

func (AsyncSRClass) AssertSupportsDatabaseReplication 

func (_class AsyncSRClass) AssertSupportsDatabaseReplication(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not.

func (AsyncSRClass) Create 

func (_class AsyncSRClass) Create(sessionID SessionRef, host HostRef, deviceConfig map[string]string, physicalSize int, nameLabel string, nameDescription string, atype string, contentType string, shared bool, smConfig map[string]string) (_retval TaskRef, _err error)

Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters)

Errors: 

SR_UNKNOWN_DRIVER - The SR could not be connected because the driver was not recognised.

func (AsyncSRClass) CreateNewBlob 

func (_class AsyncSRClass) CreateNewBlob(sessionID SessionRef, sr SRRef, name string, mimeType string, public bool) (_retval TaskRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this SR

func (AsyncSRClass) Destroy 

func (_class AsyncSRClass) Destroy(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Destroy specified SR, removing SR-record from database and remove SR from disk. (In order to affect this operation the appropriate device_config is read from the specified SR's PBD on current host)

Errors: 

SR_HAS_PBD - The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.

func (AsyncSRClass) DisableDatabaseReplication 

func (_class AsyncSRClass) DisableDatabaseReplication(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

func (AsyncSRClass) EnableDatabaseReplication 

func (_class AsyncSRClass) EnableDatabaseReplication(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

func (AsyncSRClass) Forget 

func (_class AsyncSRClass) Forget(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Removing specified SR-record from database, without attempting to remove SR from disk

Errors: 

SR_HAS_PBD - The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.

func (AsyncSRClass) GetAll 

func (_class AsyncSRClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the SRs known to the system.

func (AsyncSRClass) GetAllRecords 

func (_class AsyncSRClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of SR references to SR records for all SRs known to the system.

func (AsyncSRClass) GetAllowedOperations 

func (_class AsyncSRClass) GetAllowedOperations(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given SR.

func (AsyncSRClass) GetBlobs 

func (_class AsyncSRClass) GetBlobs(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the blobs field of the given SR.

func (AsyncSRClass) GetByNameLabel 

func (_class AsyncSRClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the SR instances with the given label.

func (AsyncSRClass) GetByUUID 

func (_class AsyncSRClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the SR instance with the specified UUID.

func (AsyncSRClass) GetContentType 

func (_class AsyncSRClass) GetContentType(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the content_type field of the given SR.

func (AsyncSRClass) GetCurrentOperations 

func (_class AsyncSRClass) GetCurrentOperations(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the current_operations field of the given SR.

func (AsyncSRClass) GetIntroducedBy 

func (_class AsyncSRClass) GetIntroducedBy(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the introduced_by field of the given SR.

func (AsyncSRClass) GetLocalCacheEnabled 

func (_class AsyncSRClass) GetLocalCacheEnabled(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the local_cache_enabled field of the given SR.

func (AsyncSRClass) GetNameDescription 

func (_class AsyncSRClass) GetNameDescription(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the name/description field of the given SR.

func (AsyncSRClass) GetNameLabel 

func (_class AsyncSRClass) GetNameLabel(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the name/label field of the given SR.

func (AsyncSRClass) GetOtherConfig 

func (_class AsyncSRClass) GetOtherConfig(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the other_config field of the given SR.

func (AsyncSRClass) GetPBDs 

func (_class AsyncSRClass) GetPBDs(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the PBDs field of the given SR.

func (AsyncSRClass) GetPhysicalSize 

func (_class AsyncSRClass) GetPhysicalSize(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the physical_size field of the given SR.

func (AsyncSRClass) GetPhysicalUtilisation 

func (_class AsyncSRClass) GetPhysicalUtilisation(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the physical_utilisation field of the given SR.

func (AsyncSRClass) GetRecord 

func (_class AsyncSRClass) GetRecord(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given SR.

func (AsyncSRClass) GetShared 

func (_class AsyncSRClass) GetShared(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the shared field of the given SR.

func (AsyncSRClass) GetSmConfig 

func (_class AsyncSRClass) GetSmConfig(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the sm_config field of the given SR.

func (AsyncSRClass) GetSupportedTypes 

func (_class AsyncSRClass) GetSupportedTypes(sessionID SessionRef) (_retval TaskRef, _err error)

Return a set of all the SR types supported by the system

func (AsyncSRClass) GetTags 

func (_class AsyncSRClass) GetTags(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the tags field of the given SR.

func (AsyncSRClass) GetType 

func (_class AsyncSRClass) GetType(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the type field of the given SR.

func (AsyncSRClass) GetUUID 

func (_class AsyncSRClass) GetUUID(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the uuid field of the given SR.

func (AsyncSRClass) GetVDIs 

func (_class AsyncSRClass) GetVDIs(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the VDIs field of the given SR.

func (AsyncSRClass) GetVirtualAllocation 

func (_class AsyncSRClass) GetVirtualAllocation(sessionID SessionRef, self SRRef) (_retval TaskRef, _err error)

Get the virtual_allocation field of the given SR.

func (AsyncSRClass) Introduce 

func (_class AsyncSRClass) Introduce(sessionID SessionRef, uuid string, nameLabel string, nameDescription string, atype string, contentType string, shared bool, smConfig map[string]string) (_retval TaskRef, _err error)

Introduce a new Storage Repository into the managed system

func (AsyncSRClass) Make 

func (_class AsyncSRClass) Make(sessionID SessionRef, host HostRef, deviceConfig map[string]string, physicalSize int, nameLabel string, nameDescription string, atype string, contentType string, smConfig map[string]string) (_retval TaskRef, _err error)

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead.

func (AsyncSRClass) Probe 

func (_class AsyncSRClass) Probe(sessionID SessionRef, host HostRef, deviceConfig map[string]string, atype string, smConfig map[string]string) (_retval TaskRef, _err error)

Perform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list 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_config.

func (AsyncSRClass) RemoveFromOtherConfig 

func (_class AsyncSRClass) RemoveFromOtherConfig(sessionID SessionRef, self SRRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given SR. If the key is not in that Map, then do nothing.

func (AsyncSRClass) RemoveFromSmConfig 

func (_class AsyncSRClass) RemoveFromSmConfig(sessionID SessionRef, self SRRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncSRClass) RemoveTags 

func (_class AsyncSRClass) RemoveTags(sessionID SessionRef, self SRRef, value string) (_retval TaskRef, _err error)

Remove the given value from the tags field of the given SR. If the value is not in that Set, then do nothing.

func (AsyncSRClass) Scan 

func (_class AsyncSRClass) Scan(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Refreshes the list of VDIs associated with an SR

func (AsyncSRClass) SetNameDescription 

func (_class AsyncSRClass) SetNameDescription(sessionID SessionRef, sr SRRef, value string) (_retval TaskRef, _err error)

Set the name description of the SR

func (AsyncSRClass) SetNameLabel 

func (_class AsyncSRClass) SetNameLabel(sessionID SessionRef, sr SRRef, value string) (_retval TaskRef, _err error)

Set the name label of the SR

func (AsyncSRClass) SetOtherConfig 

func (_class AsyncSRClass) SetOtherConfig(sessionID SessionRef, self SRRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given SR.

func (AsyncSRClass) SetPhysicalSize 

func (_class AsyncSRClass) SetPhysicalSize(sessionID SessionRef, self SRRef, value int) (_retval TaskRef, _err error)

Sets the SR's physical_size field

func (AsyncSRClass) SetPhysicalUtilisation 

func (_class AsyncSRClass) SetPhysicalUtilisation(sessionID SessionRef, self SRRef, value int) (_retval TaskRef, _err error)

Sets the SR's physical_utilisation field

func (AsyncSRClass) SetShared 

func (_class AsyncSRClass) SetShared(sessionID SessionRef, sr SRRef, value bool) (_retval TaskRef, _err error)

Sets the shared flag on the SR

func (AsyncSRClass) SetSmConfig 

func (_class AsyncSRClass) SetSmConfig(sessionID SessionRef, self SRRef, value map[string]string) (_retval TaskRef, _err error)

Set the sm_config field of the given SR.

func (AsyncSRClass) SetTags 

func (_class AsyncSRClass) SetTags(sessionID SessionRef, self SRRef, value []string) (_retval TaskRef, _err error)

Set the tags field of the given SR.

func (AsyncSRClass) SetVirtualAllocation 

func (_class AsyncSRClass) SetVirtualAllocation(sessionID SessionRef, self SRRef, value int) (_retval TaskRef, _err error)

Sets the SR's virtual_allocation field

func (AsyncSRClass) Update 

func (_class AsyncSRClass) Update(sessionID SessionRef, sr SRRef) (_retval TaskRef, _err error)

Refresh the fields on the SR object

type AsyncSecretClass 

type AsyncSecretClass struct {
	// contains filtered or unexported fields
}

A secret

func (AsyncSecretClass) AddToOtherConfig 

func (_class AsyncSecretClass) AddToOtherConfig(sessionID SessionRef, self SecretRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given secret.

func (AsyncSecretClass) Create 

func (_class AsyncSecretClass) Create(sessionID SessionRef, args SecretRecord) (_retval TaskRef, _err error)

Create a new secret instance, and return its handle. The constructor args are: value*, other_config (* = non-optional).

func (AsyncSecretClass) Destroy 

func (_class AsyncSecretClass) Destroy(sessionID SessionRef, self SecretRef) (_retval TaskRef, _err error)

Destroy the specified secret instance.

func (AsyncSecretClass) GetAll 

func (_class AsyncSecretClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the secrets known to the system.

func (AsyncSecretClass) GetAllRecords 

func (_class AsyncSecretClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of secret references to secret records for all secrets known to the system.

func (AsyncSecretClass) GetByUUID 

func (_class AsyncSecretClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the secret instance with the specified UUID.

func (AsyncSecretClass) GetOtherConfig 

func (_class AsyncSecretClass) GetOtherConfig(sessionID SessionRef, self SecretRef) (_retval TaskRef, _err error)

Get the other_config field of the given secret.

func (AsyncSecretClass) GetRecord 

func (_class AsyncSecretClass) GetRecord(sessionID SessionRef, self SecretRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given secret.

func (AsyncSecretClass) GetUUID 

func (_class AsyncSecretClass) GetUUID(sessionID SessionRef, self SecretRef) (_retval TaskRef, _err error)

Get the uuid field of the given secret.

func (AsyncSecretClass) GetValue 

func (_class AsyncSecretClass) GetValue(sessionID SessionRef, self SecretRef) (_retval TaskRef, _err error)

Get the value field of the given secret.

func (AsyncSecretClass) RemoveFromOtherConfig 

func (_class AsyncSecretClass) RemoveFromOtherConfig(sessionID SessionRef, self SecretRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given secret. If the key is not in that Map, then do nothing.

func (AsyncSecretClass) SetOtherConfig 

func (_class AsyncSecretClass) SetOtherConfig(sessionID SessionRef, self SecretRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given secret.

func (AsyncSecretClass) SetValue 

func (_class AsyncSecretClass) SetValue(sessionID SessionRef, self SecretRef, value string) (_retval TaskRef, _err error)

Set the value field of the given secret.

type AsyncSessionClass 

type AsyncSessionClass struct {
	// contains filtered or unexported fields
}

A session

func (AsyncSessionClass) AddToOtherConfig 

func (_class AsyncSessionClass) AddToOtherConfig(sessionID SessionRef, self SessionRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given session.

func (AsyncSessionClass) ChangePassword 

func (_class AsyncSessionClass) ChangePassword(sessionID SessionRef, oldPwd string, newPwd string) (_retval TaskRef, _err error)

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

func (AsyncSessionClass) CreateFromDbFile 

func (_class AsyncSessionClass) CreateFromDbFile(sessionID SessionRef, filename string) (_retval TaskRef, _err error)

func (AsyncSessionClass) GetAllSubjectIdentifiers 

func (_class AsyncSessionClass) GetAllSubjectIdentifiers(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the user subject-identifiers of all existing sessions

func (AsyncSessionClass) GetAuthUserName 

func (_class AsyncSessionClass) GetAuthUserName(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the auth_user_name field of the given session.

func (AsyncSessionClass) GetAuthUserSid 

func (_class AsyncSessionClass) GetAuthUserSid(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the auth_user_sid field of the given session.

func (AsyncSessionClass) GetByUUID 

func (_class AsyncSessionClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the session instance with the specified UUID.

func (AsyncSessionClass) GetIsLocalSuperuser 

func (_class AsyncSessionClass) GetIsLocalSuperuser(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the is_local_superuser field of the given session.

func (AsyncSessionClass) GetLastActive 

func (_class AsyncSessionClass) GetLastActive(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the last_active field of the given session.

func (AsyncSessionClass) GetOriginator 

func (_class AsyncSessionClass) GetOriginator(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the originator field of the given session.

func (AsyncSessionClass) GetOtherConfig 

func (_class AsyncSessionClass) GetOtherConfig(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the other_config field of the given session.

func (AsyncSessionClass) GetParent 

func (_class AsyncSessionClass) GetParent(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the parent field of the given session.

func (AsyncSessionClass) GetPool 

func (_class AsyncSessionClass) GetPool(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the pool field of the given session.

func (AsyncSessionClass) GetRbacPermissions 

func (_class AsyncSessionClass) GetRbacPermissions(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the rbac_permissions field of the given session.

func (AsyncSessionClass) GetRecord 

func (_class AsyncSessionClass) GetRecord(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given session.

func (AsyncSessionClass) GetSubject 

func (_class AsyncSessionClass) GetSubject(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the subject field of the given session.

func (AsyncSessionClass) GetTasks 

func (_class AsyncSessionClass) GetTasks(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the tasks field of the given session.

func (AsyncSessionClass) GetThisHost 

func (_class AsyncSessionClass) GetThisHost(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the this_host field of the given session.

func (AsyncSessionClass) GetThisUser 

func (_class AsyncSessionClass) GetThisUser(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the this_user field of the given session.

func (AsyncSessionClass) GetUUID 

func (_class AsyncSessionClass) GetUUID(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the uuid field of the given session.

func (AsyncSessionClass) GetValidationTime 

func (_class AsyncSessionClass) GetValidationTime(sessionID SessionRef, self SessionRef) (_retval TaskRef, _err error)

Get the validation_time field of the given session.

func (AsyncSessionClass) LocalLogout 

func (_class AsyncSessionClass) LocalLogout(sessionID SessionRef) (_retval TaskRef, _err error)

Log out of local session.

func (AsyncSessionClass) LoginWithPassword 

func (_class AsyncSessionClass) LoginWithPassword(uname string, pwd string, version string, originator string) (_retval TaskRef, _err error)

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

Errors: 

SESSION_AUTHENTICATION_FAILED - The credentials given by the user are incorrect, so access has been denied, and you have not been issued a session handle.
HOST_IS_SLAVE - You cannot make regular API calls directly on a slave. Please pass API calls via the master host.

func (AsyncSessionClass) Logout 

func (_class AsyncSessionClass) Logout(sessionID SessionRef) (_retval TaskRef, _err error)

Log out of a session

func (AsyncSessionClass) LogoutSubjectIdentifier 

func (_class AsyncSessionClass) LogoutSubjectIdentifier(sessionID SessionRef, subjectIdentifier string) (_retval TaskRef, _err error)

Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function

func (AsyncSessionClass) RemoveFromOtherConfig 

func (_class AsyncSessionClass) RemoveFromOtherConfig(sessionID SessionRef, self SessionRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given session. If the key is not in that Map, then do nothing.

func (AsyncSessionClass) SetOtherConfig 

func (_class AsyncSessionClass) SetOtherConfig(sessionID SessionRef, self SessionRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given session.

func (AsyncSessionClass) SlaveLocalLoginWithPassword 

func (_class AsyncSessionClass) SlaveLocalLoginWithPassword(uname string, pwd string) (_retval TaskRef, _err error)

Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host.

type AsyncSubjectClass 

type AsyncSubjectClass struct {
	// contains filtered or unexported fields
}

A user or group that can log in xapi

func (AsyncSubjectClass) AddToRoles 

func (_class AsyncSubjectClass) AddToRoles(sessionID SessionRef, self SubjectRef, role RoleRef) (_retval TaskRef, _err error)

This call adds a new role to a subject

func (AsyncSubjectClass) Create 

func (_class AsyncSubjectClass) Create(sessionID SessionRef, args SubjectRecord) (_retval TaskRef, _err error)

Create a new subject instance, and return its handle. The constructor args are: subject_identifier, other_config (* = non-optional).

func (AsyncSubjectClass) Destroy 

func (_class AsyncSubjectClass) Destroy(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

Destroy the specified subject instance.

func (AsyncSubjectClass) GetAll 

func (_class AsyncSubjectClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the subjects known to the system.

func (AsyncSubjectClass) GetAllRecords 

func (_class AsyncSubjectClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of subject references to subject records for all subjects known to the system.

func (AsyncSubjectClass) GetByUUID 

func (_class AsyncSubjectClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the subject instance with the specified UUID.

func (AsyncSubjectClass) GetOtherConfig 

func (_class AsyncSubjectClass) GetOtherConfig(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

Get the other_config field of the given subject.

func (AsyncSubjectClass) GetPermissionsNameLabel 

func (_class AsyncSubjectClass) GetPermissionsNameLabel(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

This call returns a list of permission names given a subject

func (AsyncSubjectClass) GetRecord 

func (_class AsyncSubjectClass) GetRecord(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given subject.

func (AsyncSubjectClass) GetRoles 

func (_class AsyncSubjectClass) GetRoles(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

Get the roles field of the given subject.

func (AsyncSubjectClass) GetSubjectIdentifier 

func (_class AsyncSubjectClass) GetSubjectIdentifier(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

Get the subject_identifier field of the given subject.

func (AsyncSubjectClass) GetUUID 

func (_class AsyncSubjectClass) GetUUID(sessionID SessionRef, self SubjectRef) (_retval TaskRef, _err error)

Get the uuid field of the given subject.

func (AsyncSubjectClass) RemoveFromRoles 

func (_class AsyncSubjectClass) RemoveFromRoles(sessionID SessionRef, self SubjectRef, role RoleRef) (_retval TaskRef, _err error)

This call removes a role from a subject

type AsyncTaskClass 

type AsyncTaskClass struct {
	// contains filtered or unexported fields
}

A long-running asynchronous task

func (AsyncTaskClass) AddToOtherConfig 

func (_class AsyncTaskClass) AddToOtherConfig(sessionID SessionRef, self TaskRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given task.

func (AsyncTaskClass) Cancel 

func (_class AsyncTaskClass) Cancel(sessionID SessionRef, task TaskRef) (_retval TaskRef, _err error)

Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time.

Errors: 

OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (AsyncTaskClass) Create 

func (_class AsyncTaskClass) Create(sessionID SessionRef, label string, description string) (_retval TaskRef, _err error)

Create a new task object which must be manually destroyed.

func (AsyncTaskClass) Destroy 

func (_class AsyncTaskClass) Destroy(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Destroy the task object

func (AsyncTaskClass) GetAll 

func (_class AsyncTaskClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the tasks known to the system.

func (AsyncTaskClass) GetAllRecords 

func (_class AsyncTaskClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of task references to task records for all tasks known to the system.

func (AsyncTaskClass) GetAllowedOperations 

func (_class AsyncTaskClass) GetAllowedOperations(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given task.

func (AsyncTaskClass) GetBacktrace 

func (_class AsyncTaskClass) GetBacktrace(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the backtrace field of the given task.

func (AsyncTaskClass) GetByNameLabel 

func (_class AsyncTaskClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the task instances with the given label.

func (AsyncTaskClass) GetByUUID 

func (_class AsyncTaskClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the task instance with the specified UUID.

func (AsyncTaskClass) GetCreated 

func (_class AsyncTaskClass) GetCreated(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the created field of the given task.

func (AsyncTaskClass) GetCurrentOperations 

func (_class AsyncTaskClass) GetCurrentOperations(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the current_operations field of the given task.

func (AsyncTaskClass) GetErrorInfo 

func (_class AsyncTaskClass) GetErrorInfo(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the error_info field of the given task.

func (AsyncTaskClass) GetFinished 

func (_class AsyncTaskClass) GetFinished(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the finished field of the given task.

func (AsyncTaskClass) GetNameDescription 

func (_class AsyncTaskClass) GetNameDescription(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the name/description field of the given task.

func (AsyncTaskClass) GetNameLabel 

func (_class AsyncTaskClass) GetNameLabel(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the name/label field of the given task.

func (AsyncTaskClass) GetOtherConfig 

func (_class AsyncTaskClass) GetOtherConfig(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the other_config field of the given task.

func (AsyncTaskClass) GetProgress 

func (_class AsyncTaskClass) GetProgress(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the progress field of the given task.

func (AsyncTaskClass) GetRecord 

func (_class AsyncTaskClass) GetRecord(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given task.

func (AsyncTaskClass) GetResidentOn 

func (_class AsyncTaskClass) GetResidentOn(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the resident_on field of the given task.

func (AsyncTaskClass) GetResult 

func (_class AsyncTaskClass) GetResult(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the result field of the given task.

func (AsyncTaskClass) GetStatus 

func (_class AsyncTaskClass) GetStatus(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the status field of the given task.

func (AsyncTaskClass) GetSubtaskOf 

func (_class AsyncTaskClass) GetSubtaskOf(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the subtask_of field of the given task.

func (AsyncTaskClass) GetSubtasks 

func (_class AsyncTaskClass) GetSubtasks(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the subtasks field of the given task.

func (AsyncTaskClass) GetType 

func (_class AsyncTaskClass) GetType(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the type field of the given task.

func (AsyncTaskClass) GetUUID 

func (_class AsyncTaskClass) GetUUID(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the uuid field of the given task.

func (AsyncTaskClass) RemoveFromOtherConfig 

func (_class AsyncTaskClass) RemoveFromOtherConfig(sessionID SessionRef, self TaskRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given task. If the key is not in that Map, then do nothing.

func (AsyncTaskClass) SetOtherConfig 

func (_class AsyncTaskClass) SetOtherConfig(sessionID SessionRef, self TaskRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given task.

type AsyncTunnelClass 

type AsyncTunnelClass struct {
	// contains filtered or unexported fields
}

A tunnel for network traffic

func (AsyncTunnelClass) AddToOtherConfig 

func (_class AsyncTunnelClass) AddToOtherConfig(sessionID SessionRef, self TunnelRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given tunnel.

func (AsyncTunnelClass) AddToStatus 

func (_class AsyncTunnelClass) AddToStatus(sessionID SessionRef, self TunnelRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the status field of the given tunnel.

func (AsyncTunnelClass) Create 

func (_class AsyncTunnelClass) Create(sessionID SessionRef, transportPIF PIFRef, network NetworkRef) (_retval TaskRef, _err error)

Create a tunnel

Errors: 

OPENVSWITCH_NOT_ACTIVE - This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.
TRANSPORT_PIF_NOT_CONFIGURED - The tunnel transport PIF has no IP configuration set.
IS_TUNNEL_ACCESS_PIF - You tried to create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.

func (AsyncTunnelClass) Destroy 

func (_class AsyncTunnelClass) Destroy(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Destroy a tunnel

func (AsyncTunnelClass) GetAccessPIF 

func (_class AsyncTunnelClass) GetAccessPIF(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Get the access_PIF field of the given tunnel.

func (AsyncTunnelClass) GetAll 

func (_class AsyncTunnelClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the tunnels known to the system.

func (AsyncTunnelClass) GetAllRecords 

func (_class AsyncTunnelClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of tunnel references to tunnel records for all tunnels known to the system.

func (AsyncTunnelClass) GetByUUID 

func (_class AsyncTunnelClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the tunnel instance with the specified UUID.

func (AsyncTunnelClass) GetOtherConfig 

func (_class AsyncTunnelClass) GetOtherConfig(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Get the other_config field of the given tunnel.

func (AsyncTunnelClass) GetRecord 

func (_class AsyncTunnelClass) GetRecord(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given tunnel.

func (AsyncTunnelClass) GetStatus 

func (_class AsyncTunnelClass) GetStatus(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Get the status field of the given tunnel.

func (AsyncTunnelClass) GetTransportPIF 

func (_class AsyncTunnelClass) GetTransportPIF(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Get the transport_PIF field of the given tunnel.

func (AsyncTunnelClass) GetUUID 

func (_class AsyncTunnelClass) GetUUID(sessionID SessionRef, self TunnelRef) (_retval TaskRef, _err error)

Get the uuid field of the given tunnel.

func (AsyncTunnelClass) RemoveFromOtherConfig 

func (_class AsyncTunnelClass) RemoveFromOtherConfig(sessionID SessionRef, self TunnelRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given tunnel. If the key is not in that Map, then do nothing.

func (AsyncTunnelClass) RemoveFromStatus 

func (_class AsyncTunnelClass) RemoveFromStatus(sessionID SessionRef, self TunnelRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the status field of the given tunnel. If the key is not in that Map, then do nothing.

func (AsyncTunnelClass) SetOtherConfig 

func (_class AsyncTunnelClass) SetOtherConfig(sessionID SessionRef, self TunnelRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given tunnel.

func (AsyncTunnelClass) SetStatus 

func (_class AsyncTunnelClass) SetStatus(sessionID SessionRef, self TunnelRef, value map[string]string) (_retval TaskRef, _err error)

Set the status field of the given tunnel.

type AsyncUserClass 

type AsyncUserClass struct {
	// contains filtered or unexported fields
}

A user of the system

func (AsyncUserClass) AddToOtherConfig 

func (_class AsyncUserClass) AddToOtherConfig(sessionID SessionRef, self UserRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given user.

func (AsyncUserClass) Create 

func (_class AsyncUserClass) Create(sessionID SessionRef, args UserRecord) (_retval TaskRef, _err error)

Create a new user instance, and return its handle. The constructor args are: short_name*, fullname*, other_config (* = non-optional).

func (AsyncUserClass) Destroy 

func (_class AsyncUserClass) Destroy(sessionID SessionRef, self UserRef) (_retval TaskRef, _err error)

Destroy the specified user instance.

func (AsyncUserClass) GetByUUID 

func (_class AsyncUserClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the user instance with the specified UUID.

func (AsyncUserClass) GetFullname 

func (_class AsyncUserClass) GetFullname(sessionID SessionRef, self UserRef) (_retval TaskRef, _err error)

Get the fullname field of the given user.

func (AsyncUserClass) GetOtherConfig 

func (_class AsyncUserClass) GetOtherConfig(sessionID SessionRef, self UserRef) (_retval TaskRef, _err error)

Get the other_config field of the given user.

func (AsyncUserClass) GetRecord 

func (_class AsyncUserClass) GetRecord(sessionID SessionRef, self UserRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given user.

func (AsyncUserClass) GetShortName 

func (_class AsyncUserClass) GetShortName(sessionID SessionRef, self UserRef) (_retval TaskRef, _err error)

Get the short_name field of the given user.

func (AsyncUserClass) GetUUID 

func (_class AsyncUserClass) GetUUID(sessionID SessionRef, self UserRef) (_retval TaskRef, _err error)

Get the uuid field of the given user.

func (AsyncUserClass) RemoveFromOtherConfig 

func (_class AsyncUserClass) RemoveFromOtherConfig(sessionID SessionRef, self UserRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given user. If the key is not in that Map, then do nothing.

func (AsyncUserClass) SetFullname 

func (_class AsyncUserClass) SetFullname(sessionID SessionRef, self UserRef, value string) (_retval TaskRef, _err error)

Set the fullname field of the given user.

func (AsyncUserClass) SetOtherConfig 

func (_class AsyncUserClass) SetOtherConfig(sessionID SessionRef, self UserRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given user.

type AsyncVBDClass 

type AsyncVBDClass struct {
	// contains filtered or unexported fields
}

A virtual block device

func (AsyncVBDClass) AddToOtherConfig 

func (_class AsyncVBDClass) AddToOtherConfig(sessionID SessionRef, self VBDRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VBD.

func (AsyncVBDClass) AddToQosAlgorithmParams 

func (_class AsyncVBDClass) AddToQosAlgorithmParams(sessionID SessionRef, self VBDRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the qos/algorithm_params field of the given VBD.

func (AsyncVBDClass) AssertAttachable 

func (_class AsyncVBDClass) AssertAttachable(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.

func (AsyncVBDClass) Create 

func (_class AsyncVBDClass) Create(sessionID SessionRef, args VBDRecord) (_retval TaskRef, _err error)

Create a new VBD instance, and return its handle. The constructor args are: VM*, VDI*, userdevice*, bootable*, mode*, type*, unpluggable, empty*, other_config*, qos_algorithm_type*, qos_algorithm_params* (* = non-optional).

func (AsyncVBDClass) Destroy 

func (_class AsyncVBDClass) Destroy(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Destroy the specified VBD instance.

func (AsyncVBDClass) Eject 

func (_class AsyncVBDClass) Eject(sessionID SessionRef, vbd VBDRef) (_retval TaskRef, _err error)

Remove the media from the device and leave it empty

Errors: 

VBD_NOT_REMOVABLE_MEDIA - Media could not be ejected because it is not removable
VBD_IS_EMPTY - Operation could not be performed because the drive is empty

func (AsyncVBDClass) GetAll 

func (_class AsyncVBDClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VBDs known to the system.

func (AsyncVBDClass) GetAllRecords 

func (_class AsyncVBDClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VBD references to VBD records for all VBDs known to the system.

func (AsyncVBDClass) GetAllowedOperations 

func (_class AsyncVBDClass) GetAllowedOperations(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given VBD.

func (AsyncVBDClass) GetBootable 

func (_class AsyncVBDClass) GetBootable(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the bootable field of the given VBD.

func (AsyncVBDClass) GetByUUID 

func (_class AsyncVBDClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VBD instance with the specified UUID.

func (AsyncVBDClass) GetCurrentOperations 

func (_class AsyncVBDClass) GetCurrentOperations(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the current_operations field of the given VBD.

func (AsyncVBDClass) GetCurrentlyAttached 

func (_class AsyncVBDClass) GetCurrentlyAttached(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the currently_attached field of the given VBD.

func (AsyncVBDClass) GetDevice 

func (_class AsyncVBDClass) GetDevice(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the device field of the given VBD.

func (AsyncVBDClass) GetEmpty 

func (_class AsyncVBDClass) GetEmpty(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the empty field of the given VBD.

func (AsyncVBDClass) GetMetrics 

func (_class AsyncVBDClass) GetMetrics(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the metrics field of the given VBD.

func (AsyncVBDClass) GetMode 

func (_class AsyncVBDClass) GetMode(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the mode field of the given VBD.

func (AsyncVBDClass) GetOtherConfig 

func (_class AsyncVBDClass) GetOtherConfig(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the other_config field of the given VBD.

func (AsyncVBDClass) GetQosAlgorithmParams 

func (_class AsyncVBDClass) GetQosAlgorithmParams(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the qos/algorithm_params field of the given VBD.

func (AsyncVBDClass) GetQosAlgorithmType 

func (_class AsyncVBDClass) GetQosAlgorithmType(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the qos/algorithm_type field of the given VBD.

func (AsyncVBDClass) GetQosSupportedAlgorithms 

func (_class AsyncVBDClass) GetQosSupportedAlgorithms(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the qos/supported_algorithms field of the given VBD.

func (AsyncVBDClass) GetRecord 

func (_class AsyncVBDClass) GetRecord(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VBD.

func (AsyncVBDClass) GetRuntimeProperties 

func (_class AsyncVBDClass) GetRuntimeProperties(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the runtime_properties field of the given VBD.

func (AsyncVBDClass) GetStatusCode 

func (_class AsyncVBDClass) GetStatusCode(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the status_code field of the given VBD.

func (AsyncVBDClass) GetStatusDetail 

func (_class AsyncVBDClass) GetStatusDetail(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the status_detail field of the given VBD.

func (AsyncVBDClass) GetStorageLock 

func (_class AsyncVBDClass) GetStorageLock(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the storage_lock field of the given VBD.

func (AsyncVBDClass) GetType 

func (_class AsyncVBDClass) GetType(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the type field of the given VBD.

func (AsyncVBDClass) GetUUID 

func (_class AsyncVBDClass) GetUUID(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the uuid field of the given VBD.

func (AsyncVBDClass) GetUnpluggable 

func (_class AsyncVBDClass) GetUnpluggable(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the unpluggable field of the given VBD.

func (AsyncVBDClass) GetUserdevice 

func (_class AsyncVBDClass) GetUserdevice(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the userdevice field of the given VBD.

func (AsyncVBDClass) GetVDI 

func (_class AsyncVBDClass) GetVDI(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the VDI field of the given VBD.

func (AsyncVBDClass) GetVM 

func (_class AsyncVBDClass) GetVM(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Get the VM field of the given VBD.

func (AsyncVBDClass) Insert 

func (_class AsyncVBDClass) Insert(sessionID SessionRef, vbd VBDRef, vdi VDIRef) (_retval TaskRef, _err error)

Insert new media into the device

Errors: 

VBD_NOT_REMOVABLE_MEDIA - Media could not be ejected because it is not removable
VBD_NOT_EMPTY - Operation could not be performed because the drive is not empty

func (AsyncVBDClass) Plug 

func (_class AsyncVBDClass) Plug(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Hotplug the specified VBD, dynamically attaching it to the running VM

func (AsyncVBDClass) RemoveFromOtherConfig 

func (_class AsyncVBDClass) RemoveFromOtherConfig(sessionID SessionRef, self VBDRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVBDClass) RemoveFromQosAlgorithmParams 

func (_class AsyncVBDClass) RemoveFromQosAlgorithmParams(sessionID SessionRef, self VBDRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVBDClass) SetBootable 

func (_class AsyncVBDClass) SetBootable(sessionID SessionRef, self VBDRef, value bool) (_retval TaskRef, _err error)

Set the bootable field of the given VBD.

func (AsyncVBDClass) SetMode 

func (_class AsyncVBDClass) SetMode(sessionID SessionRef, self VBDRef, value VbdMode) (_retval TaskRef, _err error)

Set the mode field of the given VBD.

func (AsyncVBDClass) SetOtherConfig 

func (_class AsyncVBDClass) SetOtherConfig(sessionID SessionRef, self VBDRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VBD.

func (AsyncVBDClass) SetQosAlgorithmParams 

func (_class AsyncVBDClass) SetQosAlgorithmParams(sessionID SessionRef, self VBDRef, value map[string]string) (_retval TaskRef, _err error)

Set the qos/algorithm_params field of the given VBD.

func (AsyncVBDClass) SetQosAlgorithmType 

func (_class AsyncVBDClass) SetQosAlgorithmType(sessionID SessionRef, self VBDRef, value string) (_retval TaskRef, _err error)

Set the qos/algorithm_type field of the given VBD.

func (AsyncVBDClass) SetType 

func (_class AsyncVBDClass) SetType(sessionID SessionRef, self VBDRef, value VbdType) (_retval TaskRef, _err error)

Set the type field of the given VBD.

func (AsyncVBDClass) SetUnpluggable 

func (_class AsyncVBDClass) SetUnpluggable(sessionID SessionRef, self VBDRef, value bool) (_retval TaskRef, _err error)

Set the unpluggable field of the given VBD.

func (AsyncVBDClass) SetUserdevice 

func (_class AsyncVBDClass) SetUserdevice(sessionID SessionRef, self VBDRef, value string) (_retval TaskRef, _err error)

Set the userdevice field of the given VBD.

func (AsyncVBDClass) Unplug 

func (_class AsyncVBDClass) Unplug(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Hot-unplug the specified VBD, dynamically unattaching it from the running VM

Errors: 

DEVICE_DETACH_REJECTED - The VM rejected the attempt to detach the device.
DEVICE_ALREADY_DETACHED - The device is not currently attached

func (AsyncVBDClass) UnplugForce 

func (_class AsyncVBDClass) UnplugForce(sessionID SessionRef, self VBDRef) (_retval TaskRef, _err error)

Forcibly unplug the specified VBD

type AsyncVBDMetricsClass 

type AsyncVBDMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a virtual block device

func (AsyncVBDMetricsClass) AddToOtherConfig 

func (_class AsyncVBDMetricsClass) AddToOtherConfig(sessionID SessionRef, self VBDMetricsRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VBD_metrics.

func (AsyncVBDMetricsClass) GetAll 

func (_class AsyncVBDMetricsClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VBD_metrics instances known to the system.

func (AsyncVBDMetricsClass) GetAllRecords 

func (_class AsyncVBDMetricsClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VBD_metrics references to VBD_metrics records for all VBD_metrics instances known to the system.

func (AsyncVBDMetricsClass) GetByUUID 

func (_class AsyncVBDMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VBD_metrics instance with the specified UUID.

func (AsyncVBDMetricsClass) GetIoReadKbs 

func (_class AsyncVBDMetricsClass) GetIoReadKbs(sessionID SessionRef, self VBDMetricsRef) (_retval TaskRef, _err error)

Get the io/read_kbs field of the given VBD_metrics.

func (AsyncVBDMetricsClass) GetIoWriteKbs 

func (_class AsyncVBDMetricsClass) GetIoWriteKbs(sessionID SessionRef, self VBDMetricsRef) (_retval TaskRef, _err error)

Get the io/write_kbs field of the given VBD_metrics.

func (AsyncVBDMetricsClass) GetLastUpdated 

func (_class AsyncVBDMetricsClass) GetLastUpdated(sessionID SessionRef, self VBDMetricsRef) (_retval TaskRef, _err error)

Get the last_updated field of the given VBD_metrics.

func (AsyncVBDMetricsClass) GetOtherConfig 

func (_class AsyncVBDMetricsClass) GetOtherConfig(sessionID SessionRef, self VBDMetricsRef) (_retval TaskRef, _err error)

Get the other_config field of the given VBD_metrics.

func (AsyncVBDMetricsClass) GetRecord 

func (_class AsyncVBDMetricsClass) GetRecord(sessionID SessionRef, self VBDMetricsRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VBD_metrics.

func (AsyncVBDMetricsClass) GetUUID 

func (_class AsyncVBDMetricsClass) GetUUID(sessionID SessionRef, self VBDMetricsRef) (_retval TaskRef, _err error)

Get the uuid field of the given VBD_metrics.

func (AsyncVBDMetricsClass) RemoveFromOtherConfig 

func (_class AsyncVBDMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VBDMetricsRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given VBD_metrics. If the key is not in that Map, then do nothing.

func (AsyncVBDMetricsClass) SetOtherConfig 

func (_class AsyncVBDMetricsClass) SetOtherConfig(sessionID SessionRef, self VBDMetricsRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VBD_metrics.

type AsyncVDIClass 

type AsyncVDIClass struct {
	// contains filtered or unexported fields
}

A virtual disk image

func (AsyncVDIClass) AddTags 

func (_class AsyncVDIClass) AddTags(sessionID SessionRef, self VDIRef, value string) (_retval TaskRef, _err error)

Add the given value to the tags field of the given VDI. If the value is already in that Set, then do nothing.

func (AsyncVDIClass) AddToOtherConfig 

func (_class AsyncVDIClass) AddToOtherConfig(sessionID SessionRef, self VDIRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VDI.

func (AsyncVDIClass) AddToSmConfig 

func (_class AsyncVDIClass) AddToSmConfig(sessionID SessionRef, self VDIRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the sm_config field of the given VDI.

func (AsyncVDIClass) AddToXenstoreData 

func (_class AsyncVDIClass) AddToXenstoreData(sessionID SessionRef, self VDIRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the xenstore_data field of the given VDI.

func (AsyncVDIClass) Clone 

func (_class AsyncVDIClass) Clone(sessionID SessionRef, vdi VDIRef, driverParams map[string]string) (_retval TaskRef, _err error)

Take an exact copy of the VDI and return a reference to the new disk. If any driver_params are specified then these are passed through to the storage-specific substrate driver that implements the clone operation. NB the clone lives in the same Storage Repository as its parent.

func (AsyncVDIClass) Copy 

func (_class AsyncVDIClass) Copy(sessionID SessionRef, vdi VDIRef, sr SRRef, baseVdi VDIRef, intoVdi VDIRef) (_retval TaskRef, _err error)

Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.

Errors: 

VDI_READONLY - The operation required write access but this VDI is read-only
VDI_TOO_SMALL - The VDI is too small. Please resize it to at least the minimum size.
VDI_NOT_SPARSE - The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed blocks (or 'block differences' or 'disk deltas') between two VDIs. Please select a VDI which uses a sparse-aware technology such as VHD.

func (AsyncVDIClass) Create 

func (_class AsyncVDIClass) Create(sessionID SessionRef, args VDIRecord) (_retval TaskRef, _err error)

Create a new VDI instance, and return its handle. The constructor args are: name_label, name_description, SR*, virtual_size*, type*, sharable*, read_only*, other_config*, xenstore_data, sm_config, tags (* = non-optional).

func (AsyncVDIClass) DbForget 

func (_class AsyncVDIClass) DbForget(sessionID SessionRef, vdi VDIRef) (_retval TaskRef, _err error)

Removes a VDI record from the database

func (AsyncVDIClass) DbIntroduce 

func (_class AsyncVDIClass) DbIntroduce(sessionID SessionRef, uuid string, nameLabel string, nameDescription string, sr SRRef, atype VdiType, sharable bool, readOnly bool, otherConfig map[string]string, location string, xenstoreData map[string]string, smConfig map[string]string, managed bool, virtualSize int, physicalUtilisation int, metadataOfPool PoolRef, isASnapshot bool, snapshotTime time.Time, snapshotOf VDIRef) (_retval TaskRef, _err error)

Create a new VDI record in the database only

func (AsyncVDIClass) Destroy 

func (_class AsyncVDIClass) Destroy(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Destroy the specified VDI instance.

func (AsyncVDIClass) Forget 

func (_class AsyncVDIClass) Forget(sessionID SessionRef, vdi VDIRef) (_retval TaskRef, _err error)

Removes a VDI record from the database

func (AsyncVDIClass) GetAll 

func (_class AsyncVDIClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VDIs known to the system.

func (AsyncVDIClass) GetAllRecords 

func (_class AsyncVDIClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VDI references to VDI records for all VDIs known to the system.

func (AsyncVDIClass) GetAllowCaching 

func (_class AsyncVDIClass) GetAllowCaching(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the allow_caching field of the given VDI.

func (AsyncVDIClass) GetAllowedOperations 

func (_class AsyncVDIClass) GetAllowedOperations(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given VDI.

func (AsyncVDIClass) GetByNameLabel 

func (_class AsyncVDIClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the VDI instances with the given label.

func (AsyncVDIClass) GetByUUID 

func (_class AsyncVDIClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VDI instance with the specified UUID.

func (AsyncVDIClass) GetCrashDumps 

func (_class AsyncVDIClass) GetCrashDumps(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the crash_dumps field of the given VDI.

func (AsyncVDIClass) GetCurrentOperations 

func (_class AsyncVDIClass) GetCurrentOperations(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the current_operations field of the given VDI.

func (AsyncVDIClass) GetIsASnapshot 

func (_class AsyncVDIClass) GetIsASnapshot(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the is_a_snapshot field of the given VDI.

func (AsyncVDIClass) GetLocation 

func (_class AsyncVDIClass) GetLocation(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the location field of the given VDI.

func (AsyncVDIClass) GetManaged 

func (_class AsyncVDIClass) GetManaged(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the managed field of the given VDI.

func (AsyncVDIClass) GetMetadataLatest 

func (_class AsyncVDIClass) GetMetadataLatest(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the metadata_latest field of the given VDI.

func (AsyncVDIClass) GetMetadataOfPool 

func (_class AsyncVDIClass) GetMetadataOfPool(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the metadata_of_pool field of the given VDI.

func (AsyncVDIClass) GetMissing 

func (_class AsyncVDIClass) GetMissing(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the missing field of the given VDI.

func (AsyncVDIClass) GetNameDescription 

func (_class AsyncVDIClass) GetNameDescription(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the name/description field of the given VDI.

func (AsyncVDIClass) GetNameLabel 

func (_class AsyncVDIClass) GetNameLabel(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the name/label field of the given VDI.

func (AsyncVDIClass) GetOnBoot 

func (_class AsyncVDIClass) GetOnBoot(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the on_boot field of the given VDI.

func (AsyncVDIClass) GetOtherConfig 

func (_class AsyncVDIClass) GetOtherConfig(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the other_config field of the given VDI.

func (AsyncVDIClass) GetParent 

func (_class AsyncVDIClass) GetParent(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the parent field of the given VDI.

func (AsyncVDIClass) GetPhysicalUtilisation 

func (_class AsyncVDIClass) GetPhysicalUtilisation(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the physical_utilisation field of the given VDI.

func (AsyncVDIClass) GetReadOnly 

func (_class AsyncVDIClass) GetReadOnly(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the read_only field of the given VDI.

func (AsyncVDIClass) GetRecord 

func (_class AsyncVDIClass) GetRecord(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VDI.

func (AsyncVDIClass) GetSR 

func (_class AsyncVDIClass) GetSR(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the SR field of the given VDI.

func (AsyncVDIClass) GetSharable 

func (_class AsyncVDIClass) GetSharable(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the sharable field of the given VDI.

func (AsyncVDIClass) GetSmConfig 

func (_class AsyncVDIClass) GetSmConfig(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the sm_config field of the given VDI.

func (AsyncVDIClass) GetSnapshotOf 

func (_class AsyncVDIClass) GetSnapshotOf(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the snapshot_of field of the given VDI.

func (AsyncVDIClass) GetSnapshotTime 

func (_class AsyncVDIClass) GetSnapshotTime(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the snapshot_time field of the given VDI.

func (AsyncVDIClass) GetSnapshots 

func (_class AsyncVDIClass) GetSnapshots(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the snapshots field of the given VDI.

func (AsyncVDIClass) GetStorageLock 

func (_class AsyncVDIClass) GetStorageLock(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the storage_lock field of the given VDI.

func (AsyncVDIClass) GetTags 

func (_class AsyncVDIClass) GetTags(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the tags field of the given VDI.

func (AsyncVDIClass) GetType 

func (_class AsyncVDIClass) GetType(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the type field of the given VDI.

func (AsyncVDIClass) GetUUID 

func (_class AsyncVDIClass) GetUUID(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the uuid field of the given VDI.

func (AsyncVDIClass) GetVBDs 

func (_class AsyncVDIClass) GetVBDs(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the VBDs field of the given VDI.

func (AsyncVDIClass) GetVirtualSize 

func (_class AsyncVDIClass) GetVirtualSize(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the virtual_size field of the given VDI.

func (AsyncVDIClass) GetXenstoreData 

func (_class AsyncVDIClass) GetXenstoreData(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Get the xenstore_data field of the given VDI.

func (AsyncVDIClass) Introduce 

func (_class AsyncVDIClass) Introduce(sessionID SessionRef, uuid string, nameLabel string, nameDescription string, sr SRRef, atype VdiType, sharable bool, readOnly bool, otherConfig map[string]string, location string, xenstoreData map[string]string, smConfig map[string]string, managed bool, virtualSize int, physicalUtilisation int, metadataOfPool PoolRef, isASnapshot bool, snapshotTime time.Time, snapshotOf VDIRef) (_retval TaskRef, _err error)

Create a new VDI record in the database only

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)

func (AsyncVDIClass) OpenDatabase 

func (_class AsyncVDIClass) OpenDatabase(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Load the metadata found on the supplied VDI and return a session reference which can be used in XenAPI calls to query its contents.

func (AsyncVDIClass) PoolMigrate 

func (_class AsyncVDIClass) PoolMigrate(sessionID SessionRef, vdi VDIRef, sr SRRef, options map[string]string) (_retval TaskRef, _err error)

Migrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible to the guest.

func (AsyncVDIClass) ReadDatabasePoolUUID 

func (_class AsyncVDIClass) ReadDatabasePoolUUID(sessionID SessionRef, self VDIRef) (_retval TaskRef, _err error)

Check the VDI cache for the pool UUID of the database on this VDI.

func (AsyncVDIClass) RemoveFromOtherConfig 

func (_class AsyncVDIClass) RemoveFromOtherConfig(sessionID SessionRef, self VDIRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVDIClass) RemoveFromSmConfig 

func (_class AsyncVDIClass) RemoveFromSmConfig(sessionID SessionRef, self VDIRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the sm_config field of the given VDI. If the key is not in that Map, then do nothing.

func (AsyncVDIClass) RemoveFromXenstoreData 

func (_class AsyncVDIClass) RemoveFromXenstoreData(sessionID SessionRef, self VDIRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVDIClass) RemoveTags 

func (_class AsyncVDIClass) RemoveTags(sessionID SessionRef, self VDIRef, value string) (_retval TaskRef, _err error)

Remove the given value from the tags field of the given VDI. If the value is not in that Set, then do nothing.

func (AsyncVDIClass) Resize 

func (_class AsyncVDIClass) Resize(sessionID SessionRef, vdi VDIRef, size int) (_retval TaskRef, _err error)

Resize the VDI.

func (AsyncVDIClass) ResizeOnline 

func (_class AsyncVDIClass) ResizeOnline(sessionID SessionRef, vdi VDIRef, size int) (_retval TaskRef, _err error)

Resize the VDI which may or may not be attached to running guests.

func (AsyncVDIClass) SetAllowCaching 

func (_class AsyncVDIClass) SetAllowCaching(sessionID SessionRef, self VDIRef, value bool) (_retval TaskRef, _err error)

Set the value of the allow_caching parameter. This value can only be changed when the VDI is not attached to a running VM. The caching behaviour is only affected by this flag for VHD-based VDIs that have one parent and no child VHDs. Moreover, caching only takes place when the host running the VM containing this VDI has a nominated SR for local caching.

func (AsyncVDIClass) SetIsASnapshot 

func (_class AsyncVDIClass) SetIsASnapshot(sessionID SessionRef, self VDIRef, value bool) (_retval TaskRef, _err error)

Sets whether this VDI is a snapshot

func (AsyncVDIClass) SetManaged 

func (_class AsyncVDIClass) SetManaged(sessionID SessionRef, self VDIRef, value bool) (_retval TaskRef, _err error)

Sets the VDI's managed field

func (AsyncVDIClass) SetMetadataOfPool 

func (_class AsyncVDIClass) SetMetadataOfPool(sessionID SessionRef, self VDIRef, value PoolRef) (_retval TaskRef, _err error)

Records the pool whose metadata is contained by this VDI.

func (AsyncVDIClass) SetMissing 

func (_class AsyncVDIClass) SetMissing(sessionID SessionRef, self VDIRef, value bool) (_retval TaskRef, _err error)

Sets the VDI's missing field

func (AsyncVDIClass) SetNameDescription 

func (_class AsyncVDIClass) SetNameDescription(sessionID SessionRef, self VDIRef, value string) (_retval TaskRef, _err error)

Set the name description of the VDI. This can only happen when its SR is currently attached.

func (AsyncVDIClass) SetNameLabel 

func (_class AsyncVDIClass) SetNameLabel(sessionID SessionRef, self VDIRef, value string) (_retval TaskRef, _err error)

Set the name label of the VDI. This can only happen when then its SR is currently attached.

func (AsyncVDIClass) SetOnBoot 

func (_class AsyncVDIClass) SetOnBoot(sessionID SessionRef, self VDIRef, value OnBoot) (_retval TaskRef, _err error)

Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM.

func (AsyncVDIClass) SetOtherConfig 

func (_class AsyncVDIClass) SetOtherConfig(sessionID SessionRef, self VDIRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VDI.

func (AsyncVDIClass) SetPhysicalUtilisation 

func (_class AsyncVDIClass) SetPhysicalUtilisation(sessionID SessionRef, self VDIRef, value int) (_retval TaskRef, _err error)

Sets the VDI's physical_utilisation field

func (AsyncVDIClass) SetReadOnly 

func (_class AsyncVDIClass) SetReadOnly(sessionID SessionRef, self VDIRef, value bool) (_retval TaskRef, _err error)

Sets the VDI's read_only field

func (AsyncVDIClass) SetSharable 

func (_class AsyncVDIClass) SetSharable(sessionID SessionRef, self VDIRef, value bool) (_retval TaskRef, _err error)

Sets the VDI's sharable field

func (AsyncVDIClass) SetSmConfig 

func (_class AsyncVDIClass) SetSmConfig(sessionID SessionRef, self VDIRef, value map[string]string) (_retval TaskRef, _err error)

Set the sm_config field of the given VDI.

func (AsyncVDIClass) SetSnapshotOf 

func (_class AsyncVDIClass) SetSnapshotOf(sessionID SessionRef, self VDIRef, value VDIRef) (_retval TaskRef, _err error)

Sets the VDI of which this VDI is a snapshot

func (AsyncVDIClass) SetSnapshotTime 

func (_class AsyncVDIClass) SetSnapshotTime(sessionID SessionRef, self VDIRef, value time.Time) (_retval TaskRef, _err error)

Sets the snapshot time of this VDI.

func (AsyncVDIClass) SetTags 

func (_class AsyncVDIClass) SetTags(sessionID SessionRef, self VDIRef, value []string) (_retval TaskRef, _err error)

Set the tags field of the given VDI.

func (AsyncVDIClass) SetVirtualSize 

func (_class AsyncVDIClass) SetVirtualSize(sessionID SessionRef, self VDIRef, value int) (_retval TaskRef, _err error)

Sets the VDI's virtual_size field

func (AsyncVDIClass) SetXenstoreData 

func (_class AsyncVDIClass) SetXenstoreData(sessionID SessionRef, self VDIRef, value map[string]string) (_retval TaskRef, _err error)

Set the xenstore_data field of the given VDI.

func (AsyncVDIClass) Snapshot 

func (_class AsyncVDIClass) Snapshot(sessionID SessionRef, vdi VDIRef, driverParams map[string]string) (_retval TaskRef, _err error)

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 takes the snapshot. NB the snapshot lives in the same Storage Repository as its parent.

func (AsyncVDIClass) Update 

func (_class AsyncVDIClass) Update(sessionID SessionRef, vdi VDIRef) (_retval TaskRef, _err error)

Ask the storage backend to refresh the fields in the VDI object

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)

type AsyncVGPUClass 

type AsyncVGPUClass struct {
	// contains filtered or unexported fields
}

A virtual GPU (vGPU)

func (AsyncVGPUClass) AddToOtherConfig 

func (_class AsyncVGPUClass) AddToOtherConfig(sessionID SessionRef, self VGPURef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VGPU.

func (AsyncVGPUClass) Create 

func (_class AsyncVGPUClass) Create(sessionID SessionRef, vm VMRef, gpuGroup GPUGroupRef, device string, otherConfig map[string]string, atype VGPUTypeRef) (_retval TaskRef, _err error)

func (AsyncVGPUClass) Destroy 

func (_class AsyncVGPUClass) Destroy(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

func (AsyncVGPUClass) GetAll 

func (_class AsyncVGPUClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VGPUs known to the system.

func (AsyncVGPUClass) GetAllRecords 

func (_class AsyncVGPUClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VGPU references to VGPU records for all VGPUs known to the system.

func (AsyncVGPUClass) GetByUUID 

func (_class AsyncVGPUClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VGPU instance with the specified UUID.

func (AsyncVGPUClass) GetCurrentlyAttached 

func (_class AsyncVGPUClass) GetCurrentlyAttached(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the currently_attached field of the given VGPU.

func (AsyncVGPUClass) GetDevice 

func (_class AsyncVGPUClass) GetDevice(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the device field of the given VGPU.

func (AsyncVGPUClass) GetGPUGroup 

func (_class AsyncVGPUClass) GetGPUGroup(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the GPU_group field of the given VGPU.

func (AsyncVGPUClass) GetOtherConfig 

func (_class AsyncVGPUClass) GetOtherConfig(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the other_config field of the given VGPU.

func (AsyncVGPUClass) GetRecord 

func (_class AsyncVGPUClass) GetRecord(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VGPU.

func (AsyncVGPUClass) GetResidentOn 

func (_class AsyncVGPUClass) GetResidentOn(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the resident_on field of the given VGPU.

func (AsyncVGPUClass) GetType 

func (_class AsyncVGPUClass) GetType(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the type field of the given VGPU.

func (AsyncVGPUClass) GetUUID 

func (_class AsyncVGPUClass) GetUUID(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the uuid field of the given VGPU.

func (AsyncVGPUClass) GetVM 

func (_class AsyncVGPUClass) GetVM(sessionID SessionRef, self VGPURef) (_retval TaskRef, _err error)

Get the VM field of the given VGPU.

func (AsyncVGPUClass) RemoveFromOtherConfig 

func (_class AsyncVGPUClass) RemoveFromOtherConfig(sessionID SessionRef, self VGPURef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given VGPU. If the key is not in that Map, then do nothing.

func (AsyncVGPUClass) SetOtherConfig 

func (_class AsyncVGPUClass) SetOtherConfig(sessionID SessionRef, self VGPURef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VGPU.

type AsyncVGPUTypeClass 

type AsyncVGPUTypeClass struct {
	// contains filtered or unexported fields
}

A type of virtual GPU

func (AsyncVGPUTypeClass) GetAll 

func (_class AsyncVGPUTypeClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VGPU_types known to the system.

func (AsyncVGPUTypeClass) GetAllRecords 

func (_class AsyncVGPUTypeClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.

func (AsyncVGPUTypeClass) GetByUUID 

func (_class AsyncVGPUTypeClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VGPU_type instance with the specified UUID.

func (AsyncVGPUTypeClass) GetEnabledOnGPUGroups 

func (_class AsyncVGPUTypeClass) GetEnabledOnGPUGroups(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the enabled_on_GPU_groups field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetEnabledOnPGPUs 

func (_class AsyncVGPUTypeClass) GetEnabledOnPGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the enabled_on_PGPUs field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetExperimental 

func (_class AsyncVGPUTypeClass) GetExperimental(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the experimental field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetFramebufferSize 

func (_class AsyncVGPUTypeClass) GetFramebufferSize(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the framebuffer_size field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetIdentifier 

func (_class AsyncVGPUTypeClass) GetIdentifier(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the identifier field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetImplementation 

func (_class AsyncVGPUTypeClass) GetImplementation(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the implementation field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetMaxHeads 

func (_class AsyncVGPUTypeClass) GetMaxHeads(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the max_heads field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetMaxResolutionX 

func (_class AsyncVGPUTypeClass) GetMaxResolutionX(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the max_resolution_x field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetMaxResolutionY 

func (_class AsyncVGPUTypeClass) GetMaxResolutionY(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the max_resolution_y field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetModelName 

func (_class AsyncVGPUTypeClass) GetModelName(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the model_name field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetRecord 

func (_class AsyncVGPUTypeClass) GetRecord(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VGPU_type.

func (AsyncVGPUTypeClass) GetSupportedOnGPUGroups 

func (_class AsyncVGPUTypeClass) GetSupportedOnGPUGroups(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the supported_on_GPU_groups field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetSupportedOnPGPUs 

func (_class AsyncVGPUTypeClass) GetSupportedOnPGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the supported_on_PGPUs field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetUUID 

func (_class AsyncVGPUTypeClass) GetUUID(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the uuid field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetVGPUs 

func (_class AsyncVGPUTypeClass) GetVGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the VGPUs field of the given VGPU_type.

func (AsyncVGPUTypeClass) GetVendorName 

func (_class AsyncVGPUTypeClass) GetVendorName(sessionID SessionRef, self VGPUTypeRef) (_retval TaskRef, _err error)

Get the vendor_name field of the given VGPU_type.

type AsyncVIFClass 

type AsyncVIFClass struct {
	// contains filtered or unexported fields
}

A virtual network interface

func (AsyncVIFClass) AddIpv4Allowed 

func (_class AsyncVIFClass) AddIpv4Allowed(sessionID SessionRef, self VIFRef, value string) (_retval TaskRef, _err error)

Associates an IPv4 address with this VIF

func (AsyncVIFClass) AddIpv6Allowed 

func (_class AsyncVIFClass) AddIpv6Allowed(sessionID SessionRef, self VIFRef, value string) (_retval TaskRef, _err error)

Associates an IPv6 address with this VIF

func (AsyncVIFClass) AddToOtherConfig 

func (_class AsyncVIFClass) AddToOtherConfig(sessionID SessionRef, self VIFRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VIF.

func (AsyncVIFClass) AddToQosAlgorithmParams 

func (_class AsyncVIFClass) AddToQosAlgorithmParams(sessionID SessionRef, self VIFRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the qos/algorithm_params field of the given VIF.

func (AsyncVIFClass) Create 

func (_class AsyncVIFClass) Create(sessionID SessionRef, args VIFRecord) (_retval TaskRef, _err error)

Create a new VIF instance, and return its handle. The constructor args are: device*, network*, VM*, MAC*, MTU*, other_config*, qos_algorithm_type*, qos_algorithm_params*, locking_mode, ipv4_allowed, ipv6_allowed (* = non-optional).

func (AsyncVIFClass) Destroy 

func (_class AsyncVIFClass) Destroy(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Destroy the specified VIF instance.

func (AsyncVIFClass) GetAll 

func (_class AsyncVIFClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VIFs known to the system.

func (AsyncVIFClass) GetAllRecords 

func (_class AsyncVIFClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VIF references to VIF records for all VIFs known to the system.

func (AsyncVIFClass) GetAllowedOperations 

func (_class AsyncVIFClass) GetAllowedOperations(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given VIF.

func (AsyncVIFClass) GetByUUID 

func (_class AsyncVIFClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VIF instance with the specified UUID.

func (AsyncVIFClass) GetCurrentOperations 

func (_class AsyncVIFClass) GetCurrentOperations(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the current_operations field of the given VIF.

func (AsyncVIFClass) GetCurrentlyAttached 

func (_class AsyncVIFClass) GetCurrentlyAttached(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the currently_attached field of the given VIF.

func (AsyncVIFClass) GetDevice 

func (_class AsyncVIFClass) GetDevice(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the device field of the given VIF.

func (AsyncVIFClass) GetIpv4Allowed 

func (_class AsyncVIFClass) GetIpv4Allowed(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the ipv4_allowed field of the given VIF.

func (AsyncVIFClass) GetIpv6Allowed 

func (_class AsyncVIFClass) GetIpv6Allowed(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the ipv6_allowed field of the given VIF.

func (AsyncVIFClass) GetLockingMode 

func (_class AsyncVIFClass) GetLockingMode(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the locking_mode field of the given VIF.

func (AsyncVIFClass) GetMAC 

func (_class AsyncVIFClass) GetMAC(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the MAC field of the given VIF.

func (AsyncVIFClass) GetMACAutogenerated 

func (_class AsyncVIFClass) GetMACAutogenerated(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the MAC_autogenerated field of the given VIF.

func (AsyncVIFClass) GetMTU 

func (_class AsyncVIFClass) GetMTU(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the MTU field of the given VIF.

func (AsyncVIFClass) GetMetrics 

func (_class AsyncVIFClass) GetMetrics(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the metrics field of the given VIF.

func (AsyncVIFClass) GetNetwork 

func (_class AsyncVIFClass) GetNetwork(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the network field of the given VIF.

func (AsyncVIFClass) GetOtherConfig 

func (_class AsyncVIFClass) GetOtherConfig(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the other_config field of the given VIF.

func (AsyncVIFClass) GetQosAlgorithmParams 

func (_class AsyncVIFClass) GetQosAlgorithmParams(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the qos/algorithm_params field of the given VIF.

func (AsyncVIFClass) GetQosAlgorithmType 

func (_class AsyncVIFClass) GetQosAlgorithmType(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the qos/algorithm_type field of the given VIF.

func (AsyncVIFClass) GetQosSupportedAlgorithms 

func (_class AsyncVIFClass) GetQosSupportedAlgorithms(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the qos/supported_algorithms field of the given VIF.

func (AsyncVIFClass) GetRecord 

func (_class AsyncVIFClass) GetRecord(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VIF.

func (AsyncVIFClass) GetRuntimeProperties 

func (_class AsyncVIFClass) GetRuntimeProperties(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the runtime_properties field of the given VIF.

func (AsyncVIFClass) GetStatusCode 

func (_class AsyncVIFClass) GetStatusCode(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the status_code field of the given VIF.

func (AsyncVIFClass) GetStatusDetail 

func (_class AsyncVIFClass) GetStatusDetail(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the status_detail field of the given VIF.

func (AsyncVIFClass) GetUUID 

func (_class AsyncVIFClass) GetUUID(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the uuid field of the given VIF.

func (AsyncVIFClass) GetVM 

func (_class AsyncVIFClass) GetVM(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Get the VM field of the given VIF.

func (AsyncVIFClass) Plug 

func (_class AsyncVIFClass) Plug(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Hotplug the specified VIF, dynamically attaching it to the running VM

func (AsyncVIFClass) RemoveFromOtherConfig 

func (_class AsyncVIFClass) RemoveFromOtherConfig(sessionID SessionRef, self VIFRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVIFClass) RemoveFromQosAlgorithmParams 

func (_class AsyncVIFClass) RemoveFromQosAlgorithmParams(sessionID SessionRef, self VIFRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing.

func (AsyncVIFClass) RemoveIpv4Allowed 

func (_class AsyncVIFClass) RemoveIpv4Allowed(sessionID SessionRef, self VIFRef, value string) (_retval TaskRef, _err error)

Removes an IPv4 address from this VIF

func (AsyncVIFClass) RemoveIpv6Allowed 

func (_class AsyncVIFClass) RemoveIpv6Allowed(sessionID SessionRef, self VIFRef, value string) (_retval TaskRef, _err error)

Removes an IPv6 address from this VIF

func (AsyncVIFClass) SetIpv4Allowed 

func (_class AsyncVIFClass) SetIpv4Allowed(sessionID SessionRef, self VIFRef, value []string) (_retval TaskRef, _err error)

Set the IPv4 addresses to which traffic on this VIF can be restricted

func (AsyncVIFClass) SetIpv6Allowed 

func (_class AsyncVIFClass) SetIpv6Allowed(sessionID SessionRef, self VIFRef, value []string) (_retval TaskRef, _err error)

Set the IPv6 addresses to which traffic on this VIF can be restricted

func (AsyncVIFClass) SetLockingMode 

func (_class AsyncVIFClass) SetLockingMode(sessionID SessionRef, self VIFRef, value VifLockingMode) (_retval TaskRef, _err error)

Set the locking mode for this VIF

func (AsyncVIFClass) SetOtherConfig 

func (_class AsyncVIFClass) SetOtherConfig(sessionID SessionRef, self VIFRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VIF.

func (AsyncVIFClass) SetQosAlgorithmParams 

func (_class AsyncVIFClass) SetQosAlgorithmParams(sessionID SessionRef, self VIFRef, value map[string]string) (_retval TaskRef, _err error)

Set the qos/algorithm_params field of the given VIF.

func (AsyncVIFClass) SetQosAlgorithmType 

func (_class AsyncVIFClass) SetQosAlgorithmType(sessionID SessionRef, self VIFRef, value string) (_retval TaskRef, _err error)

Set the qos/algorithm_type field of the given VIF.

func (AsyncVIFClass) Unplug 

func (_class AsyncVIFClass) Unplug(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Hot-unplug the specified VIF, dynamically unattaching it from the running VM

func (AsyncVIFClass) UnplugForce 

func (_class AsyncVIFClass) UnplugForce(sessionID SessionRef, self VIFRef) (_retval TaskRef, _err error)

Forcibly unplug the specified VIF

type AsyncVIFMetricsClass 

type AsyncVIFMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a virtual network device

func (AsyncVIFMetricsClass) AddToOtherConfig 

func (_class AsyncVIFMetricsClass) AddToOtherConfig(sessionID SessionRef, self VIFMetricsRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VIF_metrics.

func (AsyncVIFMetricsClass) GetAll 

func (_class AsyncVIFMetricsClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VIF_metrics instances known to the system.

func (AsyncVIFMetricsClass) GetAllRecords 

func (_class AsyncVIFMetricsClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VIF_metrics references to VIF_metrics records for all VIF_metrics instances known to the system.

func (AsyncVIFMetricsClass) GetByUUID 

func (_class AsyncVIFMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VIF_metrics instance with the specified UUID.

func (AsyncVIFMetricsClass) GetIoReadKbs 

func (_class AsyncVIFMetricsClass) GetIoReadKbs(sessionID SessionRef, self VIFMetricsRef) (_retval TaskRef, _err error)

Get the io/read_kbs field of the given VIF_metrics.

func (AsyncVIFMetricsClass) GetIoWriteKbs 

func (_class AsyncVIFMetricsClass) GetIoWriteKbs(sessionID SessionRef, self VIFMetricsRef) (_retval TaskRef, _err error)

Get the io/write_kbs field of the given VIF_metrics.

func (AsyncVIFMetricsClass) GetLastUpdated 

func (_class AsyncVIFMetricsClass) GetLastUpdated(sessionID SessionRef, self VIFMetricsRef) (_retval TaskRef, _err error)

Get the last_updated field of the given VIF_metrics.

func (AsyncVIFMetricsClass) GetOtherConfig 

func (_class AsyncVIFMetricsClass) GetOtherConfig(sessionID SessionRef, self VIFMetricsRef) (_retval TaskRef, _err error)

Get the other_config field of the given VIF_metrics.

func (AsyncVIFMetricsClass) GetRecord 

func (_class AsyncVIFMetricsClass) GetRecord(sessionID SessionRef, self VIFMetricsRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VIF_metrics.

func (AsyncVIFMetricsClass) GetUUID 

func (_class AsyncVIFMetricsClass) GetUUID(sessionID SessionRef, self VIFMetricsRef) (_retval TaskRef, _err error)

Get the uuid field of the given VIF_metrics.

func (AsyncVIFMetricsClass) RemoveFromOtherConfig 

func (_class AsyncVIFMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VIFMetricsRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given VIF_metrics. If the key is not in that Map, then do nothing.

func (AsyncVIFMetricsClass) SetOtherConfig 

func (_class AsyncVIFMetricsClass) SetOtherConfig(sessionID SessionRef, self VIFMetricsRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VIF_metrics.

type AsyncVLANClass 

type AsyncVLANClass struct {
	// contains filtered or unexported fields
}

A VLAN mux/demux

func (AsyncVLANClass) AddToOtherConfig 

func (_class AsyncVLANClass) AddToOtherConfig(sessionID SessionRef, self VLANRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VLAN.

func (AsyncVLANClass) Create 

func (_class AsyncVLANClass) Create(sessionID SessionRef, taggedPIF PIFRef, tag int, network NetworkRef) (_retval TaskRef, _err error)

Create a VLAN mux/demuxer

func (AsyncVLANClass) Destroy 

func (_class AsyncVLANClass) Destroy(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Destroy a VLAN mux/demuxer

func (AsyncVLANClass) GetAll 

func (_class AsyncVLANClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VLANs known to the system.

func (AsyncVLANClass) GetAllRecords 

func (_class AsyncVLANClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VLAN references to VLAN records for all VLANs known to the system.

func (AsyncVLANClass) GetByUUID 

func (_class AsyncVLANClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VLAN instance with the specified UUID.

func (AsyncVLANClass) GetOtherConfig 

func (_class AsyncVLANClass) GetOtherConfig(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Get the other_config field of the given VLAN.

func (AsyncVLANClass) GetRecord 

func (_class AsyncVLANClass) GetRecord(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VLAN.

func (AsyncVLANClass) GetTag 

func (_class AsyncVLANClass) GetTag(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Get the tag field of the given VLAN.

func (AsyncVLANClass) GetTaggedPIF 

func (_class AsyncVLANClass) GetTaggedPIF(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Get the tagged_PIF field of the given VLAN.

func (AsyncVLANClass) GetUUID 

func (_class AsyncVLANClass) GetUUID(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Get the uuid field of the given VLAN.

func (AsyncVLANClass) GetUntaggedPIF 

func (_class AsyncVLANClass) GetUntaggedPIF(sessionID SessionRef, self VLANRef) (_retval TaskRef, _err error)

Get the untagged_PIF field of the given VLAN.

func (AsyncVLANClass) RemoveFromOtherConfig 

func (_class AsyncVLANClass) RemoveFromOtherConfig(sessionID SessionRef, self VLANRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given VLAN. If the key is not in that Map, then do nothing.

func (AsyncVLANClass) SetOtherConfig 

func (_class AsyncVLANClass) SetOtherConfig(sessionID SessionRef, self VLANRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VLAN.

type AsyncVMApplianceClass 

type AsyncVMApplianceClass struct {
	// contains filtered or unexported fields
}

VM appliance

func (AsyncVMApplianceClass) AssertCanBeRecovered 

func (_class AsyncVMApplianceClass) AssertCanBeRecovered(sessionID SessionRef, self VMApplianceRef, sessionTo SessionRef) (_retval TaskRef, _err error)

Assert whether all SRs required to recover this VM appliance are available.

Errors: 

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 attached to a VDI in the SR.

func (AsyncVMApplianceClass) CleanShutdown 

func (_class AsyncVMApplianceClass) CleanShutdown(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Perform a clean shutdown of all the VMs in the appliance

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

func (AsyncVMApplianceClass) Create 

func (_class AsyncVMApplianceClass) Create(sessionID SessionRef, args VMApplianceRecord) (_retval TaskRef, _err error)

Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional).

func (AsyncVMApplianceClass) Destroy 

func (_class AsyncVMApplianceClass) Destroy(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Destroy the specified VM_appliance instance.

func (AsyncVMApplianceClass) GetAll 

func (_class AsyncVMApplianceClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VM_appliances known to the system.

func (AsyncVMApplianceClass) GetAllRecords 

func (_class AsyncVMApplianceClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system.

func (AsyncVMApplianceClass) GetAllowedOperations 

func (_class AsyncVMApplianceClass) GetAllowedOperations(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given VM_appliance.

func (AsyncVMApplianceClass) GetByNameLabel 

func (_class AsyncVMApplianceClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the VM_appliance instances with the given label.

func (AsyncVMApplianceClass) GetByUUID 

func (_class AsyncVMApplianceClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VM_appliance instance with the specified UUID.

func (AsyncVMApplianceClass) GetCurrentOperations 

func (_class AsyncVMApplianceClass) GetCurrentOperations(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get the current_operations field of the given VM_appliance.

func (AsyncVMApplianceClass) GetNameDescription 

func (_class AsyncVMApplianceClass) GetNameDescription(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get the name/description field of the given VM_appliance.

func (AsyncVMApplianceClass) GetNameLabel 

func (_class AsyncVMApplianceClass) GetNameLabel(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get the name/label field of the given VM_appliance.

func (AsyncVMApplianceClass) GetRecord 

func (_class AsyncVMApplianceClass) GetRecord(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VM_appliance.

func (AsyncVMApplianceClass) GetSRsRequiredForRecovery 

func (_class AsyncVMApplianceClass) GetSRsRequiredForRecovery(sessionID SessionRef, self VMApplianceRef, sessionTo SessionRef) (_retval TaskRef, _err error)

Get the list of SRs required by the VM appliance to recover.

func (AsyncVMApplianceClass) GetUUID 

func (_class AsyncVMApplianceClass) GetUUID(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get the uuid field of the given VM_appliance.

func (AsyncVMApplianceClass) GetVMs 

func (_class AsyncVMApplianceClass) GetVMs(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Get the VMs field of the given VM_appliance.

func (AsyncVMApplianceClass) HardShutdown 

func (_class AsyncVMApplianceClass) HardShutdown(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

Perform a hard shutdown of all the VMs in the appliance

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

func (AsyncVMApplianceClass) Recover 

func (_class AsyncVMApplianceClass) Recover(sessionID SessionRef, self VMApplianceRef, sessionTo SessionRef, force bool) (_retval TaskRef, _err error)

Recover the VM appliance

Errors: 

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 attached to a VDI in the SR.

func (AsyncVMApplianceClass) SetNameDescription 

func (_class AsyncVMApplianceClass) SetNameDescription(sessionID SessionRef, self VMApplianceRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given VM_appliance.

func (AsyncVMApplianceClass) SetNameLabel 

func (_class AsyncVMApplianceClass) SetNameLabel(sessionID SessionRef, self VMApplianceRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given VM_appliance.

func (AsyncVMApplianceClass) Shutdown 

func (_class AsyncVMApplianceClass) Shutdown(sessionID SessionRef, self VMApplianceRef) (_retval TaskRef, _err error)

For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM.

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

func (AsyncVMApplianceClass) Start 

func (_class AsyncVMApplianceClass) Start(sessionID SessionRef, self VMApplianceRef, paused bool) (_retval TaskRef, _err error)

Start all VMs in the appliance

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

type AsyncVMClass 

type AsyncVMClass struct {
	// contains filtered or unexported fields
}

A virtual machine (or 'guest').

func (AsyncVMClass) AddTags 

func (_class AsyncVMClass) AddTags(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing.

func (AsyncVMClass) AddToBlockedOperations 

func (_class AsyncVMClass) AddToBlockedOperations(sessionID SessionRef, self VMRef, key VMOperations, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the blocked_operations field of the given VM.

func (AsyncVMClass) AddToHVMBootParams 

func (_class AsyncVMClass) AddToHVMBootParams(sessionID SessionRef, self VMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the HVM/boot_params field of the given VM.

func (AsyncVMClass) AddToOtherConfig 

func (_class AsyncVMClass) AddToOtherConfig(sessionID SessionRef, self VMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VM.

func (AsyncVMClass) AddToPlatform 

func (_class AsyncVMClass) AddToPlatform(sessionID SessionRef, self VMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the platform field of the given VM.

func (AsyncVMClass) AddToVCPUsParams 

func (_class AsyncVMClass) AddToVCPUsParams(sessionID SessionRef, self VMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the VCPUs/params field of the given VM.

func (AsyncVMClass) AddToVCPUsParamsLive 

func (_class AsyncVMClass) AddToVCPUsParamsLive(sessionID SessionRef, self VMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM

func (AsyncVMClass) AddToXenstoreData 

func (_class AsyncVMClass) AddToXenstoreData(sessionID SessionRef, self VMRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the xenstore_data field of the given VM.

func (AsyncVMClass) AssertAgile 

func (_class AsyncVMClass) AssertAgile(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host

func (AsyncVMClass) AssertCanBeRecovered 

func (_class AsyncVMClass) AssertCanBeRecovered(sessionID SessionRef, self VMRef, sessionTo SessionRef) (_retval TaskRef, _err error)

Assert whether all SRs required to recover this VM are available.

Errors: 

VM_IS_PART_OF_AN_APPLIANCE - This operation is not allowed as the VM is part of an appliance.
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 attached to a VDI in the SR.

func (AsyncVMClass) AssertCanBootHere 

func (_class AsyncVMClass) AssertCanBootHere(sessionID SessionRef, self VMRef, host HostRef) (_retval TaskRef, _err error)

Returns an error if the VM could not boot on this host for some reason

Errors: 

HOST_NOT_ENOUGH_FREE_MEMORY - Not enough host memory is available to perform this operation
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 attached to a VDI in the SR.
VM_HOST_INCOMPATIBLE_VERSION - This VM operation cannot be performed on an older-versioned host during an upgrade.
VM_HOST_INCOMPATIBLE_VIRTUAL_HARDWARE_PLATFORM_VERSION - You attempted to run a VM on a host that cannot provide the VM's required Virtual Hardware Platform version.

func (AsyncVMClass) AssertCanMigrate 

func (_class AsyncVMClass) AssertCanMigrate(sessionID SessionRef, vm VMRef, dest map[string]string, live bool, vdiMap map[VDIRef]SRRef, vifMap map[VIFRef]NetworkRef, options map[string]string) (_retval TaskRef, _err error)

Assert whether a VM can be migrated to the specified destination.

func (AsyncVMClass) AssertCanSetAutoUpdateDrivers 

func (_class AsyncVMClass) AssertCanSetAutoUpdateDrivers(sessionID SessionRef, self VMRef, value bool) (_retval TaskRef, _err error)

Check if PV auto update can be set on Windows vm

func (AsyncVMClass) AssertOperationValid 

func (_class AsyncVMClass) AssertOperationValid(sessionID SessionRef, self VMRef, op VMOperations) (_retval TaskRef, _err error)

Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason

func (AsyncVMClass) CallPlugin 

func (_class AsyncVMClass) CallPlugin(sessionID SessionRef, vm VMRef, plugin string, fn string, args map[string]string) (_retval TaskRef, _err error)

Call a XenAPI plugin on this vm

func (AsyncVMClass) Checkpoint 

func (_class AsyncVMClass) Checkpoint(sessionID SessionRef, vm VMRef, newName string) (_retval TaskRef, _err error)

Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_CHECKPOINT_SUSPEND_FAILED - An error occured while saving the memory image of the specified virtual machine
VM_CHECKPOINT_RESUME_FAILED - An error occured while restoring the memory image of the specified virtual machine

func (AsyncVMClass) CleanReboot 

func (_class AsyncVMClass) CleanReboot(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

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.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) CleanShutdown 

func (_class AsyncVMClass) CleanShutdown(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

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.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) Clone 

func (_class AsyncVMClass) Clone(sessionID SessionRef, vm VMRef, newName string) (_retval TaskRef, _err error)

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.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (AsyncVMClass) ComputeMemoryOverhead 

func (_class AsyncVMClass) ComputeMemoryOverhead(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Computes the virtualization memory overhead of a VM.

func (AsyncVMClass) Copy 

func (_class AsyncVMClass) Copy(sessionID SessionRef, vm VMRef, newName string, sr SRRef) (_retval TaskRef, _err error)

Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository 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 the VM is in the Halted State.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (AsyncVMClass) CopyBiosStrings 

func (_class AsyncVMClass) CopyBiosStrings(sessionID SessionRef, vm VMRef, host HostRef) (_retval TaskRef, _err error)

Copy the BIOS strings from the given host to this VM

func (AsyncVMClass) Create 

func (_class AsyncVMClass) Create(sessionID SessionRef, args VMRecord) (_retval TaskRef, _err error)

Create a new VM instance, and return its handle. The constructor args are: name_label, name_description, user_version*, is_a_template*, affinity*, memory_target, memory_static_max*, memory_dynamic_max*, memory_dynamic_min*, memory_static_min*, VCPUs_params*, VCPUs_max*, VCPUs_at_startup*, actions_after_shutdown*, actions_after_reboot*, actions_after_crash*, PV_bootloader*, PV_kernel*, PV_ramdisk*, PV_args*, PV_bootloader_args*, PV_legacy_args*, HVM_boot_policy*, HVM_boot_params*, HVM_shadow_multiplier, platform*, PCI_bus*, other_config*, recommendations*, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version (* = non-optional).

func (AsyncVMClass) CreateNewBlob 

func (_class AsyncVMClass) CreateNewBlob(sessionID SessionRef, vm VMRef, name string, mimeType string, public bool) (_retval TaskRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this VM

func (AsyncVMClass) Destroy 

func (_class AsyncVMClass) Destroy(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

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

func (AsyncVMClass) ForgetDataSourceArchives 

func (_class AsyncVMClass) ForgetDataSourceArchives(sessionID SessionRef, self VMRef, dataSource string) (_retval TaskRef, _err error)

Forget the recorded statistics related to the specified data source

func (AsyncVMClass) GetActionsAfterCrash 

func (_class AsyncVMClass) GetActionsAfterCrash(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the actions/after_crash field of the given VM.

func (AsyncVMClass) GetActionsAfterReboot 

func (_class AsyncVMClass) GetActionsAfterReboot(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the actions/after_reboot field of the given VM.

func (AsyncVMClass) GetActionsAfterShutdown 

func (_class AsyncVMClass) GetActionsAfterShutdown(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the actions/after_shutdown field of the given VM.

func (AsyncVMClass) GetAffinity 

func (_class AsyncVMClass) GetAffinity(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the affinity field of the given VM.

func (AsyncVMClass) GetAll 

func (_class AsyncVMClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VMs known to the system.

func (AsyncVMClass) GetAllRecords 

func (_class AsyncVMClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VM references to VM records for all VMs known to the system.

func (AsyncVMClass) GetAllowedOperations 

func (_class AsyncVMClass) GetAllowedOperations(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the allowed_operations field of the given VM.

func (AsyncVMClass) GetAllowedVBDDevices 

func (_class AsyncVMClass) GetAllowedVBDDevices(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Returns a list of the allowed values that a VBD device field can take

func (AsyncVMClass) GetAllowedVIFDevices 

func (_class AsyncVMClass) GetAllowedVIFDevices(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Returns a list of the allowed values that a VIF device field can take

func (AsyncVMClass) GetAppliance 

func (_class AsyncVMClass) GetAppliance(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the appliance field of the given VM.

func (AsyncVMClass) GetAttachedPCIs 

func (_class AsyncVMClass) GetAttachedPCIs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the attached_PCIs field of the given VM.

func (AsyncVMClass) GetAutoUpdateDrivers 

func (_class AsyncVMClass) GetAutoUpdateDrivers(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the auto_update_drivers field of the given VM.

func (AsyncVMClass) GetBiosStrings 

func (_class AsyncVMClass) GetBiosStrings(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the bios_strings field of the given VM.

func (AsyncVMClass) GetBlobs 

func (_class AsyncVMClass) GetBlobs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the blobs field of the given VM.

func (AsyncVMClass) GetBlockedOperations 

func (_class AsyncVMClass) GetBlockedOperations(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the blocked_operations field of the given VM.

func (AsyncVMClass) GetBootRecord 

func (_class AsyncVMClass) GetBootRecord(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug

func (AsyncVMClass) GetByNameLabel 

func (_class AsyncVMClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the VM instances with the given label.

func (AsyncVMClass) GetByUUID 

func (_class AsyncVMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VM instance with the specified UUID.

func (AsyncVMClass) GetChildren 

func (_class AsyncVMClass) GetChildren(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the children field of the given VM.

func (AsyncVMClass) GetConsoles 

func (_class AsyncVMClass) GetConsoles(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the consoles field of the given VM.

func (AsyncVMClass) GetCooperative 

func (_class AsyncVMClass) GetCooperative(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done

func (AsyncVMClass) GetCrashDumps 

func (_class AsyncVMClass) GetCrashDumps(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the crash_dumps field of the given VM.

func (AsyncVMClass) GetCurrentOperations 

func (_class AsyncVMClass) GetCurrentOperations(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the current_operations field of the given VM.

func (AsyncVMClass) GetDataSources 

func (_class AsyncVMClass) GetDataSources(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

func (AsyncVMClass) GetDomarch 

func (_class AsyncVMClass) GetDomarch(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the domarch field of the given VM.

func (AsyncVMClass) GetDomid 

func (_class AsyncVMClass) GetDomid(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the domid field of the given VM.

func (AsyncVMClass) GetGenerationID 

func (_class AsyncVMClass) GetGenerationID(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the generation_id field of the given VM.

func (AsyncVMClass) GetGuestMetrics 

func (_class AsyncVMClass) GetGuestMetrics(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the guest_metrics field of the given VM.

func (AsyncVMClass) GetHVMBootParams 

func (_class AsyncVMClass) GetHVMBootParams(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the HVM/boot_params field of the given VM.

func (AsyncVMClass) GetHVMBootPolicy 

func (_class AsyncVMClass) GetHVMBootPolicy(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the HVM/boot_policy field of the given VM.

func (AsyncVMClass) GetHVMShadowMultiplier 

func (_class AsyncVMClass) GetHVMShadowMultiplier(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the HVM/shadow_multiplier field of the given VM.

func (AsyncVMClass) GetHaAlwaysRun 

func (_class AsyncVMClass) GetHaAlwaysRun(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the ha_always_run field of the given VM.

func (AsyncVMClass) GetHaRestartPriority 

func (_class AsyncVMClass) GetHaRestartPriority(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the ha_restart_priority field of the given VM.

func (AsyncVMClass) GetHardwarePlatformVersion 

func (_class AsyncVMClass) GetHardwarePlatformVersion(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the hardware_platform_version field of the given VM.

func (AsyncVMClass) GetIsASnapshot 

func (_class AsyncVMClass) GetIsASnapshot(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the is_a_snapshot field of the given VM.

func (AsyncVMClass) GetIsATemplate 

func (_class AsyncVMClass) GetIsATemplate(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the is_a_template field of the given VM.

func (AsyncVMClass) GetIsControlDomain 

func (_class AsyncVMClass) GetIsControlDomain(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the is_control_domain field of the given VM.

func (AsyncVMClass) GetIsSnapshotFromVmpp 

func (_class AsyncVMClass) GetIsSnapshotFromVmpp(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the is_snapshot_from_vmpp field of the given VM.

func (AsyncVMClass) GetLastBootCPUFlags 

func (_class AsyncVMClass) GetLastBootCPUFlags(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the last_boot_CPU_flags field of the given VM.

func (AsyncVMClass) GetLastBootedRecord 

func (_class AsyncVMClass) GetLastBootedRecord(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the last_booted_record field of the given VM.

func (AsyncVMClass) GetMemoryDynamicMax 

func (_class AsyncVMClass) GetMemoryDynamicMax(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the memory/dynamic_max field of the given VM.

func (AsyncVMClass) GetMemoryDynamicMin 

func (_class AsyncVMClass) GetMemoryDynamicMin(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the memory/dynamic_min field of the given VM.

func (AsyncVMClass) GetMemoryOverhead 

func (_class AsyncVMClass) GetMemoryOverhead(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the memory/overhead field of the given VM.

func (AsyncVMClass) GetMemoryStaticMax 

func (_class AsyncVMClass) GetMemoryStaticMax(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the memory/static_max field of the given VM.

func (AsyncVMClass) GetMemoryStaticMin 

func (_class AsyncVMClass) GetMemoryStaticMin(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the memory/static_min field of the given VM.

func (AsyncVMClass) GetMemoryTarget 

func (_class AsyncVMClass) GetMemoryTarget(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the memory/target field of the given VM.

func (AsyncVMClass) GetMetrics 

func (_class AsyncVMClass) GetMetrics(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the metrics field of the given VM.

func (AsyncVMClass) GetNameDescription 

func (_class AsyncVMClass) GetNameDescription(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the name/description field of the given VM.

func (AsyncVMClass) GetNameLabel 

func (_class AsyncVMClass) GetNameLabel(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the name/label field of the given VM.

func (AsyncVMClass) GetOrder 

func (_class AsyncVMClass) GetOrder(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the order field of the given VM.

func (AsyncVMClass) GetOtherConfig 

func (_class AsyncVMClass) GetOtherConfig(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the other_config field of the given VM.

func (AsyncVMClass) GetPCIBus 

func (_class AsyncVMClass) GetPCIBus(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PCI_bus field of the given VM.

func (AsyncVMClass) GetPVArgs 

func (_class AsyncVMClass) GetPVArgs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PV/args field of the given VM.

func (AsyncVMClass) GetPVBootloader 

func (_class AsyncVMClass) GetPVBootloader(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PV/bootloader field of the given VM.

func (AsyncVMClass) GetPVBootloaderArgs 

func (_class AsyncVMClass) GetPVBootloaderArgs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PV/bootloader_args field of the given VM.

func (AsyncVMClass) GetPVKernel 

func (_class AsyncVMClass) GetPVKernel(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PV/kernel field of the given VM.

func (AsyncVMClass) GetPVLegacyArgs 

func (_class AsyncVMClass) GetPVLegacyArgs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PV/legacy_args field of the given VM.

func (AsyncVMClass) GetPVRamdisk 

func (_class AsyncVMClass) GetPVRamdisk(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the PV/ramdisk field of the given VM.

func (AsyncVMClass) GetParent 

func (_class AsyncVMClass) GetParent(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the parent field of the given VM.

func (AsyncVMClass) GetPlatform 

func (_class AsyncVMClass) GetPlatform(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the platform field of the given VM.

func (AsyncVMClass) GetPossibleHosts 

func (_class AsyncVMClass) GetPossibleHosts(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Return the list of hosts on which this VM may run.

func (AsyncVMClass) GetPowerState 

func (_class AsyncVMClass) GetPowerState(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the power_state field of the given VM.

func (AsyncVMClass) GetProtectionPolicy 

func (_class AsyncVMClass) GetProtectionPolicy(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the protection_policy field of the given VM.

func (AsyncVMClass) GetRecommendations 

func (_class AsyncVMClass) GetRecommendations(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the recommendations field of the given VM.

func (AsyncVMClass) GetRecord 

func (_class AsyncVMClass) GetRecord(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VM.

func (AsyncVMClass) GetResidentOn 

func (_class AsyncVMClass) GetResidentOn(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the resident_on field of the given VM.

func (AsyncVMClass) GetSRsRequiredForRecovery 

func (_class AsyncVMClass) GetSRsRequiredForRecovery(sessionID SessionRef, self VMRef, sessionTo SessionRef) (_retval TaskRef, _err error)

List all the SR's that are required for the VM to be recovered

func (AsyncVMClass) GetShutdownDelay 

func (_class AsyncVMClass) GetShutdownDelay(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the shutdown_delay field of the given VM.

func (AsyncVMClass) GetSnapshotInfo 

func (_class AsyncVMClass) GetSnapshotInfo(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the snapshot_info field of the given VM.

func (AsyncVMClass) GetSnapshotMetadata 

func (_class AsyncVMClass) GetSnapshotMetadata(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the snapshot_metadata field of the given VM.

func (AsyncVMClass) GetSnapshotOf 

func (_class AsyncVMClass) GetSnapshotOf(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the snapshot_of field of the given VM.

func (AsyncVMClass) GetSnapshotTime 

func (_class AsyncVMClass) GetSnapshotTime(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the snapshot_time field of the given VM.

func (AsyncVMClass) GetSnapshots 

func (_class AsyncVMClass) GetSnapshots(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the snapshots field of the given VM.

func (AsyncVMClass) GetStartDelay 

func (_class AsyncVMClass) GetStartDelay(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the start_delay field of the given VM.

func (AsyncVMClass) GetSuspendSR 

func (_class AsyncVMClass) GetSuspendSR(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the suspend_SR field of the given VM.

func (AsyncVMClass) GetSuspendVDI 

func (_class AsyncVMClass) GetSuspendVDI(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the suspend_VDI field of the given VM.

func (AsyncVMClass) GetTags 

func (_class AsyncVMClass) GetTags(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the tags field of the given VM.

func (AsyncVMClass) GetTransportableSnapshotID 

func (_class AsyncVMClass) GetTransportableSnapshotID(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the transportable_snapshot_id field of the given VM.

func (AsyncVMClass) GetUUID 

func (_class AsyncVMClass) GetUUID(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the uuid field of the given VM.

func (AsyncVMClass) GetUserVersion 

func (_class AsyncVMClass) GetUserVersion(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the user_version field of the given VM.

func (AsyncVMClass) GetVBDs 

func (_class AsyncVMClass) GetVBDs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VBDs field of the given VM.

func (AsyncVMClass) GetVCPUsAtStartup 

func (_class AsyncVMClass) GetVCPUsAtStartup(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VCPUs/at_startup field of the given VM.

func (AsyncVMClass) GetVCPUsMax 

func (_class AsyncVMClass) GetVCPUsMax(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VCPUs/max field of the given VM.

func (AsyncVMClass) GetVCPUsParams 

func (_class AsyncVMClass) GetVCPUsParams(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VCPUs/params field of the given VM.

func (AsyncVMClass) GetVGPUs 

func (_class AsyncVMClass) GetVGPUs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VGPUs field of the given VM.

func (AsyncVMClass) GetVIFs 

func (_class AsyncVMClass) GetVIFs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VIFs field of the given VM.

func (AsyncVMClass) GetVTPMs 

func (_class AsyncVMClass) GetVTPMs(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the VTPMs field of the given VM.

func (AsyncVMClass) GetVersion 

func (_class AsyncVMClass) GetVersion(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the version field of the given VM.

func (AsyncVMClass) GetXenstoreData 

func (_class AsyncVMClass) GetXenstoreData(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Get the xenstore_data field of the given VM.

func (AsyncVMClass) HardReboot 

func (_class AsyncVMClass) HardReboot(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) HardShutdown 

func (_class AsyncVMClass) HardShutdown(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Stop executing the specified VM without attempting a clean shutdown.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) Import 

func (_class AsyncVMClass) Import(sessionID SessionRef, url string, sr SRRef, fullRestore bool, force bool) (_retval TaskRef, _err error)

Import an XVA from a URI

func (AsyncVMClass) ImportConvert 

func (_class AsyncVMClass) ImportConvert(sessionID SessionRef, atype string, username string, password string, sr SRRef, remoteConfig map[string]string) (_retval TaskRef, _err error)

Import using a conversion service.

func (AsyncVMClass) MaximiseMemory 

func (_class AsyncVMClass) MaximiseMemory(sessionID SessionRef, self VMRef, total int, approximate bool) (_retval TaskRef, _err error)

Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used

func (AsyncVMClass) MigrateSend 

func (_class AsyncVMClass) MigrateSend(sessionID SessionRef, vm VMRef, dest map[string]string, live bool, vdiMap map[VDIRef]SRRef, vifMap map[VIFRef]NetworkRef, options map[string]string) (_retval TaskRef, _err error)

Migrate the VM to another host. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.

func (AsyncVMClass) Pause 

func (_class AsyncVMClass) Pause(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Pause the specified VM. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) PoolMigrate 

func (_class AsyncVMClass) PoolMigrate(sessionID SessionRef, vm VMRef, host HostRef, options map[string]string) (_retval TaskRef, _err error)

Migrate a VM to another Host.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_MIGRATE_FAILED - An error occurred during the migration process.

func (AsyncVMClass) PowerStateReset 

func (_class AsyncVMClass) PowerStateReset(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care.

func (AsyncVMClass) Provision 

func (_class AsyncVMClass) Provision(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (AsyncVMClass) QueryDataSource 

func (_class AsyncVMClass) QueryDataSource(sessionID SessionRef, self VMRef, dataSource string) (_retval TaskRef, _err error)

Query the latest value of the specified data source

func (AsyncVMClass) QueryServices 

func (_class AsyncVMClass) QueryServices(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Query the system services advertised by this VM and register them. This can only be applied to a system domain.

func (AsyncVMClass) RecordDataSource 

func (_class AsyncVMClass) RecordDataSource(sessionID SessionRef, self VMRef, dataSource string) (_retval TaskRef, _err error)

Start recording the specified data source

func (AsyncVMClass) Recover 

func (_class AsyncVMClass) Recover(sessionID SessionRef, self VMRef, sessionTo SessionRef, force bool) (_retval TaskRef, _err error)

Recover the VM

func (AsyncVMClass) RemoveFromBlockedOperations 

func (_class AsyncVMClass) RemoveFromBlockedOperations(sessionID SessionRef, self VMRef, key VMOperations) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the blocked_operations field of the given VM. If the key is not in that Map, then do nothing.

func (AsyncVMClass) RemoveFromHVMBootParams 

func (_class AsyncVMClass) RemoveFromHVMBootParams(sessionID SessionRef, self VMRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVMClass) RemoveFromOtherConfig 

func (_class AsyncVMClass) RemoveFromOtherConfig(sessionID SessionRef, self VMRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVMClass) RemoveFromPlatform 

func (_class AsyncVMClass) RemoveFromPlatform(sessionID SessionRef, self VMRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVMClass) RemoveFromVCPUsParams 

func (_class AsyncVMClass) RemoveFromVCPUsParams(sessionID SessionRef, self VMRef, key string) (_retval TaskRef, _err error)

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.

func (AsyncVMClass) RemoveFromXenstoreData 

func (_class AsyncVMClass) RemoveFromXenstoreData(sessionID SessionRef, self VMRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing.

func (AsyncVMClass) RemoveTags 

func (_class AsyncVMClass) RemoveTags(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing.

func (AsyncVMClass) Resume 

func (_class AsyncVMClass) Resume(sessionID SessionRef, vm VMRef, startPaused bool, force bool) (_retval TaskRef, _err error)

Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) ResumeOn 

func (_class AsyncVMClass) ResumeOn(sessionID SessionRef, vm VMRef, host HostRef, startPaused bool, force bool) (_retval TaskRef, _err error)

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.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) RetrieveWlbRecommendations 

func (_class AsyncVMClass) RetrieveWlbRecommendations(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there.

func (AsyncVMClass) Revert 

func (_class AsyncVMClass) Revert(sessionID SessionRef, snapshot VMRef) (_retval TaskRef, _err error)

Reverts the specified VM to a previous state.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
VM_REVERT_FAILED - An error occured while reverting the specified virtual machine to the specified snapshot

func (AsyncVMClass) SendSysrq 

func (_class AsyncVMClass) SendSysrq(sessionID SessionRef, vm VMRef, key string) (_retval TaskRef, _err error)

Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.

func (AsyncVMClass) SendTrigger 

func (_class AsyncVMClass) SendTrigger(sessionID SessionRef, vm VMRef, trigger string) (_retval TaskRef, _err error)

Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.

func (AsyncVMClass) SetActionsAfterCrash 

func (_class AsyncVMClass) SetActionsAfterCrash(sessionID SessionRef, self VMRef, value OnCrashBehaviour) (_retval TaskRef, _err error)

Set the actions/after_crash field of the given VM.

func (AsyncVMClass) SetActionsAfterReboot 

func (_class AsyncVMClass) SetActionsAfterReboot(sessionID SessionRef, self VMRef, value OnNormalExit) (_retval TaskRef, _err error)

Set the actions/after_reboot field of the given VM.

func (AsyncVMClass) SetActionsAfterShutdown 

func (_class AsyncVMClass) SetActionsAfterShutdown(sessionID SessionRef, self VMRef, value OnNormalExit) (_retval TaskRef, _err error)

Set the actions/after_shutdown field of the given VM.

func (AsyncVMClass) SetAffinity 

func (_class AsyncVMClass) SetAffinity(sessionID SessionRef, self VMRef, value HostRef) (_retval TaskRef, _err error)

Set the affinity field of the given VM.

func (AsyncVMClass) SetAppliance 

func (_class AsyncVMClass) SetAppliance(sessionID SessionRef, self VMRef, value VMApplianceRef) (_retval TaskRef, _err error)

Assign this VM to an appliance.

func (AsyncVMClass) SetAutoUpdateDrivers 

func (_class AsyncVMClass) SetAutoUpdateDrivers(sessionID SessionRef, self VMRef, value bool) (_retval TaskRef, _err error)

Enable or disable PV auto update on Windows vm

func (AsyncVMClass) SetBlockedOperations 

func (_class AsyncVMClass) SetBlockedOperations(sessionID SessionRef, self VMRef, value map[VMOperations]string) (_retval TaskRef, _err error)

Set the blocked_operations field of the given VM.

func (AsyncVMClass) SetHVMBootParams 

func (_class AsyncVMClass) SetHVMBootParams(sessionID SessionRef, self VMRef, value map[string]string) (_retval TaskRef, _err error)

Set the HVM/boot_params field of the given VM.

func (AsyncVMClass) SetHVMBootPolicy 

func (_class AsyncVMClass) SetHVMBootPolicy(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the HVM/boot_policy field of the given VM.

func (AsyncVMClass) SetHVMShadowMultiplier 

func (_class AsyncVMClass) SetHVMShadowMultiplier(sessionID SessionRef, self VMRef, value float64) (_retval TaskRef, _err error)

Set the shadow memory multiplier on a halted VM

func (AsyncVMClass) SetHaAlwaysRun 

func (_class AsyncVMClass) SetHaAlwaysRun(sessionID SessionRef, self VMRef, value bool) (_retval TaskRef, _err error)

Set the value of the ha_always_run

func (AsyncVMClass) SetHaRestartPriority 

func (_class AsyncVMClass) SetHaRestartPriority(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the value of the ha_restart_priority field

func (AsyncVMClass) SetHardwarePlatformVersion 

func (_class AsyncVMClass) SetHardwarePlatformVersion(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the hardware_platform_version field of the given VM.

func (AsyncVMClass) SetIsATemplate 

func (_class AsyncVMClass) SetIsATemplate(sessionID SessionRef, self VMRef, value bool) (_retval TaskRef, _err error)

Set the is_a_template field of the given VM.

func (AsyncVMClass) SetMemoryDynamicMax 

func (_class AsyncVMClass) SetMemoryDynamicMax(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the value of the memory_dynamic_max field

func (AsyncVMClass) SetMemoryDynamicMin 

func (_class AsyncVMClass) SetMemoryDynamicMin(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the value of the memory_dynamic_min field

func (AsyncVMClass) SetMemoryDynamicRange 

func (_class AsyncVMClass) SetMemoryDynamicRange(sessionID SessionRef, self VMRef, min int, max int) (_retval TaskRef, _err error)

Set the minimum and maximum amounts of physical memory the VM is allowed to use.

func (AsyncVMClass) SetMemoryLimits 

func (_class AsyncVMClass) SetMemoryLimits(sessionID SessionRef, self VMRef, staticMin int, staticMax int, dynamicMin int, dynamicMax int) (_retval TaskRef, _err error)

Set the memory limits of this VM.

func (AsyncVMClass) SetMemoryStaticMax 

func (_class AsyncVMClass) SetMemoryStaticMax(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the value of the memory_static_max field

Errors: 

HA_OPERATION_WOULD_BREAK_FAILOVER_PLAN - This operation cannot be performed because it would invalidate VM failover planning such that the system would be unable to guarantee to restart protected VMs after a Host failure.

func (AsyncVMClass) SetMemoryStaticMin 

func (_class AsyncVMClass) SetMemoryStaticMin(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the value of the memory_static_min field

func (AsyncVMClass) SetMemoryStaticRange 

func (_class AsyncVMClass) SetMemoryStaticRange(sessionID SessionRef, self VMRef, min int, max int) (_retval TaskRef, _err error)

Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.

func (AsyncVMClass) SetMemoryTargetLive 

func (_class AsyncVMClass) SetMemoryTargetLive(sessionID SessionRef, self VMRef, target int) (_retval TaskRef, _err error)

Set the memory target for a running VM

func (AsyncVMClass) SetNameDescription 

func (_class AsyncVMClass) SetNameDescription(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given VM.

func (AsyncVMClass) SetNameLabel 

func (_class AsyncVMClass) SetNameLabel(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given VM.

func (AsyncVMClass) SetOrder 

func (_class AsyncVMClass) SetOrder(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set this VM's boot order

func (AsyncVMClass) SetOtherConfig 

func (_class AsyncVMClass) SetOtherConfig(sessionID SessionRef, self VMRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VM.

func (AsyncVMClass) SetPCIBus 

func (_class AsyncVMClass) SetPCIBus(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PCI_bus field of the given VM.

func (AsyncVMClass) SetPVArgs 

func (_class AsyncVMClass) SetPVArgs(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PV/args field of the given VM.

func (AsyncVMClass) SetPVBootloader 

func (_class AsyncVMClass) SetPVBootloader(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PV/bootloader field of the given VM.

func (AsyncVMClass) SetPVBootloaderArgs 

func (_class AsyncVMClass) SetPVBootloaderArgs(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PV/bootloader_args field of the given VM.

func (AsyncVMClass) SetPVKernel 

func (_class AsyncVMClass) SetPVKernel(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PV/kernel field of the given VM.

func (AsyncVMClass) SetPVLegacyArgs 

func (_class AsyncVMClass) SetPVLegacyArgs(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PV/legacy_args field of the given VM.

func (AsyncVMClass) SetPVRamdisk 

func (_class AsyncVMClass) SetPVRamdisk(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the PV/ramdisk field of the given VM.

func (AsyncVMClass) SetPlatform 

func (_class AsyncVMClass) SetPlatform(sessionID SessionRef, self VMRef, value map[string]string) (_retval TaskRef, _err error)

Set the platform field of the given VM.

func (AsyncVMClass) SetProtectionPolicy 

func (_class AsyncVMClass) SetProtectionPolicy(sessionID SessionRef, self VMRef, value VMPPRef) (_retval TaskRef, _err error)

Set the value of the protection_policy field

func (AsyncVMClass) SetRecommendations 

func (_class AsyncVMClass) SetRecommendations(sessionID SessionRef, self VMRef, value string) (_retval TaskRef, _err error)

Set the recommendations field of the given VM.

func (AsyncVMClass) SetShadowMultiplierLive 

func (_class AsyncVMClass) SetShadowMultiplierLive(sessionID SessionRef, self VMRef, multiplier float64) (_retval TaskRef, _err error)

Set the shadow memory multiplier on a running VM

func (AsyncVMClass) SetShutdownDelay 

func (_class AsyncVMClass) SetShutdownDelay(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set this VM's shutdown delay in seconds

func (AsyncVMClass) SetStartDelay 

func (_class AsyncVMClass) SetStartDelay(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set this VM's start delay in seconds

func (AsyncVMClass) SetSuspendSR 

func (_class AsyncVMClass) SetSuspendSR(sessionID SessionRef, self VMRef, value SRRef) (_retval TaskRef, _err error)

Set the suspend_SR field of the given VM.

func (AsyncVMClass) SetSuspendVDI 

func (_class AsyncVMClass) SetSuspendVDI(sessionID SessionRef, self VMRef, value VDIRef) (_retval TaskRef, _err error)

Set this VM's suspend VDI, which must be indentical to its current one

func (AsyncVMClass) SetTags 

func (_class AsyncVMClass) SetTags(sessionID SessionRef, self VMRef, value []string) (_retval TaskRef, _err error)

Set the tags field of the given VM.

func (AsyncVMClass) SetUserVersion 

func (_class AsyncVMClass) SetUserVersion(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the user_version field of the given VM.

func (AsyncVMClass) SetVCPUsAtStartup 

func (_class AsyncVMClass) SetVCPUsAtStartup(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the number of startup VCPUs for a halted VM

func (AsyncVMClass) SetVCPUsMax 

func (_class AsyncVMClass) SetVCPUsMax(sessionID SessionRef, self VMRef, value int) (_retval TaskRef, _err error)

Set the maximum number of VCPUs for a halted VM

func (AsyncVMClass) SetVCPUsNumberLive 

func (_class AsyncVMClass) SetVCPUsNumberLive(sessionID SessionRef, self VMRef, nvcpu int) (_retval TaskRef, _err error)

Set the number of VCPUs for a running VM

func (AsyncVMClass) SetVCPUsParams 

func (_class AsyncVMClass) SetVCPUsParams(sessionID SessionRef, self VMRef, value map[string]string) (_retval TaskRef, _err error)

Set the VCPUs/params field of the given VM.

func (AsyncVMClass) SetXenstoreData 

func (_class AsyncVMClass) SetXenstoreData(sessionID SessionRef, self VMRef, value map[string]string) (_retval TaskRef, _err error)

Set the xenstore_data field of the given VM.

func (AsyncVMClass) Shutdown 

func (_class AsyncVMClass) Shutdown(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) Snapshot 

func (_class AsyncVMClass) Snapshot(sessionID SessionRef, vm VMRef, newName string) (_retval TaskRef, _err error)

Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (AsyncVMClass) SnapshotWithQuiesce 

func (_class AsyncVMClass) SnapshotWithQuiesce(sessionID SessionRef, vm VMRef, newName string) (_retval TaskRef, _err error)

Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_SNAPSHOT_WITH_QUIESCE_FAILED - The quiesced-snapshot operation failed for an unexpected reason
VM_SNAPSHOT_WITH_QUIESCE_TIMEOUT - The VSS plug-in has timed out
VM_SNAPSHOT_WITH_QUIESCE_PLUGIN_DEOS_NOT_RESPOND - The VSS plug-in cannot be contacted
VM_SNAPSHOT_WITH_QUIESCE_NOT_SUPPORTED - The VSS plug-in is not installed on this virtual machine

func (AsyncVMClass) Start 

func (_class AsyncVMClass) Start(sessionID SessionRef, vm VMRef, startPaused bool, force bool) (_retval TaskRef, _err error)

Start the specified VM. This function can only be called with the VM is in the Halted State.

Errors: 

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 state at the time of the call.
VM_HVM_REQUIRED - HVM is required for this operation
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
BOOTLOADER_FAILED - The bootloader returned an error
UNKNOWN_BOOTLOADER - The requested bootloader is unknown
NO_HOSTS_AVAILABLE - There were no hosts available to complete the specified operation.
LICENCE_RESTRICTION - This operation is not allowed under your license.  Please contact your support representative.

func (AsyncVMClass) StartOn 

func (_class AsyncVMClass) StartOn(sessionID SessionRef, vm VMRef, host HostRef, startPaused bool, force bool) (_retval TaskRef, _err error)

Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State.

Errors: 

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 state at the time of the call.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
BOOTLOADER_FAILED - The bootloader returned an error
UNKNOWN_BOOTLOADER - The requested bootloader is unknown

func (AsyncVMClass) Suspend 

func (_class AsyncVMClass) Suspend(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) Unpause 

func (_class AsyncVMClass) Unpause(sessionID SessionRef, vm VMRef) (_retval TaskRef, _err error)

Resume the specified VM. This can only be called when the specified VM is in the Paused state.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (AsyncVMClass) UpdateAllowedOperations 

func (_class AsyncVMClass) UpdateAllowedOperations(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Recomputes the list of acceptable operations

func (AsyncVMClass) WaitMemoryTargetLive 

func (_class AsyncVMClass) WaitMemoryTargetLive(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Wait for a running VM to reach its current memory target

func (AsyncVMClass) XenprepStart 

func (_class AsyncVMClass) XenprepStart(sessionID SessionRef, self VMRef) (_retval TaskRef, _err error)

Start the 'xenprep' process on the VM; the process will remove any tools and drivers for XenServer and then set auto update drivers true.

type AsyncVMGuestMetricsClass 

type AsyncVMGuestMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics reported by the guest (as opposed to inferred from outside)

func (AsyncVMGuestMetricsClass) AddToOtherConfig 

func (_class AsyncVMGuestMetricsClass) AddToOtherConfig(sessionID SessionRef, self VMGuestMetricsRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetAll 

func (_class AsyncVMGuestMetricsClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VM_guest_metrics instances known to the system.

func (AsyncVMGuestMetricsClass) GetAllRecords 

func (_class AsyncVMGuestMetricsClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VM_guest_metrics references to VM_guest_metrics records for all VM_guest_metrics instances known to the system.

func (AsyncVMGuestMetricsClass) GetByUUID 

func (_class AsyncVMGuestMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VM_guest_metrics instance with the specified UUID.

func (AsyncVMGuestMetricsClass) GetDisks 

func (_class AsyncVMGuestMetricsClass) GetDisks(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the disks field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetLastUpdated 

func (_class AsyncVMGuestMetricsClass) GetLastUpdated(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the last_updated field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetLive 

func (_class AsyncVMGuestMetricsClass) GetLive(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the live field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetMemory 

func (_class AsyncVMGuestMetricsClass) GetMemory(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the memory field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetNetworkPathsOptimized 

func (_class AsyncVMGuestMetricsClass) GetNetworkPathsOptimized(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the network_paths_optimized field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetNetworks 

func (_class AsyncVMGuestMetricsClass) GetNetworks(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the networks field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetOsVersion 

func (_class AsyncVMGuestMetricsClass) GetOsVersion(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the os_version field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetOther 

func (_class AsyncVMGuestMetricsClass) GetOther(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the other field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetOtherConfig 

func (_class AsyncVMGuestMetricsClass) GetOtherConfig(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the other_config field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetPVDriversUpToDate 

func (_class AsyncVMGuestMetricsClass) GetPVDriversUpToDate(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the PV_drivers_up_to_date field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetPVDriversVersion 

func (_class AsyncVMGuestMetricsClass) GetPVDriversVersion(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the PV_drivers_version field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetRecord 

func (_class AsyncVMGuestMetricsClass) GetRecord(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetStoragePathsOptimized 

func (_class AsyncVMGuestMetricsClass) GetStoragePathsOptimized(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the storage_paths_optimized field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) GetUUID 

func (_class AsyncVMGuestMetricsClass) GetUUID(sessionID SessionRef, self VMGuestMetricsRef) (_retval TaskRef, _err error)

Get the uuid field of the given VM_guest_metrics.

func (AsyncVMGuestMetricsClass) RemoveFromOtherConfig 

func (_class AsyncVMGuestMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VMGuestMetricsRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given VM_guest_metrics. If the key is not in that Map, then do nothing.

func (AsyncVMGuestMetricsClass) SetOtherConfig 

func (_class AsyncVMGuestMetricsClass) SetOtherConfig(sessionID SessionRef, self VMGuestMetricsRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VM_guest_metrics.

type AsyncVMMetricsClass 

type AsyncVMMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a VM

func (AsyncVMMetricsClass) AddToOtherConfig 

func (_class AsyncVMMetricsClass) AddToOtherConfig(sessionID SessionRef, self VMMetricsRef, key string, value string) (_retval TaskRef, _err error)

Add the given key-value pair to the other_config field of the given VM_metrics.

func (AsyncVMMetricsClass) GetAll 

func (_class AsyncVMMetricsClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VM_metrics instances known to the system.

func (AsyncVMMetricsClass) GetAllRecords 

func (_class AsyncVMMetricsClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VM_metrics references to VM_metrics records for all VM_metrics instances known to the system.

func (AsyncVMMetricsClass) GetByUUID 

func (_class AsyncVMMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VM_metrics instance with the specified UUID.

func (AsyncVMMetricsClass) GetInstallTime 

func (_class AsyncVMMetricsClass) GetInstallTime(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the install_time field of the given VM_metrics.

func (AsyncVMMetricsClass) GetLastUpdated 

func (_class AsyncVMMetricsClass) GetLastUpdated(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the last_updated field of the given VM_metrics.

func (AsyncVMMetricsClass) GetMemoryActual 

func (_class AsyncVMMetricsClass) GetMemoryActual(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the memory/actual field of the given VM_metrics.

func (AsyncVMMetricsClass) GetOtherConfig 

func (_class AsyncVMMetricsClass) GetOtherConfig(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the other_config field of the given VM_metrics.

func (AsyncVMMetricsClass) GetRecord 

func (_class AsyncVMMetricsClass) GetRecord(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VM_metrics.

func (AsyncVMMetricsClass) GetStartTime 

func (_class AsyncVMMetricsClass) GetStartTime(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the start_time field of the given VM_metrics.

func (AsyncVMMetricsClass) GetState 

func (_class AsyncVMMetricsClass) GetState(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the state field of the given VM_metrics.

func (AsyncVMMetricsClass) GetUUID 

func (_class AsyncVMMetricsClass) GetUUID(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the uuid field of the given VM_metrics.

func (AsyncVMMetricsClass) GetVCPUsCPU 

func (_class AsyncVMMetricsClass) GetVCPUsCPU(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the VCPUs/CPU field of the given VM_metrics.

func (AsyncVMMetricsClass) GetVCPUsFlags 

func (_class AsyncVMMetricsClass) GetVCPUsFlags(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the VCPUs/flags field of the given VM_metrics.

func (AsyncVMMetricsClass) GetVCPUsNumber 

func (_class AsyncVMMetricsClass) GetVCPUsNumber(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the VCPUs/number field of the given VM_metrics.

func (AsyncVMMetricsClass) GetVCPUsParams 

func (_class AsyncVMMetricsClass) GetVCPUsParams(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the VCPUs/params field of the given VM_metrics.

func (AsyncVMMetricsClass) GetVCPUsUtilisation 

func (_class AsyncVMMetricsClass) GetVCPUsUtilisation(sessionID SessionRef, self VMMetricsRef) (_retval TaskRef, _err error)

Get the VCPUs/utilisation field of the given VM_metrics.

func (AsyncVMMetricsClass) RemoveFromOtherConfig 

func (_class AsyncVMMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VMMetricsRef, key string) (_retval TaskRef, _err error)

Remove the given key and its corresponding value from the other_config field of the given VM_metrics. If the key is not in that Map, then do nothing.

func (AsyncVMMetricsClass) SetOtherConfig 

func (_class AsyncVMMetricsClass) SetOtherConfig(sessionID SessionRef, self VMMetricsRef, value map[string]string) (_retval TaskRef, _err error)

Set the other_config field of the given VM_metrics.

type AsyncVMPPClass 

type AsyncVMPPClass struct {
	// contains filtered or unexported fields
}

VM Protection Policy

func (AsyncVMPPClass) AddToAlarmConfig 

func (_class AsyncVMPPClass) AddToAlarmConfig(sessionID SessionRef, self VMPPRef, key string, value string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) AddToArchiveSchedule 

func (_class AsyncVMPPClass) AddToArchiveSchedule(sessionID SessionRef, self VMPPRef, key string, value string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) AddToArchiveTargetConfig 

func (_class AsyncVMPPClass) AddToArchiveTargetConfig(sessionID SessionRef, self VMPPRef, key string, value string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) AddToBackupSchedule 

func (_class AsyncVMPPClass) AddToBackupSchedule(sessionID SessionRef, self VMPPRef, key string, value string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) ArchiveNow 

func (_class AsyncVMPPClass) ArchiveNow(sessionID SessionRef, snapshot VMRef) (_retval TaskRef, _err error)

This call archives the snapshot provided as a parameter

func (AsyncVMPPClass) Create 

func (_class AsyncVMPPClass) Create(sessionID SessionRef, args VMPPRecord) (_retval TaskRef, _err error)

Create a new VMPP instance, and return its handle. The constructor args are: name_label, name_description, is_policy_enabled, backup_type, backup_retention_value, backup_frequency, backup_schedule, archive_target_type, archive_target_config, archive_frequency, archive_schedule, is_alarm_enabled, alarm_config (* = non-optional).

func (AsyncVMPPClass) Destroy 

func (_class AsyncVMPPClass) Destroy(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Destroy the specified VMPP instance.

func (AsyncVMPPClass) GetAlarmConfig 

func (_class AsyncVMPPClass) GetAlarmConfig(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the alarm_config field of the given VMPP.

func (AsyncVMPPClass) GetAlerts 

func (_class AsyncVMPPClass) GetAlerts(sessionID SessionRef, vmpp VMPPRef, hoursFromNow int) (_retval TaskRef, _err error)

This call fetches a history of alerts for a given protection policy

func (AsyncVMPPClass) GetAll 

func (_class AsyncVMPPClass) GetAll(sessionID SessionRef) (_retval TaskRef, _err error)

Return a list of all the VMPPs known to the system.

func (AsyncVMPPClass) GetAllRecords 

func (_class AsyncVMPPClass) GetAllRecords(sessionID SessionRef) (_retval TaskRef, _err error)

Return a map of VMPP references to VMPP records for all VMPPs known to the system.

func (AsyncVMPPClass) GetArchiveFrequency 

func (_class AsyncVMPPClass) GetArchiveFrequency(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the archive_frequency field of the given VMPP.

func (AsyncVMPPClass) GetArchiveLastRunTime 

func (_class AsyncVMPPClass) GetArchiveLastRunTime(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the archive_last_run_time field of the given VMPP.

func (AsyncVMPPClass) GetArchiveSchedule 

func (_class AsyncVMPPClass) GetArchiveSchedule(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the archive_schedule field of the given VMPP.

func (AsyncVMPPClass) GetArchiveTargetConfig 

func (_class AsyncVMPPClass) GetArchiveTargetConfig(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the archive_target_config field of the given VMPP.

func (AsyncVMPPClass) GetArchiveTargetType 

func (_class AsyncVMPPClass) GetArchiveTargetType(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the archive_target_type field of the given VMPP.

func (AsyncVMPPClass) GetBackupFrequency 

func (_class AsyncVMPPClass) GetBackupFrequency(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the backup_frequency field of the given VMPP.

func (AsyncVMPPClass) GetBackupLastRunTime 

func (_class AsyncVMPPClass) GetBackupLastRunTime(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the backup_last_run_time field of the given VMPP.

func (AsyncVMPPClass) GetBackupRetentionValue 

func (_class AsyncVMPPClass) GetBackupRetentionValue(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the backup_retention_value field of the given VMPP.

func (AsyncVMPPClass) GetBackupSchedule 

func (_class AsyncVMPPClass) GetBackupSchedule(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the backup_schedule field of the given VMPP.

func (AsyncVMPPClass) GetBackupType 

func (_class AsyncVMPPClass) GetBackupType(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the backup_type field of the given VMPP.

func (AsyncVMPPClass) GetByNameLabel 

func (_class AsyncVMPPClass) GetByNameLabel(sessionID SessionRef, label string) (_retval TaskRef, _err error)

Get all the VMPP instances with the given label.

func (AsyncVMPPClass) GetByUUID 

func (_class AsyncVMPPClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VMPP instance with the specified UUID.

func (AsyncVMPPClass) GetIsAlarmEnabled 

func (_class AsyncVMPPClass) GetIsAlarmEnabled(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the is_alarm_enabled field of the given VMPP.

func (AsyncVMPPClass) GetIsArchiveRunning 

func (_class AsyncVMPPClass) GetIsArchiveRunning(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the is_archive_running field of the given VMPP.

func (AsyncVMPPClass) GetIsBackupRunning 

func (_class AsyncVMPPClass) GetIsBackupRunning(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the is_backup_running field of the given VMPP.

func (AsyncVMPPClass) GetIsPolicyEnabled 

func (_class AsyncVMPPClass) GetIsPolicyEnabled(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the is_policy_enabled field of the given VMPP.

func (AsyncVMPPClass) GetNameDescription 

func (_class AsyncVMPPClass) GetNameDescription(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the name/description field of the given VMPP.

func (AsyncVMPPClass) GetNameLabel 

func (_class AsyncVMPPClass) GetNameLabel(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the name/label field of the given VMPP.

func (AsyncVMPPClass) GetRecentAlerts 

func (_class AsyncVMPPClass) GetRecentAlerts(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the recent_alerts field of the given VMPP.

func (AsyncVMPPClass) GetRecord 

func (_class AsyncVMPPClass) GetRecord(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VMPP.

func (AsyncVMPPClass) GetUUID 

func (_class AsyncVMPPClass) GetUUID(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the uuid field of the given VMPP.

func (AsyncVMPPClass) GetVMs 

func (_class AsyncVMPPClass) GetVMs(sessionID SessionRef, self VMPPRef) (_retval TaskRef, _err error)

Get the VMs field of the given VMPP.

func (AsyncVMPPClass) ProtectNow 

func (_class AsyncVMPPClass) ProtectNow(sessionID SessionRef, vmpp VMPPRef) (_retval TaskRef, _err error)

This call executes the protection policy immediately

func (AsyncVMPPClass) RemoveFromAlarmConfig 

func (_class AsyncVMPPClass) RemoveFromAlarmConfig(sessionID SessionRef, self VMPPRef, key string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) RemoveFromArchiveSchedule 

func (_class AsyncVMPPClass) RemoveFromArchiveSchedule(sessionID SessionRef, self VMPPRef, key string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) RemoveFromArchiveTargetConfig 

func (_class AsyncVMPPClass) RemoveFromArchiveTargetConfig(sessionID SessionRef, self VMPPRef, key string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) RemoveFromBackupSchedule 

func (_class AsyncVMPPClass) RemoveFromBackupSchedule(sessionID SessionRef, self VMPPRef, key string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetAlarmConfig 

func (_class AsyncVMPPClass) SetAlarmConfig(sessionID SessionRef, self VMPPRef, value map[string]string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetArchiveFrequency 

func (_class AsyncVMPPClass) SetArchiveFrequency(sessionID SessionRef, self VMPPRef, value VmppArchiveFrequency) (_retval TaskRef, _err error)

Set the value of the archive_frequency field

func (AsyncVMPPClass) SetArchiveLastRunTime 

func (_class AsyncVMPPClass) SetArchiveLastRunTime(sessionID SessionRef, self VMPPRef, value time.Time) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetArchiveSchedule 

func (_class AsyncVMPPClass) SetArchiveSchedule(sessionID SessionRef, self VMPPRef, value map[string]string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetArchiveTargetConfig 

func (_class AsyncVMPPClass) SetArchiveTargetConfig(sessionID SessionRef, self VMPPRef, value map[string]string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetArchiveTargetType 

func (_class AsyncVMPPClass) SetArchiveTargetType(sessionID SessionRef, self VMPPRef, value VmppArchiveTargetType) (_retval TaskRef, _err error)

Set the value of the archive_target_config_type field

func (AsyncVMPPClass) SetBackupFrequency 

func (_class AsyncVMPPClass) SetBackupFrequency(sessionID SessionRef, self VMPPRef, value VmppBackupFrequency) (_retval TaskRef, _err error)

Set the value of the backup_frequency field

func (AsyncVMPPClass) SetBackupLastRunTime 

func (_class AsyncVMPPClass) SetBackupLastRunTime(sessionID SessionRef, self VMPPRef, value time.Time) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetBackupRetentionValue 

func (_class AsyncVMPPClass) SetBackupRetentionValue(sessionID SessionRef, self VMPPRef, value int) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetBackupSchedule 

func (_class AsyncVMPPClass) SetBackupSchedule(sessionID SessionRef, self VMPPRef, value map[string]string) (_retval TaskRef, _err error)

func (AsyncVMPPClass) SetBackupType 

func (_class AsyncVMPPClass) SetBackupType(sessionID SessionRef, self VMPPRef, value VmppBackupType) (_retval TaskRef, _err error)

Set the backup_type field of the given VMPP.

func (AsyncVMPPClass) SetIsAlarmEnabled 

func (_class AsyncVMPPClass) SetIsAlarmEnabled(sessionID SessionRef, self VMPPRef, value bool) (_retval TaskRef, _err error)

Set the value of the is_alarm_enabled field

func (AsyncVMPPClass) SetIsPolicyEnabled 

func (_class AsyncVMPPClass) SetIsPolicyEnabled(sessionID SessionRef, self VMPPRef, value bool) (_retval TaskRef, _err error)

Set the is_policy_enabled field of the given VMPP.

func (AsyncVMPPClass) SetNameDescription 

func (_class AsyncVMPPClass) SetNameDescription(sessionID SessionRef, self VMPPRef, value string) (_retval TaskRef, _err error)

Set the name/description field of the given VMPP.

func (AsyncVMPPClass) SetNameLabel 

func (_class AsyncVMPPClass) SetNameLabel(sessionID SessionRef, self VMPPRef, value string) (_retval TaskRef, _err error)

Set the name/label field of the given VMPP.

type AsyncVTPMClass 

type AsyncVTPMClass struct {
	// contains filtered or unexported fields
}

A virtual TPM device

func (AsyncVTPMClass) Create 

func (_class AsyncVTPMClass) Create(sessionID SessionRef, args VTPMRecord) (_retval TaskRef, _err error)

Create a new VTPM instance, and return its handle. The constructor args are: VM*, backend* (* = non-optional).

func (AsyncVTPMClass) Destroy 

func (_class AsyncVTPMClass) Destroy(sessionID SessionRef, self VTPMRef) (_retval TaskRef, _err error)

Destroy the specified VTPM instance.

func (AsyncVTPMClass) GetBackend 

func (_class AsyncVTPMClass) GetBackend(sessionID SessionRef, self VTPMRef) (_retval TaskRef, _err error)

Get the backend field of the given VTPM.

func (AsyncVTPMClass) GetByUUID 

func (_class AsyncVTPMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the VTPM instance with the specified UUID.

func (AsyncVTPMClass) GetRecord 

func (_class AsyncVTPMClass) GetRecord(sessionID SessionRef, self VTPMRef) (_retval TaskRef, _err error)

Get a record containing the current state of the given VTPM.

func (AsyncVTPMClass) GetUUID 

func (_class AsyncVTPMClass) GetUUID(sessionID SessionRef, self VTPMRef) (_retval TaskRef, _err error)

Get the uuid field of the given VTPM.

func (AsyncVTPMClass) GetVM 

func (_class AsyncVTPMClass) GetVM(sessionID SessionRef, self VTPMRef) (_retval TaskRef, _err error)

Get the VM field of the given VTPM.

type AuthClass 

type AuthClass struct {
	// contains filtered or unexported fields
}

Management of remote authentication services

func (AuthClass) GetGroupMembership 

func (_class AuthClass) GetGroupMembership(sessionID SessionRef, subjectIdentifier string) (_retval []string, _err error)

This calls queries the external directory service to obtain the transitively-closed set of groups that the the subject_identifier is member of.

func (AuthClass) GetSubjectIdentifier 

func (_class AuthClass) GetSubjectIdentifier(sessionID SessionRef, subjectName string) (_retval string, _err error)

This call queries the external directory service to obtain the subject_identifier as a string from the human-readable subject_name

func (AuthClass) GetSubjectInformationFromIdentifier 

func (_class AuthClass) GetSubjectInformationFromIdentifier(sessionID SessionRef, subjectIdentifier string) (_retval map[string]string, _err error)

This call queries the external directory service to obtain the user information (e.g. username, organization etc) from the specified subject_identifier

type AuthRef 

type AuthRef string

type BlobClass 

type BlobClass struct {
	// contains filtered or unexported fields
}

A placeholder for a binary blob

func (BlobClass) Create 

func (_class BlobClass) Create(sessionID SessionRef, mimeType string, public bool) (_retval BlobRef, _err error)

Create a placeholder for a binary blob

func (BlobClass) Destroy 

func (_class BlobClass) Destroy(sessionID SessionRef, self BlobRef) (_err error)

func (BlobClass) GetAll 

func (_class BlobClass) GetAll(sessionID SessionRef) (_retval []BlobRef, _err error)

Return a list of all the blobs known to the system.

func (BlobClass) GetAllRecords 

func (_class BlobClass) GetAllRecords(sessionID SessionRef) (_retval map[BlobRef]BlobRecord, _err error)

Return a map of blob references to blob records for all blobs known to the system.

func (BlobClass) GetByNameLabel 

func (_class BlobClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []BlobRef, _err error)

Get all the blob instances with the given label.

func (BlobClass) GetByUUID 

func (_class BlobClass) GetByUUID(sessionID SessionRef, uuid string) (_retval BlobRef, _err error)

Get a reference to the blob instance with the specified UUID.

func (BlobClass) GetLastUpdated 

func (_class BlobClass) GetLastUpdated(sessionID SessionRef, self BlobRef) (_retval time.Time, _err error)

Get the last_updated field of the given blob.

func (BlobClass) GetMimeType 

func (_class BlobClass) GetMimeType(sessionID SessionRef, self BlobRef) (_retval string, _err error)

Get the mime_type field of the given blob.

func (BlobClass) GetNameDescription 

func (_class BlobClass) GetNameDescription(sessionID SessionRef, self BlobRef) (_retval string, _err error)

Get the name/description field of the given blob.

func (BlobClass) GetNameLabel 

func (_class BlobClass) GetNameLabel(sessionID SessionRef, self BlobRef) (_retval string, _err error)

Get the name/label field of the given blob.

func (BlobClass) GetPublic 

func (_class BlobClass) GetPublic(sessionID SessionRef, self BlobRef) (_retval bool, _err error)

Get the public field of the given blob.

func (BlobClass) GetRecord 

func (_class BlobClass) GetRecord(sessionID SessionRef, self BlobRef) (_retval BlobRecord, _err error)

Get a record containing the current state of the given blob.

func (BlobClass) GetSize 

func (_class BlobClass) GetSize(sessionID SessionRef, self BlobRef) (_retval int, _err error)

Get the size field of the given blob.

func (BlobClass) GetUUID 

func (_class BlobClass) GetUUID(sessionID SessionRef, self BlobRef) (_retval string, _err error)

Get the uuid field of the given blob.

func (BlobClass) SetNameDescription 

func (_class BlobClass) SetNameDescription(sessionID SessionRef, self BlobRef, value string) (_err error)

Set the name/description field of the given blob.

func (BlobClass) SetNameLabel 

func (_class BlobClass) SetNameLabel(sessionID SessionRef, self BlobRef, value string) (_err error)

Set the name/label field of the given blob.

func (BlobClass) SetPublic 

func (_class BlobClass) SetPublic(sessionID SessionRef, self BlobRef, value bool) (_err error)

Set the public field of the given blob.

type BlobRecord 

type BlobRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Size of the binary data, in bytes
	Size int
	// True if the blob is publicly accessible
	Public bool
	// Time at which the data in the blob was last updated
	LastUpdated time.Time
	// The mime type associated with this object. Defaults to 'application/octet-stream' if the empty string is supplied
	MimeType string
}

type BlobRef 

type BlobRef string

type BondClass 

type BondClass struct {
	// contains filtered or unexported fields
}

func (BondClass) AddToOtherConfig 

func (_class BondClass) AddToOtherConfig(sessionID SessionRef, self BondRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given Bond.

func (BondClass) Create 

func (_class BondClass) Create(sessionID SessionRef, network NetworkRef, members []PIFRef, mac string, mode BondMode, properties map[string]string) (_retval BondRef, _err error)

Create an interface bond

func (BondClass) Destroy 

func (_class BondClass) Destroy(sessionID SessionRef, self BondRef) (_err error)

Destroy an interface bond

func (BondClass) GetAll 

func (_class BondClass) GetAll(sessionID SessionRef) (_retval []BondRef, _err error)

Return a list of all the Bonds known to the system.

func (BondClass) GetAllRecords 

func (_class BondClass) GetAllRecords(sessionID SessionRef) (_retval map[BondRef]BondRecord, _err error)

Return a map of Bond references to Bond records for all Bonds known to the system.

func (BondClass) GetByUUID 

func (_class BondClass) GetByUUID(sessionID SessionRef, uuid string) (_retval BondRef, _err error)

Get a reference to the Bond instance with the specified UUID.

func (BondClass) GetLinksUp 

func (_class BondClass) GetLinksUp(sessionID SessionRef, self BondRef) (_retval int, _err error)

Get the links_up field of the given Bond.

func (BondClass) GetMaster 

func (_class BondClass) GetMaster(sessionID SessionRef, self BondRef) (_retval PIFRef, _err error)

Get the master field of the given Bond.

func (BondClass) GetMode 

func (_class BondClass) GetMode(sessionID SessionRef, self BondRef) (_retval BondMode, _err error)

Get the mode field of the given Bond.

func (BondClass) GetOtherConfig 

func (_class BondClass) GetOtherConfig(sessionID SessionRef, self BondRef) (_retval map[string]string, _err error)

Get the other_config field of the given Bond.

func (BondClass) GetPrimarySlave 

func (_class BondClass) GetPrimarySlave(sessionID SessionRef, self BondRef) (_retval PIFRef, _err error)

Get the primary_slave field of the given Bond.

func (BondClass) GetProperties 

func (_class BondClass) GetProperties(sessionID SessionRef, self BondRef) (_retval map[string]string, _err error)

Get the properties field of the given Bond.

func (BondClass) GetRecord 

func (_class BondClass) GetRecord(sessionID SessionRef, self BondRef) (_retval BondRecord, _err error)

Get a record containing the current state of the given Bond.

func (BondClass) GetSlaves 

func (_class BondClass) GetSlaves(sessionID SessionRef, self BondRef) (_retval []PIFRef, _err error)

Get the slaves field of the given Bond.

func (BondClass) GetUUID 

func (_class BondClass) GetUUID(sessionID SessionRef, self BondRef) (_retval string, _err error)

Get the uuid field of the given Bond.

func (BondClass) RemoveFromOtherConfig 

func (_class BondClass) RemoveFromOtherConfig(sessionID SessionRef, self BondRef, key string) (_err error)

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.

func (BondClass) SetMode 

func (_class BondClass) SetMode(sessionID SessionRef, self BondRef, value BondMode) (_err error)

Change the bond mode

func (BondClass) SetOtherConfig 

func (_class BondClass) SetOtherConfig(sessionID SessionRef, self BondRef, value map[string]string) (_err error)

Set the other_config field of the given Bond.

func (BondClass) SetProperty 

func (_class BondClass) SetProperty(sessionID SessionRef, self BondRef, name string, value string) (_err error)

Set the value of a property of the bond

type BondMode 

type BondMode string
const (
	// Source-level balancing
	BondModeBalanceSlb BondMode = "balance-slb"
	// Active/passive bonding: only one NIC is carrying traffic
	BondModeActiveBackup BondMode = "active-backup"
	// Link aggregation control protocol
	BondModeLacp BondMode = "lacp"
)

type BondRecord 

type BondRecord struct {
	// Unique identifier/object reference
	UUID string
	// The bonded interface
	Master PIFRef
	// The interfaces which are part of this bond
	Slaves []PIFRef
	// additional configuration
	OtherConfig map[string]string
	// The PIF of which the IP configuration and MAC were copied to the bond, and which will receive all configuration/VLANs/VIFs on the bond if the bond is destroyed
	PrimarySlave PIFRef
	// The algorithm used to distribute traffic among the bonded NICs
	Mode BondMode
	// Additional configuration properties specific to the bond mode.
	Properties map[string]string
	// Number of links up in this bond
	LinksUp int
}

type BondRef 

type BondRef string

type Client 

type Client struct {
	Session        SessionClass
	Auth           AuthClass
	Subject        SubjectClass
	Role           RoleClass
	Task           TaskClass
	Event          EventClass
	Pool           PoolClass
	PoolPatch      PoolPatchClass
	VM             VMClass
	VMMetrics      VMMetricsClass
	VMGuestMetrics VMGuestMetricsClass
	VMPP           VMPPClass
	VMAppliance    VMApplianceClass
	DRTask         DRTaskClass
	Host           HostClass
	HostCrashdump  HostCrashdumpClass
	HostPatch      HostPatchClass
	HostMetrics    HostMetricsClass
	HostCPU        HostCPUClass
	Network        NetworkClass
	VIF            VIFClass
	VIFMetrics     VIFMetricsClass
	PIF            PIFClass
	PIFMetrics     PIFMetricsClass
	Bond           BondClass
	VLAN           VLANClass
	SM             SMClass
	SR             SRClass
	VDI            VDIClass
	VBD            VBDClass
	VBDMetrics     VBDMetricsClass
	PBD            PBDClass
	Crashdump      CrashdumpClass
	VTPM           VTPMClass
	Console        ConsoleClass
	User           UserClass
	DataSource     DataSourceClass
	Blob           BlobClass
	Message        MessageClass
	Secret         SecretClass
	Tunnel         TunnelClass
	PCI            PCIClass
	PGPU           PGPUClass
	GPUGroup       GPUGroupClass
	VGPU           VGPUClass
	VGPUType       VGPUTypeClass
	Async          struct {
		Session        AsyncSessionClass
		Auth           AsyncAuthClass
		Subject        AsyncSubjectClass
		Role           AsyncRoleClass
		Task           AsyncTaskClass
		Event          AsyncEventClass
		Pool           AsyncPoolClass
		PoolPatch      AsyncPoolPatchClass
		VM             AsyncVMClass
		VMMetrics      AsyncVMMetricsClass
		VMGuestMetrics AsyncVMGuestMetricsClass
		VMPP           AsyncVMPPClass
		VMAppliance    AsyncVMApplianceClass
		DRTask         AsyncDRTaskClass
		Host           AsyncHostClass
		HostCrashdump  AsyncHostCrashdumpClass
		HostPatch      AsyncHostPatchClass
		HostMetrics    AsyncHostMetricsClass
		HostCPU        AsyncHostCPUClass
		Network        AsyncNetworkClass
		VIF            AsyncVIFClass
		VIFMetrics     AsyncVIFMetricsClass
		PIF            AsyncPIFClass
		PIFMetrics     AsyncPIFMetricsClass
		Bond           AsyncBondClass
		VLAN           AsyncVLANClass
		SM             AsyncSMClass
		SR             AsyncSRClass
		VDI            AsyncVDIClass
		VBD            AsyncVBDClass
		VBDMetrics     AsyncVBDMetricsClass
		PBD            AsyncPBDClass
		Crashdump      AsyncCrashdumpClass
		VTPM           AsyncVTPMClass
		Console        AsyncConsoleClass
		User           AsyncUserClass
		DataSource     AsyncDataSourceClass
		Blob           AsyncBlobClass
		Message        AsyncMessageClass
		Secret         AsyncSecretClass
		Tunnel         AsyncTunnelClass
		PCI            AsyncPCIClass
		PGPU           AsyncPGPUClass
		GPUGroup       AsyncGPUGroupClass
		VGPU           AsyncVGPUClass
		VGPUType       AsyncVGPUTypeClass
	}
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(url string, transport *http.Transport) (*Client, error)

func NewClientTimeout 

func NewClientTimeout(url string, transport *http.Transport, timeout time.Duration) (*Client, error)

func (*Client) APICall 

func (client *Client) APICall(method string, params ...interface{}) (result APIResult, err error)

func (*Client) Close 

func (client *Client) Close() (err error)

Close closes close the xapi connection

type Cls 

type Cls string
const (
	// VM
	ClsVM Cls = "VM"
	// Host
	ClsHost Cls = "Host"
	// SR
	ClsSR Cls = "SR"
	// Pool
	ClsPool Cls = "Pool"
	// VMPP
	ClsVMPP Cls = "VMPP"
)

type ConsoleClass 

type ConsoleClass struct {
	// contains filtered or unexported fields
}

A console

func (ConsoleClass) AddToOtherConfig 

func (_class ConsoleClass) AddToOtherConfig(sessionID SessionRef, self ConsoleRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given console.

func (ConsoleClass) Create 

func (_class ConsoleClass) Create(sessionID SessionRef, args ConsoleRecord) (_retval ConsoleRef, _err error)

Create a new console instance, and return its handle. The constructor args are: other_config* (* = non-optional).

func (ConsoleClass) Destroy 

func (_class ConsoleClass) Destroy(sessionID SessionRef, self ConsoleRef) (_err error)

Destroy the specified console instance.

func (ConsoleClass) GetAll 

func (_class ConsoleClass) GetAll(sessionID SessionRef) (_retval []ConsoleRef, _err error)

Return a list of all the consoles known to the system.

func (ConsoleClass) GetAllRecords 

func (_class ConsoleClass) GetAllRecords(sessionID SessionRef) (_retval map[ConsoleRef]ConsoleRecord, _err error)

Return a map of console references to console records for all consoles known to the system.

func (ConsoleClass) GetByUUID 

func (_class ConsoleClass) GetByUUID(sessionID SessionRef, uuid string) (_retval ConsoleRef, _err error)

Get a reference to the console instance with the specified UUID.

func (ConsoleClass) GetLocation 

func (_class ConsoleClass) GetLocation(sessionID SessionRef, self ConsoleRef) (_retval string, _err error)

Get the location field of the given console.

func (ConsoleClass) GetOtherConfig 

func (_class ConsoleClass) GetOtherConfig(sessionID SessionRef, self ConsoleRef) (_retval map[string]string, _err error)

Get the other_config field of the given console.

func (ConsoleClass) GetProtocol 

func (_class ConsoleClass) GetProtocol(sessionID SessionRef, self ConsoleRef) (_retval ConsoleProtocol, _err error)

Get the protocol field of the given console.

func (ConsoleClass) GetRecord 

func (_class ConsoleClass) GetRecord(sessionID SessionRef, self ConsoleRef) (_retval ConsoleRecord, _err error)

Get a record containing the current state of the given console.

func (ConsoleClass) GetUUID 

func (_class ConsoleClass) GetUUID(sessionID SessionRef, self ConsoleRef) (_retval string, _err error)

Get the uuid field of the given console.

func (ConsoleClass) GetVM 

func (_class ConsoleClass) GetVM(sessionID SessionRef, self ConsoleRef) (_retval VMRef, _err error)

Get the VM field of the given console.

func (ConsoleClass) RemoveFromOtherConfig 

func (_class ConsoleClass) RemoveFromOtherConfig(sessionID SessionRef, self ConsoleRef, key string) (_err error)

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.

func (ConsoleClass) SetOtherConfig 

func (_class ConsoleClass) SetOtherConfig(sessionID SessionRef, self ConsoleRef, value map[string]string) (_err error)

Set the other_config field of the given console.

type ConsoleProtocol 

type ConsoleProtocol string
const (
	// VT100 terminal
	ConsoleProtocolVt100 ConsoleProtocol = "vt100"
	// Remote FrameBuffer protocol (as used in VNC)
	ConsoleProtocolRfb ConsoleProtocol = "rfb"
	// Remote Desktop Protocol
	ConsoleProtocolRdp ConsoleProtocol = "rdp"
)

type ConsoleRecord 

type ConsoleRecord struct {
	// Unique identifier/object reference
	UUID string
	// the protocol used by this console
	Protocol ConsoleProtocol
	// URI for the console service
	Location string
	// VM to which this console is attached
	VM VMRef
	// additional configuration
	OtherConfig map[string]string
}

type ConsoleRef 

type ConsoleRef string

type CrashdumpClass 

type CrashdumpClass struct {
	// contains filtered or unexported fields
}

A VM crashdump

func (CrashdumpClass) AddToOtherConfig 

func (_class CrashdumpClass) AddToOtherConfig(sessionID SessionRef, self CrashdumpRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given crashdump.

func (CrashdumpClass) Destroy 

func (_class CrashdumpClass) Destroy(sessionID SessionRef, self CrashdumpRef) (_err error)

Destroy the specified crashdump

func (CrashdumpClass) GetAll 

func (_class CrashdumpClass) GetAll(sessionID SessionRef) (_retval []CrashdumpRef, _err error)

Return a list of all the crashdumps known to the system.

func (CrashdumpClass) GetAllRecords 

func (_class CrashdumpClass) GetAllRecords(sessionID SessionRef) (_retval map[CrashdumpRef]CrashdumpRecord, _err error)

Return a map of crashdump references to crashdump records for all crashdumps known to the system.

func (CrashdumpClass) GetByUUID 

func (_class CrashdumpClass) GetByUUID(sessionID SessionRef, uuid string) (_retval CrashdumpRef, _err error)

Get a reference to the crashdump instance with the specified UUID.

func (CrashdumpClass) GetOtherConfig 

func (_class CrashdumpClass) GetOtherConfig(sessionID SessionRef, self CrashdumpRef) (_retval map[string]string, _err error)

Get the other_config field of the given crashdump.

func (CrashdumpClass) GetRecord 

func (_class CrashdumpClass) GetRecord(sessionID SessionRef, self CrashdumpRef) (_retval CrashdumpRecord, _err error)

Get a record containing the current state of the given crashdump.

func (CrashdumpClass) GetUUID 

func (_class CrashdumpClass) GetUUID(sessionID SessionRef, self CrashdumpRef) (_retval string, _err error)

Get the uuid field of the given crashdump.

func (CrashdumpClass) GetVDI 

func (_class CrashdumpClass) GetVDI(sessionID SessionRef, self CrashdumpRef) (_retval VDIRef, _err error)

Get the VDI field of the given crashdump.

func (CrashdumpClass) GetVM 

func (_class CrashdumpClass) GetVM(sessionID SessionRef, self CrashdumpRef) (_retval VMRef, _err error)

Get the VM field of the given crashdump.

func (CrashdumpClass) RemoveFromOtherConfig 

func (_class CrashdumpClass) RemoveFromOtherConfig(sessionID SessionRef, self CrashdumpRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given crashdump. If the key is not in that Map, then do nothing.

func (CrashdumpClass) SetOtherConfig 

func (_class CrashdumpClass) SetOtherConfig(sessionID SessionRef, self CrashdumpRef, value map[string]string) (_err error)

Set the other_config field of the given crashdump.

type CrashdumpRecord 

type CrashdumpRecord struct {
	// Unique identifier/object reference
	UUID string
	// the virtual machine
	VM VMRef
	// the virtual disk
	VDI VDIRef
	// additional configuration
	OtherConfig map[string]string
}

type CrashdumpRef 

type CrashdumpRef string

type DRTaskClass 

type DRTaskClass struct {
	// contains filtered or unexported fields
}

DR task

func (DRTaskClass) Create 

func (_class DRTaskClass) Create(sessionID SessionRef, atype string, deviceConfig map[string]string, whitelist []string) (_retval DRTaskRef, _err error)

Create a disaster recovery task which will query the supplied list of devices

func (DRTaskClass) Destroy 

func (_class DRTaskClass) Destroy(sessionID SessionRef, self DRTaskRef) (_err error)

Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required

func (DRTaskClass) GetAll 

func (_class DRTaskClass) GetAll(sessionID SessionRef) (_retval []DRTaskRef, _err error)

Return a list of all the DR_tasks known to the system.

func (DRTaskClass) GetAllRecords 

func (_class DRTaskClass) GetAllRecords(sessionID SessionRef) (_retval map[DRTaskRef]DRTaskRecord, _err error)

Return a map of DR_task references to DR_task records for all DR_tasks known to the system.

func (DRTaskClass) GetByUUID 

func (_class DRTaskClass) GetByUUID(sessionID SessionRef, uuid string) (_retval DRTaskRef, _err error)

Get a reference to the DR_task instance with the specified UUID.

func (DRTaskClass) GetIntroducedSRs 

func (_class DRTaskClass) GetIntroducedSRs(sessionID SessionRef, self DRTaskRef) (_retval []SRRef, _err error)

Get the introduced_SRs field of the given DR_task.

func (DRTaskClass) GetRecord 

func (_class DRTaskClass) GetRecord(sessionID SessionRef, self DRTaskRef) (_retval DRTaskRecord, _err error)

Get a record containing the current state of the given DR_task.

func (DRTaskClass) GetUUID 

func (_class DRTaskClass) GetUUID(sessionID SessionRef, self DRTaskRef) (_retval string, _err error)

Get the uuid field of the given DR_task.

type DRTaskRecord 

type DRTaskRecord struct {
	// Unique identifier/object reference
	UUID string
	// All SRs introduced by this appliance
	IntroducedSRs []SRRef
}

type DRTaskRef 

type DRTaskRef string

type DataSourceClass 

type DataSourceClass struct {
	// contains filtered or unexported fields
}

Data sources for logging in RRDs

type DataSourceRecord 

type DataSourceRecord struct {
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// true if the data source is being logged
	Enabled bool
	// true if the data source is enabled by default. Non-default data sources cannot be disabled
	Standard bool
	// the units of the value
	Units string
	// the minimum value of the data source
	Min float64
	// the maximum value of the data source
	Max float64
	// current value of the data source
	Value float64
}

type DataSourceRef 

type DataSourceRef string

type Error 

type Error struct {
	// contains filtered or unexported fields
}

Error represents errors returned on xmlrpc request.

func (*Error) Code 

func (e *Error) Code() string

Code ...

func (*Error) Error 

func (e *Error) Error() string

Error() method implements Error interface

func (*Error) Type 

func (e *Error) Type() string

Type ...

func (*Error) UUID 

func (e *Error) UUID() string

UUID ...

type EventClass 

type EventClass struct {
	// contains filtered or unexported fields
}

Asynchronous event registration and handling

func (EventClass) From 

func (_class EventClass) From(sessionID SessionRef, classes []string, token string, timeout float64) (_retval []EventRecord, _err error)

Blocking call which returns a new token and a (possibly empty) batch of events. The returned token can be used in subsequent calls to this function.

Errors: 

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.
EVENTS_LOST - Some events have been lost from the queue and cannot be retrieved.

func (EventClass) GetCurrentID 

func (_class EventClass) GetCurrentID(sessionID SessionRef) (_retval int, _err error)

Return the ID of the next event to be generated by the system

func (EventClass) Inject 

func (_class EventClass) Inject(sessionID SessionRef, class string, ref string) (_retval string, _err error)

Injects an artificial event on the given object and return the corresponding ID

func (EventClass) Next 

func (_class EventClass) Next(sessionID SessionRef) (_retval []EventRecord, _err error)

Blocking call which returns a (possibly empty) batch of events. This method is only recommended for legacy use. New development should use event.from which supercedes this method.

Errors: 

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.
EVENTS_LOST - Some events have been lost from the queue and cannot be retrieved.

func (EventClass) Register 

func (_class EventClass) Register(sessionID SessionRef, classes []string) (_err error)

Registers this session with the event system. Specifying * as the desired class will register for all classes.

func (EventClass) Unregister 

func (_class EventClass) Unregister(sessionID SessionRef, classes []string) (_err error)

Unregisters this session with the event system

type EventOperation 

type EventOperation string
const (
	// An object has been created
	EventOperationAdd EventOperation = "add"
	// An object has been deleted
	EventOperationDel EventOperation = "del"
	// An object has been modified
	EventOperationMod EventOperation = "mod"
)

type EventRecord 

type EventRecord struct {
	// An ID, monotonically increasing, and local to the current session
	ID int
	// The time at which the event occurred
	Timestamp string
	// The name of the class of the object that changed
	Class string
	// The operation that was performed
	Operation EventOperation
	// A reference to the object that changed
	Ref string
	// The uuid of the object that changed
	ObjUUID string
}

type EventRef 

type EventRef string

type GPUGroupClass 

type GPUGroupClass struct {
	// contains filtered or unexported fields
}

A group of compatible GPUs across the resource pool

func (GPUGroupClass) AddToOtherConfig 

func (_class GPUGroupClass) AddToOtherConfig(sessionID SessionRef, self GPUGroupRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given GPU_group.

func (GPUGroupClass) Create 

func (_class GPUGroupClass) Create(sessionID SessionRef, nameLabel string, nameDescription string, otherConfig map[string]string) (_retval GPUGroupRef, _err error)

func (GPUGroupClass) Destroy 

func (_class GPUGroupClass) Destroy(sessionID SessionRef, self GPUGroupRef) (_err error)

func (GPUGroupClass) GetAll 

func (_class GPUGroupClass) GetAll(sessionID SessionRef) (_retval []GPUGroupRef, _err error)

Return a list of all the GPU_groups known to the system.

func (GPUGroupClass) GetAllRecords 

func (_class GPUGroupClass) GetAllRecords(sessionID SessionRef) (_retval map[GPUGroupRef]GPUGroupRecord, _err error)

Return a map of GPU_group references to GPU_group records for all GPU_groups known to the system.

func (GPUGroupClass) GetAllocationAlgorithm 

func (_class GPUGroupClass) GetAllocationAlgorithm(sessionID SessionRef, self GPUGroupRef) (_retval AllocationAlgorithm, _err error)

Get the allocation_algorithm field of the given GPU_group.

func (GPUGroupClass) GetByNameLabel 

func (_class GPUGroupClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []GPUGroupRef, _err error)

Get all the GPU_group instances with the given label.

func (GPUGroupClass) GetByUUID 

func (_class GPUGroupClass) GetByUUID(sessionID SessionRef, uuid string) (_retval GPUGroupRef, _err error)

Get a reference to the GPU_group instance with the specified UUID.

func (GPUGroupClass) GetEnabledVGPUTypes 

func (_class GPUGroupClass) GetEnabledVGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval []VGPUTypeRef, _err error)

Get the enabled_VGPU_types field of the given GPU_group.

func (GPUGroupClass) GetGPUTypes 

func (_class GPUGroupClass) GetGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval []string, _err error)

Get the GPU_types field of the given GPU_group.

func (GPUGroupClass) GetNameDescription 

func (_class GPUGroupClass) GetNameDescription(sessionID SessionRef, self GPUGroupRef) (_retval string, _err error)

Get the name/description field of the given GPU_group.

func (GPUGroupClass) GetNameLabel 

func (_class GPUGroupClass) GetNameLabel(sessionID SessionRef, self GPUGroupRef) (_retval string, _err error)

Get the name/label field of the given GPU_group.

func (GPUGroupClass) GetOtherConfig 

func (_class GPUGroupClass) GetOtherConfig(sessionID SessionRef, self GPUGroupRef) (_retval map[string]string, _err error)

Get the other_config field of the given GPU_group.

func (GPUGroupClass) GetPGPUs 

func (_class GPUGroupClass) GetPGPUs(sessionID SessionRef, self GPUGroupRef) (_retval []PGPURef, _err error)

Get the PGPUs field of the given GPU_group.

func (GPUGroupClass) GetRecord 

func (_class GPUGroupClass) GetRecord(sessionID SessionRef, self GPUGroupRef) (_retval GPUGroupRecord, _err error)

Get a record containing the current state of the given GPU_group.

func (GPUGroupClass) GetRemainingCapacity 

func (_class GPUGroupClass) GetRemainingCapacity(sessionID SessionRef, self GPUGroupRef, vgpuType VGPUTypeRef) (_retval int, _err error)

func (GPUGroupClass) GetSupportedVGPUTypes 

func (_class GPUGroupClass) GetSupportedVGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval []VGPUTypeRef, _err error)

Get the supported_VGPU_types field of the given GPU_group.

func (GPUGroupClass) GetUUID 

func (_class GPUGroupClass) GetUUID(sessionID SessionRef, self GPUGroupRef) (_retval string, _err error)

Get the uuid field of the given GPU_group.

func (GPUGroupClass) GetVGPUs 

func (_class GPUGroupClass) GetVGPUs(sessionID SessionRef, self GPUGroupRef) (_retval []VGPURef, _err error)

Get the VGPUs field of the given GPU_group.

func (GPUGroupClass) RemoveFromOtherConfig 

func (_class GPUGroupClass) RemoveFromOtherConfig(sessionID SessionRef, self GPUGroupRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given GPU_group. If the key is not in that Map, then do nothing.

func (GPUGroupClass) SetAllocationAlgorithm 

func (_class GPUGroupClass) SetAllocationAlgorithm(sessionID SessionRef, self GPUGroupRef, value AllocationAlgorithm) (_err error)

Set the allocation_algorithm field of the given GPU_group.

func (GPUGroupClass) SetNameDescription 

func (_class GPUGroupClass) SetNameDescription(sessionID SessionRef, self GPUGroupRef, value string) (_err error)

Set the name/description field of the given GPU_group.

func (GPUGroupClass) SetNameLabel 

func (_class GPUGroupClass) SetNameLabel(sessionID SessionRef, self GPUGroupRef, value string) (_err error)

Set the name/label field of the given GPU_group.

func (GPUGroupClass) SetOtherConfig 

func (_class GPUGroupClass) SetOtherConfig(sessionID SessionRef, self GPUGroupRef, value map[string]string) (_err error)

Set the other_config field of the given GPU_group.

type GPUGroupRecord 

type GPUGroupRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// List of pGPUs in the group
	PGPUs []PGPURef
	// List of vGPUs using the group
	VGPUs []VGPURef
	// List of GPU types (vendor+device ID) that can be in this group
	GPUTypes []string
	// Additional configuration
	OtherConfig map[string]string
	// Current allocation of vGPUs to pGPUs for this group
	AllocationAlgorithm AllocationAlgorithm
	// vGPU types supported on at least one of the pGPUs in this group
	SupportedVGPUTypes []VGPUTypeRef
	// vGPU types supported on at least one of the pGPUs in this group
	EnabledVGPUTypes []VGPUTypeRef
}

type GPUGroupRef 

type GPUGroupRef string

type HostAllowedOperations 

type HostAllowedOperations string
const (
	// Indicates this host is able to provision another VM
	HostAllowedOperationsProvision HostAllowedOperations = "provision"
	// Indicates this host is evacuating
	HostAllowedOperationsEvacuate HostAllowedOperations = "evacuate"
	// Indicates this host is in the process of shutting itself down
	HostAllowedOperationsShutdown HostAllowedOperations = "shutdown"
	// Indicates this host is in the process of rebooting
	HostAllowedOperationsReboot HostAllowedOperations = "reboot"
	// Indicates this host is in the process of being powered on
	HostAllowedOperationsPowerOn HostAllowedOperations = "power_on"
	// This host is starting a VM
	HostAllowedOperationsVMStart HostAllowedOperations = "vm_start"
	// This host is resuming a VM
	HostAllowedOperationsVMResume HostAllowedOperations = "vm_resume"
	// This host is the migration target of a VM
	HostAllowedOperationsVMMigrate HostAllowedOperations = "vm_migrate"
)

type HostCPUClass 

type HostCPUClass struct {
	// contains filtered or unexported fields
}

A physical CPU

func (HostCPUClass) AddToOtherConfig 

func (_class HostCPUClass) AddToOtherConfig(sessionID SessionRef, self HostCPURef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given host_cpu.

func (HostCPUClass) GetAll 

func (_class HostCPUClass) GetAll(sessionID SessionRef) (_retval []HostCPURef, _err error)

Return a list of all the host_cpus known to the system.

func (HostCPUClass) GetAllRecords 

func (_class HostCPUClass) GetAllRecords(sessionID SessionRef) (_retval map[HostCPURef]HostCPURecord, _err error)

Return a map of host_cpu references to host_cpu records for all host_cpus known to the system.

func (HostCPUClass) GetByUUID 

func (_class HostCPUClass) GetByUUID(sessionID SessionRef, uuid string) (_retval HostCPURef, _err error)

Get a reference to the host_cpu instance with the specified UUID.

func (HostCPUClass) GetFamily 

func (_class HostCPUClass) GetFamily(sessionID SessionRef, self HostCPURef) (_retval int, _err error)

Get the family field of the given host_cpu.

func (HostCPUClass) GetFeatures 

func (_class HostCPUClass) GetFeatures(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

Get the features field of the given host_cpu.

func (HostCPUClass) GetFlags 

func (_class HostCPUClass) GetFlags(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

Get the flags field of the given host_cpu.

func (HostCPUClass) GetHost 

func (_class HostCPUClass) GetHost(sessionID SessionRef, self HostCPURef) (_retval HostRef, _err error)

Get the host field of the given host_cpu.

func (HostCPUClass) GetModel 

func (_class HostCPUClass) GetModel(sessionID SessionRef, self HostCPURef) (_retval int, _err error)

Get the model field of the given host_cpu.

func (HostCPUClass) GetModelname 

func (_class HostCPUClass) GetModelname(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

Get the modelname field of the given host_cpu.

func (HostCPUClass) GetNumber 

func (_class HostCPUClass) GetNumber(sessionID SessionRef, self HostCPURef) (_retval int, _err error)

Get the number field of the given host_cpu.

func (HostCPUClass) GetOtherConfig 

func (_class HostCPUClass) GetOtherConfig(sessionID SessionRef, self HostCPURef) (_retval map[string]string, _err error)

Get the other_config field of the given host_cpu.

func (HostCPUClass) GetRecord 

func (_class HostCPUClass) GetRecord(sessionID SessionRef, self HostCPURef) (_retval HostCPURecord, _err error)

Get a record containing the current state of the given host_cpu.

func (HostCPUClass) GetSpeed 

func (_class HostCPUClass) GetSpeed(sessionID SessionRef, self HostCPURef) (_retval int, _err error)

Get the speed field of the given host_cpu.

func (HostCPUClass) GetStepping 

func (_class HostCPUClass) GetStepping(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

Get the stepping field of the given host_cpu.

func (HostCPUClass) GetUUID 

func (_class HostCPUClass) GetUUID(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

Get the uuid field of the given host_cpu.

func (HostCPUClass) GetUtilisation 

func (_class HostCPUClass) GetUtilisation(sessionID SessionRef, self HostCPURef) (_retval float64, _err error)

Get the utilisation field of the given host_cpu.

func (HostCPUClass) GetVendor 

func (_class HostCPUClass) GetVendor(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

Get the vendor field of the given host_cpu.

func (HostCPUClass) RemoveFromOtherConfig 

func (_class HostCPUClass) RemoveFromOtherConfig(sessionID SessionRef, self HostCPURef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given host_cpu. If the key is not in that Map, then do nothing.

func (HostCPUClass) SetOtherConfig 

func (_class HostCPUClass) SetOtherConfig(sessionID SessionRef, self HostCPURef, value map[string]string) (_err error)

Set the other_config field of the given host_cpu.

type HostCPURecord 

type HostCPURecord struct {
	// Unique identifier/object reference
	UUID string
	// the host the CPU is in
	Host HostRef
	// the number of the physical CPU within the host
	Number int
	// the vendor of the physical CPU
	Vendor string
	// the speed of the physical CPU
	Speed int
	// the model name of the physical CPU
	Modelname string
	// the family (number) of the physical CPU
	Family int
	// the model number of the physical CPU
	Model int
	// the stepping of the physical CPU
	Stepping string
	// the flags of the physical CPU (a decoded version of the features field)
	Flags string
	// the physical CPU feature bitmap
	Features string
	// the current CPU utilisation
	Utilisation float64
	// additional configuration
	OtherConfig map[string]string
}

type HostCPURef 

type HostCPURef string

type HostClass 

type HostClass struct {
	// contains filtered or unexported fields
}

A physical host

func (HostClass) AddTags 

func (_class HostClass) AddTags(sessionID SessionRef, self HostRef, value string) (_err error)

Add the given value to the tags field of the given host. If the value is already in that Set, then do nothing.

func (HostClass) AddToGuestVCPUsParams 

func (_class HostClass) AddToGuestVCPUsParams(sessionID SessionRef, self HostRef, key string, value string) (_err error)

Add the given key-value pair to the guest_VCPUs_params field of the given host.

func (HostClass) AddToLicenseServer 

func (_class HostClass) AddToLicenseServer(sessionID SessionRef, self HostRef, key string, value string) (_err error)

Add the given key-value pair to the license_server field of the given host.

func (HostClass) AddToLogging 

func (_class HostClass) AddToLogging(sessionID SessionRef, self HostRef, key string, value string) (_err error)

Add the given key-value pair to the logging field of the given host.

func (HostClass) AddToOtherConfig 

func (_class HostClass) AddToOtherConfig(sessionID SessionRef, self HostRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given host.

func (HostClass) ApplyEdition 

func (_class HostClass) ApplyEdition(sessionID SessionRef, host HostRef, edition string, force bool) (_err error)

Change to another edition, or reactivate the current edition after a license has expired. This may be subject to the successful checkout of an appropriate license.

func (HostClass) AssertCanEvacuate 

func (_class HostClass) AssertCanEvacuate(sessionID SessionRef, host HostRef) (_err error)

Check this host can be evacuated.

func (HostClass) BackupRrds 

func (_class HostClass) BackupRrds(sessionID SessionRef, host HostRef, delay float64) (_err error)

This causes the RRDs to be backed up to the master

func (HostClass) BugreportUpload 

func (_class HostClass) BugreportUpload(sessionID SessionRef, host HostRef, url string, options map[string]string) (_err error)

Run xen-bugtool --yestoall and upload the output to Citrix support

func (HostClass) CallPlugin 

func (_class HostClass) CallPlugin(sessionID SessionRef, host HostRef, plugin string, fn string, args map[string]string) (_retval string, _err error)

Call a XenAPI plugin on this host

func (HostClass) ComputeFreeMemory 

func (_class HostClass) ComputeFreeMemory(sessionID SessionRef, host HostRef) (_retval int, _err error)

Computes the amount of free memory on the host.

func (HostClass) ComputeMemoryOverhead 

func (_class HostClass) ComputeMemoryOverhead(sessionID SessionRef, host HostRef) (_retval int, _err error)

Computes the virtualization memory overhead of a host.

func (HostClass) CreateNewBlob 

func (_class HostClass) CreateNewBlob(sessionID SessionRef, host HostRef, name string, mimeType string, public bool) (_retval BlobRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this host

func (HostClass) DeclareDead 

func (_class HostClass) DeclareDead(sessionID SessionRef, host HostRef) (_err error)

Declare that a host is dead. This is a dangerous operation, and should only be called if the administrator is absolutely sure the host is definitely dead

func (HostClass) Destroy 

func (_class HostClass) Destroy(sessionID SessionRef, self HostRef) (_err error)

Destroy specified host record in database

func (HostClass) Disable 

func (_class HostClass) Disable(sessionID SessionRef, host HostRef) (_err error)

Puts the host into a state in which no new VMs can be started. Currently active VMs on the host continue to execute.

func (HostClass) DisableDisplay 

func (_class HostClass) DisableDisplay(sessionID SessionRef, host HostRef) (_retval HostDisplay, _err error)

Disable console output to the physical display device next time this host boots

func (HostClass) DisableExternalAuth 

func (_class HostClass) DisableExternalAuth(sessionID SessionRef, host HostRef, config map[string]string) (_err error)

This call disables external authentication on the local host

func (HostClass) DisableLocalStorageCaching 

func (_class HostClass) DisableLocalStorageCaching(sessionID SessionRef, host HostRef) (_err error)

Disable the use of a local SR for caching purposes

func (HostClass) Dmesg 

func (_class HostClass) Dmesg(sessionID SessionRef, host HostRef) (_retval string, _err error)

Get the host xen dmesg.

func (HostClass) DmesgClear 

func (_class HostClass) DmesgClear(sessionID SessionRef, host HostRef) (_retval string, _err error)

Get the host xen dmesg, and clear the buffer.

func (HostClass) EmergencyHaDisable 

func (_class HostClass) EmergencyHaDisable(sessionID SessionRef) (_err error)

This call disables HA on the local host. This should only be used with extreme care.

func (HostClass) Enable 

func (_class HostClass) Enable(sessionID SessionRef, host HostRef) (_err error)

Puts the host into a state in which new VMs can be started.

func (HostClass) EnableDisplay 

func (_class HostClass) EnableDisplay(sessionID SessionRef, host HostRef) (_retval HostDisplay, _err error)

Enable console output to the physical display device next time this host boots

func (HostClass) EnableExternalAuth 

func (_class HostClass) EnableExternalAuth(sessionID SessionRef, host HostRef, config map[string]string, serviceName string, authType string) (_err error)

This call enables external authentication on a host

func (HostClass) EnableLocalStorageCaching 

func (_class HostClass) EnableLocalStorageCaching(sessionID SessionRef, host HostRef, sr SRRef) (_err error)

Enable the use of a local SR for caching purposes

func (HostClass) Evacuate 

func (_class HostClass) Evacuate(sessionID SessionRef, host HostRef) (_err error)

Migrate all VMs off of this host, where possible.

func (HostClass) ForgetDataSourceArchives 

func (_class HostClass) ForgetDataSourceArchives(sessionID SessionRef, host HostRef, dataSource string) (_err error)

Forget the recorded statistics related to the specified data source

func (HostClass) GetAPIVersionMajor 

func (_class HostClass) GetAPIVersionMajor(sessionID SessionRef, self HostRef) (_retval int, _err error)

Get the API_version/major field of the given host.

func (HostClass) GetAPIVersionMinor 

func (_class HostClass) GetAPIVersionMinor(sessionID SessionRef, self HostRef) (_retval int, _err error)

Get the API_version/minor field of the given host.

func (HostClass) GetAPIVersionVendor 

func (_class HostClass) GetAPIVersionVendor(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the API_version/vendor field of the given host.

func (HostClass) GetAPIVersionVendorImplementation 

func (_class HostClass) GetAPIVersionVendorImplementation(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the API_version/vendor_implementation field of the given host.

func (HostClass) GetAddress 

func (_class HostClass) GetAddress(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the address field of the given host.

func (HostClass) GetAll 

func (_class HostClass) GetAll(sessionID SessionRef) (_retval []HostRef, _err error)

Return a list of all the hosts known to the system.

func (HostClass) GetAllRecords 

func (_class HostClass) GetAllRecords(sessionID SessionRef) (_retval map[HostRef]HostRecord, _err error)

Return a map of host references to host records for all hosts known to the system.

func (HostClass) GetAllowedOperations 

func (_class HostClass) GetAllowedOperations(sessionID SessionRef, self HostRef) (_retval []HostAllowedOperations, _err error)

Get the allowed_operations field of the given host.

func (HostClass) GetBiosStrings 

func (_class HostClass) GetBiosStrings(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the bios_strings field of the given host.

func (HostClass) GetBlobs 

func (_class HostClass) GetBlobs(sessionID SessionRef, self HostRef) (_retval map[string]BlobRef, _err error)

Get the blobs field of the given host.

func (HostClass) GetByNameLabel 

func (_class HostClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []HostRef, _err error)

Get all the host instances with the given label.

func (HostClass) GetByUUID 

func (_class HostClass) GetByUUID(sessionID SessionRef, uuid string) (_retval HostRef, _err error)

Get a reference to the host instance with the specified UUID.

func (HostClass) GetCPUConfiguration 

func (_class HostClass) GetCPUConfiguration(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the cpu_configuration field of the given host.

func (HostClass) GetCPUInfo 

func (_class HostClass) GetCPUInfo(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the cpu_info field of the given host.

func (HostClass) GetCapabilities 

func (_class HostClass) GetCapabilities(sessionID SessionRef, self HostRef) (_retval []string, _err error)

Get the capabilities field of the given host.

func (HostClass) GetChipsetInfo 

func (_class HostClass) GetChipsetInfo(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the chipset_info field of the given host.

func (HostClass) GetCrashDumpSr 

func (_class HostClass) GetCrashDumpSr(sessionID SessionRef, self HostRef) (_retval SRRef, _err error)

Get the crash_dump_sr field of the given host.

func (HostClass) GetCrashdumps 

func (_class HostClass) GetCrashdumps(sessionID SessionRef, self HostRef) (_retval []HostCrashdumpRef, _err error)

Get the crashdumps field of the given host.

func (HostClass) GetCurrentOperations 

func (_class HostClass) GetCurrentOperations(sessionID SessionRef, self HostRef) (_retval map[string]HostAllowedOperations, _err error)

Get the current_operations field of the given host.

func (HostClass) GetDataSources 

func (_class HostClass) GetDataSources(sessionID SessionRef, host HostRef) (_retval []DataSourceRecord, _err error)

func (HostClass) GetDisplay 

func (_class HostClass) GetDisplay(sessionID SessionRef, self HostRef) (_retval HostDisplay, _err error)

Get the display field of the given host.

func (HostClass) GetEdition 

func (_class HostClass) GetEdition(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the edition field of the given host.

func (HostClass) GetEnabled 

func (_class HostClass) GetEnabled(sessionID SessionRef, self HostRef) (_retval bool, _err error)

Get the enabled field of the given host.

func (HostClass) GetExternalAuthConfiguration 

func (_class HostClass) GetExternalAuthConfiguration(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the external_auth_configuration field of the given host.

func (HostClass) GetExternalAuthServiceName 

func (_class HostClass) GetExternalAuthServiceName(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the external_auth_service_name field of the given host.

func (HostClass) GetExternalAuthType 

func (_class HostClass) GetExternalAuthType(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the external_auth_type field of the given host.

func (HostClass) GetGuestVCPUsParams 

func (_class HostClass) GetGuestVCPUsParams(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the guest_VCPUs_params field of the given host.

func (HostClass) GetHaNetworkPeers 

func (_class HostClass) GetHaNetworkPeers(sessionID SessionRef, self HostRef) (_retval []string, _err error)

Get the ha_network_peers field of the given host.

func (HostClass) GetHaStatefiles 

func (_class HostClass) GetHaStatefiles(sessionID SessionRef, self HostRef) (_retval []string, _err error)

Get the ha_statefiles field of the given host.

func (HostClass) GetHostCPUs 

func (_class HostClass) GetHostCPUs(sessionID SessionRef, self HostRef) (_retval []HostCPURef, _err error)

Get the host_CPUs field of the given host.

func (HostClass) GetHostname 

func (_class HostClass) GetHostname(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the hostname field of the given host.

func (HostClass) GetLicenseParams 

func (_class HostClass) GetLicenseParams(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the license_params field of the given host.

func (HostClass) GetLicenseServer 

func (_class HostClass) GetLicenseServer(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the license_server field of the given host.

func (HostClass) GetLocalCacheSr 

func (_class HostClass) GetLocalCacheSr(sessionID SessionRef, self HostRef) (_retval SRRef, _err error)

Get the local_cache_sr field of the given host.

func (HostClass) GetLog 

func (_class HostClass) GetLog(sessionID SessionRef, host HostRef) (_retval string, _err error)

Get the host's log file

func (HostClass) GetLogging 

func (_class HostClass) GetLogging(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the logging field of the given host.

func (HostClass) GetManagementInterface 

func (_class HostClass) GetManagementInterface(sessionID SessionRef, host HostRef) (_retval PIFRef, _err error)

Returns the management interface for the specified host

func (HostClass) GetMemoryOverhead 

func (_class HostClass) GetMemoryOverhead(sessionID SessionRef, self HostRef) (_retval int, _err error)

Get the memory/overhead field of the given host.

func (HostClass) GetMetrics 

func (_class HostClass) GetMetrics(sessionID SessionRef, self HostRef) (_retval HostMetricsRef, _err error)

Get the metrics field of the given host.

func (HostClass) GetNameDescription 

func (_class HostClass) GetNameDescription(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the name/description field of the given host.

func (HostClass) GetNameLabel 

func (_class HostClass) GetNameLabel(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the name/label field of the given host.

func (HostClass) GetOtherConfig 

func (_class HostClass) GetOtherConfig(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the other_config field of the given host.

func (HostClass) GetPBDs 

func (_class HostClass) GetPBDs(sessionID SessionRef, self HostRef) (_retval []PBDRef, _err error)

Get the PBDs field of the given host.

func (HostClass) GetPCIs 

func (_class HostClass) GetPCIs(sessionID SessionRef, self HostRef) (_retval []PCIRef, _err error)

Get the PCIs field of the given host.

func (HostClass) GetPGPUs 

func (_class HostClass) GetPGPUs(sessionID SessionRef, self HostRef) (_retval []PGPURef, _err error)

Get the PGPUs field of the given host.

func (HostClass) GetPIFs 

func (_class HostClass) GetPIFs(sessionID SessionRef, self HostRef) (_retval []PIFRef, _err error)

Get the PIFs field of the given host.

func (HostClass) GetPatches 

func (_class HostClass) GetPatches(sessionID SessionRef, self HostRef) (_retval []HostPatchRef, _err error)

Get the patches field of the given host.

func (HostClass) GetPowerOnConfig 

func (_class HostClass) GetPowerOnConfig(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the power_on_config field of the given host.

func (HostClass) GetPowerOnMode 

func (_class HostClass) GetPowerOnMode(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the power_on_mode field of the given host.

func (HostClass) GetRecord 

func (_class HostClass) GetRecord(sessionID SessionRef, self HostRef) (_retval HostRecord, _err error)

Get a record containing the current state of the given host.

func (HostClass) GetResidentVMs 

func (_class HostClass) GetResidentVMs(sessionID SessionRef, self HostRef) (_retval []VMRef, _err error)

Get the resident_VMs field of the given host.

func (HostClass) GetSchedPolicy 

func (_class HostClass) GetSchedPolicy(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the sched_policy field of the given host.

func (HostClass) GetServerCertificate 

func (_class HostClass) GetServerCertificate(sessionID SessionRef, host HostRef) (_retval string, _err error)

Get the installed server SSL certificate.

func (HostClass) GetServerLocaltime 

func (_class HostClass) GetServerLocaltime(sessionID SessionRef, host HostRef) (_retval time.Time, _err error)

This call queries the host's clock for the current time in the host's local timezone

func (HostClass) GetServertime 

func (_class HostClass) GetServertime(sessionID SessionRef, host HostRef) (_retval time.Time, _err error)

This call queries the host's clock for the current time

func (HostClass) GetSoftwareVersion 

func (_class HostClass) GetSoftwareVersion(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

Get the software_version field of the given host.

func (HostClass) GetSslLegacy 

func (_class HostClass) GetSslLegacy(sessionID SessionRef, self HostRef) (_retval bool, _err error)

Get the ssl_legacy field of the given host.

func (HostClass) GetSupportedBootloaders 

func (_class HostClass) GetSupportedBootloaders(sessionID SessionRef, self HostRef) (_retval []string, _err error)

Get the supported_bootloaders field of the given host.

func (HostClass) GetSuspendImageSr 

func (_class HostClass) GetSuspendImageSr(sessionID SessionRef, self HostRef) (_retval SRRef, _err error)

Get the suspend_image_sr field of the given host.

func (HostClass) GetSystemStatusCapabilities 

func (_class HostClass) GetSystemStatusCapabilities(sessionID SessionRef, host HostRef) (_retval string, _err error)

func (HostClass) GetTags 

func (_class HostClass) GetTags(sessionID SessionRef, self HostRef) (_retval []string, _err error)

Get the tags field of the given host.

func (HostClass) GetUUID 

func (_class HostClass) GetUUID(sessionID SessionRef, self HostRef) (_retval string, _err error)

Get the uuid field of the given host.

func (HostClass) GetUncooperativeResidentVMs 

func (_class HostClass) GetUncooperativeResidentVMs(sessionID SessionRef, self HostRef) (_retval []VMRef, _err error)

Return a set of VMs which are not co-operating with the host's memory control system

func (HostClass) GetVirtualHardwarePlatformVersions 

func (_class HostClass) GetVirtualHardwarePlatformVersions(sessionID SessionRef, self HostRef) (_retval []int, _err error)

Get the virtual_hardware_platform_versions field of the given host.

func (HostClass) GetVmsWhichPreventEvacuation 

func (_class HostClass) GetVmsWhichPreventEvacuation(sessionID SessionRef, self HostRef) (_retval map[VMRef][]string, _err error)

Return a set of VMs which prevent the host being evacuated, with per-VM error codes

func (HostClass) LicenseApply 

func (_class HostClass) LicenseApply(sessionID SessionRef, host HostRef, contents string) (_err error)

Apply a new license to a host

Errors: 

LICENSE_PROCESSING_ERROR - There was an error processing your license.  Please contact your support representative.

func (HostClass) ListMethods 

func (_class HostClass) ListMethods(sessionID SessionRef) (_retval []string, _err error)

List all supported methods

func (HostClass) LocalManagementReconfigure 

func (_class HostClass) LocalManagementReconfigure(sessionID SessionRef, iface string) (_err error)

Reconfigure the management network interface. Should only be used if Host.management_reconfigure is impossible because the network configuration is broken.

func (HostClass) ManagementDisable 

func (_class HostClass) ManagementDisable(sessionID SessionRef) (_err error)

Disable the management network interface

func (HostClass) ManagementReconfigure 

func (_class HostClass) ManagementReconfigure(sessionID SessionRef, pif PIFRef) (_err error)

Reconfigure the management network interface

func (HostClass) MigrateReceive 

func (_class HostClass) MigrateReceive(sessionID SessionRef, host HostRef, network NetworkRef, options map[string]string) (_retval map[string]string, _err error)

Prepare to receive a VM, returning a token which can be passed to VM.migrate.

func (HostClass) PowerOn 

func (_class HostClass) PowerOn(sessionID SessionRef, host HostRef) (_err error)

Attempt to power-on the host (if the capability exists).

func (HostClass) QueryDataSource 

func (_class HostClass) QueryDataSource(sessionID SessionRef, host HostRef, dataSource string) (_retval float64, _err error)

Query the latest value of the specified data source

func (HostClass) Reboot 

func (_class HostClass) Reboot(sessionID SessionRef, host HostRef) (_err error)

Reboot the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)

func (HostClass) RecordDataSource 

func (_class HostClass) RecordDataSource(sessionID SessionRef, host HostRef, dataSource string) (_err error)

Start recording the specified data source

func (HostClass) RefreshPackInfo 

func (_class HostClass) RefreshPackInfo(sessionID SessionRef, host HostRef) (_err error)

Refresh the list of installed Supplemental Packs.

func (HostClass) RemoveFromGuestVCPUsParams 

func (_class HostClass) RemoveFromGuestVCPUsParams(sessionID SessionRef, self HostRef, key string) (_err error)

Remove the given key and its corresponding value from the guest_VCPUs_params field of the given host. If the key is not in that Map, then do nothing.

func (HostClass) RemoveFromLicenseServer 

func (_class HostClass) RemoveFromLicenseServer(sessionID SessionRef, self HostRef, key string) (_err error)

Remove the given key and its corresponding value from the license_server field of the given host. If the key is not in that Map, then do nothing.

func (HostClass) RemoveFromLogging 

func (_class HostClass) RemoveFromLogging(sessionID SessionRef, self HostRef, key string) (_err error)

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.

func (HostClass) RemoveFromOtherConfig 

func (_class HostClass) RemoveFromOtherConfig(sessionID SessionRef, self HostRef, key string) (_err error)

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.

func (HostClass) RemoveTags 

func (_class HostClass) RemoveTags(sessionID SessionRef, self HostRef, value string) (_err error)

Remove the given value from the tags field of the given host. If the value is not in that Set, then do nothing.

func (HostClass) ResetCPUFeatures 

func (_class HostClass) ResetCPUFeatures(sessionID SessionRef, host HostRef) (_err error)

Remove the feature mask, such that after a reboot all features of the CPU are enabled.

func (HostClass) RestartAgent 

func (_class HostClass) RestartAgent(sessionID SessionRef, host HostRef) (_err error)

Restarts the agent after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.

func (HostClass) RetrieveWlbEvacuateRecommendations 

func (_class HostClass) RetrieveWlbEvacuateRecommendations(sessionID SessionRef, self HostRef) (_retval map[VMRef][]string, _err error)

Retrieves recommended host migrations to perform when evacuating the host from the wlb server. If a VM cannot be migrated from the host the reason is listed instead of a recommendation.

func (HostClass) SendDebugKeys 

func (_class HostClass) SendDebugKeys(sessionID SessionRef, host HostRef, keys string) (_err error)

Inject the given string as debugging keys into Xen

func (HostClass) SetAddress 

func (_class HostClass) SetAddress(sessionID SessionRef, self HostRef, value string) (_err error)

Set the address field of the given host.

func (HostClass) SetCPUFeatures 

func (_class HostClass) SetCPUFeatures(sessionID SessionRef, host HostRef, features string) (_err error)

Set the CPU features to be used after a reboot, if the given features string is valid.

func (HostClass) SetCrashDumpSr 

func (_class HostClass) SetCrashDumpSr(sessionID SessionRef, self HostRef, value SRRef) (_err error)

Set the crash_dump_sr field of the given host.

func (HostClass) SetDisplay 

func (_class HostClass) SetDisplay(sessionID SessionRef, self HostRef, value HostDisplay) (_err error)

Set the display field of the given host.

func (HostClass) SetGuestVCPUsParams 

func (_class HostClass) SetGuestVCPUsParams(sessionID SessionRef, self HostRef, value map[string]string) (_err error)

Set the guest_VCPUs_params field of the given host.

func (HostClass) SetHostname 

func (_class HostClass) SetHostname(sessionID SessionRef, self HostRef, value string) (_err error)

Set the hostname field of the given host.

func (HostClass) SetHostnameLive 

func (_class HostClass) SetHostnameLive(sessionID SessionRef, host HostRef, hostname string) (_err error)

Sets the host name to the specified string. Both the API and lower-level system hostname are changed immediately.

Errors: 

HOST_NAME_INVALID - The host name is invalid.

func (HostClass) SetLicenseServer 

func (_class HostClass) SetLicenseServer(sessionID SessionRef, self HostRef, value map[string]string) (_err error)

Set the license_server field of the given host.

func (HostClass) SetLogging 

func (_class HostClass) SetLogging(sessionID SessionRef, self HostRef, value map[string]string) (_err error)

Set the logging field of the given host.

func (HostClass) SetNameDescription 

func (_class HostClass) SetNameDescription(sessionID SessionRef, self HostRef, value string) (_err error)

Set the name/description field of the given host.

func (HostClass) SetNameLabel 

func (_class HostClass) SetNameLabel(sessionID SessionRef, self HostRef, value string) (_err error)

Set the name/label field of the given host.

func (HostClass) SetOtherConfig 

func (_class HostClass) SetOtherConfig(sessionID SessionRef, self HostRef, value map[string]string) (_err error)

Set the other_config field of the given host.

func (HostClass) SetPowerOnMode 

func (_class HostClass) SetPowerOnMode(sessionID SessionRef, self HostRef, powerOnMode string, powerOnConfig map[string]string) (_err error)

Set the power-on-mode, host, user and password

func (HostClass) SetSslLegacy 

func (_class HostClass) SetSslLegacy(sessionID SessionRef, self HostRef, value bool) (_err error)

Enable/disable SSLv3 for interoperability with older versions of XenServer

func (HostClass) SetSuspendImageSr 

func (_class HostClass) SetSuspendImageSr(sessionID SessionRef, self HostRef, value SRRef) (_err error)

Set the suspend_image_sr field of the given host.

func (HostClass) SetTags 

func (_class HostClass) SetTags(sessionID SessionRef, self HostRef, value []string) (_err error)

Set the tags field of the given host.

func (HostClass) Shutdown 

func (_class HostClass) Shutdown(sessionID SessionRef, host HostRef) (_err error)

Shutdown the host. (This function can only be called if there are no currently running VMs on the host and it is disabled.)

func (HostClass) ShutdownAgent 

func (_class HostClass) ShutdownAgent(sessionID SessionRef) (_err error)

Shuts the agent down after a 10 second pause. WARNING: this is a dangerous operation. Any operations in progress will be aborted, and unrecoverable data loss may occur. The caller is responsible for ensuring that there are no operations in progress when this method is called.

func (HostClass) SyncData 

func (_class HostClass) SyncData(sessionID SessionRef, host HostRef) (_err error)

This causes the synchronisation of the non-database data (messages, RRDs and so on) stored on the master to be synchronised with the host

func (HostClass) SyslogReconfigure 

func (_class HostClass) SyslogReconfigure(sessionID SessionRef, host HostRef) (_err error)

Re-configure syslog logging

type HostCrashdumpClass 

type HostCrashdumpClass struct {
	// contains filtered or unexported fields
}

Represents a host crash dump

func (HostCrashdumpClass) AddToOtherConfig 

func (_class HostCrashdumpClass) AddToOtherConfig(sessionID SessionRef, self HostCrashdumpRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given host_crashdump.

func (HostCrashdumpClass) Destroy 

func (_class HostCrashdumpClass) Destroy(sessionID SessionRef, self HostCrashdumpRef) (_err error)

Destroy specified host crash dump, removing it from the disk.

func (HostCrashdumpClass) GetAll 

func (_class HostCrashdumpClass) GetAll(sessionID SessionRef) (_retval []HostCrashdumpRef, _err error)

Return a list of all the host_crashdumps known to the system.

func (HostCrashdumpClass) GetAllRecords 

func (_class HostCrashdumpClass) GetAllRecords(sessionID SessionRef) (_retval map[HostCrashdumpRef]HostCrashdumpRecord, _err error)

Return a map of host_crashdump references to host_crashdump records for all host_crashdumps known to the system.

func (HostCrashdumpClass) GetByUUID 

func (_class HostCrashdumpClass) GetByUUID(sessionID SessionRef, uuid string) (_retval HostCrashdumpRef, _err error)

Get a reference to the host_crashdump instance with the specified UUID.

func (HostCrashdumpClass) GetHost 

func (_class HostCrashdumpClass) GetHost(sessionID SessionRef, self HostCrashdumpRef) (_retval HostRef, _err error)

Get the host field of the given host_crashdump.

func (HostCrashdumpClass) GetOtherConfig 

func (_class HostCrashdumpClass) GetOtherConfig(sessionID SessionRef, self HostCrashdumpRef) (_retval map[string]string, _err error)

Get the other_config field of the given host_crashdump.

func (HostCrashdumpClass) GetRecord 

func (_class HostCrashdumpClass) GetRecord(sessionID SessionRef, self HostCrashdumpRef) (_retval HostCrashdumpRecord, _err error)

Get a record containing the current state of the given host_crashdump.

func (HostCrashdumpClass) GetSize 

func (_class HostCrashdumpClass) GetSize(sessionID SessionRef, self HostCrashdumpRef) (_retval int, _err error)

Get the size field of the given host_crashdump.

func (HostCrashdumpClass) GetTimestamp 

func (_class HostCrashdumpClass) GetTimestamp(sessionID SessionRef, self HostCrashdumpRef) (_retval time.Time, _err error)

Get the timestamp field of the given host_crashdump.

func (HostCrashdumpClass) GetUUID 

func (_class HostCrashdumpClass) GetUUID(sessionID SessionRef, self HostCrashdumpRef) (_retval string, _err error)

Get the uuid field of the given host_crashdump.

func (HostCrashdumpClass) RemoveFromOtherConfig 

func (_class HostCrashdumpClass) RemoveFromOtherConfig(sessionID SessionRef, self HostCrashdumpRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given host_crashdump. If the key is not in that Map, then do nothing.

func (HostCrashdumpClass) SetOtherConfig 

func (_class HostCrashdumpClass) SetOtherConfig(sessionID SessionRef, self HostCrashdumpRef, value map[string]string) (_err error)

Set the other_config field of the given host_crashdump.

func (HostCrashdumpClass) Upload 

func (_class HostCrashdumpClass) Upload(sessionID SessionRef, self HostCrashdumpRef, url string, options map[string]string) (_err error)

Upload the specified host crash dump to a specified URL

type HostCrashdumpRecord 

type HostCrashdumpRecord struct {
	// Unique identifier/object reference
	UUID string
	// Host the crashdump relates to
	Host HostRef
	// Time the crash happened
	Timestamp time.Time
	// Size of the crashdump
	Size int
	// additional configuration
	OtherConfig map[string]string
}

type HostCrashdumpRef 

type HostCrashdumpRef string

type HostDisplay 

type HostDisplay string
const (
	// This host is outputting its console to a physical display device
	HostDisplayEnabled HostDisplay = "enabled"
	// The host will stop outputting its console to a physical display device on next boot
	HostDisplayDisableOnReboot HostDisplay = "disable_on_reboot"
	// This host is not outputting its console to a physical display device
	HostDisplayDisabled HostDisplay = "disabled"
	// The host will start outputting its console to a physical display device on next boot
	HostDisplayEnableOnReboot HostDisplay = "enable_on_reboot"
)

type HostMetricsClass 

type HostMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a host

func (HostMetricsClass) AddToOtherConfig 

func (_class HostMetricsClass) AddToOtherConfig(sessionID SessionRef, self HostMetricsRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given host_metrics.

func (HostMetricsClass) GetAll 

func (_class HostMetricsClass) GetAll(sessionID SessionRef) (_retval []HostMetricsRef, _err error)

Return a list of all the host_metrics instances known to the system.

func (HostMetricsClass) GetAllRecords 

func (_class HostMetricsClass) GetAllRecords(sessionID SessionRef) (_retval map[HostMetricsRef]HostMetricsRecord, _err error)

Return a map of host_metrics references to host_metrics records for all host_metrics instances known to the system.

func (HostMetricsClass) GetByUUID 

func (_class HostMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval HostMetricsRef, _err error)

Get a reference to the host_metrics instance with the specified UUID.

func (HostMetricsClass) GetLastUpdated 

func (_class HostMetricsClass) GetLastUpdated(sessionID SessionRef, self HostMetricsRef) (_retval time.Time, _err error)

Get the last_updated field of the given host_metrics.

func (HostMetricsClass) GetLive 

func (_class HostMetricsClass) GetLive(sessionID SessionRef, self HostMetricsRef) (_retval bool, _err error)

Get the live field of the given host_metrics.

func (HostMetricsClass) GetMemoryFree 

func (_class HostMetricsClass) GetMemoryFree(sessionID SessionRef, self HostMetricsRef) (_retval int, _err error)

Get the memory/free field of the given host_metrics.

func (HostMetricsClass) GetMemoryTotal 

func (_class HostMetricsClass) GetMemoryTotal(sessionID SessionRef, self HostMetricsRef) (_retval int, _err error)

Get the memory/total field of the given host_metrics.

func (HostMetricsClass) GetOtherConfig 

func (_class HostMetricsClass) GetOtherConfig(sessionID SessionRef, self HostMetricsRef) (_retval map[string]string, _err error)

Get the other_config field of the given host_metrics.

func (HostMetricsClass) GetRecord 

func (_class HostMetricsClass) GetRecord(sessionID SessionRef, self HostMetricsRef) (_retval HostMetricsRecord, _err error)

Get a record containing the current state of the given host_metrics.

func (HostMetricsClass) GetUUID 

func (_class HostMetricsClass) GetUUID(sessionID SessionRef, self HostMetricsRef) (_retval string, _err error)

Get the uuid field of the given host_metrics.

func (HostMetricsClass) RemoveFromOtherConfig 

func (_class HostMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self HostMetricsRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given host_metrics. If the key is not in that Map, then do nothing.

func (HostMetricsClass) SetOtherConfig 

func (_class HostMetricsClass) SetOtherConfig(sessionID SessionRef, self HostMetricsRef, value map[string]string) (_err error)

Set the other_config field of the given host_metrics.

type HostMetricsRecord 

type HostMetricsRecord struct {
	// Unique identifier/object reference
	UUID string
	// Total host memory (bytes)
	MemoryTotal int
	// Free host memory (bytes)
	MemoryFree int
	// Pool master thinks this host is live
	Live bool
	// Time at which this information was last updated
	LastUpdated time.Time
	// additional configuration
	OtherConfig map[string]string
}

type HostMetricsRef 

type HostMetricsRef string

type HostPatchClass 

type HostPatchClass struct {
	// contains filtered or unexported fields
}

Represents a patch stored on a server

func (HostPatchClass) AddToOtherConfig 

func (_class HostPatchClass) AddToOtherConfig(sessionID SessionRef, self HostPatchRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given host_patch.

func (HostPatchClass) Apply 

func (_class HostPatchClass) Apply(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

Apply the selected patch and return its output

func (HostPatchClass) Destroy 

func (_class HostPatchClass) Destroy(sessionID SessionRef, self HostPatchRef) (_err error)

Destroy the specified host patch, removing it from the disk. This does NOT reverse the patch

func (HostPatchClass) GetAll 

func (_class HostPatchClass) GetAll(sessionID SessionRef) (_retval []HostPatchRef, _err error)

Return a list of all the host_patchs known to the system.

func (HostPatchClass) GetAllRecords 

func (_class HostPatchClass) GetAllRecords(sessionID SessionRef) (_retval map[HostPatchRef]HostPatchRecord, _err error)

Return a map of host_patch references to host_patch records for all host_patchs known to the system.

func (HostPatchClass) GetApplied 

func (_class HostPatchClass) GetApplied(sessionID SessionRef, self HostPatchRef) (_retval bool, _err error)

Get the applied field of the given host_patch.

func (HostPatchClass) GetByNameLabel 

func (_class HostPatchClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []HostPatchRef, _err error)

Get all the host_patch instances with the given label.

func (HostPatchClass) GetByUUID 

func (_class HostPatchClass) GetByUUID(sessionID SessionRef, uuid string) (_retval HostPatchRef, _err error)

Get a reference to the host_patch instance with the specified UUID.

func (HostPatchClass) GetHost 

func (_class HostPatchClass) GetHost(sessionID SessionRef, self HostPatchRef) (_retval HostRef, _err error)

Get the host field of the given host_patch.

func (HostPatchClass) GetNameDescription 

func (_class HostPatchClass) GetNameDescription(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

Get the name/description field of the given host_patch.

func (HostPatchClass) GetNameLabel 

func (_class HostPatchClass) GetNameLabel(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

Get the name/label field of the given host_patch.

func (HostPatchClass) GetOtherConfig 

func (_class HostPatchClass) GetOtherConfig(sessionID SessionRef, self HostPatchRef) (_retval map[string]string, _err error)

Get the other_config field of the given host_patch.

func (HostPatchClass) GetPoolPatch 

func (_class HostPatchClass) GetPoolPatch(sessionID SessionRef, self HostPatchRef) (_retval PoolPatchRef, _err error)

Get the pool_patch field of the given host_patch.

func (HostPatchClass) GetRecord 

func (_class HostPatchClass) GetRecord(sessionID SessionRef, self HostPatchRef) (_retval HostPatchRecord, _err error)

Get a record containing the current state of the given host_patch.

func (HostPatchClass) GetSize 

func (_class HostPatchClass) GetSize(sessionID SessionRef, self HostPatchRef) (_retval int, _err error)

Get the size field of the given host_patch.

func (HostPatchClass) GetTimestampApplied 

func (_class HostPatchClass) GetTimestampApplied(sessionID SessionRef, self HostPatchRef) (_retval time.Time, _err error)

Get the timestamp_applied field of the given host_patch.

func (HostPatchClass) GetUUID 

func (_class HostPatchClass) GetUUID(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

Get the uuid field of the given host_patch.

func (HostPatchClass) GetVersion 

func (_class HostPatchClass) GetVersion(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

Get the version field of the given host_patch.

func (HostPatchClass) RemoveFromOtherConfig 

func (_class HostPatchClass) RemoveFromOtherConfig(sessionID SessionRef, self HostPatchRef, key string) (_err error)

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.

func (HostPatchClass) SetOtherConfig 

func (_class HostPatchClass) SetOtherConfig(sessionID SessionRef, self HostPatchRef, value map[string]string) (_err error)

Set the other_config field of the given host_patch.

type HostPatchRecord 

type HostPatchRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Patch version number
	Version string
	// Host the patch relates to
	Host HostRef
	// True if the patch has been applied
	Applied bool
	// Time the patch was applied
	TimestampApplied time.Time
	// Size of the patch
	Size int
	// The patch applied
	PoolPatch PoolPatchRef
	// additional configuration
	OtherConfig map[string]string
}

type HostPatchRef 

type HostPatchRef string

type HostRecord 

type HostRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Virtualization memory overhead (bytes).
	MemoryOverhead int
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []HostAllowedOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]HostAllowedOperations
	// major version number
	APIVersionMajor int
	// minor version number
	APIVersionMinor int
	// identification of vendor
	APIVersionVendor string
	// details of vendor implementation
	APIVersionVendorImplementation map[string]string
	// True if the host is currently enabled
	Enabled bool
	// version strings
	SoftwareVersion map[string]string
	// additional configuration
	OtherConfig map[string]string
	// Xen capabilities
	Capabilities []string
	// The CPU configuration on this host.  May contain keys such as "nr_nodes", "sockets_per_node", "cores_per_socket", or "threads_per_core"
	CPUConfiguration map[string]string
	// Scheduler policy currently in force on this host
	SchedPolicy string
	// a list of the bootloaders installed on the machine
	SupportedBootloaders []string
	// list of VMs currently resident on host
	ResidentVMs []VMRef
	// logging configuration
	Logging map[string]string
	// physical network interfaces
	PIFs []PIFRef
	// The SR in which VDIs for suspend images are created
	SuspendImageSr SRRef
	// The SR in which VDIs for crash dumps are created
	CrashDumpSr SRRef
	// Set of host crash dumps
	Crashdumps []HostCrashdumpRef
	// Set of host patches
	Patches []HostPatchRef
	// physical blockdevices
	PBDs []PBDRef
	// The physical CPUs on this host
	HostCPUs []HostCPURef
	// Details about the physical CPUs on this host
	CPUInfo map[string]string
	// The hostname of this host
	Hostname string
	// The address by which this host can be contacted from any other host in the pool
	Address string
	// metrics associated with this host
	Metrics HostMetricsRef
	// State of the current license
	LicenseParams map[string]string
	// The set of statefiles accessible from this host
	HaStatefiles []string
	// The set of hosts visible via the network from this host
	HaNetworkPeers []string
	// Binary blobs associated with this host
	Blobs map[string]BlobRef
	// user-specified tags for categorization purposes
	Tags []string
	// type of external authentication service configured; empty if none configured.
	ExternalAuthType string
	// name of external authentication service configured; empty if none configured.
	ExternalAuthServiceName string
	// configuration specific to external authentication service
	ExternalAuthConfiguration map[string]string
	// XenServer edition
	Edition string
	// Contact information of the license server
	LicenseServer map[string]string
	// BIOS strings
	BiosStrings map[string]string
	// The power on mode
	PowerOnMode string
	// The power on config
	PowerOnConfig map[string]string
	// The SR that is used as a local cache
	LocalCacheSr SRRef
	// Information about chipset features
	ChipsetInfo map[string]string
	// List of PCI devices in the host
	PCIs []PCIRef
	// List of physical GPUs in the host
	PGPUs []PGPURef
	// Allow SSLv3 protocol and ciphersuites as used by older XenServers
	SslLegacy bool
	// VCPUs params to apply to all resident guests
	GuestVCPUsParams map[string]string
	// indicates whether the host is configured to output its console to a physical display device
	Display HostDisplay
	// The set of versions of the virtual hardware platform that the host can offer to its guests
	VirtualHardwarePlatformVersions []int
}

type HostRef 

type HostRef string

type IPConfigurationMode 

type IPConfigurationMode string
const (
	// Do not acquire an IP address
	IPConfigurationModeNone IPConfigurationMode = "None"
	// Acquire an IP address by DHCP
	IPConfigurationModeDHCP IPConfigurationMode = "DHCP"
	// Static IP address configuration
	IPConfigurationModeStatic IPConfigurationMode = "Static"
)

type Ipv6ConfigurationMode 

type Ipv6ConfigurationMode string
const (
	// Do not acquire an IPv6 address
	Ipv6ConfigurationModeNone Ipv6ConfigurationMode = "None"
	// Acquire an IPv6 address by DHCP
	Ipv6ConfigurationModeDHCP Ipv6ConfigurationMode = "DHCP"
	// Static IPv6 address configuration
	Ipv6ConfigurationModeStatic Ipv6ConfigurationMode = "Static"
	// Router assigned prefix delegation IPv6 allocation
	Ipv6ConfigurationModeAutoconf Ipv6ConfigurationMode = "Autoconf"
)

type MessageClass 

type MessageClass struct {
	// contains filtered or unexported fields
}

An message for the attention of the administrator

func (MessageClass) Create 

func (_class MessageClass) Create(sessionID SessionRef, name string, priority int, cls Cls, objUUID string, body string) (_retval MessageRef, _err error)

func (MessageClass) Destroy 

func (_class MessageClass) Destroy(sessionID SessionRef, self MessageRef) (_err error)

func (MessageClass) Get 

func (_class MessageClass) Get(sessionID SessionRef, cls Cls, objUUID string, since time.Time) (_retval map[MessageRef]MessageRecord, _err error)

func (MessageClass) GetAll 

func (_class MessageClass) GetAll(sessionID SessionRef) (_retval []MessageRef, _err error)

func (MessageClass) GetAllRecords 

func (_class MessageClass) GetAllRecords(sessionID SessionRef) (_retval map[MessageRef]MessageRecord, _err error)

func (MessageClass) GetAllRecordsWhere 

func (_class MessageClass) GetAllRecordsWhere(sessionID SessionRef, expr string) (_retval map[MessageRef]MessageRecord, _err error)

func (MessageClass) GetByUUID 

func (_class MessageClass) GetByUUID(sessionID SessionRef, uuid string) (_retval MessageRef, _err error)

func (MessageClass) GetRecord 

func (_class MessageClass) GetRecord(sessionID SessionRef, self MessageRef) (_retval MessageRecord, _err error)

func (MessageClass) GetSince 

func (_class MessageClass) GetSince(sessionID SessionRef, since time.Time) (_retval map[MessageRef]MessageRecord, _err error)

type MessageRecord 

type MessageRecord struct {
	// Unique identifier/object reference
	UUID string
	// The name of the message
	Name string
	// The message priority, 0 being low priority
	Priority int
	// The class of the object this message is associated with
	Cls Cls
	// The uuid of the object this message is associated with
	ObjUUID string
	// The time at which the message was created
	Timestamp time.Time
	// The body of the message
	Body string
}

type MessageRef 

type MessageRef string

type NetworkClass 

type NetworkClass struct {
	// contains filtered or unexported fields
}

A virtual network

func (NetworkClass) AddTags 

func (_class NetworkClass) AddTags(sessionID SessionRef, self NetworkRef, value string) (_err error)

Add the given value to the tags field of the given network. If the value is already in that Set, then do nothing.

func (NetworkClass) AddToOtherConfig 

func (_class NetworkClass) AddToOtherConfig(sessionID SessionRef, self NetworkRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given network.

func (NetworkClass) Create 

func (_class NetworkClass) Create(sessionID SessionRef, args NetworkRecord) (_retval NetworkRef, _err error)

Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config*, tags (* = non-optional).

func (NetworkClass) CreateNewBlob 

func (_class NetworkClass) CreateNewBlob(sessionID SessionRef, network NetworkRef, name string, mimeType string, public bool) (_retval BlobRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this pool

func (NetworkClass) Destroy 

func (_class NetworkClass) Destroy(sessionID SessionRef, self NetworkRef) (_err error)

Destroy the specified network instance.

func (NetworkClass) GetAll 

func (_class NetworkClass) GetAll(sessionID SessionRef) (_retval []NetworkRef, _err error)

Return a list of all the networks known to the system.

func (NetworkClass) GetAllRecords 

func (_class NetworkClass) GetAllRecords(sessionID SessionRef) (_retval map[NetworkRef]NetworkRecord, _err error)

Return a map of network references to network records for all networks known to the system.

func (NetworkClass) GetAllowedOperations 

func (_class NetworkClass) GetAllowedOperations(sessionID SessionRef, self NetworkRef) (_retval []NetworkOperations, _err error)

Get the allowed_operations field of the given network.

func (NetworkClass) GetAssignedIps 

func (_class NetworkClass) GetAssignedIps(sessionID SessionRef, self NetworkRef) (_retval map[VIFRef]string, _err error)

Get the assigned_ips field of the given network.

func (NetworkClass) GetBlobs 

func (_class NetworkClass) GetBlobs(sessionID SessionRef, self NetworkRef) (_retval map[string]BlobRef, _err error)

Get the blobs field of the given network.

func (NetworkClass) GetBridge 

func (_class NetworkClass) GetBridge(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

Get the bridge field of the given network.

func (NetworkClass) GetByNameLabel 

func (_class NetworkClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []NetworkRef, _err error)

Get all the network instances with the given label.

func (NetworkClass) GetByUUID 

func (_class NetworkClass) GetByUUID(sessionID SessionRef, uuid string) (_retval NetworkRef, _err error)

Get a reference to the network instance with the specified UUID.

func (NetworkClass) GetCurrentOperations 

func (_class NetworkClass) GetCurrentOperations(sessionID SessionRef, self NetworkRef) (_retval map[string]NetworkOperations, _err error)

Get the current_operations field of the given network.

func (NetworkClass) GetDefaultLockingMode 

func (_class NetworkClass) GetDefaultLockingMode(sessionID SessionRef, self NetworkRef) (_retval NetworkDefaultLockingMode, _err error)

Get the default_locking_mode field of the given network.

func (NetworkClass) GetMTU 

func (_class NetworkClass) GetMTU(sessionID SessionRef, self NetworkRef) (_retval int, _err error)

Get the MTU field of the given network.

func (NetworkClass) GetNameDescription 

func (_class NetworkClass) GetNameDescription(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

Get the name/description field of the given network.

func (NetworkClass) GetNameLabel 

func (_class NetworkClass) GetNameLabel(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

Get the name/label field of the given network.

func (NetworkClass) GetOtherConfig 

func (_class NetworkClass) GetOtherConfig(sessionID SessionRef, self NetworkRef) (_retval map[string]string, _err error)

Get the other_config field of the given network.

func (NetworkClass) GetPIFs 

func (_class NetworkClass) GetPIFs(sessionID SessionRef, self NetworkRef) (_retval []PIFRef, _err error)

Get the PIFs field of the given network.

func (NetworkClass) GetRecord 

func (_class NetworkClass) GetRecord(sessionID SessionRef, self NetworkRef) (_retval NetworkRecord, _err error)

Get a record containing the current state of the given network.

func (NetworkClass) GetTags 

func (_class NetworkClass) GetTags(sessionID SessionRef, self NetworkRef) (_retval []string, _err error)

Get the tags field of the given network.

func (NetworkClass) GetUUID 

func (_class NetworkClass) GetUUID(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

Get the uuid field of the given network.

func (NetworkClass) GetVIFs 

func (_class NetworkClass) GetVIFs(sessionID SessionRef, self NetworkRef) (_retval []VIFRef, _err error)

Get the VIFs field of the given network.

func (NetworkClass) RemoveFromOtherConfig 

func (_class NetworkClass) RemoveFromOtherConfig(sessionID SessionRef, self NetworkRef, key string) (_err error)

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.

func (NetworkClass) RemoveTags 

func (_class NetworkClass) RemoveTags(sessionID SessionRef, self NetworkRef, value string) (_err error)

Remove the given value from the tags field of the given network. If the value is not in that Set, then do nothing.

func (NetworkClass) SetDefaultLockingMode 

func (_class NetworkClass) SetDefaultLockingMode(sessionID SessionRef, network NetworkRef, value NetworkDefaultLockingMode) (_err error)

Set the default locking mode for VIFs attached to this network

func (NetworkClass) SetMTU 

func (_class NetworkClass) SetMTU(sessionID SessionRef, self NetworkRef, value int) (_err error)

Set the MTU field of the given network.

func (NetworkClass) SetNameDescription 

func (_class NetworkClass) SetNameDescription(sessionID SessionRef, self NetworkRef, value string) (_err error)

Set the name/description field of the given network.

func (NetworkClass) SetNameLabel 

func (_class NetworkClass) SetNameLabel(sessionID SessionRef, self NetworkRef, value string) (_err error)

Set the name/label field of the given network.

func (NetworkClass) SetOtherConfig 

func (_class NetworkClass) SetOtherConfig(sessionID SessionRef, self NetworkRef, value map[string]string) (_err error)

Set the other_config field of the given network.

func (NetworkClass) SetTags 

func (_class NetworkClass) SetTags(sessionID SessionRef, self NetworkRef, value []string) (_err error)

Set the tags field of the given network.

type NetworkDefaultLockingMode 

type NetworkDefaultLockingMode string
const (
	// Treat all VIFs on this network with locking_mode = 'default' as if they have locking_mode = 'unlocked'
	NetworkDefaultLockingModeUnlocked NetworkDefaultLockingMode = "unlocked"
	// Treat all VIFs on this network with locking_mode = 'default' as if they have locking_mode = 'disabled'
	NetworkDefaultLockingModeDisabled NetworkDefaultLockingMode = "disabled"
)

type NetworkOperations 

type NetworkOperations string
const (
	// Indicates this network is attaching to a VIF or PIF
	NetworkOperationsAttaching NetworkOperations = "attaching"
)

type NetworkRecord 

type NetworkRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []NetworkOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]NetworkOperations
	// list of connected vifs
	VIFs []VIFRef
	// list of connected pifs
	PIFs []PIFRef
	// MTU in octets
	MTU int
	// additional configuration
	OtherConfig map[string]string
	// name of the bridge corresponding to this network on the local host
	Bridge string
	// Binary blobs associated with this network
	Blobs map[string]BlobRef
	// user-specified tags for categorization purposes
	Tags []string
	// The network will use this value to determine the behaviour of all VIFs where locking_mode = default
	DefaultLockingMode NetworkDefaultLockingMode
	// The IP addresses assigned to VIFs on networks that have active xapi-managed DHCP
	AssignedIps map[VIFRef]string
}

type NetworkRef 

type NetworkRef string

type OnBoot 

type OnBoot string
const (
	// When a VM containing this VDI is started, the contents of the VDI are reset to the state they were in when this flag was last set.
	OnBootReset OnBoot = "reset"
	// Standard behaviour.
	OnBootPersist OnBoot = "persist"
)

type OnCrashBehaviour 

type OnCrashBehaviour string
const (
	// destroy the VM state
	OnCrashBehaviourDestroy OnCrashBehaviour = "destroy"
	// record a coredump and then destroy the VM state
	OnCrashBehaviourCoredumpAndDestroy OnCrashBehaviour = "coredump_and_destroy"
	// restart the VM
	OnCrashBehaviourRestart OnCrashBehaviour = "restart"
	// record a coredump and then restart the VM
	OnCrashBehaviourCoredumpAndRestart OnCrashBehaviour = "coredump_and_restart"
	// leave the crashed VM paused
	OnCrashBehaviourPreserve OnCrashBehaviour = "preserve"
	// rename the crashed VM and start a new copy
	OnCrashBehaviourRenameRestart OnCrashBehaviour = "rename_restart"
)

type OnNormalExit 

type OnNormalExit string
const (
	// destroy the VM state
	OnNormalExitDestroy OnNormalExit = "destroy"
	// restart the VM
	OnNormalExitRestart OnNormalExit = "restart"
)

type PBDClass 

type PBDClass struct {
	// contains filtered or unexported fields
}

The physical block devices through which hosts access SRs

func (PBDClass) AddToOtherConfig 

func (_class PBDClass) AddToOtherConfig(sessionID SessionRef, self PBDRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given PBD.

func (PBDClass) Create 

func (_class PBDClass) Create(sessionID SessionRef, args PBDRecord) (_retval PBDRef, _err error)

Create a new PBD instance, and return its handle. The constructor args are: host*, SR*, device_config*, other_config (* = non-optional).

func (PBDClass) Destroy 

func (_class PBDClass) Destroy(sessionID SessionRef, self PBDRef) (_err error)

Destroy the specified PBD instance.

func (PBDClass) GetAll 

func (_class PBDClass) GetAll(sessionID SessionRef) (_retval []PBDRef, _err error)

Return a list of all the PBDs known to the system.

func (PBDClass) GetAllRecords 

func (_class PBDClass) GetAllRecords(sessionID SessionRef) (_retval map[PBDRef]PBDRecord, _err error)

Return a map of PBD references to PBD records for all PBDs known to the system.

func (PBDClass) GetByUUID 

func (_class PBDClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PBDRef, _err error)

Get a reference to the PBD instance with the specified UUID.

func (PBDClass) GetCurrentlyAttached 

func (_class PBDClass) GetCurrentlyAttached(sessionID SessionRef, self PBDRef) (_retval bool, _err error)

Get the currently_attached field of the given PBD.

func (PBDClass) GetDeviceConfig 

func (_class PBDClass) GetDeviceConfig(sessionID SessionRef, self PBDRef) (_retval map[string]string, _err error)

Get the device_config field of the given PBD.

func (PBDClass) GetHost 

func (_class PBDClass) GetHost(sessionID SessionRef, self PBDRef) (_retval HostRef, _err error)

Get the host field of the given PBD.

func (PBDClass) GetOtherConfig 

func (_class PBDClass) GetOtherConfig(sessionID SessionRef, self PBDRef) (_retval map[string]string, _err error)

Get the other_config field of the given PBD.

func (PBDClass) GetRecord 

func (_class PBDClass) GetRecord(sessionID SessionRef, self PBDRef) (_retval PBDRecord, _err error)

Get a record containing the current state of the given PBD.

func (PBDClass) GetSR 

func (_class PBDClass) GetSR(sessionID SessionRef, self PBDRef) (_retval SRRef, _err error)

Get the SR field of the given PBD.

func (PBDClass) GetUUID 

func (_class PBDClass) GetUUID(sessionID SessionRef, self PBDRef) (_retval string, _err error)

Get the uuid field of the given PBD.

func (PBDClass) Plug 

func (_class PBDClass) Plug(sessionID SessionRef, self PBDRef) (_err error)

Activate the specified PBD, causing the referenced SR to be attached and scanned

Errors: 

SR_UNKNOWN_DRIVER - The SR could not be connected because the driver was not recognised.

func (PBDClass) RemoveFromOtherConfig 

func (_class PBDClass) RemoveFromOtherConfig(sessionID SessionRef, self PBDRef, key string) (_err error)

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.

func (PBDClass) SetDeviceConfig 

func (_class PBDClass) SetDeviceConfig(sessionID SessionRef, self PBDRef, value map[string]string) (_err error)

Sets the PBD's device_config field

func (PBDClass) SetOtherConfig 

func (_class PBDClass) SetOtherConfig(sessionID SessionRef, self PBDRef, value map[string]string) (_err error)

Set the other_config field of the given PBD.

func (PBDClass) Unplug 

func (_class PBDClass) Unplug(sessionID SessionRef, self PBDRef) (_err error)

Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned

type PBDRecord 

type PBDRecord struct {
	// Unique identifier/object reference
	UUID string
	// physical machine on which the pbd is available
	Host HostRef
	// the storage repository that the pbd realises
	SR SRRef
	// a config string to string map that is provided to the host's SR-backend-driver
	DeviceConfig map[string]string
	// is the SR currently attached on this host?
	CurrentlyAttached bool
	// additional configuration
	OtherConfig map[string]string
}

type PBDRef 

type PBDRef string

type PCIClass 

type PCIClass struct {
	// contains filtered or unexported fields
}

A PCI device

func (PCIClass) AddToOtherConfig 

func (_class PCIClass) AddToOtherConfig(sessionID SessionRef, self PCIRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given PCI.

func (PCIClass) GetAll 

func (_class PCIClass) GetAll(sessionID SessionRef) (_retval []PCIRef, _err error)

Return a list of all the PCIs known to the system.

func (PCIClass) GetAllRecords 

func (_class PCIClass) GetAllRecords(sessionID SessionRef) (_retval map[PCIRef]PCIRecord, _err error)

Return a map of PCI references to PCI records for all PCIs known to the system.

func (PCIClass) GetByUUID 

func (_class PCIClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PCIRef, _err error)

Get a reference to the PCI instance with the specified UUID.

func (PCIClass) GetClassName 

func (_class PCIClass) GetClassName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the class_name field of the given PCI.

func (PCIClass) GetDependencies 

func (_class PCIClass) GetDependencies(sessionID SessionRef, self PCIRef) (_retval []PCIRef, _err error)

Get the dependencies field of the given PCI.

func (PCIClass) GetDeviceName 

func (_class PCIClass) GetDeviceName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the device_name field of the given PCI.

func (PCIClass) GetHost 

func (_class PCIClass) GetHost(sessionID SessionRef, self PCIRef) (_retval HostRef, _err error)

Get the host field of the given PCI.

func (PCIClass) GetOtherConfig 

func (_class PCIClass) GetOtherConfig(sessionID SessionRef, self PCIRef) (_retval map[string]string, _err error)

Get the other_config field of the given PCI.

func (PCIClass) GetPciID 

func (_class PCIClass) GetPciID(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the pci_id field of the given PCI.

func (PCIClass) GetRecord 

func (_class PCIClass) GetRecord(sessionID SessionRef, self PCIRef) (_retval PCIRecord, _err error)

Get a record containing the current state of the given PCI.

func (PCIClass) GetSubsystemDeviceName 

func (_class PCIClass) GetSubsystemDeviceName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the subsystem_device_name field of the given PCI.

func (PCIClass) GetSubsystemVendorName 

func (_class PCIClass) GetSubsystemVendorName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the subsystem_vendor_name field of the given PCI.

func (PCIClass) GetUUID 

func (_class PCIClass) GetUUID(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the uuid field of the given PCI.

func (PCIClass) GetVendorName 

func (_class PCIClass) GetVendorName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

Get the vendor_name field of the given PCI.

func (PCIClass) RemoveFromOtherConfig 

func (_class PCIClass) RemoveFromOtherConfig(sessionID SessionRef, self PCIRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given PCI. If the key is not in that Map, then do nothing.

func (PCIClass) SetOtherConfig 

func (_class PCIClass) SetOtherConfig(sessionID SessionRef, self PCIRef, value map[string]string) (_err error)

Set the other_config field of the given PCI.

type PCIRecord 

type PCIRecord struct {
	// Unique identifier/object reference
	UUID string
	// PCI class name
	ClassName string
	// Vendor name
	VendorName string
	// Device name
	DeviceName string
	// Physical machine that owns the PCI device
	Host HostRef
	// PCI ID of the physical device
	PciID string
	// List of dependent PCI devices
	Dependencies []PCIRef
	// Additional configuration
	OtherConfig map[string]string
	// Subsystem vendor name
	SubsystemVendorName string
	// Subsystem device name
	SubsystemDeviceName string
}

type PCIRef 

type PCIRef string

type PGPUClass 

type PGPUClass struct {
	// contains filtered or unexported fields
}

A physical GPU (pGPU)

func (PGPUClass) AddEnabledVGPUTypes 

func (_class PGPUClass) AddEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value VGPUTypeRef) (_err error)

func (PGPUClass) AddToOtherConfig 

func (_class PGPUClass) AddToOtherConfig(sessionID SessionRef, self PGPURef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given PGPU.

func (PGPUClass) DisableDom0Access 

func (_class PGPUClass) DisableDom0Access(sessionID SessionRef, self PGPURef) (_retval PgpuDom0Access, _err error)

func (PGPUClass) EnableDom0Access 

func (_class PGPUClass) EnableDom0Access(sessionID SessionRef, self PGPURef) (_retval PgpuDom0Access, _err error)

func (PGPUClass) GetAll 

func (_class PGPUClass) GetAll(sessionID SessionRef) (_retval []PGPURef, _err error)

Return a list of all the PGPUs known to the system.

func (PGPUClass) GetAllRecords 

func (_class PGPUClass) GetAllRecords(sessionID SessionRef) (_retval map[PGPURef]PGPURecord, _err error)

Return a map of PGPU references to PGPU records for all PGPUs known to the system.

func (PGPUClass) GetByUUID 

func (_class PGPUClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PGPURef, _err error)

Get a reference to the PGPU instance with the specified UUID.

func (PGPUClass) GetDom0Access 

func (_class PGPUClass) GetDom0Access(sessionID SessionRef, self PGPURef) (_retval PgpuDom0Access, _err error)

Get the dom0_access field of the given PGPU.

func (PGPUClass) GetEnabledVGPUTypes 

func (_class PGPUClass) GetEnabledVGPUTypes(sessionID SessionRef, self PGPURef) (_retval []VGPUTypeRef, _err error)

Get the enabled_VGPU_types field of the given PGPU.

func (PGPUClass) GetGPUGroup 

func (_class PGPUClass) GetGPUGroup(sessionID SessionRef, self PGPURef) (_retval GPUGroupRef, _err error)

Get the GPU_group field of the given PGPU.

func (PGPUClass) GetHost 

func (_class PGPUClass) GetHost(sessionID SessionRef, self PGPURef) (_retval HostRef, _err error)

Get the host field of the given PGPU.

func (PGPUClass) GetIsSystemDisplayDevice 

func (_class PGPUClass) GetIsSystemDisplayDevice(sessionID SessionRef, self PGPURef) (_retval bool, _err error)

Get the is_system_display_device field of the given PGPU.

func (PGPUClass) GetOtherConfig 

func (_class PGPUClass) GetOtherConfig(sessionID SessionRef, self PGPURef) (_retval map[string]string, _err error)

Get the other_config field of the given PGPU.

func (PGPUClass) GetPCI 

func (_class PGPUClass) GetPCI(sessionID SessionRef, self PGPURef) (_retval PCIRef, _err error)

Get the PCI field of the given PGPU.

func (PGPUClass) GetRecord 

func (_class PGPUClass) GetRecord(sessionID SessionRef, self PGPURef) (_retval PGPURecord, _err error)

Get a record containing the current state of the given PGPU.

func (PGPUClass) GetRemainingCapacity 

func (_class PGPUClass) GetRemainingCapacity(sessionID SessionRef, self PGPURef, vgpuType VGPUTypeRef) (_retval int, _err error)

func (PGPUClass) GetResidentVGPUs 

func (_class PGPUClass) GetResidentVGPUs(sessionID SessionRef, self PGPURef) (_retval []VGPURef, _err error)

Get the resident_VGPUs field of the given PGPU.

func (PGPUClass) GetSupportedVGPUMaxCapacities 

func (_class PGPUClass) GetSupportedVGPUMaxCapacities(sessionID SessionRef, self PGPURef) (_retval map[VGPUTypeRef]int, _err error)

Get the supported_VGPU_max_capacities field of the given PGPU.

func (PGPUClass) GetSupportedVGPUTypes 

func (_class PGPUClass) GetSupportedVGPUTypes(sessionID SessionRef, self PGPURef) (_retval []VGPUTypeRef, _err error)

Get the supported_VGPU_types field of the given PGPU.

func (PGPUClass) GetUUID 

func (_class PGPUClass) GetUUID(sessionID SessionRef, self PGPURef) (_retval string, _err error)

Get the uuid field of the given PGPU.

func (PGPUClass) RemoveEnabledVGPUTypes 

func (_class PGPUClass) RemoveEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value VGPUTypeRef) (_err error)

func (PGPUClass) RemoveFromOtherConfig 

func (_class PGPUClass) RemoveFromOtherConfig(sessionID SessionRef, self PGPURef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given PGPU. If the key is not in that Map, then do nothing.

func (PGPUClass) SetEnabledVGPUTypes 

func (_class PGPUClass) SetEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value []VGPUTypeRef) (_err error)

func (PGPUClass) SetGPUGroup 

func (_class PGPUClass) SetGPUGroup(sessionID SessionRef, self PGPURef, value GPUGroupRef) (_err error)

func (PGPUClass) SetOtherConfig 

func (_class PGPUClass) SetOtherConfig(sessionID SessionRef, self PGPURef, value map[string]string) (_err error)

Set the other_config field of the given PGPU.

type PGPURecord 

type PGPURecord struct {
	// Unique identifier/object reference
	UUID string
	// Link to underlying PCI device
	PCI PCIRef
	// GPU group the pGPU is contained in
	GPUGroup GPUGroupRef
	// Host that own the GPU
	Host HostRef
	// Additional configuration
	OtherConfig map[string]string
	// List of VGPU types supported by the underlying hardware
	SupportedVGPUTypes []VGPUTypeRef
	// List of VGPU types which have been enabled for this PGPU
	EnabledVGPUTypes []VGPUTypeRef
	// List of VGPUs running on this PGPU
	ResidentVGPUs []VGPURef
	// A map relating each VGPU type supported on this GPU to the maximum number of VGPUs of that type which can run simultaneously on this GPU
	SupportedVGPUMaxCapacities map[VGPUTypeRef]int
	// The accessibility of this device from dom0
	Dom0Access PgpuDom0Access
	// Is this device the system display device
	IsSystemDisplayDevice bool
}

type PGPURef 

type PGPURef string

type PIFClass 

type PIFClass struct {
	// contains filtered or unexported fields
}

A physical network interface (note separate VLANs are represented as several PIFs)

func (PIFClass) AddToOtherConfig 

func (_class PIFClass) AddToOtherConfig(sessionID SessionRef, self PIFRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given PIF.

func (PIFClass) CreateVLAN 

func (_class PIFClass) CreateVLAN(sessionID SessionRef, device string, network NetworkRef, host HostRef, vlan int) (_retval PIFRef, _err error)

Create a VLAN interface from an existing physical interface. This call is deprecated: use VLAN.create instead

Errors: 

VLAN_TAG_INVALID - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.  The parameter echoes the VLAN tag you gave.

func (PIFClass) DbForget 

func (_class PIFClass) DbForget(sessionID SessionRef, self PIFRef) (_err error)

Destroy a PIF database record.

func (PIFClass) DbIntroduce 

func (_class PIFClass) DbIntroduce(sessionID SessionRef, device string, network NetworkRef, host HostRef, mac string, mtu int, vlan int, physical bool, ipConfigurationMode IPConfigurationMode, ip string, netmask string, gateway string, dns string, bondSlaveOf BondRef, vlanMasterOf VLANRef, management bool, otherConfig map[string]string, disallowUnplug bool, ipv6ConfigurationMode Ipv6ConfigurationMode, ipv6 []string, ipv6Gateway string, primaryAddressType PrimaryAddressType, managed bool, properties map[string]string) (_retval PIFRef, _err error)

Create a new PIF record in the database only

func (PIFClass) Destroy 

func (_class PIFClass) Destroy(sessionID SessionRef, self PIFRef) (_err error)

Destroy the PIF object (provided it is a VLAN interface). This call is deprecated: use VLAN.destroy or Bond.destroy instead

Errors: 

PIF_IS_PHYSICAL - You tried to destroy a PIF, but it represents an aspect of the physical host configuration, and so cannot be destroyed.  The parameter echoes the PIF handle you gave.

func (PIFClass) Forget 

func (_class PIFClass) Forget(sessionID SessionRef, self PIFRef) (_err error)

Destroy the PIF object matching a particular network interface

Errors: 

PIF_TUNNEL_STILL_EXISTS - Operation cannot proceed while a tunnel exists on this interface.

func (PIFClass) GetAll 

func (_class PIFClass) GetAll(sessionID SessionRef) (_retval []PIFRef, _err error)

Return a list of all the PIFs known to the system.

func (PIFClass) GetAllRecords 

func (_class PIFClass) GetAllRecords(sessionID SessionRef) (_retval map[PIFRef]PIFRecord, _err error)

Return a map of PIF references to PIF records for all PIFs known to the system.

func (PIFClass) GetBondMasterOf 

func (_class PIFClass) GetBondMasterOf(sessionID SessionRef, self PIFRef) (_retval []BondRef, _err error)

Get the bond_master_of field of the given PIF.

func (PIFClass) GetBondSlaveOf 

func (_class PIFClass) GetBondSlaveOf(sessionID SessionRef, self PIFRef) (_retval BondRef, _err error)

Get the bond_slave_of field of the given PIF.

func (PIFClass) GetByUUID 

func (_class PIFClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PIFRef, _err error)

Get a reference to the PIF instance with the specified UUID.

func (PIFClass) GetCapabilities 

func (_class PIFClass) GetCapabilities(sessionID SessionRef, self PIFRef) (_retval []string, _err error)

Get the capabilities field of the given PIF.

func (PIFClass) GetCurrentlyAttached 

func (_class PIFClass) GetCurrentlyAttached(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

Get the currently_attached field of the given PIF.

func (PIFClass) GetDNS 

func (_class PIFClass) GetDNS(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the DNS field of the given PIF.

func (PIFClass) GetDevice 

func (_class PIFClass) GetDevice(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the device field of the given PIF.

func (PIFClass) GetDisallowUnplug 

func (_class PIFClass) GetDisallowUnplug(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

Get the disallow_unplug field of the given PIF.

func (PIFClass) GetGateway 

func (_class PIFClass) GetGateway(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the gateway field of the given PIF.

func (PIFClass) GetHost 

func (_class PIFClass) GetHost(sessionID SessionRef, self PIFRef) (_retval HostRef, _err error)

Get the host field of the given PIF.

func (PIFClass) GetIP 

func (_class PIFClass) GetIP(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the IP field of the given PIF.

func (PIFClass) GetIPConfigurationMode 

func (_class PIFClass) GetIPConfigurationMode(sessionID SessionRef, self PIFRef) (_retval IPConfigurationMode, _err error)

Get the ip_configuration_mode field of the given PIF.

func (PIFClass) GetIPv6 

func (_class PIFClass) GetIPv6(sessionID SessionRef, self PIFRef) (_retval []string, _err error)

Get the IPv6 field of the given PIF.

func (PIFClass) GetIpv6ConfigurationMode 

func (_class PIFClass) GetIpv6ConfigurationMode(sessionID SessionRef, self PIFRef) (_retval Ipv6ConfigurationMode, _err error)

Get the ipv6_configuration_mode field of the given PIF.

func (PIFClass) GetIpv6Gateway 

func (_class PIFClass) GetIpv6Gateway(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the ipv6_gateway field of the given PIF.

func (PIFClass) GetMAC 

func (_class PIFClass) GetMAC(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the MAC field of the given PIF.

func (PIFClass) GetMTU 

func (_class PIFClass) GetMTU(sessionID SessionRef, self PIFRef) (_retval int, _err error)

Get the MTU field of the given PIF.

func (PIFClass) GetManaged 

func (_class PIFClass) GetManaged(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

Get the managed field of the given PIF.

func (PIFClass) GetManagement 

func (_class PIFClass) GetManagement(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

Get the management field of the given PIF.

func (PIFClass) GetMetrics 

func (_class PIFClass) GetMetrics(sessionID SessionRef, self PIFRef) (_retval PIFMetricsRef, _err error)

Get the metrics field of the given PIF.

func (PIFClass) GetNetmask 

func (_class PIFClass) GetNetmask(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the netmask field of the given PIF.

func (PIFClass) GetNetwork 

func (_class PIFClass) GetNetwork(sessionID SessionRef, self PIFRef) (_retval NetworkRef, _err error)

Get the network field of the given PIF.

func (PIFClass) GetOtherConfig 

func (_class PIFClass) GetOtherConfig(sessionID SessionRef, self PIFRef) (_retval map[string]string, _err error)

Get the other_config field of the given PIF.

func (PIFClass) GetPhysical 

func (_class PIFClass) GetPhysical(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

Get the physical field of the given PIF.

func (PIFClass) GetPrimaryAddressType 

func (_class PIFClass) GetPrimaryAddressType(sessionID SessionRef, self PIFRef) (_retval PrimaryAddressType, _err error)

Get the primary_address_type field of the given PIF.

func (PIFClass) GetProperties 

func (_class PIFClass) GetProperties(sessionID SessionRef, self PIFRef) (_retval map[string]string, _err error)

Get the properties field of the given PIF.

func (PIFClass) GetRecord 

func (_class PIFClass) GetRecord(sessionID SessionRef, self PIFRef) (_retval PIFRecord, _err error)

Get a record containing the current state of the given PIF.

func (PIFClass) GetTunnelAccessPIFOf 

func (_class PIFClass) GetTunnelAccessPIFOf(sessionID SessionRef, self PIFRef) (_retval []TunnelRef, _err error)

Get the tunnel_access_PIF_of field of the given PIF.

func (PIFClass) GetTunnelTransportPIFOf 

func (_class PIFClass) GetTunnelTransportPIFOf(sessionID SessionRef, self PIFRef) (_retval []TunnelRef, _err error)

Get the tunnel_transport_PIF_of field of the given PIF.

func (PIFClass) GetUUID 

func (_class PIFClass) GetUUID(sessionID SessionRef, self PIFRef) (_retval string, _err error)

Get the uuid field of the given PIF.

func (PIFClass) GetVLAN 

func (_class PIFClass) GetVLAN(sessionID SessionRef, self PIFRef) (_retval int, _err error)

Get the VLAN field of the given PIF.

func (PIFClass) GetVLANMasterOf 

func (_class PIFClass) GetVLANMasterOf(sessionID SessionRef, self PIFRef) (_retval VLANRef, _err error)

Get the VLAN_master_of field of the given PIF.

func (PIFClass) GetVLANSlaveOf 

func (_class PIFClass) GetVLANSlaveOf(sessionID SessionRef, self PIFRef) (_retval []VLANRef, _err error)

Get the VLAN_slave_of field of the given PIF.

func (PIFClass) Introduce 

func (_class PIFClass) Introduce(sessionID SessionRef, host HostRef, mac string, device string, managed bool) (_retval PIFRef, _err error)

Create a PIF object matching a particular network interface

func (PIFClass) Plug 

func (_class PIFClass) Plug(sessionID SessionRef, self PIFRef) (_err error)

Attempt to bring up a physical interface

Errors: 

TRANSPORT_PIF_NOT_CONFIGURED - The tunnel transport PIF has no IP configuration set.

func (PIFClass) ReconfigureIP 

func (_class PIFClass) ReconfigureIP(sessionID SessionRef, self PIFRef, mode IPConfigurationMode, ip string, netmask string, gateway string, dns string) (_err error)

Reconfigure the IP address settings for this interface

func (PIFClass) ReconfigureIpv6 

func (_class PIFClass) ReconfigureIpv6(sessionID SessionRef, self PIFRef, mode Ipv6ConfigurationMode, ipv6 string, gateway string, dns string) (_err error)

Reconfigure the IPv6 address settings for this interface

func (PIFClass) RemoveFromOtherConfig 

func (_class PIFClass) RemoveFromOtherConfig(sessionID SessionRef, self PIFRef, key string) (_err error)

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.

func (PIFClass) Scan 

func (_class PIFClass) Scan(sessionID SessionRef, host HostRef) (_err error)

Scan for physical interfaces on a host and create PIF objects to represent them

func (PIFClass) SetDisallowUnplug 

func (_class PIFClass) SetDisallowUnplug(sessionID SessionRef, self PIFRef, value bool) (_err error)

Set the disallow_unplug field of the given PIF.

func (PIFClass) SetOtherConfig 

func (_class PIFClass) SetOtherConfig(sessionID SessionRef, self PIFRef, value map[string]string) (_err error)

Set the other_config field of the given PIF.

func (PIFClass) SetPrimaryAddressType 

func (_class PIFClass) SetPrimaryAddressType(sessionID SessionRef, self PIFRef, primaryAddressType PrimaryAddressType) (_err error)

Change the primary address type used by this PIF

func (PIFClass) SetProperty 

func (_class PIFClass) SetProperty(sessionID SessionRef, self PIFRef, name string, value string) (_err error)

Set the value of a property of the PIF

func (PIFClass) Unplug 

func (_class PIFClass) Unplug(sessionID SessionRef, self PIFRef) (_err error)

Attempt to bring down a physical interface

type PIFMetricsClass 

type PIFMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a physical network interface

func (PIFMetricsClass) AddToOtherConfig 

func (_class PIFMetricsClass) AddToOtherConfig(sessionID SessionRef, self PIFMetricsRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given PIF_metrics.

func (PIFMetricsClass) GetAll 

func (_class PIFMetricsClass) GetAll(sessionID SessionRef) (_retval []PIFMetricsRef, _err error)

Return a list of all the PIF_metrics instances known to the system.

func (PIFMetricsClass) GetAllRecords 

func (_class PIFMetricsClass) GetAllRecords(sessionID SessionRef) (_retval map[PIFMetricsRef]PIFMetricsRecord, _err error)

Return a map of PIF_metrics references to PIF_metrics records for all PIF_metrics instances known to the system.

func (PIFMetricsClass) GetByUUID 

func (_class PIFMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PIFMetricsRef, _err error)

Get a reference to the PIF_metrics instance with the specified UUID.

func (PIFMetricsClass) GetCarrier 

func (_class PIFMetricsClass) GetCarrier(sessionID SessionRef, self PIFMetricsRef) (_retval bool, _err error)

Get the carrier field of the given PIF_metrics.

func (PIFMetricsClass) GetDeviceID 

func (_class PIFMetricsClass) GetDeviceID(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

Get the device_id field of the given PIF_metrics.

func (PIFMetricsClass) GetDeviceName 

func (_class PIFMetricsClass) GetDeviceName(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

Get the device_name field of the given PIF_metrics.

func (PIFMetricsClass) GetDuplex 

func (_class PIFMetricsClass) GetDuplex(sessionID SessionRef, self PIFMetricsRef) (_retval bool, _err error)

Get the duplex field of the given PIF_metrics.

func (PIFMetricsClass) GetIoReadKbs 

func (_class PIFMetricsClass) GetIoReadKbs(sessionID SessionRef, self PIFMetricsRef) (_retval float64, _err error)

Get the io/read_kbs field of the given PIF_metrics.

func (PIFMetricsClass) GetIoWriteKbs 

func (_class PIFMetricsClass) GetIoWriteKbs(sessionID SessionRef, self PIFMetricsRef) (_retval float64, _err error)

Get the io/write_kbs field of the given PIF_metrics.

func (PIFMetricsClass) GetLastUpdated 

func (_class PIFMetricsClass) GetLastUpdated(sessionID SessionRef, self PIFMetricsRef) (_retval time.Time, _err error)

Get the last_updated field of the given PIF_metrics.

func (PIFMetricsClass) GetOtherConfig 

func (_class PIFMetricsClass) GetOtherConfig(sessionID SessionRef, self PIFMetricsRef) (_retval map[string]string, _err error)

Get the other_config field of the given PIF_metrics.

func (PIFMetricsClass) GetPciBusPath 

func (_class PIFMetricsClass) GetPciBusPath(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

Get the pci_bus_path field of the given PIF_metrics.

func (PIFMetricsClass) GetRecord 

func (_class PIFMetricsClass) GetRecord(sessionID SessionRef, self PIFMetricsRef) (_retval PIFMetricsRecord, _err error)

Get a record containing the current state of the given PIF_metrics.

func (PIFMetricsClass) GetSpeed 

func (_class PIFMetricsClass) GetSpeed(sessionID SessionRef, self PIFMetricsRef) (_retval int, _err error)

Get the speed field of the given PIF_metrics.

func (PIFMetricsClass) GetUUID 

func (_class PIFMetricsClass) GetUUID(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

Get the uuid field of the given PIF_metrics.

func (PIFMetricsClass) GetVendorID 

func (_class PIFMetricsClass) GetVendorID(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

Get the vendor_id field of the given PIF_metrics.

func (PIFMetricsClass) GetVendorName 

func (_class PIFMetricsClass) GetVendorName(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

Get the vendor_name field of the given PIF_metrics.

func (PIFMetricsClass) RemoveFromOtherConfig 

func (_class PIFMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self PIFMetricsRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given PIF_metrics. If the key is not in that Map, then do nothing.

func (PIFMetricsClass) SetOtherConfig 

func (_class PIFMetricsClass) SetOtherConfig(sessionID SessionRef, self PIFMetricsRef, value map[string]string) (_err error)

Set the other_config field of the given PIF_metrics.

type PIFMetricsRecord 

type PIFMetricsRecord struct {
	// Unique identifier/object reference
	UUID string
	// Read bandwidth (KiB/s)
	IoReadKbs float64
	// Write bandwidth (KiB/s)
	IoWriteKbs float64
	// Report if the PIF got a carrier or not
	Carrier bool
	// Report vendor ID
	VendorID string
	// Report vendor name
	VendorName string
	// Report device ID
	DeviceID string
	// Report device name
	DeviceName string
	// Speed of the link (if available)
	Speed int
	// Full duplex capability of the link (if available)
	Duplex bool
	// PCI bus path of the pif (if available)
	PciBusPath string
	// Time at which this information was last updated
	LastUpdated time.Time
	// additional configuration
	OtherConfig map[string]string
}

type PIFMetricsRef 

type PIFMetricsRef string

type PIFRecord 

type PIFRecord struct {
	// Unique identifier/object reference
	UUID string
	// machine-readable name of the interface (e.g. eth0)
	Device string
	// virtual network to which this pif is connected
	Network NetworkRef
	// physical machine to which this pif is connected
	Host HostRef
	// ethernet MAC address of physical interface
	MAC string
	// MTU in octets
	MTU int
	// VLAN tag for all traffic passing through this interface
	VLAN int
	// metrics associated with this PIF
	Metrics PIFMetricsRef
	// true if this represents a physical network interface
	Physical bool
	// true if this interface is online
	CurrentlyAttached bool
	// Sets if and how this interface gets an IP address
	IPConfigurationMode IPConfigurationMode
	// IP address
	IP string
	// IP netmask
	Netmask string
	// IP gateway
	Gateway string
	// IP address of DNS servers to use
	DNS string
	// Indicates which bond this interface is part of
	BondSlaveOf BondRef
	// Indicates this PIF represents the results of a bond
	BondMasterOf []BondRef
	// Indicates wich VLAN this interface receives untagged traffic from
	VLANMasterOf VLANRef
	// Indicates which VLANs this interface transmits tagged traffic to
	VLANSlaveOf []VLANRef
	// Indicates whether the control software is listening for connections on this interface
	Management bool
	// Additional configuration
	OtherConfig map[string]string
	// Prevent this PIF from being unplugged; set this to notify the management tool-stack that the PIF has a special use and should not be unplugged under any circumstances (e.g. because you're running storage traffic over it)
	DisallowUnplug bool
	// Indicates to which tunnel this PIF gives access
	TunnelAccessPIFOf []TunnelRef
	// Indicates to which tunnel this PIF provides transport
	TunnelTransportPIFOf []TunnelRef
	// Sets if and how this interface gets an IPv6 address
	Ipv6ConfigurationMode Ipv6ConfigurationMode
	// IPv6 address
	IPv6 []string
	// IPv6 gateway
	Ipv6Gateway string
	// Which protocol should define the primary address of this interface
	PrimaryAddressType PrimaryAddressType
	// Indicates whether the interface is managed by xapi. If it is not, then xapi will not configure the interface, the commands PIF.plug/unplug/reconfigure_ip(v6) can not be used, nor can the interface be bonded or have VLANs based on top through xapi.
	Managed bool
	// Additional configuration properties for the interface.
	Properties map[string]string
	// Additional capabilities on the interface.
	Capabilities []string
}

type PIFRef 

type PIFRef string

type PgpuDom0Access 

type PgpuDom0Access string
const (
	// dom0 can access this device as normal
	PgpuDom0AccessEnabled PgpuDom0Access = "enabled"
	// On host reboot dom0 will be blocked from accessing this device
	PgpuDom0AccessDisableOnReboot PgpuDom0Access = "disable_on_reboot"
	// dom0 cannot access this device
	PgpuDom0AccessDisabled PgpuDom0Access = "disabled"
	// On host reboot dom0 will be allowed to access this device
	PgpuDom0AccessEnableOnReboot PgpuDom0Access = "enable_on_reboot"
)

type PoolAllowedOperations 

type PoolAllowedOperations string
const (
	// Indicates this pool is in the process of enabling HA
	PoolAllowedOperationsHaEnable PoolAllowedOperations = "ha_enable"
	// Indicates this pool is in the process of disabling HA
	PoolAllowedOperationsHaDisable PoolAllowedOperations = "ha_disable"
)

type PoolClass 

type PoolClass struct {
	// contains filtered or unexported fields
}

Pool-wide information

func (PoolClass) AddTags 

func (_class PoolClass) AddTags(sessionID SessionRef, self PoolRef, value string) (_err error)

Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing.

func (PoolClass) AddToGuiConfig 

func (_class PoolClass) AddToGuiConfig(sessionID SessionRef, self PoolRef, key string, value string) (_err error)

Add the given key-value pair to the gui_config field of the given pool.

func (PoolClass) AddToHealthCheckConfig 

func (_class PoolClass) AddToHealthCheckConfig(sessionID SessionRef, self PoolRef, key string, value string) (_err error)

Add the given key-value pair to the health_check_config field of the given pool.

func (PoolClass) AddToOtherConfig 

func (_class PoolClass) AddToOtherConfig(sessionID SessionRef, self PoolRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given pool.

func (PoolClass) ApplyEdition 

func (_class PoolClass) ApplyEdition(sessionID SessionRef, self PoolRef, edition string) (_err error)

Apply an edition to all hosts in the pool

func (PoolClass) CertificateInstall 

func (_class PoolClass) CertificateInstall(sessionID SessionRef, name string, cert string) (_err error)

Install an SSL certificate pool-wide.

func (PoolClass) CertificateList 

func (_class PoolClass) CertificateList(sessionID SessionRef) (_retval []string, _err error)

List all installed SSL certificates.

func (PoolClass) CertificateSync 

func (_class PoolClass) CertificateSync(sessionID SessionRef) (_err error)

Sync SSL certificates from master to slaves.

func (PoolClass) CertificateUninstall 

func (_class PoolClass) CertificateUninstall(sessionID SessionRef, name string) (_err error)

Remove an SSL certificate.

func (PoolClass) CreateNewBlob 

func (_class PoolClass) CreateNewBlob(sessionID SessionRef, pool PoolRef, name string, mimeType string, public bool) (_retval BlobRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this pool

func (PoolClass) CreateVLAN 

func (_class PoolClass) CreateVLAN(sessionID SessionRef, device string, network NetworkRef, vlan int) (_retval []PIFRef, _err error)

Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead.

Errors: 

VLAN_TAG_INVALID - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.  The parameter echoes the VLAN tag you gave.

func (PoolClass) CreateVLANFromPIF 

func (_class PoolClass) CreateVLANFromPIF(sessionID SessionRef, pif PIFRef, network NetworkRef, vlan int) (_retval []PIFRef, _err error)

Create a pool-wide VLAN by taking the PIF.

Errors: 

VLAN_TAG_INVALID - You tried to create a VLAN, but the tag you gave was invalid -- it must be between 0 and 4094.  The parameter echoes the VLAN tag you gave.

func (PoolClass) CrlInstall 

func (_class PoolClass) CrlInstall(sessionID SessionRef, name string, cert string) (_err error)

Install an SSL certificate revocation list, pool-wide.

func (PoolClass) CrlList 

func (_class PoolClass) CrlList(sessionID SessionRef) (_retval []string, _err error)

List all installed SSL certificate revocation lists.

func (PoolClass) CrlUninstall 

func (_class PoolClass) CrlUninstall(sessionID SessionRef, name string) (_err error)

Remove an SSL certificate revocation list.

func (PoolClass) DeconfigureWlb 

func (_class PoolClass) DeconfigureWlb(sessionID SessionRef) (_err error)

Permanently deconfigures workload balancing monitoring on this pool

func (PoolClass) DesignateNewMaster 

func (_class PoolClass) DesignateNewMaster(sessionID SessionRef, host HostRef) (_err error)

Perform an orderly handover of the role of master to the referenced host.

func (PoolClass) DetectNonhomogeneousExternalAuth 

func (_class PoolClass) DetectNonhomogeneousExternalAuth(sessionID SessionRef, pool PoolRef) (_err error)

This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts

func (PoolClass) DisableExternalAuth 

func (_class PoolClass) DisableExternalAuth(sessionID SessionRef, pool PoolRef, config map[string]string) (_err error)

This call disables external authentication on all the hosts of the pool

func (PoolClass) DisableHa 

func (_class PoolClass) DisableHa(sessionID SessionRef) (_err error)

Turn off High Availability mode

func (PoolClass) DisableLocalStorageCaching 

func (_class PoolClass) DisableLocalStorageCaching(sessionID SessionRef, self PoolRef) (_err error)

This call disables pool-wide local storage caching

func (PoolClass) DisableRedoLog 

func (_class PoolClass) DisableRedoLog(sessionID SessionRef) (_err error)

Disable the redo log if in use, unless HA is enabled.

func (PoolClass) DisableSslLegacy 

func (_class PoolClass) DisableSslLegacy(sessionID SessionRef, self PoolRef) (_err error)

Sets ssl_legacy true on each host: see Host.ssl_legacy

func (PoolClass) Eject 

func (_class PoolClass) Eject(sessionID SessionRef, host HostRef) (_err error)

Instruct a pool master to eject a host from the pool

func (PoolClass) EmergencyResetMaster 

func (_class PoolClass) EmergencyResetMaster(sessionID SessionRef, masterAddress string) (_err error)

Instruct a slave already in a pool that the master has changed

func (PoolClass) EmergencyTransitionToMaster 

func (_class PoolClass) EmergencyTransitionToMaster(sessionID SessionRef) (_err error)

Instruct host that's currently a slave to transition to being master

func (PoolClass) EnableExternalAuth 

func (_class PoolClass) EnableExternalAuth(sessionID SessionRef, pool PoolRef, config map[string]string, serviceName string, authType string) (_err error)

This call enables external authentication on all the hosts of the pool

func (PoolClass) EnableHa 

func (_class PoolClass) EnableHa(sessionID SessionRef, heartbeatSrs []SRRef, configuration map[string]string) (_err error)

Turn on High Availability mode

func (PoolClass) EnableLocalStorageCaching 

func (_class PoolClass) EnableLocalStorageCaching(sessionID SessionRef, self PoolRef) (_err error)

This call attempts to enable pool-wide local storage caching

func (PoolClass) EnableRedoLog 

func (_class PoolClass) EnableRedoLog(sessionID SessionRef, sr SRRef) (_err error)

Enable the redo log on the given SR and start using it, unless HA is enabled.

func (PoolClass) EnableSslLegacy 

func (_class PoolClass) EnableSslLegacy(sessionID SessionRef, self PoolRef) (_err error)

Sets ssl_legacy true on each host: see Host.ssl_legacy

func (PoolClass) GetAll 

func (_class PoolClass) GetAll(sessionID SessionRef) (_retval []PoolRef, _err error)

Return a list of all the pools known to the system.

func (PoolClass) GetAllRecords 

func (_class PoolClass) GetAllRecords(sessionID SessionRef) (_retval map[PoolRef]PoolRecord, _err error)

Return a map of pool references to pool records for all pools known to the system.

func (PoolClass) GetAllowedOperations 

func (_class PoolClass) GetAllowedOperations(sessionID SessionRef, self PoolRef) (_retval []PoolAllowedOperations, _err error)

Get the allowed_operations field of the given pool.

func (PoolClass) GetBlobs 

func (_class PoolClass) GetBlobs(sessionID SessionRef, self PoolRef) (_retval map[string]BlobRef, _err error)

Get the blobs field of the given pool.

func (PoolClass) GetByUUID 

func (_class PoolClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PoolRef, _err error)

Get a reference to the pool instance with the specified UUID.

func (PoolClass) GetCrashDumpSR 

func (_class PoolClass) GetCrashDumpSR(sessionID SessionRef, self PoolRef) (_retval SRRef, _err error)

Get the crash_dump_SR field of the given pool.

func (PoolClass) GetCurrentOperations 

func (_class PoolClass) GetCurrentOperations(sessionID SessionRef, self PoolRef) (_retval map[string]PoolAllowedOperations, _err error)

Get the current_operations field of the given pool.

func (PoolClass) GetDefaultSR 

func (_class PoolClass) GetDefaultSR(sessionID SessionRef, self PoolRef) (_retval SRRef, _err error)

Get the default_SR field of the given pool.

func (PoolClass) GetGuiConfig 

func (_class PoolClass) GetGuiConfig(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

Get the gui_config field of the given pool.

func (PoolClass) GetHaAllowOvercommit 

func (_class PoolClass) GetHaAllowOvercommit(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

Get the ha_allow_overcommit field of the given pool.

func (PoolClass) GetHaClusterStack 

func (_class PoolClass) GetHaClusterStack(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the ha_cluster_stack field of the given pool.

func (PoolClass) GetHaConfiguration 

func (_class PoolClass) GetHaConfiguration(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

Get the ha_configuration field of the given pool.

func (PoolClass) GetHaEnabled 

func (_class PoolClass) GetHaEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

Get the ha_enabled field of the given pool.

func (PoolClass) GetHaHostFailuresToTolerate 

func (_class PoolClass) GetHaHostFailuresToTolerate(sessionID SessionRef, self PoolRef) (_retval int, _err error)

Get the ha_host_failures_to_tolerate field of the given pool.

func (PoolClass) GetHaOvercommitted 

func (_class PoolClass) GetHaOvercommitted(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

Get the ha_overcommitted field of the given pool.

func (PoolClass) GetHaPlanExistsFor 

func (_class PoolClass) GetHaPlanExistsFor(sessionID SessionRef, self PoolRef) (_retval int, _err error)

Get the ha_plan_exists_for field of the given pool.

func (PoolClass) GetHaStatefiles 

func (_class PoolClass) GetHaStatefiles(sessionID SessionRef, self PoolRef) (_retval []string, _err error)

Get the ha_statefiles field of the given pool.

func (PoolClass) GetHealthCheckConfig 

func (_class PoolClass) GetHealthCheckConfig(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

Get the health_check_config field of the given pool.

func (PoolClass) GetLicenseState 

func (_class PoolClass) GetLicenseState(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

This call returns the license state for the pool

func (PoolClass) GetMaster 

func (_class PoolClass) GetMaster(sessionID SessionRef, self PoolRef) (_retval HostRef, _err error)

Get the master field of the given pool.

func (PoolClass) GetMetadataVDIs 

func (_class PoolClass) GetMetadataVDIs(sessionID SessionRef, self PoolRef) (_retval []VDIRef, _err error)

Get the metadata_VDIs field of the given pool.

func (PoolClass) GetNameDescription 

func (_class PoolClass) GetNameDescription(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the name_description field of the given pool.

func (PoolClass) GetNameLabel 

func (_class PoolClass) GetNameLabel(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the name_label field of the given pool.

func (PoolClass) GetOtherConfig 

func (_class PoolClass) GetOtherConfig(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

Get the other_config field of the given pool.

func (PoolClass) GetRecord 

func (_class PoolClass) GetRecord(sessionID SessionRef, self PoolRef) (_retval PoolRecord, _err error)

Get a record containing the current state of the given pool.

func (PoolClass) GetRedoLogEnabled 

func (_class PoolClass) GetRedoLogEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

Get the redo_log_enabled field of the given pool.

func (PoolClass) GetRedoLogVdi 

func (_class PoolClass) GetRedoLogVdi(sessionID SessionRef, self PoolRef) (_retval VDIRef, _err error)

Get the redo_log_vdi field of the given pool.

func (PoolClass) GetRestrictions 

func (_class PoolClass) GetRestrictions(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

Get the restrictions field of the given pool.

func (PoolClass) GetSuspendImageSR 

func (_class PoolClass) GetSuspendImageSR(sessionID SessionRef, self PoolRef) (_retval SRRef, _err error)

Get the suspend_image_SR field of the given pool.

func (PoolClass) GetTags 

func (_class PoolClass) GetTags(sessionID SessionRef, self PoolRef) (_retval []string, _err error)

Get the tags field of the given pool.

func (PoolClass) GetUUID 

func (_class PoolClass) GetUUID(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the uuid field of the given pool.

func (PoolClass) GetVswitchController 

func (_class PoolClass) GetVswitchController(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the vswitch_controller field of the given pool.

func (PoolClass) GetWlbEnabled 

func (_class PoolClass) GetWlbEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

Get the wlb_enabled field of the given pool.

func (PoolClass) GetWlbURL 

func (_class PoolClass) GetWlbURL(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the wlb_url field of the given pool.

func (PoolClass) GetWlbUsername 

func (_class PoolClass) GetWlbUsername(sessionID SessionRef, self PoolRef) (_retval string, _err error)

Get the wlb_username field of the given pool.

func (PoolClass) GetWlbVerifyCert 

func (_class PoolClass) GetWlbVerifyCert(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

Get the wlb_verify_cert field of the given pool.

func (PoolClass) HaComputeHypotheticalMaxHostFailuresToTolerate 

func (_class PoolClass) HaComputeHypotheticalMaxHostFailuresToTolerate(sessionID SessionRef, configuration map[VMRef]string) (_retval int, _err error)

Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs

func (PoolClass) HaComputeMaxHostFailuresToTolerate 

func (_class PoolClass) HaComputeMaxHostFailuresToTolerate(sessionID SessionRef) (_retval int, _err error)

Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs

func (PoolClass) HaComputeVMFailoverPlan 

func (_class PoolClass) HaComputeVMFailoverPlan(sessionID SessionRef, failedHosts []HostRef, failedVms []VMRef) (_retval map[VMRef]map[string]string, _err error)

Return a VM failover plan assuming a given subset of hosts fail

func (PoolClass) HaFailoverPlanExists 

func (_class PoolClass) HaFailoverPlanExists(sessionID SessionRef, n int) (_retval bool, _err error)

Returns true if a VM failover plan exists for up to 'n' host failures

func (PoolClass) HaPreventRestartsFor 

func (_class PoolClass) HaPreventRestartsFor(sessionID SessionRef, seconds int) (_err error)

When this call returns the VM restart logic will not run for the requested number of seconds. If the argument is zero then the restart thread is immediately unblocked

func (PoolClass) InitializeWlb 

func (_class PoolClass) InitializeWlb(sessionID SessionRef, wlbURL string, wlbUsername string, wlbPassword string, xenserverUsername string, xenserverPassword string) (_err error)

Initializes workload balancing monitoring on this pool with the specified wlb server

func (PoolClass) Join 

func (_class PoolClass) Join(sessionID SessionRef, masterAddress string, masterUsername string, masterPassword string) (_err error)

Instruct host to join a new pool

Errors: 

JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS - The host joining the pool cannot contain any shared storage.

func (PoolClass) JoinForce 

func (_class PoolClass) JoinForce(sessionID SessionRef, masterAddress string, masterUsername string, masterPassword string) (_err error)

Instruct host to join a new pool

func (PoolClass) RecoverSlaves 

func (_class PoolClass) RecoverSlaves(sessionID SessionRef) (_retval []HostRef, _err error)

Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.

func (PoolClass) RemoveFromGuiConfig 

func (_class PoolClass) RemoveFromGuiConfig(sessionID SessionRef, self PoolRef, key string) (_err error)

Remove the given key and its corresponding value from the gui_config field of the given pool. If the key is not in that Map, then do nothing.

func (PoolClass) RemoveFromHealthCheckConfig 

func (_class PoolClass) RemoveFromHealthCheckConfig(sessionID SessionRef, self PoolRef, key string) (_err error)

Remove the given key and its corresponding value from the health_check_config field of the given pool. If the key is not in that Map, then do nothing.

func (PoolClass) RemoveFromOtherConfig 

func (_class PoolClass) RemoveFromOtherConfig(sessionID SessionRef, self PoolRef, key string) (_err error)

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.

func (PoolClass) RemoveTags 

func (_class PoolClass) RemoveTags(sessionID SessionRef, self PoolRef, value string) (_err error)

Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.

func (PoolClass) RetrieveWlbConfiguration 

func (_class PoolClass) RetrieveWlbConfiguration(sessionID SessionRef) (_retval map[string]string, _err error)

Retrieves the pool optimization criteria from the workload balancing server

func (PoolClass) RetrieveWlbRecommendations 

func (_class PoolClass) RetrieveWlbRecommendations(sessionID SessionRef) (_retval map[VMRef][]string, _err error)

Retrieves vm migrate recommendations for the pool from the workload balancing server

func (PoolClass) SendTestPost 

func (_class PoolClass) SendTestPost(sessionID SessionRef, host string, port int, body string) (_retval string, _err error)

Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.

func (PoolClass) SendWlbConfiguration 

func (_class PoolClass) SendWlbConfiguration(sessionID SessionRef, config map[string]string) (_err error)

Sets the pool optimization criteria for the workload balancing server

func (PoolClass) SetCrashDumpSR 

func (_class PoolClass) SetCrashDumpSR(sessionID SessionRef, self PoolRef, value SRRef) (_err error)

Set the crash_dump_SR field of the given pool.

func (PoolClass) SetDefaultSR 

func (_class PoolClass) SetDefaultSR(sessionID SessionRef, self PoolRef, value SRRef) (_err error)

Set the default_SR field of the given pool.

func (PoolClass) SetGuiConfig 

func (_class PoolClass) SetGuiConfig(sessionID SessionRef, self PoolRef, value map[string]string) (_err error)

Set the gui_config field of the given pool.

func (PoolClass) SetHaAllowOvercommit 

func (_class PoolClass) SetHaAllowOvercommit(sessionID SessionRef, self PoolRef, value bool) (_err error)

Set the ha_allow_overcommit field of the given pool.

func (PoolClass) SetHaHostFailuresToTolerate 

func (_class PoolClass) SetHaHostFailuresToTolerate(sessionID SessionRef, self PoolRef, value int) (_err error)

Set the maximum number of host failures to consider in the HA VM restart planner

func (PoolClass) SetHealthCheckConfig 

func (_class PoolClass) SetHealthCheckConfig(sessionID SessionRef, self PoolRef, value map[string]string) (_err error)

Set the health_check_config field of the given pool.

func (PoolClass) SetNameDescription 

func (_class PoolClass) SetNameDescription(sessionID SessionRef, self PoolRef, value string) (_err error)

Set the name_description field of the given pool.

func (PoolClass) SetNameLabel 

func (_class PoolClass) SetNameLabel(sessionID SessionRef, self PoolRef, value string) (_err error)

Set the name_label field of the given pool.

func (PoolClass) SetOtherConfig 

func (_class PoolClass) SetOtherConfig(sessionID SessionRef, self PoolRef, value map[string]string) (_err error)

Set the other_config field of the given pool.

func (PoolClass) SetSuspendImageSR 

func (_class PoolClass) SetSuspendImageSR(sessionID SessionRef, self PoolRef, value SRRef) (_err error)

Set the suspend_image_SR field of the given pool.

func (PoolClass) SetTags 

func (_class PoolClass) SetTags(sessionID SessionRef, self PoolRef, value []string) (_err error)

Set the tags field of the given pool.

func (PoolClass) SetVswitchController 

func (_class PoolClass) SetVswitchController(sessionID SessionRef, address string) (_err error)

Set the IP address of the vswitch controller.

func (PoolClass) SetWlbEnabled 

func (_class PoolClass) SetWlbEnabled(sessionID SessionRef, self PoolRef, value bool) (_err error)

Set the wlb_enabled field of the given pool.

func (PoolClass) SetWlbVerifyCert 

func (_class PoolClass) SetWlbVerifyCert(sessionID SessionRef, self PoolRef, value bool) (_err error)

Set the wlb_verify_cert field of the given pool.

func (PoolClass) SyncDatabase 

func (_class PoolClass) SyncDatabase(sessionID SessionRef) (_err error)

Forcibly synchronise the database now

func (PoolClass) TestArchiveTarget 

func (_class PoolClass) TestArchiveTarget(sessionID SessionRef, self PoolRef, config map[string]string) (_retval string, _err error)

This call tests if a location is valid

type PoolPatchClass 

type PoolPatchClass struct {
	// contains filtered or unexported fields
}

Pool-wide patches

func (PoolPatchClass) AddToOtherConfig 

func (_class PoolPatchClass) AddToOtherConfig(sessionID SessionRef, self PoolPatchRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given pool_patch.

func (PoolPatchClass) Apply 

func (_class PoolPatchClass) Apply(sessionID SessionRef, self PoolPatchRef, host HostRef) (_retval string, _err error)

Apply the selected patch to a host and return its output

func (PoolPatchClass) Clean 

func (_class PoolPatchClass) Clean(sessionID SessionRef, self PoolPatchRef) (_err error)

Removes the patch's files from the server

func (PoolPatchClass) CleanOnHost 

func (_class PoolPatchClass) CleanOnHost(sessionID SessionRef, self PoolPatchRef, host HostRef) (_err error)

Removes the patch's files from the specified host

func (PoolPatchClass) Destroy 

func (_class PoolPatchClass) Destroy(sessionID SessionRef, self PoolPatchRef) (_err error)

Removes the patch's files from all hosts in the pool, and removes the database entries. Only works on unapplied patches.

func (PoolPatchClass) GetAfterApplyGuidance 

func (_class PoolPatchClass) GetAfterApplyGuidance(sessionID SessionRef, self PoolPatchRef) (_retval []AfterApplyGuidance, _err error)

Get the after_apply_guidance field of the given pool_patch.

func (PoolPatchClass) GetAll 

func (_class PoolPatchClass) GetAll(sessionID SessionRef) (_retval []PoolPatchRef, _err error)

Return a list of all the pool_patchs known to the system.

func (PoolPatchClass) GetAllRecords 

func (_class PoolPatchClass) GetAllRecords(sessionID SessionRef) (_retval map[PoolPatchRef]PoolPatchRecord, _err error)

Return a map of pool_patch references to pool_patch records for all pool_patchs known to the system.

func (PoolPatchClass) GetByNameLabel 

func (_class PoolPatchClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []PoolPatchRef, _err error)

Get all the pool_patch instances with the given label.

func (PoolPatchClass) GetByUUID 

func (_class PoolPatchClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PoolPatchRef, _err error)

Get a reference to the pool_patch instance with the specified UUID.

func (PoolPatchClass) GetHostPatches 

func (_class PoolPatchClass) GetHostPatches(sessionID SessionRef, self PoolPatchRef) (_retval []HostPatchRef, _err error)

Get the host_patches field of the given pool_patch.

func (PoolPatchClass) GetNameDescription 

func (_class PoolPatchClass) GetNameDescription(sessionID SessionRef, self PoolPatchRef) (_retval string, _err error)

Get the name/description field of the given pool_patch.

func (PoolPatchClass) GetNameLabel 

func (_class PoolPatchClass) GetNameLabel(sessionID SessionRef, self PoolPatchRef) (_retval string, _err error)

Get the name/label field of the given pool_patch.

func (PoolPatchClass) GetOtherConfig 

func (_class PoolPatchClass) GetOtherConfig(sessionID SessionRef, self PoolPatchRef) (_retval map[string]string, _err error)

Get the other_config field of the given pool_patch.

func (PoolPatchClass) GetPoolApplied 

func (_class PoolPatchClass) GetPoolApplied(sessionID SessionRef, self PoolPatchRef) (_retval bool, _err error)

Get the pool_applied field of the given pool_patch.

func (PoolPatchClass) GetRecord 

func (_class PoolPatchClass) GetRecord(sessionID SessionRef, self PoolPatchRef) (_retval PoolPatchRecord, _err error)

Get a record containing the current state of the given pool_patch.

func (PoolPatchClass) GetSize 

func (_class PoolPatchClass) GetSize(sessionID SessionRef, self PoolPatchRef) (_retval int, _err error)

Get the size field of the given pool_patch.

func (PoolPatchClass) GetUUID 

func (_class PoolPatchClass) GetUUID(sessionID SessionRef, self PoolPatchRef) (_retval string, _err error)

Get the uuid field of the given pool_patch.

func (PoolPatchClass) GetVersion 

func (_class PoolPatchClass) GetVersion(sessionID SessionRef, self PoolPatchRef) (_retval string, _err error)

Get the version field of the given pool_patch.

func (PoolPatchClass) PoolApply 

func (_class PoolPatchClass) PoolApply(sessionID SessionRef, self PoolPatchRef) (_err error)

Apply the selected patch to all hosts in the pool and return a map of host_ref -> patch output

func (PoolPatchClass) PoolClean 

func (_class PoolPatchClass) PoolClean(sessionID SessionRef, self PoolPatchRef) (_err error)

Removes the patch's files from all hosts in the pool, but does not remove the database entries

func (PoolPatchClass) Precheck 

func (_class PoolPatchClass) Precheck(sessionID SessionRef, self PoolPatchRef, host HostRef) (_retval string, _err error)

Execute the precheck stage of the selected patch on a host and return its output

func (PoolPatchClass) RemoveFromOtherConfig 

func (_class PoolPatchClass) RemoveFromOtherConfig(sessionID SessionRef, self PoolPatchRef, key string) (_err error)

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.

func (PoolPatchClass) SetOtherConfig 

func (_class PoolPatchClass) SetOtherConfig(sessionID SessionRef, self PoolPatchRef, value map[string]string) (_err error)

Set the other_config field of the given pool_patch.

type PoolPatchRecord 

type PoolPatchRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Patch version number
	Version string
	// Size of the patch
	Size int
	// This patch should be applied across the entire pool
	PoolApplied bool
	// This hosts this patch is applied to.
	HostPatches []HostPatchRef
	// What the client should do after this patch has been applied.
	AfterApplyGuidance []AfterApplyGuidance
	// additional configuration
	OtherConfig map[string]string
}

type PoolPatchRef 

type PoolPatchRef string

type PoolRecord 

type PoolRecord struct {
	// Unique identifier/object reference
	UUID string
	// Short name
	NameLabel string
	// Description
	NameDescription string
	// The host that is pool master
	Master HostRef
	// Default SR for VDIs
	DefaultSR SRRef
	// The SR in which VDIs for suspend images are created
	SuspendImageSR SRRef
	// The SR in which VDIs for crash dumps are created
	CrashDumpSR SRRef
	// additional configuration
	OtherConfig map[string]string
	// true if HA is enabled on the pool, false otherwise
	HaEnabled bool
	// The current HA configuration
	HaConfiguration map[string]string
	// HA statefile VDIs in use
	HaStatefiles []string
	// Number of host failures to tolerate before the Pool is declared to be overcommitted
	HaHostFailuresToTolerate int
	// Number of future host failures we have managed to find a plan for. Once this reaches zero any future host failures will cause the failure of protected VMs.
	HaPlanExistsFor int
	// If set to false then operations which would cause the Pool to become overcommitted will be blocked.
	HaAllowOvercommit bool
	// True if the Pool is considered to be overcommitted i.e. if there exist insufficient physical resources to tolerate the configured number of host failures
	HaOvercommitted bool
	// Binary blobs associated with this pool
	Blobs map[string]BlobRef
	// user-specified tags for categorization purposes
	Tags []string
	// gui-specific configuration for pool
	GuiConfig map[string]string
	// Configuration for the automatic health check feature
	HealthCheckConfig map[string]string
	// Url for the configured workload balancing host
	WlbURL string
	// Username for accessing the workload balancing host
	WlbUsername string
	// true if workload balancing is enabled on the pool, false otherwise
	WlbEnabled bool
	// true if communication with the WLB server should enforce SSL certificate verification.
	WlbVerifyCert bool
	// true a redo-log is to be used other than when HA is enabled, false otherwise
	RedoLogEnabled bool
	// indicates the VDI to use for the redo-log other than when HA is enabled
	RedoLogVdi VDIRef
	// address of the vswitch controller
	VswitchController string
	// Pool-wide restrictions currently in effect
	Restrictions map[string]string
	// The set of currently known metadata VDIs for this pool
	MetadataVDIs []VDIRef
	// The HA cluster stack that is currently in use. Only valid when HA is enabled.
	HaClusterStack string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []PoolAllowedOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]PoolAllowedOperations
}

type PoolRef 

type PoolRef string

type PrimaryAddressType 

type PrimaryAddressType string
const (
	// Primary address is the IPv4 address
	PrimaryAddressTypeIPv4 PrimaryAddressType = "IPv4"
	// Primary address is the IPv6 address
	PrimaryAddressTypeIPv6 PrimaryAddressType = "IPv6"
)

type RoleClass 

type RoleClass struct {
	// contains filtered or unexported fields
}

A set of permissions associated with a subject

func (RoleClass) GetAll 

func (_class RoleClass) GetAll(sessionID SessionRef) (_retval []RoleRef, _err error)

Return a list of all the roles known to the system.

func (RoleClass) GetAllRecords 

func (_class RoleClass) GetAllRecords(sessionID SessionRef) (_retval map[RoleRef]RoleRecord, _err error)

Return a map of role references to role records for all roles known to the system.

func (RoleClass) GetByNameLabel 

func (_class RoleClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []RoleRef, _err error)

Get all the role instances with the given label.

func (RoleClass) GetByPermission 

func (_class RoleClass) GetByPermission(sessionID SessionRef, permission RoleRef) (_retval []RoleRef, _err error)

This call returns a list of roles given a permission

func (RoleClass) GetByPermissionNameLabel 

func (_class RoleClass) GetByPermissionNameLabel(sessionID SessionRef, label string) (_retval []RoleRef, _err error)

This call returns a list of roles given a permission name

func (RoleClass) GetByUUID 

func (_class RoleClass) GetByUUID(sessionID SessionRef, uuid string) (_retval RoleRef, _err error)

Get a reference to the role instance with the specified UUID.

func (RoleClass) GetNameDescription 

func (_class RoleClass) GetNameDescription(sessionID SessionRef, self RoleRef) (_retval string, _err error)

Get the name/description field of the given role.

func (RoleClass) GetNameLabel 

func (_class RoleClass) GetNameLabel(sessionID SessionRef, self RoleRef) (_retval string, _err error)

Get the name/label field of the given role.

func (RoleClass) GetPermissions 

func (_class RoleClass) GetPermissions(sessionID SessionRef, self RoleRef) (_retval []RoleRef, _err error)

This call returns a list of permissions given a role

func (RoleClass) GetPermissionsNameLabel 

func (_class RoleClass) GetPermissionsNameLabel(sessionID SessionRef, self RoleRef) (_retval []string, _err error)

This call returns a list of permission names given a role

func (RoleClass) GetRecord 

func (_class RoleClass) GetRecord(sessionID SessionRef, self RoleRef) (_retval RoleRecord, _err error)

Get a record containing the current state of the given role.

func (RoleClass) GetSubroles 

func (_class RoleClass) GetSubroles(sessionID SessionRef, self RoleRef) (_retval []RoleRef, _err error)

Get the subroles field of the given role.

func (RoleClass) GetUUID 

func (_class RoleClass) GetUUID(sessionID SessionRef, self RoleRef) (_retval string, _err error)

Get the uuid field of the given role.

type RoleRecord 

type RoleRecord struct {
	// Unique identifier/object reference
	UUID string
	// a short user-friendly name for the role
	NameLabel string
	// what this role is for
	NameDescription string
	// a list of pointers to other roles or permissions
	Subroles []RoleRef
}

type RoleRef 

type RoleRef string

type SMClass 

type SMClass struct {
	// contains filtered or unexported fields
}

A storage manager plugin

func (SMClass) AddToOtherConfig 

func (_class SMClass) AddToOtherConfig(sessionID SessionRef, self SMRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given SM.

func (SMClass) GetAll 

func (_class SMClass) GetAll(sessionID SessionRef) (_retval []SMRef, _err error)

Return a list of all the SMs known to the system.

func (SMClass) GetAllRecords 

func (_class SMClass) GetAllRecords(sessionID SessionRef) (_retval map[SMRef]SMRecord, _err error)

Return a map of SM references to SM records for all SMs known to the system.

func (SMClass) GetByNameLabel 

func (_class SMClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []SMRef, _err error)

Get all the SM instances with the given label.

func (SMClass) GetByUUID 

func (_class SMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SMRef, _err error)

Get a reference to the SM instance with the specified UUID.

func (SMClass) GetCapabilities 

func (_class SMClass) GetCapabilities(sessionID SessionRef, self SMRef) (_retval []string, _err error)

Get the capabilities field of the given SM.

func (SMClass) GetConfiguration 

func (_class SMClass) GetConfiguration(sessionID SessionRef, self SMRef) (_retval map[string]string, _err error)

Get the configuration field of the given SM.

func (SMClass) GetCopyright 

func (_class SMClass) GetCopyright(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the copyright field of the given SM.

func (SMClass) GetDriverFilename 

func (_class SMClass) GetDriverFilename(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the driver_filename field of the given SM.

func (SMClass) GetFeatures 

func (_class SMClass) GetFeatures(sessionID SessionRef, self SMRef) (_retval map[string]int, _err error)

Get the features field of the given SM.

func (SMClass) GetNameDescription 

func (_class SMClass) GetNameDescription(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the name/description field of the given SM.

func (SMClass) GetNameLabel 

func (_class SMClass) GetNameLabel(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the name/label field of the given SM.

func (SMClass) GetOtherConfig 

func (_class SMClass) GetOtherConfig(sessionID SessionRef, self SMRef) (_retval map[string]string, _err error)

Get the other_config field of the given SM.

func (SMClass) GetRecord 

func (_class SMClass) GetRecord(sessionID SessionRef, self SMRef) (_retval SMRecord, _err error)

Get a record containing the current state of the given SM.

func (SMClass) GetRequiredAPIVersion 

func (_class SMClass) GetRequiredAPIVersion(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the required_api_version field of the given SM.

func (SMClass) GetRequiredClusterStack 

func (_class SMClass) GetRequiredClusterStack(sessionID SessionRef, self SMRef) (_retval []string, _err error)

Get the required_cluster_stack field of the given SM.

func (SMClass) GetType 

func (_class SMClass) GetType(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the type field of the given SM.

func (SMClass) GetUUID 

func (_class SMClass) GetUUID(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the uuid field of the given SM.

func (SMClass) GetVendor 

func (_class SMClass) GetVendor(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the vendor field of the given SM.

func (SMClass) GetVersion 

func (_class SMClass) GetVersion(sessionID SessionRef, self SMRef) (_retval string, _err error)

Get the version field of the given SM.

func (SMClass) RemoveFromOtherConfig 

func (_class SMClass) RemoveFromOtherConfig(sessionID SessionRef, self SMRef, key string) (_err error)

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.

func (SMClass) SetOtherConfig 

func (_class SMClass) SetOtherConfig(sessionID SessionRef, self SMRef, value map[string]string) (_err error)

Set the other_config field of the given SM.

type SMRecord 

type SMRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// SR.type
	Type string
	// Vendor who created this plugin
	Vendor string
	// Entity which owns the copyright of this plugin
	Copyright string
	// Version of the plugin
	Version string
	// Minimum SM API version required on the server
	RequiredAPIVersion string
	// names and descriptions of device config keys
	Configuration map[string]string
	// capabilities of the SM plugin
	Capabilities []string
	// capabilities of the SM plugin, with capability version numbers
	Features map[string]int
	// additional configuration
	OtherConfig map[string]string
	// filename of the storage driver
	DriverFilename string
	// The storage plugin requires that one of these cluster stacks is configured and running.
	RequiredClusterStack []string
}

type SMRef 

type SMRef string

type SRClass 

type SRClass struct {
	// contains filtered or unexported fields
}

A storage repository

func (SRClass) AddTags 

func (_class SRClass) AddTags(sessionID SessionRef, self SRRef, value string) (_err error)

Add the given value to the tags field of the given SR. If the value is already in that Set, then do nothing.

func (SRClass) AddToOtherConfig 

func (_class SRClass) AddToOtherConfig(sessionID SessionRef, self SRRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given SR.

func (SRClass) AddToSmConfig 

func (_class SRClass) AddToSmConfig(sessionID SessionRef, self SRRef, key string, value string) (_err error)

Add the given key-value pair to the sm_config field of the given SR.

func (SRClass) AssertCanHostHaStatefile 

func (_class SRClass) AssertCanHostHaStatefile(sessionID SessionRef, sr SRRef) (_err error)

Returns successfully if the given SR can host an HA statefile. Otherwise returns an error to explain why not

func (SRClass) AssertSupportsDatabaseReplication 

func (_class SRClass) AssertSupportsDatabaseReplication(sessionID SessionRef, sr SRRef) (_err error)

Returns successfully if the given SR supports database replication. Otherwise returns an error to explain why not.

func (SRClass) Create 

func (_class SRClass) Create(sessionID SessionRef, host HostRef, deviceConfig map[string]string, physicalSize int, nameLabel string, nameDescription string, atype string, contentType string, shared bool, smConfig map[string]string) (_retval SRRef, _err error)

Create a new Storage Repository and introduce it into the managed system, creating both SR record and PBD record to attach it to current host (with specified device_config parameters)

Errors: 

SR_UNKNOWN_DRIVER - The SR could not be connected because the driver was not recognised.

func (SRClass) CreateNewBlob 

func (_class SRClass) CreateNewBlob(sessionID SessionRef, sr SRRef, name string, mimeType string, public bool) (_retval BlobRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this SR

func (SRClass) Destroy 

func (_class SRClass) Destroy(sessionID SessionRef, sr SRRef) (_err error)

Destroy specified SR, removing SR-record from database and remove SR from disk. (In order to affect this operation the appropriate device_config is read from the specified SR's PBD on current host)

Errors: 

SR_HAS_PBD - The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.

func (SRClass) DisableDatabaseReplication 

func (_class SRClass) DisableDatabaseReplication(sessionID SessionRef, sr SRRef) (_err error)

func (SRClass) EnableDatabaseReplication 

func (_class SRClass) EnableDatabaseReplication(sessionID SessionRef, sr SRRef) (_err error)

func (SRClass) Forget 

func (_class SRClass) Forget(sessionID SessionRef, sr SRRef) (_err error)

Removing specified SR-record from database, without attempting to remove SR from disk

Errors: 

SR_HAS_PBD - The SR is still connected to a host via a PBD. It cannot be destroyed or forgotten.

func (SRClass) GetAll 

func (_class SRClass) GetAll(sessionID SessionRef) (_retval []SRRef, _err error)

Return a list of all the SRs known to the system.

func (SRClass) GetAllRecords 

func (_class SRClass) GetAllRecords(sessionID SessionRef) (_retval map[SRRef]SRRecord, _err error)

Return a map of SR references to SR records for all SRs known to the system.

func (SRClass) GetAllowedOperations 

func (_class SRClass) GetAllowedOperations(sessionID SessionRef, self SRRef) (_retval []StorageOperations, _err error)

Get the allowed_operations field of the given SR.

func (SRClass) GetBlobs 

func (_class SRClass) GetBlobs(sessionID SessionRef, self SRRef) (_retval map[string]BlobRef, _err error)

Get the blobs field of the given SR.

func (SRClass) GetByNameLabel 

func (_class SRClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []SRRef, _err error)

Get all the SR instances with the given label.

func (SRClass) GetByUUID 

func (_class SRClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SRRef, _err error)

Get a reference to the SR instance with the specified UUID.

func (SRClass) GetContentType 

func (_class SRClass) GetContentType(sessionID SessionRef, self SRRef) (_retval string, _err error)

Get the content_type field of the given SR.

func (SRClass) GetCurrentOperations 

func (_class SRClass) GetCurrentOperations(sessionID SessionRef, self SRRef) (_retval map[string]StorageOperations, _err error)

Get the current_operations field of the given SR.

func (SRClass) GetIntroducedBy 

func (_class SRClass) GetIntroducedBy(sessionID SessionRef, self SRRef) (_retval DRTaskRef, _err error)

Get the introduced_by field of the given SR.

func (SRClass) GetLocalCacheEnabled 

func (_class SRClass) GetLocalCacheEnabled(sessionID SessionRef, self SRRef) (_retval bool, _err error)

Get the local_cache_enabled field of the given SR.

func (SRClass) GetNameDescription 

func (_class SRClass) GetNameDescription(sessionID SessionRef, self SRRef) (_retval string, _err error)

Get the name/description field of the given SR.

func (SRClass) GetNameLabel 

func (_class SRClass) GetNameLabel(sessionID SessionRef, self SRRef) (_retval string, _err error)

Get the name/label field of the given SR.

func (SRClass) GetOtherConfig 

func (_class SRClass) GetOtherConfig(sessionID SessionRef, self SRRef) (_retval map[string]string, _err error)

Get the other_config field of the given SR.

func (SRClass) GetPBDs 

func (_class SRClass) GetPBDs(sessionID SessionRef, self SRRef) (_retval []PBDRef, _err error)

Get the PBDs field of the given SR.

func (SRClass) GetPhysicalSize 

func (_class SRClass) GetPhysicalSize(sessionID SessionRef, self SRRef) (_retval int, _err error)

Get the physical_size field of the given SR.

func (SRClass) GetPhysicalUtilisation 

func (_class SRClass) GetPhysicalUtilisation(sessionID SessionRef, self SRRef) (_retval int, _err error)

Get the physical_utilisation field of the given SR.

func (SRClass) GetRecord 

func (_class SRClass) GetRecord(sessionID SessionRef, self SRRef) (_retval SRRecord, _err error)

Get a record containing the current state of the given SR.

func (SRClass) GetShared 

func (_class SRClass) GetShared(sessionID SessionRef, self SRRef) (_retval bool, _err error)

Get the shared field of the given SR.

func (SRClass) GetSmConfig 

func (_class SRClass) GetSmConfig(sessionID SessionRef, self SRRef) (_retval map[string]string, _err error)

Get the sm_config field of the given SR.

func (SRClass) GetSupportedTypes 

func (_class SRClass) GetSupportedTypes(sessionID SessionRef) (_retval []string, _err error)

Return a set of all the SR types supported by the system

func (SRClass) GetTags 

func (_class SRClass) GetTags(sessionID SessionRef, self SRRef) (_retval []string, _err error)

Get the tags field of the given SR.

func (SRClass) GetType 

func (_class SRClass) GetType(sessionID SessionRef, self SRRef) (_retval string, _err error)

Get the type field of the given SR.

func (SRClass) GetUUID 

func (_class SRClass) GetUUID(sessionID SessionRef, self SRRef) (_retval string, _err error)

Get the uuid field of the given SR.

func (SRClass) GetVDIs 

func (_class SRClass) GetVDIs(sessionID SessionRef, self SRRef) (_retval []VDIRef, _err error)

Get the VDIs field of the given SR.

func (SRClass) GetVirtualAllocation 

func (_class SRClass) GetVirtualAllocation(sessionID SessionRef, self SRRef) (_retval int, _err error)

Get the virtual_allocation field of the given SR.

func (SRClass) Introduce 

func (_class SRClass) Introduce(sessionID SessionRef, uuid string, nameLabel string, nameDescription string, atype string, contentType string, shared bool, smConfig map[string]string) (_retval SRRef, _err error)

Introduce a new Storage Repository into the managed system

func (SRClass) Make 

func (_class SRClass) Make(sessionID SessionRef, host HostRef, deviceConfig map[string]string, physicalSize int, nameLabel string, nameDescription string, atype string, contentType string, smConfig map[string]string) (_retval string, _err error)

Create a new Storage Repository on disk. This call is deprecated: use SR.create instead.

func (SRClass) Probe 

func (_class SRClass) Probe(sessionID SessionRef, host HostRef, deviceConfig map[string]string, atype string, smConfig map[string]string) (_retval string, _err error)

Perform a backend-specific scan, using the given device_config. If the device_config is complete, then this will return a list 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_config.

func (SRClass) RemoveFromOtherConfig 

func (_class SRClass) RemoveFromOtherConfig(sessionID SessionRef, self SRRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given SR. If the key is not in that Map, then do nothing.

func (SRClass) RemoveFromSmConfig 

func (_class SRClass) RemoveFromSmConfig(sessionID SessionRef, self SRRef, key string) (_err error)

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.

func (SRClass) RemoveTags 

func (_class SRClass) RemoveTags(sessionID SessionRef, self SRRef, value string) (_err error)

Remove the given value from the tags field of the given SR. If the value is not in that Set, then do nothing.

func (SRClass) Scan 

func (_class SRClass) Scan(sessionID SessionRef, sr SRRef) (_err error)

Refreshes the list of VDIs associated with an SR

func (SRClass) SetNameDescription 

func (_class SRClass) SetNameDescription(sessionID SessionRef, sr SRRef, value string) (_err error)

Set the name description of the SR

func (SRClass) SetNameLabel 

func (_class SRClass) SetNameLabel(sessionID SessionRef, sr SRRef, value string) (_err error)

Set the name label of the SR

func (SRClass) SetOtherConfig 

func (_class SRClass) SetOtherConfig(sessionID SessionRef, self SRRef, value map[string]string) (_err error)

Set the other_config field of the given SR.

func (SRClass) SetPhysicalSize 

func (_class SRClass) SetPhysicalSize(sessionID SessionRef, self SRRef, value int) (_err error)

Sets the SR's physical_size field

func (SRClass) SetPhysicalUtilisation 

func (_class SRClass) SetPhysicalUtilisation(sessionID SessionRef, self SRRef, value int) (_err error)

Sets the SR's physical_utilisation field

func (SRClass) SetShared 

func (_class SRClass) SetShared(sessionID SessionRef, sr SRRef, value bool) (_err error)

Sets the shared flag on the SR

func (SRClass) SetSmConfig 

func (_class SRClass) SetSmConfig(sessionID SessionRef, self SRRef, value map[string]string) (_err error)

Set the sm_config field of the given SR.

func (SRClass) SetTags 

func (_class SRClass) SetTags(sessionID SessionRef, self SRRef, value []string) (_err error)

Set the tags field of the given SR.

func (SRClass) SetVirtualAllocation 

func (_class SRClass) SetVirtualAllocation(sessionID SessionRef, self SRRef, value int) (_err error)

Sets the SR's virtual_allocation field

func (SRClass) Update 

func (_class SRClass) Update(sessionID SessionRef, sr SRRef) (_err error)

Refresh the fields on the SR object

type SRRecord 

type SRRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []StorageOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]StorageOperations
	// all virtual disks known to this storage repository
	VDIs []VDIRef
	// describes how particular hosts can see this storage repository
	PBDs []PBDRef
	// sum of virtual_sizes of all VDIs in this storage repository (in bytes)
	VirtualAllocation int
	// physical space currently utilised on this storage repository (in bytes). Note that for sparse disk formats, physical_utilisation may be less than virtual_allocation
	PhysicalUtilisation int
	// total physical size of the repository (in bytes)
	PhysicalSize int
	// type of the storage repository
	Type string
	// the type of the SR's content, if required (e.g. ISOs)
	ContentType string
	// true if this SR is (capable of being) shared between multiple hosts
	Shared bool
	// additional configuration
	OtherConfig map[string]string
	// user-specified tags for categorization purposes
	Tags []string
	// SM dependent data
	SmConfig map[string]string
	// Binary blobs associated with this SR
	Blobs map[string]BlobRef
	// True if this SR is assigned to be the local cache for its host
	LocalCacheEnabled bool
	// The disaster recovery task which introduced this SR
	IntroducedBy DRTaskRef
}

type SRRef 

type SRRef string

type SecretClass 

type SecretClass struct {
	// contains filtered or unexported fields
}

A secret

func (SecretClass) AddToOtherConfig 

func (_class SecretClass) AddToOtherConfig(sessionID SessionRef, self SecretRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given secret.

func (SecretClass) Create 

func (_class SecretClass) Create(sessionID SessionRef, args SecretRecord) (_retval SecretRef, _err error)

Create a new secret instance, and return its handle. The constructor args are: value*, other_config (* = non-optional).

func (SecretClass) Destroy 

func (_class SecretClass) Destroy(sessionID SessionRef, self SecretRef) (_err error)

Destroy the specified secret instance.

func (SecretClass) GetAll 

func (_class SecretClass) GetAll(sessionID SessionRef) (_retval []SecretRef, _err error)

Return a list of all the secrets known to the system.

func (SecretClass) GetAllRecords 

func (_class SecretClass) GetAllRecords(sessionID SessionRef) (_retval map[SecretRef]SecretRecord, _err error)

Return a map of secret references to secret records for all secrets known to the system.

func (SecretClass) GetByUUID 

func (_class SecretClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SecretRef, _err error)

Get a reference to the secret instance with the specified UUID.

func (SecretClass) GetOtherConfig 

func (_class SecretClass) GetOtherConfig(sessionID SessionRef, self SecretRef) (_retval map[string]string, _err error)

Get the other_config field of the given secret.

func (SecretClass) GetRecord 

func (_class SecretClass) GetRecord(sessionID SessionRef, self SecretRef) (_retval SecretRecord, _err error)

Get a record containing the current state of the given secret.

func (SecretClass) GetUUID 

func (_class SecretClass) GetUUID(sessionID SessionRef, self SecretRef) (_retval string, _err error)

Get the uuid field of the given secret.

func (SecretClass) GetValue 

func (_class SecretClass) GetValue(sessionID SessionRef, self SecretRef) (_retval string, _err error)

Get the value field of the given secret.

func (SecretClass) RemoveFromOtherConfig 

func (_class SecretClass) RemoveFromOtherConfig(sessionID SessionRef, self SecretRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given secret. If the key is not in that Map, then do nothing.

func (SecretClass) SetOtherConfig 

func (_class SecretClass) SetOtherConfig(sessionID SessionRef, self SecretRef, value map[string]string) (_err error)

Set the other_config field of the given secret.

func (SecretClass) SetValue 

func (_class SecretClass) SetValue(sessionID SessionRef, self SecretRef, value string) (_err error)

Set the value field of the given secret.

type SecretRecord 

type SecretRecord struct {
	// Unique identifier/object reference
	UUID string
	// the secret
	Value string
	// other_config
	OtherConfig map[string]string
}

type SecretRef 

type SecretRef string

type SessionClass 

type SessionClass struct {
	// contains filtered or unexported fields
}

A session

func (SessionClass) AddToOtherConfig 

func (_class SessionClass) AddToOtherConfig(sessionID SessionRef, self SessionRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given session.

func (SessionClass) ChangePassword 

func (_class SessionClass) ChangePassword(sessionID SessionRef, oldPwd string, newPwd string) (_err error)

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

func (SessionClass) CreateFromDbFile 

func (_class SessionClass) CreateFromDbFile(sessionID SessionRef, filename string) (_retval SessionRef, _err error)

func (SessionClass) GetAllSubjectIdentifiers 

func (_class SessionClass) GetAllSubjectIdentifiers(sessionID SessionRef) (_retval []string, _err error)

Return a list of all the user subject-identifiers of all existing sessions

func (SessionClass) GetAuthUserName 

func (_class SessionClass) GetAuthUserName(sessionID SessionRef, self SessionRef) (_retval string, _err error)

Get the auth_user_name field of the given session.

func (SessionClass) GetAuthUserSid 

func (_class SessionClass) GetAuthUserSid(sessionID SessionRef, self SessionRef) (_retval string, _err error)

Get the auth_user_sid field of the given session.

func (SessionClass) GetByUUID 

func (_class SessionClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SessionRef, _err error)

Get a reference to the session instance with the specified UUID.

func (SessionClass) GetIsLocalSuperuser 

func (_class SessionClass) GetIsLocalSuperuser(sessionID SessionRef, self SessionRef) (_retval bool, _err error)

Get the is_local_superuser field of the given session.

func (SessionClass) GetLastActive 

func (_class SessionClass) GetLastActive(sessionID SessionRef, self SessionRef) (_retval time.Time, _err error)

Get the last_active field of the given session.

func (SessionClass) GetOriginator 

func (_class SessionClass) GetOriginator(sessionID SessionRef, self SessionRef) (_retval string, _err error)

Get the originator field of the given session.

func (SessionClass) GetOtherConfig 

func (_class SessionClass) GetOtherConfig(sessionID SessionRef, self SessionRef) (_retval map[string]string, _err error)

Get the other_config field of the given session.

func (SessionClass) GetParent 

func (_class SessionClass) GetParent(sessionID SessionRef, self SessionRef) (_retval SessionRef, _err error)

Get the parent field of the given session.

func (SessionClass) GetPool 

func (_class SessionClass) GetPool(sessionID SessionRef, self SessionRef) (_retval bool, _err error)

Get the pool field of the given session.

func (SessionClass) GetRbacPermissions 

func (_class SessionClass) GetRbacPermissions(sessionID SessionRef, self SessionRef) (_retval []string, _err error)

Get the rbac_permissions field of the given session.

func (SessionClass) GetRecord 

func (_class SessionClass) GetRecord(sessionID SessionRef, self SessionRef) (_retval SessionRecord, _err error)

Get a record containing the current state of the given session.

func (SessionClass) GetSubject 

func (_class SessionClass) GetSubject(sessionID SessionRef, self SessionRef) (_retval SubjectRef, _err error)

Get the subject field of the given session.

func (SessionClass) GetTasks 

func (_class SessionClass) GetTasks(sessionID SessionRef, self SessionRef) (_retval []TaskRef, _err error)

Get the tasks field of the given session.

func (SessionClass) GetThisHost 

func (_class SessionClass) GetThisHost(sessionID SessionRef, self SessionRef) (_retval HostRef, _err error)

Get the this_host field of the given session.

func (SessionClass) GetThisUser 

func (_class SessionClass) GetThisUser(sessionID SessionRef, self SessionRef) (_retval UserRef, _err error)

Get the this_user field of the given session.

func (SessionClass) GetUUID 

func (_class SessionClass) GetUUID(sessionID SessionRef, self SessionRef) (_retval string, _err error)

Get the uuid field of the given session.

func (SessionClass) GetValidationTime 

func (_class SessionClass) GetValidationTime(sessionID SessionRef, self SessionRef) (_retval time.Time, _err error)

Get the validation_time field of the given session.

func (SessionClass) LocalLogout 

func (_class SessionClass) LocalLogout(sessionID SessionRef) (_err error)

Log out of local session.

func (SessionClass) LoginWithPassword 

func (_class SessionClass) LoginWithPassword(uname string, pwd string, version string, originator string) (_retval SessionRef, _err error)

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

Errors: 

SESSION_AUTHENTICATION_FAILED - The credentials given by the user are incorrect, so access has been denied, and you have not been issued a session handle.
HOST_IS_SLAVE - You cannot make regular API calls directly on a slave. Please pass API calls via the master host.

func (SessionClass) Logout 

func (_class SessionClass) Logout(sessionID SessionRef) (_err error)

Log out of a session

func (SessionClass) LogoutSubjectIdentifier 

func (_class SessionClass) LogoutSubjectIdentifier(sessionID SessionRef, subjectIdentifier string) (_err error)

Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function

func (SessionClass) RemoveFromOtherConfig 

func (_class SessionClass) RemoveFromOtherConfig(sessionID SessionRef, self SessionRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given session. If the key is not in that Map, then do nothing.

func (SessionClass) SetOtherConfig 

func (_class SessionClass) SetOtherConfig(sessionID SessionRef, self SessionRef, value map[string]string) (_err error)

Set the other_config field of the given session.

func (SessionClass) SlaveLocalLoginWithPassword 

func (_class SessionClass) SlaveLocalLoginWithPassword(uname string, pwd string) (_retval SessionRef, _err error)

Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host.

type SessionRecord 

type SessionRecord struct {
	// Unique identifier/object reference
	UUID string
	// Currently connected host
	ThisHost HostRef
	// Currently connected user
	ThisUser UserRef
	// Timestamp for last time session was active
	LastActive time.Time
	// True if this session relates to a intra-pool login, false otherwise
	Pool bool
	// additional configuration
	OtherConfig map[string]string
	// true iff this session was created using local superuser credentials
	IsLocalSuperuser bool
	// references the subject instance that created the session. If a session instance has is_local_superuser set, then the value of this field is undefined.
	Subject SubjectRef
	// time when session was last validated
	ValidationTime time.Time
	// the subject identifier of the user that was externally authenticated. If a session instance has is_local_superuser set, then the value of this field is undefined.
	AuthUserSid string
	// the subject name of the user that was externally authenticated. If a session instance has is_local_superuser set, then the value of this field is undefined.
	AuthUserName string
	// list with all RBAC permissions for this session
	RbacPermissions []string
	// list of tasks created using the current session
	Tasks []TaskRef
	// references the parent session that created this session
	Parent SessionRef
	// a key string provided by a API user to distinguish itself from other users sharing the same login name
	Originator string
}

type SessionRef 

type SessionRef string

type StorageOperations 

type StorageOperations string
const (
	// Scanning backends for new or deleted VDIs
	StorageOperationsScan StorageOperations = "scan"
	// Destroying the SR
	StorageOperationsDestroy StorageOperations = "destroy"
	// Forgetting about SR
	StorageOperationsForget StorageOperations = "forget"
	// Plugging a PBD into this SR
	StorageOperationsPlug StorageOperations = "plug"
	// Unplugging a PBD from this SR
	StorageOperationsUnplug StorageOperations = "unplug"
	// Refresh the fields on the SR
	StorageOperationsUpdate StorageOperations = "update"
	// Creating a new VDI
	StorageOperationsVdiCreate StorageOperations = "vdi_create"
	// Introducing a new VDI
	StorageOperationsVdiIntroduce StorageOperations = "vdi_introduce"
	// Destroying a VDI
	StorageOperationsVdiDestroy StorageOperations = "vdi_destroy"
	// Resizing a VDI
	StorageOperationsVdiResize StorageOperations = "vdi_resize"
	// Cloneing a VDI
	StorageOperationsVdiClone StorageOperations = "vdi_clone"
	// Snapshotting a VDI
	StorageOperationsVdiSnapshot StorageOperations = "vdi_snapshot"
	// Creating a PBD for this SR
	StorageOperationsPbdCreate StorageOperations = "pbd_create"
	// Destroying one of this SR's PBDs
	StorageOperationsPbdDestroy StorageOperations = "pbd_destroy"
)

type SubjectClass 

type SubjectClass struct {
	// contains filtered or unexported fields
}

A user or group that can log in xapi

func (SubjectClass) AddToRoles 

func (_class SubjectClass) AddToRoles(sessionID SessionRef, self SubjectRef, role RoleRef) (_err error)

This call adds a new role to a subject

func (SubjectClass) Create 

func (_class SubjectClass) Create(sessionID SessionRef, args SubjectRecord) (_retval SubjectRef, _err error)

Create a new subject instance, and return its handle. The constructor args are: subject_identifier, other_config (* = non-optional).

func (SubjectClass) Destroy 

func (_class SubjectClass) Destroy(sessionID SessionRef, self SubjectRef) (_err error)

Destroy the specified subject instance.

func (SubjectClass) GetAll 

func (_class SubjectClass) GetAll(sessionID SessionRef) (_retval []SubjectRef, _err error)

Return a list of all the subjects known to the system.

func (SubjectClass) GetAllRecords 

func (_class SubjectClass) GetAllRecords(sessionID SessionRef) (_retval map[SubjectRef]SubjectRecord, _err error)

Return a map of subject references to subject records for all subjects known to the system.

func (SubjectClass) GetByUUID 

func (_class SubjectClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SubjectRef, _err error)

Get a reference to the subject instance with the specified UUID.

func (SubjectClass) GetOtherConfig 

func (_class SubjectClass) GetOtherConfig(sessionID SessionRef, self SubjectRef) (_retval map[string]string, _err error)

Get the other_config field of the given subject.

func (SubjectClass) GetPermissionsNameLabel 

func (_class SubjectClass) GetPermissionsNameLabel(sessionID SessionRef, self SubjectRef) (_retval []string, _err error)

This call returns a list of permission names given a subject

func (SubjectClass) GetRecord 

func (_class SubjectClass) GetRecord(sessionID SessionRef, self SubjectRef) (_retval SubjectRecord, _err error)

Get a record containing the current state of the given subject.

func (SubjectClass) GetRoles 

func (_class SubjectClass) GetRoles(sessionID SessionRef, self SubjectRef) (_retval []RoleRef, _err error)

Get the roles field of the given subject.

func (SubjectClass) GetSubjectIdentifier 

func (_class SubjectClass) GetSubjectIdentifier(sessionID SessionRef, self SubjectRef) (_retval string, _err error)

Get the subject_identifier field of the given subject.

func (SubjectClass) GetUUID 

func (_class SubjectClass) GetUUID(sessionID SessionRef, self SubjectRef) (_retval string, _err error)

Get the uuid field of the given subject.

func (SubjectClass) RemoveFromRoles 

func (_class SubjectClass) RemoveFromRoles(sessionID SessionRef, self SubjectRef, role RoleRef) (_err error)

This call removes a role from a subject

type SubjectRecord 

type SubjectRecord struct {
	// Unique identifier/object reference
	UUID string
	// the subject identifier, unique in the external directory service
	SubjectIdentifier string
	// additional configuration
	OtherConfig map[string]string
	// the roles associated with this subject
	Roles []RoleRef
}

type SubjectRef 

type SubjectRef string

type TaskAllowedOperations 

type TaskAllowedOperations string
const (
	// refers to the operation "cancel"
	TaskAllowedOperationsCancel TaskAllowedOperations = "cancel"
	// refers to the operation "destroy"
	TaskAllowedOperationsDestroy TaskAllowedOperations = "destroy"
)

type TaskClass 

type TaskClass struct {
	// contains filtered or unexported fields
}

A long-running asynchronous task

func (TaskClass) AddToOtherConfig 

func (_class TaskClass) AddToOtherConfig(sessionID SessionRef, self TaskRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given task.

func (TaskClass) Cancel 

func (_class TaskClass) Cancel(sessionID SessionRef, task TaskRef) (_err error)

Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time.

Errors: 

OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (TaskClass) Create 

func (_class TaskClass) Create(sessionID SessionRef, label string, description string) (_retval TaskRef, _err error)

Create a new task object which must be manually destroyed.

func (TaskClass) Destroy 

func (_class TaskClass) Destroy(sessionID SessionRef, self TaskRef) (_err error)

Destroy the task object

func (TaskClass) GetAll 

func (_class TaskClass) GetAll(sessionID SessionRef) (_retval []TaskRef, _err error)

Return a list of all the tasks known to the system.

func (TaskClass) GetAllRecords 

func (_class TaskClass) GetAllRecords(sessionID SessionRef) (_retval map[TaskRef]TaskRecord, _err error)

Return a map of task references to task records for all tasks known to the system.

func (TaskClass) GetAllowedOperations 

func (_class TaskClass) GetAllowedOperations(sessionID SessionRef, self TaskRef) (_retval []TaskAllowedOperations, _err error)

Get the allowed_operations field of the given task.

func (TaskClass) GetBacktrace 

func (_class TaskClass) GetBacktrace(sessionID SessionRef, self TaskRef) (_retval string, _err error)

Get the backtrace field of the given task.

func (TaskClass) GetByNameLabel 

func (_class TaskClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []TaskRef, _err error)

Get all the task instances with the given label.

func (TaskClass) GetByUUID 

func (_class TaskClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TaskRef, _err error)

Get a reference to the task instance with the specified UUID.

func (TaskClass) GetCreated 

func (_class TaskClass) GetCreated(sessionID SessionRef, self TaskRef) (_retval time.Time, _err error)

Get the created field of the given task.

func (TaskClass) GetCurrentOperations 

func (_class TaskClass) GetCurrentOperations(sessionID SessionRef, self TaskRef) (_retval map[string]TaskAllowedOperations, _err error)

Get the current_operations field of the given task.

func (TaskClass) GetErrorInfo 

func (_class TaskClass) GetErrorInfo(sessionID SessionRef, self TaskRef) (_retval []string, _err error)

Get the error_info field of the given task.

func (TaskClass) GetFinished 

func (_class TaskClass) GetFinished(sessionID SessionRef, self TaskRef) (_retval time.Time, _err error)

Get the finished field of the given task.

func (TaskClass) GetNameDescription 

func (_class TaskClass) GetNameDescription(sessionID SessionRef, self TaskRef) (_retval string, _err error)

Get the name/description field of the given task.

func (TaskClass) GetNameLabel 

func (_class TaskClass) GetNameLabel(sessionID SessionRef, self TaskRef) (_retval string, _err error)

Get the name/label field of the given task.

func (TaskClass) GetOtherConfig 

func (_class TaskClass) GetOtherConfig(sessionID SessionRef, self TaskRef) (_retval map[string]string, _err error)

Get the other_config field of the given task.

func (TaskClass) GetProgress 

func (_class TaskClass) GetProgress(sessionID SessionRef, self TaskRef) (_retval float64, _err error)

Get the progress field of the given task.

func (TaskClass) GetRecord 

func (_class TaskClass) GetRecord(sessionID SessionRef, self TaskRef) (_retval TaskRecord, _err error)

Get a record containing the current state of the given task.

func (TaskClass) GetResidentOn 

func (_class TaskClass) GetResidentOn(sessionID SessionRef, self TaskRef) (_retval HostRef, _err error)

Get the resident_on field of the given task.

func (TaskClass) GetResult 

func (_class TaskClass) GetResult(sessionID SessionRef, self TaskRef) (_retval string, _err error)

Get the result field of the given task.

func (TaskClass) GetStatus 

func (_class TaskClass) GetStatus(sessionID SessionRef, self TaskRef) (_retval TaskStatusType, _err error)

Get the status field of the given task.

func (TaskClass) GetSubtaskOf 

func (_class TaskClass) GetSubtaskOf(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

Get the subtask_of field of the given task.

func (TaskClass) GetSubtasks 

func (_class TaskClass) GetSubtasks(sessionID SessionRef, self TaskRef) (_retval []TaskRef, _err error)

Get the subtasks field of the given task.

func (TaskClass) GetType 

func (_class TaskClass) GetType(sessionID SessionRef, self TaskRef) (_retval string, _err error)

Get the type field of the given task.

func (TaskClass) GetUUID 

func (_class TaskClass) GetUUID(sessionID SessionRef, self TaskRef) (_retval string, _err error)

Get the uuid field of the given task.

func (TaskClass) RemoveFromOtherConfig 

func (_class TaskClass) RemoveFromOtherConfig(sessionID SessionRef, self TaskRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given task. If the key is not in that Map, then do nothing.

func (TaskClass) SetOtherConfig 

func (_class TaskClass) SetOtherConfig(sessionID SessionRef, self TaskRef, value map[string]string) (_err error)

Set the other_config field of the given task.

type TaskRecord 

type TaskRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []TaskAllowedOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]TaskAllowedOperations
	// Time task was created
	Created time.Time
	// Time task finished (i.e. succeeded or failed). If task-status is pending, then the value of this field has no meaning
	Finished time.Time
	// current status of the task
	Status TaskStatusType
	// the host on which the task is running
	ResidentOn HostRef
	// This field contains the estimated fraction of the task which is complete. This field should not be used to determine whether the task is complete - for this the status field of the task should be used.
	Progress float64
	// if the task has completed successfully, this field contains the type of the encoded result (i.e. name of the class whose reference is in the result field). Undefined otherwise.
	Type string
	// if the task has completed successfully, this field contains the result value (either Void or an object reference). Undefined otherwise.
	Result string
	// if the task has failed, this field contains the set of associated error strings. Undefined otherwise.
	ErrorInfo []string
	// additional configuration
	OtherConfig map[string]string
	// Ref pointing to the task this is a substask of.
	SubtaskOf TaskRef
	// List pointing to all the substasks.
	Subtasks []TaskRef
	// Function call trace for debugging.
	Backtrace string
}

type TaskRef 

type TaskRef string

type TaskStatusType 

type TaskStatusType string
const (
	// task is in progress
	TaskStatusTypePending TaskStatusType = "pending"
	// task was completed successfully
	TaskStatusTypeSuccess TaskStatusType = "success"
	// task has failed
	TaskStatusTypeFailure TaskStatusType = "failure"
	// task is being cancelled
	TaskStatusTypeCancelling TaskStatusType = "cancelling"
	// task has been cancelled
	TaskStatusTypeCancelled TaskStatusType = "cancelled"
)

type TunnelClass 

type TunnelClass struct {
	// contains filtered or unexported fields
}

A tunnel for network traffic

func (TunnelClass) AddToOtherConfig 

func (_class TunnelClass) AddToOtherConfig(sessionID SessionRef, self TunnelRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given tunnel.

func (TunnelClass) AddToStatus 

func (_class TunnelClass) AddToStatus(sessionID SessionRef, self TunnelRef, key string, value string) (_err error)

Add the given key-value pair to the status field of the given tunnel.

func (TunnelClass) Create 

func (_class TunnelClass) Create(sessionID SessionRef, transportPIF PIFRef, network NetworkRef) (_retval TunnelRef, _err error)

Create a tunnel

Errors: 

OPENVSWITCH_NOT_ACTIVE - This operation needs the OpenVSwitch networking backend to be enabled on all hosts in the pool.
TRANSPORT_PIF_NOT_CONFIGURED - The tunnel transport PIF has no IP configuration set.
IS_TUNNEL_ACCESS_PIF - You tried to create a VLAN or tunnel on top of a tunnel access PIF - use the underlying transport PIF instead.

func (TunnelClass) Destroy 

func (_class TunnelClass) Destroy(sessionID SessionRef, self TunnelRef) (_err error)

Destroy a tunnel

func (TunnelClass) GetAccessPIF 

func (_class TunnelClass) GetAccessPIF(sessionID SessionRef, self TunnelRef) (_retval PIFRef, _err error)

Get the access_PIF field of the given tunnel.

func (TunnelClass) GetAll 

func (_class TunnelClass) GetAll(sessionID SessionRef) (_retval []TunnelRef, _err error)

Return a list of all the tunnels known to the system.

func (TunnelClass) GetAllRecords 

func (_class TunnelClass) GetAllRecords(sessionID SessionRef) (_retval map[TunnelRef]TunnelRecord, _err error)

Return a map of tunnel references to tunnel records for all tunnels known to the system.

func (TunnelClass) GetByUUID 

func (_class TunnelClass) GetByUUID(sessionID SessionRef, uuid string) (_retval TunnelRef, _err error)

Get a reference to the tunnel instance with the specified UUID.

func (TunnelClass) GetOtherConfig 

func (_class TunnelClass) GetOtherConfig(sessionID SessionRef, self TunnelRef) (_retval map[string]string, _err error)

Get the other_config field of the given tunnel.

func (TunnelClass) GetRecord 

func (_class TunnelClass) GetRecord(sessionID SessionRef, self TunnelRef) (_retval TunnelRecord, _err error)

Get a record containing the current state of the given tunnel.

func (TunnelClass) GetStatus 

func (_class TunnelClass) GetStatus(sessionID SessionRef, self TunnelRef) (_retval map[string]string, _err error)

Get the status field of the given tunnel.

func (TunnelClass) GetTransportPIF 

func (_class TunnelClass) GetTransportPIF(sessionID SessionRef, self TunnelRef) (_retval PIFRef, _err error)

Get the transport_PIF field of the given tunnel.

func (TunnelClass) GetUUID 

func (_class TunnelClass) GetUUID(sessionID SessionRef, self TunnelRef) (_retval string, _err error)

Get the uuid field of the given tunnel.

func (TunnelClass) RemoveFromOtherConfig 

func (_class TunnelClass) RemoveFromOtherConfig(sessionID SessionRef, self TunnelRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given tunnel. If the key is not in that Map, then do nothing.

func (TunnelClass) RemoveFromStatus 

func (_class TunnelClass) RemoveFromStatus(sessionID SessionRef, self TunnelRef, key string) (_err error)

Remove the given key and its corresponding value from the status field of the given tunnel. If the key is not in that Map, then do nothing.

func (TunnelClass) SetOtherConfig 

func (_class TunnelClass) SetOtherConfig(sessionID SessionRef, self TunnelRef, value map[string]string) (_err error)

Set the other_config field of the given tunnel.

func (TunnelClass) SetStatus 

func (_class TunnelClass) SetStatus(sessionID SessionRef, self TunnelRef, value map[string]string) (_err error)

Set the status field of the given tunnel.

type TunnelRecord 

type TunnelRecord struct {
	// Unique identifier/object reference
	UUID string
	// The interface through which the tunnel is accessed
	AccessPIF PIFRef
	// The interface used by the tunnel
	TransportPIF PIFRef
	// Status information about the tunnel
	Status map[string]string
	// Additional configuration
	OtherConfig map[string]string
}

type TunnelRef 

type TunnelRef string

type UserClass 

type UserClass struct {
	// contains filtered or unexported fields
}

A user of the system

func (UserClass) AddToOtherConfig 

func (_class UserClass) AddToOtherConfig(sessionID SessionRef, self UserRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given user.

func (UserClass) Create 

func (_class UserClass) Create(sessionID SessionRef, args UserRecord) (_retval UserRef, _err error)

Create a new user instance, and return its handle. The constructor args are: short_name*, fullname*, other_config (* = non-optional).

func (UserClass) Destroy 

func (_class UserClass) Destroy(sessionID SessionRef, self UserRef) (_err error)

Destroy the specified user instance.

func (UserClass) GetByUUID 

func (_class UserClass) GetByUUID(sessionID SessionRef, uuid string) (_retval UserRef, _err error)

Get a reference to the user instance with the specified UUID.

func (UserClass) GetFullname 

func (_class UserClass) GetFullname(sessionID SessionRef, self UserRef) (_retval string, _err error)

Get the fullname field of the given user.

func (UserClass) GetOtherConfig 

func (_class UserClass) GetOtherConfig(sessionID SessionRef, self UserRef) (_retval map[string]string, _err error)

Get the other_config field of the given user.

func (UserClass) GetRecord 

func (_class UserClass) GetRecord(sessionID SessionRef, self UserRef) (_retval UserRecord, _err error)

Get a record containing the current state of the given user.

func (UserClass) GetShortName 

func (_class UserClass) GetShortName(sessionID SessionRef, self UserRef) (_retval string, _err error)

Get the short_name field of the given user.

func (UserClass) GetUUID 

func (_class UserClass) GetUUID(sessionID SessionRef, self UserRef) (_retval string, _err error)

Get the uuid field of the given user.

func (UserClass) RemoveFromOtherConfig 

func (_class UserClass) RemoveFromOtherConfig(sessionID SessionRef, self UserRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given user. If the key is not in that Map, then do nothing.

func (UserClass) SetFullname 

func (_class UserClass) SetFullname(sessionID SessionRef, self UserRef, value string) (_err error)

Set the fullname field of the given user.

func (UserClass) SetOtherConfig 

func (_class UserClass) SetOtherConfig(sessionID SessionRef, self UserRef, value map[string]string) (_err error)

Set the other_config field of the given user.

type UserRecord 

type UserRecord struct {
	// Unique identifier/object reference
	UUID string
	// short name (e.g. userid)
	ShortName string
	// full name
	Fullname string
	// additional configuration
	OtherConfig map[string]string
}

type UserRef 

type UserRef string

type VBDClass 

type VBDClass struct {
	// contains filtered or unexported fields
}

A virtual block device

func (VBDClass) AddToOtherConfig 

func (_class VBDClass) AddToOtherConfig(sessionID SessionRef, self VBDRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VBD.

func (VBDClass) AddToQosAlgorithmParams 

func (_class VBDClass) AddToQosAlgorithmParams(sessionID SessionRef, self VBDRef, key string, value string) (_err error)

Add the given key-value pair to the qos/algorithm_params field of the given VBD.

func (VBDClass) AssertAttachable 

func (_class VBDClass) AssertAttachable(sessionID SessionRef, self VBDRef) (_err error)

Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.

func (VBDClass) Create 

func (_class VBDClass) Create(sessionID SessionRef, args VBDRecord) (_retval VBDRef, _err error)

Create a new VBD instance, and return its handle. The constructor args are: VM*, VDI*, userdevice*, bootable*, mode*, type*, unpluggable, empty*, other_config*, qos_algorithm_type*, qos_algorithm_params* (* = non-optional).

func (VBDClass) Destroy 

func (_class VBDClass) Destroy(sessionID SessionRef, self VBDRef) (_err error)

Destroy the specified VBD instance.

func (VBDClass) Eject 

func (_class VBDClass) Eject(sessionID SessionRef, vbd VBDRef) (_err error)

Remove the media from the device and leave it empty

Errors: 

VBD_NOT_REMOVABLE_MEDIA - Media could not be ejected because it is not removable
VBD_IS_EMPTY - Operation could not be performed because the drive is empty

func (VBDClass) GetAll 

func (_class VBDClass) GetAll(sessionID SessionRef) (_retval []VBDRef, _err error)

Return a list of all the VBDs known to the system.

func (VBDClass) GetAllRecords 

func (_class VBDClass) GetAllRecords(sessionID SessionRef) (_retval map[VBDRef]VBDRecord, _err error)

Return a map of VBD references to VBD records for all VBDs known to the system.

func (VBDClass) GetAllowedOperations 

func (_class VBDClass) GetAllowedOperations(sessionID SessionRef, self VBDRef) (_retval []VbdOperations, _err error)

Get the allowed_operations field of the given VBD.

func (VBDClass) GetBootable 

func (_class VBDClass) GetBootable(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

Get the bootable field of the given VBD.

func (VBDClass) GetByUUID 

func (_class VBDClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VBDRef, _err error)

Get a reference to the VBD instance with the specified UUID.

func (VBDClass) GetCurrentOperations 

func (_class VBDClass) GetCurrentOperations(sessionID SessionRef, self VBDRef) (_retval map[string]VbdOperations, _err error)

Get the current_operations field of the given VBD.

func (VBDClass) GetCurrentlyAttached 

func (_class VBDClass) GetCurrentlyAttached(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

Get the currently_attached field of the given VBD.

func (VBDClass) GetDevice 

func (_class VBDClass) GetDevice(sessionID SessionRef, self VBDRef) (_retval string, _err error)

Get the device field of the given VBD.

func (VBDClass) GetEmpty 

func (_class VBDClass) GetEmpty(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

Get the empty field of the given VBD.

func (VBDClass) GetMetrics 

func (_class VBDClass) GetMetrics(sessionID SessionRef, self VBDRef) (_retval VBDMetricsRef, _err error)

Get the metrics field of the given VBD.

func (VBDClass) GetMode 

func (_class VBDClass) GetMode(sessionID SessionRef, self VBDRef) (_retval VbdMode, _err error)

Get the mode field of the given VBD.

func (VBDClass) GetOtherConfig 

func (_class VBDClass) GetOtherConfig(sessionID SessionRef, self VBDRef) (_retval map[string]string, _err error)

Get the other_config field of the given VBD.

func (VBDClass) GetQosAlgorithmParams 

func (_class VBDClass) GetQosAlgorithmParams(sessionID SessionRef, self VBDRef) (_retval map[string]string, _err error)

Get the qos/algorithm_params field of the given VBD.

func (VBDClass) GetQosAlgorithmType 

func (_class VBDClass) GetQosAlgorithmType(sessionID SessionRef, self VBDRef) (_retval string, _err error)

Get the qos/algorithm_type field of the given VBD.

func (VBDClass) GetQosSupportedAlgorithms 

func (_class VBDClass) GetQosSupportedAlgorithms(sessionID SessionRef, self VBDRef) (_retval []string, _err error)

Get the qos/supported_algorithms field of the given VBD.

func (VBDClass) GetRecord 

func (_class VBDClass) GetRecord(sessionID SessionRef, self VBDRef) (_retval VBDRecord, _err error)

Get a record containing the current state of the given VBD.

func (VBDClass) GetRuntimeProperties 

func (_class VBDClass) GetRuntimeProperties(sessionID SessionRef, self VBDRef) (_retval map[string]string, _err error)

Get the runtime_properties field of the given VBD.

func (VBDClass) GetStatusCode 

func (_class VBDClass) GetStatusCode(sessionID SessionRef, self VBDRef) (_retval int, _err error)

Get the status_code field of the given VBD.

func (VBDClass) GetStatusDetail 

func (_class VBDClass) GetStatusDetail(sessionID SessionRef, self VBDRef) (_retval string, _err error)

Get the status_detail field of the given VBD.

func (VBDClass) GetStorageLock 

func (_class VBDClass) GetStorageLock(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

Get the storage_lock field of the given VBD.

func (VBDClass) GetType 

func (_class VBDClass) GetType(sessionID SessionRef, self VBDRef) (_retval VbdType, _err error)

Get the type field of the given VBD.

func (VBDClass) GetUUID 

func (_class VBDClass) GetUUID(sessionID SessionRef, self VBDRef) (_retval string, _err error)

Get the uuid field of the given VBD.

func (VBDClass) GetUnpluggable 

func (_class VBDClass) GetUnpluggable(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

Get the unpluggable field of the given VBD.

func (VBDClass) GetUserdevice 

func (_class VBDClass) GetUserdevice(sessionID SessionRef, self VBDRef) (_retval string, _err error)

Get the userdevice field of the given VBD.

func (VBDClass) GetVDI 

func (_class VBDClass) GetVDI(sessionID SessionRef, self VBDRef) (_retval VDIRef, _err error)

Get the VDI field of the given VBD.

func (VBDClass) GetVM 

func (_class VBDClass) GetVM(sessionID SessionRef, self VBDRef) (_retval VMRef, _err error)

Get the VM field of the given VBD.

func (VBDClass) Insert 

func (_class VBDClass) Insert(sessionID SessionRef, vbd VBDRef, vdi VDIRef) (_err error)

Insert new media into the device

Errors: 

VBD_NOT_REMOVABLE_MEDIA - Media could not be ejected because it is not removable
VBD_NOT_EMPTY - Operation could not be performed because the drive is not empty

func (VBDClass) Plug 

func (_class VBDClass) Plug(sessionID SessionRef, self VBDRef) (_err error)

Hotplug the specified VBD, dynamically attaching it to the running VM

func (VBDClass) RemoveFromOtherConfig 

func (_class VBDClass) RemoveFromOtherConfig(sessionID SessionRef, self VBDRef, key string) (_err error)

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.

func (VBDClass) RemoveFromQosAlgorithmParams 

func (_class VBDClass) RemoveFromQosAlgorithmParams(sessionID SessionRef, self VBDRef, key string) (_err error)

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.

func (VBDClass) SetBootable 

func (_class VBDClass) SetBootable(sessionID SessionRef, self VBDRef, value bool) (_err error)

Set the bootable field of the given VBD.

func (VBDClass) SetMode 

func (_class VBDClass) SetMode(sessionID SessionRef, self VBDRef, value VbdMode) (_err error)

Set the mode field of the given VBD.

func (VBDClass) SetOtherConfig 

func (_class VBDClass) SetOtherConfig(sessionID SessionRef, self VBDRef, value map[string]string) (_err error)

Set the other_config field of the given VBD.

func (VBDClass) SetQosAlgorithmParams 

func (_class VBDClass) SetQosAlgorithmParams(sessionID SessionRef, self VBDRef, value map[string]string) (_err error)

Set the qos/algorithm_params field of the given VBD.

func (VBDClass) SetQosAlgorithmType 

func (_class VBDClass) SetQosAlgorithmType(sessionID SessionRef, self VBDRef, value string) (_err error)

Set the qos/algorithm_type field of the given VBD.

func (VBDClass) SetType 

func (_class VBDClass) SetType(sessionID SessionRef, self VBDRef, value VbdType) (_err error)

Set the type field of the given VBD.

func (VBDClass) SetUnpluggable 

func (_class VBDClass) SetUnpluggable(sessionID SessionRef, self VBDRef, value bool) (_err error)

Set the unpluggable field of the given VBD.

func (VBDClass) SetUserdevice 

func (_class VBDClass) SetUserdevice(sessionID SessionRef, self VBDRef, value string) (_err error)

Set the userdevice field of the given VBD.

func (VBDClass) Unplug 

func (_class VBDClass) Unplug(sessionID SessionRef, self VBDRef) (_err error)

Hot-unplug the specified VBD, dynamically unattaching it from the running VM

Errors: 

DEVICE_DETACH_REJECTED - The VM rejected the attempt to detach the device.
DEVICE_ALREADY_DETACHED - The device is not currently attached

func (VBDClass) UnplugForce 

func (_class VBDClass) UnplugForce(sessionID SessionRef, self VBDRef) (_err error)

Forcibly unplug the specified VBD

type VBDMetricsClass 

type VBDMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a virtual block device

func (VBDMetricsClass) AddToOtherConfig 

func (_class VBDMetricsClass) AddToOtherConfig(sessionID SessionRef, self VBDMetricsRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VBD_metrics.

func (VBDMetricsClass) GetAll 

func (_class VBDMetricsClass) GetAll(sessionID SessionRef) (_retval []VBDMetricsRef, _err error)

Return a list of all the VBD_metrics instances known to the system.

func (VBDMetricsClass) GetAllRecords 

func (_class VBDMetricsClass) GetAllRecords(sessionID SessionRef) (_retval map[VBDMetricsRef]VBDMetricsRecord, _err error)

Return a map of VBD_metrics references to VBD_metrics records for all VBD_metrics instances known to the system.

func (VBDMetricsClass) GetByUUID 

func (_class VBDMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VBDMetricsRef, _err error)

Get a reference to the VBD_metrics instance with the specified UUID.

func (VBDMetricsClass) GetIoReadKbs 

func (_class VBDMetricsClass) GetIoReadKbs(sessionID SessionRef, self VBDMetricsRef) (_retval float64, _err error)

Get the io/read_kbs field of the given VBD_metrics.

func (VBDMetricsClass) GetIoWriteKbs 

func (_class VBDMetricsClass) GetIoWriteKbs(sessionID SessionRef, self VBDMetricsRef) (_retval float64, _err error)

Get the io/write_kbs field of the given VBD_metrics.

func (VBDMetricsClass) GetLastUpdated 

func (_class VBDMetricsClass) GetLastUpdated(sessionID SessionRef, self VBDMetricsRef) (_retval time.Time, _err error)

Get the last_updated field of the given VBD_metrics.

func (VBDMetricsClass) GetOtherConfig 

func (_class VBDMetricsClass) GetOtherConfig(sessionID SessionRef, self VBDMetricsRef) (_retval map[string]string, _err error)

Get the other_config field of the given VBD_metrics.

func (VBDMetricsClass) GetRecord 

func (_class VBDMetricsClass) GetRecord(sessionID SessionRef, self VBDMetricsRef) (_retval VBDMetricsRecord, _err error)

Get a record containing the current state of the given VBD_metrics.

func (VBDMetricsClass) GetUUID 

func (_class VBDMetricsClass) GetUUID(sessionID SessionRef, self VBDMetricsRef) (_retval string, _err error)

Get the uuid field of the given VBD_metrics.

func (VBDMetricsClass) RemoveFromOtherConfig 

func (_class VBDMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VBDMetricsRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given VBD_metrics. If the key is not in that Map, then do nothing.

func (VBDMetricsClass) SetOtherConfig 

func (_class VBDMetricsClass) SetOtherConfig(sessionID SessionRef, self VBDMetricsRef, value map[string]string) (_err error)

Set the other_config field of the given VBD_metrics.

type VBDMetricsRecord 

type VBDMetricsRecord struct {
	// Unique identifier/object reference
	UUID string
	// Read bandwidth (KiB/s)
	IoReadKbs float64
	// Write bandwidth (KiB/s)
	IoWriteKbs float64
	// Time at which this information was last updated
	LastUpdated time.Time
	// additional configuration
	OtherConfig map[string]string
}

type VBDMetricsRef 

type VBDMetricsRef string

type VBDRecord 

type VBDRecord struct {
	// Unique identifier/object reference
	UUID string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []VbdOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]VbdOperations
	// the virtual machine
	VM VMRef
	// the virtual disk
	VDI VDIRef
	// device seen by the guest e.g. hda1
	Device string
	// user-friendly device name e.g. 0,1,2,etc.
	Userdevice string
	// true if this VBD is bootable
	Bootable bool
	// the mode the VBD should be mounted with
	Mode VbdMode
	// how the VBD will appear to the guest (e.g. disk or CD)
	Type VbdType
	// true if this VBD will support hot-unplug
	Unpluggable bool
	// true if a storage level lock was acquired
	StorageLock bool
	// if true this represents an empty drive
	Empty bool
	// additional configuration
	OtherConfig map[string]string
	// is the device currently attached (erased on reboot)
	CurrentlyAttached bool
	// error/success code associated with last attach-operation (erased on reboot)
	StatusCode int
	// error/success information associated with last attach-operation status (erased on reboot)
	StatusDetail string
	// Device runtime properties
	RuntimeProperties map[string]string
	// QoS algorithm to use
	QosAlgorithmType string
	// parameters for chosen QoS algorithm
	QosAlgorithmParams map[string]string
	// supported QoS algorithms for this VBD
	QosSupportedAlgorithms []string
	// metrics associated with this VBD
	Metrics VBDMetricsRef
}

type VBDRef 

type VBDRef string

type VDIClass 

type VDIClass struct {
	// contains filtered or unexported fields
}

A virtual disk image

func (VDIClass) AddTags 

func (_class VDIClass) AddTags(sessionID SessionRef, self VDIRef, value string) (_err error)

Add the given value to the tags field of the given VDI. If the value is already in that Set, then do nothing.

func (VDIClass) AddToOtherConfig 

func (_class VDIClass) AddToOtherConfig(sessionID SessionRef, self VDIRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VDI.

func (VDIClass) AddToSmConfig 

func (_class VDIClass) AddToSmConfig(sessionID SessionRef, self VDIRef, key string, value string) (_err error)

Add the given key-value pair to the sm_config field of the given VDI.

func (VDIClass) AddToXenstoreData 

func (_class VDIClass) AddToXenstoreData(sessionID SessionRef, self VDIRef, key string, value string) (_err error)

Add the given key-value pair to the xenstore_data field of the given VDI.

func (VDIClass) Clone 

func (_class VDIClass) Clone(sessionID SessionRef, vdi VDIRef, driverParams map[string]string) (_retval VDIRef, _err error)

Take an exact copy of the VDI and return a reference to the new disk. If any driver_params are specified then these are passed through to the storage-specific substrate driver that implements the clone operation. NB the clone lives in the same Storage Repository as its parent.

func (VDIClass) Copy 

func (_class VDIClass) Copy(sessionID SessionRef, vdi VDIRef, sr SRRef, baseVdi VDIRef, intoVdi VDIRef) (_retval VDIRef, _err error)

Copy either a full VDI or the block differences between two VDIs into either a fresh VDI or an existing VDI.

Errors: 

VDI_READONLY - The operation required write access but this VDI is read-only
VDI_TOO_SMALL - The VDI is too small. Please resize it to at least the minimum size.
VDI_NOT_SPARSE - The VDI is not stored using a sparse format. It is not possible to query and manipulate only the changed blocks (or 'block differences' or 'disk deltas') between two VDIs. Please select a VDI which uses a sparse-aware technology such as VHD.

func (VDIClass) Create 

func (_class VDIClass) Create(sessionID SessionRef, args VDIRecord) (_retval VDIRef, _err error)

Create a new VDI instance, and return its handle. The constructor args are: name_label, name_description, SR*, virtual_size*, type*, sharable*, read_only*, other_config*, xenstore_data, sm_config, tags (* = non-optional).

func (VDIClass) DbForget 

func (_class VDIClass) DbForget(sessionID SessionRef, vdi VDIRef) (_err error)

Removes a VDI record from the database

func (VDIClass) DbIntroduce 

func (_class VDIClass) DbIntroduce(sessionID SessionRef, uuid string, nameLabel string, nameDescription string, sr SRRef, atype VdiType, sharable bool, readOnly bool, otherConfig map[string]string, location string, xenstoreData map[string]string, smConfig map[string]string, managed bool, virtualSize int, physicalUtilisation int, metadataOfPool PoolRef, isASnapshot bool, snapshotTime time.Time, snapshotOf VDIRef) (_retval VDIRef, _err error)

Create a new VDI record in the database only

func (VDIClass) Destroy 

func (_class VDIClass) Destroy(sessionID SessionRef, self VDIRef) (_err error)

Destroy the specified VDI instance.

func (VDIClass) Forget 

func (_class VDIClass) Forget(sessionID SessionRef, vdi VDIRef) (_err error)

Removes a VDI record from the database

func (VDIClass) GetAll 

func (_class VDIClass) GetAll(sessionID SessionRef) (_retval []VDIRef, _err error)

Return a list of all the VDIs known to the system.

func (VDIClass) GetAllRecords 

func (_class VDIClass) GetAllRecords(sessionID SessionRef) (_retval map[VDIRef]VDIRecord, _err error)

Return a map of VDI references to VDI records for all VDIs known to the system.

func (VDIClass) GetAllowCaching 

func (_class VDIClass) GetAllowCaching(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the allow_caching field of the given VDI.

func (VDIClass) GetAllowedOperations 

func (_class VDIClass) GetAllowedOperations(sessionID SessionRef, self VDIRef) (_retval []VdiOperations, _err error)

Get the allowed_operations field of the given VDI.

func (VDIClass) GetByNameLabel 

func (_class VDIClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VDIRef, _err error)

Get all the VDI instances with the given label.

func (VDIClass) GetByUUID 

func (_class VDIClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VDIRef, _err error)

Get a reference to the VDI instance with the specified UUID.

func (VDIClass) GetCrashDumps 

func (_class VDIClass) GetCrashDumps(sessionID SessionRef, self VDIRef) (_retval []CrashdumpRef, _err error)

Get the crash_dumps field of the given VDI.

func (VDIClass) GetCurrentOperations 

func (_class VDIClass) GetCurrentOperations(sessionID SessionRef, self VDIRef) (_retval map[string]VdiOperations, _err error)

Get the current_operations field of the given VDI.

func (VDIClass) GetIsASnapshot 

func (_class VDIClass) GetIsASnapshot(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the is_a_snapshot field of the given VDI.

func (VDIClass) GetLocation 

func (_class VDIClass) GetLocation(sessionID SessionRef, self VDIRef) (_retval string, _err error)

Get the location field of the given VDI.

func (VDIClass) GetManaged 

func (_class VDIClass) GetManaged(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the managed field of the given VDI.

func (VDIClass) GetMetadataLatest 

func (_class VDIClass) GetMetadataLatest(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the metadata_latest field of the given VDI.

func (VDIClass) GetMetadataOfPool 

func (_class VDIClass) GetMetadataOfPool(sessionID SessionRef, self VDIRef) (_retval PoolRef, _err error)

Get the metadata_of_pool field of the given VDI.

func (VDIClass) GetMissing 

func (_class VDIClass) GetMissing(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the missing field of the given VDI.

func (VDIClass) GetNameDescription 

func (_class VDIClass) GetNameDescription(sessionID SessionRef, self VDIRef) (_retval string, _err error)

Get the name/description field of the given VDI.

func (VDIClass) GetNameLabel 

func (_class VDIClass) GetNameLabel(sessionID SessionRef, self VDIRef) (_retval string, _err error)

Get the name/label field of the given VDI.

func (VDIClass) GetOnBoot 

func (_class VDIClass) GetOnBoot(sessionID SessionRef, self VDIRef) (_retval OnBoot, _err error)

Get the on_boot field of the given VDI.

func (VDIClass) GetOtherConfig 

func (_class VDIClass) GetOtherConfig(sessionID SessionRef, self VDIRef) (_retval map[string]string, _err error)

Get the other_config field of the given VDI.

func (VDIClass) GetParent 

func (_class VDIClass) GetParent(sessionID SessionRef, self VDIRef) (_retval VDIRef, _err error)

Get the parent field of the given VDI.

func (VDIClass) GetPhysicalUtilisation 

func (_class VDIClass) GetPhysicalUtilisation(sessionID SessionRef, self VDIRef) (_retval int, _err error)

Get the physical_utilisation field of the given VDI.

func (VDIClass) GetReadOnly 

func (_class VDIClass) GetReadOnly(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the read_only field of the given VDI.

func (VDIClass) GetRecord 

func (_class VDIClass) GetRecord(sessionID SessionRef, self VDIRef) (_retval VDIRecord, _err error)

Get a record containing the current state of the given VDI.

func (VDIClass) GetSR 

func (_class VDIClass) GetSR(sessionID SessionRef, self VDIRef) (_retval SRRef, _err error)

Get the SR field of the given VDI.

func (VDIClass) GetSharable 

func (_class VDIClass) GetSharable(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the sharable field of the given VDI.

func (VDIClass) GetSmConfig 

func (_class VDIClass) GetSmConfig(sessionID SessionRef, self VDIRef) (_retval map[string]string, _err error)

Get the sm_config field of the given VDI.

func (VDIClass) GetSnapshotOf 

func (_class VDIClass) GetSnapshotOf(sessionID SessionRef, self VDIRef) (_retval VDIRef, _err error)

Get the snapshot_of field of the given VDI.

func (VDIClass) GetSnapshotTime 

func (_class VDIClass) GetSnapshotTime(sessionID SessionRef, self VDIRef) (_retval time.Time, _err error)

Get the snapshot_time field of the given VDI.

func (VDIClass) GetSnapshots 

func (_class VDIClass) GetSnapshots(sessionID SessionRef, self VDIRef) (_retval []VDIRef, _err error)

Get the snapshots field of the given VDI.

func (VDIClass) GetStorageLock 

func (_class VDIClass) GetStorageLock(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

Get the storage_lock field of the given VDI.

func (VDIClass) GetTags 

func (_class VDIClass) GetTags(sessionID SessionRef, self VDIRef) (_retval []string, _err error)

Get the tags field of the given VDI.

func (VDIClass) GetType 

func (_class VDIClass) GetType(sessionID SessionRef, self VDIRef) (_retval VdiType, _err error)

Get the type field of the given VDI.

func (VDIClass) GetUUID 

func (_class VDIClass) GetUUID(sessionID SessionRef, self VDIRef) (_retval string, _err error)

Get the uuid field of the given VDI.

func (VDIClass) GetVBDs 

func (_class VDIClass) GetVBDs(sessionID SessionRef, self VDIRef) (_retval []VBDRef, _err error)

Get the VBDs field of the given VDI.

func (VDIClass) GetVirtualSize 

func (_class VDIClass) GetVirtualSize(sessionID SessionRef, self VDIRef) (_retval int, _err error)

Get the virtual_size field of the given VDI.

func (VDIClass) GetXenstoreData 

func (_class VDIClass) GetXenstoreData(sessionID SessionRef, self VDIRef) (_retval map[string]string, _err error)

Get the xenstore_data field of the given VDI.

func (VDIClass) Introduce 

func (_class VDIClass) Introduce(sessionID SessionRef, uuid string, nameLabel string, nameDescription string, sr SRRef, atype VdiType, sharable bool, readOnly bool, otherConfig map[string]string, location string, xenstoreData map[string]string, smConfig map[string]string, managed bool, virtualSize int, physicalUtilisation int, metadataOfPool PoolRef, isASnapshot bool, snapshotTime time.Time, snapshotOf VDIRef) (_retval VDIRef, _err error)

Create a new VDI record in the database only

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)

func (VDIClass) OpenDatabase 

func (_class VDIClass) OpenDatabase(sessionID SessionRef, self VDIRef) (_retval SessionRef, _err error)

Load the metadata found on the supplied VDI and return a session reference which can be used in XenAPI calls to query its contents.

func (VDIClass) PoolMigrate 

func (_class VDIClass) PoolMigrate(sessionID SessionRef, vdi VDIRef, sr SRRef, options map[string]string) (_retval VDIRef, _err error)

Migrate a VDI, which may be attached to a running guest, to a different SR. The destination SR must be visible to the guest.

func (VDIClass) ReadDatabasePoolUUID 

func (_class VDIClass) ReadDatabasePoolUUID(sessionID SessionRef, self VDIRef) (_retval string, _err error)

Check the VDI cache for the pool UUID of the database on this VDI.

func (VDIClass) RemoveFromOtherConfig 

func (_class VDIClass) RemoveFromOtherConfig(sessionID SessionRef, self VDIRef, key string) (_err error)

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.

func (VDIClass) RemoveFromSmConfig 

func (_class VDIClass) RemoveFromSmConfig(sessionID SessionRef, self VDIRef, key string) (_err error)

Remove the given key and its corresponding value from the sm_config field of the given VDI. If the key is not in that Map, then do nothing.

func (VDIClass) RemoveFromXenstoreData 

func (_class VDIClass) RemoveFromXenstoreData(sessionID SessionRef, self VDIRef, key string) (_err error)

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.

func (VDIClass) RemoveTags 

func (_class VDIClass) RemoveTags(sessionID SessionRef, self VDIRef, value string) (_err error)

Remove the given value from the tags field of the given VDI. If the value is not in that Set, then do nothing.

func (VDIClass) Resize 

func (_class VDIClass) Resize(sessionID SessionRef, vdi VDIRef, size int) (_err error)

Resize the VDI.

func (VDIClass) ResizeOnline 

func (_class VDIClass) ResizeOnline(sessionID SessionRef, vdi VDIRef, size int) (_err error)

Resize the VDI which may or may not be attached to running guests.

func (VDIClass) SetAllowCaching 

func (_class VDIClass) SetAllowCaching(sessionID SessionRef, self VDIRef, value bool) (_err error)

Set the value of the allow_caching parameter. This value can only be changed when the VDI is not attached to a running VM. The caching behaviour is only affected by this flag for VHD-based VDIs that have one parent and no child VHDs. Moreover, caching only takes place when the host running the VM containing this VDI has a nominated SR for local caching.

func (VDIClass) SetIsASnapshot 

func (_class VDIClass) SetIsASnapshot(sessionID SessionRef, self VDIRef, value bool) (_err error)

Sets whether this VDI is a snapshot

func (VDIClass) SetManaged 

func (_class VDIClass) SetManaged(sessionID SessionRef, self VDIRef, value bool) (_err error)

Sets the VDI's managed field

func (VDIClass) SetMetadataOfPool 

func (_class VDIClass) SetMetadataOfPool(sessionID SessionRef, self VDIRef, value PoolRef) (_err error)

Records the pool whose metadata is contained by this VDI.

func (VDIClass) SetMissing 

func (_class VDIClass) SetMissing(sessionID SessionRef, self VDIRef, value bool) (_err error)

Sets the VDI's missing field

func (VDIClass) SetNameDescription 

func (_class VDIClass) SetNameDescription(sessionID SessionRef, self VDIRef, value string) (_err error)

Set the name description of the VDI. This can only happen when its SR is currently attached.

func (VDIClass) SetNameLabel 

func (_class VDIClass) SetNameLabel(sessionID SessionRef, self VDIRef, value string) (_err error)

Set the name label of the VDI. This can only happen when then its SR is currently attached.

func (VDIClass) SetOnBoot 

func (_class VDIClass) SetOnBoot(sessionID SessionRef, self VDIRef, value OnBoot) (_err error)

Set the value of the on_boot parameter. This value can only be changed when the VDI is not attached to a running VM.

func (VDIClass) SetOtherConfig 

func (_class VDIClass) SetOtherConfig(sessionID SessionRef, self VDIRef, value map[string]string) (_err error)

Set the other_config field of the given VDI.

func (VDIClass) SetPhysicalUtilisation 

func (_class VDIClass) SetPhysicalUtilisation(sessionID SessionRef, self VDIRef, value int) (_err error)

Sets the VDI's physical_utilisation field

func (VDIClass) SetReadOnly 

func (_class VDIClass) SetReadOnly(sessionID SessionRef, self VDIRef, value bool) (_err error)

Sets the VDI's read_only field

func (VDIClass) SetSharable 

func (_class VDIClass) SetSharable(sessionID SessionRef, self VDIRef, value bool) (_err error)

Sets the VDI's sharable field

func (VDIClass) SetSmConfig 

func (_class VDIClass) SetSmConfig(sessionID SessionRef, self VDIRef, value map[string]string) (_err error)

Set the sm_config field of the given VDI.

func (VDIClass) SetSnapshotOf 

func (_class VDIClass) SetSnapshotOf(sessionID SessionRef, self VDIRef, value VDIRef) (_err error)

Sets the VDI of which this VDI is a snapshot

func (VDIClass) SetSnapshotTime 

func (_class VDIClass) SetSnapshotTime(sessionID SessionRef, self VDIRef, value time.Time) (_err error)

Sets the snapshot time of this VDI.

func (VDIClass) SetTags 

func (_class VDIClass) SetTags(sessionID SessionRef, self VDIRef, value []string) (_err error)

Set the tags field of the given VDI.

func (VDIClass) SetVirtualSize 

func (_class VDIClass) SetVirtualSize(sessionID SessionRef, self VDIRef, value int) (_err error)

Sets the VDI's virtual_size field

func (VDIClass) SetXenstoreData 

func (_class VDIClass) SetXenstoreData(sessionID SessionRef, self VDIRef, value map[string]string) (_err error)

Set the xenstore_data field of the given VDI.

func (VDIClass) Snapshot 

func (_class VDIClass) Snapshot(sessionID SessionRef, vdi VDIRef, driverParams map[string]string) (_retval VDIRef, _err error)

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 takes the snapshot. NB the snapshot lives in the same Storage Repository as its parent.

func (VDIClass) Update 

func (_class VDIClass) Update(sessionID SessionRef, vdi VDIRef) (_err error)

Ask the storage backend to refresh the fields in the VDI object

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)

type VDIRecord 

type VDIRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []VdiOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]VdiOperations
	// storage repository in which the VDI resides
	SR SRRef
	// list of vbds that refer to this disk
	VBDs []VBDRef
	// list of crash dumps that refer to this disk
	CrashDumps []CrashdumpRef
	// size of disk as presented to the guest (in bytes). Note that, depending on storage backend type, requested size may not be respected exactly
	VirtualSize int
	// amount of physical space that the disk image is currently taking up on the storage repository (in bytes)
	PhysicalUtilisation int
	// type of the VDI
	Type VdiType
	// true if this disk may be shared
	Sharable bool
	// true if this disk may ONLY be mounted read-only
	ReadOnly bool
	// additional configuration
	OtherConfig map[string]string
	// true if this disk is locked at the storage level
	StorageLock bool
	// location information
	Location string
	//
	Managed bool
	// true if SR scan operation reported this VDI as not present on disk
	Missing bool
	// References the parent disk, if this VDI is part of a chain
	Parent VDIRef
	// data to be inserted into the xenstore tree (/local/domain/0/backend/vbd/<domid>/<device-id>/sm-data) after the VDI is attached. This is generally set by the SM backends on vdi_attach.
	XenstoreData map[string]string
	// SM dependent data
	SmConfig map[string]string
	// true if this is a snapshot.
	IsASnapshot bool
	// Ref pointing to the VDI this snapshot is of.
	SnapshotOf VDIRef
	// List pointing to all the VDIs snapshots.
	Snapshots []VDIRef
	// Date/time when this snapshot was created.
	SnapshotTime time.Time
	// user-specified tags for categorization purposes
	Tags []string
	// true if this VDI is to be cached in the local cache SR
	AllowCaching bool
	// The behaviour of this VDI on a VM boot
	OnBoot OnBoot
	// The pool whose metadata is contained in this VDI
	MetadataOfPool PoolRef
	// Whether this VDI contains the latest known accessible metadata for the pool
	MetadataLatest bool
}

type VDIRef 

type VDIRef string

type VGPUClass 

type VGPUClass struct {
	// contains filtered or unexported fields
}

A virtual GPU (vGPU)

func (VGPUClass) AddToOtherConfig 

func (_class VGPUClass) AddToOtherConfig(sessionID SessionRef, self VGPURef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VGPU.

func (VGPUClass) Create 

func (_class VGPUClass) Create(sessionID SessionRef, vm VMRef, gpuGroup GPUGroupRef, device string, otherConfig map[string]string, atype VGPUTypeRef) (_retval VGPURef, _err error)

func (VGPUClass) Destroy 

func (_class VGPUClass) Destroy(sessionID SessionRef, self VGPURef) (_err error)

func (VGPUClass) GetAll 

func (_class VGPUClass) GetAll(sessionID SessionRef) (_retval []VGPURef, _err error)

Return a list of all the VGPUs known to the system.

func (VGPUClass) GetAllRecords 

func (_class VGPUClass) GetAllRecords(sessionID SessionRef) (_retval map[VGPURef]VGPURecord, _err error)

Return a map of VGPU references to VGPU records for all VGPUs known to the system.

func (VGPUClass) GetByUUID 

func (_class VGPUClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VGPURef, _err error)

Get a reference to the VGPU instance with the specified UUID.

func (VGPUClass) GetCurrentlyAttached 

func (_class VGPUClass) GetCurrentlyAttached(sessionID SessionRef, self VGPURef) (_retval bool, _err error)

Get the currently_attached field of the given VGPU.

func (VGPUClass) GetDevice 

func (_class VGPUClass) GetDevice(sessionID SessionRef, self VGPURef) (_retval string, _err error)

Get the device field of the given VGPU.

func (VGPUClass) GetGPUGroup 

func (_class VGPUClass) GetGPUGroup(sessionID SessionRef, self VGPURef) (_retval GPUGroupRef, _err error)

Get the GPU_group field of the given VGPU.

func (VGPUClass) GetOtherConfig 

func (_class VGPUClass) GetOtherConfig(sessionID SessionRef, self VGPURef) (_retval map[string]string, _err error)

Get the other_config field of the given VGPU.

func (VGPUClass) GetRecord 

func (_class VGPUClass) GetRecord(sessionID SessionRef, self VGPURef) (_retval VGPURecord, _err error)

Get a record containing the current state of the given VGPU.

func (VGPUClass) GetResidentOn 

func (_class VGPUClass) GetResidentOn(sessionID SessionRef, self VGPURef) (_retval PGPURef, _err error)

Get the resident_on field of the given VGPU.

func (VGPUClass) GetType 

func (_class VGPUClass) GetType(sessionID SessionRef, self VGPURef) (_retval VGPUTypeRef, _err error)

Get the type field of the given VGPU.

func (VGPUClass) GetUUID 

func (_class VGPUClass) GetUUID(sessionID SessionRef, self VGPURef) (_retval string, _err error)

Get the uuid field of the given VGPU.

func (VGPUClass) GetVM 

func (_class VGPUClass) GetVM(sessionID SessionRef, self VGPURef) (_retval VMRef, _err error)

Get the VM field of the given VGPU.

func (VGPUClass) RemoveFromOtherConfig 

func (_class VGPUClass) RemoveFromOtherConfig(sessionID SessionRef, self VGPURef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given VGPU. If the key is not in that Map, then do nothing.

func (VGPUClass) SetOtherConfig 

func (_class VGPUClass) SetOtherConfig(sessionID SessionRef, self VGPURef, value map[string]string) (_err error)

Set the other_config field of the given VGPU.

type VGPURecord 

type VGPURecord struct {
	// Unique identifier/object reference
	UUID string
	// VM that owns the vGPU
	VM VMRef
	// GPU group used by the vGPU
	GPUGroup GPUGroupRef
	// Order in which the devices are plugged into the VM
	Device string
	// Reflects whether the virtual device is currently connected to a physical device
	CurrentlyAttached bool
	// Additional configuration
	OtherConfig map[string]string
	// Preset type for this VGPU
	Type VGPUTypeRef
	// The PGPU on which this VGPU is running
	ResidentOn PGPURef
}

type VGPURef 

type VGPURef string

type VGPUTypeClass 

type VGPUTypeClass struct {
	// contains filtered or unexported fields
}

A type of virtual GPU

func (VGPUTypeClass) GetAll 

func (_class VGPUTypeClass) GetAll(sessionID SessionRef) (_retval []VGPUTypeRef, _err error)

Return a list of all the VGPU_types known to the system.

func (VGPUTypeClass) GetAllRecords 

func (_class VGPUTypeClass) GetAllRecords(sessionID SessionRef) (_retval map[VGPUTypeRef]VGPUTypeRecord, _err error)

Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.

func (VGPUTypeClass) GetByUUID 

func (_class VGPUTypeClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VGPUTypeRef, _err error)

Get a reference to the VGPU_type instance with the specified UUID.

func (VGPUTypeClass) GetEnabledOnGPUGroups 

func (_class VGPUTypeClass) GetEnabledOnGPUGroups(sessionID SessionRef, self VGPUTypeRef) (_retval []GPUGroupRef, _err error)

Get the enabled_on_GPU_groups field of the given VGPU_type.

func (VGPUTypeClass) GetEnabledOnPGPUs 

func (_class VGPUTypeClass) GetEnabledOnPGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval []PGPURef, _err error)

Get the enabled_on_PGPUs field of the given VGPU_type.

func (VGPUTypeClass) GetExperimental 

func (_class VGPUTypeClass) GetExperimental(sessionID SessionRef, self VGPUTypeRef) (_retval bool, _err error)

Get the experimental field of the given VGPU_type.

func (VGPUTypeClass) GetFramebufferSize 

func (_class VGPUTypeClass) GetFramebufferSize(sessionID SessionRef, self VGPUTypeRef) (_retval int, _err error)

Get the framebuffer_size field of the given VGPU_type.

func (VGPUTypeClass) GetIdentifier 

func (_class VGPUTypeClass) GetIdentifier(sessionID SessionRef, self VGPUTypeRef) (_retval string, _err error)

Get the identifier field of the given VGPU_type.

func (VGPUTypeClass) GetImplementation 

func (_class VGPUTypeClass) GetImplementation(sessionID SessionRef, self VGPUTypeRef) (_retval VgpuTypeImplementation, _err error)

Get the implementation field of the given VGPU_type.

func (VGPUTypeClass) GetMaxHeads 

func (_class VGPUTypeClass) GetMaxHeads(sessionID SessionRef, self VGPUTypeRef) (_retval int, _err error)

Get the max_heads field of the given VGPU_type.

func (VGPUTypeClass) GetMaxResolutionX 

func (_class VGPUTypeClass) GetMaxResolutionX(sessionID SessionRef, self VGPUTypeRef) (_retval int, _err error)

Get the max_resolution_x field of the given VGPU_type.

func (VGPUTypeClass) GetMaxResolutionY 

func (_class VGPUTypeClass) GetMaxResolutionY(sessionID SessionRef, self VGPUTypeRef) (_retval int, _err error)

Get the max_resolution_y field of the given VGPU_type.

func (VGPUTypeClass) GetModelName 

func (_class VGPUTypeClass) GetModelName(sessionID SessionRef, self VGPUTypeRef) (_retval string, _err error)

Get the model_name field of the given VGPU_type.

func (VGPUTypeClass) GetRecord 

func (_class VGPUTypeClass) GetRecord(sessionID SessionRef, self VGPUTypeRef) (_retval VGPUTypeRecord, _err error)

Get a record containing the current state of the given VGPU_type.

func (VGPUTypeClass) GetSupportedOnGPUGroups 

func (_class VGPUTypeClass) GetSupportedOnGPUGroups(sessionID SessionRef, self VGPUTypeRef) (_retval []GPUGroupRef, _err error)

Get the supported_on_GPU_groups field of the given VGPU_type.

func (VGPUTypeClass) GetSupportedOnPGPUs 

func (_class VGPUTypeClass) GetSupportedOnPGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval []PGPURef, _err error)

Get the supported_on_PGPUs field of the given VGPU_type.

func (VGPUTypeClass) GetUUID 

func (_class VGPUTypeClass) GetUUID(sessionID SessionRef, self VGPUTypeRef) (_retval string, _err error)

Get the uuid field of the given VGPU_type.

func (VGPUTypeClass) GetVGPUs 

func (_class VGPUTypeClass) GetVGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval []VGPURef, _err error)

Get the VGPUs field of the given VGPU_type.

func (VGPUTypeClass) GetVendorName 

func (_class VGPUTypeClass) GetVendorName(sessionID SessionRef, self VGPUTypeRef) (_retval string, _err error)

Get the vendor_name field of the given VGPU_type.

type VGPUTypeRecord 

type VGPUTypeRecord struct {
	// Unique identifier/object reference
	UUID string
	// Name of VGPU vendor
	VendorName string
	// Model name associated with the VGPU type
	ModelName string
	// Framebuffer size of the VGPU type, in bytes
	FramebufferSize int
	// Maximum number of displays supported by the VGPU type
	MaxHeads int
	// Maximum resolution (width) supported by the VGPU type
	MaxResolutionX int
	// Maximum resolution (height) supported by the VGPU type
	MaxResolutionY int
	// List of PGPUs that support this VGPU type
	SupportedOnPGPUs []PGPURef
	// List of PGPUs that have this VGPU type enabled
	EnabledOnPGPUs []PGPURef
	// List of VGPUs of this type
	VGPUs []VGPURef
	// List of GPU groups in which at least one PGPU supports this VGPU type
	SupportedOnGPUGroups []GPUGroupRef
	// List of GPU groups in which at least one have this VGPU type enabled
	EnabledOnGPUGroups []GPUGroupRef
	// The internal implementation of this VGPU type
	Implementation VgpuTypeImplementation
	// Key used to identify VGPU types and avoid creating duplicates - this field is used internally and not intended for interpretation by API clients
	Identifier string
	// Indicates whether VGPUs of this type should be considered experimental
	Experimental bool
}

type VGPUTypeRef 

type VGPUTypeRef string

type VIFClass 

type VIFClass struct {
	// contains filtered or unexported fields
}

A virtual network interface

func (VIFClass) AddIpv4Allowed 

func (_class VIFClass) AddIpv4Allowed(sessionID SessionRef, self VIFRef, value string) (_err error)

Associates an IPv4 address with this VIF

func (VIFClass) AddIpv6Allowed 

func (_class VIFClass) AddIpv6Allowed(sessionID SessionRef, self VIFRef, value string) (_err error)

Associates an IPv6 address with this VIF

func (VIFClass) AddToOtherConfig 

func (_class VIFClass) AddToOtherConfig(sessionID SessionRef, self VIFRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VIF.

func (VIFClass) AddToQosAlgorithmParams 

func (_class VIFClass) AddToQosAlgorithmParams(sessionID SessionRef, self VIFRef, key string, value string) (_err error)

Add the given key-value pair to the qos/algorithm_params field of the given VIF.

func (VIFClass) Create 

func (_class VIFClass) Create(sessionID SessionRef, args VIFRecord) (_retval VIFRef, _err error)

Create a new VIF instance, and return its handle. The constructor args are: device*, network*, VM*, MAC*, MTU*, other_config*, qos_algorithm_type*, qos_algorithm_params*, locking_mode, ipv4_allowed, ipv6_allowed (* = non-optional).

func (VIFClass) Destroy 

func (_class VIFClass) Destroy(sessionID SessionRef, self VIFRef) (_err error)

Destroy the specified VIF instance.

func (VIFClass) GetAll 

func (_class VIFClass) GetAll(sessionID SessionRef) (_retval []VIFRef, _err error)

Return a list of all the VIFs known to the system.

func (VIFClass) GetAllRecords 

func (_class VIFClass) GetAllRecords(sessionID SessionRef) (_retval map[VIFRef]VIFRecord, _err error)

Return a map of VIF references to VIF records for all VIFs known to the system.

func (VIFClass) GetAllowedOperations 

func (_class VIFClass) GetAllowedOperations(sessionID SessionRef, self VIFRef) (_retval []VifOperations, _err error)

Get the allowed_operations field of the given VIF.

func (VIFClass) GetByUUID 

func (_class VIFClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VIFRef, _err error)

Get a reference to the VIF instance with the specified UUID.

func (VIFClass) GetCurrentOperations 

func (_class VIFClass) GetCurrentOperations(sessionID SessionRef, self VIFRef) (_retval map[string]VifOperations, _err error)

Get the current_operations field of the given VIF.

func (VIFClass) GetCurrentlyAttached 

func (_class VIFClass) GetCurrentlyAttached(sessionID SessionRef, self VIFRef) (_retval bool, _err error)

Get the currently_attached field of the given VIF.

func (VIFClass) GetDevice 

func (_class VIFClass) GetDevice(sessionID SessionRef, self VIFRef) (_retval string, _err error)

Get the device field of the given VIF.

func (VIFClass) GetIpv4Allowed 

func (_class VIFClass) GetIpv4Allowed(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

Get the ipv4_allowed field of the given VIF.

func (VIFClass) GetIpv6Allowed 

func (_class VIFClass) GetIpv6Allowed(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

Get the ipv6_allowed field of the given VIF.

func (VIFClass) GetLockingMode 

func (_class VIFClass) GetLockingMode(sessionID SessionRef, self VIFRef) (_retval VifLockingMode, _err error)

Get the locking_mode field of the given VIF.

func (VIFClass) GetMAC 

func (_class VIFClass) GetMAC(sessionID SessionRef, self VIFRef) (_retval string, _err error)

Get the MAC field of the given VIF.

func (VIFClass) GetMACAutogenerated 

func (_class VIFClass) GetMACAutogenerated(sessionID SessionRef, self VIFRef) (_retval bool, _err error)

Get the MAC_autogenerated field of the given VIF.

func (VIFClass) GetMTU 

func (_class VIFClass) GetMTU(sessionID SessionRef, self VIFRef) (_retval int, _err error)

Get the MTU field of the given VIF.

func (VIFClass) GetMetrics 

func (_class VIFClass) GetMetrics(sessionID SessionRef, self VIFRef) (_retval VIFMetricsRef, _err error)

Get the metrics field of the given VIF.

func (VIFClass) GetNetwork 

func (_class VIFClass) GetNetwork(sessionID SessionRef, self VIFRef) (_retval NetworkRef, _err error)

Get the network field of the given VIF.

func (VIFClass) GetOtherConfig 

func (_class VIFClass) GetOtherConfig(sessionID SessionRef, self VIFRef) (_retval map[string]string, _err error)

Get the other_config field of the given VIF.

func (VIFClass) GetQosAlgorithmParams 

func (_class VIFClass) GetQosAlgorithmParams(sessionID SessionRef, self VIFRef) (_retval map[string]string, _err error)

Get the qos/algorithm_params field of the given VIF.

func (VIFClass) GetQosAlgorithmType 

func (_class VIFClass) GetQosAlgorithmType(sessionID SessionRef, self VIFRef) (_retval string, _err error)

Get the qos/algorithm_type field of the given VIF.

func (VIFClass) GetQosSupportedAlgorithms 

func (_class VIFClass) GetQosSupportedAlgorithms(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

Get the qos/supported_algorithms field of the given VIF.

func (VIFClass) GetRecord 

func (_class VIFClass) GetRecord(sessionID SessionRef, self VIFRef) (_retval VIFRecord, _err error)

Get a record containing the current state of the given VIF.

func (VIFClass) GetRuntimeProperties 

func (_class VIFClass) GetRuntimeProperties(sessionID SessionRef, self VIFRef) (_retval map[string]string, _err error)

Get the runtime_properties field of the given VIF.

func (VIFClass) GetStatusCode 

func (_class VIFClass) GetStatusCode(sessionID SessionRef, self VIFRef) (_retval int, _err error)

Get the status_code field of the given VIF.

func (VIFClass) GetStatusDetail 

func (_class VIFClass) GetStatusDetail(sessionID SessionRef, self VIFRef) (_retval string, _err error)

Get the status_detail field of the given VIF.

func (VIFClass) GetUUID 

func (_class VIFClass) GetUUID(sessionID SessionRef, self VIFRef) (_retval string, _err error)

Get the uuid field of the given VIF.

func (VIFClass) GetVM 

func (_class VIFClass) GetVM(sessionID SessionRef, self VIFRef) (_retval VMRef, _err error)

Get the VM field of the given VIF.

func (VIFClass) Plug 

func (_class VIFClass) Plug(sessionID SessionRef, self VIFRef) (_err error)

Hotplug the specified VIF, dynamically attaching it to the running VM

func (VIFClass) RemoveFromOtherConfig 

func (_class VIFClass) RemoveFromOtherConfig(sessionID SessionRef, self VIFRef, key string) (_err error)

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.

func (VIFClass) RemoveFromQosAlgorithmParams 

func (_class VIFClass) RemoveFromQosAlgorithmParams(sessionID SessionRef, self VIFRef, key string) (_err error)

Remove the given key and its corresponding value from the qos/algorithm_params field of the given VIF. If the key is not in that Map, then do nothing.

func (VIFClass) RemoveIpv4Allowed 

func (_class VIFClass) RemoveIpv4Allowed(sessionID SessionRef, self VIFRef, value string) (_err error)

Removes an IPv4 address from this VIF

func (VIFClass) RemoveIpv6Allowed 

func (_class VIFClass) RemoveIpv6Allowed(sessionID SessionRef, self VIFRef, value string) (_err error)

Removes an IPv6 address from this VIF

func (VIFClass) SetIpv4Allowed 

func (_class VIFClass) SetIpv4Allowed(sessionID SessionRef, self VIFRef, value []string) (_err error)

Set the IPv4 addresses to which traffic on this VIF can be restricted

func (VIFClass) SetIpv6Allowed 

func (_class VIFClass) SetIpv6Allowed(sessionID SessionRef, self VIFRef, value []string) (_err error)

Set the IPv6 addresses to which traffic on this VIF can be restricted

func (VIFClass) SetLockingMode 

func (_class VIFClass) SetLockingMode(sessionID SessionRef, self VIFRef, value VifLockingMode) (_err error)

Set the locking mode for this VIF

func (VIFClass) SetOtherConfig 

func (_class VIFClass) SetOtherConfig(sessionID SessionRef, self VIFRef, value map[string]string) (_err error)

Set the other_config field of the given VIF.

func (VIFClass) SetQosAlgorithmParams 

func (_class VIFClass) SetQosAlgorithmParams(sessionID SessionRef, self VIFRef, value map[string]string) (_err error)

Set the qos/algorithm_params field of the given VIF.

func (VIFClass) SetQosAlgorithmType 

func (_class VIFClass) SetQosAlgorithmType(sessionID SessionRef, self VIFRef, value string) (_err error)

Set the qos/algorithm_type field of the given VIF.

func (VIFClass) Unplug 

func (_class VIFClass) Unplug(sessionID SessionRef, self VIFRef) (_err error)

Hot-unplug the specified VIF, dynamically unattaching it from the running VM

func (VIFClass) UnplugForce 

func (_class VIFClass) UnplugForce(sessionID SessionRef, self VIFRef) (_err error)

Forcibly unplug the specified VIF

type VIFMetricsClass 

type VIFMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a virtual network device

func (VIFMetricsClass) AddToOtherConfig 

func (_class VIFMetricsClass) AddToOtherConfig(sessionID SessionRef, self VIFMetricsRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VIF_metrics.

func (VIFMetricsClass) GetAll 

func (_class VIFMetricsClass) GetAll(sessionID SessionRef) (_retval []VIFMetricsRef, _err error)

Return a list of all the VIF_metrics instances known to the system.

func (VIFMetricsClass) GetAllRecords 

func (_class VIFMetricsClass) GetAllRecords(sessionID SessionRef) (_retval map[VIFMetricsRef]VIFMetricsRecord, _err error)

Return a map of VIF_metrics references to VIF_metrics records for all VIF_metrics instances known to the system.

func (VIFMetricsClass) GetByUUID 

func (_class VIFMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VIFMetricsRef, _err error)

Get a reference to the VIF_metrics instance with the specified UUID.

func (VIFMetricsClass) GetIoReadKbs 

func (_class VIFMetricsClass) GetIoReadKbs(sessionID SessionRef, self VIFMetricsRef) (_retval float64, _err error)

Get the io/read_kbs field of the given VIF_metrics.

func (VIFMetricsClass) GetIoWriteKbs 

func (_class VIFMetricsClass) GetIoWriteKbs(sessionID SessionRef, self VIFMetricsRef) (_retval float64, _err error)

Get the io/write_kbs field of the given VIF_metrics.

func (VIFMetricsClass) GetLastUpdated 

func (_class VIFMetricsClass) GetLastUpdated(sessionID SessionRef, self VIFMetricsRef) (_retval time.Time, _err error)

Get the last_updated field of the given VIF_metrics.

func (VIFMetricsClass) GetOtherConfig 

func (_class VIFMetricsClass) GetOtherConfig(sessionID SessionRef, self VIFMetricsRef) (_retval map[string]string, _err error)

Get the other_config field of the given VIF_metrics.

func (VIFMetricsClass) GetRecord 

func (_class VIFMetricsClass) GetRecord(sessionID SessionRef, self VIFMetricsRef) (_retval VIFMetricsRecord, _err error)

Get a record containing the current state of the given VIF_metrics.

func (VIFMetricsClass) GetUUID 

func (_class VIFMetricsClass) GetUUID(sessionID SessionRef, self VIFMetricsRef) (_retval string, _err error)

Get the uuid field of the given VIF_metrics.

func (VIFMetricsClass) RemoveFromOtherConfig 

func (_class VIFMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VIFMetricsRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given VIF_metrics. If the key is not in that Map, then do nothing.

func (VIFMetricsClass) SetOtherConfig 

func (_class VIFMetricsClass) SetOtherConfig(sessionID SessionRef, self VIFMetricsRef, value map[string]string) (_err error)

Set the other_config field of the given VIF_metrics.

type VIFMetricsRecord 

type VIFMetricsRecord struct {
	// Unique identifier/object reference
	UUID string
	// Read bandwidth (KiB/s)
	IoReadKbs float64
	// Write bandwidth (KiB/s)
	IoWriteKbs float64
	// Time at which this information was last updated
	LastUpdated time.Time
	// additional configuration
	OtherConfig map[string]string
}

type VIFMetricsRef 

type VIFMetricsRef string

type VIFRecord 

type VIFRecord struct {
	// Unique identifier/object reference
	UUID string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []VifOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]VifOperations
	// order in which VIF backends are created by xapi
	Device string
	// virtual network to which this vif is connected
	Network NetworkRef
	// virtual machine to which this vif is connected
	VM VMRef
	// ethernet MAC address of virtual interface, as exposed to guest
	MAC string
	// MTU in octets
	MTU int
	// additional configuration
	OtherConfig map[string]string
	// is the device currently attached (erased on reboot)
	CurrentlyAttached bool
	// error/success code associated with last attach-operation (erased on reboot)
	StatusCode int
	// error/success information associated with last attach-operation status (erased on reboot)
	StatusDetail string
	// Device runtime properties
	RuntimeProperties map[string]string
	// QoS algorithm to use
	QosAlgorithmType string
	// parameters for chosen QoS algorithm
	QosAlgorithmParams map[string]string
	// supported QoS algorithms for this VIF
	QosSupportedAlgorithms []string
	// metrics associated with this VIF
	Metrics VIFMetricsRef
	// true if the MAC was autogenerated; false indicates it was set manually
	MACAutogenerated bool
	// current locking mode of the VIF
	LockingMode VifLockingMode
	// A list of IPv4 addresses which can be used to filter traffic passing through this VIF
	Ipv4Allowed []string
	// A list of IPv6 addresses which can be used to filter traffic passing through this VIF
	Ipv6Allowed []string
}

type VIFRef 

type VIFRef string

type VLANClass 

type VLANClass struct {
	// contains filtered or unexported fields
}

A VLAN mux/demux

func (VLANClass) AddToOtherConfig 

func (_class VLANClass) AddToOtherConfig(sessionID SessionRef, self VLANRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VLAN.

func (VLANClass) Create 

func (_class VLANClass) Create(sessionID SessionRef, taggedPIF PIFRef, tag int, network NetworkRef) (_retval VLANRef, _err error)

Create a VLAN mux/demuxer

func (VLANClass) Destroy 

func (_class VLANClass) Destroy(sessionID SessionRef, self VLANRef) (_err error)

Destroy a VLAN mux/demuxer

func (VLANClass) GetAll 

func (_class VLANClass) GetAll(sessionID SessionRef) (_retval []VLANRef, _err error)

Return a list of all the VLANs known to the system.

func (VLANClass) GetAllRecords 

func (_class VLANClass) GetAllRecords(sessionID SessionRef) (_retval map[VLANRef]VLANRecord, _err error)

Return a map of VLAN references to VLAN records for all VLANs known to the system.

func (VLANClass) GetByUUID 

func (_class VLANClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VLANRef, _err error)

Get a reference to the VLAN instance with the specified UUID.

func (VLANClass) GetOtherConfig 

func (_class VLANClass) GetOtherConfig(sessionID SessionRef, self VLANRef) (_retval map[string]string, _err error)

Get the other_config field of the given VLAN.

func (VLANClass) GetRecord 

func (_class VLANClass) GetRecord(sessionID SessionRef, self VLANRef) (_retval VLANRecord, _err error)

Get a record containing the current state of the given VLAN.

func (VLANClass) GetTag 

func (_class VLANClass) GetTag(sessionID SessionRef, self VLANRef) (_retval int, _err error)

Get the tag field of the given VLAN.

func (VLANClass) GetTaggedPIF 

func (_class VLANClass) GetTaggedPIF(sessionID SessionRef, self VLANRef) (_retval PIFRef, _err error)

Get the tagged_PIF field of the given VLAN.

func (VLANClass) GetUUID 

func (_class VLANClass) GetUUID(sessionID SessionRef, self VLANRef) (_retval string, _err error)

Get the uuid field of the given VLAN.

func (VLANClass) GetUntaggedPIF 

func (_class VLANClass) GetUntaggedPIF(sessionID SessionRef, self VLANRef) (_retval PIFRef, _err error)

Get the untagged_PIF field of the given VLAN.

func (VLANClass) RemoveFromOtherConfig 

func (_class VLANClass) RemoveFromOtherConfig(sessionID SessionRef, self VLANRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given VLAN. If the key is not in that Map, then do nothing.

func (VLANClass) SetOtherConfig 

func (_class VLANClass) SetOtherConfig(sessionID SessionRef, self VLANRef, value map[string]string) (_err error)

Set the other_config field of the given VLAN.

type VLANRecord 

type VLANRecord struct {
	// Unique identifier/object reference
	UUID string
	// interface on which traffic is tagged
	TaggedPIF PIFRef
	// interface on which traffic is untagged
	UntaggedPIF PIFRef
	// VLAN tag in use
	Tag int
	// additional configuration
	OtherConfig map[string]string
}

type VLANRef 

type VLANRef string

type VMApplianceClass 

type VMApplianceClass struct {
	// contains filtered or unexported fields
}

VM appliance

func (VMApplianceClass) AssertCanBeRecovered 

func (_class VMApplianceClass) AssertCanBeRecovered(sessionID SessionRef, self VMApplianceRef, sessionTo SessionRef) (_err error)

Assert whether all SRs required to recover this VM appliance are available.

Errors: 

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 attached to a VDI in the SR.

func (VMApplianceClass) CleanShutdown 

func (_class VMApplianceClass) CleanShutdown(sessionID SessionRef, self VMApplianceRef) (_err error)

Perform a clean shutdown of all the VMs in the appliance

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

func (VMApplianceClass) Create 

func (_class VMApplianceClass) Create(sessionID SessionRef, args VMApplianceRecord) (_retval VMApplianceRef, _err error)

Create a new VM_appliance instance, and return its handle. The constructor args are: name_label, name_description (* = non-optional).

func (VMApplianceClass) Destroy 

func (_class VMApplianceClass) Destroy(sessionID SessionRef, self VMApplianceRef) (_err error)

Destroy the specified VM_appliance instance.

func (VMApplianceClass) GetAll 

func (_class VMApplianceClass) GetAll(sessionID SessionRef) (_retval []VMApplianceRef, _err error)

Return a list of all the VM_appliances known to the system.

func (VMApplianceClass) GetAllRecords 

func (_class VMApplianceClass) GetAllRecords(sessionID SessionRef) (_retval map[VMApplianceRef]VMApplianceRecord, _err error)

Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system.

func (VMApplianceClass) GetAllowedOperations 

func (_class VMApplianceClass) GetAllowedOperations(sessionID SessionRef, self VMApplianceRef) (_retval []VMApplianceOperation, _err error)

Get the allowed_operations field of the given VM_appliance.

func (VMApplianceClass) GetByNameLabel 

func (_class VMApplianceClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VMApplianceRef, _err error)

Get all the VM_appliance instances with the given label.

func (VMApplianceClass) GetByUUID 

func (_class VMApplianceClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMApplianceRef, _err error)

Get a reference to the VM_appliance instance with the specified UUID.

func (VMApplianceClass) GetCurrentOperations 

func (_class VMApplianceClass) GetCurrentOperations(sessionID SessionRef, self VMApplianceRef) (_retval map[string]VMApplianceOperation, _err error)

Get the current_operations field of the given VM_appliance.

func (VMApplianceClass) GetNameDescription 

func (_class VMApplianceClass) GetNameDescription(sessionID SessionRef, self VMApplianceRef) (_retval string, _err error)

Get the name/description field of the given VM_appliance.

func (VMApplianceClass) GetNameLabel 

func (_class VMApplianceClass) GetNameLabel(sessionID SessionRef, self VMApplianceRef) (_retval string, _err error)

Get the name/label field of the given VM_appliance.

func (VMApplianceClass) GetRecord 

func (_class VMApplianceClass) GetRecord(sessionID SessionRef, self VMApplianceRef) (_retval VMApplianceRecord, _err error)

Get a record containing the current state of the given VM_appliance.

func (VMApplianceClass) GetSRsRequiredForRecovery 

func (_class VMApplianceClass) GetSRsRequiredForRecovery(sessionID SessionRef, self VMApplianceRef, sessionTo SessionRef) (_retval []SRRef, _err error)

Get the list of SRs required by the VM appliance to recover.

func (VMApplianceClass) GetUUID 

func (_class VMApplianceClass) GetUUID(sessionID SessionRef, self VMApplianceRef) (_retval string, _err error)

Get the uuid field of the given VM_appliance.

func (VMApplianceClass) GetVMs 

func (_class VMApplianceClass) GetVMs(sessionID SessionRef, self VMApplianceRef) (_retval []VMRef, _err error)

Get the VMs field of the given VM_appliance.

func (VMApplianceClass) HardShutdown 

func (_class VMApplianceClass) HardShutdown(sessionID SessionRef, self VMApplianceRef) (_err error)

Perform a hard shutdown of all the VMs in the appliance

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

func (VMApplianceClass) Recover 

func (_class VMApplianceClass) Recover(sessionID SessionRef, self VMApplianceRef, sessionTo SessionRef, force bool) (_err error)

Recover the VM appliance

Errors: 

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 attached to a VDI in the SR.

func (VMApplianceClass) SetNameDescription 

func (_class VMApplianceClass) SetNameDescription(sessionID SessionRef, self VMApplianceRef, value string) (_err error)

Set the name/description field of the given VM_appliance.

func (VMApplianceClass) SetNameLabel 

func (_class VMApplianceClass) SetNameLabel(sessionID SessionRef, self VMApplianceRef, value string) (_err error)

Set the name/label field of the given VM_appliance.

func (VMApplianceClass) Shutdown 

func (_class VMApplianceClass) Shutdown(sessionID SessionRef, self VMApplianceRef) (_err error)

For each VM in the appliance, try to shut it down cleanly. If this fails, perform a hard shutdown of the VM.

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

func (VMApplianceClass) Start 

func (_class VMApplianceClass) Start(sessionID SessionRef, self VMApplianceRef, paused bool) (_err error)

Start all VMs in the appliance

Errors: 

OPERATION_PARTIALLY_FAILED - Some VMs belonging to the appliance threw an exception while carrying out the specified operation

type VMApplianceOperation 

type VMApplianceOperation string
const (
	// Start
	VMApplianceOperationStart VMApplianceOperation = "start"
	// Clean shutdown
	VMApplianceOperationCleanShutdown VMApplianceOperation = "clean_shutdown"
	// Hard shutdown
	VMApplianceOperationHardShutdown VMApplianceOperation = "hard_shutdown"
	// Shutdown
	VMApplianceOperationShutdown VMApplianceOperation = "shutdown"
)

type VMApplianceRecord 

type VMApplianceRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []VMApplianceOperation
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]VMApplianceOperation
	// all VMs in this appliance
	VMs []VMRef
}

type VMApplianceRef 

type VMApplianceRef string

type VMClass 

type VMClass struct {
	// contains filtered or unexported fields
}

A virtual machine (or 'guest').

func (VMClass) AddTags 

func (_class VMClass) AddTags(sessionID SessionRef, self VMRef, value string) (_err error)

Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing.

func (VMClass) AddToBlockedOperations 

func (_class VMClass) AddToBlockedOperations(sessionID SessionRef, self VMRef, key VMOperations, value string) (_err error)

Add the given key-value pair to the blocked_operations field of the given VM.

func (VMClass) AddToHVMBootParams 

func (_class VMClass) AddToHVMBootParams(sessionID SessionRef, self VMRef, key string, value string) (_err error)

Add the given key-value pair to the HVM/boot_params field of the given VM.

func (VMClass) AddToOtherConfig 

func (_class VMClass) AddToOtherConfig(sessionID SessionRef, self VMRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VM.

func (VMClass) AddToPlatform 

func (_class VMClass) AddToPlatform(sessionID SessionRef, self VMRef, key string, value string) (_err error)

Add the given key-value pair to the platform field of the given VM.

func (VMClass) AddToVCPUsParams 

func (_class VMClass) AddToVCPUsParams(sessionID SessionRef, self VMRef, key string, value string) (_err error)

Add the given key-value pair to the VCPUs/params field of the given VM.

func (VMClass) AddToVCPUsParamsLive 

func (_class VMClass) AddToVCPUsParamsLive(sessionID SessionRef, self VMRef, key string, value string) (_err error)

Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM

func (VMClass) AddToXenstoreData 

func (_class VMClass) AddToXenstoreData(sessionID SessionRef, self VMRef, key string, value string) (_err error)

Add the given key-value pair to the xenstore_data field of the given VM.

func (VMClass) AssertAgile 

func (_class VMClass) AssertAgile(sessionID SessionRef, self VMRef) (_err error)

Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host

func (VMClass) AssertCanBeRecovered 

func (_class VMClass) AssertCanBeRecovered(sessionID SessionRef, self VMRef, sessionTo SessionRef) (_err error)

Assert whether all SRs required to recover this VM are available.

Errors: 

VM_IS_PART_OF_AN_APPLIANCE - This operation is not allowed as the VM is part of an appliance.
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 attached to a VDI in the SR.

func (VMClass) AssertCanBootHere 

func (_class VMClass) AssertCanBootHere(sessionID SessionRef, self VMRef, host HostRef) (_err error)

Returns an error if the VM could not boot on this host for some reason

Errors: 

HOST_NOT_ENOUGH_FREE_MEMORY - Not enough host memory is available to perform this operation
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 attached to a VDI in the SR.
VM_HOST_INCOMPATIBLE_VERSION - This VM operation cannot be performed on an older-versioned host during an upgrade.
VM_HOST_INCOMPATIBLE_VIRTUAL_HARDWARE_PLATFORM_VERSION - You attempted to run a VM on a host that cannot provide the VM's required Virtual Hardware Platform version.

func (VMClass) AssertCanMigrate 

func (_class VMClass) AssertCanMigrate(sessionID SessionRef, vm VMRef, dest map[string]string, live bool, vdiMap map[VDIRef]SRRef, vifMap map[VIFRef]NetworkRef, options map[string]string) (_err error)

Assert whether a VM can be migrated to the specified destination.

func (VMClass) AssertCanSetAutoUpdateDrivers 

func (_class VMClass) AssertCanSetAutoUpdateDrivers(sessionID SessionRef, self VMRef, value bool) (_err error)

Check if PV auto update can be set on Windows vm

func (VMClass) AssertOperationValid 

func (_class VMClass) AssertOperationValid(sessionID SessionRef, self VMRef, op VMOperations) (_err error)

Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason

func (VMClass) CallPlugin 

func (_class VMClass) CallPlugin(sessionID SessionRef, vm VMRef, plugin string, fn string, args map[string]string) (_retval string, _err error)

Call a XenAPI plugin on this vm

func (VMClass) Checkpoint 

func (_class VMClass) Checkpoint(sessionID SessionRef, vm VMRef, newName string) (_retval VMRef, _err error)

Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_CHECKPOINT_SUSPEND_FAILED - An error occured while saving the memory image of the specified virtual machine
VM_CHECKPOINT_RESUME_FAILED - An error occured while restoring the memory image of the specified virtual machine

func (VMClass) CleanReboot 

func (_class VMClass) CleanReboot(sessionID SessionRef, vm VMRef) (_err error)

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.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) CleanShutdown 

func (_class VMClass) CleanShutdown(sessionID SessionRef, vm VMRef) (_err error)

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.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) Clone 

func (_class VMClass) Clone(sessionID SessionRef, vm VMRef, newName string) (_retval VMRef, _err error)

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.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (VMClass) ComputeMemoryOverhead 

func (_class VMClass) ComputeMemoryOverhead(sessionID SessionRef, vm VMRef) (_retval int, _err error)

Computes the virtualization memory overhead of a VM.

func (VMClass) Copy 

func (_class VMClass) Copy(sessionID SessionRef, vm VMRef, newName string, sr SRRef) (_retval VMRef, _err error)

Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository 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 the VM is in the Halted State.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (VMClass) CopyBiosStrings 

func (_class VMClass) CopyBiosStrings(sessionID SessionRef, vm VMRef, host HostRef) (_err error)

Copy the BIOS strings from the given host to this VM

func (VMClass) Create 

func (_class VMClass) Create(sessionID SessionRef, args VMRecord) (_retval VMRef, _err error)

Create a new VM instance, and return its handle. The constructor args are: name_label, name_description, user_version*, is_a_template*, affinity*, memory_target, memory_static_max*, memory_dynamic_max*, memory_dynamic_min*, memory_static_min*, VCPUs_params*, VCPUs_max*, VCPUs_at_startup*, actions_after_shutdown*, actions_after_reboot*, actions_after_crash*, PV_bootloader*, PV_kernel*, PV_ramdisk*, PV_args*, PV_bootloader_args*, PV_legacy_args*, HVM_boot_policy*, HVM_boot_params*, HVM_shadow_multiplier, platform*, PCI_bus*, other_config*, recommendations*, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version (* = non-optional).

func (VMClass) CreateNewBlob 

func (_class VMClass) CreateNewBlob(sessionID SessionRef, vm VMRef, name string, mimeType string, public bool) (_retval BlobRef, _err error)

Create a placeholder for a named binary blob of data that is associated with this VM

func (VMClass) Destroy 

func (_class VMClass) Destroy(sessionID SessionRef, self VMRef) (_err error)

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

func (VMClass) ForgetDataSourceArchives 

func (_class VMClass) ForgetDataSourceArchives(sessionID SessionRef, self VMRef, dataSource string) (_err error)

Forget the recorded statistics related to the specified data source

func (VMClass) GetActionsAfterCrash 

func (_class VMClass) GetActionsAfterCrash(sessionID SessionRef, self VMRef) (_retval OnCrashBehaviour, _err error)

Get the actions/after_crash field of the given VM.

func (VMClass) GetActionsAfterReboot 

func (_class VMClass) GetActionsAfterReboot(sessionID SessionRef, self VMRef) (_retval OnNormalExit, _err error)

Get the actions/after_reboot field of the given VM.

func (VMClass) GetActionsAfterShutdown 

func (_class VMClass) GetActionsAfterShutdown(sessionID SessionRef, self VMRef) (_retval OnNormalExit, _err error)

Get the actions/after_shutdown field of the given VM.

func (VMClass) GetAffinity 

func (_class VMClass) GetAffinity(sessionID SessionRef, self VMRef) (_retval HostRef, _err error)

Get the affinity field of the given VM.

func (VMClass) GetAll 

func (_class VMClass) GetAll(sessionID SessionRef) (_retval []VMRef, _err error)

Return a list of all the VMs known to the system.

func (VMClass) GetAllRecords 

func (_class VMClass) GetAllRecords(sessionID SessionRef) (_retval map[VMRef]VMRecord, _err error)

Return a map of VM references to VM records for all VMs known to the system.

func (VMClass) GetAllowedOperations 

func (_class VMClass) GetAllowedOperations(sessionID SessionRef, self VMRef) (_retval []VMOperations, _err error)

Get the allowed_operations field of the given VM.

func (VMClass) GetAllowedVBDDevices 

func (_class VMClass) GetAllowedVBDDevices(sessionID SessionRef, vm VMRef) (_retval []string, _err error)

Returns a list of the allowed values that a VBD device field can take

func (VMClass) GetAllowedVIFDevices 

func (_class VMClass) GetAllowedVIFDevices(sessionID SessionRef, vm VMRef) (_retval []string, _err error)

Returns a list of the allowed values that a VIF device field can take

func (VMClass) GetAppliance 

func (_class VMClass) GetAppliance(sessionID SessionRef, self VMRef) (_retval VMApplianceRef, _err error)

Get the appliance field of the given VM.

func (VMClass) GetAttachedPCIs 

func (_class VMClass) GetAttachedPCIs(sessionID SessionRef, self VMRef) (_retval []PCIRef, _err error)

Get the attached_PCIs field of the given VM.

func (VMClass) GetAutoUpdateDrivers 

func (_class VMClass) GetAutoUpdateDrivers(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Get the auto_update_drivers field of the given VM.

func (VMClass) GetBiosStrings 

func (_class VMClass) GetBiosStrings(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the bios_strings field of the given VM.

func (VMClass) GetBlobs 

func (_class VMClass) GetBlobs(sessionID SessionRef, self VMRef) (_retval map[string]BlobRef, _err error)

Get the blobs field of the given VM.

func (VMClass) GetBlockedOperations 

func (_class VMClass) GetBlockedOperations(sessionID SessionRef, self VMRef) (_retval map[VMOperations]string, _err error)

Get the blocked_operations field of the given VM.

func (VMClass) GetBootRecord 

func (_class VMClass) GetBootRecord(sessionID SessionRef, self VMRef) (_retval VMRecord, _err error)

Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug

func (VMClass) GetByNameLabel 

func (_class VMClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VMRef, _err error)

Get all the VM instances with the given label.

func (VMClass) GetByUUID 

func (_class VMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMRef, _err error)

Get a reference to the VM instance with the specified UUID.

func (VMClass) GetChildren 

func (_class VMClass) GetChildren(sessionID SessionRef, self VMRef) (_retval []VMRef, _err error)

Get the children field of the given VM.

func (VMClass) GetConsoles 

func (_class VMClass) GetConsoles(sessionID SessionRef, self VMRef) (_retval []ConsoleRef, _err error)

Get the consoles field of the given VM.

func (VMClass) GetCooperative 

func (_class VMClass) GetCooperative(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done

func (VMClass) GetCrashDumps 

func (_class VMClass) GetCrashDumps(sessionID SessionRef, self VMRef) (_retval []CrashdumpRef, _err error)

Get the crash_dumps field of the given VM.

func (VMClass) GetCurrentOperations 

func (_class VMClass) GetCurrentOperations(sessionID SessionRef, self VMRef) (_retval map[string]VMOperations, _err error)

Get the current_operations field of the given VM.

func (VMClass) GetDataSources 

func (_class VMClass) GetDataSources(sessionID SessionRef, self VMRef) (_retval []DataSourceRecord, _err error)

func (VMClass) GetDomarch 

func (_class VMClass) GetDomarch(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the domarch field of the given VM.

func (VMClass) GetDomid 

func (_class VMClass) GetDomid(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the domid field of the given VM.

func (VMClass) GetGenerationID 

func (_class VMClass) GetGenerationID(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the generation_id field of the given VM.

func (VMClass) GetGuestMetrics 

func (_class VMClass) GetGuestMetrics(sessionID SessionRef, self VMRef) (_retval VMGuestMetricsRef, _err error)

Get the guest_metrics field of the given VM.

func (VMClass) GetHVMBootParams 

func (_class VMClass) GetHVMBootParams(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the HVM/boot_params field of the given VM.

func (VMClass) GetHVMBootPolicy 

func (_class VMClass) GetHVMBootPolicy(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the HVM/boot_policy field of the given VM.

func (VMClass) GetHVMShadowMultiplier 

func (_class VMClass) GetHVMShadowMultiplier(sessionID SessionRef, self VMRef) (_retval float64, _err error)

Get the HVM/shadow_multiplier field of the given VM.

func (VMClass) GetHaAlwaysRun 

func (_class VMClass) GetHaAlwaysRun(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Get the ha_always_run field of the given VM.

func (VMClass) GetHaRestartPriority 

func (_class VMClass) GetHaRestartPriority(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the ha_restart_priority field of the given VM.

func (VMClass) GetHardwarePlatformVersion 

func (_class VMClass) GetHardwarePlatformVersion(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the hardware_platform_version field of the given VM.

func (VMClass) GetIsASnapshot 

func (_class VMClass) GetIsASnapshot(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Get the is_a_snapshot field of the given VM.

func (VMClass) GetIsATemplate 

func (_class VMClass) GetIsATemplate(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Get the is_a_template field of the given VM.

func (VMClass) GetIsControlDomain 

func (_class VMClass) GetIsControlDomain(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Get the is_control_domain field of the given VM.

func (VMClass) GetIsSnapshotFromVmpp 

func (_class VMClass) GetIsSnapshotFromVmpp(sessionID SessionRef, self VMRef) (_retval bool, _err error)

Get the is_snapshot_from_vmpp field of the given VM.

func (VMClass) GetLastBootCPUFlags 

func (_class VMClass) GetLastBootCPUFlags(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the last_boot_CPU_flags field of the given VM.

func (VMClass) GetLastBootedRecord 

func (_class VMClass) GetLastBootedRecord(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the last_booted_record field of the given VM.

func (VMClass) GetMemoryDynamicMax 

func (_class VMClass) GetMemoryDynamicMax(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the memory/dynamic_max field of the given VM.

func (VMClass) GetMemoryDynamicMin 

func (_class VMClass) GetMemoryDynamicMin(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the memory/dynamic_min field of the given VM.

func (VMClass) GetMemoryOverhead 

func (_class VMClass) GetMemoryOverhead(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the memory/overhead field of the given VM.

func (VMClass) GetMemoryStaticMax 

func (_class VMClass) GetMemoryStaticMax(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the memory/static_max field of the given VM.

func (VMClass) GetMemoryStaticMin 

func (_class VMClass) GetMemoryStaticMin(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the memory/static_min field of the given VM.

func (VMClass) GetMemoryTarget 

func (_class VMClass) GetMemoryTarget(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the memory/target field of the given VM.

func (VMClass) GetMetrics 

func (_class VMClass) GetMetrics(sessionID SessionRef, self VMRef) (_retval VMMetricsRef, _err error)

Get the metrics field of the given VM.

func (VMClass) GetNameDescription 

func (_class VMClass) GetNameDescription(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the name/description field of the given VM.

func (VMClass) GetNameLabel 

func (_class VMClass) GetNameLabel(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the name/label field of the given VM.

func (VMClass) GetOrder 

func (_class VMClass) GetOrder(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the order field of the given VM.

func (VMClass) GetOtherConfig 

func (_class VMClass) GetOtherConfig(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the other_config field of the given VM.

func (VMClass) GetPCIBus 

func (_class VMClass) GetPCIBus(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PCI_bus field of the given VM.

func (VMClass) GetPVArgs 

func (_class VMClass) GetPVArgs(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PV/args field of the given VM.

func (VMClass) GetPVBootloader 

func (_class VMClass) GetPVBootloader(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PV/bootloader field of the given VM.

func (VMClass) GetPVBootloaderArgs 

func (_class VMClass) GetPVBootloaderArgs(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PV/bootloader_args field of the given VM.

func (VMClass) GetPVKernel 

func (_class VMClass) GetPVKernel(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PV/kernel field of the given VM.

func (VMClass) GetPVLegacyArgs 

func (_class VMClass) GetPVLegacyArgs(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PV/legacy_args field of the given VM.

func (VMClass) GetPVRamdisk 

func (_class VMClass) GetPVRamdisk(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the PV/ramdisk field of the given VM.

func (VMClass) GetParent 

func (_class VMClass) GetParent(sessionID SessionRef, self VMRef) (_retval VMRef, _err error)

Get the parent field of the given VM.

func (VMClass) GetPlatform 

func (_class VMClass) GetPlatform(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the platform field of the given VM.

func (VMClass) GetPossibleHosts 

func (_class VMClass) GetPossibleHosts(sessionID SessionRef, vm VMRef) (_retval []HostRef, _err error)

Return the list of hosts on which this VM may run.

func (VMClass) GetPowerState 

func (_class VMClass) GetPowerState(sessionID SessionRef, self VMRef) (_retval VMPowerState, _err error)

Get the power_state field of the given VM.

func (VMClass) GetProtectionPolicy 

func (_class VMClass) GetProtectionPolicy(sessionID SessionRef, self VMRef) (_retval VMPPRef, _err error)

Get the protection_policy field of the given VM.

func (VMClass) GetRecommendations 

func (_class VMClass) GetRecommendations(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the recommendations field of the given VM.

func (VMClass) GetRecord 

func (_class VMClass) GetRecord(sessionID SessionRef, self VMRef) (_retval VMRecord, _err error)

Get a record containing the current state of the given VM.

func (VMClass) GetResidentOn 

func (_class VMClass) GetResidentOn(sessionID SessionRef, self VMRef) (_retval HostRef, _err error)

Get the resident_on field of the given VM.

func (VMClass) GetSRsRequiredForRecovery 

func (_class VMClass) GetSRsRequiredForRecovery(sessionID SessionRef, self VMRef, sessionTo SessionRef) (_retval []SRRef, _err error)

List all the SR's that are required for the VM to be recovered

func (VMClass) GetShutdownDelay 

func (_class VMClass) GetShutdownDelay(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the shutdown_delay field of the given VM.

func (VMClass) GetSnapshotInfo 

func (_class VMClass) GetSnapshotInfo(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the snapshot_info field of the given VM.

func (VMClass) GetSnapshotMetadata 

func (_class VMClass) GetSnapshotMetadata(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the snapshot_metadata field of the given VM.

func (VMClass) GetSnapshotOf 

func (_class VMClass) GetSnapshotOf(sessionID SessionRef, self VMRef) (_retval VMRef, _err error)

Get the snapshot_of field of the given VM.

func (VMClass) GetSnapshotTime 

func (_class VMClass) GetSnapshotTime(sessionID SessionRef, self VMRef) (_retval time.Time, _err error)

Get the snapshot_time field of the given VM.

func (VMClass) GetSnapshots 

func (_class VMClass) GetSnapshots(sessionID SessionRef, self VMRef) (_retval []VMRef, _err error)

Get the snapshots field of the given VM.

func (VMClass) GetStartDelay 

func (_class VMClass) GetStartDelay(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the start_delay field of the given VM.

func (VMClass) GetSuspendSR 

func (_class VMClass) GetSuspendSR(sessionID SessionRef, self VMRef) (_retval SRRef, _err error)

Get the suspend_SR field of the given VM.

func (VMClass) GetSuspendVDI 

func (_class VMClass) GetSuspendVDI(sessionID SessionRef, self VMRef) (_retval VDIRef, _err error)

Get the suspend_VDI field of the given VM.

func (VMClass) GetTags 

func (_class VMClass) GetTags(sessionID SessionRef, self VMRef) (_retval []string, _err error)

Get the tags field of the given VM.

func (VMClass) GetTransportableSnapshotID 

func (_class VMClass) GetTransportableSnapshotID(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the transportable_snapshot_id field of the given VM.

func (VMClass) GetUUID 

func (_class VMClass) GetUUID(sessionID SessionRef, self VMRef) (_retval string, _err error)

Get the uuid field of the given VM.

func (VMClass) GetUserVersion 

func (_class VMClass) GetUserVersion(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the user_version field of the given VM.

func (VMClass) GetVBDs 

func (_class VMClass) GetVBDs(sessionID SessionRef, self VMRef) (_retval []VBDRef, _err error)

Get the VBDs field of the given VM.

func (VMClass) GetVCPUsAtStartup 

func (_class VMClass) GetVCPUsAtStartup(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the VCPUs/at_startup field of the given VM.

func (VMClass) GetVCPUsMax 

func (_class VMClass) GetVCPUsMax(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the VCPUs/max field of the given VM.

func (VMClass) GetVCPUsParams 

func (_class VMClass) GetVCPUsParams(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the VCPUs/params field of the given VM.

func (VMClass) GetVGPUs 

func (_class VMClass) GetVGPUs(sessionID SessionRef, self VMRef) (_retval []VGPURef, _err error)

Get the VGPUs field of the given VM.

func (VMClass) GetVIFs 

func (_class VMClass) GetVIFs(sessionID SessionRef, self VMRef) (_retval []VIFRef, _err error)

Get the VIFs field of the given VM.

func (VMClass) GetVTPMs 

func (_class VMClass) GetVTPMs(sessionID SessionRef, self VMRef) (_retval []VTPMRef, _err error)

Get the VTPMs field of the given VM.

func (VMClass) GetVersion 

func (_class VMClass) GetVersion(sessionID SessionRef, self VMRef) (_retval int, _err error)

Get the version field of the given VM.

func (VMClass) GetXenstoreData 

func (_class VMClass) GetXenstoreData(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Get the xenstore_data field of the given VM.

func (VMClass) HardReboot 

func (_class VMClass) HardReboot(sessionID SessionRef, vm VMRef) (_err error)

Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) HardShutdown 

func (_class VMClass) HardShutdown(sessionID SessionRef, vm VMRef) (_err error)

Stop executing the specified VM without attempting a clean shutdown.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) Import 

func (_class VMClass) Import(sessionID SessionRef, url string, sr SRRef, fullRestore bool, force bool) (_retval []VMRef, _err error)

Import an XVA from a URI

func (VMClass) ImportConvert 

func (_class VMClass) ImportConvert(sessionID SessionRef, atype string, username string, password string, sr SRRef, remoteConfig map[string]string) (_err error)

Import using a conversion service.

func (VMClass) MaximiseMemory 

func (_class VMClass) MaximiseMemory(sessionID SessionRef, self VMRef, total int, approximate bool) (_retval int, _err error)

Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used

func (VMClass) MigrateSend 

func (_class VMClass) MigrateSend(sessionID SessionRef, vm VMRef, dest map[string]string, live bool, vdiMap map[VDIRef]SRRef, vifMap map[VIFRef]NetworkRef, options map[string]string) (_retval VMRef, _err error)

Migrate the VM to another host. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.

func (VMClass) Pause 

func (_class VMClass) Pause(sessionID SessionRef, vm VMRef) (_err error)

Pause the specified VM. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) PoolMigrate 

func (_class VMClass) PoolMigrate(sessionID SessionRef, vm VMRef, host HostRef, options map[string]string) (_err error)

Migrate a VM to another Host.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_MIGRATE_FAILED - An error occurred during the migration process.

func (VMClass) PowerStateReset 

func (_class VMClass) PowerStateReset(sessionID SessionRef, vm VMRef) (_err error)

Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care.

func (VMClass) Provision 

func (_class VMClass) Provision(sessionID SessionRef, vm VMRef) (_err error)

Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (VMClass) QueryDataSource 

func (_class VMClass) QueryDataSource(sessionID SessionRef, self VMRef, dataSource string) (_retval float64, _err error)

Query the latest value of the specified data source

func (VMClass) QueryServices 

func (_class VMClass) QueryServices(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

Query the system services advertised by this VM and register them. This can only be applied to a system domain.

func (VMClass) RecordDataSource 

func (_class VMClass) RecordDataSource(sessionID SessionRef, self VMRef, dataSource string) (_err error)

Start recording the specified data source

func (VMClass) Recover 

func (_class VMClass) Recover(sessionID SessionRef, self VMRef, sessionTo SessionRef, force bool) (_err error)

Recover the VM

func (VMClass) RemoveFromBlockedOperations 

func (_class VMClass) RemoveFromBlockedOperations(sessionID SessionRef, self VMRef, key VMOperations) (_err error)

Remove the given key and its corresponding value from the blocked_operations field of the given VM. If the key is not in that Map, then do nothing.

func (VMClass) RemoveFromHVMBootParams 

func (_class VMClass) RemoveFromHVMBootParams(sessionID SessionRef, self VMRef, key string) (_err error)

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.

func (VMClass) RemoveFromOtherConfig 

func (_class VMClass) RemoveFromOtherConfig(sessionID SessionRef, self VMRef, key string) (_err error)

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.

func (VMClass) RemoveFromPlatform 

func (_class VMClass) RemoveFromPlatform(sessionID SessionRef, self VMRef, key string) (_err error)

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.

func (VMClass) RemoveFromVCPUsParams 

func (_class VMClass) RemoveFromVCPUsParams(sessionID SessionRef, self VMRef, key string) (_err error)

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.

func (VMClass) RemoveFromXenstoreData 

func (_class VMClass) RemoveFromXenstoreData(sessionID SessionRef, self VMRef, key string) (_err error)

Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing.

func (VMClass) RemoveTags 

func (_class VMClass) RemoveTags(sessionID SessionRef, self VMRef, value string) (_err error)

Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing.

func (VMClass) Resume 

func (_class VMClass) Resume(sessionID SessionRef, vm VMRef, startPaused bool, force bool) (_err error)

Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) ResumeOn 

func (_class VMClass) ResumeOn(sessionID SessionRef, vm VMRef, host HostRef, startPaused bool, force bool) (_err error)

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.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) RetrieveWlbRecommendations 

func (_class VMClass) RetrieveWlbRecommendations(sessionID SessionRef, vm VMRef) (_retval map[HostRef][]string, _err error)

Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there.

func (VMClass) Revert 

func (_class VMClass) Revert(sessionID SessionRef, snapshot VMRef) (_err error)

Reverts the specified VM to a previous state.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
VM_REVERT_FAILED - An error occured while reverting the specified virtual machine to the specified snapshot

func (VMClass) SendSysrq 

func (_class VMClass) SendSysrq(sessionID SessionRef, vm VMRef, key string) (_err error)

Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.

func (VMClass) SendTrigger 

func (_class VMClass) SendTrigger(sessionID SessionRef, vm VMRef, trigger string) (_err error)

Send the named trigger to this VM. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.

func (VMClass) SetActionsAfterCrash 

func (_class VMClass) SetActionsAfterCrash(sessionID SessionRef, self VMRef, value OnCrashBehaviour) (_err error)

Set the actions/after_crash field of the given VM.

func (VMClass) SetActionsAfterReboot 

func (_class VMClass) SetActionsAfterReboot(sessionID SessionRef, self VMRef, value OnNormalExit) (_err error)

Set the actions/after_reboot field of the given VM.

func (VMClass) SetActionsAfterShutdown 

func (_class VMClass) SetActionsAfterShutdown(sessionID SessionRef, self VMRef, value OnNormalExit) (_err error)

Set the actions/after_shutdown field of the given VM.

func (VMClass) SetAffinity 

func (_class VMClass) SetAffinity(sessionID SessionRef, self VMRef, value HostRef) (_err error)

Set the affinity field of the given VM.

func (VMClass) SetAppliance 

func (_class VMClass) SetAppliance(sessionID SessionRef, self VMRef, value VMApplianceRef) (_err error)

Assign this VM to an appliance.

func (VMClass) SetAutoUpdateDrivers 

func (_class VMClass) SetAutoUpdateDrivers(sessionID SessionRef, self VMRef, value bool) (_err error)

Enable or disable PV auto update on Windows vm

func (VMClass) SetBlockedOperations 

func (_class VMClass) SetBlockedOperations(sessionID SessionRef, self VMRef, value map[VMOperations]string) (_err error)

Set the blocked_operations field of the given VM.

func (VMClass) SetHVMBootParams 

func (_class VMClass) SetHVMBootParams(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

Set the HVM/boot_params field of the given VM.

func (VMClass) SetHVMBootPolicy 

func (_class VMClass) SetHVMBootPolicy(sessionID SessionRef, self VMRef, value string) (_err error)

Set the HVM/boot_policy field of the given VM.

func (VMClass) SetHVMShadowMultiplier 

func (_class VMClass) SetHVMShadowMultiplier(sessionID SessionRef, self VMRef, value float64) (_err error)

Set the shadow memory multiplier on a halted VM

func (VMClass) SetHaAlwaysRun 

func (_class VMClass) SetHaAlwaysRun(sessionID SessionRef, self VMRef, value bool) (_err error)

Set the value of the ha_always_run

func (VMClass) SetHaRestartPriority 

func (_class VMClass) SetHaRestartPriority(sessionID SessionRef, self VMRef, value string) (_err error)

Set the value of the ha_restart_priority field

func (VMClass) SetHardwarePlatformVersion 

func (_class VMClass) SetHardwarePlatformVersion(sessionID SessionRef, self VMRef, value int) (_err error)

Set the hardware_platform_version field of the given VM.

func (VMClass) SetIsATemplate 

func (_class VMClass) SetIsATemplate(sessionID SessionRef, self VMRef, value bool) (_err error)

Set the is_a_template field of the given VM.

func (VMClass) SetMemoryDynamicMax 

func (_class VMClass) SetMemoryDynamicMax(sessionID SessionRef, self VMRef, value int) (_err error)

Set the value of the memory_dynamic_max field

func (VMClass) SetMemoryDynamicMin 

func (_class VMClass) SetMemoryDynamicMin(sessionID SessionRef, self VMRef, value int) (_err error)

Set the value of the memory_dynamic_min field

func (VMClass) SetMemoryDynamicRange 

func (_class VMClass) SetMemoryDynamicRange(sessionID SessionRef, self VMRef, min int, max int) (_err error)

Set the minimum and maximum amounts of physical memory the VM is allowed to use.

func (VMClass) SetMemoryLimits 

func (_class VMClass) SetMemoryLimits(sessionID SessionRef, self VMRef, staticMin int, staticMax int, dynamicMin int, dynamicMax int) (_err error)

Set the memory limits of this VM.

func (VMClass) SetMemoryStaticMax 

func (_class VMClass) SetMemoryStaticMax(sessionID SessionRef, self VMRef, value int) (_err error)

Set the value of the memory_static_max field

Errors: 

HA_OPERATION_WOULD_BREAK_FAILOVER_PLAN - This operation cannot be performed because it would invalidate VM failover planning such that the system would be unable to guarantee to restart protected VMs after a Host failure.

func (VMClass) SetMemoryStaticMin 

func (_class VMClass) SetMemoryStaticMin(sessionID SessionRef, self VMRef, value int) (_err error)

Set the value of the memory_static_min field

func (VMClass) SetMemoryStaticRange 

func (_class VMClass) SetMemoryStaticRange(sessionID SessionRef, self VMRef, min int, max int) (_err error)

Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.

func (VMClass) SetMemoryTargetLive 

func (_class VMClass) SetMemoryTargetLive(sessionID SessionRef, self VMRef, target int) (_err error)

Set the memory target for a running VM

func (VMClass) SetNameDescription 

func (_class VMClass) SetNameDescription(sessionID SessionRef, self VMRef, value string) (_err error)

Set the name/description field of the given VM.

func (VMClass) SetNameLabel 

func (_class VMClass) SetNameLabel(sessionID SessionRef, self VMRef, value string) (_err error)

Set the name/label field of the given VM.

func (VMClass) SetOrder 

func (_class VMClass) SetOrder(sessionID SessionRef, self VMRef, value int) (_err error)

Set this VM's boot order

func (VMClass) SetOtherConfig 

func (_class VMClass) SetOtherConfig(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

Set the other_config field of the given VM.

func (VMClass) SetPCIBus 

func (_class VMClass) SetPCIBus(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PCI_bus field of the given VM.

func (VMClass) SetPVArgs 

func (_class VMClass) SetPVArgs(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PV/args field of the given VM.

func (VMClass) SetPVBootloader 

func (_class VMClass) SetPVBootloader(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PV/bootloader field of the given VM.

func (VMClass) SetPVBootloaderArgs 

func (_class VMClass) SetPVBootloaderArgs(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PV/bootloader_args field of the given VM.

func (VMClass) SetPVKernel 

func (_class VMClass) SetPVKernel(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PV/kernel field of the given VM.

func (VMClass) SetPVLegacyArgs 

func (_class VMClass) SetPVLegacyArgs(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PV/legacy_args field of the given VM.

func (VMClass) SetPVRamdisk 

func (_class VMClass) SetPVRamdisk(sessionID SessionRef, self VMRef, value string) (_err error)

Set the PV/ramdisk field of the given VM.

func (VMClass) SetPlatform 

func (_class VMClass) SetPlatform(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

Set the platform field of the given VM.

func (VMClass) SetProtectionPolicy 

func (_class VMClass) SetProtectionPolicy(sessionID SessionRef, self VMRef, value VMPPRef) (_err error)

Set the value of the protection_policy field

func (VMClass) SetRecommendations 

func (_class VMClass) SetRecommendations(sessionID SessionRef, self VMRef, value string) (_err error)

Set the recommendations field of the given VM.

func (VMClass) SetShadowMultiplierLive 

func (_class VMClass) SetShadowMultiplierLive(sessionID SessionRef, self VMRef, multiplier float64) (_err error)

Set the shadow memory multiplier on a running VM

func (VMClass) SetShutdownDelay 

func (_class VMClass) SetShutdownDelay(sessionID SessionRef, self VMRef, value int) (_err error)

Set this VM's shutdown delay in seconds

func (VMClass) SetStartDelay 

func (_class VMClass) SetStartDelay(sessionID SessionRef, self VMRef, value int) (_err error)

Set this VM's start delay in seconds

func (VMClass) SetSuspendSR 

func (_class VMClass) SetSuspendSR(sessionID SessionRef, self VMRef, value SRRef) (_err error)

Set the suspend_SR field of the given VM.

func (VMClass) SetSuspendVDI 

func (_class VMClass) SetSuspendVDI(sessionID SessionRef, self VMRef, value VDIRef) (_err error)

Set this VM's suspend VDI, which must be indentical to its current one

func (VMClass) SetTags 

func (_class VMClass) SetTags(sessionID SessionRef, self VMRef, value []string) (_err error)

Set the tags field of the given VM.

func (VMClass) SetUserVersion 

func (_class VMClass) SetUserVersion(sessionID SessionRef, self VMRef, value int) (_err error)

Set the user_version field of the given VM.

func (VMClass) SetVCPUsAtStartup 

func (_class VMClass) SetVCPUsAtStartup(sessionID SessionRef, self VMRef, value int) (_err error)

Set the number of startup VCPUs for a halted VM

func (VMClass) SetVCPUsMax 

func (_class VMClass) SetVCPUsMax(sessionID SessionRef, self VMRef, value int) (_err error)

Set the maximum number of VCPUs for a halted VM

func (VMClass) SetVCPUsNumberLive 

func (_class VMClass) SetVCPUsNumberLive(sessionID SessionRef, self VMRef, nvcpu int) (_err error)

Set the number of VCPUs for a running VM

func (VMClass) SetVCPUsParams 

func (_class VMClass) SetVCPUsParams(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

Set the VCPUs/params field of the given VM.

func (VMClass) SetXenstoreData 

func (_class VMClass) SetXenstoreData(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

Set the xenstore_data field of the given VM.

func (VMClass) Shutdown 

func (_class VMClass) Shutdown(sessionID SessionRef, vm VMRef) (_err error)

Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) Snapshot 

func (_class VMClass) Snapshot(sessionID SessionRef, vm VMRef, newName string) (_retval VMRef, _err error)

Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.

func (VMClass) SnapshotWithQuiesce 

func (_class VMClass) SnapshotWithQuiesce(sessionID SessionRef, vm VMRef, newName string) (_retval VMRef, _err error)

Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write).

Errors: 

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 state at the time of the call.
SR_FULL - The SR is full. Requested new size exceeds the maximum size
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_SNAPSHOT_WITH_QUIESCE_FAILED - The quiesced-snapshot operation failed for an unexpected reason
VM_SNAPSHOT_WITH_QUIESCE_TIMEOUT - The VSS plug-in has timed out
VM_SNAPSHOT_WITH_QUIESCE_PLUGIN_DEOS_NOT_RESPOND - The VSS plug-in cannot be contacted
VM_SNAPSHOT_WITH_QUIESCE_NOT_SUPPORTED - The VSS plug-in is not installed on this virtual machine

func (VMClass) Start 

func (_class VMClass) Start(sessionID SessionRef, vm VMRef, startPaused bool, force bool) (_err error)

Start the specified VM. This function can only be called with the VM is in the Halted State.

Errors: 

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 state at the time of the call.
VM_HVM_REQUIRED - HVM is required for this operation
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
BOOTLOADER_FAILED - The bootloader returned an error
UNKNOWN_BOOTLOADER - The requested bootloader is unknown
NO_HOSTS_AVAILABLE - There were no hosts available to complete the specified operation.
LICENCE_RESTRICTION - This operation is not allowed under your license.  Please contact your support representative.

func (VMClass) StartOn 

func (_class VMClass) StartOn(sessionID SessionRef, vm VMRef, host HostRef, startPaused bool, force bool) (_err error)

Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State.

Errors: 

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 state at the time of the call.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
BOOTLOADER_FAILED - The bootloader returned an error
UNKNOWN_BOOTLOADER - The requested bootloader is unknown

func (VMClass) Suspend 

func (_class VMClass) Suspend(sessionID SessionRef, vm VMRef) (_err error)

Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state.

Errors: 

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 state at the time of the call.
OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) Unpause 

func (_class VMClass) Unpause(sessionID SessionRef, vm VMRef) (_err error)

Resume the specified VM. This can only be called when the specified VM is in the Paused state.

Errors: 

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 state at the time of the call.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VM_IS_TEMPLATE - The operation attempted is not valid for a template VM

func (VMClass) UpdateAllowedOperations 

func (_class VMClass) UpdateAllowedOperations(sessionID SessionRef, self VMRef) (_err error)

Recomputes the list of acceptable operations

func (VMClass) WaitMemoryTargetLive 

func (_class VMClass) WaitMemoryTargetLive(sessionID SessionRef, self VMRef) (_err error)

Wait for a running VM to reach its current memory target

func (VMClass) XenprepStart 

func (_class VMClass) XenprepStart(sessionID SessionRef, self VMRef) (_err error)

Start the 'xenprep' process on the VM; the process will remove any tools and drivers for XenServer and then set auto update drivers true.

type VMGuestMetricsClass 

type VMGuestMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics reported by the guest (as opposed to inferred from outside)

func (VMGuestMetricsClass) AddToOtherConfig 

func (_class VMGuestMetricsClass) AddToOtherConfig(sessionID SessionRef, self VMGuestMetricsRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetAll 

func (_class VMGuestMetricsClass) GetAll(sessionID SessionRef) (_retval []VMGuestMetricsRef, _err error)

Return a list of all the VM_guest_metrics instances known to the system.

func (VMGuestMetricsClass) GetAllRecords 

func (_class VMGuestMetricsClass) GetAllRecords(sessionID SessionRef) (_retval map[VMGuestMetricsRef]VMGuestMetricsRecord, _err error)

Return a map of VM_guest_metrics references to VM_guest_metrics records for all VM_guest_metrics instances known to the system.

func (VMGuestMetricsClass) GetByUUID 

func (_class VMGuestMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMGuestMetricsRef, _err error)

Get a reference to the VM_guest_metrics instance with the specified UUID.

func (VMGuestMetricsClass) GetDisks 

func (_class VMGuestMetricsClass) GetDisks(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the disks field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetLastUpdated 

func (_class VMGuestMetricsClass) GetLastUpdated(sessionID SessionRef, self VMGuestMetricsRef) (_retval time.Time, _err error)

Get the last_updated field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetLive 

func (_class VMGuestMetricsClass) GetLive(sessionID SessionRef, self VMGuestMetricsRef) (_retval bool, _err error)

Get the live field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetMemory 

func (_class VMGuestMetricsClass) GetMemory(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the memory field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetNetworkPathsOptimized 

func (_class VMGuestMetricsClass) GetNetworkPathsOptimized(sessionID SessionRef, self VMGuestMetricsRef) (_retval bool, _err error)

Get the network_paths_optimized field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetNetworks 

func (_class VMGuestMetricsClass) GetNetworks(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the networks field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetOsVersion 

func (_class VMGuestMetricsClass) GetOsVersion(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the os_version field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetOther 

func (_class VMGuestMetricsClass) GetOther(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the other field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetOtherConfig 

func (_class VMGuestMetricsClass) GetOtherConfig(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the other_config field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetPVDriversUpToDate 

func (_class VMGuestMetricsClass) GetPVDriversUpToDate(sessionID SessionRef, self VMGuestMetricsRef) (_retval bool, _err error)

Get the PV_drivers_up_to_date field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetPVDriversVersion 

func (_class VMGuestMetricsClass) GetPVDriversVersion(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

Get the PV_drivers_version field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetRecord 

func (_class VMGuestMetricsClass) GetRecord(sessionID SessionRef, self VMGuestMetricsRef) (_retval VMGuestMetricsRecord, _err error)

Get a record containing the current state of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetStoragePathsOptimized 

func (_class VMGuestMetricsClass) GetStoragePathsOptimized(sessionID SessionRef, self VMGuestMetricsRef) (_retval bool, _err error)

Get the storage_paths_optimized field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetUUID 

func (_class VMGuestMetricsClass) GetUUID(sessionID SessionRef, self VMGuestMetricsRef) (_retval string, _err error)

Get the uuid field of the given VM_guest_metrics.

func (VMGuestMetricsClass) RemoveFromOtherConfig 

func (_class VMGuestMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VMGuestMetricsRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given VM_guest_metrics. If the key is not in that Map, then do nothing.

func (VMGuestMetricsClass) SetOtherConfig 

func (_class VMGuestMetricsClass) SetOtherConfig(sessionID SessionRef, self VMGuestMetricsRef, value map[string]string) (_err error)

Set the other_config field of the given VM_guest_metrics.

type VMGuestMetricsRecord 

type VMGuestMetricsRecord struct {
	// Unique identifier/object reference
	UUID string
	// version of the OS
	OsVersion map[string]string
	// version of the PV drivers
	PVDriversVersion map[string]string
	// Logical AND of network_paths_optimized and storage_paths_optimized
	PVDriversUpToDate bool
	// True if the network paths are optimized with PV driver
	NetworkPathsOptimized bool
	// True if the storage paths are optimized with PV driver
	StoragePathsOptimized bool
	// This field exists but has no data. Use the memory and memory_internal_free RRD data-sources instead.
	Memory map[string]string
	// This field exists but has no data.
	Disks map[string]string
	// network configuration
	Networks map[string]string
	// anything else
	Other map[string]string
	// Time at which this information was last updated
	LastUpdated time.Time
	// additional configuration
	OtherConfig map[string]string
	// True if the guest is sending heartbeat messages via the guest agent
	Live bool
}

type VMGuestMetricsRef 

type VMGuestMetricsRef string

type VMMetricsClass 

type VMMetricsClass struct {
	// contains filtered or unexported fields
}

The metrics associated with a VM

func (VMMetricsClass) AddToOtherConfig 

func (_class VMMetricsClass) AddToOtherConfig(sessionID SessionRef, self VMMetricsRef, key string, value string) (_err error)

Add the given key-value pair to the other_config field of the given VM_metrics.

func (VMMetricsClass) GetAll 

func (_class VMMetricsClass) GetAll(sessionID SessionRef) (_retval []VMMetricsRef, _err error)

Return a list of all the VM_metrics instances known to the system.

func (VMMetricsClass) GetAllRecords 

func (_class VMMetricsClass) GetAllRecords(sessionID SessionRef) (_retval map[VMMetricsRef]VMMetricsRecord, _err error)

Return a map of VM_metrics references to VM_metrics records for all VM_metrics instances known to the system.

func (VMMetricsClass) GetByUUID 

func (_class VMMetricsClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMMetricsRef, _err error)

Get a reference to the VM_metrics instance with the specified UUID.

func (VMMetricsClass) GetInstallTime 

func (_class VMMetricsClass) GetInstallTime(sessionID SessionRef, self VMMetricsRef) (_retval time.Time, _err error)

Get the install_time field of the given VM_metrics.

func (VMMetricsClass) GetLastUpdated 

func (_class VMMetricsClass) GetLastUpdated(sessionID SessionRef, self VMMetricsRef) (_retval time.Time, _err error)

Get the last_updated field of the given VM_metrics.

func (VMMetricsClass) GetMemoryActual 

func (_class VMMetricsClass) GetMemoryActual(sessionID SessionRef, self VMMetricsRef) (_retval int, _err error)

Get the memory/actual field of the given VM_metrics.

func (VMMetricsClass) GetOtherConfig 

func (_class VMMetricsClass) GetOtherConfig(sessionID SessionRef, self VMMetricsRef) (_retval map[string]string, _err error)

Get the other_config field of the given VM_metrics.

func (VMMetricsClass) GetRecord 

func (_class VMMetricsClass) GetRecord(sessionID SessionRef, self VMMetricsRef) (_retval VMMetricsRecord, _err error)

Get a record containing the current state of the given VM_metrics.

func (VMMetricsClass) GetStartTime 

func (_class VMMetricsClass) GetStartTime(sessionID SessionRef, self VMMetricsRef) (_retval time.Time, _err error)

Get the start_time field of the given VM_metrics.

func (VMMetricsClass) GetState 

func (_class VMMetricsClass) GetState(sessionID SessionRef, self VMMetricsRef) (_retval []string, _err error)

Get the state field of the given VM_metrics.

func (VMMetricsClass) GetUUID 

func (_class VMMetricsClass) GetUUID(sessionID SessionRef, self VMMetricsRef) (_retval string, _err error)

Get the uuid field of the given VM_metrics.

func (VMMetricsClass) GetVCPUsCPU 

func (_class VMMetricsClass) GetVCPUsCPU(sessionID SessionRef, self VMMetricsRef) (_retval map[int]int, _err error)

Get the VCPUs/CPU field of the given VM_metrics.

func (VMMetricsClass) GetVCPUsFlags 

func (_class VMMetricsClass) GetVCPUsFlags(sessionID SessionRef, self VMMetricsRef) (_retval map[int][]string, _err error)

Get the VCPUs/flags field of the given VM_metrics.

func (VMMetricsClass) GetVCPUsNumber 

func (_class VMMetricsClass) GetVCPUsNumber(sessionID SessionRef, self VMMetricsRef) (_retval int, _err error)

Get the VCPUs/number field of the given VM_metrics.

func (VMMetricsClass) GetVCPUsParams 

func (_class VMMetricsClass) GetVCPUsParams(sessionID SessionRef, self VMMetricsRef) (_retval map[string]string, _err error)

Get the VCPUs/params field of the given VM_metrics.

func (VMMetricsClass) GetVCPUsUtilisation 

func (_class VMMetricsClass) GetVCPUsUtilisation(sessionID SessionRef, self VMMetricsRef) (_retval map[int]float64, _err error)

Get the VCPUs/utilisation field of the given VM_metrics.

func (VMMetricsClass) RemoveFromOtherConfig 

func (_class VMMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VMMetricsRef, key string) (_err error)

Remove the given key and its corresponding value from the other_config field of the given VM_metrics. If the key is not in that Map, then do nothing.

func (VMMetricsClass) SetOtherConfig 

func (_class VMMetricsClass) SetOtherConfig(sessionID SessionRef, self VMMetricsRef, value map[string]string) (_err error)

Set the other_config field of the given VM_metrics.

type VMMetricsRecord 

type VMMetricsRecord struct {
	// Unique identifier/object reference
	UUID string
	// Guest's actual memory (bytes)
	MemoryActual int
	// Current number of VCPUs
	VCPUsNumber int
	// Utilisation for all of guest's current VCPUs
	VCPUsUtilisation map[int]float64
	// VCPU to PCPU map
	VCPUsCPU map[int]int
	// The live equivalent to VM.VCPUs_params
	VCPUsParams map[string]string
	// CPU flags (blocked,online,running)
	VCPUsFlags map[int][]string
	// The state of the guest, eg blocked, dying etc
	State []string
	// Time at which this VM was last booted
	StartTime time.Time
	// Time at which the VM was installed
	InstallTime time.Time
	// Time at which this information was last updated
	LastUpdated time.Time
	// additional configuration
	OtherConfig map[string]string
}

type VMMetricsRef 

type VMMetricsRef string

type VMOperations 

type VMOperations string
const (
	// refers to the operation "snapshot"
	VMOperationsSnapshot VMOperations = "snapshot"
	// refers to the operation "clone"
	VMOperationsClone VMOperations = "clone"
	// refers to the operation "copy"
	VMOperationsCopy VMOperations = "copy"
	// refers to the operation "create_template"
	VMOperationsCreateTemplate VMOperations = "create_template"
	// refers to the operation "revert"
	VMOperationsRevert VMOperations = "revert"
	// refers to the operation "checkpoint"
	VMOperationsCheckpoint VMOperations = "checkpoint"
	// refers to the operation "snapshot_with_quiesce"
	VMOperationsSnapshotWithQuiesce VMOperations = "snapshot_with_quiesce"
	// refers to the operation "provision"
	VMOperationsProvision VMOperations = "provision"
	// refers to the operation "start"
	VMOperationsStart VMOperations = "start"
	// refers to the operation "start_on"
	VMOperationsStartOn VMOperations = "start_on"
	// refers to the operation "pause"
	VMOperationsPause VMOperations = "pause"
	// refers to the operation "unpause"
	VMOperationsUnpause VMOperations = "unpause"
	// refers to the operation "clean_shutdown"
	VMOperationsCleanShutdown VMOperations = "clean_shutdown"
	// refers to the operation "clean_reboot"
	VMOperationsCleanReboot VMOperations = "clean_reboot"
	// refers to the operation "hard_shutdown"
	VMOperationsHardShutdown VMOperations = "hard_shutdown"
	// refers to the operation "power_state_reset"
	VMOperationsPowerStateReset VMOperations = "power_state_reset"
	// refers to the operation "hard_reboot"
	VMOperationsHardReboot VMOperations = "hard_reboot"
	// refers to the operation "suspend"
	VMOperationsSuspend VMOperations = "suspend"
	// refers to the operation "csvm"
	VMOperationsCsvm VMOperations = "csvm"
	// refers to the operation "resume"
	VMOperationsResume VMOperations = "resume"
	// refers to the operation "resume_on"
	VMOperationsResumeOn VMOperations = "resume_on"
	// refers to the operation "pool_migrate"
	VMOperationsPoolMigrate VMOperations = "pool_migrate"
	// refers to the operation "migrate_send"
	VMOperationsMigrateSend VMOperations = "migrate_send"
	// refers to the operation "get_boot_record"
	VMOperationsGetBootRecord VMOperations = "get_boot_record"
	// refers to the operation "send_sysrq"
	VMOperationsSendSysrq VMOperations = "send_sysrq"
	// refers to the operation "send_trigger"
	VMOperationsSendTrigger VMOperations = "send_trigger"
	// refers to the operation "query_services"
	VMOperationsQueryServices VMOperations = "query_services"
	// refers to the operation "shutdown"
	VMOperationsShutdown VMOperations = "shutdown"
	// refers to the operation "call_plugin"
	VMOperationsCallPlugin VMOperations = "call_plugin"
	// Changing the memory settings
	VMOperationsChangingMemoryLive VMOperations = "changing_memory_live"
	// Waiting for the memory settings to change
	VMOperationsAwaitingMemoryLive VMOperations = "awaiting_memory_live"
	// Changing the memory dynamic range
	VMOperationsChangingDynamicRange VMOperations = "changing_dynamic_range"
	// Changing the memory static range
	VMOperationsChangingStaticRange VMOperations = "changing_static_range"
	// Changing the memory limits
	VMOperationsChangingMemoryLimits VMOperations = "changing_memory_limits"
	// Changing the shadow memory for a halted VM.
	VMOperationsChangingShadowMemory VMOperations = "changing_shadow_memory"
	// Changing the shadow memory for a running VM.
	VMOperationsChangingShadowMemoryLive VMOperations = "changing_shadow_memory_live"
	// Changing VCPU settings for a halted VM.
	VMOperationsChangingVCPUs VMOperations = "changing_VCPUs"
	// Changing VCPU settings for a running VM.
	VMOperationsChangingVCPUsLive VMOperations = "changing_VCPUs_live"
	//
	VMOperationsAssertOperationValid VMOperations = "assert_operation_valid"
	// Add, remove, query or list data sources
	VMOperationsDataSourceOp VMOperations = "data_source_op"
	//
	VMOperationsUpdateAllowedOperations VMOperations = "update_allowed_operations"
	// Turning this VM into a template
	VMOperationsMakeIntoTemplate VMOperations = "make_into_template"
	// importing a VM from a network stream
	VMOperationsImport VMOperations = "import"
	// exporting a VM to a network stream
	VMOperationsExport VMOperations = "export"
	// exporting VM metadata to a network stream
	VMOperationsMetadataExport VMOperations = "metadata_export"
	// Reverting the VM to a previous snapshotted state
	VMOperationsReverting VMOperations = "reverting"
	// refers to the act of uninstalling the VM
	VMOperationsDestroy VMOperations = "destroy"
)

type VMPPClass 

type VMPPClass struct {
	// contains filtered or unexported fields
}

VM Protection Policy

func (VMPPClass) AddToAlarmConfig 

func (_class VMPPClass) AddToAlarmConfig(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

func (VMPPClass) AddToArchiveSchedule 

func (_class VMPPClass) AddToArchiveSchedule(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

func (VMPPClass) AddToArchiveTargetConfig 

func (_class VMPPClass) AddToArchiveTargetConfig(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

func (VMPPClass) AddToBackupSchedule 

func (_class VMPPClass) AddToBackupSchedule(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

func (VMPPClass) ArchiveNow 

func (_class VMPPClass) ArchiveNow(sessionID SessionRef, snapshot VMRef) (_retval string, _err error)

This call archives the snapshot provided as a parameter

func (VMPPClass) Create 

func (_class VMPPClass) Create(sessionID SessionRef, args VMPPRecord) (_retval VMPPRef, _err error)

Create a new VMPP instance, and return its handle. The constructor args are: name_label, name_description, is_policy_enabled, backup_type, backup_retention_value, backup_frequency, backup_schedule, archive_target_type, archive_target_config, archive_frequency, archive_schedule, is_alarm_enabled, alarm_config (* = non-optional).

func (VMPPClass) Destroy 

func (_class VMPPClass) Destroy(sessionID SessionRef, self VMPPRef) (_err error)

Destroy the specified VMPP instance.

func (VMPPClass) GetAlarmConfig 

func (_class VMPPClass) GetAlarmConfig(sessionID SessionRef, self VMPPRef) (_retval map[string]string, _err error)

Get the alarm_config field of the given VMPP.

func (VMPPClass) GetAlerts 

func (_class VMPPClass) GetAlerts(sessionID SessionRef, vmpp VMPPRef, hoursFromNow int) (_retval []string, _err error)

This call fetches a history of alerts for a given protection policy

func (VMPPClass) GetAll 

func (_class VMPPClass) GetAll(sessionID SessionRef) (_retval []VMPPRef, _err error)

Return a list of all the VMPPs known to the system.

func (VMPPClass) GetAllRecords 

func (_class VMPPClass) GetAllRecords(sessionID SessionRef) (_retval map[VMPPRef]VMPPRecord, _err error)

Return a map of VMPP references to VMPP records for all VMPPs known to the system.

func (VMPPClass) GetArchiveFrequency 

func (_class VMPPClass) GetArchiveFrequency(sessionID SessionRef, self VMPPRef) (_retval VmppArchiveFrequency, _err error)

Get the archive_frequency field of the given VMPP.

func (VMPPClass) GetArchiveLastRunTime 

func (_class VMPPClass) GetArchiveLastRunTime(sessionID SessionRef, self VMPPRef) (_retval time.Time, _err error)

Get the archive_last_run_time field of the given VMPP.

func (VMPPClass) GetArchiveSchedule 

func (_class VMPPClass) GetArchiveSchedule(sessionID SessionRef, self VMPPRef) (_retval map[string]string, _err error)

Get the archive_schedule field of the given VMPP.

func (VMPPClass) GetArchiveTargetConfig 

func (_class VMPPClass) GetArchiveTargetConfig(sessionID SessionRef, self VMPPRef) (_retval map[string]string, _err error)

Get the archive_target_config field of the given VMPP.

func (VMPPClass) GetArchiveTargetType 

func (_class VMPPClass) GetArchiveTargetType(sessionID SessionRef, self VMPPRef) (_retval VmppArchiveTargetType, _err error)

Get the archive_target_type field of the given VMPP.

func (VMPPClass) GetBackupFrequency 

func (_class VMPPClass) GetBackupFrequency(sessionID SessionRef, self VMPPRef) (_retval VmppBackupFrequency, _err error)

Get the backup_frequency field of the given VMPP.

func (VMPPClass) GetBackupLastRunTime 

func (_class VMPPClass) GetBackupLastRunTime(sessionID SessionRef, self VMPPRef) (_retval time.Time, _err error)

Get the backup_last_run_time field of the given VMPP.

func (VMPPClass) GetBackupRetentionValue 

func (_class VMPPClass) GetBackupRetentionValue(sessionID SessionRef, self VMPPRef) (_retval int, _err error)

Get the backup_retention_value field of the given VMPP.

func (VMPPClass) GetBackupSchedule 

func (_class VMPPClass) GetBackupSchedule(sessionID SessionRef, self VMPPRef) (_retval map[string]string, _err error)

Get the backup_schedule field of the given VMPP.

func (VMPPClass) GetBackupType 

func (_class VMPPClass) GetBackupType(sessionID SessionRef, self VMPPRef) (_retval VmppBackupType, _err error)

Get the backup_type field of the given VMPP.

func (VMPPClass) GetByNameLabel 

func (_class VMPPClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VMPPRef, _err error)

Get all the VMPP instances with the given label.

func (VMPPClass) GetByUUID 

func (_class VMPPClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMPPRef, _err error)

Get a reference to the VMPP instance with the specified UUID.

func (VMPPClass) GetIsAlarmEnabled 

func (_class VMPPClass) GetIsAlarmEnabled(sessionID SessionRef, self VMPPRef) (_retval bool, _err error)

Get the is_alarm_enabled field of the given VMPP.

func (VMPPClass) GetIsArchiveRunning 

func (_class VMPPClass) GetIsArchiveRunning(sessionID SessionRef, self VMPPRef) (_retval bool, _err error)

Get the is_archive_running field of the given VMPP.

func (VMPPClass) GetIsBackupRunning 

func (_class VMPPClass) GetIsBackupRunning(sessionID SessionRef, self VMPPRef) (_retval bool, _err error)

Get the is_backup_running field of the given VMPP.

func (VMPPClass) GetIsPolicyEnabled 

func (_class VMPPClass) GetIsPolicyEnabled(sessionID SessionRef, self VMPPRef) (_retval bool, _err error)

Get the is_policy_enabled field of the given VMPP.

func (VMPPClass) GetNameDescription 

func (_class VMPPClass) GetNameDescription(sessionID SessionRef, self VMPPRef) (_retval string, _err error)

Get the name/description field of the given VMPP.

func (VMPPClass) GetNameLabel 

func (_class VMPPClass) GetNameLabel(sessionID SessionRef, self VMPPRef) (_retval string, _err error)

Get the name/label field of the given VMPP.

func (VMPPClass) GetRecentAlerts 

func (_class VMPPClass) GetRecentAlerts(sessionID SessionRef, self VMPPRef) (_retval []string, _err error)

Get the recent_alerts field of the given VMPP.

func (VMPPClass) GetRecord 

func (_class VMPPClass) GetRecord(sessionID SessionRef, self VMPPRef) (_retval VMPPRecord, _err error)

Get a record containing the current state of the given VMPP.

func (VMPPClass) GetUUID 

func (_class VMPPClass) GetUUID(sessionID SessionRef, self VMPPRef) (_retval string, _err error)

Get the uuid field of the given VMPP.

func (VMPPClass) GetVMs 

func (_class VMPPClass) GetVMs(sessionID SessionRef, self VMPPRef) (_retval []VMRef, _err error)

Get the VMs field of the given VMPP.

func (VMPPClass) ProtectNow 

func (_class VMPPClass) ProtectNow(sessionID SessionRef, vmpp VMPPRef) (_retval string, _err error)

This call executes the protection policy immediately

func (VMPPClass) RemoveFromAlarmConfig 

func (_class VMPPClass) RemoveFromAlarmConfig(sessionID SessionRef, self VMPPRef, key string) (_err error)

func (VMPPClass) RemoveFromArchiveSchedule 

func (_class VMPPClass) RemoveFromArchiveSchedule(sessionID SessionRef, self VMPPRef, key string) (_err error)

func (VMPPClass) RemoveFromArchiveTargetConfig 

func (_class VMPPClass) RemoveFromArchiveTargetConfig(sessionID SessionRef, self VMPPRef, key string) (_err error)

func (VMPPClass) RemoveFromBackupSchedule 

func (_class VMPPClass) RemoveFromBackupSchedule(sessionID SessionRef, self VMPPRef, key string) (_err error)

func (VMPPClass) SetAlarmConfig 

func (_class VMPPClass) SetAlarmConfig(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

func (VMPPClass) SetArchiveFrequency 

func (_class VMPPClass) SetArchiveFrequency(sessionID SessionRef, self VMPPRef, value VmppArchiveFrequency) (_err error)

Set the value of the archive_frequency field

func (VMPPClass) SetArchiveLastRunTime 

func (_class VMPPClass) SetArchiveLastRunTime(sessionID SessionRef, self VMPPRef, value time.Time) (_err error)

func (VMPPClass) SetArchiveSchedule 

func (_class VMPPClass) SetArchiveSchedule(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

func (VMPPClass) SetArchiveTargetConfig 

func (_class VMPPClass) SetArchiveTargetConfig(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

func (VMPPClass) SetArchiveTargetType 

func (_class VMPPClass) SetArchiveTargetType(sessionID SessionRef, self VMPPRef, value VmppArchiveTargetType) (_err error)

Set the value of the archive_target_config_type field

func (VMPPClass) SetBackupFrequency 

func (_class VMPPClass) SetBackupFrequency(sessionID SessionRef, self VMPPRef, value VmppBackupFrequency) (_err error)

Set the value of the backup_frequency field

func (VMPPClass) SetBackupLastRunTime 

func (_class VMPPClass) SetBackupLastRunTime(sessionID SessionRef, self VMPPRef, value time.Time) (_err error)

func (VMPPClass) SetBackupRetentionValue 

func (_class VMPPClass) SetBackupRetentionValue(sessionID SessionRef, self VMPPRef, value int) (_err error)

func (VMPPClass) SetBackupSchedule 

func (_class VMPPClass) SetBackupSchedule(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

func (VMPPClass) SetBackupType 

func (_class VMPPClass) SetBackupType(sessionID SessionRef, self VMPPRef, value VmppBackupType) (_err error)

Set the backup_type field of the given VMPP.

func (VMPPClass) SetIsAlarmEnabled 

func (_class VMPPClass) SetIsAlarmEnabled(sessionID SessionRef, self VMPPRef, value bool) (_err error)

Set the value of the is_alarm_enabled field

func (VMPPClass) SetIsPolicyEnabled 

func (_class VMPPClass) SetIsPolicyEnabled(sessionID SessionRef, self VMPPRef, value bool) (_err error)

Set the is_policy_enabled field of the given VMPP.

func (VMPPClass) SetNameDescription 

func (_class VMPPClass) SetNameDescription(sessionID SessionRef, self VMPPRef, value string) (_err error)

Set the name/description field of the given VMPP.

func (VMPPClass) SetNameLabel 

func (_class VMPPClass) SetNameLabel(sessionID SessionRef, self VMPPRef, value string) (_err error)

Set the name/label field of the given VMPP.

type VMPPRecord 

type VMPPRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// enable or disable this policy
	IsPolicyEnabled bool
	// type of the backup sub-policy
	BackupType VmppBackupType
	// maximum number of backups that should be stored at any time
	BackupRetentionValue int
	// frequency of the backup schedule
	BackupFrequency VmppBackupFrequency
	// schedule of the backup containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone
	BackupSchedule map[string]string
	// true if this protection policy's backup is running
	IsBackupRunning bool
	// time of the last backup
	BackupLastRunTime time.Time
	// type of the archive target config
	ArchiveTargetType VmppArchiveTargetType
	// configuration for the archive, including its 'location', 'username', 'password'
	ArchiveTargetConfig map[string]string
	// frequency of the archive schedule
	ArchiveFrequency VmppArchiveFrequency
	// schedule of the archive containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone
	ArchiveSchedule map[string]string
	// true if this protection policy's archive is running
	IsArchiveRunning bool
	// time of the last archive
	ArchiveLastRunTime time.Time
	// all VMs attached to this protection policy
	VMs []VMRef
	// true if alarm is enabled for this policy
	IsAlarmEnabled bool
	// configuration for the alarm
	AlarmConfig map[string]string
	// recent alerts
	RecentAlerts []string
}

type VMPPRef 

type VMPPRef string

type VMPowerState 

type VMPowerState string
const (
	// VM is offline and not using any resources
	VMPowerStateHalted VMPowerState = "Halted"
	// All resources have been allocated but the VM itself is paused and its vCPUs are not running
	VMPowerStatePaused VMPowerState = "Paused"
	// Running
	VMPowerStateRunning VMPowerState = "Running"
	// VM state has been saved to disk and it is nolonger running. Note that disks remain in-use while the VM is suspended.
	VMPowerStateSuspended VMPowerState = "Suspended"
)

type VMRecord 

type VMRecord struct {
	// Unique identifier/object reference
	UUID string
	// list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
	AllowedOperations []VMOperations
	// links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
	CurrentOperations map[string]VMOperations
	// Current power state of the machine
	PowerState VMPowerState
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// a user version number for this machine
	UserVersion int
	// true if this is a template. Template VMs can never be started, they are used only for cloning other VMs
	IsATemplate bool
	// The VDI that a suspend image is stored on. (Only has meaning if VM is currently suspended)
	SuspendVDI VDIRef
	// the host the VM is currently resident on
	ResidentOn HostRef
	// a host which the VM has some affinity for (or NULL). This is used as a hint to the start call when it decides where to run the VM. Implementations are free to ignore this field.
	Affinity HostRef
	// Virtualization memory overhead (bytes).
	MemoryOverhead int
	// Dynamically-set memory target (bytes). The value of this field indicates the current target for memory available to this VM.
	MemoryTarget int
	// Statically-set (i.e. absolute) maximum (bytes). The value of this field at VM start time acts as a hard limit of the amount of memory a guest can use. New values only take effect on reboot.
	MemoryStaticMax int
	// Dynamic maximum (bytes)
	MemoryDynamicMax int
	// Dynamic minimum (bytes)
	MemoryDynamicMin int
	// Statically-set (i.e. absolute) mininum (bytes). The value of this field indicates the least amount of memory this VM can boot with without crashing.
	MemoryStaticMin int
	// configuration parameters for the selected VCPU policy
	VCPUsParams map[string]string
	// Max number of VCPUs
	VCPUsMax int
	// Boot number of VCPUs
	VCPUsAtStartup int
	// action to take after the guest has shutdown itself
	ActionsAfterShutdown OnNormalExit
	// action to take after the guest has rebooted itself
	ActionsAfterReboot OnNormalExit
	// action to take if the guest crashes
	ActionsAfterCrash OnCrashBehaviour
	// virtual console devices
	Consoles []ConsoleRef
	// virtual network interfaces
	VIFs []VIFRef
	// virtual block devices
	VBDs []VBDRef
	// crash dumps associated with this VM
	CrashDumps []CrashdumpRef
	// virtual TPMs
	VTPMs []VTPMRef
	// name of or path to bootloader
	PVBootloader string
	// path to the kernel
	PVKernel string
	// path to the initrd
	PVRamdisk string
	// kernel command-line arguments
	PVArgs string
	// miscellaneous arguments for the bootloader
	PVBootloaderArgs string
	// to make Zurich guests boot
	PVLegacyArgs string
	// HVM boot policy
	HVMBootPolicy string
	// HVM boot params
	HVMBootParams map[string]string
	// multiplier applied to the amount of shadow that will be made available to the guest
	HVMShadowMultiplier float64
	// platform-specific configuration
	Platform map[string]string
	// PCI bus path for pass-through devices
	PCIBus string
	// additional configuration
	OtherConfig map[string]string
	// domain ID (if available, -1 otherwise)
	Domid int
	// Domain architecture (if available, null string otherwise)
	Domarch string
	// describes the CPU flags on which the VM was last booted
	LastBootCPUFlags map[string]string
	// true if this is a control domain (domain 0 or a driver domain)
	IsControlDomain bool
	// metrics associated with this VM
	Metrics VMMetricsRef
	// metrics associated with the running guest
	GuestMetrics VMGuestMetricsRef
	// marshalled value containing VM record at time of last boot, updated dynamically to reflect the runtime state of the domain
	LastBootedRecord string
	// An XML specification of recommended values and ranges for properties of this VM
	Recommendations string
	// data to be inserted into the xenstore tree (/local/domain/<domid>/vm-data) after the VM is created.
	XenstoreData map[string]string
	// if true then the system will attempt to keep the VM running as much as possible.
	HaAlwaysRun bool
	// has possible values: "best-effort" meaning "try to restart this VM if possible but don't consider the Pool to be overcommitted if this is not possible"; "restart" meaning "this VM should be restarted"; "" meaning "do not try to restart this VM"
	HaRestartPriority string
	// true if this is a snapshot. Snapshotted VMs can never be started, they are used only for cloning other VMs
	IsASnapshot bool
	// Ref pointing to the VM this snapshot is of.
	SnapshotOf VMRef
	// List pointing to all the VM snapshots.
	Snapshots []VMRef
	// Date/time when this snapshot was created.
	SnapshotTime time.Time
	// Transportable ID of the snapshot VM
	TransportableSnapshotID string
	// Binary blobs associated with this VM
	Blobs map[string]BlobRef
	// user-specified tags for categorization purposes
	Tags []string
	// List of operations which have been explicitly blocked and an error code
	BlockedOperations map[VMOperations]string
	// Human-readable information concerning this snapshot
	SnapshotInfo map[string]string
	// Encoded information about the VM's metadata this is a snapshot of
	SnapshotMetadata string
	// Ref pointing to the parent of this VM
	Parent VMRef
	// List pointing to all the children of this VM
	Children []VMRef
	// BIOS strings
	BiosStrings map[string]string
	// Ref pointing to a protection policy for this VM
	ProtectionPolicy VMPPRef
	// true if this snapshot was created by the protection policy
	IsSnapshotFromVmpp bool
	// the appliance to which this VM belongs
	Appliance VMApplianceRef
	// The delay to wait before proceeding to the next order in the startup sequence (seconds)
	StartDelay int
	// The delay to wait before proceeding to the next order in the shutdown sequence (seconds)
	ShutdownDelay int
	// The point in the startup or shutdown sequence at which this VM will be started
	Order int
	// Virtual GPUs
	VGPUs []VGPURef
	// Currently passed-through PCI devices
	AttachedPCIs []PCIRef
	// The SR on which a suspend image is stored
	SuspendSR SRRef
	// The number of times this VM has been recovered
	Version int
	// Generation ID of the VM
	GenerationID string
	// The host virtual hardware platform version the VM can run on
	HardwarePlatformVersion int
	// True if the Windows Update feature is enabled on the VM; false otherwise
	AutoUpdateDrivers bool
}

type VMRef 

type VMRef string

type VTPMClass 

type VTPMClass struct {
	// contains filtered or unexported fields
}

A virtual TPM device

func (VTPMClass) Create 

func (_class VTPMClass) Create(sessionID SessionRef, args VTPMRecord) (_retval VTPMRef, _err error)

Create a new VTPM instance, and return its handle. The constructor args are: VM*, backend* (* = non-optional).

func (VTPMClass) Destroy 

func (_class VTPMClass) Destroy(sessionID SessionRef, self VTPMRef) (_err error)

Destroy the specified VTPM instance.

func (VTPMClass) GetBackend 

func (_class VTPMClass) GetBackend(sessionID SessionRef, self VTPMRef) (_retval VMRef, _err error)

Get the backend field of the given VTPM.

func (VTPMClass) GetByUUID 

func (_class VTPMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VTPMRef, _err error)

Get a reference to the VTPM instance with the specified UUID.

func (VTPMClass) GetRecord 

func (_class VTPMClass) GetRecord(sessionID SessionRef, self VTPMRef) (_retval VTPMRecord, _err error)

Get a record containing the current state of the given VTPM.

func (VTPMClass) GetUUID 

func (_class VTPMClass) GetUUID(sessionID SessionRef, self VTPMRef) (_retval string, _err error)

Get the uuid field of the given VTPM.

func (VTPMClass) GetVM 

func (_class VTPMClass) GetVM(sessionID SessionRef, self VTPMRef) (_retval VMRef, _err error)

Get the VM field of the given VTPM.

type VTPMRecord 

type VTPMRecord struct {
	// Unique identifier/object reference
	UUID string
	// the virtual machine
	VM VMRef
	// the domain where the backend is located
	Backend VMRef
}

type VTPMRef 

type VTPMRef string

type VbdMode 

type VbdMode string
const (
	// only read-only access will be allowed
	VbdModeRO VbdMode = "RO"
	// read-write access will be allowed
	VbdModeRW VbdMode = "RW"
)

type VbdOperations 

type VbdOperations string
const (
	// Attempting to attach this VBD to a VM
	VbdOperationsAttach VbdOperations = "attach"
	// Attempting to eject the media from this VBD
	VbdOperationsEject VbdOperations = "eject"
	// Attempting to insert new media into this VBD
	VbdOperationsInsert VbdOperations = "insert"
	// Attempting to hotplug this VBD
	VbdOperationsPlug VbdOperations = "plug"
	// Attempting to hot unplug this VBD
	VbdOperationsUnplug VbdOperations = "unplug"
	// Attempting to forcibly unplug this VBD
	VbdOperationsUnplugForce VbdOperations = "unplug_force"
	// Attempting to pause a block device backend
	VbdOperationsPause VbdOperations = "pause"
	// Attempting to unpause a block device backend
	VbdOperationsUnpause VbdOperations = "unpause"
)

type VbdType 

type VbdType string
const (
	// VBD will appear to guest as CD
	VbdTypeCD VbdType = "CD"
	// VBD will appear to guest as disk
	VbdTypeDisk VbdType = "Disk"
	// VBD will appear as a floppy
	VbdTypeFloppy VbdType = "Floppy"
)

type VdiOperations 

type VdiOperations string
const (
	// Scanning backends for new or deleted VDIs
	VdiOperationsScan VdiOperations = "scan"
	// Cloning the VDI
	VdiOperationsClone VdiOperations = "clone"
	// Copying the VDI
	VdiOperationsCopy VdiOperations = "copy"
	// Resizing the VDI
	VdiOperationsResize VdiOperations = "resize"
	// Resizing the VDI which may or may not be online
	VdiOperationsResizeOnline VdiOperations = "resize_online"
	// Snapshotting the VDI
	VdiOperationsSnapshot VdiOperations = "snapshot"
	// Destroying the VDI
	VdiOperationsDestroy VdiOperations = "destroy"
	// Forget about the VDI
	VdiOperationsForget VdiOperations = "forget"
	// Refreshing the fields of the VDI
	VdiOperationsUpdate VdiOperations = "update"
	// Forcibly unlocking the VDI
	VdiOperationsForceUnlock VdiOperations = "force_unlock"
	// Generating static configuration
	VdiOperationsGenerateConfig VdiOperations = "generate_config"
	// Operations on this VDI are temporarily blocked
	VdiOperationsBlocked VdiOperations = "blocked"
)

type VdiType 

type VdiType string
const (
	// a disk that may be replaced on upgrade
	VdiTypeSystem VdiType = "system"
	// a disk that is always preserved on upgrade
	VdiTypeUser VdiType = "user"
	// a disk that may be reformatted on upgrade
	VdiTypeEphemeral VdiType = "ephemeral"
	// a disk that stores a suspend image
	VdiTypeSuspend VdiType = "suspend"
	// a disk that stores VM crashdump information
	VdiTypeCrashdump VdiType = "crashdump"
	// a disk used for HA storage heartbeating
	VdiTypeHaStatefile VdiType = "ha_statefile"
	// a disk used for HA Pool metadata
	VdiTypeMetadata VdiType = "metadata"
	// a disk used for a general metadata redo-log
	VdiTypeRedoLog VdiType = "redo_log"
	// a disk that stores SR-level RRDs
	VdiTypeRrd VdiType = "rrd"
)

type VgpuTypeImplementation 

type VgpuTypeImplementation string
const (
	// Pass through an entire physical GPU to a guest
	VgpuTypeImplementationPassthrough VgpuTypeImplementation = "passthrough"
	// vGPU using NVIDIA hardware
	VgpuTypeImplementationNvidia VgpuTypeImplementation = "nvidia"
	// vGPU using Intel GVT-g
	VgpuTypeImplementationGvtG VgpuTypeImplementation = "gvt_g"
)

type VifLockingMode 

type VifLockingMode string
const (
	// No specific configuration set - default network policy applies
	VifLockingModeNetworkDefault VifLockingMode = "network_default"
	// Only traffic to a specific MAC and a list of IPv4 or IPv6 addresses is permitted
	VifLockingModeLocked VifLockingMode = "locked"
	// All traffic is permitted
	VifLockingModeUnlocked VifLockingMode = "unlocked"
	// No traffic is permitted
	VifLockingModeDisabled VifLockingMode = "disabled"
)

type VifOperations 

type VifOperations string
const (
	// Attempting to attach this VIF to a VM
	VifOperationsAttach VifOperations = "attach"
	// Attempting to hotplug this VIF
	VifOperationsPlug VifOperations = "plug"
	// Attempting to hot unplug this VIF
	VifOperationsUnplug VifOperations = "unplug"
)

type VmppArchiveFrequency 

type VmppArchiveFrequency string
const (
	// Never archive
	VmppArchiveFrequencyNever VmppArchiveFrequency = "never"
	// Archive after backup
	VmppArchiveFrequencyAlwaysAfterBackup VmppArchiveFrequency = "always_after_backup"
	// Daily archives
	VmppArchiveFrequencyDaily VmppArchiveFrequency = "daily"
	// Weekly backups
	VmppArchiveFrequencyWeekly VmppArchiveFrequency = "weekly"
)

type VmppArchiveTargetType 

type VmppArchiveTargetType string
const (
	// No target config
	VmppArchiveTargetTypeNone VmppArchiveTargetType = "none"
	// CIFS target config
	VmppArchiveTargetTypeCifs VmppArchiveTargetType = "cifs"
	// NFS target config
	VmppArchiveTargetTypeNfs VmppArchiveTargetType = "nfs"
)

type VmppBackupFrequency 

type VmppBackupFrequency string
const (
	// Hourly backups
	VmppBackupFrequencyHourly VmppBackupFrequency = "hourly"
	// Daily backups
	VmppBackupFrequencyDaily VmppBackupFrequency = "daily"
	// Weekly backups
	VmppBackupFrequencyWeekly VmppBackupFrequency = "weekly"
)

type VmppBackupType 

type VmppBackupType string
const (
	// The backup is a snapshot
	VmppBackupTypeSnapshot VmppBackupType = "snapshot"
	// The backup is a checkpoint
	VmppBackupTypeCheckpoint VmppBackupType = "checkpoint"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.