xenapi

package module
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2024 License: MIT Imports: 7 Imported by: 0

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

GetGroupMembership 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)

GetSubjectIdentifier 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)

GetSubjectInformationFromIdentifier 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 Create a placeholder for a binary blob

func (BlobClass) Destroy 

func (_class BlobClass) Destroy(sessionID SessionRef, self BlobRef) (_err error)

Destroy

func (BlobClass) GetAll 

func (_class BlobClass) GetAll(sessionID SessionRef) (_retval []BlobRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByNameLabel Get all the blob instances with the given label.

func (BlobClass) GetByUUID 

func (_class BlobClass) GetByUUID(sessionID SessionRef, uuid string) (_retval BlobRef, _err error)

GetByUUID 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)

GetLastUpdated Get the last_updated field of the given blob.

func (BlobClass) GetMimeType 

func (_class BlobClass) GetMimeType(sessionID SessionRef, self BlobRef) (_retval string, _err error)

GetMimeType Get the mime_type field of the given blob.

func (BlobClass) GetNameDescription 

func (_class BlobClass) GetNameDescription(sessionID SessionRef, self BlobRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given blob.

func (BlobClass) GetNameLabel 

func (_class BlobClass) GetNameLabel(sessionID SessionRef, self BlobRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given blob.

func (BlobClass) GetPublic 

func (_class BlobClass) GetPublic(sessionID SessionRef, self BlobRef) (_retval bool, _err error)

GetPublic Get the public field of the given blob.

func (BlobClass) GetRecord 

func (_class BlobClass) GetRecord(sessionID SessionRef, self BlobRef) (_retval BlobRecord, _err error)

GetRecord 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)

GetSize Get the size field of the given blob.

func (BlobClass) GetUUID 

func (_class BlobClass) GetUUID(sessionID SessionRef, self BlobRef) (_retval string, _err error)

GetUUID Get the uuid field of the given blob.

func (BlobClass) SetNameDescription 

func (_class BlobClass) SetNameDescription(sessionID SessionRef, self BlobRef, value string) (_err error)

SetNameDescription Set the name/description field of the given blob.

func (BlobClass) SetNameLabel 

func (_class BlobClass) SetNameLabel(sessionID SessionRef, self BlobRef, value string) (_err error)

SetNameLabel Set the name/label field of the given blob.

func (BlobClass) SetPublic 

func (_class BlobClass) SetPublic(sessionID SessionRef, self BlobRef, value bool) (_err error)

SetPublic 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)

AddToOtherConfig 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 Create an interface bond

func (BondClass) Destroy 

func (_class BondClass) Destroy(sessionID SessionRef, self BondRef) (_err error)

Destroy Destroy an interface bond

func (BondClass) GetAll 

func (_class BondClass) GetAll(sessionID SessionRef) (_retval []BondRef, _err error)

GetAll 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)

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

func (BondClass) GetAutoUpdateMac 

func (_class BondClass) GetAutoUpdateMac(sessionID SessionRef, self BondRef) (_retval bool, _err error)

GetAutoUpdateMac Get the auto_update_mac field of the given Bond.

func (BondClass) GetByUUID 

func (_class BondClass) GetByUUID(sessionID SessionRef, uuid string) (_retval BondRef, _err error)

GetByUUID 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)

GetLinksUp Get the links_up field of the given Bond.

func (BondClass) GetMaster 

func (_class BondClass) GetMaster(sessionID SessionRef, self BondRef) (_retval PIFRef, _err error)

GetMaster Get the master field of the given Bond.

func (BondClass) GetMode 

func (_class BondClass) GetMode(sessionID SessionRef, self BondRef) (_retval BondMode, _err error)

GetMode 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)

GetOtherConfig Get the other_config field of the given Bond.

func (BondClass) GetPrimarySlave 

func (_class BondClass) GetPrimarySlave(sessionID SessionRef, self BondRef) (_retval PIFRef, _err error)

GetPrimarySlave 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)

GetProperties Get the properties field of the given Bond.

func (BondClass) GetRecord 

func (_class BondClass) GetRecord(sessionID SessionRef, self BondRef) (_retval BondRecord, _err error)

GetRecord 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)

GetSlaves Get the slaves field of the given Bond.

func (BondClass) GetUUID 

func (_class BondClass) GetUUID(sessionID SessionRef, self BondRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Bond.

func (BondClass) RemoveFromOtherConfig 

func (_class BondClass) RemoveFromOtherConfig(sessionID SessionRef, self BondRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetMode Change the bond mode

func (BondClass) SetOtherConfig 

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

SetOtherConfig 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)

SetProperty 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
	// true if the MAC was taken from the primary slave when the bond was created, and false if the client specified the MAC
	AutoUpdateMac bool
}

type BondRef 

type BondRef string

type CertificateClass 

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

Description

func (CertificateClass) GetAll 

func (_class CertificateClass) GetAll(sessionID SessionRef) (_retval []CertificateRef, _err error)

GetAll Return a list of all the Certificates known to the system.

func (CertificateClass) GetAllRecords 

func (_class CertificateClass) GetAllRecords(sessionID SessionRef) (_retval map[CertificateRef]CertificateRecord, _err error)

GetAllRecords Return a map of Certificate references to Certificate records for all Certificates known to the system.

func (CertificateClass) GetByUUID 

func (_class CertificateClass) GetByUUID(sessionID SessionRef, uuid string) (_retval CertificateRef, _err error)

GetByUUID Get a reference to the Certificate instance with the specified UUID.

func (CertificateClass) GetFingerprint 

func (_class CertificateClass) GetFingerprint(sessionID SessionRef, self CertificateRef) (_retval string, _err error)

GetFingerprint Get the fingerprint field of the given Certificate.

func (CertificateClass) GetHost 

func (_class CertificateClass) GetHost(sessionID SessionRef, self CertificateRef) (_retval HostRef, _err error)

GetHost Get the host field of the given Certificate.

func (CertificateClass) GetName 

func (_class CertificateClass) GetName(sessionID SessionRef, self CertificateRef) (_retval string, _err error)

GetName Get the name field of the given Certificate.

func (CertificateClass) GetNotAfter 

func (_class CertificateClass) GetNotAfter(sessionID SessionRef, self CertificateRef) (_retval time.Time, _err error)

GetNotAfter Get the not_after field of the given Certificate.

func (CertificateClass) GetNotBefore 

func (_class CertificateClass) GetNotBefore(sessionID SessionRef, self CertificateRef) (_retval time.Time, _err error)

GetNotBefore Get the not_before field of the given Certificate.

func (CertificateClass) GetRecord 

func (_class CertificateClass) GetRecord(sessionID SessionRef, self CertificateRef) (_retval CertificateRecord, _err error)

GetRecord Get a record containing the current state of the given Certificate.

func (CertificateClass) GetType 

func (_class CertificateClass) GetType(sessionID SessionRef, self CertificateRef) (_retval CertificateType, _err error)

GetType Get the type field of the given Certificate.

func (CertificateClass) GetUUID 

func (_class CertificateClass) GetUUID(sessionID SessionRef, self CertificateRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Certificate.

type CertificateRecord 

type CertificateRecord struct {
	// Unique identifier/object reference
	UUID string
	// The name of the certificate, only present on certificates of type 'ca'
	Name string
	// The type of the certificate, either 'ca', 'host' or 'host_internal'
	Type CertificateType
	// The host where the certificate is installed
	Host HostRef
	// Date after which the certificate is valid
	NotBefore time.Time
	// Date before which the certificate is valid
	NotAfter time.Time
	// The certificate's fingerprint / hash
	Fingerprint string
}

type CertificateRef 

type CertificateRef string

type CertificateType 

type CertificateType string
const (
	// Certificate that is trusted by the whole pool
	CertificateTypeCa CertificateType = "ca"
	// Certificate that identifies a single host to entities outside the pool
	CertificateTypeHost CertificateType = "host"
	// Certificate that identifies a single host to other pool members
	CertificateTypeHostInternal CertificateType = "host_internal"
)

type Client 

type Client struct {
	Session          SessionClass
	Auth             AuthClass
	Subject          SubjectClass
	Role             RoleClass
	Task             TaskClass
	Event            EventClass
	Pool             PoolClass
	PoolPatch        PoolPatchClass
	PoolUpdate       PoolUpdateClass
	VM               VMClass
	VMMetrics        VMMetricsClass
	VMGuestMetrics   VMGuestMetricsClass
	VMPP             VMPPClass
	VMSS             VMSSClass
	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
	SrStat           SrStatClass
	ProbeResult      ProbeResultClass
	LVHD             LVHDClass
	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
	NetworkSriov     NetworkSriovClass
	PCI              PCIClass
	PGPU             PGPUClass
	GPUGroup         GPUGroupClass
	VGPU             VGPUClass
	VGPUType         VGPUTypeClass
	PVSSite          PVSSiteClass
	PVSServer        PVSServerClass
	PVSProxy         PVSProxyClass
	PVSCacheStorage  PVSCacheStorageClass
	Feature          FeatureClass
	SDNController    SDNControllerClass
	VdiNbdServerInfo VdiNbdServerInfoClass
	PUSB             PUSBClass
	USBGroup         USBGroupClass
	VUSB             VUSBClass
	Cluster          ClusterClass
	ClusterHost      ClusterHostClass
	Certificate      CertificateClass
	Repository       RepositoryClass
	Observer         ObserverClass
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(url string, transport *http.Transport) (*Client, error)

func (*Client) APICall 

func (client *Client) APICall(method string, params ...interface{}) (result APIResult, err error)

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"
	// VMSS
	ClsVMSS Cls = "VMSS"
	// PVS_proxy
	ClsPVSProxy Cls = "PVS_proxy"
	// VDI
	ClsVDI Cls = "VDI"
	// Certificate
	ClsCertificate Cls = "Certificate"
)

type ClusterClass 

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

Cluster-wide Cluster metadata

func (ClusterClass) AddToOtherConfig 

func (_class ClusterClass) AddToOtherConfig(sessionID SessionRef, self ClusterRef, key string, value string) (_err error)

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

func (ClusterClass) Create 

func (_class ClusterClass) Create(sessionID SessionRef, pif PIFRef, clusterStack string, poolAutoJoin bool, tokenTimeout float64, tokenTimeoutCoefficient float64) (_retval ClusterRef, _err error)

Create Creates a Cluster object and one Cluster_host object as its first member

Errors: 

INVALID_CLUSTER_STACK - The cluster stack provided is not supported.
INVALID_VALUE - The value given is invalid
PIF_ALLOWS_UNPLUG - The operation you requested cannot be performed because the specified PIF allows unplug.
REQUIRED_PIF_IS_UNPLUGGED - The operation you requested cannot be performed because the specified PIF is currently unplugged.

func (ClusterClass) Destroy 

func (_class ClusterClass) Destroy(sessionID SessionRef, self ClusterRef) (_err error)

Destroy Destroys a Cluster object and the one remaining Cluster_host member

Errors: 

CLUSTER_DOES_NOT_HAVE_ONE_NODE - An operation failed as it expected the cluster to have only one node but found multiple cluster_hosts.
CLUSTER_STACK_IN_USE - The cluster stack is still in use by at least one plugged PBD.

func (ClusterClass) GetAll 

func (_class ClusterClass) GetAll(sessionID SessionRef) (_retval []ClusterRef, _err error)

GetAll Return a list of all the Clusters known to the system.

func (ClusterClass) GetAllRecords 

func (_class ClusterClass) GetAllRecords(sessionID SessionRef) (_retval map[ClusterRef]ClusterRecord, _err error)

GetAllRecords Return a map of Cluster references to Cluster records for all Clusters known to the system.

func (ClusterClass) GetAllowedOperations 

func (_class ClusterClass) GetAllowedOperations(sessionID SessionRef, self ClusterRef) (_retval []ClusterOperation, _err error)

GetAllowedOperations Get the allowed_operations field of the given Cluster.

func (ClusterClass) GetByUUID 

func (_class ClusterClass) GetByUUID(sessionID SessionRef, uuid string) (_retval ClusterRef, _err error)

GetByUUID Get a reference to the Cluster instance with the specified UUID.

func (ClusterClass) GetClusterConfig 

func (_class ClusterClass) GetClusterConfig(sessionID SessionRef, self ClusterRef) (_retval map[string]string, _err error)

GetClusterConfig Get the cluster_config field of the given Cluster.

func (ClusterClass) GetClusterHosts 

func (_class ClusterClass) GetClusterHosts(sessionID SessionRef, self ClusterRef) (_retval []ClusterHostRef, _err error)

GetClusterHosts Get the cluster_hosts field of the given Cluster.

func (ClusterClass) GetClusterStack 

func (_class ClusterClass) GetClusterStack(sessionID SessionRef, self ClusterRef) (_retval string, _err error)

GetClusterStack Get the cluster_stack field of the given Cluster.

func (ClusterClass) GetClusterToken 

func (_class ClusterClass) GetClusterToken(sessionID SessionRef, self ClusterRef) (_retval string, _err error)

GetClusterToken Get the cluster_token field of the given Cluster.

func (ClusterClass) GetCurrentOperations 

func (_class ClusterClass) GetCurrentOperations(sessionID SessionRef, self ClusterRef) (_retval map[string]ClusterOperation, _err error)

GetCurrentOperations Get the current_operations field of the given Cluster.

func (ClusterClass) GetNetwork 

func (_class ClusterClass) GetNetwork(sessionID SessionRef, self ClusterRef) (_retval NetworkRef, _err error)

GetNetwork Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs

func (ClusterClass) GetOtherConfig 

func (_class ClusterClass) GetOtherConfig(sessionID SessionRef, self ClusterRef) (_retval map[string]string, _err error)

GetOtherConfig Get the other_config field of the given Cluster.

func (ClusterClass) GetPendingForget 

func (_class ClusterClass) GetPendingForget(sessionID SessionRef, self ClusterRef) (_retval []string, _err error)

GetPendingForget Get the pending_forget field of the given Cluster.

func (ClusterClass) GetPoolAutoJoin 

func (_class ClusterClass) GetPoolAutoJoin(sessionID SessionRef, self ClusterRef) (_retval bool, _err error)

GetPoolAutoJoin Get the pool_auto_join field of the given Cluster.

func (ClusterClass) GetRecord 

func (_class ClusterClass) GetRecord(sessionID SessionRef, self ClusterRef) (_retval ClusterRecord, _err error)

GetRecord Get a record containing the current state of the given Cluster.

func (ClusterClass) GetTokenTimeout 

func (_class ClusterClass) GetTokenTimeout(sessionID SessionRef, self ClusterRef) (_retval float64, _err error)

GetTokenTimeout Get the token_timeout field of the given Cluster.

func (ClusterClass) GetTokenTimeoutCoefficient 

func (_class ClusterClass) GetTokenTimeoutCoefficient(sessionID SessionRef, self ClusterRef) (_retval float64, _err error)

GetTokenTimeoutCoefficient Get the token_timeout_coefficient field of the given Cluster.

func (ClusterClass) GetUUID 

func (_class ClusterClass) GetUUID(sessionID SessionRef, self ClusterRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Cluster.

func (ClusterClass) PoolCreate 

func (_class ClusterClass) PoolCreate(sessionID SessionRef, network NetworkRef, clusterStack string, tokenTimeout float64, tokenTimeoutCoefficient float64) (_retval ClusterRef, _err error)

PoolCreate Attempt to create a Cluster from the entire pool

func (ClusterClass) PoolDestroy 

func (_class ClusterClass) PoolDestroy(sessionID SessionRef, self ClusterRef) (_err error)

PoolDestroy Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.

Errors: 

CLUSTER_STACK_IN_USE - The cluster stack is still in use by at least one plugged PBD.
CLUSTERING_DISABLED - An operation was attempted while clustering was disabled on the cluster_host.
CLUSTER_HOST_IS_LAST - The last cluster host cannot be destroyed. Destroy the cluster instead

func (ClusterClass) PoolForceDestroy 

func (_class ClusterClass) PoolForceDestroy(sessionID SessionRef, self ClusterRef) (_err error)

PoolForceDestroy Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.

Errors: 

CLUSTER_FORCE_DESTROY_FAILED - Force destroy failed on a Cluster_host while force destroying the cluster.

func (ClusterClass) PoolResync 

func (_class ClusterClass) PoolResync(sessionID SessionRef, self ClusterRef) (_err error)

PoolResync Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them

func (ClusterClass) RemoveFromOtherConfig 

func (_class ClusterClass) RemoveFromOtherConfig(sessionID SessionRef, self ClusterRef, key string) (_err error)

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

func (ClusterClass) SetOtherConfig 

func (_class ClusterClass) SetOtherConfig(sessionID SessionRef, self ClusterRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given Cluster.

type ClusterHostClass 

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

Cluster member metadata

func (ClusterHostClass) Create 

func (_class ClusterHostClass) Create(sessionID SessionRef, cluster ClusterRef, host HostRef, pif PIFRef) (_retval ClusterHostRef, _err error)

Create Add a new host to an existing cluster.

Errors: 

PIF_NOT_ATTACHED_TO_HOST - Cluster_host creation failed as the PIF provided is not attached to the host.
NO_CLUSTER_HOSTS_REACHABLE - No other cluster host was reachable when joining

func (ClusterHostClass) Destroy 

func (_class ClusterHostClass) Destroy(sessionID SessionRef, self ClusterHostRef) (_err error)

Destroy Remove a host from an existing cluster.

Errors: 

CLUSTER_STACK_IN_USE - The cluster stack is still in use by at least one plugged PBD.
CLUSTERING_DISABLED - An operation was attempted while clustering was disabled on the cluster_host.
CLUSTER_HOST_IS_LAST - The last cluster host cannot be destroyed. Destroy the cluster instead

func (ClusterHostClass) Disable 

func (_class ClusterHostClass) Disable(sessionID SessionRef, self ClusterHostRef) (_err error)

Disable Disable cluster membership for an enabled cluster host.

Errors: 

CLUSTER_STACK_IN_USE - The cluster stack is still in use by at least one plugged PBD.

func (ClusterHostClass) Enable 

func (_class ClusterHostClass) Enable(sessionID SessionRef, self ClusterHostRef) (_err error)

Enable Enable cluster membership for a disabled cluster host.

Errors: 

PIF_ALLOWS_UNPLUG - The operation you requested cannot be performed because the specified PIF allows unplug.
REQUIRED_PIF_IS_UNPLUGGED - The operation you requested cannot be performed because the specified PIF is currently unplugged.

func (ClusterHostClass) ForceDestroy 

func (_class ClusterHostClass) ForceDestroy(sessionID SessionRef, self ClusterHostRef) (_err error)

ForceDestroy Remove a host from an existing cluster forcefully.

Errors: 

CLUSTER_STACK_IN_USE - The cluster stack is still in use by at least one plugged PBD.

func (ClusterHostClass) GetAll 

func (_class ClusterHostClass) GetAll(sessionID SessionRef) (_retval []ClusterHostRef, _err error)

GetAll Return a list of all the Cluster_hosts known to the system.

func (ClusterHostClass) GetAllRecords 

func (_class ClusterHostClass) GetAllRecords(sessionID SessionRef) (_retval map[ClusterHostRef]ClusterHostRecord, _err error)

GetAllRecords Return a map of Cluster_host references to Cluster_host records for all Cluster_hosts known to the system.

func (ClusterHostClass) GetAllowedOperations 

func (_class ClusterHostClass) GetAllowedOperations(sessionID SessionRef, self ClusterHostRef) (_retval []ClusterHostOperation, _err error)

GetAllowedOperations Get the allowed_operations field of the given Cluster_host.

func (ClusterHostClass) GetByUUID 

func (_class ClusterHostClass) GetByUUID(sessionID SessionRef, uuid string) (_retval ClusterHostRef, _err error)

GetByUUID Get a reference to the Cluster_host instance with the specified UUID.

func (ClusterHostClass) GetCluster 

func (_class ClusterHostClass) GetCluster(sessionID SessionRef, self ClusterHostRef) (_retval ClusterRef, _err error)

GetCluster Get the cluster field of the given Cluster_host.

func (ClusterHostClass) GetCurrentOperations 

func (_class ClusterHostClass) GetCurrentOperations(sessionID SessionRef, self ClusterHostRef) (_retval map[string]ClusterHostOperation, _err error)

GetCurrentOperations Get the current_operations field of the given Cluster_host.

func (ClusterHostClass) GetEnabled 

func (_class ClusterHostClass) GetEnabled(sessionID SessionRef, self ClusterHostRef) (_retval bool, _err error)

GetEnabled Get the enabled field of the given Cluster_host.

func (ClusterHostClass) GetHost 

func (_class ClusterHostClass) GetHost(sessionID SessionRef, self ClusterHostRef) (_retval HostRef, _err error)

GetHost Get the host field of the given Cluster_host.

func (ClusterHostClass) GetJoined 

func (_class ClusterHostClass) GetJoined(sessionID SessionRef, self ClusterHostRef) (_retval bool, _err error)

GetJoined Get the joined field of the given Cluster_host.

func (ClusterHostClass) GetOtherConfig 

func (_class ClusterHostClass) GetOtherConfig(sessionID SessionRef, self ClusterHostRef) (_retval map[string]string, _err error)

GetOtherConfig Get the other_config field of the given Cluster_host.

func (ClusterHostClass) GetPIF 

func (_class ClusterHostClass) GetPIF(sessionID SessionRef, self ClusterHostRef) (_retval PIFRef, _err error)

GetPIF Get the PIF field of the given Cluster_host.

func (ClusterHostClass) GetRecord 

func (_class ClusterHostClass) GetRecord(sessionID SessionRef, self ClusterHostRef) (_retval ClusterHostRecord, _err error)

GetRecord Get a record containing the current state of the given Cluster_host.

func (ClusterHostClass) GetUUID 

func (_class ClusterHostClass) GetUUID(sessionID SessionRef, self ClusterHostRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Cluster_host.

type ClusterHostOperation 

type ClusterHostOperation string
const (
	// enabling cluster membership on a particular host
	ClusterHostOperationEnable ClusterHostOperation = "enable"
	// disabling cluster membership on a particular host
	ClusterHostOperationDisable ClusterHostOperation = "disable"
	// completely destroying a cluster host
	ClusterHostOperationDestroy ClusterHostOperation = "destroy"
)

type ClusterHostRecord 

type ClusterHostRecord struct {
	// Unique identifier/object reference
	UUID string
	// Reference to the Cluster object
	Cluster ClusterRef
	// Reference to the Host object
	Host HostRef
	// Whether the cluster host believes that clustering should be enabled on this host
	Enabled bool
	// Reference to the PIF object
	PIF PIFRef
	// Whether the cluster host has joined the cluster
	Joined bool
	// 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 []ClusterHostOperation
	// 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]ClusterHostOperation
	// Additional configuration
	OtherConfig map[string]string
}

type ClusterHostRef 

type ClusterHostRef string

type ClusterOperation 

type ClusterOperation string
const (
	// adding a new member to the cluster
	ClusterOperationAdd ClusterOperation = "add"
	// removing a member from the cluster
	ClusterOperationRemove ClusterOperation = "remove"
	// enabling any cluster member
	ClusterOperationEnable ClusterOperation = "enable"
	// disabling any cluster member
	ClusterOperationDisable ClusterOperation = "disable"
	// completely destroying a cluster
	ClusterOperationDestroy ClusterOperation = "destroy"
)

type ClusterRecord 

type ClusterRecord struct {
	// Unique identifier/object reference
	UUID string
	// A list of the cluster_host objects associated with the Cluster
	ClusterHosts []ClusterHostRef
	// Internal field used by Host.destroy to store the IP of cluster members marked as permanently dead but not yet removed
	PendingForget []string
	// The secret key used by xapi-clusterd when it talks to itself on other hosts
	ClusterToken string
	// Simply the string 'corosync'. No other cluster stacks are currently supported
	ClusterStack 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 []ClusterOperation
	// 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]ClusterOperation
	// True if automatically joining new pool members to the cluster. This will be `true` in the first release
	PoolAutoJoin bool
	// The corosync token timeout in seconds
	TokenTimeout float64
	// The corosync token timeout coefficient in seconds
	TokenTimeoutCoefficient float64
	// Contains read-only settings for the cluster, such as timeouts and other options. It can only be set at cluster create time
	ClusterConfig map[string]string
	// Additional configuration
	OtherConfig map[string]string
}

type ClusterRef 

type ClusterRef string

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)

AddToOtherConfig 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 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 Destroy the specified console instance.

func (ConsoleClass) GetAll 

func (_class ConsoleClass) GetAll(sessionID SessionRef) (_retval []ConsoleRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetLocation 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)

GetOtherConfig Get the other_config field of the given console.

func (ConsoleClass) GetProtocol 

func (_class ConsoleClass) GetProtocol(sessionID SessionRef, self ConsoleRef) (_retval ConsoleProtocol, _err error)

GetProtocol Get the protocol field of the given console.

func (ConsoleClass) GetRecord 

func (_class ConsoleClass) GetRecord(sessionID SessionRef, self ConsoleRef) (_retval ConsoleRecord, _err error)

GetRecord 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)

GetUUID Get the uuid field of the given console.

func (ConsoleClass) GetVM 

func (_class ConsoleClass) GetVM(sessionID SessionRef, self ConsoleRef) (_retval VMRef, _err error)

GetVM Get the VM field of the given console.

func (ConsoleClass) RemoveFromOtherConfig 

func (_class ConsoleClass) RemoveFromOtherConfig(sessionID SessionRef, self ConsoleRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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)

AddToOtherConfig 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 Destroy the specified crashdump

func (CrashdumpClass) GetAll 

func (_class CrashdumpClass) GetAll(sessionID SessionRef) (_retval []CrashdumpRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetOtherConfig Get the other_config field of the given crashdump.

func (CrashdumpClass) GetRecord 

func (_class CrashdumpClass) GetRecord(sessionID SessionRef, self CrashdumpRef) (_retval CrashdumpRecord, _err error)

GetRecord 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)

GetUUID Get the uuid field of the given crashdump.

func (CrashdumpClass) GetVDI 

func (_class CrashdumpClass) GetVDI(sessionID SessionRef, self CrashdumpRef) (_retval VDIRef, _err error)

GetVDI Get the VDI field of the given crashdump.

func (CrashdumpClass) GetVM 

func (_class CrashdumpClass) GetVM(sessionID SessionRef, self CrashdumpRef) (_retval VMRef, _err error)

GetVM Get the VM field of the given crashdump.

func (CrashdumpClass) RemoveFromOtherConfig 

func (_class CrashdumpClass) RemoveFromOtherConfig(sessionID SessionRef, self CrashdumpRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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 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 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetIntroducedSRs 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)

GetRecord 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)

GetUUID 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 DomainType 

type DomainType string
const (
	// HVM; Fully Virtualised
	DomainTypeHvm DomainType = "hvm"
	// PV: Paravirtualised
	DomainTypePv DomainType = "pv"
	// PV inside a PVH container
	DomainTypePvInPvh DomainType = "pv_in_pvh"
	// PVH
	DomainTypePvh DomainType = "pvh"
	// Not specified or unknown domain type
	DomainTypeUnspecified DomainType = "unspecified"
)

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 EventBatch 

type EventBatch struct {
	Token          string
	ValidRefCounts map[string]int
	Events         []EventRecord
}

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 EventBatch, _err error)

From 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)

GetCurrentID 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)

Inject Injects an artificial event on the given object and returns the corresponding ID in the form of a token, which can be used as a point of reference for database events. For example, to check whether an object has reached the right state before attempting an operation, one can inject an artificial event on the object and wait until the token returned by consecutive event.from calls is lexicographically greater than the one returned by event.inject.

func (EventClass) Next 

func (_class EventClass) Next(sessionID SessionRef) (_retval []EventRecord, _err error)

Next 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)

Register Registers this session with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next.

func (EventClass) Unregister 

func (_class EventClass) Unregister(sessionID SessionRef, classes []string) (_err error)

Unregister Removes this session's registration with the event system for a set of given classes. This method is only recommended for legacy use in conjunction with event.next.

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 {
	// The record of the database object that was added, changed or deleted
	Snapshot RecordInterface
	// An ID, monotonically increasing, and local to the current session
	ID int
	// The time at which the event occurred
	Timestamp time.Time
	// 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 FeatureClass 

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

A new piece of functionality

func (FeatureClass) GetAll 

func (_class FeatureClass) GetAll(sessionID SessionRef) (_retval []FeatureRef, _err error)

GetAll Return a list of all the Features known to the system.

func (FeatureClass) GetAllRecords 

func (_class FeatureClass) GetAllRecords(sessionID SessionRef) (_retval map[FeatureRef]FeatureRecord, _err error)

GetAllRecords Return a map of Feature references to Feature records for all Features known to the system.

func (FeatureClass) GetByNameLabel 

func (_class FeatureClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []FeatureRef, _err error)

GetByNameLabel Get all the Feature instances with the given label.

func (FeatureClass) GetByUUID 

func (_class FeatureClass) GetByUUID(sessionID SessionRef, uuid string) (_retval FeatureRef, _err error)

GetByUUID Get a reference to the Feature instance with the specified UUID.

func (FeatureClass) GetEnabled 

func (_class FeatureClass) GetEnabled(sessionID SessionRef, self FeatureRef) (_retval bool, _err error)

GetEnabled Get the enabled field of the given Feature.

func (FeatureClass) GetExperimental 

func (_class FeatureClass) GetExperimental(sessionID SessionRef, self FeatureRef) (_retval bool, _err error)

GetExperimental Get the experimental field of the given Feature.

func (FeatureClass) GetHost 

func (_class FeatureClass) GetHost(sessionID SessionRef, self FeatureRef) (_retval HostRef, _err error)

GetHost Get the host field of the given Feature.

func (FeatureClass) GetNameDescription 

func (_class FeatureClass) GetNameDescription(sessionID SessionRef, self FeatureRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given Feature.

func (FeatureClass) GetNameLabel 

func (_class FeatureClass) GetNameLabel(sessionID SessionRef, self FeatureRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given Feature.

func (FeatureClass) GetRecord 

func (_class FeatureClass) GetRecord(sessionID SessionRef, self FeatureRef) (_retval FeatureRecord, _err error)

GetRecord Get a record containing the current state of the given Feature.

func (FeatureClass) GetUUID 

func (_class FeatureClass) GetUUID(sessionID SessionRef, self FeatureRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Feature.

func (FeatureClass) GetVersion 

func (_class FeatureClass) GetVersion(sessionID SessionRef, self FeatureRef) (_retval string, _err error)

GetVersion Get the version field of the given Feature.

type FeatureRecord 

type FeatureRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Indicates whether the feature is enabled
	Enabled bool
	// Indicates whether the feature is experimental (as opposed to stable and fully supported)
	Experimental bool
	// The version of this feature
	Version string
	// The host where this feature is available
	Host HostRef
}

type FeatureRef 

type FeatureRef 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)

AddToOtherConfig 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)

Create

func (GPUGroupClass) Destroy 

func (_class GPUGroupClass) Destroy(sessionID SessionRef, self GPUGroupRef) (_err error)

Destroy

func (GPUGroupClass) GetAll 

func (_class GPUGroupClass) GetAll(sessionID SessionRef) (_retval []GPUGroupRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllocationAlgorithm 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)

GetByNameLabel 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)

GetByUUID 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)

GetEnabledVGPUTypes 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)

GetGPUTypes 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)

GetNameDescription 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)

GetNameLabel 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)

GetOtherConfig 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)

GetPGPUs Get the PGPUs field of the given GPU_group.

func (GPUGroupClass) GetRecord 

func (_class GPUGroupClass) GetRecord(sessionID SessionRef, self GPUGroupRef) (_retval GPUGroupRecord, _err error)

GetRecord 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)

GetRemainingCapacity

func (GPUGroupClass) GetSupportedVGPUTypes 

func (_class GPUGroupClass) GetSupportedVGPUTypes(sessionID SessionRef, self GPUGroupRef) (_retval []VGPUTypeRef, _err error)

GetSupportedVGPUTypes 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)

GetUUID Get the uuid field of the given GPU_group.

func (GPUGroupClass) GetVGPUs 

func (_class GPUGroupClass) GetVGPUs(sessionID SessionRef, self GPUGroupRef) (_retval []VGPURef, _err error)

GetVGPUs Get the VGPUs field of the given GPU_group.

func (GPUGroupClass) RemoveFromOtherConfig 

func (_class GPUGroupClass) RemoveFromOtherConfig(sessionID SessionRef, self GPUGroupRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetAllocationAlgorithm 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)

SetNameDescription 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)

SetNameLabel 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)

SetOtherConfig 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"
	// Indicates this host is being updated
	HostAllowedOperationsApplyUpdates HostAllowedOperations = "apply_updates"
)

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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetFamily Get the family field of the given host_cpu.

func (HostCPUClass) GetFeatures 

func (_class HostCPUClass) GetFeatures(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

GetFeatures Get the features field of the given host_cpu.

func (HostCPUClass) GetFlags 

func (_class HostCPUClass) GetFlags(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

GetFlags Get the flags field of the given host_cpu.

func (HostCPUClass) GetHost 

func (_class HostCPUClass) GetHost(sessionID SessionRef, self HostCPURef) (_retval HostRef, _err error)

GetHost Get the host field of the given host_cpu.

func (HostCPUClass) GetModel 

func (_class HostCPUClass) GetModel(sessionID SessionRef, self HostCPURef) (_retval int, _err error)

GetModel Get the model field of the given host_cpu.

func (HostCPUClass) GetModelname 

func (_class HostCPUClass) GetModelname(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

GetModelname Get the modelname field of the given host_cpu.

func (HostCPUClass) GetNumber 

func (_class HostCPUClass) GetNumber(sessionID SessionRef, self HostCPURef) (_retval int, _err error)

GetNumber 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)

GetOtherConfig 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)

GetRecord 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)

GetSpeed Get the speed field of the given host_cpu.

func (HostCPUClass) GetStepping 

func (_class HostCPUClass) GetStepping(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

GetStepping Get the stepping field of the given host_cpu.

func (HostCPUClass) GetUUID 

func (_class HostCPUClass) GetUUID(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

GetUUID Get the uuid field of the given host_cpu.

func (HostCPUClass) GetUtilisation 

func (_class HostCPUClass) GetUtilisation(sessionID SessionRef, self HostCPURef) (_retval float64, _err error)

GetUtilisation Get the utilisation field of the given host_cpu.

func (HostCPUClass) GetVendor 

func (_class HostCPUClass) GetVendor(sessionID SessionRef, self HostCPURef) (_retval string, _err error)

GetVendor Get the vendor field of the given host_cpu.

func (HostCPUClass) RemoveFromOtherConfig 

func (_class HostCPUClass) RemoveFromOtherConfig(sessionID SessionRef, self HostCPURef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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)

AddTags 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)

AddToGuestVCPUsParams 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)

AddToLicenseServer 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)

AddToLogging 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)

AddToOtherConfig 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)

ApplyEdition 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) ApplyUpdates 

func (_class HostClass) ApplyUpdates(sessionID SessionRef, self HostRef, hash string) (_retval [][]string, _err error)

ApplyUpdates apply updates from current enabled repository on a host

func (HostClass) AssertCanEvacuate 

func (_class HostClass) AssertCanEvacuate(sessionID SessionRef, host HostRef) (_err error)

AssertCanEvacuate Check this host can be evacuated.

func (HostClass) BackupRrds 

func (_class HostClass) BackupRrds(sessionID SessionRef, host HostRef, delay float64) (_err error)

BackupRrds 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)

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

func (HostClass) CallExtension 

func (_class HostClass) CallExtension(sessionID SessionRef, host HostRef, call string) (_retval string, _err error)

CallExtension Call an API extension on this host

func (HostClass) CallPlugin 

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

CallPlugin Call an API plugin on this host

func (HostClass) ComputeFreeMemory 

func (_class HostClass) ComputeFreeMemory(sessionID SessionRef, host HostRef) (_retval int, _err error)

ComputeFreeMemory Computes the amount of free memory on the host.

func (HostClass) ComputeMemoryOverhead 

func (_class HostClass) ComputeMemoryOverhead(sessionID SessionRef, host HostRef) (_retval int, _err error)

ComputeMemoryOverhead 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)

