Package com.softlayer.api.service.network.storage

Interface Iscsi.Service

All Superinterfaces:

Maskable, ResultLimitable, Service, Storage.Service

Enclosing class:

Iscsi

@ApiService("SoftLayer_Network_Storage_Iscsi")
public static interface Iscsi.Service
extends Storage.Service

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.

See Also:

SoftLayer_Network_Storage_Iscsi

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	allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate)	This method is used to modify the access control list for this Storage volume.
Boolean	allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)	This method is used to modify the access control list for this Storage volume.
Boolean	allowAccessToReplicantFromHardwareListForIscsi(List<Hardware> hardwareObjectTemplates)	This method is used to modify the access control list for this Storage replica volume.
Boolean	allowAccessToReplicantFromIpAddressListForIscsi(List<IpAddress> ipAddressObjectTemplates)	This method is used to modify the access control list for this Storage volume.
Boolean	allowAccessToReplicantFromVirtualGuestListForIscsi(List<Guest> virtualGuestObjectTemplates)	This method is used to modify the access control list for this Storage volume.
Iscsi.ServiceAsync	asAsync()	Get an async version of this service
Property	createOrUpdateLunId(Long lunId)	The LUN ID only takes effect during the Host Authorization process.
Long	getMaximumExpansionSizeForIscsi()
Iscsi	getObjectForIscsi()
List<Storage>	getSnapshotsForVolumeForIscsi()	Retrieves a list of snapshots for this SoftLayer_Network_Storage volume.
Boolean	removeAccessFromHardware(Hardware hardwareObjectTemplate)	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	removeAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)	This method is used to modify the access control list for this Storage volume.
Boolean	removeAccessToReplicantFromHardwareListForIscsi(List<Hardware> hardwareObjectTemplates)	This method is used to modify the access control list for this Storage replica volume.
Boolean	removeAccessToReplicantFromIpAddressListForIscsi(List<IpAddress> ipAddressObjectTemplates)	This method is used to modify the access control list for this Storage replica volume.
Boolean	removeAccessToReplicantFromVirtualGuestListForIscsi(List<Guest> virtualGuestObjectTemplates)	This method is used to modify the access control list for this Storage replica volume.
void	setMask(Iscsi.Mask mask)
Iscsi.Mask	withMask()	Use the existing mask on this service or create it if not present
Iscsi.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Methods inherited from interface com.softlayer.api.service.network.Storage.Service

