SoftLayer_Network_Storage_Backup_Evault


SoftLayer_Network_Storage_Backup_Evault

Description

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.

Methods

allowAccessFromHardware

Allow access to this volume from a specified SoftLayer_Hardware object.

allowAccessFromHost

Allow access to this volume from a specified [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] object.

allowAccessFromHostList

Allow access to this volume from multiple [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects.

allowAccessFromIpAddress

Allow access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object.

allowAccessFromSubnet

Allow access to this volume from multiple SoftLayer_Network_Subnet objects.

allowAccessFromVirtualGuest

Allow access to this volume from a specified SoftLayer_Virtual_Guest object.

allowAccessFromVirtualGuestList

Allow access to this volume from multiple SoftLayer_Virtual_Guest objects.

allowAccessToReplicantFromHardware

Allow access to this replicant volume from a specified SoftLayer_Hardware object.

allowAccessToReplicantFromHardwareList

allow access to this volume’s replica from multiple SoftLayer_Hardware objects.

allowAccessToReplicantFromIpAddressList

allow access to this volume’s replica from multiple SoftLayer_Network_Subnet_IpAddress objects.

allowAccessToReplicantFromSubnet

Allow access to this replicant volume from multiple SoftLayer_Network_Subnet objects.

allowAccessToReplicantFromSubnetList

allow access to this volume’s replica from multiple SoftLayer_Network_Subnet objects.

allowAccessToReplicantFromVirtualGuest

Allow access to this replicant volume from a specified SoftLayer_Virtual_Guest object.

allowAccessToReplicantFromVirtualGuestList

allow access to this volume’s replica from multiple SoftLayer_Virtual_Guest objects.

assignCredential

This method will assign an existing credential to the current volume.

assignNewCredential

This method will set up a new credential for the remote storage volume.

changePassword

Change the password for a Storage/Virtual Server Storage account

collectBandwidth

Retrieve the bandwidth usage for the current billing cycle.

collectBytesUsed

Retrieve the number of bytes capacity currently in use on a Storage account.

convertCloneDependentToIndependent

Splits a clone from its parent allowing it to be an independent volume.

createFolder

Create a new folder in the root directory.

createOrUpdateLunId

Creates or updates the LUN ID property on a volume.

createSnapshot

Manually create a new snapshot of a storage volume.

deleteAllFiles

Delete all files within a Storage account.

deleteFile

Delete an individual file within a Storage account.

deleteFiles

Delete multiple files within a Storage account.

deleteFolder

Delete a folder in the root directory.

deleteObject

Delete a network storage volume

deleteTasks

Delete task(s)

disableSnapshots

Disable snapshots of this Storage Volume on a schedule.

disasterRecoveryFailoverToReplicant

Failover an inaccessible block/file volume to its available replicant volume.

downloadFile

Download a file from a Storage account.

editCredential

This method will change the password of a credential created using the ‘addNewCredential’ method.

editObject

Edit the password and/or notes for the Storage service

enableSnapshots

Enable snapshots of this Storage Volume on a schedule.

failbackFromReplicant

Failback from a volume replicant.

failoverToReplicant

Failover to a volume replicant.

getAccount

The account that a Storage services belongs to.

getAccountPassword

Other usernames and passwords associated with a Storage volume.

getActiveTransactions

The currently active transactions on a network storage volume.

getAllFiles

Retrieve a listing of all files in a Storage account’s root directory.

getAllFilesByFilter

Retrieve a listing of all files matching the filter’s criteria in a Storage account’s root directory.

getAllowableHardware

Return a list of SoftLayer_Hardware that can be authorized to this volume.

getAllowableIpAddresses

Return a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this volume.

getAllowableSubnets

Return a list of SoftLayer_Network_Subnet that can be authorized to this volume.

getAllowableVirtualGuests

Return a list of SoftLayer_Virtual_Guest that can be authorized to this volume.

getAllowedHardware

The SoftLayer_Hardware objects which are allowed access to this storage volume.

getAllowedHostsLimit

Retrieves the total number of allowed hosts limit per volume.

getAllowedIpAddresses

The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.

getAllowedReplicationHardware

The SoftLayer_Hardware objects which are allowed access to this storage volume’s Replicant.

getAllowedReplicationIpAddresses

The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume’s Replicant.

getAllowedReplicationSubnets

The SoftLayer_Network_Subnet objects which are allowed access to this storage volume’s Replicant.

getAllowedReplicationVirtualGuests

The SoftLayer_Hardware objects which are allowed access to this storage volume’s Replicant.

getAllowedSubnets

The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.

getAllowedVirtualGuests

The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.

getBillingItem

The current billing item for a Storage volume.

getByUsername

Retrieve network storage accounts by username.

getBytesUsed

The amount of space used by the volume, in bytes.

getCreationScheduleId

The schedule id which was executed to create a snapshot.

getCurrentCyclePeakUsage

Peak number of bytes used in the vault for the current billing cycle.

getDailySchedule

The Daily Schedule which is associated with this network storage volume.

getDependentDuplicate

Whether or not a network storage volume is a dependent duplicate.

getDependentDuplicates

The network storage volumes configured to be dependent duplicates of a volume.

getDuplicateConversionStatus

An API to fetch the percentage progress of conversion of a dependent

getEvents

The events which have taken place on a network storage volume.

getFailbackNotAllowed

Determines whether the volume is allowed to failback

getFailoverNotAllowed

Determines whether the volume is allowed to failover

getFileBlockEncryptedLocations

Returns a list of SoftLayer_Location_Datacenter objects corresponding to Datacenters in which File and Block Storage Volumes with Encryption at Rest may be ordered.

getFileByIdentifier

Retrieve an individual file’s details.

getFileCount

Retrieve the file number of files in a Virtual Server Storage account’s root directory.

getFileList

Retrieve list of files in a given folder for this account.

getFileNetworkMountAddress

Retrieves the NFS Network Mount Address Name for a given File Storage Volume.

getFilePendingDeleteCount

Retrieve the number of files pending deletion in a Storage account’s recycle bin.

getFilesPendingDelete

Retrieve a list of files in a Storage account’s recycle bin.

getFolderList

Retrieve a list of level 1 folders for this account.

getGraph

[DEPRECATED] Retrieve a graph representing the bandwidth used by a Storage account.

getHardware

When applicable, the hardware associated with a Storage service.

getHardwareWithEvaultFirst

Retrieve all the hardware for the account listing the hardware with EVault Storage service first. The output will be paginated having 25 items on each page.

getHourlySchedule

The Hourly Schedule which is associated with this network storage volume.

getIntervalSchedule

The Interval Schedule which is associated with this network storage volume.

getIops

The maximum number of IOPs selected for this volume.

getIsConvertToIndependentTransactionInProgress

Determines whether network storage volume has an active convert dependent clone to Independent transaction.

getIsDependentDuplicateProvisionCompleted

Determines whether dependent volume provision is completed on background.

getIsProvisionInProgress

Determines whether network storage volume has an active provision transaction.

getIsReadyForSnapshot

Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.

getIsReadyToMount

Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume’s volumeStatus property for details.

getIscsiLuns

Relationship between a container volume and iSCSI LUNs.

getIscsiReplicatingVolume

The network storage volumes configured to be replicants of this volume.

getIscsiTargetIpAddresses

Returns the target IP addresses of an iSCSI volume.

getLunId

The ID of the LUN volume.

getManualSnapshots

The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.

getMaximumExpansionSize

Returns the maximum volume expansion size in GB.

getMetricTrackingObject

[DEPRECATED] - A network storage volume’s metric tracking object. This object records all periodic polled data available to this volume.

getMountPath

Retrieves the NFS Network Mount Path for a given File Storage Volume.

getMountableFlag

Whether or not a network storage volume may be mounted.

getMoveAndSplitStatus

The current status of split or move operation as a part of volume duplication.

getNetworkConnectionDetails

Retrieve network connection details for complex network storage volumes.

getNetworkMountAddress

Displays the mount path of a storage volume.

getNetworkMountPath

Displays the mount path of a storage volume.

getNotificationSubscribers

The subscribers that will be notified for usage amount warnings and overages.

getObject

Retrieve a SoftLayer_Network_Storage_Backup_Evault record.

getObjectStorageConnectionInformation

Retrieve all object storage details for connection

getObjectsByCredential

Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object.

getOriginalSnapshotName

The name of the snapshot that this volume was duplicated from.

getOriginalVolumeId

Volume id of the origin volume from which this volume is been cloned.

getOriginalVolumeName

The name of the volume that this volume was duplicated from.

getOriginalVolumeSize

The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.

getOsType

A volume’s configured SoftLayer_Network_Storage_Iscsi_OS_Type.

getOsTypeId

A volume’s configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.

getParentPartnerships

The volumes or snapshots partnered with a network storage volume in a parental role.

getParentVolume

The parent volume of a volume in a complex storage relationship.

getPartnerships

The volumes or snapshots partnered with a network storage volume.

getPermissionsGroups

All permissions group(s) this volume is in.

getPreviousCyclePeakUsage

Peak number of bytes used in the vault for the previous billing cycle.

getProperties

The properties used to provide additional details about a network storage volume.

getProvisionedIops

The number of IOPs provisioned for this volume.

getRecycleBinFileByIdentifier

Retrieve all files that are in the recycle bin (pending delete). This method is only used for Virtual Server Storage accounts at moment but may expanded to other Storage types in the future.

getRemainingAllowedHosts

Retrieves the remaining number of allowed hosts per volume.

getRemainingAllowedHostsForReplicant

Retrieves the remaining number of allowed hosts for a volume’s replicant.

getReplicatingLuns

The iSCSI LUN volumes being replicated by this network storage volume.

getReplicatingVolume

The network storage volume being replicated by a volume.

getReplicationEvents

The volume replication events.

getReplicationPartners

The network storage volumes configured to be replicants of a volume.

getReplicationSchedule

The Replication Schedule associated with a network storage volume.

getReplicationStatus

The current replication status of a network storage volume. Indicates Failover or Failback status.

getReplicationTimestamp

An API call to fetch the last timestamp of the replication process

getSchedules

The schedules which are associated with a network storage volume.

getServiceResource

The network resource a Storage service is connected to.

getServiceResourceBackendIpAddress

The IP address of a Storage resource.

getServiceResourceName

The name of a Storage’s network resource.

getSnapshotCapacityGb

A volume’s configured snapshot space size.

getSnapshotCreationTimestamp

The creation timestamp of the snapshot on the storage platform.

getSnapshotDeletionThresholdPercentage

The percentage of used snapshot space after which to delete automated snapshots.

getSnapshotNotificationStatus

Whether or not a network storage volume may be mounted.

getSnapshotSizeBytes

The snapshot size in bytes.

getSnapshotSpaceAvailable

A volume’s available snapshot reservation space.

getSnapshots

The snapshots associated with this SoftLayer_Network_Storage volume.

getSnapshotsForVolume

Retrieves a list oƒf snapshots for a given volume.

getStorageGroups

The network storage groups this volume is attached to.

getStorageType

A description of the Storage object.

getTotalBytesUsed

The amount of space used by the volume.

getTotalScheduleSnapshotRetentionCount

The total snapshot retention count of all schedules on this network storage volume.

getUsageNotification

The usage notification for SL Storage services.

getVendorName

The type of network storage service.

getVirtualGuest

When applicable, the virtual guest associated with a Storage service.

getVolumeCountLimits

Retrieves an array of volume count limits per location and globally.

getVolumeDuplicateParameters

This method returns the parameters for cloning a volume

getVolumeHistory

The username and password history for a Storage service.

getVolumeStatus

The current status of a network storage volume.

getWebCCAuthenticationDetails

Retrieve WebCC authentication details value. This value is required for the login process associated to the session information for WebCC.

getWebccAccount

The account username and password for the EVault webCC interface.

getWeeklySchedule

The Weekly Schedule which is associated with this network storage volume.

immediateFailoverToReplicant

Immediate Failover to a volume replicant.

initiateBareMetalRestore

Initiate a bare metal restore for the server tied to the EVault account

initiateBareMetalRestoreForServer

Initiate a bare metal restore for the specified server

initiateOriginVolumeReclaim

Initiates Origin Volume Reclaim to delete volume from NetApp.

initiateVolumeCutover

Initiates Volume Cutover to remove access from the old volume.

isDuplicateReadyForSnapshot

Displays the if clone snapshots can be ordered.

isDuplicateReadyToMount

Displays the status of a clone mount.

refreshDependentDuplicate

Refreshes a duplicate volume with a snapshot taken from its parent. This is deprecated now.

refreshDuplicate

Refreshes any duplicate volume with a snapshot taken from its parent.

removeAccessFromHardware

Remove access to this volume from a specified SoftLayer_Hardware object.

removeAccessFromHardwareList

Remove access to this volume from multiple SoftLayer_Hardware objects.

removeAccessFromHost

Remove access to this volume from a specified [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] object.

removeAccessFromHostList

Remove access to this volume from multiple [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects.

removeAccessFromIpAddress

Remove access to this volume from a specified SoftLayer_Network_Subnet_IpAddress object.

removeAccessFromVirtualGuest

Remove access to this volume from a specified SoftLayer_Virtual_Guest object.

removeAccessFromVirtualGuestList

Remove access to this volume from multiple SoftLayer_Virtual_Guest objects.

removeAccessToReplicantFromHardwareList

Remove access to this volume’s replica from multiple SoftLayer_Hardware objects.

removeAccessToReplicantFromIpAddressList

Remove access to this replica volume’s replica from multiple SoftLayer_Network_Subnet_IpAddress objects.

removeAccessToReplicantFromSubnetList

Remove access to this volume’s replica from multiple SoftLayer_Network_Subnet objects.

removeAccessToReplicantFromVirtualGuestList

Remove access to this volume’s replica from multiple SoftLayer_Virtual_Guest objects.

removeCredential

This method will remove a credential from the current volume.

restoreFile

Restore access to an individual file in a Storage account.

restoreFromSnapshot

Restore from a volume snapshot.

sendPasswordReminderEmail

Email the password for the Storage account to the master user.

setMountable

Enable or disable mounting of a Storage volume.

setSnapshotNotification

Function to enable/disable snapshot warning notification.

upgradeVolumeCapacity

Edit the Storage volume to a different package

uploadFile

Upload a file to a Storage account’s root directory.

validateHostsAccess

An API to check if the hosts provided are behind gateway or not from