CreateNewBlob 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)

DeclareDead 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 Destroy specified host record in database

func (HostClass) Disable 

func (_class HostClass) Disable(sessionID SessionRef, host HostRef) (_err error)

Disable 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)

DisableDisplay 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)

DisableExternalAuth This call disables external authentication on the local host

func (HostClass) DisableLocalStorageCaching 

func (_class HostClass) DisableLocalStorageCaching(sessionID SessionRef, host HostRef) (_err error)

DisableLocalStorageCaching 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)

Dmesg Get the host xen dmesg.

func (HostClass) DmesgClear 

func (_class HostClass) DmesgClear(sessionID SessionRef, host HostRef) (_retval string, _err error)

DmesgClear Get the host xen dmesg, and clear the buffer.

func (HostClass) EmergencyDisableTLSVerification 

func (_class HostClass) EmergencyDisableTLSVerification(sessionID SessionRef) (_err error)

EmergencyDisableTLSVerification Disable TLS verification for this host only

func (HostClass) EmergencyHaDisable 

func (_class HostClass) EmergencyHaDisable(sessionID SessionRef, soft bool) (_err error)

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

func (HostClass) EmergencyReenableTLSVerification 

func (_class HostClass) EmergencyReenableTLSVerification(sessionID SessionRef) (_err error)

EmergencyReenableTLSVerification Reenable TLS verification for this host only

func (HostClass) EmergencyResetServerCertificate 

func (_class HostClass) EmergencyResetServerCertificate(sessionID SessionRef) (_err error)

EmergencyResetServerCertificate Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care.

func (HostClass) Enable 

func (_class HostClass) Enable(sessionID SessionRef, host HostRef) (_err error)

Enable 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)

EnableDisplay 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)

EnableExternalAuth This call enables external authentication on a host

func (HostClass) EnableLocalStorageCaching 

func (_class HostClass) EnableLocalStorageCaching(sessionID SessionRef, host HostRef, sr SRRef) (_err error)

EnableLocalStorageCaching Enable the use of a local SR for caching purposes

func (HostClass) Evacuate 

func (_class HostClass) Evacuate(sessionID SessionRef, host HostRef, network NetworkRef) (_err error)

Evacuate Migrate all VMs off of this host, where possible.

func (HostClass) ForgetDataSourceArchives 

func (_class HostClass) ForgetDataSourceArchives(sessionID SessionRef, host HostRef, dataSource string) (_err error)

ForgetDataSourceArchives 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)

GetAPIVersionMajor 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)

GetAPIVersionMinor 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)

GetAPIVersionVendor 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)

GetAPIVersionVendorImplementation 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)

GetAddress Get the address field of the given host.

func (HostClass) GetAll 

func (_class HostClass) GetAll(sessionID SessionRef) (_retval []HostRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations 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)

GetBiosStrings 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)

GetBlobs Get the blobs field of the given host.

func (HostClass) GetByNameLabel 

func (_class HostClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []HostRef, _err error)

GetByNameLabel Get all the host instances with the given label.

func (HostClass) GetByUUID 

func (_class HostClass) GetByUUID(sessionID SessionRef, uuid string) (_retval HostRef, _err error)

GetByUUID 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)

GetCPUConfiguration 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)

GetCPUInfo Get the cpu_info field of the given host.

func (HostClass) GetCapabilities 

func (_class HostClass) GetCapabilities(sessionID SessionRef, self HostRef) (_retval []string, _err error)

GetCapabilities Get the capabilities field of the given host.

func (HostClass) GetCertificates 

func (_class HostClass) GetCertificates(sessionID SessionRef, self HostRef) (_retval []CertificateRef, _err error)

GetCertificates Get the certificates field of the given host.

func (HostClass) GetChipsetInfo 

func (_class HostClass) GetChipsetInfo(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

GetChipsetInfo Get the chipset_info field of the given host.

func (HostClass) GetControlDomain 

func (_class HostClass) GetControlDomain(sessionID SessionRef, self HostRef) (_retval VMRef, _err error)

GetControlDomain Get the control_domain field of the given host.

func (HostClass) GetCrashDumpSr 

func (_class HostClass) GetCrashDumpSr(sessionID SessionRef, self HostRef) (_retval SRRef, _err error)

GetCrashDumpSr 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)

GetCrashdumps 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)

GetCurrentOperations Get the current_operations field of the given host.

func (HostClass) GetDataSources 

func (_class HostClass) GetDataSources(sessionID SessionRef, host HostRef) (_retval []DataSourceRecord, _err error)

GetDataSources

func (HostClass) GetDisplay 

func (_class HostClass) GetDisplay(sessionID SessionRef, self HostRef) (_retval HostDisplay, _err error)

GetDisplay Get the display field of the given host.

func (HostClass) GetEdition 

func (_class HostClass) GetEdition(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetEdition Get the edition field of the given host.

func (HostClass) GetEditions 

func (_class HostClass) GetEditions(sessionID SessionRef, self HostRef) (_retval []string, _err error)

GetEditions Get the editions field of the given host.

func (HostClass) GetEnabled 

func (_class HostClass) GetEnabled(sessionID SessionRef, self HostRef) (_retval bool, _err error)

GetEnabled 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)

GetExternalAuthConfiguration 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)

GetExternalAuthServiceName 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)

GetExternalAuthType Get the external_auth_type field of the given host.

func (HostClass) GetFeatures 

func (_class HostClass) GetFeatures(sessionID SessionRef, self HostRef) (_retval []FeatureRef, _err error)

GetFeatures Get the features field of the given host.

func (HostClass) GetGuestVCPUsParams 

func (_class HostClass) GetGuestVCPUsParams(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

GetGuestVCPUsParams Get the guest_VCPUs_params field of the given host.

func (HostClass) GetHTTPSOnly 

func (_class HostClass) GetHTTPSOnly(sessionID SessionRef, self HostRef) (_retval bool, _err error)

GetHTTPSOnly Get the https_only field of the given host.

func (HostClass) GetHaNetworkPeers 

func (_class HostClass) GetHaNetworkPeers(sessionID SessionRef, self HostRef) (_retval []string, _err error)

GetHaNetworkPeers 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)

GetHaStatefiles Get the ha_statefiles field of the given host.

func (HostClass) GetHostCPUs 

func (_class HostClass) GetHostCPUs(sessionID SessionRef, self HostRef) (_retval []HostCPURef, _err error)

GetHostCPUs Get the host_CPUs field of the given host.

func (HostClass) GetHostname 

func (_class HostClass) GetHostname(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetHostname Get the hostname field of the given host.

func (HostClass) GetIscsiIqn 

func (_class HostClass) GetIscsiIqn(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetIscsiIqn Get the iscsi_iqn field of the given host.

func (HostClass) GetLastSoftwareUpdate 

func (_class HostClass) GetLastSoftwareUpdate(sessionID SessionRef, self HostRef) (_retval time.Time, _err error)

GetLastSoftwareUpdate Get the last_software_update field of the given host.

func (HostClass) GetLicenseParams 

func (_class HostClass) GetLicenseParams(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

GetLicenseParams 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)

GetLicenseServer Get the license_server field of the given host.

func (HostClass) GetLocalCacheSr 

func (_class HostClass) GetLocalCacheSr(sessionID SessionRef, self HostRef) (_retval SRRef, _err error)

GetLocalCacheSr 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)

GetLog Get the host's log file

func (HostClass) GetLogging 

func (_class HostClass) GetLogging(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

GetLogging Get the logging field of the given host.

func (HostClass) GetManagementInterface 

func (_class HostClass) GetManagementInterface(sessionID SessionRef, host HostRef) (_retval PIFRef, _err error)

GetManagementInterface Returns the management interface for the specified host

func (HostClass) GetMemoryOverhead 

func (_class HostClass) GetMemoryOverhead(sessionID SessionRef, self HostRef) (_retval int, _err error)

GetMemoryOverhead Get the memory/overhead field of the given host.

func (HostClass) GetMetrics 

func (_class HostClass) GetMetrics(sessionID SessionRef, self HostRef) (_retval HostMetricsRef, _err error)

GetMetrics Get the metrics field of the given host.

func (HostClass) GetMultipathing 

func (_class HostClass) GetMultipathing(sessionID SessionRef, self HostRef) (_retval bool, _err error)

GetMultipathing Get the multipathing field of the given host.

func (HostClass) GetNameDescription 

func (_class HostClass) GetNameDescription(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given host.

func (HostClass) GetNameLabel 

func (_class HostClass) GetNameLabel(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetNameLabel 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)

GetOtherConfig Get the other_config field of the given host.

func (HostClass) GetPBDs 

func (_class HostClass) GetPBDs(sessionID SessionRef, self HostRef) (_retval []PBDRef, _err error)

GetPBDs Get the PBDs field of the given host.

func (HostClass) GetPCIs 

func (_class HostClass) GetPCIs(sessionID SessionRef, self HostRef) (_retval []PCIRef, _err error)

GetPCIs Get the PCIs field of the given host.

func (HostClass) GetPGPUs 

func (_class HostClass) GetPGPUs(sessionID SessionRef, self HostRef) (_retval []PGPURef, _err error)

GetPGPUs Get the PGPUs field of the given host.

func (HostClass) GetPIFs 

func (_class HostClass) GetPIFs(sessionID SessionRef, self HostRef) (_retval []PIFRef, _err error)

GetPIFs Get the PIFs field of the given host.

func (HostClass) GetPUSBs 

func (_class HostClass) GetPUSBs(sessionID SessionRef, self HostRef) (_retval []PUSBRef, _err error)

GetPUSBs Get the PUSBs field of the given host.

func (HostClass) GetPatches 

func (_class HostClass) GetPatches(sessionID SessionRef, self HostRef) (_retval []HostPatchRef, _err error)

GetPatches Get the patches field of the given host.

func (HostClass) GetPendingGuidances 

func (_class HostClass) GetPendingGuidances(sessionID SessionRef, self HostRef) (_retval []UpdateGuidances, _err error)

GetPendingGuidances Get the pending_guidances field of the given host.

func (HostClass) GetPowerOnConfig 

func (_class HostClass) GetPowerOnConfig(sessionID SessionRef, self HostRef) (_retval map[string]string, _err error)

GetPowerOnConfig 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)

GetPowerOnMode 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)

GetRecord 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)

GetResidentVMs Get the resident_VMs field of the given host.

func (HostClass) GetSchedGran 

func (_class HostClass) GetSchedGran(sessionID SessionRef, self HostRef) (_retval HostSchedGran, _err error)

GetSchedGran Gets xen's sched-gran on a host

func (HostClass) GetSchedPolicy 

func (_class HostClass) GetSchedPolicy(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetSchedPolicy Get the sched_policy field of the given host.

func (HostClass) GetServerCertificate 

func (_class HostClass) GetServerCertificate(sessionID SessionRef, host HostRef) (_retval string, _err error)

GetServerCertificate Get the installed server public TLS certificate.

func (HostClass) GetServerLocaltime 

func (_class HostClass) GetServerLocaltime(sessionID SessionRef, host HostRef) (_retval time.Time, _err error)

GetServerLocaltime 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)

GetServertime 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)

GetSoftwareVersion Get the software_version field of the given host.

func (HostClass) GetSslLegacy 

func (_class HostClass) GetSslLegacy(sessionID SessionRef, self HostRef) (_retval bool, _err error)

GetSslLegacy Get the ssl_legacy field of the given host.

func (HostClass) GetSupportedBootloaders 

func (_class HostClass) GetSupportedBootloaders(sessionID SessionRef, self HostRef) (_retval []string, _err error)

GetSupportedBootloaders Get the supported_bootloaders field of the given host.

func (HostClass) GetSuspendImageSr 

func (_class HostClass) GetSuspendImageSr(sessionID SessionRef, self HostRef) (_retval SRRef, _err error)

GetSuspendImageSr 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)

GetSystemStatusCapabilities

func (HostClass) GetTLSVerificationEnabled 

func (_class HostClass) GetTLSVerificationEnabled(sessionID SessionRef, self HostRef) (_retval bool, _err error)

GetTLSVerificationEnabled Get the tls_verification_enabled field of the given host.

func (HostClass) GetTags 

func (_class HostClass) GetTags(sessionID SessionRef, self HostRef) (_retval []string, _err error)

GetTags Get the tags field of the given host.

func (HostClass) GetUUID 

func (_class HostClass) GetUUID(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetUUID Get the uuid field of the given host.

func (HostClass) GetUefiCertificates 

func (_class HostClass) GetUefiCertificates(sessionID SessionRef, self HostRef) (_retval string, _err error)

GetUefiCertificates Get the uefi_certificates field of the given host.

func (HostClass) GetUncooperativeResidentVMs 

func (_class HostClass) GetUncooperativeResidentVMs(sessionID SessionRef, self HostRef) (_retval []VMRef, _err error)

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

func (HostClass) GetUpdates 

func (_class HostClass) GetUpdates(sessionID SessionRef, self HostRef) (_retval []PoolUpdateRef, _err error)

GetUpdates Get the updates field of the given host.

func (HostClass) GetUpdatesRequiringReboot 

func (_class HostClass) GetUpdatesRequiringReboot(sessionID SessionRef, self HostRef) (_retval []PoolUpdateRef, _err error)

GetUpdatesRequiringReboot Get the updates_requiring_reboot field of the given host.

func (HostClass) GetVirtualHardwarePlatformVersions 

func (_class HostClass) GetVirtualHardwarePlatformVersions(sessionID SessionRef, self HostRef) (_retval []int, _err error)

GetVirtualHardwarePlatformVersions 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)

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

func (HostClass) HasExtension 

func (_class HostClass) HasExtension(sessionID SessionRef, host HostRef, name string) (_retval bool, _err error)

HasExtension Return true if the extension is available on the host

func (HostClass) InstallServerCertificate 

func (_class HostClass) InstallServerCertificate(sessionID SessionRef, host HostRef, certificate string, privateKey string, certificateChain string) (_err error)

InstallServerCertificate Install the TLS server certificate.

func (HostClass) LicenseAdd 

func (_class HostClass) LicenseAdd(sessionID SessionRef, host HostRef, contents string) (_err error)

LicenseAdd 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) LicenseApply 

func (_class HostClass) LicenseApply(sessionID SessionRef, host HostRef, contents string) (_err error)

LicenseApply 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) LicenseRemove 

func (_class HostClass) LicenseRemove(sessionID SessionRef, host HostRef) (_err error)

LicenseRemove Remove any license file from the specified host, and switch that host to the unlicensed edition

func (HostClass) ListMethods 

func (_class HostClass) ListMethods(sessionID SessionRef) (_retval []string, _err error)

ListMethods List all supported methods

func (HostClass) LocalManagementReconfigure 

func (_class HostClass) LocalManagementReconfigure(sessionID SessionRef, iface string) (_err error)

LocalManagementReconfigure 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)

ManagementDisable Disable the management network interface

func (HostClass) ManagementReconfigure 

func (_class HostClass) ManagementReconfigure(sessionID SessionRef, pif PIFRef) (_err error)

ManagementReconfigure 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)

MigrateReceive 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)

PowerOn 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)

QueryDataSource Query the latest value of the specified data source

func (HostClass) Reboot 

func (_class HostClass) Reboot(sessionID SessionRef, host HostRef) (_err error)

Reboot 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)

RecordDataSource Start recording the specified data source

func (HostClass) RefreshPackInfo 

func (_class HostClass) RefreshPackInfo(sessionID SessionRef, host HostRef) (_err error)

RefreshPackInfo Refresh the list of installed Supplemental Packs.

func (HostClass) RefreshServerCertificate 

func (_class HostClass) RefreshServerCertificate(sessionID SessionRef, host HostRef) (_err error)

RefreshServerCertificate Replace the internal self-signed host certficate with a new one.

func (HostClass) RemoveFromGuestVCPUsParams 

func (_class HostClass) RemoveFromGuestVCPUsParams(sessionID SessionRef, self HostRef, key string) (_err error)

RemoveFromGuestVCPUsParams 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)

RemoveFromLicenseServer 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)

RemoveFromLogging 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)

RemoveFromOtherConfig 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)

RemoveTags 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)

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

func (HostClass) ResetServerCertificate 

func (_class HostClass) ResetServerCertificate(sessionID SessionRef, host HostRef) (_err error)

ResetServerCertificate Delete the current TLS server certificate and replace by a new, self-signed one. This should only be used with extreme care.

func (HostClass) RestartAgent 

func (_class HostClass) RestartAgent(sessionID SessionRef, host HostRef) (_err error)

RestartAgent 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)

RetrieveWlbEvacuateRecommendations 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)

SendDebugKeys Inject the given string as debugging keys into Xen

func (HostClass) SetAddress 

func (_class HostClass) SetAddress(sessionID SessionRef, self HostRef, value string) (_err error)

SetAddress Set the address field of the given host.

func (HostClass) SetCPUFeatures 

func (_class HostClass) SetCPUFeatures(sessionID SessionRef, host HostRef, features string) (_err error)

SetCPUFeatures 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)

SetCrashDumpSr 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)

SetDisplay 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)

SetGuestVCPUsParams Set the guest_VCPUs_params field of the given host.

func (HostClass) SetHTTPSOnly 

func (_class HostClass) SetHTTPSOnly(sessionID SessionRef, self HostRef, value bool) (_err error)

SetHTTPSOnly updates the host firewall to open or close port 80 depending on the value

func (HostClass) SetHostname 

func (_class HostClass) SetHostname(sessionID SessionRef, self HostRef, value string) (_err error)

SetHostname Set the hostname field of the given host.

func (HostClass) SetHostnameLive 

func (_class HostClass) SetHostnameLive(sessionID SessionRef, host HostRef, hostname string) (_err error)

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

Errors: 

HOST_NAME_INVALID - The server name is invalid.

func (HostClass) SetIscsiIqn 

func (_class HostClass) SetIscsiIqn(sessionID SessionRef, host HostRef, value string) (_err error)

SetIscsiIqn Sets the initiator IQN for the host

func (HostClass) SetLicenseServer 

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

SetLicenseServer 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)

SetLogging Set the logging field of the given host.

func (HostClass) SetMultipathing 

func (_class HostClass) SetMultipathing(sessionID SessionRef, host HostRef, value bool) (_err error)

SetMultipathing Specifies whether multipathing is enabled

func (HostClass) SetNameDescription 

func (_class HostClass) SetNameDescription(sessionID SessionRef, self HostRef, value string) (_err error)

SetNameDescription Set the name/description field of the given host.

func (HostClass) SetNameLabel 

func (_class HostClass) SetNameLabel(sessionID SessionRef, self HostRef, value string) (_err error)

SetNameLabel 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)

SetOtherConfig 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)

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

func (HostClass) SetSchedGran 

func (_class HostClass) SetSchedGran(sessionID SessionRef, self HostRef, value HostSchedGran) (_err error)

SetSchedGran Sets xen's sched-gran on a host. See: https://xenbits.xen.org/docs/unstable/misc/xen-command-line.html#sched-gran-x86

func (HostClass) SetSslLegacy 

func (_class HostClass) SetSslLegacy(sessionID SessionRef, self HostRef, value bool) (_err error)

SetSslLegacy Enable/disable SSLv3 for interoperability with older server versions. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid.

func (HostClass) SetSuspendImageSr 

func (_class HostClass) SetSuspendImageSr(sessionID SessionRef, self HostRef, value SRRef) (_err error)

SetSuspendImageSr 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)

SetTags Set the tags field of the given host.

func (HostClass) SetUefiCertificates 

func (_class HostClass) SetUefiCertificates(sessionID SessionRef, host HostRef, value string) (_err error)

SetUefiCertificates Sets the UEFI certificates on a host

func (HostClass) Shutdown 

func (_class HostClass) Shutdown(sessionID SessionRef, host HostRef) (_err error)

Shutdown 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)

ShutdownAgent 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)

SyncData 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)

SyslogReconfigure 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)

AddToOtherConfig 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 Destroy specified host crash dump, removing it from the disk.

func (HostCrashdumpClass) GetAll 

func (_class HostCrashdumpClass) GetAll(sessionID SessionRef) (_retval []HostCrashdumpRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetHost 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)

GetOtherConfig 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)

GetRecord 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)

GetSize 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)

GetTimestamp Get the timestamp field of the given host_crashdump.

func (HostCrashdumpClass) GetUUID 

func (_class HostCrashdumpClass) GetUUID(sessionID SessionRef, self HostCrashdumpRef) (_retval string, _err error)

GetUUID Get the uuid field of the given host_crashdump.

func (HostCrashdumpClass) RemoveFromOtherConfig 

func (_class HostCrashdumpClass) RemoveFromOtherConfig(sessionID SessionRef, self HostCrashdumpRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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 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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetLastUpdated 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)

GetLive Get the live field of the given host_metrics.

func (HostMetricsClass) GetMemoryFree 

func (_class HostMetricsClass) GetMemoryFree(sessionID SessionRef, self HostMetricsRef) (_retval int, _err error)

GetMemoryFree 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)

GetMemoryTotal 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)

GetOtherConfig 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)

GetRecord 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)

GetUUID Get the uuid field of the given host_metrics.

func (HostMetricsClass) RemoveFromOtherConfig 

func (_class HostMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self HostMetricsRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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)

AddToOtherConfig 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 Apply the selected patch and return its output

func (HostPatchClass) Destroy 

func (_class HostPatchClass) Destroy(sessionID SessionRef, self HostPatchRef) (_err error)

Destroy 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)

GetAll 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)

GetAllRecords 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)

GetApplied Get the applied field of the given host_patch.

func (HostPatchClass) GetByNameLabel 

func (_class HostPatchClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []HostPatchRef, _err error)

GetByNameLabel 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)

GetByUUID 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)

GetHost Get the host field of the given host_patch.

func (HostPatchClass) GetNameDescription 

func (_class HostPatchClass) GetNameDescription(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

GetNameDescription 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)

GetNameLabel 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)

GetOtherConfig 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)

GetPoolPatch 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)

GetRecord 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)

GetSize 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)

GetTimestampApplied 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)

GetUUID Get the uuid field of the given host_patch.

func (HostPatchClass) GetVersion 

func (_class HostPatchClass) GetVersion(sessionID SessionRef, self HostPatchRef) (_retval string, _err error)

GetVersion Get the version field of the given host_patch.

func (HostPatchClass) RemoveFromOtherConfig 

func (_class HostPatchClass) RemoveFromOtherConfig(sessionID SessionRef, self HostPatchRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// Set of updates
	Updates []PoolUpdateRef
	// 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
	// Product 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
	// List of physical USBs in the host
	PUSBs []PUSBRef
	// Allow SSLv3 protocol and ciphersuites as used by older server versions. This controls both incoming and outgoing connections. When this is set to a different value, the host immediately restarts its SSL/TLS listening service; typically this takes less than a second but existing connections to it will be broken. API login sessions will remain valid.
	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
	// The control domain (domain 0)
	ControlDomain VMRef
	// List of updates which require reboot
	UpdatesRequiringReboot []PoolUpdateRef
	// List of features available on this host
	Features []FeatureRef
	// The initiator IQN for the host
	IscsiIqn string
	// Specifies whether multipathing is enabled
	Multipathing bool
	// The UEFI certificates allowing Secure Boot
	UefiCertificates string
	// List of certificates installed in the host
	Certificates []CertificateRef
	// List of all available product editions
	Editions []string
	// The set of pending guidances after applying updates
	PendingGuidances []UpdateGuidances
	// True if this host has TLS verifcation enabled
	TLSVerificationEnabled bool
	// Date and time when the last software update was applied
	LastSoftwareUpdate time.Time
	// Reflects whether port 80 is open (false) or not (true)
	HTTPSOnly bool
}

type HostRef 

type HostRef string

type HostSchedGran 

type HostSchedGran string
const (
	// core scheduling
	HostSchedGranCore HostSchedGran = "core"
	// CPU scheduling
	HostSchedGranCPU HostSchedGran = "cpu"
	// socket scheduling
	HostSchedGranSocket HostSchedGran = "socket"
)

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 LVHDClass 

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

LVHD SR specific operations

func (LVHDClass) EnableThinProvisioning 

func (_class LVHDClass) EnableThinProvisioning(sessionID SessionRef, host HostRef, sr SRRef, initialAllocation int, allocationQuantum int) (_retval string, _err error)

EnableThinProvisioning Upgrades an LVHD SR to enable thin-provisioning. Future VDIs created in this SR will be thinly-provisioned, although existing VDIs will be left alone. Note that the SR must be attached to the SRmaster for upgrade to work.

func (LVHDClass) GetByUUID 

func (_class LVHDClass) GetByUUID(sessionID SessionRef, uuid string) (_retval LVHDRef, _err error)

GetByUUID Get a reference to the LVHD instance with the specified UUID.

func (LVHDClass) GetRecord 

func (_class LVHDClass) GetRecord(sessionID SessionRef, self LVHDRef) (_retval LVHDRecord, _err error)

GetRecord Get a record containing the current state of the given LVHD.

func (LVHDClass) GetUUID 

func (_class LVHDClass) GetUUID(sessionID SessionRef, self LVHDRef) (_retval string, _err error)

GetUUID Get the uuid field of the given LVHD.

type LVHDRecord 

type LVHDRecord struct {
	// Unique identifier/object reference
	UUID string
}

type LVHDRef 

type LVHDRef string

type LivepatchStatus 

type LivepatchStatus string
const (
	// An applicable live patch exists for every required component
	LivepatchStatusOkLivepatchComplete LivepatchStatus = "ok_livepatch_complete"
	// An applicable live patch exists but it is not sufficient
	LivepatchStatusOkLivepatchIncomplete LivepatchStatus = "ok_livepatch_incomplete"
	// There is no applicable live patch
	LivepatchStatusOk LivepatchStatus = "ok"
)

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)

Create

func (MessageClass) Destroy 

func (_class MessageClass) Destroy(sessionID SessionRef, self MessageRef) (_err error)

Destroy

func (MessageClass) DestroyMany 

func (_class MessageClass) DestroyMany(sessionID SessionRef, messages []MessageRef) (_err error)

DestroyMany

func (MessageClass) Get 

func (_class MessageClass) Get(sessionID SessionRef, cls Cls, objUUID string, since time.Time) (_retval map[MessageRef]MessageRecord, _err error)

Get

func (MessageClass) GetAll 

func (_class MessageClass) GetAll(sessionID SessionRef) (_retval []MessageRef, _err error)

GetAll

func (MessageClass) GetAllRecords 

func (_class MessageClass) GetAllRecords(sessionID SessionRef) (_retval map[MessageRef]MessageRecord, _err error)

GetAllRecords

func (MessageClass) GetAllRecordsWhere 

func (_class MessageClass) GetAllRecordsWhere(sessionID SessionRef, expr string) (_retval map[MessageRef]MessageRecord, _err error)

GetAllRecordsWhere

func (MessageClass) GetByUUID 

func (_class MessageClass) GetByUUID(sessionID SessionRef, uuid string) (_retval MessageRef, _err error)

GetByUUID

func (MessageClass) GetRecord 

func (_class MessageClass) GetRecord(sessionID SessionRef, self MessageRef) (_retval MessageRecord, _err error)

GetRecord

func (MessageClass) GetSince 

func (_class MessageClass) GetSince(sessionID SessionRef, since time.Time) (_retval map[MessageRef]MessageRecord, _err error)

GetSince

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) AddPurpose 

func (_class NetworkClass) AddPurpose(sessionID SessionRef, self NetworkRef, value NetworkPurpose) (_err error)

AddPurpose Give a network a new purpose (if not present already)

Errors: 

NETWORK_INCOMPATIBLE_PURPOSES - You tried to add a purpose to a network but the new purpose is not compatible with an existing purpose of the network or other networks.

func (NetworkClass) AddTags 

func (_class NetworkClass) AddTags(sessionID SessionRef, self NetworkRef, value string) (_err error)

AddTags 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)

AddToOtherConfig 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 Create a new network instance, and return its handle. The constructor args are: name_label, name_description, MTU, other_config*, bridge, managed, tags (* = non-optional).

func (NetworkClass) CreateNewBlob 

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

CreateNewBlob 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 Destroy the specified network instance.

func (NetworkClass) GetAll 

func (_class NetworkClass) GetAll(sessionID SessionRef) (_retval []NetworkRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations 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)

GetAssignedIps 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)

GetBlobs Get the blobs field of the given network.

func (NetworkClass) GetBridge 

func (_class NetworkClass) GetBridge(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

GetBridge Get the bridge field of the given network.

func (NetworkClass) GetByNameLabel 

func (_class NetworkClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []NetworkRef, _err error)

GetByNameLabel Get all the network instances with the given label.

func (NetworkClass) GetByUUID 

func (_class NetworkClass) GetByUUID(sessionID SessionRef, uuid string) (_retval NetworkRef, _err error)

GetByUUID 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)

GetCurrentOperations Get the current_operations field of the given network.

func (NetworkClass) GetDefaultLockingMode 

func (_class NetworkClass) GetDefaultLockingMode(sessionID SessionRef, self NetworkRef) (_retval NetworkDefaultLockingMode, _err error)

GetDefaultLockingMode 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)

GetMTU Get the MTU field of the given network.

func (NetworkClass) GetManaged 

func (_class NetworkClass) GetManaged(sessionID SessionRef, self NetworkRef) (_retval bool, _err error)

GetManaged Get the managed field of the given network.

func (NetworkClass) GetNameDescription 

func (_class NetworkClass) GetNameDescription(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given network.

func (NetworkClass) GetNameLabel 

func (_class NetworkClass) GetNameLabel(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

GetNameLabel 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)

GetOtherConfig Get the other_config field of the given network.

func (NetworkClass) GetPIFs 

func (_class NetworkClass) GetPIFs(sessionID SessionRef, self NetworkRef) (_retval []PIFRef, _err error)

GetPIFs Get the PIFs field of the given network.

func (NetworkClass) GetPurpose 

func (_class NetworkClass) GetPurpose(sessionID SessionRef, self NetworkRef) (_retval []NetworkPurpose, _err error)

GetPurpose Get the purpose field of the given network.

func (NetworkClass) GetRecord 

func (_class NetworkClass) GetRecord(sessionID SessionRef, self NetworkRef) (_retval NetworkRecord, _err error)

GetRecord 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)

GetTags Get the tags field of the given network.

func (NetworkClass) GetUUID 

func (_class NetworkClass) GetUUID(sessionID SessionRef, self NetworkRef) (_retval string, _err error)

GetUUID Get the uuid field of the given network.

func (NetworkClass) GetVIFs 

func (_class NetworkClass) GetVIFs(sessionID SessionRef, self NetworkRef) (_retval []VIFRef, _err error)

GetVIFs Get the VIFs field of the given network.

func (NetworkClass) RemoveFromOtherConfig 

func (_class NetworkClass) RemoveFromOtherConfig(sessionID SessionRef, self NetworkRef, key string) (_err error)

RemoveFromOtherConfig 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) RemovePurpose 

func (_class NetworkClass) RemovePurpose(sessionID SessionRef, self NetworkRef, value NetworkPurpose) (_err error)

RemovePurpose Remove a purpose from a network (if present)

func (NetworkClass) RemoveTags 

func (_class NetworkClass) RemoveTags(sessionID SessionRef, self NetworkRef, value string) (_err error)

RemoveTags 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)

SetDefaultLockingMode 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)

SetMTU Set the MTU field of the given network.

func (NetworkClass) SetNameDescription 

func (_class NetworkClass) SetNameDescription(sessionID SessionRef, self NetworkRef, value string) (_err error)

SetNameDescription Set the name/description field of the given network.

func (NetworkClass) SetNameLabel 

func (_class NetworkClass) SetNameLabel(sessionID SessionRef, self NetworkRef, value string) (_err error)

SetNameLabel 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)

SetOtherConfig Set the other_config field of the given network.

func (NetworkClass) SetTags 

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

SetTags 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 NetworkPurpose 

type NetworkPurpose string
const (
	// Network Block Device service using TLS
	NetworkPurposeNbd NetworkPurpose = "nbd"
	// Network Block Device service without integrity or confidentiality: NOT RECOMMENDED
	NetworkPurposeInsecureNbd NetworkPurpose = "insecure_nbd"
)

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
	// true if the bridge is managed by xapi
	Managed bool
	// 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
	// Set of purposes for which the server will use this network
	Purpose []NetworkPurpose
}

type NetworkRef 

type NetworkRef string

type NetworkSriovClass 

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

network-sriov which connects logical pif and physical pif

func (NetworkSriovClass) Create 

func (_class NetworkSriovClass) Create(sessionID SessionRef, pif PIFRef, network NetworkRef) (_retval NetworkSriovRef, _err error)

Create Enable SR-IOV on the specific PIF. It will create a network-sriov based on the specific PIF and automatically create a logical PIF to connect the specific network.

func (NetworkSriovClass) Destroy 

func (_class NetworkSriovClass) Destroy(sessionID SessionRef, self NetworkSriovRef) (_err error)

Destroy Disable SR-IOV on the specific PIF. It will destroy the network-sriov and the logical PIF accordingly.

func (NetworkSriovClass) GetAll 

func (_class NetworkSriovClass) GetAll(sessionID SessionRef) (_retval []NetworkSriovRef, _err error)

GetAll Return a list of all the network_sriovs known to the system.

func (NetworkSriovClass) GetAllRecords 

func (_class NetworkSriovClass) GetAllRecords(sessionID SessionRef) (_retval map[NetworkSriovRef]NetworkSriovRecord, _err error)

GetAllRecords Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system.

func (NetworkSriovClass) GetByUUID 

func (_class NetworkSriovClass) GetByUUID(sessionID SessionRef, uuid string) (_retval NetworkSriovRef, _err error)

GetByUUID Get a reference to the network_sriov instance with the specified UUID.

func (NetworkSriovClass) GetConfigurationMode 

func (_class NetworkSriovClass) GetConfigurationMode(sessionID SessionRef, self NetworkSriovRef) (_retval SriovConfigurationMode, _err error)

GetConfigurationMode Get the configuration_mode field of the given network_sriov.

func (NetworkSriovClass) GetLogicalPIF 

func (_class NetworkSriovClass) GetLogicalPIF(sessionID SessionRef, self NetworkSriovRef) (_retval PIFRef, _err error)

GetLogicalPIF Get the logical_PIF field of the given network_sriov.

func (NetworkSriovClass) GetPhysicalPIF 

func (_class NetworkSriovClass) GetPhysicalPIF(sessionID SessionRef, self NetworkSriovRef) (_retval PIFRef, _err error)

GetPhysicalPIF Get the physical_PIF field of the given network_sriov.

func (NetworkSriovClass) GetRecord 

func (_class NetworkSriovClass) GetRecord(sessionID SessionRef, self NetworkSriovRef) (_retval NetworkSriovRecord, _err error)

GetRecord Get a record containing the current state of the given network_sriov.

func (NetworkSriovClass) GetRemainingCapacity 

func (_class NetworkSriovClass) GetRemainingCapacity(sessionID SessionRef, self NetworkSriovRef) (_retval int, _err error)

GetRemainingCapacity Get the number of free SR-IOV VFs on the associated PIF

func (NetworkSriovClass) GetRequiresReboot 

func (_class NetworkSriovClass) GetRequiresReboot(sessionID SessionRef, self NetworkSriovRef) (_retval bool, _err error)

GetRequiresReboot Get the requires_reboot field of the given network_sriov.

func (NetworkSriovClass) GetUUID 

func (_class NetworkSriovClass) GetUUID(sessionID SessionRef, self NetworkSriovRef) (_retval string, _err error)

GetUUID Get the uuid field of the given network_sriov.

type NetworkSriovRecord 

type NetworkSriovRecord struct {
	// Unique identifier/object reference
	UUID string
	// The PIF that has SR-IOV enabled
	PhysicalPIF PIFRef
	// The logical PIF to connect to the SR-IOV network after enable SR-IOV on the physical PIF
	LogicalPIF PIFRef
	// Indicates whether the host need to be rebooted before SR-IOV is enabled on the physical PIF
	RequiresReboot bool
	// The mode for configure network sriov
	ConfigurationMode SriovConfigurationMode
}

type NetworkSriovRef 

type NetworkSriovRef string

type ObserverClass 

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