allowAccessFromHardwareList, allowAccessFromHost, allowAccessFromHostList, allowAccessFromIpAddressList, allowAccessFromSubnet, allowAccessFromSubnetList, allowAccessFromVirtualGuestList, allowAccessToReplicantFromHardware, allowAccessToReplicantFromHardwareList, allowAccessToReplicantFromIpAddress, allowAccessToReplicantFromIpAddressList, allowAccessToReplicantFromSubnet, allowAccessToReplicantFromSubnetList, allowAccessToReplicantFromVirtualGuest, allowAccessToReplicantFromVirtualGuestList, assignCredential, assignNewCredential, changePassword, collectBandwidth, collectBytesUsed, convertCloneDependentToIndependent, createFolder, createSnapshot, deleteAllFiles, deleteFile, deleteFiles, deleteFolder, deleteObject, disableSnapshots, downloadFile, editCredential, editObject, enableSnapshots, failbackFromReplicant, failoverToReplicant, getAccount, getAccountPassword, getActiveTransactions, getAllFiles, getAllFilesByFilter, getAllowableHardware, getAllowableIpAddresses, getAllowableSubnets, getAllowableVirtualGuests, getAllowedHardware, getAllowedHostsLimit, getAllowedIpAddresses, getAllowedReplicationHardware, getAllowedReplicationIpAddresses, getAllowedReplicationSubnets, getAllowedReplicationVirtualGuests, getAllowedSubnets, getAllowedVirtualGuests, getBillingItem, getBillingItemCategory, getBytesUsed, getByUsername, getCdnUrls, getClusterResource, getCreationScheduleId, getCredentials, getDailySchedule, getDependentDuplicate, getDependentDuplicates, getEvents, getFileBlockEncryptedLocations, getFileByIdentifier, getFileCount, getFileList, getFileNetworkMountAddress, getFilePendingDeleteCount, getFilesPendingDelete, getFolderList, getGraph, getHardware, getHasEncryptionAtRest, getHourlySchedule, getIntervalSchedule, getIops, getIscsiLuns, getIscsiTargetIpAddresses, getIsDependentDuplicateProvisionCompleted, getIsReadyForSnapshot, getIsReadyToMount, getLunId, getManualSnapshots, getMaximumExpansionSize, getMetricTrackingObject, getMountableFlag, getMoveAndSplitStatus, getNetworkConnectionDetails, getNetworkMountAddress, getNotificationSubscribers, getObject, getObjectsByCredential, getObjectStorageConnectionInformation, getOriginalSnapshotName, getOriginalVolumeName, getOriginalVolumeSize, getOsType, getOsTypeId, getParentPartnerships, getParentVolume, getPartnerships, getPermissionsGroups, getProperties, getProvisionedIops, getRecycleBinFileByIdentifier, getRemainingAllowedHosts, getRemainingAllowedHostsForReplicant, getReplicatingLuns, getReplicatingVolume, getReplicationEvents, getReplicationPartners, getReplicationSchedule, getReplicationStatus, getSchedules, getServiceResource, getServiceResourceBackendIpAddress, getServiceResourceName, getSnapshotCapacityGb, getSnapshotCreationTimestamp, getSnapshotDeletionThresholdPercentage, getSnapshots, getSnapshotsForVolume, getSnapshotSizeBytes, getSnapshotSpaceAvailable, getStaasVersion, getStorageGroups, getStorageGroupsNetworkConnectionDetails, getStorageTierLevel, getStorageType, getTargetIpAddresses, getTotalBytesUsed, getTotalScheduleSnapshotRetentionCount, getUsageNotification, getValidReplicationTargetDatacenterLocations, getVendorName, getVirtualGuest, getVolumeCountLimits, getVolumeDuplicateParameters, getVolumeHistory, getVolumeStatus, getWebccAccount, getWeeklySchedule, immediateFailoverToReplicant, isBlockingOperationInProgress, isDuplicateReadyForSnapshot, isDuplicateReadyToMount, isVolumeActive, refreshDependentDuplicate, refreshDuplicate, removeAccessFromHardwareList, removeAccessFromHost, removeAccessFromHostList, removeAccessFromIpAddressList, removeAccessFromSubnet, removeAccessFromSubnetList, removeAccessFromVirtualGuestList, removeAccessToReplicantFromHardwareList, removeAccessToReplicantFromIpAddressList, removeAccessToReplicantFromSubnet, removeAccessToReplicantFromSubnetList, removeAccessToReplicantFromVirtualGuestList, removeCredential, restoreFile, restoreFromSnapshot, sendPasswordReminderEmail, setMask, setMountable, setSnapshotAllocation, upgradeVolumeCapacity, uploadFile

Method Details

asAsync

Iscsi.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

Specified by:

asAsync in interface Storage.Service

withNewMask

Iscsi.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 interface Maskable

Specified by:

withNewMask in interface Storage.Service

withMask

Iscsi.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

Specified by:

withMask in interface Storage.Service

setMask

void setMask(Iscsi.Mask mask)

allowAccessFromHardware

@ApiMethod(instanceRequired=true) Boolean allowAccessFromHardware(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.

Specified by:

allowAccessFromHardware in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::allowAccessFromHardware

allowAccessFromIpAddress

@ApiMethod(instanceRequired=true) Boolean allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate)

Description copied from interface: Storage.Service

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.

