SoftLayer_Network_Storage


SoftLayer_Network_Storage

Description

The SoftLayer_Network_Storage data type contains general information regarding a Storage product such as account id, access username and password, the Storage product type, and the server the Storage service is associated with. Currently, only EVault backup storage has an associated server.

Local


accountId

The internal identifier of the SoftLayer customer account that a Storage account belongs to.
Type: int


capacityGb

A Storage account’s capacity, measured in gigabytes.
Type: int


createDate

The date a network storage volume was created.
Type: dateTime


guestId

The unique identification number of the guest associated with a Storage volume.
Type: int


hardwareId

The server that is associated with a Storage service.
Type: int


hostId

The unique identification number of the host associated with a Storage volume.
Type: int


id

A Storage account’s unique identifier.
Type: int


nasType

A Storage account’s type. Valid examples are “NAS”, “LOCKBOX”, “ISCSI”, “EVAULT”, and “HUB”.
Type: string


notes

Public notes related to a Storage volume.
Type: string


password

The password used to access a non-EVault Storage volume. This password is used to register the EVault server agent with the vault backup system.
Type: string


serviceProviderId

Service Provider ID
Type: int


storageTypeId

A storage object’s type.
Type: string


upgradableFlag

This flag indicates whether this storage type is upgradable or not.
Type: boolean


username

The username used to access a non-EVault Storage volume. This username is used to register the EVault server agent with the vault backup system.
Type: string

Relational


account

The account that a Storage services belongs to.
Type: SoftLayer_Account


accountPassword

Other usernames and passwords associated with a Storage volume.
Type: SoftLayer_Account_Password


activeTransactions

The currently active transactions on a network storage volume.
Type: SoftLayer_Provisioning_Version1_Transaction[]


allowDisasterRecoveryFailback

None
Type: string


allowDisasterRecoveryFailover

None
Type: string


allowedHardware

The SoftLayer_Hardware objects which are allowed access to this storage volume.
Type: SoftLayer_Hardware[]


allowedIpAddresses

The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
Type: SoftLayer_Network_Subnet_IpAddress[]


allowedReplicationHardware

The SoftLayer_Hardware objects which are allowed access to this storage volume’s Replicant.
Type: SoftLayer_Hardware[]


allowedReplicationIpAddresses

The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume’s Replicant.
Type: SoftLayer_Network_Subnet_IpAddress[]


allowedReplicationSubnets

The SoftLayer_Network_Subnet objects which are allowed access to this storage volume’s Replicant.
Type: SoftLayer_Network_Subnet[]


allowedReplicationVirtualGuests

The SoftLayer_Hardware objects which are allowed access to this storage volume’s Replicant.
Type: SoftLayer_Virtual_Guest[]


allowedSubnets

The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
Type: SoftLayer_Network_Subnet[]


allowedVirtualGuests

The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
Type: SoftLayer_Virtual_Guest[]


billingItem

The current billing item for a Storage volume.
Type: SoftLayer_Billing_Item


bytesUsed

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


creationScheduleId

The schedule id which was executed to create a snapshot.
Type: string


dailySchedule

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


dependentDuplicate

Whether or not a network storage volume is a dependent duplicate.
Type: string


dependentDuplicates

The network storage volumes configured to be dependent duplicates of a volume.
Type: SoftLayer_Network_Storage[]


events

The events which have taken place on a network storage volume.
Type: SoftLayer_Network_Storage_Event[]


failbackNotAllowed

Determines whether the volume is allowed to failback
Type: string


failoverNotAllowed

Determines whether the volume is allowed to failover
Type: string


fileNetworkMountAddress

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


fixReplicationCurrentStatus

None
Type: string


hardware

When applicable, the hardware associated with a Storage service.
Type: SoftLayer_Hardware


hasEncryptionAtRest

None
Type: boolean


hourlySchedule

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


intervalSchedule

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


iops

The maximum number of IOPs selected for this volume.
Type: string


isConvertToIndependentTransactionInProgress

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


isDependentDuplicateProvisionCompleted

Determines whether dependent volume provision is completed on background.
Type: boolean


isInDedicatedServiceResource

None
Type: boolean


isMagneticStorage

None
Type: string


isProvisionInProgress

Determines whether network storage volume has an active provision transaction.
Type: boolean


isReadyForSnapshot

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.
Type: boolean


isReadyToMount

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.
Type: boolean


iscsiLuns

Relationship between a container volume and iSCSI LUNs.
Type: SoftLayer_Network_Storage[]


iscsiReplicatingVolume

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


iscsiTargetIpAddresses

Returns the target IP addresses of an iSCSI volume.
Type: string[]


lunId

The ID of the LUN volume.
Type: string


manualSnapshots

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


metricTrackingObject

A network storage volume’s metric tracking object. This object records all periodic polled data available to this volume.
Type: SoftLayer_Metric_Tracking_Object


mountPath

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


mountableFlag

Whether or not a network storage volume may be mounted.
Type: string


moveAndSplitStatus

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


notificationSubscribers

The subscribers that will be notified for usage amount warnings and overages.
Type: SoftLayer_Notification_User_Subscriber[]


originalSnapshotName

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


originalVolumeId

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


originalVolumeName

The name of the volume that this volume was duplicated from.
Type: string


originalVolumeSize

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: string


osType

A volume’s configured SoftLayer_Network_Storage_Iscsi_OS_Type.
Type: SoftLayer_Network_Storage_Iscsi_OS_Type


osTypeId

A volume’s configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.
Type: string


parentPartnerships

The volumes or snapshots partnered with a network storage volume in a parental role.
Type: SoftLayer_Network_Storage_Partnership[]


parentVolume

The parent volume of a volume in a complex storage relationship.
Type: SoftLayer_Network_Storage


partnerships

The volumes or snapshots partnered with a network storage volume.
Type: SoftLayer_Network_Storage_Partnership[]


permissionsGroups

All permissions group(s) this volume is in.
Type: SoftLayer_Network_Storage_Group[]


properties

The properties used to provide additional details about a network storage volume.
Type: SoftLayer_Network_Storage_Property[]


provisionedIops

The number of IOPs provisioned for this volume.
Type: string


replicatingLuns

The iSCSI LUN volumes being replicated by this network storage volume.
Type: SoftLayer_Network_Storage[]


replicatingVolume

The network storage volume being replicated by a volume.
Type: SoftLayer_Network_Storage


replicationEvents

The volume replication events.
Type: SoftLayer_Network_Storage_Event[]


replicationPartners

The network storage volumes configured to be replicants of a volume.
Type: SoftLayer_Network_Storage[]


replicationSchedule

The Replication Schedule associated with a network storage volume.
Type: SoftLayer_Network_Storage_Schedule


replicationStatus

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


schedules

The schedules which are associated with a network storage volume.
Type: SoftLayer_Network_Storage_Schedule[]


serviceResource

The network resource a Storage service is connected to.
Type: SoftLayer_Network_Service_Resource


serviceResourceBackendIpAddress

The IP address of a Storage resource.
Type: string


serviceResourceName

The name of a Storage’s network resource.
Type: string


snapshotCapacityGb

A volume’s configured snapshot space size.
Type: string


snapshotCreationTimestamp

The creation timestamp of the snapshot on the storage platform.
Type: string


snapshotDeletionThresholdPercentage

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


snapshotNotificationStatus

Whether or not a network storage volume may be mounted.
Type: string


snapshotSizeBytes

The snapshot size in bytes.
Type: string


snapshotSpaceAvailable

A volume’s available snapshot reservation space.
Type: string


snapshots

The snapshots associated with this SoftLayer_Network_Storage volume.
Type: SoftLayer_Network_Storage[]


staasVersion

None
Type: string


storageGroups

The network storage groups this volume is attached to.
Type: SoftLayer_Network_Storage_Group[]


storageTierLevel

None
Type: string


storageType

A description of the Storage object.
Type: SoftLayer_Network_Storage_Type


totalBytesUsed

The amount of space used by the volume.
Type: string


totalScheduleSnapshotRetentionCount

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


usageNotification

The usage notification for SL Storage services.
Type: SoftLayer_Notification


vendorName

The type of network storage service.
Type: string


virtualGuest

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


volumeHistory

The username and password history for a Storage service.
Type: SoftLayer_Network_Storage_History[]


volumeStatus

The current status of a network storage volume.
Type: string


webccAccount

The account username and password for the EVault webCC interface.
Type: SoftLayer_Account_Password


weeklySchedule

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

Count


activeTransactionCount

A count of the currently active transactions on a network storage volume.
Type: unsignedLong


allowedHardwareCount

A count of the SoftLayer_Hardware objects which are allowed access to this storage volume.
Type: unsignedLong


allowedIpAddressCount

A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
Type: unsignedLong


allowedReplicationHardwareCount

A count of the SoftLayer_Hardware objects which are allowed access to this storage volume’s Replicant.
Type: unsignedLong


allowedReplicationIpAddressCount

A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume’s Replicant.
Type: unsignedLong


allowedReplicationSubnetCount

A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume’s Replicant.
Type: unsignedLong


allowedReplicationVirtualGuestCount

A count of the SoftLayer_Hardware objects which are allowed access to this storage volume’s Replicant.
Type: unsignedLong


allowedSubnetCount

A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
Type: unsignedLong


allowedVirtualGuestCount

A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
Type: unsignedLong


credentialCount

A count of
Type: unsignedLong


dependentDuplicateCount

A count of the network storage volumes configured to be dependent duplicates of a volume.
Type: unsignedLong


eventCount

A count of the events which have taken place on a network storage volume.
Type: unsignedLong


iscsiLunCount

A count of relationship between a container volume and iSCSI LUNs.
Type: unsignedLong


iscsiTargetIpAddressCount

A count of returns the target IP addresses of an iSCSI volume.
Type: unsignedLong


manualSnapshotCount

A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.
Type: unsignedLong


notificationSubscriberCount

A count of the subscribers that will be notified for usage amount warnings and overages.
Type: unsignedLong


parentPartnershipCount

A count of the volumes or snapshots partnered with a network storage volume in a parental role.
Type: unsignedLong


partnershipCount

A count of the volumes or snapshots partnered with a network storage volume.
Type: unsignedLong


permissionsGroupCount

A count of all permissions group(s) this volume is in.
Type: unsignedLong


propertyCount

A count of the properties used to provide additional details about a network storage volume.
Type: unsignedLong


replicatingLunCount

A count of the iSCSI LUN volumes being replicated by this network storage volume.
Type: unsignedLong


replicationEventCount

A count of the volume replication events.
Type: unsignedLong


replicationPartnerCount

A count of the network storage volumes configured to be replicants of a volume.
Type: unsignedLong


scheduleCount

A count of the schedules which are associated with a network storage volume.
Type: unsignedLong


snapshotCount

A count of the snapshots associated with this SoftLayer_Network_Storage volume.
Type: unsignedLong


storageGroupCount

A count of the network storage groups this volume is attached to.
Type: unsignedLong


volumeHistoryCount

A count of the username and password history for a Storage service.
Type: unsignedLong