Describes a observer which will control observability activity in the Toolstack

func (ObserverClass) Create 

func (_class ObserverClass) Create(sessionID SessionRef, args ObserverRecord) (_retval ObserverRef, _err error)

Create Create a new Observer instance, and return its handle. The constructor args are: name_label, name_description, hosts, attributes, endpoints, components, enabled (* = non-optional).

func (ObserverClass) Destroy 

func (_class ObserverClass) Destroy(sessionID SessionRef, self ObserverRef) (_err error)

Destroy Destroy the specified Observer instance.

func (ObserverClass) GetAll 

func (_class ObserverClass) GetAll(sessionID SessionRef) (_retval []ObserverRef, _err error)

GetAll Return a list of all the Observers known to the system.

func (ObserverClass) GetAllRecords 

func (_class ObserverClass) GetAllRecords(sessionID SessionRef) (_retval map[ObserverRef]ObserverRecord, _err error)

GetAllRecords Return a map of Observer references to Observer records for all Observers known to the system.

func (ObserverClass) GetAttributes 

func (_class ObserverClass) GetAttributes(sessionID SessionRef, self ObserverRef) (_retval map[string]string, _err error)

GetAttributes Get the attributes field of the given Observer.

func (ObserverClass) GetByNameLabel 

func (_class ObserverClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []ObserverRef, _err error)

GetByNameLabel Get all the Observer instances with the given label.

func (ObserverClass) GetByUUID 

func (_class ObserverClass) GetByUUID(sessionID SessionRef, uuid string) (_retval ObserverRef, _err error)

GetByUUID Get a reference to the Observer instance with the specified UUID.

func (ObserverClass) GetComponents 

func (_class ObserverClass) GetComponents(sessionID SessionRef, self ObserverRef) (_retval []string, _err error)

GetComponents Get the components field of the given Observer.

func (ObserverClass) GetEnabled 

func (_class ObserverClass) GetEnabled(sessionID SessionRef, self ObserverRef) (_retval bool, _err error)

GetEnabled Get the enabled field of the given Observer.

func (ObserverClass) GetEndpoints 

func (_class ObserverClass) GetEndpoints(sessionID SessionRef, self ObserverRef) (_retval []string, _err error)

GetEndpoints Get the endpoints field of the given Observer.

func (ObserverClass) GetHosts 

func (_class ObserverClass) GetHosts(sessionID SessionRef, self ObserverRef) (_retval []HostRef, _err error)

GetHosts Get the hosts field of the given Observer.

func (ObserverClass) GetNameDescription 

func (_class ObserverClass) GetNameDescription(sessionID SessionRef, self ObserverRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given Observer.

func (ObserverClass) GetNameLabel 

func (_class ObserverClass) GetNameLabel(sessionID SessionRef, self ObserverRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given Observer.

func (ObserverClass) GetRecord 

func (_class ObserverClass) GetRecord(sessionID SessionRef, self ObserverRef) (_retval ObserverRecord, _err error)

GetRecord Get a record containing the current state of the given Observer.

func (ObserverClass) GetUUID 

func (_class ObserverClass) GetUUID(sessionID SessionRef, self ObserverRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Observer.

func (ObserverClass) SetAttributes 

func (_class ObserverClass) SetAttributes(sessionID SessionRef, self ObserverRef, value map[string]string) (_err error)

SetAttributes Set the attributes of an observer. These are used to emit metadata by the observer

func (ObserverClass) SetComponents 

func (_class ObserverClass) SetComponents(sessionID SessionRef, self ObserverRef, value []string) (_err error)

SetComponents Set the components on which the observer will broadcast to. i.e. xapi, xenopsd, networkd, etc

func (ObserverClass) SetEnabled 

func (_class ObserverClass) SetEnabled(sessionID SessionRef, self ObserverRef, value bool) (_err error)

SetEnabled Enable / disable this observer which will stop the observer from producing observability information

func (ObserverClass) SetEndpoints 

func (_class ObserverClass) SetEndpoints(sessionID SessionRef, self ObserverRef, value []string) (_err error)

SetEndpoints Set the file/HTTP endpoints the observer sends data to

func (ObserverClass) SetHosts 

func (_class ObserverClass) SetHosts(sessionID SessionRef, self ObserverRef, value []HostRef) (_err error)

SetHosts Sets the hosts that the observer is to be registered on

func (ObserverClass) SetNameDescription 

func (_class ObserverClass) SetNameDescription(sessionID SessionRef, self ObserverRef, value string) (_err error)

SetNameDescription Set the name/description field of the given Observer.

func (ObserverClass) SetNameLabel 

func (_class ObserverClass) SetNameLabel(sessionID SessionRef, self ObserverRef, value string) (_err error)

SetNameLabel Set the name/label field of the given Observer.

type ObserverRecord 

type ObserverRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// The list of hosts the observer is active on. An empty list means all hosts
	Hosts []HostRef
	// Attributes that observer will add to the data they produce
	Attributes map[string]string
	// The list of endpoints where data is exported to. Each endpoint is a URL or the string 'bugtool' refering to the internal logs
	Endpoints []string
	// The list of xenserver components the observer will broadcast. An empty list means all components
	Components []string
	// This denotes if the observer is enabled. true if it is enabled and false if it is disabled
	Enabled bool
}

type ObserverRef 

type ObserverRef 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 OnSoftrebootBehavior 

type OnSoftrebootBehavior string
const (
	// perform soft-reboot
	OnSoftrebootBehaviorSoftReboot OnSoftrebootBehavior = "soft_reboot"
	// destroy the VM state
	OnSoftrebootBehaviorDestroy OnSoftrebootBehavior = "destroy"
	// restart the VM
	OnSoftrebootBehaviorRestart OnSoftrebootBehavior = "restart"
	// leave the VM paused
	OnSoftrebootBehaviorPreserve OnSoftrebootBehavior = "preserve"
)

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)

AddToOtherConfig 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 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 Destroy the specified PBD instance.

func (PBDClass) GetAll 

func (_class PBDClass) GetAll(sessionID SessionRef) (_retval []PBDRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetCurrentlyAttached 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)

GetDeviceConfig Get the device_config field of the given PBD.

func (PBDClass) GetHost 

func (_class PBDClass) GetHost(sessionID SessionRef, self PBDRef) (_retval HostRef, _err error)

GetHost 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)

GetOtherConfig Get the other_config field of the given PBD.

func (PBDClass) GetRecord 

func (_class PBDClass) GetRecord(sessionID SessionRef, self PBDRef) (_retval PBDRecord, _err error)

GetRecord 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)

GetSR Get the SR field of the given PBD.

func (PBDClass) GetUUID 

func (_class PBDClass) GetUUID(sessionID SessionRef, self PBDRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PBD.

func (PBDClass) Plug 

func (_class PBDClass) Plug(sessionID SessionRef, self PBDRef) (_err error)

Plug 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)

RemoveFromOtherConfig 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)

SetDeviceConfig Sets the PBD's device_config field

func (PBDClass) SetOtherConfig 

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

SetOtherConfig Set the other_config field of the given PBD.

func (PBDClass) Unplug 

func (_class PBDClass) Unplug(sessionID SessionRef, self PBDRef) (_err error)

Unplug 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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetClassName Get the class_name field of the given PCI.

func (PCIClass) GetDependencies 

func (_class PCIClass) GetDependencies(sessionID SessionRef, self PCIRef) (_retval []PCIRef, _err error)

GetDependencies Get the dependencies field of the given PCI.

func (PCIClass) GetDeviceName 

func (_class PCIClass) GetDeviceName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

GetDeviceName Get the device_name field of the given PCI.

func (PCIClass) GetDriverName 

func (_class PCIClass) GetDriverName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

GetDriverName Get the driver_name field of the given PCI.

func (PCIClass) GetHost 

func (_class PCIClass) GetHost(sessionID SessionRef, self PCIRef) (_retval HostRef, _err error)

GetHost 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)

GetOtherConfig Get the other_config field of the given PCI.

func (PCIClass) GetPciID 

func (_class PCIClass) GetPciID(sessionID SessionRef, self PCIRef) (_retval string, _err error)

GetPciID Get the pci_id field of the given PCI.

func (PCIClass) GetRecord 

func (_class PCIClass) GetRecord(sessionID SessionRef, self PCIRef) (_retval PCIRecord, _err error)

GetRecord 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)

GetSubsystemDeviceName 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)

GetSubsystemVendorName 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)

GetUUID Get the uuid field of the given PCI.

func (PCIClass) GetVendorName 

func (_class PCIClass) GetVendorName(sessionID SessionRef, self PCIRef) (_retval string, _err error)

GetVendorName Get the vendor_name field of the given PCI.

func (PCIClass) RemoveFromOtherConfig 

func (_class PCIClass) RemoveFromOtherConfig(sessionID SessionRef, self PCIRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// Driver name
	DriverName 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)

AddEnabledVGPUTypes

func (PGPUClass) AddToOtherConfig 

func (_class PGPUClass) AddToOtherConfig(sessionID SessionRef, self PGPURef, key string, value string) (_err error)

AddToOtherConfig 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)

DisableDom0Access

func (PGPUClass) EnableDom0Access 

func (_class PGPUClass) EnableDom0Access(sessionID SessionRef, self PGPURef) (_retval PgpuDom0Access, _err error)

EnableDom0Access

func (PGPUClass) GetAll 

func (_class PGPUClass) GetAll(sessionID SessionRef) (_retval []PGPURef, _err error)

GetAll 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)

GetAllRecords 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)

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

func (PGPUClass) GetCompatibilityMetadata 

func (_class PGPUClass) GetCompatibilityMetadata(sessionID SessionRef, self PGPURef) (_retval map[string]string, _err error)

GetCompatibilityMetadata Get the compatibility_metadata field of the given PGPU.

func (PGPUClass) GetDom0Access 

func (_class PGPUClass) GetDom0Access(sessionID SessionRef, self PGPURef) (_retval PgpuDom0Access, _err error)

GetDom0Access Get the dom0_access field of the given PGPU.

func (PGPUClass) GetEnabledVGPUTypes 

func (_class PGPUClass) GetEnabledVGPUTypes(sessionID SessionRef, self PGPURef) (_retval []VGPUTypeRef, _err error)

GetEnabledVGPUTypes 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)

GetGPUGroup Get the GPU_group field of the given PGPU.

func (PGPUClass) GetHost 

func (_class PGPUClass) GetHost(sessionID SessionRef, self PGPURef) (_retval HostRef, _err error)

GetHost Get the host field of the given PGPU.

func (PGPUClass) GetIsSystemDisplayDevice 

func (_class PGPUClass) GetIsSystemDisplayDevice(sessionID SessionRef, self PGPURef) (_retval bool, _err error)

GetIsSystemDisplayDevice 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)

GetOtherConfig Get the other_config field of the given PGPU.

func (PGPUClass) GetPCI 

func (_class PGPUClass) GetPCI(sessionID SessionRef, self PGPURef) (_retval PCIRef, _err error)

GetPCI Get the PCI field of the given PGPU.

func (PGPUClass) GetRecord 

func (_class PGPUClass) GetRecord(sessionID SessionRef, self PGPURef) (_retval PGPURecord, _err error)

GetRecord 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)

GetRemainingCapacity

func (PGPUClass) GetResidentVGPUs 

func (_class PGPUClass) GetResidentVGPUs(sessionID SessionRef, self PGPURef) (_retval []VGPURef, _err error)

GetResidentVGPUs 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)

GetSupportedVGPUMaxCapacities 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)

GetSupportedVGPUTypes 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)

GetUUID Get the uuid field of the given PGPU.

func (PGPUClass) RemoveEnabledVGPUTypes 

func (_class PGPUClass) RemoveEnabledVGPUTypes(sessionID SessionRef, self PGPURef, value VGPUTypeRef) (_err error)

RemoveEnabledVGPUTypes

func (PGPUClass) RemoveFromOtherConfig 

func (_class PGPUClass) RemoveFromOtherConfig(sessionID SessionRef, self PGPURef, key string) (_err error)

RemoveFromOtherConfig 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)

SetEnabledVGPUTypes

func (PGPUClass) SetGPUGroup 

func (_class PGPUClass) SetGPUGroup(sessionID SessionRef, self PGPURef, value GPUGroupRef) (_err error)

SetGPUGroup

func (PGPUClass) SetOtherConfig 

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

SetOtherConfig 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 owns 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
	// PGPU metadata to determine whether a VGPU can migrate between two PGPUs
	CompatibilityMetadata map[string]string
}

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)

AddToOtherConfig 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)

CreateVLAN 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)

DbForget 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)

DbIntroduce Create a new PIF record in the database only

func (PIFClass) Destroy 

func (_class PIFClass) Destroy(sessionID SessionRef, self PIFRef) (_err error)

Destroy 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)

Forget Destroy the PIF object matching a particular network interface

Errors: 

PIF_TUNNEL_STILL_EXISTS - Operation cannot proceed while a tunnel exists on this interface.
CLUSTERING_ENABLED - An operation was attempted while clustering was enabled on the cluster_host.

func (PIFClass) GetAll 

func (_class PIFClass) GetAll(sessionID SessionRef) (_retval []PIFRef, _err error)

GetAll 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)

GetAllRecords 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)

GetBondMasterOf 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)

GetBondSlaveOf 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)

GetByUUID 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)

GetCapabilities Get the capabilities field of the given PIF.

func (PIFClass) GetCurrentlyAttached 

func (_class PIFClass) GetCurrentlyAttached(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

GetCurrentlyAttached Get the currently_attached field of the given PIF.

func (PIFClass) GetDNS 

func (_class PIFClass) GetDNS(sessionID SessionRef, self PIFRef) (_retval string, _err error)

GetDNS Get the DNS field of the given PIF.

func (PIFClass) GetDevice 

func (_class PIFClass) GetDevice(sessionID SessionRef, self PIFRef) (_retval string, _err error)

GetDevice Get the device field of the given PIF.

func (PIFClass) GetDisallowUnplug 

func (_class PIFClass) GetDisallowUnplug(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

GetDisallowUnplug Get the disallow_unplug field of the given PIF.

func (PIFClass) GetGateway 

func (_class PIFClass) GetGateway(sessionID SessionRef, self PIFRef) (_retval string, _err error)

GetGateway Get the gateway field of the given PIF.

func (PIFClass) GetHost 

func (_class PIFClass) GetHost(sessionID SessionRef, self PIFRef) (_retval HostRef, _err error)

GetHost Get the host field of the given PIF.

func (PIFClass) GetIP 

func (_class PIFClass) GetIP(sessionID SessionRef, self PIFRef) (_retval string, _err error)

GetIP Get the IP field of the given PIF.

func (PIFClass) GetIPConfigurationMode 

func (_class PIFClass) GetIPConfigurationMode(sessionID SessionRef, self PIFRef) (_retval IPConfigurationMode, _err error)

GetIPConfigurationMode 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)

GetIPv6 Get the IPv6 field of the given PIF.

func (PIFClass) GetIgmpSnoopingStatus 

func (_class PIFClass) GetIgmpSnoopingStatus(sessionID SessionRef, self PIFRef) (_retval PifIgmpStatus, _err error)

GetIgmpSnoopingStatus Get the igmp_snooping_status field of the given PIF.

func (PIFClass) GetIpv6ConfigurationMode 

func (_class PIFClass) GetIpv6ConfigurationMode(sessionID SessionRef, self PIFRef) (_retval Ipv6ConfigurationMode, _err error)

GetIpv6ConfigurationMode 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)

GetIpv6Gateway Get the ipv6_gateway field of the given PIF.

func (PIFClass) GetMAC 

func (_class PIFClass) GetMAC(sessionID SessionRef, self PIFRef) (_retval string, _err error)

GetMAC Get the MAC field of the given PIF.

func (PIFClass) GetMTU 

func (_class PIFClass) GetMTU(sessionID SessionRef, self PIFRef) (_retval int, _err error)

GetMTU Get the MTU field of the given PIF.

func (PIFClass) GetManaged 

func (_class PIFClass) GetManaged(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

GetManaged Get the managed field of the given PIF.

func (PIFClass) GetManagement 

func (_class PIFClass) GetManagement(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

GetManagement Get the management field of the given PIF.

func (PIFClass) GetMetrics 

func (_class PIFClass) GetMetrics(sessionID SessionRef, self PIFRef) (_retval PIFMetricsRef, _err error)

GetMetrics Get the metrics field of the given PIF.

func (PIFClass) GetNetmask 

func (_class PIFClass) GetNetmask(sessionID SessionRef, self PIFRef) (_retval string, _err error)

GetNetmask Get the netmask field of the given PIF.

func (PIFClass) GetNetwork 

func (_class PIFClass) GetNetwork(sessionID SessionRef, self PIFRef) (_retval NetworkRef, _err error)

GetNetwork 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)

GetOtherConfig Get the other_config field of the given PIF.

func (PIFClass) GetPCI 

func (_class PIFClass) GetPCI(sessionID SessionRef, self PIFRef) (_retval PCIRef, _err error)

GetPCI Get the PCI field of the given PIF.

func (PIFClass) GetPhysical 

func (_class PIFClass) GetPhysical(sessionID SessionRef, self PIFRef) (_retval bool, _err error)

GetPhysical Get the physical field of the given PIF.

func (PIFClass) GetPrimaryAddressType 

func (_class PIFClass) GetPrimaryAddressType(sessionID SessionRef, self PIFRef) (_retval PrimaryAddressType, _err error)

GetPrimaryAddressType 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)

GetProperties Get the properties field of the given PIF.

func (PIFClass) GetRecord 

func (_class PIFClass) GetRecord(sessionID SessionRef, self PIFRef) (_retval PIFRecord, _err error)

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

func (PIFClass) GetSriovLogicalPIFOf 

func (_class PIFClass) GetSriovLogicalPIFOf(sessionID SessionRef, self PIFRef) (_retval []NetworkSriovRef, _err error)

GetSriovLogicalPIFOf Get the sriov_logical_PIF_of field of the given PIF.

func (PIFClass) GetSriovPhysicalPIFOf 

func (_class PIFClass) GetSriovPhysicalPIFOf(sessionID SessionRef, self PIFRef) (_retval []NetworkSriovRef, _err error)

GetSriovPhysicalPIFOf Get the sriov_physical_PIF_of field of the given PIF.

func (PIFClass) GetTunnelAccessPIFOf 

func (_class PIFClass) GetTunnelAccessPIFOf(sessionID SessionRef, self PIFRef) (_retval []TunnelRef, _err error)

GetTunnelAccessPIFOf 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)

GetTunnelTransportPIFOf 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)

GetUUID Get the uuid field of the given PIF.

func (PIFClass) GetVLAN 

func (_class PIFClass) GetVLAN(sessionID SessionRef, self PIFRef) (_retval int, _err error)

GetVLAN Get the VLAN field of the given PIF.

func (PIFClass) GetVLANMasterOf 

func (_class PIFClass) GetVLANMasterOf(sessionID SessionRef, self PIFRef) (_retval VLANRef, _err error)

GetVLANMasterOf 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)

GetVLANSlaveOf 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)

Introduce Create a PIF object matching a particular network interface

func (PIFClass) Plug 

func (_class PIFClass) Plug(sessionID SessionRef, self PIFRef) (_err error)

Plug 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)

ReconfigureIP Reconfigure the IP address settings for this interface

Errors: 

CLUSTERING_ENABLED - An operation was attempted while clustering was enabled on the cluster_host.

func (PIFClass) ReconfigureIpv6 

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

ReconfigureIpv6 Reconfigure the IPv6 address settings for this interface

Errors: 

CLUSTERING_ENABLED - An operation was attempted while clustering was enabled on the cluster_host.

func (PIFClass) RemoveFromOtherConfig 

func (_class PIFClass) RemoveFromOtherConfig(sessionID SessionRef, self PIFRef, key string) (_err error)

RemoveFromOtherConfig 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 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)

SetDisallowUnplug Set whether unplugging the PIF is allowed

Errors: 

OTHER_OPERATION_IN_PROGRESS - Another operation involving the object is currently in progress
CLUSTERING_ENABLED - An operation was attempted while clustering was enabled on the cluster_host.

func (PIFClass) SetOtherConfig 

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

SetOtherConfig Set the other_config field of the given PIF.

func (PIFClass) SetPrimaryAddressType 

func (_class PIFClass) SetPrimaryAddressType(sessionID SessionRef, self PIFRef, primaryAddressType PrimaryAddressType) (_err error)

SetPrimaryAddressType 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)

SetProperty Set the value of a property of the PIF

func (PIFClass) Unplug 

func (_class PIFClass) Unplug(sessionID SessionRef, self PIFRef) (_err error)

Unplug Attempt to bring down a physical interface

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.
VIF_IN_USE - Network has active VIFs
PIF_DOES_NOT_ALLOW_UNPLUG - The operation you requested cannot be performed because the specified PIF does not allow unplug.
PIF_HAS_FCOE_SR_IN_USE - The operation you requested cannot be performed because the specified PIF has FCoE SR in use.

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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetCarrier Get the carrier field of the given PIF_metrics.

func (PIFMetricsClass) GetDeviceID 

func (_class PIFMetricsClass) GetDeviceID(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

GetDeviceID 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)

GetDeviceName 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)

GetDuplex Get the duplex field of the given PIF_metrics.

func (PIFMetricsClass) GetIoReadKbs 

func (_class PIFMetricsClass) GetIoReadKbs(sessionID SessionRef, self PIFMetricsRef) (_retval float64, _err error)

GetIoReadKbs 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)

GetIoWriteKbs 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)

GetLastUpdated 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)

GetOtherConfig 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)

GetPciBusPath 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)

GetRecord 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)

GetSpeed Get the speed field of the given PIF_metrics.

func (PIFMetricsClass) GetUUID 

func (_class PIFMetricsClass) GetUUID(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PIF_metrics.

func (PIFMetricsClass) GetVendorID 

func (_class PIFMetricsClass) GetVendorID(sessionID SessionRef, self PIFMetricsRef) (_retval string, _err error)

GetVendorID 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)

GetVendorName 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)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// Comma separated list of the IP addresses of the 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 which 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) cannot 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
	// The IGMP snooping status of the corresponding network bridge
	IgmpSnoopingStatus PifIgmpStatus
	// Indicates which network_sriov this interface is physical of
	SriovPhysicalPIFOf []NetworkSriovRef
	// Indicates which network_sriov this interface is logical of
	SriovLogicalPIFOf []NetworkSriovRef
	// Link to underlying PCI device
	PCI PCIRef
}

type PIFRef 

type PIFRef string

type PUSBClass 

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

A physical USB device

func (PUSBClass) AddToOtherConfig 

func (_class PUSBClass) AddToOtherConfig(sessionID SessionRef, self PUSBRef, key string, value string) (_err error)

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

func (PUSBClass) GetAll 

func (_class PUSBClass) GetAll(sessionID SessionRef) (_retval []PUSBRef, _err error)

GetAll Return a list of all the PUSBs known to the system.

func (PUSBClass) GetAllRecords 

func (_class PUSBClass) GetAllRecords(sessionID SessionRef) (_retval map[PUSBRef]PUSBRecord, _err error)

GetAllRecords Return a map of PUSB references to PUSB records for all PUSBs known to the system.

func (PUSBClass) GetByUUID 

func (_class PUSBClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PUSBRef, _err error)

GetByUUID Get a reference to the PUSB instance with the specified UUID.

func (PUSBClass) GetDescription 

