public class VMPP extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
VMPP.Record
Represents all the fields in a VMPP
|
Modifier and Type | Field and Description |
---|---|
protected String |
ref
The XenAPI reference to this object.
|
Modifier and Type | Method and Description |
---|---|
void |
addToAlarmConfig(Connection c,
String key,
String value) |
void |
addToArchiveSchedule(Connection c,
String key,
String value) |
void |
addToArchiveTargetConfig(Connection c,
String key,
String value) |
void |
addToBackupSchedule(Connection c,
String key,
String value) |
static String |
archiveNow(Connection c,
VM snapshot)
This call archives the snapshot provided as a parameter
|
static VMPP |
create(Connection c,
VMPP.Record record)
Create a new VMPP instance, and return its handle.
|
static Task |
createAsync(Connection c,
VMPP.Record record)
Create a new VMPP instance, and return its handle.
|
void |
destroy(Connection c)
Destroy the specified VMPP instance.
|
Task |
destroyAsync(Connection c)
Destroy the specified VMPP instance.
|
boolean |
equals(Object obj)
If obj is a VMPP, compares XenAPI references for equality.
|
Map<String,String> |
getAlarmConfig(Connection c)
Get the alarm_config field of the given VMPP.
|
Set<String> |
getAlerts(Connection c,
Long hoursFromNow)
This call fetches a history of alerts for a given protection policy
|
static Set<VMPP> |
getAll(Connection c)
Return a list of all the VMPPs known to the system.
|
static Map<VMPP,VMPP.Record> |
getAllRecords(Connection c)
Return a map of VMPP references to VMPP records for all VMPPs known to the system.
|
Types.VmppArchiveFrequency |
getArchiveFrequency(Connection c)
Get the archive_frequency field of the given VMPP.
|
Date |
getArchiveLastRunTime(Connection c)
Get the archive_last_run_time field of the given VMPP.
|
Map<String,String> |
getArchiveSchedule(Connection c)
Get the archive_schedule field of the given VMPP.
|
Map<String,String> |
getArchiveTargetConfig(Connection c)
Get the archive_target_config field of the given VMPP.
|
Types.VmppArchiveTargetType |
getArchiveTargetType(Connection c)
Get the archive_target_type field of the given VMPP.
|
Types.VmppBackupFrequency |
getBackupFrequency(Connection c)
Get the backup_frequency field of the given VMPP.
|
Date |
getBackupLastRunTime(Connection c)
Get the backup_last_run_time field of the given VMPP.
|
Long |
getBackupRetentionValue(Connection c)
Get the backup_retention_value field of the given VMPP.
|
Map<String,String> |
getBackupSchedule(Connection c)
Get the backup_schedule field of the given VMPP.
|
Types.VmppBackupType |
getBackupType(Connection c)
Get the backup_type field of the given VMPP.
|
static Set<VMPP> |
getByNameLabel(Connection c,
String label)
Get all the VMPP instances with the given label.
|
static VMPP |
getByUuid(Connection c,
String uuid)
Get a reference to the VMPP instance with the specified UUID.
|
Boolean |
getIsAlarmEnabled(Connection c)
Get the is_alarm_enabled field of the given VMPP.
|
Boolean |
getIsArchiveRunning(Connection c)
Get the is_archive_running field of the given VMPP.
|
Boolean |
getIsBackupRunning(Connection c)
Get the is_backup_running field of the given VMPP.
|
Boolean |
getIsPolicyEnabled(Connection c)
Get the is_policy_enabled field of the given VMPP.
|
String |
getNameDescription(Connection c)
Get the name/description field of the given VMPP.
|
String |
getNameLabel(Connection c)
Get the name/label field of the given VMPP.
|
Set<String> |
getRecentAlerts(Connection c)
Get the recent_alerts field of the given VMPP.
|
VMPP.Record |
getRecord(Connection c)
Get a record containing the current state of the given VMPP.
|
String |
getUuid(Connection c)
Get the uuid field of the given VMPP.
|
Set<VM> |
getVMs(Connection c)
Get the VMs field of the given VMPP.
|
int |
hashCode() |
String |
protectNow(Connection c)
This call executes the protection policy immediately
|
void |
removeFromAlarmConfig(Connection c,
String key) |
void |
removeFromArchiveSchedule(Connection c,
String key) |
void |
removeFromArchiveTargetConfig(Connection c,
String key) |
void |
removeFromBackupSchedule(Connection c,
String key) |
void |
setAlarmConfig(Connection c,
Map<String,String> value) |
void |
setArchiveFrequency(Connection c,
Types.VmppArchiveFrequency value)
Set the value of the archive_frequency field
|
void |
setArchiveLastRunTime(Connection c,
Date value) |
void |
setArchiveSchedule(Connection c,
Map<String,String> value) |
void |
setArchiveTargetConfig(Connection c,
Map<String,String> value) |
void |
setArchiveTargetType(Connection c,
Types.VmppArchiveTargetType value)
Set the value of the archive_target_config_type field
|
void |
setBackupFrequency(Connection c,
Types.VmppBackupFrequency value)
Set the value of the backup_frequency field
|
void |
setBackupLastRunTime(Connection c,
Date value) |
void |
setBackupRetentionValue(Connection c,
Long value) |
void |
setBackupSchedule(Connection c,
Map<String,String> value) |
void |
setBackupType(Connection c,
Types.VmppBackupType backupType)
Set the backup_type field of the given VMPP.
|
void |
setIsAlarmEnabled(Connection c,
Boolean value)
Set the value of the is_alarm_enabled field
|
void |
setIsPolicyEnabled(Connection c,
Boolean isPolicyEnabled)
Set the is_policy_enabled field of the given VMPP.
|
void |
setNameDescription(Connection c,
String description)
Set the name/description field of the given VMPP.
|
void |
setNameLabel(Connection c,
String label)
Set the name/label field of the given VMPP.
|
String |
toWireString() |
protected final String ref
public String toWireString()
toWireString
in class XenAPIObject
public boolean equals(Object obj)
public VMPP.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VMPP getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, VMPP.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VMPP create(Connection c, VMPP.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<VMPP> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- label of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Boolean getIsPolicyEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VmppBackupType getBackupType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Long getBackupRetentionValue(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VmppBackupFrequency getBackupFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getBackupSchedule(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Boolean getIsBackupRunning(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Date getBackupLastRunTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VmppArchiveTargetType getArchiveTargetType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getArchiveTargetConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VmppArchiveFrequency getArchiveFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getArchiveSchedule(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Boolean getIsArchiveRunning(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Date getArchiveLastRunTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Set<VM> getVMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Boolean getIsAlarmEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getAlarmConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Set<String> getRecentAlerts(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setNameDescription(Connection c, String description) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
description
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setIsPolicyEnabled(Connection c, Boolean isPolicyEnabled) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
isPolicyEnabled
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setBackupType(Connection c, Types.VmppBackupType backupType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
backupType
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String protectNow(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static String archiveNow(Connection c, VM snapshot) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
snapshot
- The snapshot to archiveTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Set<String> getAlerts(Connection c, Long hoursFromNow) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
hoursFromNow
- how many hours in the past the oldest record to fetch isTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setBackupRetentionValue(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setBackupFrequency(Connection c, Types.VmppBackupFrequency value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the backup frequencyTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setBackupSchedule(Connection c, Map<String,String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setArchiveFrequency(Connection c, Types.VmppArchiveFrequency value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the archive frequencyTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setArchiveSchedule(Connection c, Map<String,String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setArchiveTargetType(Connection c, Types.VmppArchiveTargetType value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the archive target config typeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setArchiveTargetConfig(Connection c, Map<String,String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setIsAlarmEnabled(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- true if alarm is enabled for this policyTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setAlarmConfig(Connection c, Map<String,String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToBackupSchedule(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to addvalue
- the value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToArchiveTargetConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to addvalue
- the value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToArchiveSchedule(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to addvalue
- the value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToAlarmConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to addvalue
- the value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromBackupSchedule(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromArchiveTargetConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromArchiveSchedule(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromAlarmConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- the key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setBackupLastRunTime(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setArchiveLastRunTime(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- the value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<VMPP> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Map<VMPP,VMPP.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException