Interface Storage.Service
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- All Known Subinterfaces:
Evault.Service
,Iscsi.Service
- Enclosing class:
- Storage
@ApiService("SoftLayer_Network_Storage") public static interface Storage.Service extends Service
SoftLayer customers may have a Storage volume associated with their account. Storage types include NAS, Lockbox, iSCSI, EVault backup, and Hub cloud storage. Information such as the account the Storage volume is associated to, username and password to access the Storage volume, related server (EVault only) and the capacity used are some of the details that may be retrieved using this service. Information regarding the Storage's resource that is useful in reconfiguring and mounting a StorageLayer volume may also be retrieved from this service.
For the EVault Storage services, the username and passwords in the SoftLayer_Network_Storage services are used to register the EVault server agent with the vault. Please see the [[SoftLayer_Account_Password]] service to edit the passwords and notes for the EVault Webcc tool.
For the EVault Storage services, the username and passwords in the SoftLayer_Network_Storage services are used to register the EVault server agent with the vault. Please see the [[SoftLayer_Account_Password]] service to edit the passwords and notes for the EVault Webcc tool.
- See Also:
- SoftLayer_Network_Storage
-
Method Summary
Modifier and Type Method Description Boolean
allowAccessFromHardware(Hardware hardwareObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
allowAccessFromHardwareList(List<Hardware> hardwareObjectTemplates)
Host
allowAccessFromHost(String typeClassName, Long hostId)
This method is used to modify the access control list for this Storage volume.List<Host>
allowAccessFromHostList(List<Host> hostObjectTemplates)
This method is used to modify the access control list for this Storage volume.Boolean
allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
allowAccessFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)
Boolean
allowAccessFromSubnet(Subnet subnetObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
allowAccessFromSubnetList(List<Subnet> subnetObjectTemplates)
Boolean
allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
allowAccessFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)
This method is used to modify the access control list for this Storage volume.Boolean
allowAccessToReplicantFromHardware(Hardware hardwareObjectTemplate)
This method is used to modify the access control list for this Storage replicant volume.Boolean
allowAccessToReplicantFromHardwareList(List<Hardware> hardwareObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
allowAccessToReplicantFromIpAddress(IpAddress ipAddressObjectTemplate)
Boolean
allowAccessToReplicantFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
allowAccessToReplicantFromSubnet(Subnet subnetObjectTemplate)
This method is used to modify the access control list for this Storage replicant volume.Boolean
allowAccessToReplicantFromSubnetList(List<Subnet> subnetObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
allowAccessToReplicantFromVirtualGuest(Guest virtualGuestObjectTemplate)
This method is used to modify the access control list for this Storage replicant volume.Boolean
allowAccessToReplicantFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Storage.ServiceAsync
asAsync()
Get an async version of this serviceBoolean
assignCredential(String username)
This method will assign an existing credential to the current volume.Credential
assignNewCredential(String type)
This method will set up a new credential for the remote storage volume.Boolean
changePassword(String username, String currentPassword, String newPassword)
The method will change the password for the given Storage/Virtual Server Storage account.Long
collectBandwidth(String type, GregorianCalendar startDate, GregorianCalendar endDate)
{{CloudLayerOnlyMethod}}
collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.Long
collectBytesUsed()
{{CloudLayerOnlyMethod}}
collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.Boolean
convertCloneDependentToIndependent()
Boolean
createFolder(String folder)
Property
createOrUpdateLunId(Long lunId)
The LUN ID only takes effect during the Host Authorization process.Storage
createSnapshot(String notes)
Boolean
deleteAllFiles()
{{CloudLayerOnlyMethod}} Delete all files within a Storage account.Boolean
deleteFile(String fileId)
{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account.Boolean
deleteFiles(List<String> fileIds)
{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account.Boolean
deleteFolder(String folder)
Boolean
deleteObject()
Delete a network storage volume.Boolean
disableSnapshots(String scheduleType)
This method is not valid for Legacy iSCSI Storage Volumes.Entity
downloadFile(String fileId)
{{CloudLayerOnlyMethod}} Download a file from a Storage account.Boolean
editCredential(String username, String newPassword)
This method will change the password of a credential created using the 'addNewCredential' method.Boolean
editObject(Storage templateObject)
The password and/or notes may be modified for the Storage service except evault passwords and notes.Boolean
enableSnapshots(String scheduleType, Long retentionCount, Long minute, Long hour, String dayOfWeek)
This method is not valid for Legacy iSCSI Storage Volumes.Boolean
failbackFromReplicant()
Failback from a volume replicant.Boolean
failoverToReplicant(Long replicantId)
Failover to a volume replicant.Account
getAccount()
The account that a Storage services belongs to.Password
getAccountPassword()
Other usernames and passwords associated with a Storage volume.List<Transaction>
getActiveTransactions()
The currently active transactions on a network storage volume.List<Entity>
getAllFiles()
{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory.List<Entity>
getAllFilesByFilter(Entity filter)
{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory.List<Hardware>
getAllowableHardware(String filterHostname)
This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.List<IpAddress>
getAllowableIpAddresses(Long subnetId, String filterIpAddress)
This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.List<Subnet>
getAllowableSubnets(String filterNetworkIdentifier)
This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.List<Guest>
getAllowableVirtualGuests(String filterHostname)
This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.List<Hardware>
getAllowedHardware()
The SoftLayer_Hardware objects which are allowed access to this storage volume.Long
getAllowedHostsLimit()
Retrieves the total number of allowed hosts limit per volume.List<IpAddress>
getAllowedIpAddresses()
The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.List<Hardware>
getAllowedReplicationHardware()
The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.List<IpAddress>
getAllowedReplicationIpAddresses()
The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.List<Subnet>
getAllowedReplicationSubnets()
The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.List<Guest>
getAllowedReplicationVirtualGuests()
The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.List<Subnet>
getAllowedSubnets()
The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.List<Guest>
getAllowedVirtualGuests()
The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.Item
getBillingItem()
The current billing item for a Storage volume.Category
getBillingItemCategory()
String
getBytesUsed()
The amount of space used by the volume, in bytes.List<Storage>
getByUsername(String username, String type)
Retrieve network storage accounts by username and storage account type.List<ContentDeliveryUrl>
getCdnUrls()
Resource
getClusterResource()
String
getCreationScheduleId()
The schedule id which was executed to create a snapshot.List<Credential>
getCredentials()
Schedule
getDailySchedule()
The Daily Schedule which is associated with this network storage volume.String
getDependentDuplicate()
Whether or not a network storage volume is a dependent duplicate.List<Storage>
getDependentDuplicates()
The network storage volumes configured to be dependent duplicates of a volume.List<Event>
getEvents()
The events which have taken place on a network storage volume.List<Location>
getFileBlockEncryptedLocations()
Entity
getFileByIdentifier(String identifier)
{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account.Long
getFileCount()
{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory.List<Entity>
getFileList(String folder, String path)
String
getFileNetworkMountAddress()
Retrieves the NFS Network Mount Address Name for a given File Storage Volume.Long
getFilePendingDeleteCount()
{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin.List<Entity>
getFilesPendingDelete()
{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin.List<Folder>
getFolderList()
GraphOutputs
getGraph(GregorianCalendar startDate, GregorianCalendar endDate, String type)
{{CloudLayerOnlyMethod}}
getGraph() retrieves a Storage account's usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range.Hardware
getHardware()
When applicable, the hardware associated with a Storage service.Boolean
getHasEncryptionAtRest()
Schedule
getHourlySchedule()
The Hourly Schedule which is associated with this network storage volume.Schedule
getIntervalSchedule()
The Interval Schedule which is associated with this network storage volume.String
getIops()
The maximum number of IOPs selected for this volume.List<Storage>
getIscsiLuns()
Relationship between a container volume and iSCSI LUNs.List<String>
getIscsiTargetIpAddresses()
Returns the target IP addresses of an iSCSI volume.Boolean
getIsDependentDuplicateProvisionCompleted()
Determines whether dependent volume provision is completed on background.Boolean
getIsInDedicatedServiceResource()
Boolean
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.Boolean
getIsReadyToMount()
Determines whether a volume is ready to have Hosts authorized to access it.String
getLunId()
The ID of the LUN volume.List<Storage>
getManualSnapshots()
The manually-created snapshots associated with this SoftLayer_Network_Storage volume.Long
getMaximumExpansionSize()
Object
getMetricTrackingObject()
A network storage volume's metric tracking object.String
getMountableFlag()
Whether or not a network storage volume may be mounted.String
getMoveAndSplitStatus()
The current status of split or move operation as a part of volume duplication.NetworkConnectionInformation
getNetworkConnectionDetails()
String
getNetworkMountAddress()
List<Subscriber>
getNotificationSubscribers()
The subscribers that will be notified for usage amount warnings and overages.Storage
getObject()
getObject retrieves the SoftLayer_Network_Storage object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage service.List<Storage>
getObjectsByCredential(Credential credentialObject)
Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object.List<ConnectionInformation>
getObjectStorageConnectionInformation()
String
getOriginalSnapshotName()
The name of the snapshot that this volume was duplicated from.String
getOriginalVolumeName()
The name of the volume that this volume was duplicated from.String
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.Type
getOsType()
A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.String
getOsTypeId()
A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.List<Partnership>
getParentPartnerships()
The volumes or snapshots partnered with a network storage volume in a parental role.Storage
getParentVolume()
The parent volume of a volume in a complex storage relationship.List<Partnership>
getPartnerships()
The volumes or snapshots partnered with a network storage volume.List<Group>
getPermissionsGroups()
All permissions group(s) this volume is in.List<Property>
getProperties()
The properties used to provide additional details about a network storage volume.String
getProvisionedIops()
The number of IOPs provisioned for this volume.Entity
getRecycleBinFileByIdentifier(String fileId)
{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin.Long
getRemainingAllowedHosts()
Retrieves the remaining number of allowed hosts per volume.Long
getRemainingAllowedHostsForReplicant()
Retrieves the remaining number of allowed hosts for a volume's replicant.List<Storage>
getReplicatingLuns()
The iSCSI LUN volumes being replicated by this network storage volume.Storage
getReplicatingVolume()
The network storage volume being replicated by a volume.List<Event>
getReplicationEvents()
The volume replication events.List<Storage>
getReplicationPartners()
The network storage volumes configured to be replicants of a volume.Schedule
getReplicationSchedule()
The Replication Schedule associated with a network storage volume.String
getReplicationStatus()
The current replication status of a network storage volume.List<Schedule>
getSchedules()
The schedules which are associated with a network storage volume.Resource
getServiceResource()
The network resource a Storage service is connected to.String
getServiceResourceBackendIpAddress()
The IP address of a Storage resource.String
getServiceResourceName()
The name of a Storage's network resource.String
getSnapshotCapacityGb()
A volume's configured snapshot space size.String
getSnapshotCreationTimestamp()
The creation timestamp of the snapshot on the storage platform.String
getSnapshotDeletionThresholdPercentage()
The percentage of used snapshot space after which to delete automated snapshots.List<Storage>
getSnapshots()
The snapshots associated with this SoftLayer_Network_Storage volume.List<Storage>
getSnapshotsForVolume()
Retrieves a list of snapshots for this SoftLayer_Network_Storage volume.String
getSnapshotSizeBytes()
The snapshot size in bytes.String
getSnapshotSpaceAvailable()
A volume's available snapshot reservation space.String
getStaasVersion()
List<Group>
getStorageGroups()
The network storage groups this volume is attached to.List<NetworkConnectionInformation>
getStorageGroupsNetworkConnectionDetails()
String
getStorageTierLevel()
Type
getStorageType()
A description of the Storage object.List<String>
getTargetIpAddresses()
String
getTotalBytesUsed()
The amount of space used by the volume.Long
getTotalScheduleSnapshotRetentionCount()
The total snapshot retention count of all schedules on this network storage volume.Notification
getUsageNotification()
The usage notification for SL Storage services.List<Location>
getValidReplicationTargetDatacenterLocations()
String
getVendorName()
The type of network storage service.Guest
getVirtualGuest()
When applicable, the virtual guest associated with a Storage service.List<VolumeCountLimitContainer>
getVolumeCountLimits()
Retrieves an array of volume count limits per location and globally.VolumeDuplicateParameters
getVolumeDuplicateParameters()
This method returns the parameters for cloning a volumeList<History>
getVolumeHistory()
The username and password history for a Storage service.String
getVolumeStatus()
The current status of a network storage volume.Password
getWebccAccount()
The account username and password for the EVault webCC interface.Schedule
getWeeklySchedule()
The Weekly Schedule which is associated with this network storage volume.Boolean
immediateFailoverToReplicant(Long replicantId)
Immediate Failover to a volume replicant.Boolean
isBlockingOperationInProgress(List<String> exemptStatusKeyNames)
Boolean
isDuplicateReadyForSnapshot()
This method returns a boolean indicating whether the clone volume is ready for snapshot.Boolean
isDuplicateReadyToMount()
This method returns a boolean indicating whether the clone volume is ready to mount.Boolean
isVolumeActive()
Boolean
refreshDependentDuplicate(Long snapshotId)
Boolean
refreshDuplicate(Long snapshotId)
Boolean
removeAccessFromHardware(Hardware hardwareObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
removeAccessFromHardwareList(List<Hardware> hardwareObjectTemplates)
This method is used to modify the access control list for this Storage volume.Host
removeAccessFromHost(String typeClassName, Long hostId)
This method is used to modify the access control list for this Storage volume.List<Host>
removeAccessFromHostList(List<Host> hostObjectTemplates)
This method is used to modify the access control list for this Storage volume.Boolean
removeAccessFromIpAddress(IpAddress ipAddressObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
removeAccessFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)
Boolean
removeAccessFromSubnet(Subnet subnetObjectTemplate)
Boolean
removeAccessFromSubnetList(List<Subnet> subnetObjectTemplates)
Boolean
removeAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)
This method is used to modify the access control list for this Storage volume.Boolean
removeAccessFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)
This method is used to modify the access control list for this Storage volume.Boolean
removeAccessToReplicantFromHardwareList(List<Hardware> hardwareObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
removeAccessToReplicantFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
removeAccessToReplicantFromSubnet(Subnet subnetObjectTemplate)
Boolean
removeAccessToReplicantFromSubnetList(List<Subnet> subnetObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
removeAccessToReplicantFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)
This method is used to modify the access control list for this Storage volume's replica.Boolean
removeCredential(String username)
This method will remove a credential from the current volume.Entity
restoreFile(String fileId)
{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.Boolean
restoreFromSnapshot(Long snapshotId)
Restore the volume from a snapshot that was previously taken.Boolean
sendPasswordReminderEmail(String username)
The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password.void
setMask(Storage.Mask mask)
Boolean
setMountable(Boolean mountable)
Enable or disable the mounting of a Storage volume.Void
setSnapshotAllocation(Long capacityGb)
Boolean
upgradeVolumeCapacity(Long itemId)
Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage).Entity
uploadFile(Entity file)
{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory.Storage.Mask
withMask()
Use the existing mask on this service or create it if not presentStorage.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Storage.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service -
withNewMask
Storage.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
-
withMask
Storage.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
allowAccessFromHardware
This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. -
allowAccessFromHardwareList
@ApiMethod(instanceRequired=true) Boolean allowAccessFromHardwareList(List<Hardware> hardwareObjectTemplates) -
allowAccessFromHost
This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. -
allowAccessFromHostList
@ApiMethod(instanceRequired=true) List<Host> allowAccessFromHostList(List<Host> hostObjectTemplates)This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. -
allowAccessFromIpAddress
@ApiMethod(instanceRequired=true) Boolean allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate)This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume. -
allowAccessFromIpAddressList
@ApiMethod(instanceRequired=true) Boolean allowAccessFromIpAddressList(List<IpAddress> ipAddressObjectTemplates) -
allowAccessFromSubnet
This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. -
allowAccessFromSubnetList
@ApiMethod(instanceRequired=true) Boolean allowAccessFromSubnetList(List<Subnet> subnetObjectTemplates) -
allowAccessFromVirtualGuest
@ApiMethod(instanceRequired=true) Boolean allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. -
allowAccessFromVirtualGuestList
@ApiMethod(instanceRequired=true) Boolean allowAccessFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. -
allowAccessToReplicantFromHardware
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume. -
allowAccessToReplicantFromHardwareList
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromHardwareList(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume. -
allowAccessToReplicantFromIpAddress
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromIpAddress(IpAddress ipAddressObjectTemplate) -
allowAccessToReplicantFromIpAddressList
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume. -
allowAccessToReplicantFromSubnet
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromSubnet(Subnet subnetObjectTemplate)This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume. -
allowAccessToReplicantFromSubnetList
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromSubnetList(List<Subnet> subnetObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume. -
allowAccessToReplicantFromVirtualGuest
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume. -
allowAccessToReplicantFromVirtualGuestList
@ApiMethod(instanceRequired=true) Boolean allowAccessToReplicantFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume. -
assignCredential
This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential. -
assignNewCredential
This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted. -
changePassword
The method will change the password for the given Storage/Virtual Server Storage account. -
collectBandwidth
@ApiMethod(instanceRequired=true) Long collectBandwidth(String type, GregorianCalendar startDate, GregorianCalendar endDate){{CloudLayerOnlyMethod}}
collectBandwidth() Retrieve the bandwidth usage for the current billing cycle. -
collectBytesUsed
{{CloudLayerOnlyMethod}}
collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account. -
convertCloneDependentToIndependent
-
createFolder
- See Also:
- SoftLayer_Network_Storage::createFolder
-
createOrUpdateLunId
The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method. -
createSnapshot
-
deleteAllFiles
{{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.
Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.
Please note, files can not be restored once they are permanently deleted. -
deleteFile
{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin.
Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted.
Please note, a file can not be restored once it is permanently deleted.- See Also:
- SoftLayer_Network_Storage::deleteFile
-
deleteFiles
{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.
Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.
Please note, files can not be restored once they are permanently deleted.- See Also:
- SoftLayer_Network_Storage::deleteFiles
-
deleteFolder
- See Also:
- SoftLayer_Network_Storage::deleteFolder
-
deleteObject
Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method.
''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume;- See Also:
- SoftLayer_Network_Storage::deleteObject
-
disableSnapshots
This method is not valid for Legacy iSCSI Storage Volumes.
Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules. -
downloadFile
{{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.- See Also:
- SoftLayer_Network_Storage::downloadFile
-
editCredential
This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well. -
editObject
The password and/or notes may be modified for the Storage service except evault passwords and notes.- See Also:
- SoftLayer_Network_Storage::editObject
-
enableSnapshots
@ApiMethod(instanceRequired=true) Boolean enableSnapshots(String scheduleType, Long retentionCount, Long minute, Long hour, String dayOfWeek)This method is not valid for Legacy iSCSI Storage Volumes.
Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method. -
failbackFromReplicant
Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant. -
failoverToReplicant
Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available. -
getAllFiles
{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.- See Also:
- SoftLayer_Network_Storage::getAllFiles
-
getAllFilesByFilter
{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content. -
getAllowableHardware
This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage. -
getAllowableIpAddresses
@ApiMethod(instanceRequired=true) List<IpAddress> getAllowableIpAddresses(Long subnetId, String filterIpAddress)This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage. -
getAllowableSubnets
This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage. -
getAllowableVirtualGuests
This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage. -
getAllowedHostsLimit
Retrieves the total number of allowed hosts limit per volume. -
getByUsername
Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type.- See Also:
- SoftLayer_Network_Storage::getByUsername
-
getCdnUrls
- See Also:
- SoftLayer_Network_Storage::getCdnUrls
-
getClusterResource
-
getFileBlockEncryptedLocations
-
getFileByIdentifier
{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content. -
getFileCount
{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin.- See Also:
- SoftLayer_Network_Storage::getFileCount
-
getFileList
- See Also:
- SoftLayer_Network_Storage::getFileList
-
getFilePendingDeleteCount
{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. -
getFilesPendingDelete
{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content. -
getFolderList
- See Also:
- SoftLayer_Network_Storage::getFolderList
-
getGraph
@ApiMethod(instanceRequired=true) GraphOutputs getGraph(GregorianCalendar startDate, GregorianCalendar endDate, String type){{CloudLayerOnlyMethod}}
getGraph() retrieves a Storage account's usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range. Virtual Server storage accounts can also graph upload and download bandwidth usage.- See Also:
- SoftLayer_Network_Storage::getGraph
-
getMaximumExpansionSize
-
getNetworkConnectionDetails
-
getNetworkMountAddress
-
getObject
getObject retrieves the SoftLayer_Network_Storage object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage service.
Please use the associated methods in the [[SoftLayer_Network_Storage]] service to retrieve a Storage account's id.- See Also:
- SoftLayer_Network_Storage::getObject
-
getObjectStorageConnectionInformation
-
getObjectsByCredential
Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id. -
getRecycleBinFileByIdentifier
{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin. -
getRemainingAllowedHosts
Retrieves the remaining number of allowed hosts per volume. -
getRemainingAllowedHostsForReplicant
Retrieves the remaining number of allowed hosts for a volume's replicant. -
getSnapshotsForVolume
Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination. -
getStorageGroupsNetworkConnectionDetails
@ApiMethod(instanceRequired=true) List<NetworkConnectionInformation> getStorageGroupsNetworkConnectionDetails() -
getTargetIpAddresses
-
getValidReplicationTargetDatacenterLocations
-
getVolumeCountLimits
Retrieves an array of volume count limits per location and globally. -
getVolumeDuplicateParameters
This method returns the parameters for cloning a volume -
immediateFailoverToReplicant
Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available. -
isBlockingOperationInProgress
@ApiMethod(instanceRequired=true) Boolean isBlockingOperationInProgress(List<String> exemptStatusKeyNames) -
isDuplicateReadyForSnapshot
This method returns a boolean indicating whether the clone volume is ready for snapshot. -
isDuplicateReadyToMount
This method returns a boolean indicating whether the clone volume is ready to mount. -
isVolumeActive
-
refreshDependentDuplicate
-
refreshDuplicate
-
removeAccessFromHardware
@ApiMethod(instanceRequired=true) Boolean removeAccessFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. -
removeAccessFromHardwareList
@ApiMethod(instanceRequired=true) Boolean removeAccessFromHardwareList(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume. -
removeAccessFromHost
This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. -
removeAccessFromHostList
@ApiMethod(instanceRequired=true) List<Host> removeAccessFromHostList(List<Host> hostObjectTemplates)This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume. -
removeAccessFromIpAddress
@ApiMethod(instanceRequired=true) Boolean removeAccessFromIpAddress(IpAddress ipAddressObjectTemplate)This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume. -
removeAccessFromIpAddressList
@ApiMethod(instanceRequired=true) Boolean removeAccessFromIpAddressList(List<IpAddress> ipAddressObjectTemplates) -
removeAccessFromSubnet
-
removeAccessFromSubnetList
@ApiMethod(instanceRequired=true) Boolean removeAccessFromSubnetList(List<Subnet> subnetObjectTemplates) -
removeAccessFromVirtualGuest
@ApiMethod(instanceRequired=true) Boolean removeAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. -
removeAccessFromVirtualGuestList
@ApiMethod(instanceRequired=true) Boolean removeAccessFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume. -
removeAccessToReplicantFromHardwareList
@ApiMethod(instanceRequired=true) Boolean removeAccessToReplicantFromHardwareList(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume. -
removeAccessToReplicantFromIpAddressList
@ApiMethod(instanceRequired=true) Boolean removeAccessToReplicantFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume. -
removeAccessToReplicantFromSubnet
@ApiMethod(instanceRequired=true) Boolean removeAccessToReplicantFromSubnet(Subnet subnetObjectTemplate) -
removeAccessToReplicantFromSubnetList
@ApiMethod(instanceRequired=true) Boolean removeAccessToReplicantFromSubnetList(List<Subnet> subnetObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume. -
removeAccessToReplicantFromVirtualGuestList
@ApiMethod(instanceRequired=true) Boolean removeAccessToReplicantFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume. -
removeCredential
This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method. -
restoreFile
{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.
If a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory.- See Also:
- SoftLayer_Network_Storage::restoreFile
-
restoreFromSnapshot
Restore the volume from a snapshot that was previously taken. -
sendPasswordReminderEmail
The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username. -
setMountable
Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use.
For Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads.
Enabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account.- See Also:
- SoftLayer_Network_Storage::setMountable
-
setSnapshotAllocation
-
upgradeVolumeCapacity
Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage). -
uploadFile
{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file.
The following properties are required in the ''file'' parameter.
*'''name''': The name of the file you wish to upload
*'''content''': The raw contents of the file you wish to upload.
*'''contentType''': The MIME-type of content that you wish to upload.- See Also:
- SoftLayer_Network_Storage::uploadFile
-
getAccount
The account that a Storage services belongs to.- See Also:
- SoftLayer_Network_Storage::getAccount
-
getAccountPassword
Other usernames and passwords associated with a Storage volume. -
getActiveTransactions
The currently active transactions on a network storage volume. -
getAllowedHardware
The SoftLayer_Hardware objects which are allowed access to this storage 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. -
getBillingItemCategory
-
getBytesUsed
The amount of space used by the volume, in bytes.- See Also:
- SoftLayer_Network_Storage::getBytesUsed
-
getCreationScheduleId
The schedule id which was executed to create a snapshot. -
getCredentials
-
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. -
getEvents
The events which have taken place on a network storage volume.- See Also:
- SoftLayer_Network_Storage::getEvents
-
getFileNetworkMountAddress
Retrieves the NFS Network Mount Address Name for a given File Storage Volume. -
getHardware
When applicable, the hardware associated with a Storage service.- See Also:
- SoftLayer_Network_Storage::getHardware
-
getHasEncryptionAtRest
-
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.- See Also:
- SoftLayer_Network_Storage::getIops
-
getIsDependentDuplicateProvisionCompleted
Determines whether dependent volume provision is completed on background. -
getIsInDedicatedServiceResource
-
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.- See Also:
- SoftLayer_Network_Storage::getIscsiLuns
-
getIscsiTargetIpAddresses
Returns the target IP addresses of an iSCSI volume. -
getLunId
The ID of the LUN volume.- See Also:
- SoftLayer_Network_Storage::getLunId
-
getManualSnapshots
The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. -
getMetricTrackingObject
A network storage volume's metric tracking object. This object records all periodic polled data available to this 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. -
getNotificationSubscribers
The subscribers that will be notified for usage amount warnings and overages. -
getOriginalSnapshotName
The name of the snapshot that this volume was duplicated from. -
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.- See Also:
- SoftLayer_Network_Storage::getOsType
-
getOsTypeId
A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.- See Also:
- SoftLayer_Network_Storage::getOsTypeId
-
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. -
getProperties
The properties used to provide additional details about a network storage volume.- See Also:
- SoftLayer_Network_Storage::getProperties
-
getProvisionedIops
The number of IOPs provisioned for this volume. -
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. -
getSchedules
The schedules which are associated with a network storage volume.- See Also:
- SoftLayer_Network_Storage::getSchedules
-
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. -
getSnapshotSizeBytes
The snapshot size in bytes. -
getSnapshotSpaceAvailable
A volume's available snapshot reservation space. -
getSnapshots
The snapshots associated with this SoftLayer_Network_Storage volume.- See Also:
- SoftLayer_Network_Storage::getSnapshots
-
getStaasVersion
-
getStorageGroups
The network storage groups this volume is attached to. -
getStorageTierLevel
-
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.- See Also:
- SoftLayer_Network_Storage::getVendorName
-
getVirtualGuest
When applicable, the virtual guest associated with a Storage service. -
getVolumeHistory
The username and password history for a Storage service. -
getVolumeStatus
The current status of a network storage volume. -
getWebccAccount
The account username and password for the EVault webCC interface. -
getWeeklySchedule
The Weekly Schedule which is associated with this network storage volume.
-