func (_class PUSBClass) GetDescription(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetDescription Get the description field of the given PUSB.

func (PUSBClass) GetHost 

func (_class PUSBClass) GetHost(sessionID SessionRef, self PUSBRef) (_retval HostRef, _err error)

GetHost Get the host field of the given PUSB.

func (PUSBClass) GetOtherConfig 

func (_class PUSBClass) GetOtherConfig(sessionID SessionRef, self PUSBRef) (_retval map[string]string, _err error)

GetOtherConfig Get the other_config field of the given PUSB.

func (PUSBClass) GetPassthroughEnabled 

func (_class PUSBClass) GetPassthroughEnabled(sessionID SessionRef, self PUSBRef) (_retval bool, _err error)

GetPassthroughEnabled Get the passthrough_enabled field of the given PUSB.

func (PUSBClass) GetPath 

func (_class PUSBClass) GetPath(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetPath Get the path field of the given PUSB.

func (PUSBClass) GetProductDesc 

func (_class PUSBClass) GetProductDesc(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetProductDesc Get the product_desc field of the given PUSB.

func (PUSBClass) GetProductID 

func (_class PUSBClass) GetProductID(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetProductID Get the product_id field of the given PUSB.

func (PUSBClass) GetRecord 

func (_class PUSBClass) GetRecord(sessionID SessionRef, self PUSBRef) (_retval PUSBRecord, _err error)

GetRecord Get a record containing the current state of the given PUSB.

func (PUSBClass) GetSerial 

func (_class PUSBClass) GetSerial(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetSerial Get the serial field of the given PUSB.

func (PUSBClass) GetSpeed 

func (_class PUSBClass) GetSpeed(sessionID SessionRef, self PUSBRef) (_retval float64, _err error)

GetSpeed Get the speed field of the given PUSB.

func (PUSBClass) GetUSBGroup 

func (_class PUSBClass) GetUSBGroup(sessionID SessionRef, self PUSBRef) (_retval USBGroupRef, _err error)

GetUSBGroup Get the USB_group field of the given PUSB.

func (PUSBClass) GetUUID 

func (_class PUSBClass) GetUUID(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PUSB.

func (PUSBClass) GetVendorDesc 

func (_class PUSBClass) GetVendorDesc(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetVendorDesc Get the vendor_desc field of the given PUSB.

func (PUSBClass) GetVendorID 

func (_class PUSBClass) GetVendorID(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetVendorID Get the vendor_id field of the given PUSB.

func (PUSBClass) GetVersion 

func (_class PUSBClass) GetVersion(sessionID SessionRef, self PUSBRef) (_retval string, _err error)

GetVersion Get the version field of the given PUSB.

func (PUSBClass) RemoveFromOtherConfig 

func (_class PUSBClass) RemoveFromOtherConfig(sessionID SessionRef, self PUSBRef, key string) (_err error)

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

func (PUSBClass) Scan 

func (_class PUSBClass) Scan(sessionID SessionRef, host HostRef) (_err error)

Scan

func (PUSBClass) SetOtherConfig 

func (_class PUSBClass) SetOtherConfig(sessionID SessionRef, self PUSBRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given PUSB.

func (PUSBClass) SetPassthroughEnabled 

func (_class PUSBClass) SetPassthroughEnabled(sessionID SessionRef, self PUSBRef, value bool) (_err error)

SetPassthroughEnabled

type PUSBRecord 

type PUSBRecord struct {
	// Unique identifier/object reference
	UUID string
	// USB group the PUSB is contained in
	USBGroup USBGroupRef
	// Physical machine that owns the USB device
	Host HostRef
	// port path of USB device
	Path string
	// vendor id of the USB device
	VendorID string
	// vendor description of the USB device
	VendorDesc string
	// product id of the USB device
	ProductID string
	// product description of the USB device
	ProductDesc string
	// serial of the USB device
	Serial string
	// USB device version
	Version string
	// USB device description
	Description string
	// enabled for passthrough
	PassthroughEnabled bool
	// additional configuration
	OtherConfig map[string]string
	// USB device speed
	Speed float64
}

type PUSBRef 

type PUSBRef string

type PVSCacheStorageClass 

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

Describes the storage that is available to a PVS site for caching purposes

func (PVSCacheStorageClass) Create 

func (_class PVSCacheStorageClass) Create(sessionID SessionRef, args PVSCacheStorageRecord) (_retval PVSCacheStorageRef, _err error)

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

func (PVSCacheStorageClass) Destroy 

func (_class PVSCacheStorageClass) Destroy(sessionID SessionRef, self PVSCacheStorageRef) (_err error)

Destroy Destroy the specified PVS_cache_storage instance.

func (PVSCacheStorageClass) GetAll 

func (_class PVSCacheStorageClass) GetAll(sessionID SessionRef) (_retval []PVSCacheStorageRef, _err error)

GetAll Return a list of all the PVS_cache_storages known to the system.

func (PVSCacheStorageClass) GetAllRecords 

func (_class PVSCacheStorageClass) GetAllRecords(sessionID SessionRef) (_retval map[PVSCacheStorageRef]PVSCacheStorageRecord, _err error)

GetAllRecords Return a map of PVS_cache_storage references to PVS_cache_storage records for all PVS_cache_storages known to the system.

func (PVSCacheStorageClass) GetByUUID 

func (_class PVSCacheStorageClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PVSCacheStorageRef, _err error)

GetByUUID Get a reference to the PVS_cache_storage instance with the specified UUID.

func (PVSCacheStorageClass) GetHost 

func (_class PVSCacheStorageClass) GetHost(sessionID SessionRef, self PVSCacheStorageRef) (_retval HostRef, _err error)

GetHost Get the host field of the given PVS_cache_storage.

func (PVSCacheStorageClass) GetRecord 

func (_class PVSCacheStorageClass) GetRecord(sessionID SessionRef, self PVSCacheStorageRef) (_retval PVSCacheStorageRecord, _err error)

GetRecord Get a record containing the current state of the given PVS_cache_storage.

func (PVSCacheStorageClass) GetSR 

func (_class PVSCacheStorageClass) GetSR(sessionID SessionRef, self PVSCacheStorageRef) (_retval SRRef, _err error)

GetSR Get the SR field of the given PVS_cache_storage.

func (PVSCacheStorageClass) GetSite 

func (_class PVSCacheStorageClass) GetSite(sessionID SessionRef, self PVSCacheStorageRef) (_retval PVSSiteRef, _err error)

GetSite Get the site field of the given PVS_cache_storage.

func (PVSCacheStorageClass) GetSize 

func (_class PVSCacheStorageClass) GetSize(sessionID SessionRef, self PVSCacheStorageRef) (_retval int, _err error)

GetSize Get the size field of the given PVS_cache_storage.

func (PVSCacheStorageClass) GetUUID 

func (_class PVSCacheStorageClass) GetUUID(sessionID SessionRef, self PVSCacheStorageRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PVS_cache_storage.

func (PVSCacheStorageClass) GetVDI 

func (_class PVSCacheStorageClass) GetVDI(sessionID SessionRef, self PVSCacheStorageRef) (_retval VDIRef, _err error)

GetVDI Get the VDI field of the given PVS_cache_storage.

type PVSCacheStorageRecord 

type PVSCacheStorageRecord struct {
	// Unique identifier/object reference
	UUID string
	// The host on which this object defines PVS cache storage
	Host HostRef
	// SR providing storage for the PVS cache
	SR SRRef
	// The PVS_site for which this object defines the storage
	Site PVSSiteRef
	// The size of the cache VDI (in bytes)
	Size int
	// The VDI used for caching
	VDI VDIRef
}

type PVSCacheStorageRef 

type PVSCacheStorageRef string

type PVSProxyClass 

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

a proxy connects a VM/VIF with a PVS site

func (PVSProxyClass) Create 

func (_class PVSProxyClass) Create(sessionID SessionRef, site PVSSiteRef, vif VIFRef) (_retval PVSProxyRef, _err error)

Create Configure a VM/VIF to use a PVS proxy

func (PVSProxyClass) Destroy 

func (_class PVSProxyClass) Destroy(sessionID SessionRef, self PVSProxyRef) (_err error)

Destroy remove (or switch off) a PVS proxy for this VM

func (PVSProxyClass) GetAll 

func (_class PVSProxyClass) GetAll(sessionID SessionRef) (_retval []PVSProxyRef, _err error)

GetAll Return a list of all the PVS_proxys known to the system.

func (PVSProxyClass) GetAllRecords 

func (_class PVSProxyClass) GetAllRecords(sessionID SessionRef) (_retval map[PVSProxyRef]PVSProxyRecord, _err error)

GetAllRecords Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system.

func (PVSProxyClass) GetByUUID 

func (_class PVSProxyClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PVSProxyRef, _err error)

GetByUUID Get a reference to the PVS_proxy instance with the specified UUID.

func (PVSProxyClass) GetCurrentlyAttached 

func (_class PVSProxyClass) GetCurrentlyAttached(sessionID SessionRef, self PVSProxyRef) (_retval bool, _err error)

GetCurrentlyAttached Get the currently_attached field of the given PVS_proxy.

func (PVSProxyClass) GetRecord 

func (_class PVSProxyClass) GetRecord(sessionID SessionRef, self PVSProxyRef) (_retval PVSProxyRecord, _err error)

GetRecord Get a record containing the current state of the given PVS_proxy.

func (PVSProxyClass) GetSite 

func (_class PVSProxyClass) GetSite(sessionID SessionRef, self PVSProxyRef) (_retval PVSSiteRef, _err error)

GetSite Get the site field of the given PVS_proxy.

func (PVSProxyClass) GetStatus 

func (_class PVSProxyClass) GetStatus(sessionID SessionRef, self PVSProxyRef) (_retval PvsProxyStatus, _err error)

GetStatus Get the status field of the given PVS_proxy.

func (PVSProxyClass) GetUUID 

func (_class PVSProxyClass) GetUUID(sessionID SessionRef, self PVSProxyRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PVS_proxy.

func (PVSProxyClass) GetVIF 

func (_class PVSProxyClass) GetVIF(sessionID SessionRef, self PVSProxyRef) (_retval VIFRef, _err error)

GetVIF Get the VIF field of the given PVS_proxy.

type PVSProxyRecord 

type PVSProxyRecord struct {
	// Unique identifier/object reference
	UUID string
	// PVS site this proxy is part of
	Site PVSSiteRef
	// VIF of the VM using the proxy
	VIF VIFRef
	// true = VM is currently proxied
	CurrentlyAttached bool
	// The run-time status of the proxy
	Status PvsProxyStatus
}

type PVSProxyRef 

type PVSProxyRef string

type PVSServerClass 

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

individual machine serving provisioning (block) data

func (PVSServerClass) Forget 

func (_class PVSServerClass) Forget(sessionID SessionRef, self PVSServerRef) (_err error)

Forget forget a PVS server

func (PVSServerClass) GetAddresses 

func (_class PVSServerClass) GetAddresses(sessionID SessionRef, self PVSServerRef) (_retval []string, _err error)

GetAddresses Get the addresses field of the given PVS_server.

func (PVSServerClass) GetAll 

func (_class PVSServerClass) GetAll(sessionID SessionRef) (_retval []PVSServerRef, _err error)

GetAll Return a list of all the PVS_servers known to the system.

func (PVSServerClass) GetAllRecords 

func (_class PVSServerClass) GetAllRecords(sessionID SessionRef) (_retval map[PVSServerRef]PVSServerRecord, _err error)

GetAllRecords Return a map of PVS_server references to PVS_server records for all PVS_servers known to the system.

func (PVSServerClass) GetByUUID 

func (_class PVSServerClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PVSServerRef, _err error)

GetByUUID Get a reference to the PVS_server instance with the specified UUID.

func (PVSServerClass) GetFirstPort 

func (_class PVSServerClass) GetFirstPort(sessionID SessionRef, self PVSServerRef) (_retval int, _err error)

GetFirstPort Get the first_port field of the given PVS_server.

func (PVSServerClass) GetLastPort 

func (_class PVSServerClass) GetLastPort(sessionID SessionRef, self PVSServerRef) (_retval int, _err error)

GetLastPort Get the last_port field of the given PVS_server.

func (PVSServerClass) GetRecord 

func (_class PVSServerClass) GetRecord(sessionID SessionRef, self PVSServerRef) (_retval PVSServerRecord, _err error)

GetRecord Get a record containing the current state of the given PVS_server.

func (PVSServerClass) GetSite 

func (_class PVSServerClass) GetSite(sessionID SessionRef, self PVSServerRef) (_retval PVSSiteRef, _err error)

GetSite Get the site field of the given PVS_server.

func (PVSServerClass) GetUUID 

func (_class PVSServerClass) GetUUID(sessionID SessionRef, self PVSServerRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PVS_server.

func (PVSServerClass) Introduce 

func (_class PVSServerClass) Introduce(sessionID SessionRef, addresses []string, firstPort int, lastPort int, site PVSSiteRef) (_retval PVSServerRef, _err error)

Introduce introduce new PVS server

type PVSServerRecord 

type PVSServerRecord struct {
	// Unique identifier/object reference
	UUID string
	// IPv4 addresses of this server
	Addresses []string
	// First UDP port accepted by this server
	FirstPort int
	// Last UDP port accepted by this server
	LastPort int
	// PVS site this server is part of
	Site PVSSiteRef
}

type PVSServerRef 

type PVSServerRef string

type PVSSiteClass 

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

machines serving blocks of data for provisioning VMs

func (PVSSiteClass) Forget 

func (_class PVSSiteClass) Forget(sessionID SessionRef, self PVSSiteRef) (_err error)

Forget Remove a site's meta data

Errors: 

PVS_SITE_CONTAINS_RUNNING_PROXIES - The PVS site contains running proxies.
PVS_SITE_CONTAINS_SERVERS - The PVS site contains servers and cannot be forgotten.

func (PVSSiteClass) GetAll 

func (_class PVSSiteClass) GetAll(sessionID SessionRef) (_retval []PVSSiteRef, _err error)

GetAll Return a list of all the PVS_sites known to the system.

func (PVSSiteClass) GetAllRecords 

func (_class PVSSiteClass) GetAllRecords(sessionID SessionRef) (_retval map[PVSSiteRef]PVSSiteRecord, _err error)

GetAllRecords Return a map of PVS_site references to PVS_site records for all PVS_sites known to the system.

func (PVSSiteClass) GetByNameLabel 

func (_class PVSSiteClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []PVSSiteRef, _err error)

GetByNameLabel Get all the PVS_site instances with the given label.

func (PVSSiteClass) GetByUUID 

func (_class PVSSiteClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PVSSiteRef, _err error)

GetByUUID Get a reference to the PVS_site instance with the specified UUID.

func (PVSSiteClass) GetCacheStorage 

func (_class PVSSiteClass) GetCacheStorage(sessionID SessionRef, self PVSSiteRef) (_retval []PVSCacheStorageRef, _err error)

GetCacheStorage Get the cache_storage field of the given PVS_site.

func (PVSSiteClass) GetNameDescription 

func (_class PVSSiteClass) GetNameDescription(sessionID SessionRef, self PVSSiteRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given PVS_site.

func (PVSSiteClass) GetNameLabel 

func (_class PVSSiteClass) GetNameLabel(sessionID SessionRef, self PVSSiteRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given PVS_site.

func (PVSSiteClass) GetPVSUUID 

func (_class PVSSiteClass) GetPVSUUID(sessionID SessionRef, self PVSSiteRef) (_retval string, _err error)

GetPVSUUID Get the PVS_uuid field of the given PVS_site.

func (PVSSiteClass) GetProxies 

func (_class PVSSiteClass) GetProxies(sessionID SessionRef, self PVSSiteRef) (_retval []PVSProxyRef, _err error)

GetProxies Get the proxies field of the given PVS_site.

func (PVSSiteClass) GetRecord 

func (_class PVSSiteClass) GetRecord(sessionID SessionRef, self PVSSiteRef) (_retval PVSSiteRecord, _err error)

GetRecord Get a record containing the current state of the given PVS_site.

func (PVSSiteClass) GetServers 

func (_class PVSSiteClass) GetServers(sessionID SessionRef, self PVSSiteRef) (_retval []PVSServerRef, _err error)

GetServers Get the servers field of the given PVS_site.

func (PVSSiteClass) GetUUID 

func (_class PVSSiteClass) GetUUID(sessionID SessionRef, self PVSSiteRef) (_retval string, _err error)

GetUUID Get the uuid field of the given PVS_site.

func (PVSSiteClass) Introduce 

func (_class PVSSiteClass) Introduce(sessionID SessionRef, nameLabel string, nameDescription string, pvsUUID string) (_retval PVSSiteRef, _err error)

Introduce Introduce new PVS site

func (PVSSiteClass) SetNameDescription 

func (_class PVSSiteClass) SetNameDescription(sessionID SessionRef, self PVSSiteRef, value string) (_err error)

SetNameDescription Set the name/description field of the given PVS_site.

func (PVSSiteClass) SetNameLabel 

func (_class PVSSiteClass) SetNameLabel(sessionID SessionRef, self PVSSiteRef, value string) (_err error)

SetNameLabel Set the name/label field of the given PVS_site.

func (PVSSiteClass) SetPVSUUID 

func (_class PVSSiteClass) SetPVSUUID(sessionID SessionRef, self PVSSiteRef, value string) (_err error)

SetPVSUUID Update the PVS UUID of the PVS site

type PVSSiteRecord 

type PVSSiteRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Unique identifier of the PVS site, as configured in PVS
	PVSUUID string
	// The SR used by PVS proxy for the cache
	CacheStorage []PVSCacheStorageRef
	// The set of PVS servers in the site
	Servers []PVSServerRef
	// The set of proxies associated with the site
	Proxies []PVSProxyRef
}

type PVSSiteRef 

type PVSSiteRef string

type PersistenceBackend 

type PersistenceBackend string
const (
	// This VTPM is persisted in XAPI's DB
	PersistenceBackendXapi PersistenceBackend = "xapi"
)

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 PifIgmpStatus 

type PifIgmpStatus string
const (
	// IGMP Snooping is enabled in the corresponding backend bridge.'
	PifIgmpStatusEnabled PifIgmpStatus = "enabled"
	// IGMP Snooping is disabled in the corresponding backend bridge.'
	PifIgmpStatusDisabled PifIgmpStatus = "disabled"
	// IGMP snooping status is unknown. If this is a VLAN master, then please consult the underlying VLAN slave PIF.
	PifIgmpStatusUnknown PifIgmpStatus = "unknown"
)

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"
	// Indicates this pool is in the process of creating a cluster
	PoolAllowedOperationsClusterCreate PoolAllowedOperations = "cluster_create"
	// Indicates this pool is in the process of changing master
	PoolAllowedOperationsDesignateNewMaster PoolAllowedOperations = "designate_new_master"
	// Indicates this pool is in the process of configuring repositories
	PoolAllowedOperationsConfigureRepositories PoolAllowedOperations = "configure_repositories"
	// Indicates this pool is in the process of syncing updates
	PoolAllowedOperationsSyncUpdates PoolAllowedOperations = "sync_updates"
	// Indicates this pool is in the process of getting updates
	PoolAllowedOperationsGetUpdates PoolAllowedOperations = "get_updates"
	// Indicates this pool is in the process of applying updates
	PoolAllowedOperationsApplyUpdates PoolAllowedOperations = "apply_updates"
	// Indicates this pool is in the process of enabling TLS verification
	PoolAllowedOperationsTLSVerificationEnable PoolAllowedOperations = "tls_verification_enable"
	// A certificate refresh and distribution is in progress
	PoolAllowedOperationsCertRefresh PoolAllowedOperations = "cert_refresh"
	// Indicates this pool is exchanging internal certificates with a new joiner
	PoolAllowedOperationsExchangeCertificatesOnJoin PoolAllowedOperations = "exchange_certificates_on_join"
	// Indicates this pool is exchanging ca certificates with a new joiner
	PoolAllowedOperationsExchangeCaCertificatesOnJoin PoolAllowedOperations = "exchange_ca_certificates_on_join"
	// Indicates the primary host is sending its certificates to another host
	PoolAllowedOperationsCopyPrimaryHostCerts PoolAllowedOperations = "copy_primary_host_certs"
)

type PoolClass 

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

Pool-wide information

func (PoolClass) AddRepository 

func (_class PoolClass) AddRepository(sessionID SessionRef, self PoolRef, value RepositoryRef) (_err error)

AddRepository Add a repository to the enabled set

func (PoolClass) AddTags 

func (_class PoolClass) AddTags(sessionID SessionRef, self PoolRef, value string) (_err error)

AddTags 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) AddToGuestAgentConfig 

func (_class PoolClass) AddToGuestAgentConfig(sessionID SessionRef, self PoolRef, key string, value string) (_err error)

AddToGuestAgentConfig Add a key-value pair to the pool-wide guest agent configuration

func (PoolClass) AddToGuiConfig 

func (_class PoolClass) AddToGuiConfig(sessionID SessionRef, self PoolRef, key string, value string) (_err error)

AddToGuiConfig 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)

AddToHealthCheckConfig 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)

AddToOtherConfig 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)

ApplyEdition Apply an edition to all hosts in the pool

func (PoolClass) CertificateInstall 

func (_class PoolClass) CertificateInstall(sessionID SessionRef, name string, cert string) (_err error)

CertificateInstall Install a TLS CA certificate, pool-wide.

func (PoolClass) CertificateList 

func (_class PoolClass) CertificateList(sessionID SessionRef) (_retval []string, _err error)

CertificateList List the names of all installed TLS CA certificates.

func (PoolClass) CertificateSync 

func (_class PoolClass) CertificateSync(sessionID SessionRef) (_err error)

CertificateSync Copy the TLS CA certificates and CRLs of the master to all slaves.

func (PoolClass) CertificateUninstall 

func (_class PoolClass) CertificateUninstall(sessionID SessionRef, name string) (_err error)

CertificateUninstall Remove a pool-wide TLS CA certificate.

func (PoolClass) CheckUpdateReadiness 

func (_class PoolClass) CheckUpdateReadiness(sessionID SessionRef, self PoolRef, requiresReboot bool) (_retval [][]string, _err error)

CheckUpdateReadiness Check if the pool is ready to be updated. If not, report the reasons.

func (PoolClass) ConfigureRepositoryProxy 

func (_class PoolClass) ConfigureRepositoryProxy(sessionID SessionRef, self PoolRef, url string, username string, password string) (_err error)

ConfigureRepositoryProxy Configure proxy for RPM package repositories.

func (PoolClass) CreateNewBlob 

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

CreateNewBlob 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)

CreateVLAN 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)

CreateVLANFromPIF 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)

CrlInstall Install a TLS CA-issued Certificate Revocation List, pool-wide.

func (PoolClass) CrlList 

func (_class PoolClass) CrlList(sessionID SessionRef) (_retval []string, _err error)

CrlList List the names of all installed TLS CA-issued Certificate Revocation Lists.

func (PoolClass) CrlUninstall 

func (_class PoolClass) CrlUninstall(sessionID SessionRef, name string) (_err error)

CrlUninstall Remove a pool-wide TLS CA-issued Certificate Revocation List.

func (PoolClass) DeconfigureWlb 

func (_class PoolClass) DeconfigureWlb(sessionID SessionRef) (_err error)

DeconfigureWlb Permanently deconfigures workload balancing monitoring on this pool

func (PoolClass) DesignateNewMaster 

func (_class PoolClass) DesignateNewMaster(sessionID SessionRef, host HostRef) (_err error)

DesignateNewMaster 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)

DetectNonhomogeneousExternalAuth 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) DisableClientCertificateAuth 

func (_class PoolClass) DisableClientCertificateAuth(sessionID SessionRef, self PoolRef) (_err error)

DisableClientCertificateAuth Disable client certificate authentication on the pool

func (PoolClass) DisableExternalAuth 

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

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

func (PoolClass) DisableHa 

func (_class PoolClass) DisableHa(sessionID SessionRef) (_err error)

DisableHa Turn off High Availability mode

func (PoolClass) DisableLocalStorageCaching 

func (_class PoolClass) DisableLocalStorageCaching(sessionID SessionRef, self PoolRef) (_err error)

DisableLocalStorageCaching This call disables pool-wide local storage caching

func (PoolClass) DisableRedoLog 

func (_class PoolClass) DisableRedoLog(sessionID SessionRef) (_err error)

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

func (PoolClass) DisableRepositoryProxy 

func (_class PoolClass) DisableRepositoryProxy(sessionID SessionRef, self PoolRef) (_err error)

DisableRepositoryProxy Disable the proxy for RPM package repositories.

func (PoolClass) DisableSslLegacy 

func (_class PoolClass) DisableSslLegacy(sessionID SessionRef, self PoolRef) (_err error)

DisableSslLegacy Sets ssl_legacy false on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.

func (PoolClass) Eject 

func (_class PoolClass) Eject(sessionID SessionRef, host HostRef) (_err error)

Eject Instruct a pool master to eject a host from the pool

func (PoolClass) EmergencyResetMaster 

func (_class PoolClass) EmergencyResetMaster(sessionID SessionRef, masterAddress string) (_err error)

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

func (PoolClass) EmergencyTransitionToMaster 

func (_class PoolClass) EmergencyTransitionToMaster(sessionID SessionRef) (_err error)

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

func (PoolClass) EnableClientCertificateAuth 

func (_class PoolClass) EnableClientCertificateAuth(sessionID SessionRef, self PoolRef, name string) (_err error)

EnableClientCertificateAuth Enable client certificate authentication on the pool

func (PoolClass) EnableExternalAuth 

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

EnableExternalAuth 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)

EnableHa Turn on High Availability mode

func (PoolClass) EnableLocalStorageCaching 

func (_class PoolClass) EnableLocalStorageCaching(sessionID SessionRef, self PoolRef) (_err error)

EnableLocalStorageCaching This call attempts to enable pool-wide local storage caching

func (PoolClass) EnableRedoLog 

func (_class PoolClass) EnableRedoLog(sessionID SessionRef, sr SRRef) (_err error)

EnableRedoLog 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)

EnableSslLegacy Sets ssl_legacy true on each host, pool-master last. See Host.ssl_legacy and Host.set_ssl_legacy.

func (PoolClass) EnableTLSVerification 

func (_class PoolClass) EnableTLSVerification(sessionID SessionRef) (_err error)

EnableTLSVerification Enable TLS server certificate verification

func (PoolClass) GetAll 

func (_class PoolClass) GetAll(sessionID SessionRef) (_retval []PoolRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations 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)

GetBlobs Get the blobs field of the given pool.

func (PoolClass) GetByUUID 

func (_class PoolClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PoolRef, _err error)

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

func (PoolClass) GetCPUInfo 

func (_class PoolClass) GetCPUInfo(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

GetCPUInfo Get the cpu_info field of the given pool.

func (PoolClass) GetClientCertificateAuthEnabled 

func (_class PoolClass) GetClientCertificateAuthEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetClientCertificateAuthEnabled Get the client_certificate_auth_enabled field of the given pool.

func (PoolClass) GetClientCertificateAuthName 

func (_class PoolClass) GetClientCertificateAuthName(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetClientCertificateAuthName Get the client_certificate_auth_name field of the given pool.

func (PoolClass) GetCoordinatorBias 

func (_class PoolClass) GetCoordinatorBias(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetCoordinatorBias Get the coordinator_bias field of the given pool.

func (PoolClass) GetCrashDumpSR 

func (_class PoolClass) GetCrashDumpSR(sessionID SessionRef, self PoolRef) (_retval SRRef, _err error)

GetCrashDumpSR 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)

GetCurrentOperations Get the current_operations field of the given pool.

func (PoolClass) GetDefaultSR 

func (_class PoolClass) GetDefaultSR(sessionID SessionRef, self PoolRef) (_retval SRRef, _err error)

GetDefaultSR Get the default_SR field of the given pool.

func (PoolClass) GetGuestAgentConfig 

func (_class PoolClass) GetGuestAgentConfig(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

GetGuestAgentConfig Get the guest_agent_config field of the given pool.

func (PoolClass) GetGuiConfig 

func (_class PoolClass) GetGuiConfig(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

GetGuiConfig Get the gui_config field of the given pool.

func (PoolClass) GetHaAllowOvercommit 

func (_class PoolClass) GetHaAllowOvercommit(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetHaAllowOvercommit 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)

GetHaClusterStack 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)

GetHaConfiguration Get the ha_configuration field of the given pool.

func (PoolClass) GetHaEnabled 

func (_class PoolClass) GetHaEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetHaEnabled Get the ha_enabled field of the given pool.

func (PoolClass) GetHaHostFailuresToTolerate 

func (_class PoolClass) GetHaHostFailuresToTolerate(sessionID SessionRef, self PoolRef) (_retval int, _err error)

GetHaHostFailuresToTolerate 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)

GetHaOvercommitted Get the ha_overcommitted field of the given pool.

func (PoolClass) GetHaPlanExistsFor 

func (_class PoolClass) GetHaPlanExistsFor(sessionID SessionRef, self PoolRef) (_retval int, _err error)

GetHaPlanExistsFor 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)

GetHaStatefiles 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)

GetHealthCheckConfig Get the health_check_config field of the given pool.

func (PoolClass) GetIgmpSnoopingEnabled 

func (_class PoolClass) GetIgmpSnoopingEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetIgmpSnoopingEnabled Get the igmp_snooping_enabled field of the given pool.

func (PoolClass) GetIsPsrPending 

func (_class PoolClass) GetIsPsrPending(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetIsPsrPending Get the is_psr_pending field of the given pool.

func (PoolClass) GetLicenseState 

func (_class PoolClass) GetLicenseState(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

GetLicenseState This call returns the license state for the pool

func (PoolClass) GetLivePatchingDisabled 

func (_class PoolClass) GetLivePatchingDisabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetLivePatchingDisabled Get the live_patching_disabled field of the given pool.

func (PoolClass) GetMaster 

func (_class PoolClass) GetMaster(sessionID SessionRef, self PoolRef) (_retval HostRef, _err error)

GetMaster Get the master field of the given pool.

func (PoolClass) GetMetadataVDIs 

func (_class PoolClass) GetMetadataVDIs(sessionID SessionRef, self PoolRef) (_retval []VDIRef, _err error)

GetMetadataVDIs Get the metadata_VDIs field of the given pool.

func (PoolClass) GetMigrationCompression 

func (_class PoolClass) GetMigrationCompression(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetMigrationCompression Get the migration_compression field of the given pool.

func (PoolClass) GetNameDescription 

func (_class PoolClass) GetNameDescription(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetNameDescription Get the name_description field of the given pool.

func (PoolClass) GetNameLabel 

func (_class PoolClass) GetNameLabel(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetNameLabel 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)

GetOtherConfig Get the other_config field of the given pool.

func (PoolClass) GetPolicyNoVendorDevice 

func (_class PoolClass) GetPolicyNoVendorDevice(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetPolicyNoVendorDevice Get the policy_no_vendor_device field of the given pool.

func (PoolClass) GetRecord 

func (_class PoolClass) GetRecord(sessionID SessionRef, self PoolRef) (_retval PoolRecord, _err error)

GetRecord 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)

GetRedoLogEnabled 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)

GetRedoLogVdi Get the redo_log_vdi field of the given pool.

func (PoolClass) GetRepositories 

func (_class PoolClass) GetRepositories(sessionID SessionRef, self PoolRef) (_retval []RepositoryRef, _err error)

GetRepositories Get the repositories field of the given pool.

func (PoolClass) GetRepositoryProxyPassword 

func (_class PoolClass) GetRepositoryProxyPassword(sessionID SessionRef, self PoolRef) (_retval SecretRef, _err error)

GetRepositoryProxyPassword Get the repository_proxy_password field of the given pool.

func (PoolClass) GetRepositoryProxyURL 

func (_class PoolClass) GetRepositoryProxyURL(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetRepositoryProxyURL Get the repository_proxy_url field of the given pool.

func (PoolClass) GetRepositoryProxyUsername 

func (_class PoolClass) GetRepositoryProxyUsername(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetRepositoryProxyUsername Get the repository_proxy_username field of the given pool.

func (PoolClass) GetRestrictions 

func (_class PoolClass) GetRestrictions(sessionID SessionRef, self PoolRef) (_retval map[string]string, _err error)

GetRestrictions Get the restrictions field of the given pool.

func (PoolClass) GetSuspendImageSR 

func (_class PoolClass) GetSuspendImageSR(sessionID SessionRef, self PoolRef) (_retval SRRef, _err error)

GetSuspendImageSR Get the suspend_image_SR field of the given pool.

func (PoolClass) GetTLSVerificationEnabled 

func (_class PoolClass) GetTLSVerificationEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetTLSVerificationEnabled Get the tls_verification_enabled field of the given pool.

func (PoolClass) GetTags 

func (_class PoolClass) GetTags(sessionID SessionRef, self PoolRef) (_retval []string, _err error)

GetTags Get the tags field of the given pool.

func (PoolClass) GetTelemetryFrequency 

func (_class PoolClass) GetTelemetryFrequency(sessionID SessionRef, self PoolRef) (_retval TelemetryFrequency, _err error)

GetTelemetryFrequency Get the telemetry_frequency field of the given pool.

func (PoolClass) GetTelemetryNextCollection 

func (_class PoolClass) GetTelemetryNextCollection(sessionID SessionRef, self PoolRef) (_retval time.Time, _err error)

GetTelemetryNextCollection Get the telemetry_next_collection field of the given pool.

func (PoolClass) GetTelemetryUUID 

func (_class PoolClass) GetTelemetryUUID(sessionID SessionRef, self PoolRef) (_retval SecretRef, _err error)

GetTelemetryUUID Get the telemetry_uuid field of the given pool.

func (PoolClass) GetUUID 

func (_class PoolClass) GetUUID(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetUUID Get the uuid field of the given pool.

func (PoolClass) GetUefiCertificates 

func (_class PoolClass) GetUefiCertificates(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetUefiCertificates Get the uefi_certificates field of the given pool.

func (PoolClass) GetVswitchController 

func (_class PoolClass) GetVswitchController(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetVswitchController Get the vswitch_controller field of the given pool.

func (PoolClass) GetWlbEnabled 

func (_class PoolClass) GetWlbEnabled(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetWlbEnabled Get the wlb_enabled field of the given pool.

func (PoolClass) GetWlbURL 

func (_class PoolClass) GetWlbURL(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetWlbURL Get the wlb_url field of the given pool.

func (PoolClass) GetWlbUsername 

func (_class PoolClass) GetWlbUsername(sessionID SessionRef, self PoolRef) (_retval string, _err error)

GetWlbUsername Get the wlb_username field of the given pool.

func (PoolClass) GetWlbVerifyCert 

func (_class PoolClass) GetWlbVerifyCert(sessionID SessionRef, self PoolRef) (_retval bool, _err error)

GetWlbVerifyCert 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)

HaComputeHypotheticalMaxHostFailuresToTolerate 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)

HaComputeMaxHostFailuresToTolerate 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)

HaComputeVMFailoverPlan 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)

HaFailoverPlanExists 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)

HaPreventRestartsFor 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) HasExtension 

func (_class PoolClass) HasExtension(sessionID SessionRef, self PoolRef, name string) (_retval bool, _err error)

HasExtension Return true if the extension is available on the pool

func (PoolClass) InitializeWlb 

func (_class PoolClass) InitializeWlb(sessionID SessionRef, wlbURL string, wlbUsername string, wlbPassword string, xenserverUsername string, xenserverPassword string) (_err error)

InitializeWlb Initializes workload balancing monitoring on this pool with the specified wlb server

func (PoolClass) InstallCaCertificate 

func (_class PoolClass) InstallCaCertificate(sessionID SessionRef, name string, cert string) (_err error)

InstallCaCertificate Install a TLS CA certificate, pool-wide.

func (PoolClass) Join 

func (_class PoolClass) Join(sessionID SessionRef, masterAddress string, masterUsername string, masterPassword string) (_err error)

Join Instruct host to join a new pool

Errors: 

JOINING_HOST_CANNOT_CONTAIN_SHARED_SRS - The server 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)

JoinForce Instruct host to join a new pool

func (PoolClass) ManagementReconfigure 

func (_class PoolClass) ManagementReconfigure(sessionID SessionRef, network NetworkRef) (_err error)

ManagementReconfigure Reconfigure the management network interface for all Hosts in the Pool

Errors: 

HA_IS_ENABLED - The operation could not be performed because HA is enabled on the Pool
PIF_NOT_PRESENT - This host has no PIF on the given network.
CANNOT_PLUG_BOND_SLAVE - This PIF is a bond member and cannot be plugged.
PIF_INCOMPATIBLE_PRIMARY_ADDRESS_TYPE - The primary address types are not compatible
PIF_HAS_NO_NETWORK_CONFIGURATION - PIF has no IP configuration (mode currently set to 'none')
PIF_HAS_NO_V6_NETWORK_CONFIGURATION - PIF has no IPv6 configuration (mode currently set to 'none')

func (PoolClass) RecoverSlaves 

func (_class PoolClass) RecoverSlaves(sessionID SessionRef) (_retval []HostRef, _err error)

RecoverSlaves 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) RemoveFromGuestAgentConfig 

func (_class PoolClass) RemoveFromGuestAgentConfig(sessionID SessionRef, self PoolRef, key string) (_err error)

RemoveFromGuestAgentConfig Remove a key-value pair from the pool-wide guest agent configuration

func (PoolClass) RemoveFromGuiConfig 

func (_class PoolClass) RemoveFromGuiConfig(sessionID SessionRef, self PoolRef, key string) (_err error)

RemoveFromGuiConfig 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)

RemoveFromHealthCheckConfig 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)

RemoveFromOtherConfig 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) RemoveRepository 

func (_class PoolClass) RemoveRepository(sessionID SessionRef, self PoolRef, value RepositoryRef) (_err error)

RemoveRepository Remove a repository from the enabled set

func (PoolClass) RemoveTags 

func (_class PoolClass) RemoveTags(sessionID SessionRef, self PoolRef, value string) (_err error)

RemoveTags 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) ResetTelemetryUUID 

func (_class PoolClass) ResetTelemetryUUID(sessionID SessionRef, self PoolRef) (_err error)

ResetTelemetryUUID Assign a new UUID to telemetry data.

func (PoolClass) RetrieveWlbConfiguration 

func (_class PoolClass) RetrieveWlbConfiguration(sessionID SessionRef) (_retval map[string]string, _err error)

RetrieveWlbConfiguration 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)

RetrieveWlbRecommendations Retrieves vm migrate recommendations for the pool from the workload balancing server

func (PoolClass) RotateSecret 

func (_class PoolClass) RotateSecret(sessionID SessionRef) (_err error)

RotateSecret

Errors: 

INTERNAL_ERROR - The server failed to handle your request, due to an internal error. The given message may give details useful for debugging the problem.
HOST_IS_SLAVE - You cannot make regular API calls directly on a supporter. Please pass API calls via the coordinator host.
CANNOT_CONTACT_HOST - Cannot forward messages because the server cannot be contacted. The server may be switched off or there may be network connectivity problems.
HA_IS_ENABLED - The operation could not be performed because HA is enabled on the Pool
NOT_SUPPORTED_DURING_UPGRADE - This operation is not supported during an upgrade.

func (PoolClass) SendTestPost 

func (_class PoolClass) SendTestPost(sessionID SessionRef, host string, port int, body string) (_retval string, _err error)

SendTestPost 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)

SendWlbConfiguration Sets the pool optimization criteria for the workload balancing server

func (PoolClass) SetCoordinatorBias 

func (_class PoolClass) SetCoordinatorBias(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetCoordinatorBias Set the coordinator_bias field of the given pool.

func (PoolClass) SetCrashDumpSR 

func (_class PoolClass) SetCrashDumpSR(sessionID SessionRef, self PoolRef, value SRRef) (_err error)

SetCrashDumpSR 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)

SetDefaultSR 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)

SetGuiConfig Set the gui_config field of the given pool.

func (PoolClass) SetHTTPSOnly 

func (_class PoolClass) SetHTTPSOnly(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetHTTPSOnly updates all the host firewalls in the pool to open or close port 80 depending on the value

func (PoolClass) SetHaAllowOvercommit 

func (_class PoolClass) SetHaAllowOvercommit(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetHaAllowOvercommit 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)

SetHaHostFailuresToTolerate 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)

SetHealthCheckConfig Set the health_check_config field of the given pool.

func (PoolClass) SetIgmpSnoopingEnabled 

func (_class PoolClass) SetIgmpSnoopingEnabled(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetIgmpSnoopingEnabled Enable or disable IGMP Snooping on the pool.

func (PoolClass) SetIsPsrPending 

func (_class PoolClass) SetIsPsrPending(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetIsPsrPending Set the is_psr_pending field of the given pool.

func (PoolClass) SetLivePatchingDisabled 

func (_class PoolClass) SetLivePatchingDisabled(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetLivePatchingDisabled Set the live_patching_disabled field of the given pool.

func (PoolClass) SetMigrationCompression 

func (_class PoolClass) SetMigrationCompression(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetMigrationCompression Set the migration_compression field of the given pool.

func (PoolClass) SetNameDescription 

func (_class PoolClass) SetNameDescription(sessionID SessionRef, self PoolRef, value string) (_err error)

SetNameDescription Set the name_description field of the given pool.

func (PoolClass) SetNameLabel 

func (_class PoolClass) SetNameLabel(sessionID SessionRef, self PoolRef, value string) (_err error)

SetNameLabel 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)

SetOtherConfig Set the other_config field of the given pool.

func (PoolClass) SetPolicyNoVendorDevice 

func (_class PoolClass) SetPolicyNoVendorDevice(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetPolicyNoVendorDevice Set the policy_no_vendor_device field of the given pool.

func (PoolClass) SetRepositories 

func (_class PoolClass) SetRepositories(sessionID SessionRef, self PoolRef, value []RepositoryRef) (_err error)

SetRepositories Set enabled set of repositories

func (PoolClass) SetSuspendImageSR 

func (_class PoolClass) SetSuspendImageSR(sessionID SessionRef, self PoolRef, value SRRef) (_err error)

SetSuspendImageSR 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)

SetTags Set the tags field of the given pool.

func (PoolClass) SetTelemetryNextCollection 

func (_class PoolClass) SetTelemetryNextCollection(sessionID SessionRef, self PoolRef, value time.Time) (_err error)

SetTelemetryNextCollection Set the timestamp for the next telemetry data collection.

func (PoolClass) SetUefiCertificates 

func (_class PoolClass) SetUefiCertificates(sessionID SessionRef, self PoolRef, value string) (_err error)

SetUefiCertificates Sets the UEFI certificates for a pool and all its hosts

func (PoolClass) SetVswitchController 

func (_class PoolClass) SetVswitchController(sessionID SessionRef, address string) (_err error)

SetVswitchController Set the IP address of the vswitch controller.

func (PoolClass) SetWlbEnabled 

func (_class PoolClass) SetWlbEnabled(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetWlbEnabled Set the wlb_enabled field of the given pool.

func (PoolClass) SetWlbVerifyCert 

func (_class PoolClass) SetWlbVerifyCert(sessionID SessionRef, self PoolRef, value bool) (_err error)

SetWlbVerifyCert Set the wlb_verify_cert field of the given pool.

func (PoolClass) SyncDatabase 

func (_class PoolClass) SyncDatabase(sessionID SessionRef) (_err error)

SyncDatabase Forcibly synchronise the database now

func (PoolClass) SyncUpdates 

func (_class PoolClass) SyncUpdates(sessionID SessionRef, self PoolRef, force bool, token string, tokenID string) (_retval string, _err error)

SyncUpdates Sync with the enabled repository

func (PoolClass) TestArchiveTarget 

func (_class PoolClass) TestArchiveTarget(sessionID SessionRef, self PoolRef, config map[string]string) (_retval string, _err error)

TestArchiveTarget This call tests if a location is valid

func (PoolClass) UninstallCaCertificate 

func (_class PoolClass) UninstallCaCertificate(sessionID SessionRef, name string) (_err error)

UninstallCaCertificate Remove a pool-wide TLS CA certificate.

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)

AddToOtherConfig 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 Apply the selected patch to a host and return its output

func (PoolPatchClass) Clean 

func (_class PoolPatchClass) Clean(sessionID SessionRef, self PoolPatchRef) (_err error)

Clean Removes the patch's files from the server

func (PoolPatchClass) CleanOnHost 

func (_class PoolPatchClass) CleanOnHost(sessionID SessionRef, self PoolPatchRef, host HostRef) (_err error)

CleanOnHost Removes the patch's files from the specified host

func (PoolPatchClass) Destroy 

func (_class PoolPatchClass) Destroy(sessionID SessionRef, self PoolPatchRef) (_err error)

Destroy 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)

GetAfterApplyGuidance Get the after_apply_guidance field of the given pool_patch.

func (PoolPatchClass) GetAll 

func (_class PoolPatchClass) GetAll(sessionID SessionRef) (_retval []PoolPatchRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByNameLabel 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)

GetByUUID 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)

GetHostPatches 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)

GetNameDescription 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)

GetNameLabel 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)

GetOtherConfig 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)

GetPoolApplied Get the pool_applied field of the given pool_patch.

func (PoolPatchClass) GetPoolUpdate 

func (_class PoolPatchClass) GetPoolUpdate(sessionID SessionRef, self PoolPatchRef) (_retval PoolUpdateRef, _err error)

GetPoolUpdate Get the pool_update field of the given pool_patch.

func (PoolPatchClass) GetRecord 

func (_class PoolPatchClass) GetRecord(sessionID SessionRef, self PoolPatchRef) (_retval PoolPatchRecord, _err error)

GetRecord 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)

GetSize Get the size field of the given pool_patch.

func (PoolPatchClass) GetUUID 

func (_class PoolPatchClass) GetUUID(sessionID SessionRef, self PoolPatchRef) (_retval string, _err error)

GetUUID Get the uuid field of the given pool_patch.

func (PoolPatchClass) GetVersion 

func (_class PoolPatchClass) GetVersion(sessionID SessionRef, self PoolPatchRef) (_retval string, _err error)

GetVersion Get the version field of the given pool_patch.

func (PoolPatchClass) PoolApply 

func (_class PoolPatchClass) PoolApply(sessionID SessionRef, self PoolPatchRef) (_err error)

PoolApply 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)

PoolClean 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)

Precheck 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)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// A reference to the associated pool_update object
	PoolUpdate PoolUpdateRef
	// 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 TLS 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
	// Pool-wide guest agent configuration information
	GuestAgentConfig map[string]string
	// Details about the physical CPUs on the pool
	CPUInfo map[string]string
	// The pool-wide policy for clients on whether to use the vendor device or not on newly created VMs. This field will also be consulted if the 'has_vendor_device' field is not specified in the VM.create call.
	PolicyNoVendorDevice bool
	// The pool-wide flag to show if the live patching feauture is disabled or not.
	LivePatchingDisabled bool
	// true if IGMP snooping is enabled in the pool, false otherwise.
	IgmpSnoopingEnabled bool
	// The UEFI certificates allowing Secure Boot
	UefiCertificates string
	// True if either a PSR is running or we are waiting for a PSR to be re-run
	IsPsrPending bool
	// True iff TLS certificate verification is enabled
	TLSVerificationEnabled bool
	// The set of currently enabled repositories
	Repositories []RepositoryRef
	// True if authentication by TLS client certificates is enabled
	ClientCertificateAuthEnabled bool
	// The name (CN/SAN) that an incoming client certificate must have to allow authentication
	ClientCertificateAuthName string
	// Url of the proxy used in syncing with the enabled repositories
	RepositoryProxyURL string
	// Username for the authentication of the proxy used in syncing with the enabled repositories
	RepositoryProxyUsername string
	// Password for the authentication of the proxy used in syncing with the enabled repositories
	RepositoryProxyPassword SecretRef
	// Default behaviour during migration, True if stream compression should be used
	MigrationCompression bool
	// true if bias against pool master when scheduling vms is enabled, false otherwise
	CoordinatorBias bool
	// The UUID of the pool for identification of telemetry data
	TelemetryUUID SecretRef
	// How often the telemetry collection will be carried out
	TelemetryFrequency TelemetryFrequency
	// The earliest timestamp (in UTC) when the next round of telemetry collection can be carried out
	TelemetryNextCollection time.Time
}

type PoolRef 

type PoolRef string

type PoolUpdateClass 

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

Pool-wide updates to the host software

func (PoolUpdateClass) AddToOtherConfig 

func (_class PoolUpdateClass) AddToOtherConfig(sessionID SessionRef, self PoolUpdateRef, key string, value string) (_err error)

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

func (PoolUpdateClass) Apply 

func (_class PoolUpdateClass) Apply(sessionID SessionRef, self PoolUpdateRef, host HostRef) (_err error)

Apply Apply the selected update to a host

func (PoolUpdateClass) Destroy 

func (_class PoolUpdateClass) Destroy(sessionID SessionRef, self PoolUpdateRef) (_err error)

