Package com.xensource.xenapi

Class VTPM

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VTPM

public class VTPM
extends XenAPIObject

A virtual TPM device First published in .

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VTPM.Record	Represents all the fields in a VTPM

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Method Summary

Modifier and Type	Method	Description
static VTPM	create(Connection c, VM vM, Boolean isUnique)	Create a new VTPM instance, and return its handle.
static Task	createAsync(Connection c, VM vM, Boolean isUnique)	Create a new VTPM instance, and return its handle.
void	destroy(Connection c)	Destroy the specified VTPM instance, along with its state.
Task	destroyAsync(Connection c)	Destroy the specified VTPM instance, along with its state.
boolean	equals(Object obj)	If obj is a VTPM, compares XenAPI references for equality.
static Set<VTPM>	getAll(Connection c)	Return a list of all the VTPMs known to the system.
Set<Types.VtpmOperations>	getAllowedOperations(Connection c)	Get the allowed_operations field of the given VTPM.
static Map<VTPM,VTPM.Record>	getAllRecords(Connection c)	Return a map of VTPM references to VTPM records for all VTPMs known to the system.
VM	getBackend(Connection c)	Get the backend field of the given VTPM.
static VTPM	getByUuid(Connection c, String uuid)	Get a reference to the VTPM instance with the specified UUID.
Map<String,Types.VtpmOperations>	getCurrentOperations(Connection c)	Get the current_operations field of the given VTPM.
Boolean	getIsProtected(Connection c)	Get the is_protected field of the given VTPM.
Boolean	getIsUnique(Connection c)	Get the is_unique field of the given VTPM.
Types.PersistenceBackend	getPersistenceBackend(Connection c)	Get the persistence_backend field of the given VTPM.
VTPM.Record	getRecord(Connection c)	Get a record containing the current state of the given VTPM.
String	getUuid(Connection c)	Get the uuid field of the given VTPM.
VM	getVM(Connection c)	Get the VM field of the given VTPM.
int	hashCode()
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a VTPM, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public VTPM.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given VTPM. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static VTPM getByUuid(Connection c,
 String uuid)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the VTPM instance with the specified UUID. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given VTPM. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllowedOperations

public Set<Types.VtpmOperations> getAllowedOperations(Connection c)
                                               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the allowed_operations field of the given VTPM. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getCurrentOperations

public Map<String,Types.VtpmOperations> getCurrentOperations(Connection c)
                                                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the current_operations field of the given VTPM. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVM

public VM getVM(Connection c)
         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the VM field of the given VTPM. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getBackend

public VM getBackend(Connection c)
              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the backend field of the given VTPM. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getPersistenceBackend

public Types.PersistenceBackend getPersistenceBackend(Connection c)
                                               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the persistence_backend field of the given VTPM. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getIsUnique

public Boolean getIsUnique(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the is_unique field of the given VTPM. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getIsProtected

public Boolean getIsProtected(Connection c)
                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the is_protected field of the given VTPM. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

create

public static VTPM create(Connection c,
 VM vM,
 Boolean isUnique)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new VTPM instance, and return its handle. Minimum allowed role: vm-admin Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

vM - The VM reference the VTPM will be attached to

isUnique - Whether the VTPM must be unique

Returns:

The reference of the newly created VTPM

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

createAsync

public static Task createAsync(Connection c,
 VM vM,
 Boolean isUnique)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new VTPM instance, and return its handle. Minimum allowed role: vm-admin Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

vM - The VM reference the VTPM will be attached to

isUnique - Whether the VTPM must be unique

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy the specified VTPM instance, along with its state. Minimum allowed role: vm-admin Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy the specified VTPM instance, along with its state. Minimum allowed role: vm-admin Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<VTPM> getAll(Connection c)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the VTPMs known to the system. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<VTPM,VTPM.Record> getAllRecords(Connection c)
                                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of VTPM references to VTPM records for all VTPMs known to the system. Minimum allowed role: read-only Experimental. First published in 22.26.0.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.