• API
  • Classes
    • VIF_metrics
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • last_updated
        • io_read_kbs
        • io_write_kbs
    • VBD_metrics
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • last_updated
        • io_read_kbs
        • io_write_kbs
    • PBD
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • host
        • uuid
        • currently_attached
        • device_config
        • SR
      • Explicit
        • unplug
        • plug
        • set_device_config
    • data_source
      • index
      • Fields
        • name_description
        • units
        • name_label
        • value
        • standard
        • enabled
        • max
        • min
    • PIF_metrics
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • vendor_name
        • uuid
        • last_updated
        • device_id
        • carrier
        • io_read_kbs
        • device_name
        • speed
        • vendor_id
        • duplex
        • io_write_kbs
        • pci_bus_path
    • VBD
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • qos_algorithm_type
        • VDI
        • other_config
        • uuid
        • runtime_properties
        • status_detail
        • metrics
        • userdevice
        • bootable
        • storage_lock
        • qos_algorithm_params
        • currently_attached
        • device
        • reserved
        • empty
        • VM
        • current_operations
        • allowed_operations
        • qos_supported_algorithms
        • mode
        • unpluggable
        • type
        • status_code
      • Explicit
        • unplug
        • unplug_force
        • eject
        • assert_attachable
        • plug
        • insert
    • user
      • index
      • Implicit
        • create
        • destroy
        • get_record
        • get_by_uuid
      • Fields
        • fullname
        • other_config
        • uuid
        • short_name
    • pool
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • name_description
        • other_config
        • ha_configuration
        • uuid
        • tags
        • ha_allow_overcommit
        • blobs
        • wlb_username
        • name_label
        • suspend_image_SR
        • ha_enabled
        • ha_host_failures_to_tolerate
        • restrictions
        • wlb_verify_cert
        • redo_log_enabled
        • master
        • gui_config
        • vswitch_controller
        • wlb_password
        • default_SR
        • redo_log_vdi
        • crash_dump_SR
        • wlb_url
        • ha_overcommitted
        • wlb_enabled
        • ha_statefiles
        • ha_plan_exists_for
      • Explicit
        • ha_compute_hypothetical_max_host_failures_to_tolerate
        • crl_install
        • initialize_wlb
        • certificate_list
        • certificate_install
        • ha_compute_max_host_failures_to_tolerate
        • retrieve_wlb_recommendations
        • ha_prevent_restarts_for
        • set_vswitch_controller
        • emergency_transition_to_master
        • sync_database
        • disable_ha
        • designate_new_master
        • create_VLAN
        • enable_external_auth
        • disable_external_auth
        • join
        • enable_ha
        • eject
        • deconfigure_wlb
        • test_archive_target
        • disable_local_storage_caching
        • detect_nonhomogeneous_external_auth
        • enable_redo_log
        • certificate_sync
        • send_wlb_configuration
        • ha_compute_vm_failover_plan
        • join_force
        • send_test_post
        • create_new_blob
        • create_VLAN_from_PIF
        • certificate_uninstall
        • recover_slaves
        • crl_uninstall
        • crl_list
        • ha_failover_plan_exists
        • retrieve_wlb_configuration
        • set_ha_host_failures_to_tolerate
        • disable_redo_log
        • emergency_reset_master
        • enable_local_storage_caching
    • host_crashdump
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • host
        • uuid
        • timestamp
        • filename
        • size
      • Explicit
        • destroy
        • upload
    • host_cpu
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • stepping
        • host
        • uuid
        • modelname
        • speed
        • features
        • model
        • vendor
        • flags
        • family
        • number
        • utilisation
    • secret
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • value
    • PIF
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • host
        • uuid
        • tunnel_transport_PIF_of
        • ip_configuration_mode
        • bond_slave_of
        • DNS
        • metrics
        • network
        • currently_attached
        • physical
        • device
        • netmask
        • tunnel_access_PIF_of
        • device_name
        • VLAN
        • MTU
        • VLAN_slave_of
        • IP
        • bond_master_of
        • management
        • VLAN_master_of
        • disallow_unplug
        • gateway
        • MAC
      • Explicit
        • scan
        • forget
        • unplug
        • reconfigure_ip
        • create_VLAN
        • destroy
        • db_introduce
        • introduce
        • plug
        • db_forget
        • scan_bios
    • VM_metrics
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • start_time
        • other_config
        • uuid
        • last_updated
        • memory_actual
        • state
        • install_time
        • VCPUs_params
        • VCPUs_number
        • VCPUs_flags
        • VCPUs_utilisation
        • VCPUs_CPU
    • blob
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • uuid
        • last_updated
        • name_label
        • mime_type
        • size
      • Explicit
        • create
        • destroy
    • task
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • externalpid
        • name_description
        • other_config
        • uuid
        • created
        • finished
        • stunnelpid
        • result
        • name_label
        • forwarded_to
        • progress
        • resident_on
        • error_info
        • current_operations
        • allowed_operations
        • session
        • subtasks
        • status
        • forwarded
        • subtask_of
        • type
      • Explicit
        • create
        • cancel
        • destroy
    • VM_guest_metrics
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • PV_drivers_version
        • other_config
        • uuid
        • last_updated
        • disks
        • live
        • networks
        • PV_drivers_up_to_date
        • os_version
        • memory
        • other
    • VDI
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • uuid
        • missing
        • allow_caching
        • tags
        • xenstore_data
        • crash_dumps
        • name_label
        • storage_lock
        • snapshots
        • physical_utilisation
        • managed
        • current_operations
        • VBDs
        • allowed_operations
        • SR
        • snapshot_of
        • read_only
        • virtual_size
        • snapshot_time
        • parent
        • sharable
        • on_boot
        • location
        • sm_config
        • type
        • is_a_snapshot
      • Explicit
        • set_read_only
        • set_virtual_size
        • forget
        • clone
        • set_physical_utilisation
        • set_missing
        • db_introduce
        • update
        • snapshot
        • copy
        • set_on_boot
        • set_managed
        • resize_online
        • introduce
        • db_forget
        • resize
        • set_allow_caching
        • set_sharable
    • tunnel
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • access_PIF
        • transport_PIF
        • status
      • Explicit
        • create
        • destroy
    • console
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • VM
        • protocol
        • port
        • location
    • network
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • uuid
        • tags
        • blobs
        • VIFs
        • name_label
        • bridge
        • current_operations
        • MTU
        • allowed_operations
        • PIFs
      • Explicit
        • create_new_blob
    • SM
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • uuid
        • name_label
        • copyright
        • driver_filename
        • capabilities
        • version
        • configuration
        • required_api_version
        • vendor
        • type
    • VIF
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • qos_algorithm_type
        • other_config
        • uuid
        • runtime_properties
        • status_detail
        • metrics
        • network
        • qos_algorithm_params
        • currently_attached
        • device
        • reserved
        • VM
        • current_operations
        • MTU
        • allowed_operations
        • qos_supported_algorithms
        • MAC_autogenerated
        • MAC
        • status_code
      • Explicit
        • unplug
        • plug
    • subject
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • subject_identifier
        • roles
      • Explicit
        • get_permissions_name_label
        • remove_from_roles
        • add_to_roles
    • event
      • index
      • Fields
        • class
        • operation
        • id
        • obj_uuid
        • timestamp
        • ref
      • Explicit
        • get_current_id
        • unregister
        • next
        • register
    • message
      • index
      • Fields
        • priority
        • name
        • uuid
        • cls
        • obj_uuid
        • body
        • timestamp
      • Explicit
        • create
        • destroy
        • get
        • get_all_records
        • get_all_records_where
        • get_since
        • get_record
        • get_by_uuid
        • get_all
    • auth
      • index
      • Explicit
        • get_subject_information_from_identifier
        • get_group_membership
        • get_subject_identifier
    • host_metrics
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • last_updated
        • live
        • memory_total
        • memory_free
    • VMPP
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • is_policy_enabled
        • name_description
        • backup_frequency
        • backup_last_run_time
        • is_backup_running
        • uuid
        • backup_retention_value
        • archive_last_run_time
        • backup_schedule
        • name_label
        • backup_type
        • archive_target_config
        • is_alarm_enabled
        • archive_frequency
        • is_archive_running
        • archive_schedule
        • alarm_config
        • archive_target_type
        • recent_alerts
        • VMs
      • Explicit
        • set_archive_schedule
        • set_backup_frequency
        • remove_from_archive_target_config
        • remove_from_backup_schedule
        • get_alerts
        • set_archive_frequency
        • remove_from_archive_schedule
        • set_alarm_config
        • protect_now
        • add_to_archive_target_config
        • add_to_backup_schedule
        • set_backup_last_run_time
        • set_archive_last_run_time
        • archive_now
        • set_archive_target_type
        • remove_from_alarm_config
        • add_to_archive_schedule
        • add_to_alarm_config
        • set_archive_target_config
        • set_is_alarm_enabled
        • set_backup_retention_value
        • set_backup_schedule
    • SR
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • uuid
        • tags
        • default_vdi_visibility
        • blobs
        • physical_size
        • shared
        • name_label
        • VDIs
        • PBDs
        • virtual_allocation
        • physical_utilisation
        • content_type
        • current_operations
        • allowed_operations
        • local_cache_enabled
        • sm_config
        • type
      • Explicit
        • create
        • scan
        • probe
        • forget
        • set_physical_utilisation
        • make
        • set_shared
        • destroy
        • update
        • assert_can_host_ha_statefile
        • get_supported_types
        • create_new_blob
        • introduce
        • set_virtual_allocation
        • set_physical_size
    • VLAN
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • tag
        • tagged_PIF
        • untagged_PIF
      • Explicit
        • create
        • destroy
    • Bond
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • other_config
        • uuid
        • slaves
        • master
      • Explicit
        • create
        • destroy
    • crashdump
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_all
      • Fields
        • VDI
        • other_config
        • uuid
        • VM
      • Explicit
        • destroy
    • role
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • uuid
        • name_label
        • subroles
      • Explicit
        • get_permissions
        • get_permissions_name_label
        • get_by_permission_name_label
        • get_by_permission
    • VTPM
      • index
      • Implicit
        • create
        • destroy
        • get_record
        • get_by_uuid
      • Fields
        • uuid
        • backend
        • VM
    • session
      • index
      • Implicit
        • get_record
        • get_by_uuid
      • Fields
        • other_config
        • uuid
        • rbac_permissions
        • subject
        • is_local_superuser
        • auth_user_sid
        • this_user
        • this_host
        • pool
        • auth_user_name
        • parent
        • last_active
        • tasks
        • validation_time
      • Explicit
        • logout_subject_identifier
        • change_password
        • local_logout
        • logout
        • slave_local_login_with_password
        • login_with_password
        • get_all_subject_identifiers
    • host_patch
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • host
        • uuid
        • name_label
        • timestamp_applied
        • version
        • pool_patch
        • filename
        • size
        • applied
      • Explicit
        • destroy
        • apply
    • host
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • bios_strings
        • crash_dump_sr
        • external_auth_configuration
        • uuid
        • address
        • boot_free_mem
        • ha_network_peers
        • API_version_vendor_implementation
        • edition
        • tags
        • blobs
        • host_CPUs
        • power_on_mode
        • software_version
        • cpu_info
        • name_label
        • metrics
        • enabled
        • capabilities
        • suspend_image_sr
        • PBDs
        • API_version_minor
        • license_params
        • current_operations
        • API_version_vendor
        • API_version_major
        • allowed_operations
        • supported_bootloaders
        • cpu_configuration
        • power_on_config
        • external_auth_type
        • logging
        • license_server
        • resident_VMs
        • local_cache_sr
        • sched_policy
        • crashdumps
        • patches
        • hostname
        • PIFs
        • memory_overhead
        • ha_statefiles
        • external_auth_service_name
      • Explicit
        • get_uncooperative_resident_VMs
        • refresh_pack_info
        • management_disable
        • bugreport_upload
        • get_data_sources
        • disable
        • compute_free_memory
        • get_vms_which_prevent_evacuation
        • query_data_source
        • local_management_reconfigure
        • send_debug_keys
        • management_reconfigure
        • call_plugin
        • assert_can_evacuate
        • destroy
        • enable_external_auth
        • disable_external_auth
        • dmesg_clear
        • reset_cpu_features
        • get_servertime
        • get_server_localtime
        • emergency_ha_disable
        • shutdown
        • retrieve_wlb_evacuate_recommendations
        • list_methods
        • restart_agent
        • disable_local_storage_caching
        • get_server_certificate
        • set_cpu_features
        • reboot
        • create_new_blob
        • backup_rrds
        • evacuate
        • license_apply
        • compute_memory_overhead
        • enable
        • set_hostname_live
        • sync_data
        • get_log
        • apply_edition
        • record_data_source
        • syslog_reconfigure
        • dmesg
        • get_system_status_capabilities
        • shutdown_agent
        • forget_data_source_archives
        • set_power_on_mode
        • enable_local_storage_caching
        • power_on
    • pool_patch
      • index
      • Implicit
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Fields
        • name_description
        • other_config
        • after_apply_guidance
        • uuid
        • name_label
        • version
        • host_patches
        • pool_applied
        • filename
        • size
      • Explicit
        • clean
        • destroy
        • pool_apply
        • apply
        • precheck
    • VM
      • index
      • Implicit
        • create
        • destroy
        • get_all_records
        • get_record
        • get_by_uuid
        • get_by_name_label
        • get_all
      • Explicit
        • update_allowed_operations
        • hard_shutdown
        • get_cooperative
        • hard_reboot
        • get_data_sources
        • copy_bios_strings
        • set_VCPUs_max
        • pause
        • provision
        • retrieve_wlb_recommendations
        • set_VCPUs_number_live
        • maximise_memory
        • query_data_source
        • checkpoint
        • clone
        • power_state_reset
        • revert
        • assert_agile
        • set_memory_dynamic_max
        • get_allowed_VBD_devices
        • start_on
        • set_ha_always_run
        • set_protection_policy
        • set_ha_restart_priority
        • resume_on
        • send_trigger
        • wait_memory_target_live
        • set_HVM_shadow_multiplier
        • clean_shutdown
        • set_memory_target_live
        • get_allowed_VIF_devices
        • unpause
        • snapshot
        • copy
        • assert_operation_valid
        • snapshot_with_quiesce
        • set_shadow_multiplier_live
        • suspend
        • set_memory_static_max
        • clean_reboot
        • get_boot_record
        • pool_migrate
        • create_new_blob
        • set_VCPUs_at_startup
        • compute_memory_overhead
        • set_memory_static_min
        • set_memory_dynamic_min
        • start
        • set_memory_dynamic_range
        • get_possible_hosts
        • set_memory_static_range
        • send_sysrq
        • record_data_source
        • add_to_VCPUs_params_live
        • set_memory_limits
        • forget_data_source_archives
        • resume
        • assert_can_boot_here
      • Fields
        • domid
        • name_description
        • other_config
        • affinity
        • PV_args
        • ha_always_run
        • power_state
        • bios_strings
        • uuid
        • VTPMs
        • memory_static_min
        • tags
        • consoles
        • xenstore_data
        • blobs
        • VIFs
        • PCI_bus
        • crash_dumps
        • memory_dynamic_max
        • name_label
        • metrics
        • recommendations
        • snapshots
        • snapshot_metadata
        • snapshot_info
        • last_booted_record
        • is_a_template
        • HVM_boot_policy
        • PV_kernel
        • resident_on
        • VCPUs_at_startup
        • is_control_domain
        • actions_after_shutdown
        • PV_legacy_args
        • memory_dynamic_min
        • current_operations
        • is_snapshot_from_vmpp
        • PV_bootloader
        • VBDs
        • allowed_operations
        • PV_ramdisk
        • protection_policy
        • platform
        • snapshot_of
        • guest_metrics
        • VCPUs_max
        • ha_restart_priority
        • user_version
        • HVM_boot_params
        • memory_static_max
        • snapshot_time
        • blocked_operations
        • PV_bootloader_args
        • domarch
        • HVM_shadow_multiplier
        • parent
        • memory_target
        • transportable_snapshot_id
        • scheduled_to_be_resident_on
        • last_boot_CPU_flags
        • memory_overhead
        • suspend_VDI
        • actions_after_reboot
        • actions_after_crash
        • is_a_snapshot
        • children
        • VCPUs_params
  • conventions