Destroy Removes the database entry. Only works on unapplied update.

func (PoolUpdateClass) GetAfterApplyGuidance 

func (_class PoolUpdateClass) GetAfterApplyGuidance(sessionID SessionRef, self PoolUpdateRef) (_retval []UpdateAfterApplyGuidance, _err error)

GetAfterApplyGuidance Get the after_apply_guidance field of the given pool_update.

func (PoolUpdateClass) GetAll 

func (_class PoolUpdateClass) GetAll(sessionID SessionRef) (_retval []PoolUpdateRef, _err error)

GetAll Return a list of all the pool_updates known to the system.

func (PoolUpdateClass) GetAllRecords 

func (_class PoolUpdateClass) GetAllRecords(sessionID SessionRef) (_retval map[PoolUpdateRef]PoolUpdateRecord, _err error)

GetAllRecords Return a map of pool_update references to pool_update records for all pool_updates known to the system.

func (PoolUpdateClass) GetByNameLabel 

func (_class PoolUpdateClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []PoolUpdateRef, _err error)

GetByNameLabel Get all the pool_update instances with the given label.

func (PoolUpdateClass) GetByUUID 

func (_class PoolUpdateClass) GetByUUID(sessionID SessionRef, uuid string) (_retval PoolUpdateRef, _err error)

GetByUUID Get a reference to the pool_update instance with the specified UUID.

func (PoolUpdateClass) GetEnforceHomogeneity 

func (_class PoolUpdateClass) GetEnforceHomogeneity(sessionID SessionRef, self PoolUpdateRef) (_retval bool, _err error)

GetEnforceHomogeneity Get the enforce_homogeneity field of the given pool_update.

func (PoolUpdateClass) GetHosts 

func (_class PoolUpdateClass) GetHosts(sessionID SessionRef, self PoolUpdateRef) (_retval []HostRef, _err error)

GetHosts Get the hosts field of the given pool_update.

func (PoolUpdateClass) GetInstallationSize 

func (_class PoolUpdateClass) GetInstallationSize(sessionID SessionRef, self PoolUpdateRef) (_retval int, _err error)

GetInstallationSize Get the installation_size field of the given pool_update.

func (PoolUpdateClass) GetKey 

func (_class PoolUpdateClass) GetKey(sessionID SessionRef, self PoolUpdateRef) (_retval string, _err error)

GetKey Get the key field of the given pool_update.

func (PoolUpdateClass) GetNameDescription 

func (_class PoolUpdateClass) GetNameDescription(sessionID SessionRef, self PoolUpdateRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given pool_update.

func (PoolUpdateClass) GetNameLabel 

func (_class PoolUpdateClass) GetNameLabel(sessionID SessionRef, self PoolUpdateRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given pool_update.

func (PoolUpdateClass) GetOtherConfig 

func (_class PoolUpdateClass) GetOtherConfig(sessionID SessionRef, self PoolUpdateRef) (_retval map[string]string, _err error)

GetOtherConfig Get the other_config field of the given pool_update.

func (PoolUpdateClass) GetRecord 

func (_class PoolUpdateClass) GetRecord(sessionID SessionRef, self PoolUpdateRef) (_retval PoolUpdateRecord, _err error)

GetRecord Get a record containing the current state of the given pool_update.

func (PoolUpdateClass) GetUUID 

func (_class PoolUpdateClass) GetUUID(sessionID SessionRef, self PoolUpdateRef) (_retval string, _err error)

GetUUID Get the uuid field of the given pool_update.

func (PoolUpdateClass) GetVdi 

func (_class PoolUpdateClass) GetVdi(sessionID SessionRef, self PoolUpdateRef) (_retval VDIRef, _err error)

GetVdi Get the vdi field of the given pool_update.

func (PoolUpdateClass) GetVersion 

func (_class PoolUpdateClass) GetVersion(sessionID SessionRef, self PoolUpdateRef) (_retval string, _err error)

GetVersion Get the version field of the given pool_update.

func (PoolUpdateClass) Introduce 

func (_class PoolUpdateClass) Introduce(sessionID SessionRef, vdi VDIRef) (_retval PoolUpdateRef, _err error)

Introduce Introduce update VDI

func (PoolUpdateClass) PoolApply 

func (_class PoolUpdateClass) PoolApply(sessionID SessionRef, self PoolUpdateRef) (_err error)

PoolApply Apply the selected update to all hosts in the pool

func (PoolUpdateClass) PoolClean 

func (_class PoolUpdateClass) PoolClean(sessionID SessionRef, self PoolUpdateRef) (_err error)

PoolClean Removes the update's files from all hosts in the pool, but does not revert the update

func (PoolUpdateClass) Precheck 

func (_class PoolUpdateClass) Precheck(sessionID SessionRef, self PoolUpdateRef, host HostRef) (_retval LivepatchStatus, _err error)

Precheck Execute the precheck stage of the selected update on a host

func (PoolUpdateClass) RemoveFromOtherConfig 

func (_class PoolUpdateClass) RemoveFromOtherConfig(sessionID SessionRef, self PoolUpdateRef, key string) (_err error)

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

func (PoolUpdateClass) SetOtherConfig 

func (_class PoolUpdateClass) SetOtherConfig(sessionID SessionRef, self PoolUpdateRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given pool_update.

type PoolUpdateRecord 

type PoolUpdateRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Update version number
	Version string
	// Size of the update in bytes
	InstallationSize int
	// GPG key of the update
	Key string
	// What the client should do after this update has been applied.
	AfterApplyGuidance []UpdateAfterApplyGuidance
	// VDI the update was uploaded to
	Vdi VDIRef
	// The hosts that have applied this update.
	Hosts []HostRef
	// additional configuration
	OtherConfig map[string]string
	// Flag - if true, all hosts in a pool must apply this update
	EnforceHomogeneity bool
}

type PoolUpdateRef 

type PoolUpdateRef 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 ProbeResultClass 

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

A set of properties that describe one result element of SR.probe. Result elements and properties can change dynamically based on changes to the the SR.probe input-parameters or the target.

type ProbeResultRecord 

type ProbeResultRecord struct {
	// Plugin-specific configuration which describes where and how to locate the storage repository. This may include the physical block device name, a remote NFS server and path or an RBD storage pool.
	Configuration map[string]string
	// True if this configuration is complete and can be used to call SR.create. False if it requires further iterative calls to SR.probe, to potentially narrow down on a configuration that can be used.
	Complete bool
	// Existing SR found for this configuration
	Sr SrStatRecord
	// Additional plugin-specific information about this configuration, that might be of use for an API user. This can for example include the LUN or the WWPN.
	ExtraInfo map[string]string
}

type ProbeResultRef 

type ProbeResultRef string

type PvsProxyStatus 

type PvsProxyStatus string
const (
	// The proxy is not currently running
	PvsProxyStatusStopped PvsProxyStatus = "stopped"
	// The proxy is setup but has not yet cached anything
	PvsProxyStatusInitialised PvsProxyStatus = "initialised"
	// The proxy is currently caching data
	PvsProxyStatusCaching PvsProxyStatus = "caching"
	// The PVS device is configured to use an incompatible write-cache mode
	PvsProxyStatusIncompatibleWriteCacheMode PvsProxyStatus = "incompatible_write_cache_mode"
	// The PVS protocol in use is not compatible with the PVS proxy
	PvsProxyStatusIncompatibleProtocolVersion PvsProxyStatus = "incompatible_protocol_version"
)

type RecordInterface 

type RecordInterface interface{}

type RepositoryClass 

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

Repository for updates

func (RepositoryClass) Forget 

func (_class RepositoryClass) Forget(sessionID SessionRef, self RepositoryRef) (_err error)

Forget Remove the repository record from the database

func (RepositoryClass) GetAll 

func (_class RepositoryClass) GetAll(sessionID SessionRef) (_retval []RepositoryRef, _err error)

GetAll Return a list of all the Repositorys known to the system.

func (RepositoryClass) GetAllRecords 

func (_class RepositoryClass) GetAllRecords(sessionID SessionRef) (_retval map[RepositoryRef]RepositoryRecord, _err error)

GetAllRecords Return a map of Repository references to Repository records for all Repositorys known to the system.

func (RepositoryClass) GetBinaryURL 

func (_class RepositoryClass) GetBinaryURL(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetBinaryURL Get the binary_url field of the given Repository.

func (RepositoryClass) GetByNameLabel 

func (_class RepositoryClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []RepositoryRef, _err error)

GetByNameLabel Get all the Repository instances with the given label.

func (RepositoryClass) GetByUUID 

func (_class RepositoryClass) GetByUUID(sessionID SessionRef, uuid string) (_retval RepositoryRef, _err error)

GetByUUID Get a reference to the Repository instance with the specified UUID.

func (RepositoryClass) GetGpgkeyPath 

func (_class RepositoryClass) GetGpgkeyPath(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetGpgkeyPath Get the gpgkey_path field of the given Repository.

func (RepositoryClass) GetHash 

func (_class RepositoryClass) GetHash(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetHash Get the hash field of the given Repository.

func (RepositoryClass) GetNameDescription 

func (_class RepositoryClass) GetNameDescription(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given Repository.

func (RepositoryClass) GetNameLabel 

func (_class RepositoryClass) GetNameLabel(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given Repository.

func (RepositoryClass) GetRecord 

func (_class RepositoryClass) GetRecord(sessionID SessionRef, self RepositoryRef) (_retval RepositoryRecord, _err error)

GetRecord Get a record containing the current state of the given Repository.

func (RepositoryClass) GetSourceURL 

func (_class RepositoryClass) GetSourceURL(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetSourceURL Get the source_url field of the given Repository.

func (RepositoryClass) GetUUID 

func (_class RepositoryClass) GetUUID(sessionID SessionRef, self RepositoryRef) (_retval string, _err error)

GetUUID Get the uuid field of the given Repository.

func (RepositoryClass) GetUpToDate 

func (_class RepositoryClass) GetUpToDate(sessionID SessionRef, self RepositoryRef) (_retval bool, _err error)

GetUpToDate Get the up_to_date field of the given Repository.

func (RepositoryClass) GetUpdate 

func (_class RepositoryClass) GetUpdate(sessionID SessionRef, self RepositoryRef) (_retval bool, _err error)

GetUpdate Get the update field of the given Repository.

func (RepositoryClass) Introduce 

func (_class RepositoryClass) Introduce(sessionID SessionRef, nameLabel string, nameDescription string, binaryURL string, sourceURL string, update bool, gpgkeyPath string) (_retval RepositoryRef, _err error)

Introduce Add the configuration for a new repository

func (RepositoryClass) SetGpgkeyPath 

func (_class RepositoryClass) SetGpgkeyPath(sessionID SessionRef, self RepositoryRef, value string) (_err error)

SetGpgkeyPath Set the file name of the GPG public key of the repository

func (RepositoryClass) SetNameDescription 

func (_class RepositoryClass) SetNameDescription(sessionID SessionRef, self RepositoryRef, value string) (_err error)

SetNameDescription Set the name/description field of the given Repository.

func (RepositoryClass) SetNameLabel 

func (_class RepositoryClass) SetNameLabel(sessionID SessionRef, self RepositoryRef, value string) (_err error)

SetNameLabel Set the name/label field of the given Repository.

type RepositoryRecord 

type RepositoryRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Base URL of binary packages in this repository
	BinaryURL string
	// Base URL of source packages in this repository
	SourceURL string
	// True if updateinfo.xml in this repository needs to be parsed
	Update bool
	// SHA256 checksum of latest updateinfo.xml.gz in this repository if its 'update' is true
	Hash string
	// True if all hosts in pool is up to date with this repository
	UpToDate bool
	// The file name of the GPG public key of this repository
	GpgkeyPath string
}

type RepositoryRef 

type RepositoryRef string

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)

GetAll 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)

GetAllRecords 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)

GetByNameLabel Get all the role instances with the given label.

func (RoleClass) GetByPermission 

func (_class RoleClass) GetByPermission(sessionID SessionRef, permission RoleRef) (_retval []RoleRef, _err error)

GetByPermission 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)

GetByPermissionNameLabel 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)

GetByUUID Get a reference to the role instance with the specified UUID.

func (RoleClass) GetIsInternal 

func (_class RoleClass) GetIsInternal(sessionID SessionRef, self RoleRef) (_retval bool, _err error)

GetIsInternal Get the is_internal field of the given role.

func (RoleClass) GetNameDescription 

func (_class RoleClass) GetNameDescription(sessionID SessionRef, self RoleRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given role.

func (RoleClass) GetNameLabel 

func (_class RoleClass) GetNameLabel(sessionID SessionRef, self RoleRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given role.

func (RoleClass) GetPermissions 

func (_class RoleClass) GetPermissions(sessionID SessionRef, self RoleRef) (_retval []RoleRef, _err error)

GetPermissions 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)

GetPermissionsNameLabel 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)

GetRecord 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)

GetSubroles Get the subroles field of the given role.

func (RoleClass) GetUUID 

func (_class RoleClass) GetUUID(sessionID SessionRef, self RoleRef) (_retval string, _err error)

GetUUID 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
	// Indicates whether the role is only to be assigned internally by xapi, or can be used by clients
	IsInternal bool
}

type RoleRef 

type RoleRef string

type SDNControllerClass 

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

Describes the SDN controller that is to connect with the pool

func (SDNControllerClass) Forget 

func (_class SDNControllerClass) Forget(sessionID SessionRef, self SDNControllerRef) (_err error)

Forget Remove the OVS manager of the pool and destroy the db record.

func (SDNControllerClass) GetAddress 

func (_class SDNControllerClass) GetAddress(sessionID SessionRef, self SDNControllerRef) (_retval string, _err error)

GetAddress Get the address field of the given SDN_controller.

func (SDNControllerClass) GetAll 

func (_class SDNControllerClass) GetAll(sessionID SessionRef) (_retval []SDNControllerRef, _err error)

GetAll Return a list of all the SDN_controllers known to the system.

func (SDNControllerClass) GetAllRecords 

func (_class SDNControllerClass) GetAllRecords(sessionID SessionRef) (_retval map[SDNControllerRef]SDNControllerRecord, _err error)

GetAllRecords Return a map of SDN_controller references to SDN_controller records for all SDN_controllers known to the system.

func (SDNControllerClass) GetByUUID 

func (_class SDNControllerClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SDNControllerRef, _err error)

GetByUUID Get a reference to the SDN_controller instance with the specified UUID.

func (SDNControllerClass) GetPort 

func (_class SDNControllerClass) GetPort(sessionID SessionRef, self SDNControllerRef) (_retval int, _err error)

GetPort Get the port field of the given SDN_controller.

func (SDNControllerClass) GetProtocol 

func (_class SDNControllerClass) GetProtocol(sessionID SessionRef, self SDNControllerRef) (_retval SdnControllerProtocol, _err error)

GetProtocol Get the protocol field of the given SDN_controller.

func (SDNControllerClass) GetRecord 

func (_class SDNControllerClass) GetRecord(sessionID SessionRef, self SDNControllerRef) (_retval SDNControllerRecord, _err error)

GetRecord Get a record containing the current state of the given SDN_controller.

func (SDNControllerClass) GetUUID 

func (_class SDNControllerClass) GetUUID(sessionID SessionRef, self SDNControllerRef) (_retval string, _err error)

GetUUID Get the uuid field of the given SDN_controller.

func (SDNControllerClass) Introduce 

func (_class SDNControllerClass) Introduce(sessionID SessionRef, protocol SdnControllerProtocol, address string, port int) (_retval SDNControllerRef, _err error)

Introduce Introduce an SDN controller to the pool.

type SDNControllerRecord 

type SDNControllerRecord struct {
	// Unique identifier/object reference
	UUID string
	// Protocol to connect with SDN controller
	Protocol SdnControllerProtocol
	// IP address of the controller
	Address string
	// TCP port of the controller
	Port int
}

type SDNControllerRef 

type SDNControllerRef 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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByNameLabel Get all the SM instances with the given label.

func (SMClass) GetByUUID 

func (_class SMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SMRef, _err error)

GetByUUID 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)

GetCapabilities 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)

GetConfiguration Get the configuration field of the given SM.

func (SMClass) GetCopyright 

func (_class SMClass) GetCopyright(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetCopyright Get the copyright field of the given SM.

func (SMClass) GetDriverFilename 

func (_class SMClass) GetDriverFilename(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetDriverFilename 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)

GetFeatures Get the features field of the given SM.

func (SMClass) GetNameDescription 

func (_class SMClass) GetNameDescription(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given SM.

func (SMClass) GetNameLabel 

func (_class SMClass) GetNameLabel(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetNameLabel 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)

GetOtherConfig Get the other_config field of the given SM.

func (SMClass) GetRecord 

func (_class SMClass) GetRecord(sessionID SessionRef, self SMRef) (_retval SMRecord, _err error)

GetRecord 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)

GetRequiredAPIVersion 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)

GetRequiredClusterStack 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)

GetType Get the type field of the given SM.

func (SMClass) GetUUID 

func (_class SMClass) GetUUID(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetUUID Get the uuid field of the given SM.

func (SMClass) GetVendor 

func (_class SMClass) GetVendor(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetVendor Get the vendor field of the given SM.

func (SMClass) GetVersion 

func (_class SMClass) GetVersion(sessionID SessionRef, self SMRef) (_retval string, _err error)

GetVersion Get the version field of the given SM.

func (SMClass) RemoveFromOtherConfig 

func (_class SMClass) RemoveFromOtherConfig(sessionID SessionRef, self SMRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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)

AddTags 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)

AddToOtherConfig 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)

AddToSmConfig 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)

AssertCanHostHaStatefile 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)

AssertSupportsDatabaseReplication 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 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)

CreateNewBlob 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 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)

DisableDatabaseReplication

func (SRClass) EnableDatabaseReplication 

func (_class SRClass) EnableDatabaseReplication(sessionID SessionRef, sr SRRef) (_err error)

EnableDatabaseReplication

func (SRClass) Forget 

func (_class SRClass) Forget(sessionID SessionRef, sr SRRef) (_err error)

Forget 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) ForgetDataSourceArchives 

func (_class SRClass) ForgetDataSourceArchives(sessionID SessionRef, sr SRRef, dataSource string) (_err error)

ForgetDataSourceArchives Forget the recorded statistics related to the specified data source

func (SRClass) GetAll 

func (_class SRClass) GetAll(sessionID SessionRef) (_retval []SRRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations 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)

GetBlobs Get the blobs field of the given SR.

func (SRClass) GetByNameLabel 

func (_class SRClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []SRRef, _err error)

GetByNameLabel Get all the SR instances with the given label.

func (SRClass) GetByUUID 

func (_class SRClass) GetByUUID(sessionID SessionRef, uuid string) (_retval SRRef, _err error)

GetByUUID Get a reference to the SR instance with the specified UUID.

func (SRClass) GetClustered 

func (_class SRClass) GetClustered(sessionID SessionRef, self SRRef) (_retval bool, _err error)

GetClustered Get the clustered field of the given SR.

func (SRClass) GetContentType 

func (_class SRClass) GetContentType(sessionID SessionRef, self SRRef) (_retval string, _err error)

GetContentType 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)

GetCurrentOperations Get the current_operations field of the given SR.

func (SRClass) GetDataSources 

func (_class SRClass) GetDataSources(sessionID SessionRef, sr SRRef) (_retval []DataSourceRecord, _err error)

GetDataSources

func (SRClass) GetIntroducedBy 

func (_class SRClass) GetIntroducedBy(sessionID SessionRef, self SRRef) (_retval DRTaskRef, _err error)

GetIntroducedBy Get the introduced_by field of the given SR.

func (SRClass) GetIsToolsSr 

func (_class SRClass) GetIsToolsSr(sessionID SessionRef, self SRRef) (_retval bool, _err error)

GetIsToolsSr Get the is_tools_sr field of the given SR.

func (SRClass) GetLocalCacheEnabled 

func (_class SRClass) GetLocalCacheEnabled(sessionID SessionRef, self SRRef) (_retval bool, _err error)

GetLocalCacheEnabled 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)

GetNameDescription Get the name/description field of the given SR.

func (SRClass) GetNameLabel 

func (_class SRClass) GetNameLabel(sessionID SessionRef, self SRRef) (_retval string, _err error)

GetNameLabel 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)

GetOtherConfig Get the other_config field of the given SR.

func (SRClass) GetPBDs 

func (_class SRClass) GetPBDs(sessionID SessionRef, self SRRef) (_retval []PBDRef, _err error)

GetPBDs Get the PBDs field of the given SR.

func (SRClass) GetPhysicalSize 

func (_class SRClass) GetPhysicalSize(sessionID SessionRef, self SRRef) (_retval int, _err error)

GetPhysicalSize Get the physical_size field of the given SR.

func (SRClass) GetPhysicalUtilisation 

func (_class SRClass) GetPhysicalUtilisation(sessionID SessionRef, self SRRef) (_retval int, _err error)

GetPhysicalUtilisation Get the physical_utilisation field of the given SR.

func (SRClass) GetRecord 

func (_class SRClass) GetRecord(sessionID SessionRef, self SRRef) (_retval SRRecord, _err error)

GetRecord 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)

GetShared 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)

GetSmConfig Get the sm_config field of the given SR.

func (SRClass) GetSupportedTypes 

func (_class SRClass) GetSupportedTypes(sessionID SessionRef) (_retval []string, _err error)

GetSupportedTypes 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)

GetTags Get the tags field of the given SR.

func (SRClass) GetType 

func (_class SRClass) GetType(sessionID SessionRef, self SRRef) (_retval string, _err error)

GetType Get the type field of the given SR.

func (SRClass) GetUUID 

func (_class SRClass) GetUUID(sessionID SessionRef, self SRRef) (_retval string, _err error)

GetUUID Get the uuid field of the given SR.

func (SRClass) GetVDIs 

func (_class SRClass) GetVDIs(sessionID SessionRef, self SRRef) (_retval []VDIRef, _err error)

GetVDIs Get the VDIs field of the given SR.

func (SRClass) GetVirtualAllocation 

func (_class SRClass) GetVirtualAllocation(sessionID SessionRef, self SRRef) (_retval int, _err error)

GetVirtualAllocation 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 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)

Make 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)

Probe 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) ProbeExt 

func (_class SRClass) ProbeExt(sessionID SessionRef, host HostRef, deviceConfig map[string]string, atype string, smConfig map[string]string) (_retval []ProbeResultRecord, _err error)

ProbeExt 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) QueryDataSource 

func (_class SRClass) QueryDataSource(sessionID SessionRef, sr SRRef, dataSource string) (_retval float64, _err error)

QueryDataSource Query the latest value of the specified data source

func (SRClass) RecordDataSource 

func (_class SRClass) RecordDataSource(sessionID SessionRef, sr SRRef, dataSource string) (_err error)

RecordDataSource Start recording the specified data source

func (SRClass) RemoveFromOtherConfig 

func (_class SRClass) RemoveFromOtherConfig(sessionID SessionRef, self SRRef, key string) (_err error)

RemoveFromOtherConfig 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)

RemoveFromSmConfig 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)

RemoveTags 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)

Scan Refreshes the list of VDIs associated with an SR

func (SRClass) SetNameDescription 

func (_class SRClass) SetNameDescription(sessionID SessionRef, sr SRRef, value string) (_err error)

SetNameDescription Set the name description of the SR

func (SRClass) SetNameLabel 

func (_class SRClass) SetNameLabel(sessionID SessionRef, sr SRRef, value string) (_err error)

SetNameLabel Set the name label of the SR

func (SRClass) SetOtherConfig 

func (_class SRClass) SetOtherConfig(sessionID SessionRef, self SRRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given SR.

func (SRClass) SetPhysicalSize 

func (_class SRClass) SetPhysicalSize(sessionID SessionRef, self SRRef, value int) (_err error)

SetPhysicalSize Sets the SR's physical_size field

func (SRClass) SetShared 

func (_class SRClass) SetShared(sessionID SessionRef, sr SRRef, value bool) (_err error)

SetShared Sets the shared flag on the SR

func (SRClass) SetSmConfig 

func (_class SRClass) SetSmConfig(sessionID SessionRef, self SRRef, value map[string]string) (_err error)

SetSmConfig Set the sm_config field of the given SR.

func (SRClass) SetTags 

func (_class SRClass) SetTags(sessionID SessionRef, self SRRef, value []string) (_err error)

SetTags Set the tags field of the given SR.

func (SRClass) Update 

func (_class SRClass) Update(sessionID SessionRef, sr SRRef) (_err error)

Update 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
	// True if the SR is using aggregated local storage
	Clustered bool
	// True if this is the SR that contains the Tools ISO VDIs
	IsToolsSr bool
}

type SRRef 

type SRRef string

type SdnControllerProtocol 

type SdnControllerProtocol string
const (
	// Active ssl connection
	SdnControllerProtocolSsl SdnControllerProtocol = "ssl"
	// Passive ssl connection
	SdnControllerProtocolPssl SdnControllerProtocol = "pssl"
)

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)

AddToOtherConfig 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 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 Destroy the specified secret instance.

func (SecretClass) GetAll 

func (_class SecretClass) GetAll(sessionID SessionRef) (_retval []SecretRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetOtherConfig Get the other_config field of the given secret.

func (SecretClass) GetRecord 

func (_class SecretClass) GetRecord(sessionID SessionRef, self SecretRef) (_retval SecretRecord, _err error)

GetRecord 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)

GetUUID Get the uuid field of the given secret.

func (SecretClass) GetValue 

func (_class SecretClass) GetValue(sessionID SessionRef, self SecretRef) (_retval string, _err error)

GetValue Get the value field of the given secret.

func (SecretClass) RemoveFromOtherConfig 

func (_class SecretClass) RemoveFromOtherConfig(sessionID SessionRef, self SecretRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig Set the other_config field of the given secret.

func (SecretClass) SetValue 

func (_class SecretClass) SetValue(sessionID SessionRef, self SecretRef, value string) (_err error)

SetValue 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)

AddToOtherConfig 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)

ChangePassword 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)

CreateFromDbFile

func (SessionClass) GetAllSubjectIdentifiers 

func (_class SessionClass) GetAllSubjectIdentifiers(sessionID SessionRef) (_retval []string, _err error)

GetAllSubjectIdentifiers 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)

GetAuthUserName 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)

GetAuthUserSid 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)

GetByUUID Get a reference to the session instance with the specified UUID.

func (SessionClass) GetClientCertificate 

func (_class SessionClass) GetClientCertificate(sessionID SessionRef, self SessionRef) (_retval bool, _err error)

GetClientCertificate Get the client_certificate field of the given session.

func (SessionClass) GetIsLocalSuperuser 

func (_class SessionClass) GetIsLocalSuperuser(sessionID SessionRef, self SessionRef) (_retval bool, _err error)

GetIsLocalSuperuser 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)

GetLastActive Get the last_active field of the given session.

func (SessionClass) GetOriginator 

func (_class SessionClass) GetOriginator(sessionID SessionRef, self SessionRef) (_retval string, _err error)

GetOriginator 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)

GetOtherConfig Get the other_config field of the given session.

func (SessionClass) GetParent 

func (_class SessionClass) GetParent(sessionID SessionRef, self SessionRef) (_retval SessionRef, _err error)

GetParent Get the parent field of the given session.

func (SessionClass) GetPool 

func (_class SessionClass) GetPool(sessionID SessionRef, self SessionRef) (_retval bool, _err error)

GetPool Get the pool field of the given session.

func (SessionClass) GetRbacPermissions 

func (_class SessionClass) GetRbacPermissions(sessionID SessionRef, self SessionRef) (_retval []string, _err error)

GetRbacPermissions Get the rbac_permissions field of the given session.

func (SessionClass) GetRecord 

func (_class SessionClass) GetRecord(sessionID SessionRef, self SessionRef) (_retval SessionRecord, _err error)

GetRecord 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)

GetSubject Get the subject field of the given session.

func (SessionClass) GetTasks 

func (_class SessionClass) GetTasks(sessionID SessionRef, self SessionRef) (_retval []TaskRef, _err error)

GetTasks Get the tasks field of the given session.

func (SessionClass) GetThisHost 

func (_class SessionClass) GetThisHost(sessionID SessionRef, self SessionRef) (_retval HostRef, _err error)

GetThisHost Get the this_host field of the given session.

func (SessionClass) GetThisUser 

func (_class SessionClass) GetThisUser(sessionID SessionRef, self SessionRef) (_retval UserRef, _err error)

GetThisUser Get the this_user field of the given session.

func (SessionClass) GetUUID 

func (_class SessionClass) GetUUID(sessionID SessionRef, self SessionRef) (_retval string, _err error)

GetUUID Get the uuid field of the given session.

func (SessionClass) GetValidationTime 

func (_class SessionClass) GetValidationTime(sessionID SessionRef, self SessionRef) (_retval time.Time, _err error)

GetValidationTime Get the validation_time field of the given session.

func (SessionClass) LocalLogout 

func (_class SessionClass) LocalLogout(sessionID SessionRef) (_err error)

LocalLogout Log out of local session.

func (SessionClass) LoginWithPassword 

func (_class SessionClass) LoginWithPassword(uname string, pwd string, version string, originator string) (_retval SessionRef, _err error)

LoginWithPassword 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 supporter. Please pass API calls via the coordinator host.

func (SessionClass) Logout 

func (_class SessionClass) Logout(sessionID SessionRef) (_err error)

Logout Log out of a session

func (SessionClass) LogoutSubjectIdentifier 

func (_class SessionClass) LogoutSubjectIdentifier(sessionID SessionRef, subjectIdentifier string) (_err error)

LogoutSubjectIdentifier 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)

RemoveFromOtherConfig 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)

SetOtherConfig Set the other_config field of the given session.

func (SessionClass) SlaveLocalLoginWithPassword 

func (_class SessionClass) SlaveLocalLoginWithPassword(uname string, pwd string) (_retval SessionRef, _err error)

SlaveLocalLoginWithPassword 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
	// indicates whether this session was authenticated using a client certificate
	ClientCertificate bool
}

type SessionRef 

type SessionRef string

type SrHealth 

type SrHealth string
const (
	// Storage is fully available
	SrHealthHealthy SrHealth = "healthy"
	// Storage is busy recovering, e.g. rebuilding mirrors.
	SrHealthRecovering SrHealth = "recovering"
)

type SrStatClass 

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

A set of high-level properties associated with an SR.

type SrStatRecord 

type SrStatRecord struct {
	// Uuid that uniquely identifies this SR, if one is available.
	UUID string
	// Short, human-readable label for the SR.
	NameLabel string
	// Longer, human-readable description of the SR. Descriptions are generally only displayed by clients when the user is examining SRs in detail.
	NameDescription string
	// Number of bytes free on the backing storage (in bytes)
	FreeSpace int
	// Total physical size of the backing storage (in bytes)
	TotalSpace int
	// Indicates whether the SR uses clustered local storage.
	Clustered bool
	// The health status of the SR.
	Health SrHealth
}

type SrStatRef 

type SrStatRef string

type SriovConfigurationMode 

type SriovConfigurationMode string
const (
	// Configure network sriov by sysfs, do not need reboot
	SriovConfigurationModeSysfs SriovConfigurationMode = "sysfs"
	// Configure network sriov by modprobe, need reboot
	SriovConfigurationModeModprobe SriovConfigurationMode = "modprobe"
	// Configure network sriov manually
	SriovConfigurationModeManual SriovConfigurationMode = "manual"
	// Unknown mode
	SriovConfigurationModeUnknown SriovConfigurationMode = "unknown"
)

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"
	// Mirroring a VDI
	StorageOperationsVdiMirror StorageOperations = "vdi_mirror"
	// Enabling changed block tracking for a VDI
	StorageOperationsVdiEnableCbt StorageOperations = "vdi_enable_cbt"
	// Disabling changed block tracking for a VDI
	StorageOperationsVdiDisableCbt StorageOperations = "vdi_disable_cbt"
	// Deleting the data of the VDI
	StorageOperationsVdiDataDestroy StorageOperations = "vdi_data_destroy"
	// Exporting a bitmap that shows the changed blocks between two VDIs
	StorageOperationsVdiListChangedBlocks StorageOperations = "vdi_list_changed_blocks"
	// Setting the on_boot field of the VDI
	StorageOperationsVdiSetOnBoot StorageOperations = "vdi_set_on_boot"
	// 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)

AddToRoles 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 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 Destroy the specified subject instance.

func (SubjectClass) GetAll 

func (_class SubjectClass) GetAll(sessionID SessionRef) (_retval []SubjectRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetOtherConfig Get the other_config field of the given subject.

func (SubjectClass) GetPermissionsNameLabel 

func (_class SubjectClass) GetPermissionsNameLabel(sessionID SessionRef, self SubjectRef) (_retval []string, _err error)

GetPermissionsNameLabel 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)

GetRecord 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)

GetRoles Get the roles field of the given subject.

func (SubjectClass) GetSubjectIdentifier 

func (_class SubjectClass) GetSubjectIdentifier(sessionID SessionRef, self SubjectRef) (_retval string, _err error)

GetSubjectIdentifier Get the subject_identifier field of the given subject.

func (SubjectClass) GetUUID 

func (_class SubjectClass) GetUUID(sessionID SessionRef, self SubjectRef) (_retval string, _err error)

GetUUID Get the uuid field of the given subject.

func (SubjectClass) RemoveFromRoles 

func (_class SubjectClass) RemoveFromRoles(sessionID SessionRef, self SubjectRef, role RoleRef) (_err error)

RemoveFromRoles 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)

AddToOtherConfig 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)

Cancel 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 Create a new task object which must be manually destroyed.

func (TaskClass) Destroy 

func (_class TaskClass) Destroy(sessionID SessionRef, self TaskRef) (_err error)

Destroy Destroy the task object

func (TaskClass) GetAll 

func (_class TaskClass) GetAll(sessionID SessionRef) (_retval []TaskRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations Get the allowed_operations field of the given task.

func (TaskClass) GetBacktrace 

func (_class TaskClass) GetBacktrace(sessionID SessionRef, self TaskRef) (_retval string, _err error)

GetBacktrace Get the backtrace field of the given task.

func (TaskClass) GetByNameLabel 

func (_class TaskClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []TaskRef, _err error)

GetByNameLabel Get all the task instances with the given label.

func (TaskClass) GetByUUID 

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

GetByUUID 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)

GetCreated 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)

GetCurrentOperations Get the current_operations field of the given task.

func (TaskClass) GetErrorInfo 

func (_class TaskClass) GetErrorInfo(sessionID SessionRef, self TaskRef) (_retval []string, _err error)

GetErrorInfo 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)

GetFinished Get the finished field of the given task.

func (TaskClass) GetNameDescription 

func (_class TaskClass) GetNameDescription(sessionID SessionRef, self TaskRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given task.

func (TaskClass) GetNameLabel 

func (_class TaskClass) GetNameLabel(sessionID SessionRef, self TaskRef) (_retval string, _err error)

GetNameLabel 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)

GetOtherConfig Get the other_config field of the given task.

func (TaskClass) GetProgress 

func (_class TaskClass) GetProgress(sessionID SessionRef, self TaskRef) (_retval float64, _err error)

GetProgress Get the progress field of the given task.

func (TaskClass) GetRecord 

func (_class TaskClass) GetRecord(sessionID SessionRef, self TaskRef) (_retval TaskRecord, _err error)

GetRecord 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)

GetResidentOn Get the resident_on field of the given task.

func (TaskClass) GetResult 

func (_class TaskClass) GetResult(sessionID SessionRef, self TaskRef) (_retval string, _err error)

GetResult Get the result field of the given task.

func (TaskClass) GetStatus 

func (_class TaskClass) GetStatus(sessionID SessionRef, self TaskRef) (_retval TaskStatusType, _err error)

GetStatus Get the status field of the given task.

func (TaskClass) GetSubtaskOf 

func (_class TaskClass) GetSubtaskOf(sessionID SessionRef, self TaskRef) (_retval TaskRef, _err error)

GetSubtaskOf Get the subtask_of field of the given task.

func (TaskClass) GetSubtasks 

func (_class TaskClass) GetSubtasks(sessionID SessionRef, self TaskRef) (_retval []TaskRef, _err error)

GetSubtasks Get the subtasks field of the given task.

