Interface Evault.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
,Storage.Service
- Enclosing class:
- Evault
@ApiService("SoftLayer_Network_Storage_Backup_Evault") public static interface Evault.Service extends Storage.Service
SoftLayer provides the EVault backup system as a part of it's Storage service offerings. EVault is an incremental and automated backup solution with Windows and web-based management clients. The SoftLayer_Network_Storage_Backup_Evault service allows portal and API users to work with their EVault accounts. The large majority of EVault functionality is implemented in the SoftLayer_Network_Storage_Backup_Evault_Version6 service.- See Also:
- SoftLayer_Network_Storage_Backup_Evault
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Evault.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
deleteTasks(List<Long> tasks)
This method can be used to help maintain the storage space on a vault.List<Hardware>
getHardwareWithEvaultFirst(String option, Boolean exactMatch, String criteria, String mode)
Retrieve a list of hardware associated with a SoftLayer customer account, placing all hardware with associated EVault storage accounts at the beginning of the list.Evault
getObjectForEvault()
getObject retrieves the SoftLayer_Network_Storage_Backup_Evault object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage_Backup_Evault service.Details
getWebCCAuthenticationDetails()
Boolean
initiateBareMetalRestore()
Evault Bare Metal Restore is a special version of Rescue Kernel designed specifically for making full system restores made with Evault's BMR backup.Boolean
initiateBareMetalRestoreForServer(Long hardwareId)
This method operates the same as the initiateBareMetalRestore() method.void
setMask(Evault.Mask mask)
Evault.Mask
withMask()
Use the existing mask on this service or create it if not presentEvault.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Methods inherited from interface com.softlayer.api.service.network.Storage.Service
allowAccessFromHardware, allowAccessFromHardwareList, allowAccessFromHost, allowAccessFromHostList, allowAccessFromIpAddress, allowAccessFromIpAddressList, allowAccessFromSubnet, allowAccessFromSubnetList, allowAccessFromVirtualGuest, allowAccessFromVirtualGuestList, allowAccessToReplicantFromHardware, allowAccessToReplicantFromHardwareList, allowAccessToReplicantFromIpAddress, allowAccessToReplicantFromIpAddressList, allowAccessToReplicantFromSubnet, allowAccessToReplicantFromSubnetList, allowAccessToReplicantFromVirtualGuest, allowAccessToReplicantFromVirtualGuestList, assignCredential, assignNewCredential, changePassword, collectBandwidth, collectBytesUsed, convertCloneDependentToIndependent, createFolder, createOrUpdateLunId, createSnapshot, deleteAllFiles, deleteFile, deleteFiles, deleteFolder, deleteObject, disableSnapshots, disasterRecoveryFailoverToReplicant, downloadFile, editCredential, editObject, enableSnapshots, failbackFromReplicant, failoverToReplicant, getAccount, getAccountPassword, getActiveTransactions, getAllFiles, getAllFilesByFilter, getAllowableHardware, getAllowableIpAddresses, getAllowableSubnets, getAllowableVirtualGuests, getAllowDisasterRecoveryFailback, getAllowDisasterRecoveryFailover, getAllowedHardware, getAllowedHostsLimit, getAllowedIpAddresses, getAllowedReplicationHardware, getAllowedReplicationIpAddresses, getAllowedReplicationSubnets, getAllowedReplicationVirtualGuests, getAllowedSubnets, getAllowedVirtualGuests, getBillingItem, getBillingItemCategory, getBytesUsed, getByUsername, getCdnUrls, getClusterResource, getCreationScheduleId, getCredentials, getDailySchedule, getDependentDuplicate, getDependentDuplicates, getEvents, getFailbackNotAllowed, getFailoverNotAllowed, getFileBlockEncryptedLocations, getFileByIdentifier, getFileCount, getFileList, getFileNetworkMountAddress, getFilePendingDeleteCount, getFilesPendingDelete, getFolderList, getGraph, getHardware, getHasEncryptionAtRest, getHourlySchedule, getIntervalSchedule, getIops, getIscsiLuns, getIscsiTargetIpAddresses, getIsDependentDuplicateProvisionCompleted, getIsInDedicatedServiceResource, getIsMagneticStorage, getIsReadyForSnapshot, getIsReadyToMount, getLunId, getManualSnapshots, getMaximumExpansionSize, getMetricTrackingObject, getMountableFlag, getMountPath, getMoveAndSplitStatus, getNetworkConnectionDetails, getNetworkMountAddress, getNetworkMountPath, getNotificationSubscribers, getObject, getObjectsByCredential, getObjectStorageConnectionInformation, getOriginalSnapshotName, getOriginalVolumeName, getOriginalVolumeSize, getOsType, getOsTypeId, getParentPartnerships, getParentVolume, getPartnerships, getPermissionsGroups, getProperties, getProvisionedIops, getRecycleBinFileByIdentifier, getRemainingAllowedHosts, getRemainingAllowedHostsForReplicant, getReplicatingLuns, getReplicatingVolume, getReplicationEvents, getReplicationPartners, getReplicationSchedule, getReplicationStatus, getReplicationTimestamp, getSchedules, getServiceResource, getServiceResourceBackendIpAddress, getServiceResourceName, getSnapshotCapacityGb, getSnapshotCreationTimestamp, getSnapshotDeletionThresholdPercentage, getSnapshotNotificationStatus, getSnapshots, getSnapshotsForVolume, getSnapshotSizeBytes, getSnapshotSpaceAvailable, getStaasVersion, getStorageGroups, getStorageGroupsNetworkConnectionDetails, getStorageTierLevel, getStorageType, getTargetIpAddresses, getTotalBytesUsed, getTotalScheduleSnapshotRetentionCount, getUsageNotification, getValidReplicationTargetDatacenterLocations, getVendorName, getVirtualGuest, getVolumeCountLimits, getVolumeDuplicateParameters, getVolumeHistory, getVolumeStatus, getWebccAccount, getWeeklySchedule, immediateFailoverToReplicant, initiateOriginVolumeReclaim, initiateVolumeCutover, isBlockingOperationInProgress, isDuplicateReadyForSnapshot, isDuplicateReadyToMount, isVolumeActive, refreshDependentDuplicate, refreshDuplicate, removeAccessFromHardware, removeAccessFromHardwareList, removeAccessFromHost, removeAccessFromHostList, removeAccessFromIpAddress, removeAccessFromIpAddressList, removeAccessFromSubnet, removeAccessFromSubnetList, removeAccessFromVirtualGuest, removeAccessFromVirtualGuestList, removeAccessToReplicantFromHardwareList, removeAccessToReplicantFromIpAddressList, removeAccessToReplicantFromSubnet, removeAccessToReplicantFromSubnetList, removeAccessToReplicantFromVirtualGuestList, removeCredential, restoreFile, restoreFromSnapshot, sendPasswordReminderEmail, setMask, setMountable, setSnapshotAllocation, setSnapshotNotification, upgradeVolumeCapacity, uploadFile
-
-
-
-
Method Detail
-
asAsync
Evault.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service- Specified by:
asAsync
in interfaceService
- Specified by:
asAsync
in interfaceStorage.Service
-
withNewMask
Evault.Mask withNewMask()
Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
- Specified by:
withNewMask
in interfaceStorage.Service
-
withMask
Evault.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present- Specified by:
withMask
in interfaceMaskable
- Specified by:
withMask
in interfaceStorage.Service
-
setMask
void setMask(Evault.Mask mask)
-
deleteTasks
@ApiMethod(instanceRequired=true) Boolean deleteTasks(List<Long> tasks)
This method can be used to help maintain the storage space on a vault. When a job is removed from the Webcc, the task and stored usage still exists on the vault. This method can be used to delete the associated task and its usage.
All that is required for the use of the method is to pass in an integer array of task(s).
-
getHardwareWithEvaultFirst
@ApiMethod List<Hardware> getHardwareWithEvaultFirst(String option, Boolean exactMatch, String criteria, String mode)
Retrieve a list of hardware associated with a SoftLayer customer account, placing all hardware with associated EVault storage accounts at the beginning of the list. The return type is SoftLayer_Hardware_Server[] contains the results; the number of items returned in the result will be returned in the soap header (totalItems). ''getHardwareWithEvaultFirst'' is useful in situations where you wish to search for hardware and provide paginated output.
Results are only returned for hardware belonging to the account of the user making the API call.
This method drives the backup page of the SoftLayer customer portal. It serves a very specific function, but we have exposed it as it may prove useful for API developers too.
-
getObjectForEvault
@ApiMethod(value="getObject", instanceRequired=true) Evault getObjectForEvault()
getObject retrieves the SoftLayer_Network_Storage_Backup_Evault object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage_Backup_Evault service.
-
getWebCCAuthenticationDetails
@ApiMethod Details getWebCCAuthenticationDetails()
-
initiateBareMetalRestore
@ApiMethod(instanceRequired=true) Boolean initiateBareMetalRestore()
Evault Bare Metal Restore is a special version of Rescue Kernel designed specifically for making full system restores made with Evault's BMR backup. This process works very similar to Rescue Kernel, except only the Evault restore program is available. The process takes approximately 10 minutes. Once completed you will be able to access your server to do a restore through VNC or your servers KVM-over-IP. IP information and credentials can be found on the hardware page of the customer portal. The Evault Application will be running automatically upon startup, and will walk you through the restore process.
-
initiateBareMetalRestoreForServer
@ApiMethod(instanceRequired=true) Boolean initiateBareMetalRestoreForServer(Long hardwareId)
This method operates the same as the initiateBareMetalRestore() method. However, using this method, the Bare Metal Restore can be initiated on any Windows server under the account.
-
-