Specified by:

allowAccessFromIpAddress in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::allowAccessFromIpAddress

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.

Specified by:

allowAccessFromVirtualGuest in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::allowAccessFromVirtualGuest

allowAccessToReplicantFromHardwareListForIscsi

@ApiMethod(value="allowAccessToReplicantFromHardwareList", instanceRequired=true) Boolean allowAccessToReplicantFromHardwareListForIscsi(List<Hardware> hardwareObjectTemplates)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume.

See Also:

SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromHardwareList

allowAccessToReplicantFromIpAddressListForIscsi

@ApiMethod(value="allowAccessToReplicantFromIpAddressList", instanceRequired=true) Boolean allowAccessToReplicantFromIpAddressListForIscsi(List<IpAddress> ipAddressObjectTemplates)

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 allowedVirtualGuests property of this storage volume.

See Also:

SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromIpAddressList

allowAccessToReplicantFromVirtualGuestListForIscsi

@ApiMethod(value="allowAccessToReplicantFromVirtualGuestList", instanceRequired=true) Boolean allowAccessToReplicantFromVirtualGuestListForIscsi(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.

See Also:

SoftLayer_Network_Storage_Iscsi::allowAccessToReplicantFromVirtualGuestList

createOrUpdateLunId

@ApiMethod(instanceRequired=true) Property createOrUpdateLunId(Long lunId)

The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.

Specified by:

createOrUpdateLunId in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::createOrUpdateLunId

getMaximumExpansionSizeForIscsi

@ApiMethod(value="getMaximumExpansionSize", instanceRequired=true) Long getMaximumExpansionSizeForIscsi()

See Also:

SoftLayer_Network_Storage_Iscsi::getMaximumExpansionSize

getObjectForIscsi

@ApiMethod(value="getObject", instanceRequired=true) Iscsi getObjectForIscsi()

See Also:

SoftLayer_Network_Storage_Iscsi::getObject

getSnapshotsForVolumeForIscsi

@ApiMethod(value="getSnapshotsForVolume", instanceRequired=true) List<Storage> getSnapshotsForVolumeForIscsi()

Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination.

See Also:

SoftLayer_Network_Storage_Iscsi::getSnapshotsForVolume

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.

Specified by:

removeAccessFromHardware in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::removeAccessFromHardware

removeAccessFromIpAddress

@ApiMethod(instanceRequired=true) Boolean removeAccessFromIpAddress(IpAddress ipAddressObjectTemplate)

Description copied from interface: Storage.Service

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.

Specified by:

removeAccessFromIpAddress in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::removeAccessFromIpAddress

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.

Specified by:

removeAccessFromVirtualGuest in interface Storage.Service

See Also:

SoftLayer_Network_Storage_Iscsi::removeAccessFromVirtualGuest

removeAccessToReplicantFromHardwareListForIscsi

@ApiMethod(value="removeAccessToReplicantFromHardwareList", instanceRequired=true) Boolean removeAccessToReplicantFromHardwareListForIscsi(List<Hardware> hardwareObjectTemplates)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume.

See Also:

SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromHardwareList

removeAccessToReplicantFromIpAddressListForIscsi

@ApiMethod(value="removeAccessToReplicantFromIpAddressList", instanceRequired=true) Boolean removeAccessToReplicantFromIpAddressListForIscsi(List<IpAddress> ipAddressObjectTemplates)

This method is used to modify the access control list for this Storage replica 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 replica volume.

See Also:

SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromIpAddressList

removeAccessToReplicantFromVirtualGuestListForIscsi

@ApiMethod(value="removeAccessToReplicantFromVirtualGuestList", instanceRequired=true) Boolean removeAccessToReplicantFromVirtualGuestListForIscsi(List<Guest> virtualGuestObjectTemplates)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replica volume.

See Also:

SoftLayer_Network_Storage_Iscsi::removeAccessToReplicantFromVirtualGuestList