func (TaskClass) GetType 

func (_class TaskClass) GetType(sessionID SessionRef, self TaskRef) (_retval string, _err error)

GetType Get the type field of the given task.

func (TaskClass) GetUUID 

func (_class TaskClass) GetUUID(sessionID SessionRef, self TaskRef) (_retval string, _err error)

GetUUID Get the uuid field of the given task.

func (TaskClass) RemoveFromOtherConfig 

func (_class TaskClass) RemoveFromOtherConfig(sessionID SessionRef, self TaskRef, key string) (_err error)

RemoveFromOtherConfig 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) SetErrorInfo 

func (_class TaskClass) SetErrorInfo(sessionID SessionRef, self TaskRef, value []string) (_err error)

SetErrorInfo Set the task error info

func (TaskClass) SetOtherConfig 

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

SetOtherConfig Set the other_config field of the given task.

func (TaskClass) SetProgress 

func (_class TaskClass) SetProgress(sessionID SessionRef, self TaskRef, value float64) (_err error)

SetProgress Set the task progress

func (TaskClass) SetResult 

func (_class TaskClass) SetResult(sessionID SessionRef, self TaskRef, value string) (_err error)

SetResult Set the task result

func (TaskClass) SetStatus 

func (_class TaskClass) SetStatus(sessionID SessionRef, self TaskRef, value TaskStatusType) (_err error)

SetStatus Set the task status

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 TelemetryFrequency 

type TelemetryFrequency string
const (
	// Run telemetry task daily
	TelemetryFrequencyDaily TelemetryFrequency = "daily"
	// Run telemetry task weekly
	TelemetryFrequencyWeekly TelemetryFrequency = "weekly"
	// Run telemetry task monthly
	TelemetryFrequencyMonthly TelemetryFrequency = "monthly"
)

type TristateType 

type TristateType string
const (
	// Known to be true
	TristateTypeYes TristateType = "yes"
	// Known to be false
	TristateTypeNo TristateType = "no"
	// Unknown or unspecified
	TristateTypeUnspecified TristateType = "unspecified"
)

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)

AddToOtherConfig 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)

AddToStatus 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, protocol TunnelProtocol) (_retval TunnelRef, _err error)

Create 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 - Cannot 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 Destroy a tunnel

func (TunnelClass) GetAccessPIF 

func (_class TunnelClass) GetAccessPIF(sessionID SessionRef, self TunnelRef) (_retval PIFRef, _err error)

GetAccessPIF Get the access_PIF field of the given tunnel.

func (TunnelClass) GetAll 

func (_class TunnelClass) GetAll(sessionID SessionRef) (_retval []TunnelRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetOtherConfig Get the other_config field of the given tunnel.

func (TunnelClass) GetProtocol 

func (_class TunnelClass) GetProtocol(sessionID SessionRef, self TunnelRef) (_retval TunnelProtocol, _err error)

GetProtocol Get the protocol field of the given tunnel.

func (TunnelClass) GetRecord 

func (_class TunnelClass) GetRecord(sessionID SessionRef, self TunnelRef) (_retval TunnelRecord, _err error)

GetRecord 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)

GetStatus Get the status field of the given tunnel.

func (TunnelClass) GetTransportPIF 

func (_class TunnelClass) GetTransportPIF(sessionID SessionRef, self TunnelRef) (_retval PIFRef, _err error)

GetTransportPIF Get the transport_PIF field of the given tunnel.

func (TunnelClass) GetUUID 

func (_class TunnelClass) GetUUID(sessionID SessionRef, self TunnelRef) (_retval string, _err error)

GetUUID Get the uuid field of the given tunnel.

func (TunnelClass) RemoveFromOtherConfig 

func (_class TunnelClass) RemoveFromOtherConfig(sessionID SessionRef, self TunnelRef, key string) (_err error)

RemoveFromOtherConfig 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)

RemoveFromStatus 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)

SetOtherConfig Set the other_config field of the given tunnel.

func (TunnelClass) SetProtocol 

func (_class TunnelClass) SetProtocol(sessionID SessionRef, self TunnelRef, value TunnelProtocol) (_err error)

SetProtocol Set the protocol field of the given tunnel.

func (TunnelClass) SetStatus 

func (_class TunnelClass) SetStatus(sessionID SessionRef, self TunnelRef, value map[string]string) (_err error)

SetStatus Set the status field of the given tunnel.

type TunnelProtocol 

type TunnelProtocol string
const (
	// GRE protocol
	TunnelProtocolGre TunnelProtocol = "gre"
	// VxLAN Protocol
	TunnelProtocolVxlan TunnelProtocol = "vxlan"
)

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
	// The protocol used for tunneling (either GRE or VxLAN)
	Protocol TunnelProtocol
}

type TunnelRef 

type TunnelRef string

type USBGroupClass 

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

A group of compatible USBs across the resource pool

func (USBGroupClass) AddToOtherConfig 

func (_class USBGroupClass) AddToOtherConfig(sessionID SessionRef, self USBGroupRef, key string, value string) (_err error)

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

func (USBGroupClass) Create 

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

Create

func (USBGroupClass) Destroy 

func (_class USBGroupClass) Destroy(sessionID SessionRef, self USBGroupRef) (_err error)

Destroy

func (USBGroupClass) GetAll 

func (_class USBGroupClass) GetAll(sessionID SessionRef) (_retval []USBGroupRef, _err error)

GetAll Return a list of all the USB_groups known to the system.

func (USBGroupClass) GetAllRecords 

func (_class USBGroupClass) GetAllRecords(sessionID SessionRef) (_retval map[USBGroupRef]USBGroupRecord, _err error)

GetAllRecords Return a map of USB_group references to USB_group records for all USB_groups known to the system.

func (USBGroupClass) GetByNameLabel 

func (_class USBGroupClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []USBGroupRef, _err error)

GetByNameLabel Get all the USB_group instances with the given label.

func (USBGroupClass) GetByUUID 

func (_class USBGroupClass) GetByUUID(sessionID SessionRef, uuid string) (_retval USBGroupRef, _err error)

GetByUUID Get a reference to the USB_group instance with the specified UUID.

func (USBGroupClass) GetNameDescription 

func (_class USBGroupClass) GetNameDescription(sessionID SessionRef, self USBGroupRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given USB_group.

func (USBGroupClass) GetNameLabel 

func (_class USBGroupClass) GetNameLabel(sessionID SessionRef, self USBGroupRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given USB_group.

func (USBGroupClass) GetOtherConfig 

func (_class USBGroupClass) GetOtherConfig(sessionID SessionRef, self USBGroupRef) (_retval map[string]string, _err error)

GetOtherConfig Get the other_config field of the given USB_group.

func (USBGroupClass) GetPUSBs 

func (_class USBGroupClass) GetPUSBs(sessionID SessionRef, self USBGroupRef) (_retval []PUSBRef, _err error)

GetPUSBs Get the PUSBs field of the given USB_group.

func (USBGroupClass) GetRecord 

func (_class USBGroupClass) GetRecord(sessionID SessionRef, self USBGroupRef) (_retval USBGroupRecord, _err error)

GetRecord Get a record containing the current state of the given USB_group.

func (USBGroupClass) GetUUID 

func (_class USBGroupClass) GetUUID(sessionID SessionRef, self USBGroupRef) (_retval string, _err error)

GetUUID Get the uuid field of the given USB_group.

func (USBGroupClass) GetVUSBs 

func (_class USBGroupClass) GetVUSBs(sessionID SessionRef, self USBGroupRef) (_retval []VUSBRef, _err error)

GetVUSBs Get the VUSBs field of the given USB_group.

func (USBGroupClass) RemoveFromOtherConfig 

func (_class USBGroupClass) RemoveFromOtherConfig(sessionID SessionRef, self USBGroupRef, key string) (_err error)

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

func (USBGroupClass) SetNameDescription 

func (_class USBGroupClass) SetNameDescription(sessionID SessionRef, self USBGroupRef, value string) (_err error)

SetNameDescription Set the name/description field of the given USB_group.

func (USBGroupClass) SetNameLabel 

func (_class USBGroupClass) SetNameLabel(sessionID SessionRef, self USBGroupRef, value string) (_err error)

SetNameLabel Set the name/label field of the given USB_group.

func (USBGroupClass) SetOtherConfig 

func (_class USBGroupClass) SetOtherConfig(sessionID SessionRef, self USBGroupRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given USB_group.

type USBGroupRecord 

type USBGroupRecord struct {
	// Unique identifier/object reference
	UUID string
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// List of PUSBs in the group
	PUSBs []PUSBRef
	// List of VUSBs using the group
	VUSBs []VUSBRef
	// Additional configuration
	OtherConfig map[string]string
}

type USBGroupRef 

type USBGroupRef string

type UpdateAfterApplyGuidance 

type UpdateAfterApplyGuidance string
const (
	// This update requires HVM guests to be restarted once applied.
	UpdateAfterApplyGuidanceRestartHVM UpdateAfterApplyGuidance = "restartHVM"
	// This update requires PV guests to be restarted once applied.
	UpdateAfterApplyGuidanceRestartPV UpdateAfterApplyGuidance = "restartPV"
	// This update requires the host to be restarted once applied.
	UpdateAfterApplyGuidanceRestartHost UpdateAfterApplyGuidance = "restartHost"
	// This update requires XAPI to be restarted once applied.
	UpdateAfterApplyGuidanceRestartXAPI UpdateAfterApplyGuidance = "restartXAPI"
)

type UpdateGuidances 

type UpdateGuidances string
const (
	// Indicates the updated host should reboot as soon as possible
	UpdateGuidancesRebootHost UpdateGuidances = "reboot_host"
	// Indicates the updated host should reboot as soon as possible since one or more livepatch(es) failed to be applied.
	UpdateGuidancesRebootHostOnLivepatchFailure UpdateGuidances = "reboot_host_on_livepatch_failure"
	// Indicates the Toolstack running on the updated host should restart as soon as possible
	UpdateGuidancesRestartToolstack UpdateGuidances = "restart_toolstack"
	// Indicates the device model of a running VM should restart as soon as possible
	UpdateGuidancesRestartDeviceModel UpdateGuidances = "restart_device_model"
)

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)

AddToOtherConfig 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 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 Destroy the specified user instance.

func (UserClass) GetByUUID 

func (_class UserClass) GetByUUID(sessionID SessionRef, uuid string) (_retval UserRef, _err error)

GetByUUID 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)

GetFullname 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)

GetOtherConfig Get the other_config field of the given user.

func (UserClass) GetRecord 

func (_class UserClass) GetRecord(sessionID SessionRef, self UserRef) (_retval UserRecord, _err error)

GetRecord 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)

GetShortName Get the short_name field of the given user.

func (UserClass) GetUUID 

func (_class UserClass) GetUUID(sessionID SessionRef, self UserRef) (_retval string, _err error)

GetUUID Get the uuid field of the given user.

func (UserClass) RemoveFromOtherConfig 

func (_class UserClass) RemoveFromOtherConfig(sessionID SessionRef, self UserRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetFullname 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)

SetOtherConfig 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)

AddToOtherConfig 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)

AddToQosAlgorithmParams 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)

AssertAttachable 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 Create a new VBD instance, and return its handle. The constructor args are: VM*, VDI*, device, userdevice*, bootable*, mode*, type*, unpluggable, empty*, other_config*, currently_attached, qos_algorithm_type*, qos_algorithm_params* (* = non-optional).

func (VBDClass) Destroy 

func (_class VBDClass) Destroy(sessionID SessionRef, self VBDRef) (_err error)

Destroy Destroy the specified VBD instance.

func (VBDClass) Eject 

func (_class VBDClass) Eject(sessionID SessionRef, vbd VBDRef) (_err error)

Eject 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)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations Get the allowed_operations field of the given VBD.

func (VBDClass) GetBootable 

func (_class VBDClass) GetBootable(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

GetBootable Get the bootable field of the given VBD.

func (VBDClass) GetByUUID 

func (_class VBDClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VBDRef, _err error)

GetByUUID 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)

GetCurrentOperations Get the current_operations field of the given VBD.

func (VBDClass) GetCurrentlyAttached 

func (_class VBDClass) GetCurrentlyAttached(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

GetCurrentlyAttached Get the currently_attached field of the given VBD.

func (VBDClass) GetDevice 

func (_class VBDClass) GetDevice(sessionID SessionRef, self VBDRef) (_retval string, _err error)

GetDevice Get the device field of the given VBD.

func (VBDClass) GetEmpty 

func (_class VBDClass) GetEmpty(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

GetEmpty Get the empty field of the given VBD.

func (VBDClass) GetMetrics 

func (_class VBDClass) GetMetrics(sessionID SessionRef, self VBDRef) (_retval VBDMetricsRef, _err error)

GetMetrics Get the metrics field of the given VBD.

func (VBDClass) GetMode 

func (_class VBDClass) GetMode(sessionID SessionRef, self VBDRef) (_retval VbdMode, _err error)

GetMode 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)

GetOtherConfig 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)

GetQosAlgorithmParams 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)

GetQosAlgorithmType 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)

GetQosSupportedAlgorithms 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)

GetRecord 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)

GetRuntimeProperties Get the runtime_properties field of the given VBD.

func (VBDClass) GetStatusCode 

func (_class VBDClass) GetStatusCode(sessionID SessionRef, self VBDRef) (_retval int, _err error)

GetStatusCode Get the status_code field of the given VBD.

func (VBDClass) GetStatusDetail 

func (_class VBDClass) GetStatusDetail(sessionID SessionRef, self VBDRef) (_retval string, _err error)

GetStatusDetail Get the status_detail field of the given VBD.

func (VBDClass) GetStorageLock 

func (_class VBDClass) GetStorageLock(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

GetStorageLock Get the storage_lock field of the given VBD.

func (VBDClass) GetType 

func (_class VBDClass) GetType(sessionID SessionRef, self VBDRef) (_retval VbdType, _err error)

GetType Get the type field of the given VBD.

func (VBDClass) GetUUID 

func (_class VBDClass) GetUUID(sessionID SessionRef, self VBDRef) (_retval string, _err error)

GetUUID Get the uuid field of the given VBD.

func (VBDClass) GetUnpluggable 

func (_class VBDClass) GetUnpluggable(sessionID SessionRef, self VBDRef) (_retval bool, _err error)

GetUnpluggable Get the unpluggable field of the given VBD.

func (VBDClass) GetUserdevice 

func (_class VBDClass) GetUserdevice(sessionID SessionRef, self VBDRef) (_retval string, _err error)

GetUserdevice Get the userdevice field of the given VBD.

func (VBDClass) GetVDI 

func (_class VBDClass) GetVDI(sessionID SessionRef, self VBDRef) (_retval VDIRef, _err error)

GetVDI Get the VDI field of the given VBD.

func (VBDClass) GetVM 

func (_class VBDClass) GetVM(sessionID SessionRef, self VBDRef) (_retval VMRef, _err error)

GetVM Get the VM field of the given VBD.

func (VBDClass) Insert 

func (_class VBDClass) Insert(sessionID SessionRef, vbd VBDRef, vdi VDIRef) (_err error)

Insert 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)

Plug 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)

RemoveFromOtherConfig 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)

RemoveFromQosAlgorithmParams 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)

SetBootable Set the bootable field of the given VBD.

func (VBDClass) SetMode 

func (_class VBDClass) SetMode(sessionID SessionRef, self VBDRef, value VbdMode) (_err error)

SetMode Sets the mode of the VBD. The power_state of the VM must be halted.

func (VBDClass) SetOtherConfig 

func (_class VBDClass) SetOtherConfig(sessionID SessionRef, self VBDRef, value map[string]string) (_err error)

SetOtherConfig 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)

SetQosAlgorithmParams 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)

SetQosAlgorithmType 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)

SetType Set the type field of the given VBD.

func (VBDClass) SetUnpluggable 

func (_class VBDClass) SetUnpluggable(sessionID SessionRef, self VBDRef, value bool) (_err error)

SetUnpluggable Set the unpluggable field of the given VBD.

func (VBDClass) SetUserdevice 

func (_class VBDClass) SetUserdevice(sessionID SessionRef, self VBDRef, value string) (_err error)

SetUserdevice Set the userdevice field of the given VBD.

func (VBDClass) Unplug 

func (_class VBDClass) Unplug(sessionID SessionRef, self VBDRef) (_err error)

Unplug 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)

UnplugForce 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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetIoReadKbs 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)

GetIoWriteKbs 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)

GetLastUpdated 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)

GetOtherConfig 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)

GetRecord 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)

GetUUID Get the uuid field of the given VBD_metrics.

func (VBDMetricsClass) RemoveFromOtherConfig 

func (_class VBDMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VBDMetricsRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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)

AddTags 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)

AddToOtherConfig 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)

AddToSmConfig 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)

AddToXenstoreData 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)

Clone 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 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 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) DataDestroy 

func (_class VDIClass) DataDestroy(sessionID SessionRef, self VDIRef) (_err error)

DataDestroy Delete the data of the snapshot VDI, but keep its changed block tracking metadata. When successful, this call changes the type of the VDI to cbt_metadata. This operation is idempotent: calling it on a VDI of type cbt_metadata results in a no-op, and no error will be thrown.

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)
VDI_MISSING - This operation cannot be performed because the specified VDI could not be found on the storage substrate
SR_NOT_ATTACHED - The SR is not attached.
SR_HAS_NO_PBDS - The SR has no attached PBDs
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VDI_INCOMPATIBLE_TYPE - This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)
VDI_NO_CBT_METADATA - The requested operation is not allowed because the specified VDI does not have changed block tracking metadata.
VDI_IN_USE - This operation cannot be performed because this VDI is in use by some other operation
VDI_IS_A_PHYSICAL_DEVICE - The operation cannot be performed on physical device

func (VDIClass) Destroy 

func (_class VDIClass) Destroy(sessionID SessionRef, self VDIRef) (_err error)

Destroy Destroy the specified VDI instance.

func (VDIClass) DisableCbt 

func (_class VDIClass) DisableCbt(sessionID SessionRef, self VDIRef) (_err error)

DisableCbt Disable changed block tracking for the VDI. This call is only allowed on VDIs that support enabling CBT. It is an idempotent operation - disabling CBT for a VDI for which CBT is not enabled results in a no-op, and no error will be thrown.

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)
VDI_MISSING - This operation cannot be performed because the specified VDI could not be found on the storage substrate
SR_NOT_ATTACHED - The SR is not attached.
SR_HAS_NO_PBDS - The SR has no attached PBDs
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VDI_INCOMPATIBLE_TYPE - This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)
VDI_ON_BOOT_MODE_INCOMPATIBLE_WITH_OPERATION - This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.

func (VDIClass) EnableCbt 

func (_class VDIClass) EnableCbt(sessionID SessionRef, self VDIRef) (_err error)

EnableCbt Enable changed block tracking for the VDI. This call is idempotent - enabling CBT for a VDI for which CBT is already enabled results in a no-op, and no error will be thrown.

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)
VDI_MISSING - This operation cannot be performed because the specified VDI could not be found on the storage substrate
SR_NOT_ATTACHED - The SR is not attached.
SR_HAS_NO_PBDS - The SR has no attached PBDs
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VDI_INCOMPATIBLE_TYPE - This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)
VDI_ON_BOOT_MODE_INCOMPATIBLE_WITH_OPERATION - This operation is not permitted on VDIs in the 'on-boot=reset' mode, or on VMs having such VDIs.

func (VDIClass) Forget 

func (_class VDIClass) Forget(sessionID SessionRef, vdi VDIRef) (_err error)

Forget Removes a VDI record from the database

func (VDIClass) GetAll 

func (_class VDIClass) GetAll(sessionID SessionRef) (_retval []VDIRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowCaching Get the allow_caching field of the given VDI.

func (VDIClass) GetAllowedOperations 

func (_class VDIClass) GetAllowedOperations(sessionID SessionRef, self VDIRef) (_retval []VdiOperations, _err error)

GetAllowedOperations Get the allowed_operations field of the given VDI.

func (VDIClass) GetByNameLabel 

func (_class VDIClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VDIRef, _err error)

GetByNameLabel Get all the VDI instances with the given label.

func (VDIClass) GetByUUID 

func (_class VDIClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VDIRef, _err error)

GetByUUID Get a reference to the VDI instance with the specified UUID.

func (VDIClass) GetCbtEnabled 

func (_class VDIClass) GetCbtEnabled(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetCbtEnabled Get the cbt_enabled field of the given VDI.

func (VDIClass) GetCrashDumps 

func (_class VDIClass) GetCrashDumps(sessionID SessionRef, self VDIRef) (_retval []CrashdumpRef, _err error)

GetCrashDumps 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)

GetCurrentOperations Get the current_operations field of the given VDI.

func (VDIClass) GetIsASnapshot 

func (_class VDIClass) GetIsASnapshot(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetIsASnapshot Get the is_a_snapshot field of the given VDI.

func (VDIClass) GetIsToolsIso 

func (_class VDIClass) GetIsToolsIso(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetIsToolsIso Get the is_tools_iso field of the given VDI.

func (VDIClass) GetLocation 

func (_class VDIClass) GetLocation(sessionID SessionRef, self VDIRef) (_retval string, _err error)

GetLocation Get the location field of the given VDI.

func (VDIClass) GetManaged 

func (_class VDIClass) GetManaged(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetManaged Get the managed field of the given VDI.

func (VDIClass) GetMetadataLatest 

func (_class VDIClass) GetMetadataLatest(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetMetadataLatest Get the metadata_latest field of the given VDI.

func (VDIClass) GetMetadataOfPool 

func (_class VDIClass) GetMetadataOfPool(sessionID SessionRef, self VDIRef) (_retval PoolRef, _err error)

GetMetadataOfPool 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)

GetMissing Get the missing field of the given VDI.

func (VDIClass) GetNameDescription 

func (_class VDIClass) GetNameDescription(sessionID SessionRef, self VDIRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given VDI.

func (VDIClass) GetNameLabel 

func (_class VDIClass) GetNameLabel(sessionID SessionRef, self VDIRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given VDI.

func (VDIClass) GetNbdInfo 

func (_class VDIClass) GetNbdInfo(sessionID SessionRef, self VDIRef) (_retval []VdiNbdServerInfoRecord, _err error)

GetNbdInfo Get details specifying how to access this VDI via a Network Block Device server. For each of a set of NBD server addresses on which the VDI is available, the return value set contains a vdi_nbd_server_info object that contains an exportname to request once the NBD connection is established, and connection details for the address. An empty list is returned if there is no network that has a PIF on a host with access to the relevant SR, or if no such network has been assigned an NBD-related purpose in its purpose field. To access the given VDI, any of the vdi_nbd_server_info objects can be used to make a connection to a server, and then the VDI will be available by requesting the exportname.

Errors: 

VDI_INCOMPATIBLE_TYPE - This operation cannot be performed because the specified VDI is of an incompatible type (eg: an HA statefile cannot be attached to a guest)

func (VDIClass) GetOnBoot 

func (_class VDIClass) GetOnBoot(sessionID SessionRef, self VDIRef) (_retval OnBoot, _err error)

GetOnBoot 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)

GetOtherConfig Get the other_config field of the given VDI.

func (VDIClass) GetParent 

func (_class VDIClass) GetParent(sessionID SessionRef, self VDIRef) (_retval VDIRef, _err error)

GetParent Get the parent field of the given VDI.

func (VDIClass) GetPhysicalUtilisation 

func (_class VDIClass) GetPhysicalUtilisation(sessionID SessionRef, self VDIRef) (_retval int, _err error)

GetPhysicalUtilisation Get the physical_utilisation field of the given VDI.

func (VDIClass) GetReadOnly 

func (_class VDIClass) GetReadOnly(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetReadOnly Get the read_only field of the given VDI.

func (VDIClass) GetRecord 

func (_class VDIClass) GetRecord(sessionID SessionRef, self VDIRef) (_retval VDIRecord, _err error)

GetRecord 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)

GetSR Get the SR field of the given VDI.

func (VDIClass) GetSharable 

func (_class VDIClass) GetSharable(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetSharable 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)

GetSmConfig Get the sm_config field of the given VDI.

func (VDIClass) GetSnapshotOf 

func (_class VDIClass) GetSnapshotOf(sessionID SessionRef, self VDIRef) (_retval VDIRef, _err error)

GetSnapshotOf 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)

GetSnapshotTime Get the snapshot_time field of the given VDI.

func (VDIClass) GetSnapshots 

func (_class VDIClass) GetSnapshots(sessionID SessionRef, self VDIRef) (_retval []VDIRef, _err error)

GetSnapshots Get the snapshots field of the given VDI.

func (VDIClass) GetStorageLock 

func (_class VDIClass) GetStorageLock(sessionID SessionRef, self VDIRef) (_retval bool, _err error)

GetStorageLock Get the storage_lock field of the given VDI.

func (VDIClass) GetTags 

func (_class VDIClass) GetTags(sessionID SessionRef, self VDIRef) (_retval []string, _err error)

GetTags Get the tags field of the given VDI.

func (VDIClass) GetType 

func (_class VDIClass) GetType(sessionID SessionRef, self VDIRef) (_retval VdiType, _err error)

GetType Get the type field of the given VDI.

func (VDIClass) GetUUID 

func (_class VDIClass) GetUUID(sessionID SessionRef, self VDIRef) (_retval string, _err error)

GetUUID Get the uuid field of the given VDI.

func (VDIClass) GetVBDs 

func (_class VDIClass) GetVBDs(sessionID SessionRef, self VDIRef) (_retval []VBDRef, _err error)

GetVBDs Get the VBDs field of the given VDI.

func (VDIClass) GetVirtualSize 

func (_class VDIClass) GetVirtualSize(sessionID SessionRef, self VDIRef) (_retval int, _err error)

GetVirtualSize 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)

GetXenstoreData 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)

Introduce 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) ListChangedBlocks 

func (_class VDIClass) ListChangedBlocks(sessionID SessionRef, vdiFrom VDIRef, vdiTo VDIRef) (_retval string, _err error)

ListChangedBlocks Compare two VDIs in 64k block increments and report which blocks differ. This operation is not allowed when vdi_to is attached to a VM.

Errors: 

SR_OPERATION_NOT_SUPPORTED - The SR backend does not support the operation (check the SR's allowed operations)
VDI_MISSING - This operation cannot be performed because the specified VDI could not be found on the storage substrate
SR_NOT_ATTACHED - The SR is not attached.
SR_HAS_NO_PBDS - The SR has no attached PBDs
VDI_IN_USE - This operation cannot be performed because this VDI is in use by some other operation

func (VDIClass) OpenDatabase 

func (_class VDIClass) OpenDatabase(sessionID SessionRef, self VDIRef) (_retval SessionRef, _err error)

OpenDatabase Load the metadata found on the supplied VDI and return a session reference which can be used in API 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)

PoolMigrate 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)

ReadDatabasePoolUUID 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)

RemoveFromOtherConfig 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)

RemoveFromSmConfig 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)

RemoveFromXenstoreData 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)

RemoveTags 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 Resize the VDI.

func (VDIClass) ResizeOnline 

func (_class VDIClass) ResizeOnline(sessionID SessionRef, vdi VDIRef, size int) (_err error)

ResizeOnline 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)

SetAllowCaching 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) SetNameDescription 

func (_class VDIClass) SetNameDescription(sessionID SessionRef, self VDIRef, value string) (_err error)

SetNameDescription 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)

SetNameLabel 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)

SetOnBoot 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)

SetOtherConfig Set the other_config field of the given VDI.

func (VDIClass) SetReadOnly 

func (_class VDIClass) SetReadOnly(sessionID SessionRef, self VDIRef, value bool) (_err error)

SetReadOnly Sets the VDI's read_only field

func (VDIClass) SetSharable 

func (_class VDIClass) SetSharable(sessionID SessionRef, self VDIRef, value bool) (_err error)

SetSharable Sets the VDI's sharable field

func (VDIClass) SetSmConfig 

func (_class VDIClass) SetSmConfig(sessionID SessionRef, self VDIRef, value map[string]string) (_err error)

SetSmConfig Set the sm_config field of the given VDI.

func (VDIClass) SetTags 

func (_class VDIClass) SetTags(sessionID SessionRef, self VDIRef, value []string) (_err error)

SetTags Set the tags field of the given VDI.

func (VDIClass) SetXenstoreData 

func (_class VDIClass) SetXenstoreData(sessionID SessionRef, self VDIRef, value map[string]string) (_err error)

SetXenstoreData 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)

Snapshot 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)

Update 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
	// This field is always null. Deprecated
	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
	// Whether this VDI is a Tools ISO
	IsToolsIso bool
	// True if changed blocks are tracked for this VDI
	CbtEnabled 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)

AddToOtherConfig 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)

Create

func (VGPUClass) Destroy 

func (_class VGPUClass) Destroy(sessionID SessionRef, self VGPURef) (_err error)

Destroy

func (VGPUClass) GetAll 

func (_class VGPUClass) GetAll(sessionID SessionRef) (_retval []VGPURef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID Get a reference to the VGPU instance with the specified UUID.

func (VGPUClass) GetCompatibilityMetadata 

func (_class VGPUClass) GetCompatibilityMetadata(sessionID SessionRef, self VGPURef) (_retval map[string]string, _err error)

GetCompatibilityMetadata Get the compatibility_metadata field of the given VGPU.

func (VGPUClass) GetCurrentlyAttached 

func (_class VGPUClass) GetCurrentlyAttached(sessionID SessionRef, self VGPURef) (_retval bool, _err error)

GetCurrentlyAttached Get the currently_attached field of the given VGPU.

func (VGPUClass) GetDevice 

func (_class VGPUClass) GetDevice(sessionID SessionRef, self VGPURef) (_retval string, _err error)

GetDevice Get the device field of the given VGPU.

func (VGPUClass) GetExtraArgs 

func (_class VGPUClass) GetExtraArgs(sessionID SessionRef, self VGPURef) (_retval string, _err error)

GetExtraArgs Get the extra_args field of the given VGPU.

func (VGPUClass) GetGPUGroup 

func (_class VGPUClass) GetGPUGroup(sessionID SessionRef, self VGPURef) (_retval GPUGroupRef, _err error)

GetGPUGroup 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)

GetOtherConfig Get the other_config field of the given VGPU.

func (VGPUClass) GetPCI 

func (_class VGPUClass) GetPCI(sessionID SessionRef, self VGPURef) (_retval PCIRef, _err error)

GetPCI Get the PCI field of the given VGPU.

func (VGPUClass) GetRecord 

func (_class VGPUClass) GetRecord(sessionID SessionRef, self VGPURef) (_retval VGPURecord, _err error)

GetRecord 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)

GetResidentOn Get the resident_on field of the given VGPU.

func (VGPUClass) GetScheduledToBeResidentOn 

func (_class VGPUClass) GetScheduledToBeResidentOn(sessionID SessionRef, self VGPURef) (_retval PGPURef, _err error)

GetScheduledToBeResidentOn Get the scheduled_to_be_resident_on field of the given VGPU.

func (VGPUClass) GetType 

func (_class VGPUClass) GetType(sessionID SessionRef, self VGPURef) (_retval VGPUTypeRef, _err error)

GetType Get the type field of the given VGPU.

func (VGPUClass) GetUUID 

func (_class VGPUClass) GetUUID(sessionID SessionRef, self VGPURef) (_retval string, _err error)

GetUUID Get the uuid field of the given VGPU.

func (VGPUClass) GetVM 

func (_class VGPUClass) GetVM(sessionID SessionRef, self VGPURef) (_retval VMRef, _err error)

GetVM Get the VM field of the given VGPU.

func (VGPUClass) RemoveFromOtherConfig 

func (_class VGPUClass) RemoveFromOtherConfig(sessionID SessionRef, self VGPURef, key string) (_err error)

RemoveFromOtherConfig 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) SetExtraArgs 

func (_class VGPUClass) SetExtraArgs(sessionID SessionRef, self VGPURef, value string) (_err error)

SetExtraArgs Set the extra_args field of the given VGPU.

func (VGPUClass) SetOtherConfig 

func (_class VGPUClass) SetOtherConfig(sessionID SessionRef, self VGPURef, value map[string]string) (_err error)

SetOtherConfig 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
	// The PGPU on which this VGPU is scheduled to run
	ScheduledToBeResidentOn PGPURef
	// VGPU metadata to determine whether a VGPU can migrate between two PGPUs
	CompatibilityMetadata map[string]string
	// Extra arguments for vGPU and passed to demu
	ExtraArgs string
	// Device passed trough to VM, either as full device or SR-IOV virtual function
	PCI PCIRef
}

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)

GetAll 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)

GetAllRecords 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)

GetByUUID Get a reference to the VGPU_type instance with the specified UUID.

func (VGPUTypeClass) GetCompatibleTypesInVM 

func (_class VGPUTypeClass) GetCompatibleTypesInVM(sessionID SessionRef, self VGPUTypeRef) (_retval []VGPUTypeRef, _err error)

GetCompatibleTypesInVM Get the compatible_types_in_vm field of the given VGPU_type.

func (VGPUTypeClass) GetEnabledOnGPUGroups 

func (_class VGPUTypeClass) GetEnabledOnGPUGroups(sessionID SessionRef, self VGPUTypeRef) (_retval []GPUGroupRef, _err error)

GetEnabledOnGPUGroups 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)

GetEnabledOnPGPUs 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)

GetExperimental Get the experimental field of the given VGPU_type.

func (VGPUTypeClass) GetFramebufferSize 

func (_class VGPUTypeClass) GetFramebufferSize(sessionID SessionRef, self VGPUTypeRef) (_retval int, _err error)

GetFramebufferSize 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)

GetIdentifier Get the identifier field of the given VGPU_type.

func (VGPUTypeClass) GetImplementation 

func (_class VGPUTypeClass) GetImplementation(sessionID SessionRef, self VGPUTypeRef) (_retval VgpuTypeImplementation, _err error)

GetImplementation Get the implementation field of the given VGPU_type.

func (VGPUTypeClass) GetMaxHeads 

func (_class VGPUTypeClass) GetMaxHeads(sessionID SessionRef, self VGPUTypeRef) (_retval int, _err error)

GetMaxHeads 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)

GetMaxResolutionX 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)

GetMaxResolutionY 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)

GetModelName 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)

GetRecord 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)

GetSupportedOnGPUGroups 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)

GetSupportedOnPGPUs 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)

GetUUID Get the uuid field of the given VGPU_type.

func (VGPUTypeClass) GetVGPUs 

func (_class VGPUTypeClass) GetVGPUs(sessionID SessionRef, self VGPUTypeRef) (_retval []VGPURef, _err error)

GetVGPUs Get the VGPUs field of the given VGPU_type.

func (VGPUTypeClass) GetVendorName 

func (_class VGPUTypeClass) GetVendorName(sessionID SessionRef, self VGPUTypeRef) (_retval string, _err error)

GetVendorName 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
	// List of VGPU types which are compatible in one VM
	CompatibleTypesInVM []VGPUTypeRef
}

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)

AddIpv4Allowed Associates an IPv4 address with this VIF

func (VIFClass) AddIpv6Allowed 

func (_class VIFClass) AddIpv6Allowed(sessionID SessionRef, self VIFRef, value string) (_err error)

AddIpv6Allowed Associates an IPv6 address with this VIF

func (VIFClass) AddToOtherConfig 

func (_class VIFClass) AddToOtherConfig(sessionID SessionRef, self VIFRef, key string, value string) (_err error)

AddToOtherConfig 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)

AddToQosAlgorithmParams Add the given key-value pair to the qos/algorithm_params field of the given VIF.

func (VIFClass) ConfigureIpv4 

func (_class VIFClass) ConfigureIpv4(sessionID SessionRef, self VIFRef, mode VifIpv4ConfigurationMode, address string, gateway string) (_err error)

ConfigureIpv4 Configure IPv4 settings for this virtual interface

func (VIFClass) ConfigureIpv6 

func (_class VIFClass) ConfigureIpv6(sessionID SessionRef, self VIFRef, mode VifIpv6ConfigurationMode, address string, gateway string) (_err error)

ConfigureIpv6 Configure IPv6 settings for this virtual interface

func (VIFClass) Create 

func (_class VIFClass) Create(sessionID SessionRef, args VIFRecord) (_retval VIFRef, _err error)

