Prototype
Class: VTPM
A virtual TPM device
Prototyped in: XAPI 22.26.0 (22.26.0)
Enums
vtpm_operations
Values: destroy
Destroy a VTPM
persistence_backend
Values: xapi
This VTPM is persisted in XAPI's DB
Fields
VM ref
VM
[RO/constructor]
The virtual machine the TPM is attached to
Published in: XenServer 4.0 (rio)
The virtual machine the TPM is attached to
enum vtpm_operations set
allowed_operations
[RO/runtime]
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.
Default value: {}
Published in: XenServer 4.0 (rio)
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.
VM ref
backend
[RO/runtime]
The domain where the backend is located (unused)
Default value: OpaqueRef:NULL
Published in: XenServer 4.0 (rio)
The domain where the backend is located (unused)
(string → enum vtpm_operations) map
current_operations
[RO/runtime]
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Default value: {}
Published in: XenServer 4.0 (rio)
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Prototype
bool
is_protected
[RO/runtime]
Whether the contents of the VTPM are secured according to the TPM spec
Default value: false
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
bool
is_unique
[RO/constructor]
Whether the contents are never copied, satisfying the TPM spec
Default value: false
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
enum persistence_backend
persistence_backend
[RO/runtime]
The backend where the vTPM is persisted
Default value: xapi
Prototyped in: XAPI 22.26.0 (22.26.0)
string
uuid
[RO/runtime]
Unique identifier/object reference
Published in: XenServer 4.0 (rio)
Unique identifier/object reference
Messages
Hide implicit
Prototype
VTPM ref
create
(session ref, VM ref, bool)
Create a new VTPM instance, and return its handle.
Parameters: session ref session_id
Reference to a valid session
VM ref vM
The VM reference the VTPM will be attached to
bool is_unique
Whether the VTPM must be unique
Minimum role: vm-admin
Result: The reference of the newly created VTPM
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
void
destroy
(session ref, VTPM ref)
Destroy the specified VTPM instance, along with its state.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
The reference to the VTPM object
Minimum role: vm-admin
Prototyped in: XAPI 22.26.0 (22.26.0)
VM ref
get_VM
(session ref, VTPM ref)
Get the VM field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
The virtual machine the TPM is attached to
Prototype
VTPM ref set
get_all
(session ref)
Return a list of all the VTPMs known to the system.
Parameters: session ref session_id
Reference to a valid session
Minimum role: read-only
Result: references to all objects
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
(VTPM ref → VTPM record) map
get_all_records
(session ref)
Return a map of VTPM references to VTPM records for all VTPMs known to the system.
Parameters: session ref session_id
Reference to a valid session
Minimum role: read-only
Result: records of all objects
Prototyped in: XAPI 22.26.0 (22.26.0)
enum vtpm_operations set
get_allowed_operations
(session ref, VTPM ref)
Get the allowed_operations field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
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.
VM ref
get_backend
(session ref, VTPM ref)
Get the backend field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
The domain where the backend is located (unused)
Prototype
VTPM ref
get_by_uuid
(session ref, string)
Get a reference to the VTPM instance with the specified UUID.
Parameters: session ref session_id
Reference to a valid session
string uuid
UUID of object to return
Minimum role: read-only
Result: reference to the object
Prototyped in: XAPI 22.26.0 (22.26.0)
(string → enum vtpm_operations) map
get_current_operations
(session ref, VTPM ref)
Get the current_operations field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
Prototype
bool
get_is_protected
(session ref, VTPM ref)
Get the is_protected field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
bool
get_is_unique
(session ref, VTPM ref)
Get the is_unique field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
enum persistence_backend
get_persistence_backend
(session ref, VTPM ref)
Get the persistence_backend field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Prototyped in: XAPI 22.26.0 (22.26.0)
Prototype
VTPM record
get_record
(session ref, VTPM ref)
Get a record containing the current state of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: all fields from the object
Prototyped in: XAPI 22.26.0 (22.26.0)
string
get_uuid
(session ref, VTPM ref)
Get the uuid field of the given VTPM.
Parameters: session ref session_id
Reference to a valid session
VTPM ref self
reference to the object
Minimum role: read-only
Result: value of the field
Published in: XenServer 4.0 (rio)
Unique identifier/object reference
