Network
SoftLayer_Network_Storage_Replicant

Overview

Local Properties

accountId

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

Type:

integer

capacityGb

A Storage account's capacity, measured in gigabytes.

Type:

integer

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:

integer

hardwareId

The server that is associated with a Storage service.

Type:

integer

hostId

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

Type:

integer

id

A Storage account's unique identifier.

Type:

integer

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:

integer

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 & Count Properties

Relational Properties can be queried by object mask
account

The account that a Storage services belongs to.

accountPassword

Other usernames and passwords associated with a Storage volume.

activeTransactionCount

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

Type:

unsignedLong

activeTransactions

The currently active transactions on a network storage volume.

allowedHardware

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

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

allowedIpAddresses

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

allowedReplicationHardware

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

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

allowedReplicationIpAddresses

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

allowedReplicationSubnetCount

A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.

Type:

unsignedLong

allowedReplicationSubnets

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

allowedReplicationVirtualGuestCount

A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

Type:

unsignedLong

allowedReplicationVirtualGuests

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

allowedSubnetCount

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

Type:

unsignedLong

allowedSubnets

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

allowedVirtualGuestCount

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

Type:

unsignedLong

allowedVirtualGuests

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

billingItem

The current billing item for this network storage replicant volume.

billingItemCategory
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

credentialCount

A count of

Type:

unsignedLong

dailySchedule

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

eventCount

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

Type:

unsignedLong

events

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

failbackInProgressFlag

When a replicant is in the process of synchronizing with the parent volume this flag will be true.

Type:

string

fileNetworkMountAddress

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

Type:

string

hardware

When applicable, the hardware associated with a Storage service.

hasEncryptionAtRest
Type:

boolean

hourlySchedule

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

iops

The maximum number of IOPs selected for this volume.

Type:

string

iscsiLunCount

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

Type:

unsignedLong

iscsiLuns

Relationship between a container volume and iSCSI LUNs.

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

lunId

The ID of the LUN volume.

Type:

string

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

manualSnapshots

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

metricTrackingObject

A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.

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

notificationSubscriberCount

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

Type:

unsignedLong

notificationSubscribers

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

originalSnapshotName

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

Type:

string

originalVolumeName

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

Type:

string

originalVolumeSize

The size (in GB) of the volume that this volume was duplicated from, or in the case of iSCSI LUNs, the size of the base originally-provisioned LUN.

Type:

string

osType

A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.

osTypeId

A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.

Type:

string

parentPartnershipCount

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

Type:

unsignedLong

parentPartnerships

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

parentVolume

The volume for which a replicant is receiving incoming data for.

partnershipCount

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

Type:

unsignedLong

partnerships

The volumes or snapshots partnered with a network storage volume.

permissionsGroupCount

A count of the permissions groups this replicant volume is in.

Type:

unsignedLong

permissionsGroups

The permissions groups this replicant volume is in.

properties

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

propertyCount

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

Type:

unsignedLong

provisionedIops

The number of IOPs provisioned for this volume.

Type:

string

replicatingLunCount

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

Type:

unsignedLong

replicatingLuns

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

replicatingVolume

The network storage volume being replicated by a volume.

replicationEventCount

A count of the volume replication events.

Type:

unsignedLong

replicationEvents

The volume replication events.

replicationPartnerCount

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

Type:

unsignedLong

replicationPartners

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

replicationSchedule

The Replication Schedule associated with a network storage volume.

replicationStatus

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

Type:

string

scheduleCount

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

Type:

unsignedLong

schedules

The schedules which are associated with a network storage volume.

serviceResource

The network resource a Storage service is connected to.

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

snapshotCount

A count of the snapshots associated with this SoftLayer_Network_Storage volume.

Type:

unsignedLong

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

snapshots

The snapshots associated with this SoftLayer_Network_Storage volume.

snapshotSizeBytes

The snapshot size in bytes.

Type:

string

snapshotSpaceAvailable

A volume's available snapshot reservation space.

Type:

string

staasVersion
Type:

string

storageGroupCount

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

Type:

unsignedLong

storageGroups

The network storage groups this volume is attached to.

storageTierLevel
Type:

string

storageType

A description of the Storage object.

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:

unsigned integer

usageNotification

The usage notification for SL Storage services.

vendorName

The type of network storage service.

Type:

string

virtualGuest

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

volumeHistory

The username and password history for a Storage service.

volumeHistoryCount

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

Type:

unsignedLong

volumeName

The volume name for a replicant.

Type:

string

volumeStatus

The current status of a network storage volume.

Type:

string

webccAccount

The account username and password for the EVault webCC interface.

weeklySchedule

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