Create Create a new VIF instance, and return its handle. The constructor args are: device*, network*, VM*, MAC*, MTU*, other_config*, currently_attached, 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 Destroy the specified VIF instance.

func (VIFClass) GetAll 

func (_class VIFClass) GetAll(sessionID SessionRef) (_retval []VIFRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations Get the allowed_operations field of the given VIF.

func (VIFClass) GetByUUID 

func (_class VIFClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VIFRef, _err error)

GetByUUID 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)

GetCurrentOperations Get the current_operations field of the given VIF.

func (VIFClass) GetCurrentlyAttached 

func (_class VIFClass) GetCurrentlyAttached(sessionID SessionRef, self VIFRef) (_retval bool, _err error)

GetCurrentlyAttached Get the currently_attached field of the given VIF.

func (VIFClass) GetDevice 

func (_class VIFClass) GetDevice(sessionID SessionRef, self VIFRef) (_retval string, _err error)

GetDevice Get the device field of the given VIF.

func (VIFClass) GetIpv4Addresses 

func (_class VIFClass) GetIpv4Addresses(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

GetIpv4Addresses Get the ipv4_addresses field of the given VIF.

func (VIFClass) GetIpv4Allowed 

func (_class VIFClass) GetIpv4Allowed(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

GetIpv4Allowed Get the ipv4_allowed field of the given VIF.

func (VIFClass) GetIpv4ConfigurationMode 

func (_class VIFClass) GetIpv4ConfigurationMode(sessionID SessionRef, self VIFRef) (_retval VifIpv4ConfigurationMode, _err error)

GetIpv4ConfigurationMode Get the ipv4_configuration_mode field of the given VIF.

func (VIFClass) GetIpv4Gateway 

func (_class VIFClass) GetIpv4Gateway(sessionID SessionRef, self VIFRef) (_retval string, _err error)

GetIpv4Gateway Get the ipv4_gateway field of the given VIF.

func (VIFClass) GetIpv6Addresses 

func (_class VIFClass) GetIpv6Addresses(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

GetIpv6Addresses Get the ipv6_addresses field of the given VIF.

func (VIFClass) GetIpv6Allowed 

func (_class VIFClass) GetIpv6Allowed(sessionID SessionRef, self VIFRef) (_retval []string, _err error)

GetIpv6Allowed Get the ipv6_allowed field of the given VIF.

func (VIFClass) GetIpv6ConfigurationMode 

func (_class VIFClass) GetIpv6ConfigurationMode(sessionID SessionRef, self VIFRef) (_retval VifIpv6ConfigurationMode, _err error)

GetIpv6ConfigurationMode Get the ipv6_configuration_mode field of the given VIF.

func (VIFClass) GetIpv6Gateway 

func (_class VIFClass) GetIpv6Gateway(sessionID SessionRef, self VIFRef) (_retval string, _err error)

GetIpv6Gateway Get the ipv6_gateway field of the given VIF.

func (VIFClass) GetLockingMode 

func (_class VIFClass) GetLockingMode(sessionID SessionRef, self VIFRef) (_retval VifLockingMode, _err error)

GetLockingMode Get the locking_mode field of the given VIF.

func (VIFClass) GetMAC 

func (_class VIFClass) GetMAC(sessionID SessionRef, self VIFRef) (_retval string, _err error)

GetMAC Get the MAC field of the given VIF.

func (VIFClass) GetMACAutogenerated 

func (_class VIFClass) GetMACAutogenerated(sessionID SessionRef, self VIFRef) (_retval bool, _err error)

GetMACAutogenerated Get the MAC_autogenerated field of the given VIF.

func (VIFClass) GetMTU 

func (_class VIFClass) GetMTU(sessionID SessionRef, self VIFRef) (_retval int, _err error)

GetMTU Get the MTU field of the given VIF.

func (VIFClass) GetMetrics 

func (_class VIFClass) GetMetrics(sessionID SessionRef, self VIFRef) (_retval VIFMetricsRef, _err error)

GetMetrics Get the metrics field of the given VIF.

func (VIFClass) GetNetwork 

func (_class VIFClass) GetNetwork(sessionID SessionRef, self VIFRef) (_retval NetworkRef, _err error)

GetNetwork 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)

GetOtherConfig 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)

GetQosAlgorithmParams 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)

GetQosAlgorithmType 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)

GetQosSupportedAlgorithms 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)

GetRecord 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)

GetRuntimeProperties Get the runtime_properties field of the given VIF.

func (VIFClass) GetStatusCode 

func (_class VIFClass) GetStatusCode(sessionID SessionRef, self VIFRef) (_retval int, _err error)

GetStatusCode Get the status_code field of the given VIF.

func (VIFClass) GetStatusDetail 

func (_class VIFClass) GetStatusDetail(sessionID SessionRef, self VIFRef) (_retval string, _err error)

GetStatusDetail Get the status_detail field of the given VIF.

func (VIFClass) GetUUID 

func (_class VIFClass) GetUUID(sessionID SessionRef, self VIFRef) (_retval string, _err error)

GetUUID Get the uuid field of the given VIF.

func (VIFClass) GetVM 

func (_class VIFClass) GetVM(sessionID SessionRef, self VIFRef) (_retval VMRef, _err error)

GetVM Get the VM field of the given VIF.

func (VIFClass) Move 

func (_class VIFClass) Move(sessionID SessionRef, self VIFRef, network NetworkRef) (_err error)

Move Move the specified VIF to the specified network, even while the VM is running

func (VIFClass) Plug 

func (_class VIFClass) Plug(sessionID SessionRef, self VIFRef) (_err error)

Plug 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)

RemoveFromOtherConfig 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)

RemoveFromQosAlgorithmParams 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)

RemoveIpv4Allowed Removes an IPv4 address from this VIF

func (VIFClass) RemoveIpv6Allowed 

func (_class VIFClass) RemoveIpv6Allowed(sessionID SessionRef, self VIFRef, value string) (_err error)

RemoveIpv6Allowed Removes an IPv6 address from this VIF

func (VIFClass) SetIpv4Allowed 

func (_class VIFClass) SetIpv4Allowed(sessionID SessionRef, self VIFRef, value []string) (_err error)

SetIpv4Allowed 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)

SetIpv6Allowed 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)

SetLockingMode Set the locking mode for this VIF

func (VIFClass) SetOtherConfig 

func (_class VIFClass) SetOtherConfig(sessionID SessionRef, self VIFRef, value map[string]string) (_err error)

SetOtherConfig 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)

SetQosAlgorithmParams 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)

SetQosAlgorithmType Set the qos/algorithm_type field of the given VIF.

func (VIFClass) Unplug 

func (_class VIFClass) Unplug(sessionID SessionRef, self VIFRef) (_err error)

Unplug 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)

UnplugForce 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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetIoReadKbs 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)

GetIoWriteKbs 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)

GetLastUpdated 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)

GetOtherConfig 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)

GetRecord 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)

GetUUID Get the uuid field of the given VIF_metrics.

func (VIFMetricsClass) RemoveFromOtherConfig 

func (_class VIFMetricsClass) RemoveFromOtherConfig(sessionID SessionRef, self VIFMetricsRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// Determines whether IPv4 addresses are configured on the VIF
	Ipv4ConfigurationMode VifIpv4ConfigurationMode
	// IPv4 addresses in CIDR format
	Ipv4Addresses []string
	// IPv4 gateway (the empty string means that no gateway is set)
	Ipv4Gateway string
	// Determines whether IPv6 addresses are configured on the VIF
	Ipv6ConfigurationMode VifIpv6ConfigurationMode
	// IPv6 addresses in CIDR format
	Ipv6Addresses []string
	// IPv6 gateway (the empty string means that no gateway is set)
	Ipv6Gateway 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)

AddToOtherConfig 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 Create a VLAN mux/demuxer

func (VLANClass) Destroy 

func (_class VLANClass) Destroy(sessionID SessionRef, self VLANRef) (_err error)

Destroy Destroy a VLAN mux/demuxer

func (VLANClass) GetAll 

func (_class VLANClass) GetAll(sessionID SessionRef) (_retval []VLANRef, _err error)

GetAll 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)

GetAllRecords 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)

GetByUUID 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)

GetOtherConfig Get the other_config field of the given VLAN.

func (VLANClass) GetRecord 

func (_class VLANClass) GetRecord(sessionID SessionRef, self VLANRef) (_retval VLANRecord, _err error)

GetRecord 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)

GetTag Get the tag field of the given VLAN.

func (VLANClass) GetTaggedPIF 

func (_class VLANClass) GetTaggedPIF(sessionID SessionRef, self VLANRef) (_retval PIFRef, _err error)

GetTaggedPIF Get the tagged_PIF field of the given VLAN.

func (VLANClass) GetUUID 

func (_class VLANClass) GetUUID(sessionID SessionRef, self VLANRef) (_retval string, _err error)

GetUUID Get the uuid field of the given VLAN.

func (VLANClass) GetUntaggedPIF 

func (_class VLANClass) GetUntaggedPIF(sessionID SessionRef, self VLANRef) (_retval PIFRef, _err error)

GetUntaggedPIF Get the untagged_PIF field of the given VLAN.

func (VLANClass) RemoveFromOtherConfig 

func (_class VLANClass) RemoveFromOtherConfig(sessionID SessionRef, self VLANRef, key string) (_err error)

RemoveFromOtherConfig 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)

SetOtherConfig 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)

AssertCanBeRecovered 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)

CleanShutdown 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 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 Destroy the specified VM_appliance instance.

func (VMApplianceClass) GetAll 

func (_class VMApplianceClass) GetAll(sessionID SessionRef) (_retval []VMApplianceRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations 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)

GetByNameLabel 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)

GetByUUID 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)

GetCurrentOperations 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)

GetNameDescription 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)

GetNameLabel 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)

GetRecord 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)

GetSRsRequiredForRecovery 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)

GetUUID Get the uuid field of the given VM_appliance.

func (VMApplianceClass) GetVMs 

func (_class VMApplianceClass) GetVMs(sessionID SessionRef, self VMApplianceRef) (_retval []VMRef, _err error)

GetVMs Get the VMs field of the given VM_appliance.

func (VMApplianceClass) HardShutdown 

func (_class VMApplianceClass) HardShutdown(sessionID SessionRef, self VMApplianceRef) (_err error)

HardShutdown 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 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)

SetNameDescription 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)

SetNameLabel Set the name/label field of the given VM_appliance.

func (VMApplianceClass) Shutdown 

func (_class VMApplianceClass) Shutdown(sessionID SessionRef, self VMApplianceRef) (_err error)

Shutdown 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 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)

AddTags 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)

AddToBlockedOperations 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)

AddToHVMBootParams Add the given key-value pair to the HVM/boot_params field of the given VM.

func (VMClass) AddToNVRAM 

func (_class VMClass) AddToNVRAM(sessionID SessionRef, self VMRef, key string, value string) (_err error)

AddToNVRAM

func (VMClass) AddToOtherConfig 

func (_class VMClass) AddToOtherConfig(sessionID SessionRef, self VMRef, key string, value string) (_err error)

AddToOtherConfig 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)

AddToPlatform 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)

AddToVCPUsParams 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)

AddToVCPUsParamsLive 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)

AddToXenstoreData 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)

AssertAgile 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)

AssertCanBeRecovered 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)

AssertCanBootHere Returns an error if the VM could not boot on this host for some reason

Errors: 

HOST_NOT_ENOUGH_FREE_MEMORY - Not enough server memory is available to perform this operation.
HOST_NOT_ENOUGH_PCPUS - The host does not have enough pCPUs to run the VM. It needs at least as many as the VM has vCPUs.
NETWORK_SRIOV_INSUFFICIENT_CAPACITY - There is insufficient capacity for VF reservation
HOST_NOT_LIVE - This operation cannot be completed as the server is not live.
HOST_DISABLED - The specified server is disabled.
HOST_CANNOT_ATTACH_NETWORK - Server cannot attach network (in the case of NIC bonding, this may be because attaching the network on this server would require other networks - that are currently active - to be taken down).
VM_HVM_REQUIRED - HVM is required for this operation
VM_REQUIRES_GPU - You attempted to run a VM on a host which doesn't have a pGPU available in the GPU group needed by the VM. The VM has a vGPU attached to this GPU group.
VM_REQUIRES_IOMMU - You attempted to run a VM on a host which doesn't have I/O virtualization (IOMMU/VT-d) enabled, which is needed by the VM.
VM_REQUIRES_NETWORK - You attempted to run a VM on a host which doesn't have a PIF on a Network needed by the VM. The VM has at least one VIF attached to the Network.
VM_REQUIRES_SR - You attempted to run a VM on a host which doesn't have access to an SR needed by the VM. The VM has at least one VBD attached to a VDI in the SR.
VM_REQUIRES_VGPU - You attempted to run a VM on a host on which the vGPU required by the VM cannot be allocated on any pGPUs in the GPU_group needed by the VM.
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.
INVALID_VALUE - The value given is invalid
MEMORY_CONSTRAINT_VIOLATION - The dynamic memory range does not satisfy the following constraint.
OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
VALUE_NOT_SUPPORTED - You attempted to set a value that is not supported by this implementation. The fully-qualified field name and the value that you tried to set are returned. Also returned is a developer-only diagnostic reason.
VM_INCOMPATIBLE_WITH_THIS_HOST - The VM is incompatible with the CPU features of this host.

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, vgpuMap map[VGPURef]GPUGroupRef) (_err error)

AssertCanMigrate Assert whether a VM can be migrated to the specified destination.

Errors: 

LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) AssertOperationValid 

func (_class VMClass) AssertOperationValid(sessionID SessionRef, self VMRef, op VMOperations) (_err error)

AssertOperationValid 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)

CallPlugin Call an API plugin on this vm

func (VMClass) Checkpoint 

func (_class VMClass) Checkpoint(sessionID SessionRef, vm VMRef, newName string) (_retval VMRef, _err error)

Checkpoint 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)

CleanReboot 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)

CleanShutdown 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)

Clone 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.
LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) ComputeMemoryOverhead 

func (_class VMClass) ComputeMemoryOverhead(sessionID SessionRef, vm VMRef) (_retval int, _err error)

ComputeMemoryOverhead 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)

Copy 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.
LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) CopyBiosStrings 

func (_class VMClass) CopyBiosStrings(sessionID SessionRef, vm VMRef, host HostRef) (_err error)

CopyBiosStrings 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 NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. The constructor args are: name_label, name_description, power_state, user_version*, is_a_template*, suspend_VDI, affinity*, memory_target, memory_static_max*, memory_dynamic_max*, memory_dynamic_min*, memory_static_min*, VCPUs_params*, VCPUs_max*, VCPUs_at_startup*, actions_after_softreboot, 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*, last_boot_CPU_flags, last_booted_record, recommendations*, xenstore_data, ha_always_run, ha_restart_priority, tags, blocked_operations, protection_policy, is_snapshot_from_vmpp, snapshot_schedule, is_vmss_snapshot, appliance, start_delay, shutdown_delay, order, suspend_SR, version, generation_id, hardware_platform_version, has_vendor_device, reference_label, domain_type, NVRAM (* = non-optional).

func (VMClass) CreateNewBlob 

func (_class VMClass) CreateNewBlob(sessionID SessionRef, vm VMRef, name string, mimeType string, public bool) (_retval BlobRef, _err error)

CreateNewBlob 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 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)

ForgetDataSourceArchives 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)

GetActionsAfterCrash 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)

GetActionsAfterReboot 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)

GetActionsAfterShutdown Get the actions/after_shutdown field of the given VM.

func (VMClass) GetActionsAfterSoftreboot 

func (_class VMClass) GetActionsAfterSoftreboot(sessionID SessionRef, self VMRef) (_retval OnSoftrebootBehavior, _err error)

GetActionsAfterSoftreboot Get the actions/after_softreboot field of the given VM.

func (VMClass) GetAffinity 

func (_class VMClass) GetAffinity(sessionID SessionRef, self VMRef) (_retval HostRef, _err error)

GetAffinity Get the affinity field of the given VM.

func (VMClass) GetAll 

func (_class VMClass) GetAll(sessionID SessionRef) (_retval []VMRef, _err error)

GetAll 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)

GetAllRecords 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)

GetAllowedOperations Get the allowed_operations field of the given VM.

func (VMClass) GetAllowedVBDDevices 

func (_class VMClass) GetAllowedVBDDevices(sessionID SessionRef, vm VMRef) (_retval []string, _err error)

GetAllowedVBDDevices 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)

GetAllowedVIFDevices 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)

GetAppliance Get the appliance field of the given VM.

func (VMClass) GetAttachedPCIs 

func (_class VMClass) GetAttachedPCIs(sessionID SessionRef, self VMRef) (_retval []PCIRef, _err error)

GetAttachedPCIs Get the attached_PCIs field of the given VM.

func (VMClass) GetBiosStrings 

func (_class VMClass) GetBiosStrings(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

GetBiosStrings 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)

GetBlobs 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)

GetBlockedOperations Get the blocked_operations field of the given VM.

func (VMClass) GetBootRecord 

func (_class VMClass) GetBootRecord(sessionID SessionRef, self VMRef) (_retval VMRecord, _err error)

GetBootRecord 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)

GetByNameLabel Get all the VM instances with the given label.

func (VMClass) GetByUUID 

func (_class VMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMRef, _err error)

GetByUUID 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)

GetChildren Get the children field of the given VM.

func (VMClass) GetConsoles 

func (_class VMClass) GetConsoles(sessionID SessionRef, self VMRef) (_retval []ConsoleRef, _err error)

GetConsoles Get the consoles field of the given VM.

func (VMClass) GetCooperative 

func (_class VMClass) GetCooperative(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetCooperative 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)

GetCrashDumps 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)

GetCurrentOperations Get the current_operations field of the given VM.

func (VMClass) GetDataSources 

func (_class VMClass) GetDataSources(sessionID SessionRef, self VMRef) (_retval []DataSourceRecord, _err error)

GetDataSources

func (VMClass) GetDomainType 

func (_class VMClass) GetDomainType(sessionID SessionRef, self VMRef) (_retval DomainType, _err error)

GetDomainType Get the domain_type field of the given VM.

func (VMClass) GetDomarch 

func (_class VMClass) GetDomarch(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetDomarch Get the domarch field of the given VM.

func (VMClass) GetDomid 

func (_class VMClass) GetDomid(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetDomid Get the domid field of the given VM.

func (VMClass) GetGenerationID 

func (_class VMClass) GetGenerationID(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetGenerationID Get the generation_id field of the given VM.

func (VMClass) GetGuestMetrics 

func (_class VMClass) GetGuestMetrics(sessionID SessionRef, self VMRef) (_retval VMGuestMetricsRef, _err error)

GetGuestMetrics 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)

GetHVMBootParams 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)

GetHVMBootPolicy 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)

GetHVMShadowMultiplier 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)

GetHaAlwaysRun 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)

GetHaRestartPriority 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)

GetHardwarePlatformVersion Get the hardware_platform_version field of the given VM.

func (VMClass) GetHasVendorDevice 

func (_class VMClass) GetHasVendorDevice(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetHasVendorDevice Get the has_vendor_device field of the given VM.

func (VMClass) GetIsASnapshot 

func (_class VMClass) GetIsASnapshot(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetIsASnapshot 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)

GetIsATemplate 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)

GetIsControlDomain Get the is_control_domain field of the given VM.

func (VMClass) GetIsDefaultTemplate 

func (_class VMClass) GetIsDefaultTemplate(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetIsDefaultTemplate Get the is_default_template field of the given VM.

func (VMClass) GetIsSnapshotFromVmpp 

func (_class VMClass) GetIsSnapshotFromVmpp(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetIsSnapshotFromVmpp Get the is_snapshot_from_vmpp field of the given VM.

func (VMClass) GetIsVmssSnapshot 

func (_class VMClass) GetIsVmssSnapshot(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetIsVmssSnapshot Get the is_vmss_snapshot field of the given VM.

func (VMClass) GetLastBootCPUFlags 

func (_class VMClass) GetLastBootCPUFlags(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

GetLastBootCPUFlags 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)

GetLastBootedRecord 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)

GetMemoryDynamicMax 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)

GetMemoryDynamicMin 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)

GetMemoryOverhead Get the memory/overhead field of the given VM.

func (VMClass) GetMemoryStaticMax 

func (_class VMClass) GetMemoryStaticMax(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetMemoryStaticMax 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)

GetMemoryStaticMin 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)

GetMemoryTarget Get the memory/target field of the given VM.

func (VMClass) GetMetrics 

func (_class VMClass) GetMetrics(sessionID SessionRef, self VMRef) (_retval VMMetricsRef, _err error)

GetMetrics Get the metrics field of the given VM.

func (VMClass) GetNVRAM 

func (_class VMClass) GetNVRAM(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

GetNVRAM Get the NVRAM field of the given VM.

func (VMClass) GetNameDescription 

func (_class VMClass) GetNameDescription(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given VM.

func (VMClass) GetNameLabel 

func (_class VMClass) GetNameLabel(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given VM.

func (VMClass) GetOrder 

func (_class VMClass) GetOrder(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetOrder 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)

GetOtherConfig Get the other_config field of the given VM.

func (VMClass) GetPCIBus 

func (_class VMClass) GetPCIBus(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetPCIBus Get the PCI_bus field of the given VM.

func (VMClass) GetPVArgs 

func (_class VMClass) GetPVArgs(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetPVArgs Get the PV/args field of the given VM.

func (VMClass) GetPVBootloader 

func (_class VMClass) GetPVBootloader(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetPVBootloader Get the PV/bootloader field of the given VM.

func (VMClass) GetPVBootloaderArgs 

func (_class VMClass) GetPVBootloaderArgs(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetPVBootloaderArgs 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)

GetPVKernel Get the PV/kernel field of the given VM.

func (VMClass) GetPVLegacyArgs 

func (_class VMClass) GetPVLegacyArgs(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetPVLegacyArgs 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)

GetPVRamdisk Get the PV/ramdisk field of the given VM.

func (VMClass) GetParent 

func (_class VMClass) GetParent(sessionID SessionRef, self VMRef) (_retval VMRef, _err error)

GetParent Get the parent field of the given VM.

func (VMClass) GetPendingGuidances 

func (_class VMClass) GetPendingGuidances(sessionID SessionRef, self VMRef) (_retval []UpdateGuidances, _err error)

GetPendingGuidances Get the pending_guidances field of the given VM.

func (VMClass) GetPlatform 

func (_class VMClass) GetPlatform(sessionID SessionRef, self VMRef) (_retval map[string]string, _err error)

GetPlatform Get the platform field of the given VM.

func (VMClass) GetPossibleHosts 

func (_class VMClass) GetPossibleHosts(sessionID SessionRef, vm VMRef) (_retval []HostRef, _err error)

GetPossibleHosts 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)

GetPowerState Get the power_state field of the given VM.

func (VMClass) GetProtectionPolicy 

func (_class VMClass) GetProtectionPolicy(sessionID SessionRef, self VMRef) (_retval VMPPRef, _err error)

GetProtectionPolicy Get the protection_policy field of the given VM.

func (VMClass) GetRecommendations 

func (_class VMClass) GetRecommendations(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetRecommendations Get the recommendations field of the given VM.

func (VMClass) GetRecord 

func (_class VMClass) GetRecord(sessionID SessionRef, self VMRef) (_retval VMRecord, _err error)

GetRecord Get a record containing the current state of the given VM.

func (VMClass) GetReferenceLabel 

func (_class VMClass) GetReferenceLabel(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetReferenceLabel Get the reference_label field of the given VM.

func (VMClass) GetRequiresReboot 

func (_class VMClass) GetRequiresReboot(sessionID SessionRef, self VMRef) (_retval bool, _err error)

GetRequiresReboot Get the requires_reboot field of the given VM.

func (VMClass) GetResidentOn 

func (_class VMClass) GetResidentOn(sessionID SessionRef, self VMRef) (_retval HostRef, _err error)

GetResidentOn 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)

GetSRsRequiredForRecovery List all the SR's that are required for the VM to be recovered

func (VMClass) GetScheduledToBeResidentOn 

func (_class VMClass) GetScheduledToBeResidentOn(sessionID SessionRef, self VMRef) (_retval HostRef, _err error)

GetScheduledToBeResidentOn Get the scheduled_to_be_resident_on field of the given VM.

func (VMClass) GetShutdownDelay 

func (_class VMClass) GetShutdownDelay(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetShutdownDelay 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)

GetSnapshotInfo Get the snapshot_info field of the given VM.

func (VMClass) GetSnapshotMetadata 

func (_class VMClass) GetSnapshotMetadata(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetSnapshotMetadata Get the snapshot_metadata field of the given VM.

func (VMClass) GetSnapshotOf 

func (_class VMClass) GetSnapshotOf(sessionID SessionRef, self VMRef) (_retval VMRef, _err error)

GetSnapshotOf Get the snapshot_of field of the given VM.

func (VMClass) GetSnapshotSchedule 

func (_class VMClass) GetSnapshotSchedule(sessionID SessionRef, self VMRef) (_retval VMSSRef, _err error)

GetSnapshotSchedule Get the snapshot_schedule field of the given VM.

func (VMClass) GetSnapshotTime 

func (_class VMClass) GetSnapshotTime(sessionID SessionRef, self VMRef) (_retval time.Time, _err error)

GetSnapshotTime Get the snapshot_time field of the given VM.

func (VMClass) GetSnapshots 

func (_class VMClass) GetSnapshots(sessionID SessionRef, self VMRef) (_retval []VMRef, _err error)

GetSnapshots Get the snapshots field of the given VM.

func (VMClass) GetStartDelay 

func (_class VMClass) GetStartDelay(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetStartDelay Get the start_delay field of the given VM.

func (VMClass) GetSuspendSR 

func (_class VMClass) GetSuspendSR(sessionID SessionRef, self VMRef) (_retval SRRef, _err error)

GetSuspendSR Get the suspend_SR field of the given VM.

func (VMClass) GetSuspendVDI 

func (_class VMClass) GetSuspendVDI(sessionID SessionRef, self VMRef) (_retval VDIRef, _err error)

GetSuspendVDI Get the suspend_VDI field of the given VM.

func (VMClass) GetTags 

func (_class VMClass) GetTags(sessionID SessionRef, self VMRef) (_retval []string, _err error)

GetTags Get the tags field of the given VM.

func (VMClass) GetTransportableSnapshotID 

func (_class VMClass) GetTransportableSnapshotID(sessionID SessionRef, self VMRef) (_retval string, _err error)

GetTransportableSnapshotID 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)

GetUUID Get the uuid field of the given VM.

func (VMClass) GetUserVersion 

func (_class VMClass) GetUserVersion(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetUserVersion Get the user_version field of the given VM.

func (VMClass) GetVBDs 

func (_class VMClass) GetVBDs(sessionID SessionRef, self VMRef) (_retval []VBDRef, _err error)

GetVBDs Get the VBDs field of the given VM.

func (VMClass) GetVCPUsAtStartup 

func (_class VMClass) GetVCPUsAtStartup(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetVCPUsAtStartup 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)

GetVCPUsMax 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)

GetVCPUsParams Get the VCPUs/params field of the given VM.

func (VMClass) GetVGPUs 

func (_class VMClass) GetVGPUs(sessionID SessionRef, self VMRef) (_retval []VGPURef, _err error)

GetVGPUs Get the VGPUs field of the given VM.

func (VMClass) GetVIFs 

func (_class VMClass) GetVIFs(sessionID SessionRef, self VMRef) (_retval []VIFRef, _err error)

GetVIFs Get the VIFs field of the given VM.

func (VMClass) GetVTPMs 

func (_class VMClass) GetVTPMs(sessionID SessionRef, self VMRef) (_retval []VTPMRef, _err error)

GetVTPMs Get the VTPMs field of the given VM.

func (VMClass) GetVUSBs 

func (_class VMClass) GetVUSBs(sessionID SessionRef, self VMRef) (_retval []VUSBRef, _err error)

GetVUSBs Get the VUSBs field of the given VM.

func (VMClass) GetVersion 

func (_class VMClass) GetVersion(sessionID SessionRef, self VMRef) (_retval int, _err error)

GetVersion 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)

GetXenstoreData Get the xenstore_data field of the given VM.

func (VMClass) HardReboot 

func (_class VMClass) HardReboot(sessionID SessionRef, vm VMRef) (_err error)

HardReboot 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)

HardShutdown 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 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)

ImportConvert Import using a conversion service.

func (VMClass) MaximiseMemory 

func (_class VMClass) MaximiseMemory(sessionID SessionRef, self VMRef, total int, approximate bool) (_retval int, _err error)

MaximiseMemory 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, vgpuMap map[VGPURef]GPUGroupRef) (_retval VMRef, _err error)

MigrateSend 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.
LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) Pause 

func (_class VMClass) Pause(sessionID SessionRef, vm VMRef) (_err error)

Pause 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)

PoolMigrate 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)

PowerStateReset 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)

Provision 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.
LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) QueryDataSource 

func (_class VMClass) QueryDataSource(sessionID SessionRef, self VMRef, dataSource string) (_retval float64, _err error)

QueryDataSource 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)

QueryServices 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)

RecordDataSource Start recording the specified data source

func (VMClass) Recover 

func (_class VMClass) Recover(sessionID SessionRef, self VMRef, sessionTo SessionRef, force bool) (_err error)

Recover Recover the VM

func (VMClass) RemoveFromBlockedOperations 

func (_class VMClass) RemoveFromBlockedOperations(sessionID SessionRef, self VMRef, key VMOperations) (_err error)

RemoveFromBlockedOperations 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)

RemoveFromHVMBootParams 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) RemoveFromNVRAM 

func (_class VMClass) RemoveFromNVRAM(sessionID SessionRef, self VMRef, key string) (_err error)

RemoveFromNVRAM

func (VMClass) RemoveFromOtherConfig 

func (_class VMClass) RemoveFromOtherConfig(sessionID SessionRef, self VMRef, key string) (_err error)

RemoveFromOtherConfig 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)

RemoveFromPlatform 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)

RemoveFromVCPUsParams 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)

RemoveFromXenstoreData 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)

RemoveTags 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)

Resume 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)

ResumeOn 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)

RetrieveWlbRecommendations 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)

Revert 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)

SendSysrq 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)

SendTrigger 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)

SetActionsAfterCrash Sets the actions_after_crash parameter

func (VMClass) SetActionsAfterReboot 

func (_class VMClass) SetActionsAfterReboot(sessionID SessionRef, self VMRef, value OnNormalExit) (_err error)

SetActionsAfterReboot 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)

SetActionsAfterShutdown Set the actions/after_shutdown field of the given VM.

func (VMClass) SetActionsAfterSoftreboot 

func (_class VMClass) SetActionsAfterSoftreboot(sessionID SessionRef, self VMRef, value OnSoftrebootBehavior) (_err error)

SetActionsAfterSoftreboot Set the actions/after_softreboot field of the given VM.

func (VMClass) SetAffinity 

func (_class VMClass) SetAffinity(sessionID SessionRef, self VMRef, value HostRef) (_err error)

SetAffinity Set the affinity field of the given VM.

func (VMClass) SetAppliance 

func (_class VMClass) SetAppliance(sessionID SessionRef, self VMRef, value VMApplianceRef) (_err error)

SetAppliance Assign this VM to an appliance.

func (VMClass) SetBiosStrings 

func (_class VMClass) SetBiosStrings(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

SetBiosStrings Set custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag'

Errors: 

VM_BIOS_STRINGS_ALREADY_SET - The BIOS strings for this VM have already been set and cannot be changed.
INVALID_VALUE - The value given is invalid

func (VMClass) SetBlockedOperations 

func (_class VMClass) SetBlockedOperations(sessionID SessionRef, self VMRef, value map[VMOperations]string) (_err error)

SetBlockedOperations Set the blocked_operations field of the given VM.

func (VMClass) SetDomainType 

func (_class VMClass) SetDomainType(sessionID SessionRef, self VMRef, value DomainType) (_err error)

SetDomainType Set the VM.domain_type field of the given VM, which will take effect when it is next started

func (VMClass) SetHVMBootParams 

func (_class VMClass) SetHVMBootParams(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

SetHVMBootParams 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)

SetHVMBootPolicy Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started

func (VMClass) SetHVMShadowMultiplier 

func (_class VMClass) SetHVMShadowMultiplier(sessionID SessionRef, self VMRef, value float64) (_err error)

SetHVMShadowMultiplier Set the shadow memory multiplier on a halted VM

func (VMClass) SetHaAlwaysRun 

func (_class VMClass) SetHaAlwaysRun(sessionID SessionRef, self VMRef, value bool) (_err error)

SetHaAlwaysRun Set the value of the ha_always_run

func (VMClass) SetHaRestartPriority 

func (_class VMClass) SetHaRestartPriority(sessionID SessionRef, self VMRef, value string) (_err error)

SetHaRestartPriority Set the value of the ha_restart_priority field

func (VMClass) SetHardwarePlatformVersion 

func (_class VMClass) SetHardwarePlatformVersion(sessionID SessionRef, self VMRef, value int) (_err error)

SetHardwarePlatformVersion Set the hardware_platform_version field of the given VM.

func (VMClass) SetHasVendorDevice 

func (_class VMClass) SetHasVendorDevice(sessionID SessionRef, self VMRef, value bool) (_err error)

SetHasVendorDevice Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start.

func (VMClass) SetIsATemplate 

func (_class VMClass) SetIsATemplate(sessionID SessionRef, self VMRef, value bool) (_err error)

SetIsATemplate Set the is_a_template field of the given VM.

func (VMClass) SetMemory 

func (_class VMClass) SetMemory(sessionID SessionRef, self VMRef, value int) (_err error)

SetMemory Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched.

func (VMClass) SetMemoryDynamicMax 

func (_class VMClass) SetMemoryDynamicMax(sessionID SessionRef, self VMRef, value int) (_err error)

SetMemoryDynamicMax Set the value of the memory_dynamic_max field

func (VMClass) SetMemoryDynamicMin 

func (_class VMClass) SetMemoryDynamicMin(sessionID SessionRef, self VMRef, value int) (_err error)

SetMemoryDynamicMin 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)

SetMemoryDynamicRange 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)

SetMemoryLimits Set the memory limits of this VM.

func (VMClass) SetMemoryStaticMax 

func (_class VMClass) SetMemoryStaticMax(sessionID SessionRef, self VMRef, value int) (_err error)

SetMemoryStaticMax 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)

SetMemoryStaticMin 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)

SetMemoryStaticRange 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)

SetMemoryTargetLive Set the memory target for a running VM

func (VMClass) SetNVRAM 

func (_class VMClass) SetNVRAM(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

SetNVRAM

func (VMClass) SetNameDescription 

func (_class VMClass) SetNameDescription(sessionID SessionRef, self VMRef, value string) (_err error)

SetNameDescription Set the name/description field of the given VM.

func (VMClass) SetNameLabel 

func (_class VMClass) SetNameLabel(sessionID SessionRef, self VMRef, value string) (_err error)

SetNameLabel Set the name/label field of the given VM.

func (VMClass) SetOrder 

func (_class VMClass) SetOrder(sessionID SessionRef, self VMRef, value int) (_err error)

SetOrder Set this VM's boot order

func (VMClass) SetOtherConfig 

func (_class VMClass) SetOtherConfig(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given VM.

func (VMClass) SetPCIBus 

func (_class VMClass) SetPCIBus(sessionID SessionRef, self VMRef, value string) (_err error)

SetPCIBus Set the PCI_bus field of the given VM.

func (VMClass) SetPVArgs 

func (_class VMClass) SetPVArgs(sessionID SessionRef, self VMRef, value string) (_err error)

SetPVArgs Set the PV/args field of the given VM.

func (VMClass) SetPVBootloader 

func (_class VMClass) SetPVBootloader(sessionID SessionRef, self VMRef, value string) (_err error)

SetPVBootloader Set the PV/bootloader field of the given VM.

func (VMClass) SetPVBootloaderArgs 

func (_class VMClass) SetPVBootloaderArgs(sessionID SessionRef, self VMRef, value string) (_err error)

SetPVBootloaderArgs 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)

SetPVKernel Set the PV/kernel field of the given VM.

func (VMClass) SetPVLegacyArgs 

func (_class VMClass) SetPVLegacyArgs(sessionID SessionRef, self VMRef, value string) (_err error)

SetPVLegacyArgs 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)

