Package com.xensource.xenapi
Class VMPP
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VMPP
VM Protection Policy
First published in XenServer 5.6 FP1.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToAlarmConfig
(Connection c, String key, String value) Deprecated.since XenServer 6.2void
addToArchiveSchedule
(Connection c, String key, String value) Deprecated.since XenServer 6.2void
addToArchiveTargetConfig
(Connection c, String key, String value) Deprecated.since XenServer 6.2void
addToBackupSchedule
(Connection c, String key, String value) Deprecated.since XenServer 6.2static String
archiveNow
(Connection c, VM snapshot) Deprecated.since XenServer 6.2static VMPP
create
(Connection c, VMPP.Record record) Deprecated.since XenServer 6.2static Task
createAsync
(Connection c, VMPP.Record record) Deprecated.since XenServer 6.2void
Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2boolean
If obj is a VMPP, compares XenAPI references for equality.Deprecated.since XenServer 6.2getAlerts
(Connection c, Long hoursFromNow) Deprecated.since XenServer 6.2getAll
(Connection c) Deprecated.since XenServer 6.2static Map<VMPP,
VMPP.Record> Return a map of VMPP references to VMPP records for all VMPPs known to the system.Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2getByNameLabel
(Connection c, String label) Deprecated.since XenServer 6.2static VMPP
getByUuid
(Connection c, String uuid) Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2Deprecated.since XenServer 6.2getVMs
(Connection c) Deprecated.since XenServer 6.2int
hashCode()
Deprecated.since XenServer 6.2void
removeFromAlarmConfig
(Connection c, String key) Deprecated.since XenServer 6.2void
Deprecated.since XenServer 6.2void
Deprecated.since XenServer 6.2void
removeFromBackupSchedule
(Connection c, String key) Deprecated.since XenServer 6.2void
setAlarmConfig
(Connection c, Map<String, String> value) Deprecated.since XenServer 6.2void
Deprecated.since XenServer 6.2void
setArchiveLastRunTime
(Connection c, Date value) Deprecated.since XenServer 6.2void
setArchiveSchedule
(Connection c, Map<String, String> value) Deprecated.since XenServer 6.2void
setArchiveTargetConfig
(Connection c, Map<String, String> value) Deprecated.since XenServer 6.2void
Deprecated.since XenServer 6.2void
Deprecated.since XenServer 6.2void
setBackupLastRunTime
(Connection c, Date value) Deprecated.since XenServer 6.2void
setBackupRetentionValue
(Connection c, Long value) Deprecated.since XenServer 6.2void
setBackupSchedule
(Connection c, Map<String, String> value) Deprecated.since XenServer 6.2void
setBackupType
(Connection c, Types.VmppBackupType backupType) Deprecated.since XenServer 6.2void
setIsAlarmEnabled
(Connection c, Boolean value) Deprecated.since XenServer 6.2void
setIsPolicyEnabled
(Connection c, Boolean isPolicyEnabled) Deprecated.since XenServer 6.2void
setNameDescription
(Connection c, String description) Deprecated.since XenServer 6.2void
setNameLabel
(Connection c, String label) Deprecated.since XenServer 6.2Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a VMPP, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
@Deprecated(since="XenServer 6.2") public VMPP.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get a record containing the current state of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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
@Deprecated(since="XenServer 6.2") public static VMPP getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get a reference to the VMPP instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onuuid
- 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.
-
create
@Deprecated(since="XenServer 6.2") public static VMPP create(Connection c, VMPP.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Create a new VMPP instance, and return its handle. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- reference to the newly created 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.
-
createAsync
@Deprecated(since="XenServer 6.2") public static Task createAsync(Connection c, VMPP.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Create a new VMPP instance, and return its handle. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- 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
@Deprecated(since="XenServer 6.2") public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Destroy the specified VMPP instance. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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
@Deprecated(since="XenServer 6.2") public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Destroy the specified VMPP instance. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- 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.
-
getByNameLabel
@Deprecated(since="XenServer 6.2") public static Set<VMPP> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get all the VMPP instances with the given label. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onlabel
- label of object to return- Returns:
- references to objects with matching names
- 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
@Deprecated(since="XenServer 6.2") public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the uuid field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getNameLabel
@Deprecated(since="XenServer 6.2") public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the name/label field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getNameDescription
@Deprecated(since="XenServer 6.2") public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the name/description field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getIsPolicyEnabled
@Deprecated(since="XenServer 6.2") public Boolean getIsPolicyEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the is_policy_enabled field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getBackupType
@Deprecated(since="XenServer 6.2") public Types.VmppBackupType getBackupType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the backup_type field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getBackupRetentionValue
@Deprecated(since="XenServer 6.2") public Long getBackupRetentionValue(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the backup_retention_value field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getBackupFrequency
@Deprecated(since="XenServer 6.2") public Types.VmppBackupFrequency getBackupFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the backup_frequency field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getBackupSchedule
@Deprecated(since="XenServer 6.2") public Map<String,String> getBackupSchedule(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the backup_schedule field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getIsBackupRunning
@Deprecated(since="XenServer 6.2") public Boolean getIsBackupRunning(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the is_backup_running field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getBackupLastRunTime
@Deprecated(since="XenServer 6.2") public Date getBackupLastRunTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the backup_last_run_time field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getArchiveTargetType
@Deprecated(since="XenServer 6.2") public Types.VmppArchiveTargetType getArchiveTargetType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the archive_target_type field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getArchiveTargetConfig
@Deprecated(since="XenServer 6.2") public Map<String,String> getArchiveTargetConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the archive_target_config field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getArchiveFrequency
@Deprecated(since="XenServer 6.2") public Types.VmppArchiveFrequency getArchiveFrequency(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the archive_frequency field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getArchiveSchedule
@Deprecated(since="XenServer 6.2") public Map<String,String> getArchiveSchedule(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the archive_schedule field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getIsArchiveRunning
@Deprecated(since="XenServer 6.2") public Boolean getIsArchiveRunning(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the is_archive_running field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getArchiveLastRunTime
@Deprecated(since="XenServer 6.2") public Date getArchiveLastRunTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the archive_last_run_time field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getVMs
@Deprecated(since="XenServer 6.2") public Set<VM> getVMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the VMs field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getIsAlarmEnabled
@Deprecated(since="XenServer 6.2") public Boolean getIsAlarmEnabled(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the is_alarm_enabled field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getAlarmConfig
@Deprecated(since="XenServer 6.2") public Map<String,String> getAlarmConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the alarm_config field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
getRecentAlerts
@Deprecated(since="XenServer 6.2") public Set<String> getRecentAlerts(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the recent_alerts field of the given VMPP. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-
setNameLabel
@Deprecated(since="XenServer 6.2") public void setNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the name/label field of the given VMPP. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onlabel
- New value to set- 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.
-
setNameDescription
@Deprecated(since="XenServer 6.2") public void setNameDescription(Connection c, String description) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the name/description field of the given VMPP. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made ondescription
- New value to set- 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.
-
setIsPolicyEnabled
@Deprecated(since="XenServer 6.2") public void setIsPolicyEnabled(Connection c, Boolean isPolicyEnabled) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the is_policy_enabled field of the given VMPP. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onisPolicyEnabled
- New value to set- 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.
-
setBackupType
@Deprecated(since="XenServer 6.2") public void setBackupType(Connection c, Types.VmppBackupType backupType) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the backup_type field of the given VMPP. Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onbackupType
- New value to set- 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.
-
protectNow
@Deprecated(since="XenServer 6.2") public String protectNow(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2This call executes the protection policy immediately Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- An XMLRPC result
- 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.
-
archiveNow
@Deprecated(since="XenServer 6.2") public static String archiveNow(Connection c, VM snapshot) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2This call archives the snapshot provided as a parameter Minimum allowed role: vm-power-admin First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onsnapshot
- The snapshot to archive- Returns:
- An XMLRPC result
- 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.
-
getAlerts
@Deprecated(since="XenServer 6.2") public Set<String> getAlerts(Connection c, Long hoursFromNow) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2This call fetches a history of alerts for a given protection policy Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onhoursFromNow
- how many hours in the past the oldest record to fetch is- Returns:
- A list of alerts encoded in xml
- 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.
-
setBackupRetentionValue
@Deprecated(since="XenServer 6.2") public void setBackupRetentionValue(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the value to set- 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.
-
setBackupFrequency
@Deprecated(since="XenServer 6.2") public void setBackupFrequency(Connection c, Types.VmppBackupFrequency value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the value of the backup_frequency field Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the backup frequency- 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.
-
setBackupSchedule
@Deprecated(since="XenServer 6.2") public void setBackupSchedule(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionDeprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the value to set- 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.
-
setArchiveFrequency
@Deprecated(since="XenServer 6.2") public void setArchiveFrequency(Connection c, Types.VmppArchiveFrequency value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the value of the archive_frequency field Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the archive frequency- 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.
-
setArchiveSchedule
@Deprecated(since="XenServer 6.2") public void setArchiveSchedule(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionDeprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the value to set- 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.
-
setArchiveTargetType
@Deprecated(since="XenServer 6.2") public void setArchiveTargetType(Connection c, Types.VmppArchiveTargetType value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the value of the archive_target_config_type field Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the archive target config type- 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.
-
setArchiveTargetConfig
@Deprecated(since="XenServer 6.2") public void setArchiveTargetConfig(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionDeprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the value to set- 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.
-
setIsAlarmEnabled
@Deprecated(since="XenServer 6.2") public void setIsAlarmEnabled(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the value of the is_alarm_enabled field Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- true if alarm is enabled for this policy- 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.
-
setAlarmConfig
@Deprecated(since="XenServer 6.2") public void setAlarmConfig(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionDeprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- the value to set- 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.
-
addToBackupSchedule
@Deprecated(since="XenServer 6.2") public void addToBackupSchedule(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to addvalue
- the value to add- 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.
-
addToArchiveTargetConfig
@Deprecated(since="XenServer 6.2") public void addToArchiveTargetConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to addvalue
- the value to add- 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.
-
addToArchiveSchedule
@Deprecated(since="XenServer 6.2") public void addToArchiveSchedule(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to addvalue
- the value to add- 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.
-
addToAlarmConfig
@Deprecated(since="XenServer 6.2") public void addToAlarmConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to addvalue
- the value to add- 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.
-
removeFromBackupSchedule
@Deprecated(since="XenServer 6.2") public void removeFromBackupSchedule(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to remove- 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.
-
removeFromArchiveTargetConfig
@Deprecated(since="XenServer 6.2") public void removeFromArchiveTargetConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to remove- 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.
-
removeFromArchiveSchedule
@Deprecated(since="XenServer 6.2") public void removeFromArchiveSchedule(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to remove- 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.
-
removeFromAlarmConfig
@Deprecated(since="XenServer 6.2") public void removeFromAlarmConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onkey
- the key to remove- 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.
-
setBackupLastRunTime
@Deprecated(since="XenServer 6.2") public void setBackupLastRunTime(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: Not Applicable First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The time at which the last backup was done. When the timezone is missing, UTC is assumed- 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.
-
setArchiveLastRunTime
@Deprecated(since="XenServer 6.2") public void setArchiveLastRunTime(Connection c, Date value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Minimum allowed role: Not Applicable First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The time at which the last archive was created. When the timezone is missing, UTC is assumed- 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
@Deprecated(since="XenServer 6.2") public static Set<VMPP> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Return a list of all the VMPPs known to the system. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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<VMPP,VMPP.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of VMPP references to VMPP records for all VMPPs known to the system. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- 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.
-