SoftLayer_Network_Storage_Iscsi


SoftLayer_Network_Storage_Iscsi

Description

SoftLayer’s iscsi product extends upon the base functionality of SoftLayer offerings by providing snapshot and replication capabilities. An iscsi volume is mounted through SoftLayer’s private network and allows for block level additional storage on a highly redundant disk array. SoftLayer’s iscsi offering is capable of taking volume snapshots which can be mounted read-only or used for an immediate volume data restore. This high-end Storage offering is also capable of being configured for remote data replication to any of SoftLayer’s datacenters to provide a solid disaster recovery solution.

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.
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 replica volume from multiple SoftLayer_Hardware objects.
allowAccessToReplicantFromIpAddressList
allow access to this volume 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 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.
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
disableSnapshots
Disable snapshots of this Storage Volume on a schedule.
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
Retrieve the account that a Storage services belongs to.
getAccountPassword
Retrieve other usernames and passwords associated with a Storage volume.
getActiveTransactions
Retrieve 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
Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume.
getAllowedHostsLimit
Retrieves the total number of allowed hosts limit per volume.
getAllowedIpAddresses
Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
getAllowedReplicationHardware
Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
getAllowedReplicationIpAddresses
Retrieve the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
getAllowedReplicationSubnets
Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
getAllowedReplicationVirtualGuests
Retrieve the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
getAllowedSubnets
Retrieve the SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
getAllowedVirtualGuests
Retrieve the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
getBillingItem
Retrieve the current billing item for a Storage volume.
getByUsername
Retrieve network storage accounts by username.
getBytesUsed
Retrieve the amount of space used by the volume, in bytes.
getCreationScheduleId
Retrieve the schedule id which was executed to create a snapshot.
getDailySchedule
Retrieve the Daily Schedule which is associated with this network storage volume.
getEvents
Retrieve the events which have taken place on a network storage volume.
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
Retrieve 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
Retrieve a graph representing the bandwidth used by a Storage account.
getHardware
Retrieve when applicable, the hardware associated with a Storage service.
getHourlySchedule
Retrieve the Hourly Schedule which is associated with this network storage volume.
getIntervalSchedule
Retrieve the Interval Schedule which is associated with this network storage volume.
getIops
Retrieve the maximum number of IOPs guaranteed for this LUN.
getIsReadyForSnapshot
Retrieve 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
Retrieve 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
Retrieve relationship between a container volume and iSCSI LUNs.
getIscsiTargetIpAddresses
Retrieve returns the target IP addresses of an iSCSI volume.
getLunId
Retrieve the ID of the LUN volume.
getManualSnapshots
Retrieve the 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
Retrieve a network storage volume's metric tracking object. This object records all periodic polled data available to this volume.
getMountableFlag
Retrieve whether or not a network storage volume may be mounted.
getMoveAndSplitStatus
Retrieve 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.
getNotificationSubscribers
Retrieve the subscribers that will be notified for usage amount warnings and overages.
getObject
Retrieve a SoftLayer_Network_Storage_Iscsi record.
getObjectStorageConnectionInformation
Retrieve all object storage details for connection
getObjectsByCredential
Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object.
getOriginalSnapshotName
Retrieve the name of the snapshot that this volume was duplicated from.
getOriginalVolumeName
Retrieve the name of the volume that this volume was duplicated from.
getOriginalVolumeSize
Retrieve 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
Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.
getOsTypeId
Retrieve a volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.
getParentPartnerships
Retrieve the volumes or snapshots partnered with a network storage volume in a parental role.
getParentVolume
Retrieve the volume on which this iSCSI LUN is provisioned.
getPartnerships
Retrieve the volumes or snapshots partnered with a network storage volume.
getPermissionsGroups
Retrieve all permissions group(s) this volume is in.
getProperties
Retrieve the properties used to provide additional details about a network storage volume.
getProvisionedIops
Retrieve 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
Retrieve the iSCSI LUN volumes being replicated by this network storage volume.
getReplicatingVolume
Retrieve the network storage volume being replicated by a volume.
getReplicationEvents
Retrieve the volume replication events.
getReplicationPartners
Retrieve the network storage volumes configured to be replicants of a volume.
getReplicationSchedule
Retrieve the Replication Schedule associated with a network storage volume.
getReplicationStatus
Retrieve the current replication status of a network storage volume. Indicates Failover or Failback status.
getSchedules
Retrieve the schedules which are associated with a network storage volume.
getServiceResource
Retrieve the network resource a Storage service is connected to.
getServiceResourceBackendIpAddress
Retrieve the IP address of a Storage resource.
getServiceResourceName
Retrieve the name of a Storage's network resource.
getSnapshotCapacityGb
Retrieve a volume's configured snapshot space size.
getSnapshotCreationTimestamp
Retrieve the creation timestamp of the snapshot on the storage platform.
getSnapshotDeletionThresholdPercentage
Retrieve the percentage of used snapshot space after which to delete automated snapshots.
getSnapshotSizeBytes
Retrieve the snapshot size in bytes.
getSnapshotSpaceAvailable
Retrieve an volume's available snapshot reservation space.
getSnapshots
Retrieve the snapshots associated with this iSCSI LUN's container volume, if applicable
getSnapshotsForVolume
Retrieves a list of snapshots for a given volume.
getStorageGroups
Retrieve the network storage groups this volume is attached to.
getStorageType
Retrieve a description of the Storage object.
getTotalBytesUsed
Retrieve the amount of space used by the volume.
getTotalScheduleSnapshotRetentionCount
Retrieve the total snapshot retention count of all schedules on this network storage volume.
getUsageNotification
Retrieve the usage notification for SL Storage services.
getVendorName
Retrieve the type of network storage service.
getVirtualGuest
Retrieve when applicable, the virtual guest associated with a Storage service.
getVolumeHistory
Retrieve the username and password history for a Storage service.
getVolumeStatus
Retrieve the current status of a network storage volume.
getWebccAccount
Retrieve the account username and password for the EVault webCC interface.
getWeeklySchedule
Retrieve the Weekly Schedule which is associated with this network storage volume.
immediateFailoverToReplicant
Immediate Failover to a volume replicant.
isDuplicateReadyForSnapshot
Displays the if clone snapshots can be ordered.
isDuplicateReadyToMount
Displays the status of a clone mount.
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.
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 from multiple SoftLayer_Hardware objects.
removeAccessToReplicantFromIpAddressList
Remove access to this replica volume 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 replica volume 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.
upgradeVolumeCapacity
Edit the Storage volume to a different package
uploadFile
Upload a file to a Storage account's root directory.

/reference/services/SoftLayer_Network_Storage_Iscsi/