SetPVRamdisk 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)

SetPlatform Set the platform field of the given VM.

func (VMClass) SetProtectionPolicy 

func (_class VMClass) SetProtectionPolicy(sessionID SessionRef, self VMRef, value VMPPRef) (_err error)

SetProtectionPolicy Set the value of the protection_policy field

func (VMClass) SetRecommendations 

func (_class VMClass) SetRecommendations(sessionID SessionRef, self VMRef, value string) (_err error)

SetRecommendations Set the recommendations field of the given VM.

func (VMClass) SetShadowMultiplierLive 

func (_class VMClass) SetShadowMultiplierLive(sessionID SessionRef, self VMRef, multiplier float64) (_err error)

SetShadowMultiplierLive Set the shadow memory multiplier on a running VM

func (VMClass) SetShutdownDelay 

func (_class VMClass) SetShutdownDelay(sessionID SessionRef, self VMRef, value int) (_err error)

SetShutdownDelay Set this VM's shutdown delay in seconds

func (VMClass) SetSnapshotSchedule 

func (_class VMClass) SetSnapshotSchedule(sessionID SessionRef, self VMRef, value VMSSRef) (_err error)

SetSnapshotSchedule Set the value of the snapshot schedule field

func (VMClass) SetStartDelay 

func (_class VMClass) SetStartDelay(sessionID SessionRef, self VMRef, value int) (_err error)

SetStartDelay Set this VM's start delay in seconds

func (VMClass) SetSuspendSR 

func (_class VMClass) SetSuspendSR(sessionID SessionRef, self VMRef, value SRRef) (_err error)

SetSuspendSR Set the suspend_SR field of the given VM.

func (VMClass) SetSuspendVDI 

func (_class VMClass) SetSuspendVDI(sessionID SessionRef, self VMRef, value VDIRef) (_err error)

SetSuspendVDI 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)

SetTags Set the tags field of the given VM.

func (VMClass) SetUserVersion 

func (_class VMClass) SetUserVersion(sessionID SessionRef, self VMRef, value int) (_err error)

SetUserVersion Set the user_version field of the given VM.

func (VMClass) SetVCPUsAtStartup 

func (_class VMClass) SetVCPUsAtStartup(sessionID SessionRef, self VMRef, value int) (_err error)

SetVCPUsAtStartup 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)

SetVCPUsMax 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)

SetVCPUsNumberLive Set the number of VCPUs for a running VM

Errors: 

OPERATION_NOT_ALLOWED - You attempted an operation that was not allowed.
LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) SetVCPUsParams 

func (_class VMClass) SetVCPUsParams(sessionID SessionRef, self VMRef, value map[string]string) (_err error)

SetVCPUsParams 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)

SetXenstoreData Set the xenstore_data field of the given VM.

func (VMClass) Shutdown 

func (_class VMClass) Shutdown(sessionID SessionRef, vm VMRef) (_err error)

Shutdown 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, ignoreVdis []VDIRef) (_retval VMRef, _err error)

Snapshot 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)

SnapshotWithQuiesce 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 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 servers available to complete the specified operation.
LICENCE_RESTRICTION - This operation is not allowed because your license lacks a needed feature. Please contact your support representative.

func (VMClass) StartOn 

func (_class VMClass) StartOn(sessionID SessionRef, vm VMRef, host HostRef, startPaused bool, force bool) (_err error)

StartOn 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 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)

Unpause 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)

UpdateAllowedOperations Recomputes the list of acceptable operations

func (VMClass) WaitMemoryTargetLive 

func (_class VMClass) WaitMemoryTargetLive(sessionID SessionRef, self VMRef) (_err error)

WaitMemoryTargetLive Wait for a running VM to reach its current memory target

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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID Get a reference to the VM_guest_metrics instance with the specified UUID.

func (VMGuestMetricsClass) GetCanUseHotplugVbd 

func (_class VMGuestMetricsClass) GetCanUseHotplugVbd(sessionID SessionRef, self VMGuestMetricsRef) (_retval TristateType, _err error)

GetCanUseHotplugVbd Get the can_use_hotplug_vbd field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetCanUseHotplugVif 

func (_class VMGuestMetricsClass) GetCanUseHotplugVif(sessionID SessionRef, self VMGuestMetricsRef) (_retval TristateType, _err error)

GetCanUseHotplugVif Get the can_use_hotplug_vif field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetDisks 

func (_class VMGuestMetricsClass) GetDisks(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

GetDisks 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)

GetLastUpdated 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)

GetLive 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)

GetMemory Get the memory field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetNetworks 

func (_class VMGuestMetricsClass) GetNetworks(sessionID SessionRef, self VMGuestMetricsRef) (_retval map[string]string, _err error)

GetNetworks 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)

GetOSVersion 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)

GetOther 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)

GetOtherConfig Get the other_config field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetPVDriversDetected 

func (_class VMGuestMetricsClass) GetPVDriversDetected(sessionID SessionRef, self VMGuestMetricsRef) (_retval bool, _err error)

GetPVDriversDetected Get the PV_drivers_detected field of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetPVDriversUpToDate 

func (_class VMGuestMetricsClass) GetPVDriversUpToDate(sessionID SessionRef, self VMGuestMetricsRef) (_retval bool, _err error)

GetPVDriversUpToDate 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)

GetPVDriversVersion 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)

GetRecord Get a record containing the current state of the given VM_guest_metrics.

func (VMGuestMetricsClass) GetUUID 

func (_class VMGuestMetricsClass) GetUUID(sessionID SessionRef, self VMGuestMetricsRef) (_retval string, _err error)

GetUUID 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)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// Logically equivalent to PV_drivers_detected
	PVDriversUpToDate 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
	// The guest's statement of whether it supports VBD hotplug, i.e. whether it is capable of responding immediately to instantiation of a new VBD by bringing online a new PV block device. If the guest states that it is not capable, then the VBD plug and unplug operations will not be allowed while the guest is running.
	CanUseHotplugVbd TristateType
	// The guest's statement of whether it supports VIF hotplug, i.e. whether it is capable of responding immediately to instantiation of a new VIF by bringing online a new PV network device. If the guest states that it is not capable, then the VIF plug and unplug operations will not be allowed while the guest is running.
	CanUseHotplugVif TristateType
	// At least one of the guest's devices has successfully connected to the backend.
	PVDriversDetected 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)

AddToOtherConfig 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)

GetAll 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)

GetAllRecords 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)

GetByUUID Get a reference to the VM_metrics instance with the specified UUID.

func (VMMetricsClass) GetCurrentDomainType 

func (_class VMMetricsClass) GetCurrentDomainType(sessionID SessionRef, self VMMetricsRef) (_retval DomainType, _err error)

GetCurrentDomainType Get the current_domain_type field of the given VM_metrics.

func (VMMetricsClass) GetHvm 

func (_class VMMetricsClass) GetHvm(sessionID SessionRef, self VMMetricsRef) (_retval bool, _err error)

GetHvm Get the hvm field of the given VM_metrics.

func (VMMetricsClass) GetInstallTime 

func (_class VMMetricsClass) GetInstallTime(sessionID SessionRef, self VMMetricsRef) (_retval time.Time, _err error)

GetInstallTime 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)

GetLastUpdated 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)

GetMemoryActual Get the memory/actual field of the given VM_metrics.

func (VMMetricsClass) GetNestedVirt 

func (_class VMMetricsClass) GetNestedVirt(sessionID SessionRef, self VMMetricsRef) (_retval bool, _err error)

GetNestedVirt Get the nested_virt field of the given VM_metrics.

func (VMMetricsClass) GetNomigrate 

func (_class VMMetricsClass) GetNomigrate(sessionID SessionRef, self VMMetricsRef) (_retval bool, _err error)

GetNomigrate Get the nomigrate field of the given VM_metrics.

func (VMMetricsClass) GetOtherConfig 

func (_class VMMetricsClass) GetOtherConfig(sessionID SessionRef, self VMMetricsRef) (_retval map[string]string, _err error)

GetOtherConfig 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)

GetRecord 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)

GetStartTime 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)

GetState Get the state field of the given VM_metrics.

func (VMMetricsClass) GetUUID 

func (_class VMMetricsClass) GetUUID(sessionID SessionRef, self VMMetricsRef) (_retval string, _err error)

GetUUID 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)

GetVCPUsCPU 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)

GetVCPUsFlags 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)

GetVCPUsNumber 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)

GetVCPUsParams 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)

GetVCPUsUtilisation 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)

RemoveFromOtherConfig 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)

SetOtherConfig 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
	// hardware virtual machine
	Hvm bool
	// VM supports nested virtualisation
	NestedVirt bool
	// VM is immobile and can't migrate between hosts
	Nomigrate bool
	// The current domain type of the VM (for running,suspended, or paused VMs). The last-known domain type for halted VMs.
	CurrentDomainType DomainType
}

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"
	// Changing NVRAM for a halted VM.
	VMOperationsChangingNVRAM VMOperations = "changing_NVRAM"
	//
	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"
	// Creating and adding a VTPM to this VM
	VMOperationsCreateVtpm VMOperations = "create_vtpm"
)

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)

AddToAlarmConfig

func (VMPPClass) AddToArchiveSchedule 

func (_class VMPPClass) AddToArchiveSchedule(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

AddToArchiveSchedule

func (VMPPClass) AddToArchiveTargetConfig 

func (_class VMPPClass) AddToArchiveTargetConfig(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

AddToArchiveTargetConfig

func (VMPPClass) AddToBackupSchedule 

func (_class VMPPClass) AddToBackupSchedule(sessionID SessionRef, self VMPPRef, key string, value string) (_err error)

AddToBackupSchedule

func (VMPPClass) ArchiveNow 

func (_class VMPPClass) ArchiveNow(sessionID SessionRef, snapshot VMRef) (_retval string, _err error)

ArchiveNow 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 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 Destroy the specified VMPP instance.

func (VMPPClass) GetAlarmConfig 

func (_class VMPPClass) GetAlarmConfig(sessionID SessionRef, self VMPPRef) (_retval map[string]string, _err error)

GetAlarmConfig 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)

GetAlerts 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)

GetAll 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)

GetAllRecords 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)

GetArchiveFrequency 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)

GetArchiveLastRunTime 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)

GetArchiveSchedule 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)

GetArchiveTargetConfig 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)

GetArchiveTargetType 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)

GetBackupFrequency 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)

GetBackupLastRunTime 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)

GetBackupRetentionValue 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)

GetBackupSchedule Get the backup_schedule field of the given VMPP.

func (VMPPClass) GetBackupType 

func (_class VMPPClass) GetBackupType(sessionID SessionRef, self VMPPRef) (_retval VmppBackupType, _err error)

GetBackupType Get the backup_type field of the given VMPP.

func (VMPPClass) GetByNameLabel 

func (_class VMPPClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VMPPRef, _err error)

GetByNameLabel Get all the VMPP instances with the given label.

func (VMPPClass) GetByUUID 

func (_class VMPPClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMPPRef, _err error)

GetByUUID 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)

GetIsAlarmEnabled 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)

GetIsArchiveRunning 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)

GetIsBackupRunning 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)

GetIsPolicyEnabled 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)

GetNameDescription Get the name/description field of the given VMPP.

func (VMPPClass) GetNameLabel 

func (_class VMPPClass) GetNameLabel(sessionID SessionRef, self VMPPRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given VMPP.

func (VMPPClass) GetRecentAlerts 

func (_class VMPPClass) GetRecentAlerts(sessionID SessionRef, self VMPPRef) (_retval []string, _err error)

GetRecentAlerts Get the recent_alerts field of the given VMPP.

func (VMPPClass) GetRecord 

func (_class VMPPClass) GetRecord(sessionID SessionRef, self VMPPRef) (_retval VMPPRecord, _err error)

GetRecord 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)

GetUUID Get the uuid field of the given VMPP.

func (VMPPClass) GetVMs 

func (_class VMPPClass) GetVMs(sessionID SessionRef, self VMPPRef) (_retval []VMRef, _err error)

GetVMs Get the VMs field of the given VMPP.

func (VMPPClass) ProtectNow 

func (_class VMPPClass) ProtectNow(sessionID SessionRef, vmpp VMPPRef) (_retval string, _err error)

ProtectNow This call executes the protection policy immediately

func (VMPPClass) RemoveFromAlarmConfig 

func (_class VMPPClass) RemoveFromAlarmConfig(sessionID SessionRef, self VMPPRef, key string) (_err error)

RemoveFromAlarmConfig

func (VMPPClass) RemoveFromArchiveSchedule 

func (_class VMPPClass) RemoveFromArchiveSchedule(sessionID SessionRef, self VMPPRef, key string) (_err error)

RemoveFromArchiveSchedule

func (VMPPClass) RemoveFromArchiveTargetConfig 

func (_class VMPPClass) RemoveFromArchiveTargetConfig(sessionID SessionRef, self VMPPRef, key string) (_err error)

RemoveFromArchiveTargetConfig

func (VMPPClass) RemoveFromBackupSchedule 

func (_class VMPPClass) RemoveFromBackupSchedule(sessionID SessionRef, self VMPPRef, key string) (_err error)

RemoveFromBackupSchedule

func (VMPPClass) SetAlarmConfig 

func (_class VMPPClass) SetAlarmConfig(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

SetAlarmConfig

func (VMPPClass) SetArchiveFrequency 

func (_class VMPPClass) SetArchiveFrequency(sessionID SessionRef, self VMPPRef, value VmppArchiveFrequency) (_err error)

SetArchiveFrequency Set the value of the archive_frequency field

func (VMPPClass) SetArchiveLastRunTime 

func (_class VMPPClass) SetArchiveLastRunTime(sessionID SessionRef, self VMPPRef, value time.Time) (_err error)

SetArchiveLastRunTime

func (VMPPClass) SetArchiveSchedule 

func (_class VMPPClass) SetArchiveSchedule(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

SetArchiveSchedule

func (VMPPClass) SetArchiveTargetConfig 

func (_class VMPPClass) SetArchiveTargetConfig(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

SetArchiveTargetConfig

func (VMPPClass) SetArchiveTargetType 

func (_class VMPPClass) SetArchiveTargetType(sessionID SessionRef, self VMPPRef, value VmppArchiveTargetType) (_err error)

SetArchiveTargetType 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)

SetBackupFrequency Set the value of the backup_frequency field

func (VMPPClass) SetBackupLastRunTime 

func (_class VMPPClass) SetBackupLastRunTime(sessionID SessionRef, self VMPPRef, value time.Time) (_err error)

SetBackupLastRunTime

func (VMPPClass) SetBackupRetentionValue 

func (_class VMPPClass) SetBackupRetentionValue(sessionID SessionRef, self VMPPRef, value int) (_err error)

SetBackupRetentionValue

func (VMPPClass) SetBackupSchedule 

func (_class VMPPClass) SetBackupSchedule(sessionID SessionRef, self VMPPRef, value map[string]string) (_err error)

SetBackupSchedule

func (VMPPClass) SetBackupType 

func (_class VMPPClass) SetBackupType(sessionID SessionRef, self VMPPRef, value VmppBackupType) (_err error)

SetBackupType Set the backup_type field of the given VMPP.

func (VMPPClass) SetIsAlarmEnabled 

func (_class VMPPClass) SetIsAlarmEnabled(sessionID SessionRef, self VMPPRef, value bool) (_err error)

SetIsAlarmEnabled Set the value of the is_alarm_enabled field

func (VMPPClass) SetIsPolicyEnabled 

func (_class VMPPClass) SetIsPolicyEnabled(sessionID SessionRef, self VMPPRef, value bool) (_err error)

SetIsPolicyEnabled 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)

SetNameDescription Set the name/description field of the given VMPP.

func (VMPPClass) SetNameLabel 

func (_class VMPPClass) SetNameLabel(sessionID SessionRef, self VMPPRef, value string) (_err error)

SetNameLabel 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 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 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
	// a human-readable name
	NameLabel string
	// a notes field containing human-readable description
	NameDescription string
	// Current power state of the machine
	PowerState VMPowerState
	// Creators of VMs and templates may store version information here.
	UserVersion int
	// true if this is a template. Template VMs can never be started, they are used only for cloning other VMs
	IsATemplate bool
	// true if this is a default template. Default template VMs can never be started or migrated, they are used only for cloning other VMs
	IsDefaultTemplate 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
	// the host on which the VM is due to be started/resumed/migrated. This acts as a memory reservation indicator
	ScheduledToBeResidentOn 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. Resource constraints may cause the VM to be started elsewhere.
	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 soft reboot
	ActionsAfterSoftreboot OnSoftrebootBehavior
	// 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
	// vitual usb devices
	VUSBs []VUSBRef
	// 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
	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
	// Ref pointing to a snapshot schedule for this VM
	SnapshotSchedule VMSSRef
	// true if this snapshot was created by the snapshot schedule
	IsVmssSnapshot 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
	// When an HVM guest starts, this controls the presence of the emulated C000 PCI device which triggers Windows Update to fetch or update PV drivers.
	HasVendorDevice bool
	// Indicates whether a VM requires a reboot in order to update its configuration, e.g. its memory allocation.
	RequiresReboot bool
	// Textual reference to the template used to create a VM. This can be used by clients in need of an immutable reference to the template since the latter's uuid and name_label may change, for example, after a package installation or upgrade.
	ReferenceLabel string
	// The type of domain that will be created when the VM is started
	DomainType DomainType
	// initial value for guest NVRAM (containing UEFI variables, etc). Cannot be changed while the VM is running
	NVRAM map[string]string
	// The set of pending guidances after applying updates
	PendingGuidances []UpdateGuidances
}

type VMRef 

type VMRef string

type VMSSClass 

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

VM Snapshot Schedule

func (VMSSClass) AddToSchedule 

func (_class VMSSClass) AddToSchedule(sessionID SessionRef, self VMSSRef, key string, value string) (_err error)

AddToSchedule

func (VMSSClass) Create 

func (_class VMSSClass) Create(sessionID SessionRef, args VMSSRecord) (_retval VMSSRef, _err error)

Create Create a new VMSS instance, and return its handle. The constructor args are: name_label, name_description, enabled, type*, retained_snapshots, frequency*, schedule (* = non-optional).

func (VMSSClass) Destroy 

func (_class VMSSClass) Destroy(sessionID SessionRef, self VMSSRef) (_err error)

Destroy Destroy the specified VMSS instance.

func (VMSSClass) GetAll 

func (_class VMSSClass) GetAll(sessionID SessionRef) (_retval []VMSSRef, _err error)

GetAll Return a list of all the VMSSs known to the system.

func (VMSSClass) GetAllRecords 

func (_class VMSSClass) GetAllRecords(sessionID SessionRef) (_retval map[VMSSRef]VMSSRecord, _err error)

GetAllRecords Return a map of VMSS references to VMSS records for all VMSSs known to the system.

func (VMSSClass) GetByNameLabel 

func (_class VMSSClass) GetByNameLabel(sessionID SessionRef, label string) (_retval []VMSSRef, _err error)

GetByNameLabel Get all the VMSS instances with the given label.

func (VMSSClass) GetByUUID 

func (_class VMSSClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VMSSRef, _err error)

GetByUUID Get a reference to the VMSS instance with the specified UUID.

func (VMSSClass) GetEnabled 

func (_class VMSSClass) GetEnabled(sessionID SessionRef, self VMSSRef) (_retval bool, _err error)

GetEnabled Get the enabled field of the given VMSS.

func (VMSSClass) GetFrequency 

func (_class VMSSClass) GetFrequency(sessionID SessionRef, self VMSSRef) (_retval VmssFrequency, _err error)

GetFrequency Get the frequency field of the given VMSS.

func (VMSSClass) GetLastRunTime 

func (_class VMSSClass) GetLastRunTime(sessionID SessionRef, self VMSSRef) (_retval time.Time, _err error)

GetLastRunTime Get the last_run_time field of the given VMSS.

func (VMSSClass) GetNameDescription 

func (_class VMSSClass) GetNameDescription(sessionID SessionRef, self VMSSRef) (_retval string, _err error)

GetNameDescription Get the name/description field of the given VMSS.

func (VMSSClass) GetNameLabel 

func (_class VMSSClass) GetNameLabel(sessionID SessionRef, self VMSSRef) (_retval string, _err error)

GetNameLabel Get the name/label field of the given VMSS.

func (VMSSClass) GetRecord 

func (_class VMSSClass) GetRecord(sessionID SessionRef, self VMSSRef) (_retval VMSSRecord, _err error)

GetRecord Get a record containing the current state of the given VMSS.

func (VMSSClass) GetRetainedSnapshots 

func (_class VMSSClass) GetRetainedSnapshots(sessionID SessionRef, self VMSSRef) (_retval int, _err error)

GetRetainedSnapshots Get the retained_snapshots field of the given VMSS.

func (VMSSClass) GetSchedule 

func (_class VMSSClass) GetSchedule(sessionID SessionRef, self VMSSRef) (_retval map[string]string, _err error)

GetSchedule Get the schedule field of the given VMSS.

func (VMSSClass) GetType 

func (_class VMSSClass) GetType(sessionID SessionRef, self VMSSRef) (_retval VmssType, _err error)

GetType Get the type field of the given VMSS.

func (VMSSClass) GetUUID 

func (_class VMSSClass) GetUUID(sessionID SessionRef, self VMSSRef) (_retval string, _err error)

GetUUID Get the uuid field of the given VMSS.

func (VMSSClass) GetVMs 

func (_class VMSSClass) GetVMs(sessionID SessionRef, self VMSSRef) (_retval []VMRef, _err error)

GetVMs Get the VMs field of the given VMSS.

func (VMSSClass) RemoveFromSchedule 

func (_class VMSSClass) RemoveFromSchedule(sessionID SessionRef, self VMSSRef, key string) (_err error)

RemoveFromSchedule

func (VMSSClass) SetEnabled 

func (_class VMSSClass) SetEnabled(sessionID SessionRef, self VMSSRef, value bool) (_err error)

SetEnabled Set the enabled field of the given VMSS.

func (VMSSClass) SetFrequency 

func (_class VMSSClass) SetFrequency(sessionID SessionRef, self VMSSRef, value VmssFrequency) (_err error)

SetFrequency Set the value of the frequency field

func (VMSSClass) SetLastRunTime 

func (_class VMSSClass) SetLastRunTime(sessionID SessionRef, self VMSSRef, value time.Time) (_err error)

SetLastRunTime

func (VMSSClass) SetNameDescription 

func (_class VMSSClass) SetNameDescription(sessionID SessionRef, self VMSSRef, value string) (_err error)

SetNameDescription Set the name/description field of the given VMSS.

func (VMSSClass) SetNameLabel 

func (_class VMSSClass) SetNameLabel(sessionID SessionRef, self VMSSRef, value string) (_err error)

SetNameLabel Set the name/label field of the given VMSS.

func (VMSSClass) SetRetainedSnapshots 

func (_class VMSSClass) SetRetainedSnapshots(sessionID SessionRef, self VMSSRef, value int) (_err error)

SetRetainedSnapshots

func (VMSSClass) SetSchedule 

func (_class VMSSClass) SetSchedule(sessionID SessionRef, self VMSSRef, value map[string]string) (_err error)

SetSchedule

func (VMSSClass) SetType 

func (_class VMSSClass) SetType(sessionID SessionRef, self VMSSRef, value VmssType) (_err error)

SetType

func (VMSSClass) SnapshotNow 

func (_class VMSSClass) SnapshotNow(sessionID SessionRef, vmss VMSSRef) (_retval string, _err error)

SnapshotNow This call executes the snapshot schedule immediately

type VMSSRecord 

type VMSSRecord 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 snapshot schedule
	Enabled bool
	// type of the snapshot schedule
	Type VmssType
	// maximum number of snapshots that should be stored at any time
	RetainedSnapshots int
	// frequency of taking snapshot from snapshot schedule
	Frequency VmssFrequency
	// schedule of the snapshot containing 'hour', 'min', 'days'. Date/time-related information is in Local Timezone
	Schedule map[string]string
	// time of the last snapshot
	LastRunTime time.Time
	// all VMs attached to this snapshot schedule
	VMs []VMRef
}

type VMSSRef 

type VMSSRef string

type VTPMClass 

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

A virtual TPM device

func (VTPMClass) Create 

func (_class VTPMClass) Create(sessionID SessionRef, vm VMRef, isUnique bool) (_retval VTPMRef, _err error)

Create Create a new VTPM instance, and return its handle.

func (VTPMClass) Destroy 

func (_class VTPMClass) Destroy(sessionID SessionRef, self VTPMRef) (_err error)

Destroy Destroy the specified VTPM instance, along with its state.

func (VTPMClass) GetAll 

func (_class VTPMClass) GetAll(sessionID SessionRef) (_retval []VTPMRef, _err error)

GetAll Return a list of all the VTPMs known to the system.

func (VTPMClass) GetAllRecords 

func (_class VTPMClass) GetAllRecords(sessionID SessionRef) (_retval map[VTPMRef]VTPMRecord, _err error)

GetAllRecords Return a map of VTPM references to VTPM records for all VTPMs known to the system.

func (VTPMClass) GetAllowedOperations 

func (_class VTPMClass) GetAllowedOperations(sessionID SessionRef, self VTPMRef) (_retval []VtpmOperations, _err error)

GetAllowedOperations Get the allowed_operations field of the given VTPM.

func (VTPMClass) GetBackend 

func (_class VTPMClass) GetBackend(sessionID SessionRef, self VTPMRef) (_retval VMRef, _err error)

GetBackend Get the backend field of the given VTPM.

func (VTPMClass) GetByUUID 

func (_class VTPMClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VTPMRef, _err error)

GetByUUID Get a reference to the VTPM instance with the specified UUID.

func (VTPMClass) GetCurrentOperations 

func (_class VTPMClass) GetCurrentOperations(sessionID SessionRef, self VTPMRef) (_retval map[string]VtpmOperations, _err error)

GetCurrentOperations Get the current_operations field of the given VTPM.

func (VTPMClass) GetIsProtected 

func (_class VTPMClass) GetIsProtected(sessionID SessionRef, self VTPMRef) (_retval bool, _err error)

GetIsProtected Get the is_protected field of the given VTPM.

func (VTPMClass) GetIsUnique 

func (_class VTPMClass) GetIsUnique(sessionID SessionRef, self VTPMRef) (_retval bool, _err error)

GetIsUnique Get the is_unique field of the given VTPM.

func (VTPMClass) GetPersistenceBackend 

func (_class VTPMClass) GetPersistenceBackend(sessionID SessionRef, self VTPMRef) (_retval PersistenceBackend, _err error)

GetPersistenceBackend Get the persistence_backend field of the given VTPM.

func (VTPMClass) GetRecord 

func (_class VTPMClass) GetRecord(sessionID SessionRef, self VTPMRef) (_retval VTPMRecord, _err error)

GetRecord 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)

GetUUID Get the uuid field of the given VTPM.

func (VTPMClass) GetVM 

func (_class VTPMClass) GetVM(sessionID SessionRef, self VTPMRef) (_retval VMRef, _err error)

GetVM Get the VM field of the given VTPM.

type VTPMRecord 

type VTPMRecord 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 []VtpmOperations
	// 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]VtpmOperations
	// The virtual machine the TPM is attached to
	VM VMRef
	// The domain where the backend is located (unused)
	Backend VMRef
	// The backend where the vTPM is persisted
	PersistenceBackend PersistenceBackend
	// Whether the contents are never copied, satisfying the TPM spec
	IsUnique bool
	// Whether the contents of the VTPM are secured according to the TPM spec
	IsProtected bool
}

type VTPMRef 

type VTPMRef string

type VUSBClass 

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

Describes the vusb device

func (VUSBClass) AddToOtherConfig 

func (_class VUSBClass) AddToOtherConfig(sessionID SessionRef, self VUSBRef, key string, value string) (_err error)

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

func (VUSBClass) Create 

func (_class VUSBClass) Create(sessionID SessionRef, vm VMRef, usbGroup USBGroupRef, otherConfig map[string]string) (_retval VUSBRef, _err error)

Create Create a new VUSB record in the database only

func (VUSBClass) Destroy 

func (_class VUSBClass) Destroy(sessionID SessionRef, self VUSBRef) (_err error)

Destroy Removes a VUSB record from the database

func (VUSBClass) GetAll 

func (_class VUSBClass) GetAll(sessionID SessionRef) (_retval []VUSBRef, _err error)

GetAll Return a list of all the VUSBs known to the system.

func (VUSBClass) GetAllRecords 

func (_class VUSBClass) GetAllRecords(sessionID SessionRef) (_retval map[VUSBRef]VUSBRecord, _err error)

GetAllRecords Return a map of VUSB references to VUSB records for all VUSBs known to the system.

func (VUSBClass) GetAllowedOperations 

func (_class VUSBClass) GetAllowedOperations(sessionID SessionRef, self VUSBRef) (_retval []VusbOperations, _err error)

GetAllowedOperations Get the allowed_operations field of the given VUSB.

func (VUSBClass) GetByUUID 

func (_class VUSBClass) GetByUUID(sessionID SessionRef, uuid string) (_retval VUSBRef, _err error)

GetByUUID Get a reference to the VUSB instance with the specified UUID.

func (VUSBClass) GetCurrentOperations 

func (_class VUSBClass) GetCurrentOperations(sessionID SessionRef, self VUSBRef) (_retval map[string]VusbOperations, _err error)

GetCurrentOperations Get the current_operations field of the given VUSB.

func (VUSBClass) GetCurrentlyAttached 

func (_class VUSBClass) GetCurrentlyAttached(sessionID SessionRef, self VUSBRef) (_retval bool, _err error)

GetCurrentlyAttached Get the currently_attached field of the given VUSB.

func (VUSBClass) GetOtherConfig 

func (_class VUSBClass) GetOtherConfig(sessionID SessionRef, self VUSBRef) (_retval map[string]string, _err error)

GetOtherConfig Get the other_config field of the given VUSB.

func (VUSBClass) GetRecord 

func (_class VUSBClass) GetRecord(sessionID SessionRef, self VUSBRef) (_retval VUSBRecord, _err error)

GetRecord Get a record containing the current state of the given VUSB.

func (VUSBClass) GetUSBGroup 

func (_class VUSBClass) GetUSBGroup(sessionID SessionRef, self VUSBRef) (_retval USBGroupRef, _err error)

GetUSBGroup Get the USB_group field of the given VUSB.

func (VUSBClass) GetUUID 

func (_class VUSBClass) GetUUID(sessionID SessionRef, self VUSBRef) (_retval string, _err error)

GetUUID Get the uuid field of the given VUSB.

func (VUSBClass) GetVM 

func (_class VUSBClass) GetVM(sessionID SessionRef, self VUSBRef) (_retval VMRef, _err error)

GetVM Get the VM field of the given VUSB.

func (VUSBClass) RemoveFromOtherConfig 

func (_class VUSBClass) RemoveFromOtherConfig(sessionID SessionRef, self VUSBRef, key string) (_err error)

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

func (VUSBClass) SetOtherConfig 

func (_class VUSBClass) SetOtherConfig(sessionID SessionRef, self VUSBRef, value map[string]string) (_err error)

SetOtherConfig Set the other_config field of the given VUSB.

func (VUSBClass) Unplug 

func (_class VUSBClass) Unplug(sessionID SessionRef, self VUSBRef) (_err error)

Unplug Unplug the vusb device from the vm.

type VUSBRecord 

type VUSBRecord 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 []VusbOperations
	// 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]VusbOperations
	// VM that owns the VUSB
	VM VMRef
	// USB group used by the VUSB
	USBGroup USBGroupRef
	// Additional configuration
	OtherConfig map[string]string
	// is the device currently attached
	CurrentlyAttached bool
}

type VUSBRef 

type VUSBRef 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 VdiNbdServerInfoClass 

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

Details for connecting to a VDI using the Network Block Device protocol

type VdiNbdServerInfoRecord 

type VdiNbdServerInfoRecord struct {
	// The exportname to request over NBD. This holds details including an authentication token, so it must be protected appropriately. Clients should regard the exportname as an opaque string or token.
	Exportname string
	// An address on which the server can be reached; this can be IPv4, IPv6, or a DNS name.
	Address string
	// The TCP port
	Port int
	// The TLS certificate of the server
	Cert string
	// For convenience, this redundant field holds a DNS (hostname) subject of the certificate. This can be a wildcard, but only for a certificate that has a wildcard subject and no concrete hostname subjects.
	Subject string
}

type VdiNbdServerInfoRef 

type VdiNbdServerInfoRef string

type VdiOperations 

type VdiOperations string
const (
	// 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"
	// Mirroring the VDI
	VdiOperationsMirror VdiOperations = "mirror"
	// 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"
	// Enabling changed block tracking for a VDI
	VdiOperationsEnableCbt VdiOperations = "enable_cbt"
	// Disabling changed block tracking for a VDI
	VdiOperationsDisableCbt VdiOperations = "disable_cbt"
	// Deleting the data of the VDI
	VdiOperationsDataDestroy VdiOperations = "data_destroy"
	// Exporting a bitmap that shows the changed blocks between two VDIs
	VdiOperationsListChangedBlocks VdiOperations = "list_changed_blocks"
	// Setting the on_boot field of the VDI
	VdiOperationsSetOnBoot VdiOperations = "set_on_boot"
	// 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"
	// a disk that stores PVS cache data
	VdiTypePvsCache VdiType = "pvs_cache"
	// Metadata about a snapshot VDI that has been deleted: the set of blocks that changed between some previous version of the disk and the version tracked by the snapshot.
	VdiTypeCbtMetadata VdiType = "cbt_metadata"
)

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 NVIDIA hardware with SR-IOV
	VgpuTypeImplementationNvidiaSriov VgpuTypeImplementation = "nvidia_sriov"
	// vGPU using Intel GVT-g
	VgpuTypeImplementationGvtG VgpuTypeImplementation = "gvt_g"
	// vGPU using AMD MxGPU
	VgpuTypeImplementationMxgpu VgpuTypeImplementation = "mxgpu"
)

type VifIpv4ConfigurationMode 

type VifIpv4ConfigurationMode string
const (
	// Follow the default IPv4 configuration of the guest (this is guest-dependent)
	VifIpv4ConfigurationModeNone VifIpv4ConfigurationMode = "None"
	// Static IPv4 address configuration
	VifIpv4ConfigurationModeStatic VifIpv4ConfigurationMode = "Static"
)

type VifIpv6ConfigurationMode 

type VifIpv6ConfigurationMode string
const (
	// Follow the default IPv6 configuration of the guest (this is guest-dependent)
	VifIpv6ConfigurationModeNone VifIpv6ConfigurationMode = "None"
	// Static IPv6 address configuration
	VifIpv6ConfigurationModeStatic VifIpv6ConfigurationMode = "Static"
)

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"
)

type VmssFrequency 

type VmssFrequency string
const (
	// Hourly snapshots
	VmssFrequencyHourly VmssFrequency = "hourly"
	// Daily snapshots
	VmssFrequencyDaily VmssFrequency = "daily"
	// Weekly snapshots
	VmssFrequencyWeekly VmssFrequency = "weekly"
)

type VmssType 

type VmssType string
const (
	// The snapshot is a disk snapshot
	VmssTypeSnapshot VmssType = "snapshot"
	// The snapshot is a checkpoint
	VmssTypeCheckpoint VmssType = "checkpoint"
	// Support for VSS has been removed.
	VmssTypeSnapshotWithQuiesce VmssType = "snapshot_with_quiesce"
)

type VtpmOperations 

type VtpmOperations string
const (
	// Destroy a VTPM
	VtpmOperationsDestroy VtpmOperations = "destroy"
)

type VusbOperations 

type VusbOperations string
const (
	// Attempting to attach this VUSB to a VM
	VusbOperationsAttach VusbOperations = "attach"
	// Attempting to plug this VUSB into a VM
	VusbOperationsPlug VusbOperations = "plug"
	// Attempting to hot unplug this VUSB
	VusbOperationsUnplug VusbOperations = "unplug"
)

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.