SoftLayer Network Storage Backup Evault Version6

From SoftLayer Development Network Wiki

Contents 1 Overview 2 User Access 3 Local Properties 3.1 accountId 3.2 capacityGb 3.3 createDate 3.4 hardwareId 3.5 id 3.6 notes 3.7 password 3.8 username 4 Relational Properties 4.1 account 4.2 accountPassword 4.3 agentStatuses 4.4 backupJobDetails 4.5 billingItem 4.6 events 4.7 hardware 4.8 mountableFlag 4.9 notificationSubscribers 4.10 parentPartnerships 4.11 partnerships 4.12 pluginBillingItems 4.13 properties 4.14 restoreJobDetails 4.15 schedules 4.16 serviceResource 4.17 serviceResourceBackendIpAddress 4.18 serviceResourceName 4.19 softwareComponent 4.20 tasks 4.21 totalBytesUsed 4.22 usageNotification 4.23 volumeHistory 4.24 webccAccount 5 Count Properties 5.1 agentStatusCount 5.2 backupJobDetailCount 5.3 eventCount 5.4 notificationSubscriberCount 5.5 parentPartnershipCount 5.6 partnershipCount 5.7 pluginBillingItemCount 5.8 propertyCount 5.9 restoreJobDetailCount 5.10 scheduleCount 5.11 taskCount 5.12 volumeHistoryCount 6 Associated Methods

Overview

The SoftLayer_Network_Storage_Backup_Evault_Version6 contains the same properties as the SoftLayer_Network_Storage_Backup_Evault. Additional properties available for the EVault StorageLayer type: softwareComponent, totalBytesUsed, backupJobDetails, restoreJobDetails and agentStatuses

User Access

Users wishing to access the SoftLayer_Network_Storage_Backup_Evault_Version6 type must have the Manage NAS permission assigned to their account.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

accountId

The associated account id for the StorageLayer account.
accountId is required for object creation.

• Type: integer
• Length: 10 digits

---

capacityGb

The capacity, in gigabytes, for the StorageLayer account.

• Type: integer
• Length: 5 digits

---

createDate

The date a network storage volume was created.

• Type: dateTime

---

hardwareId

The server that is associated with the StorageLayer service.

• Type: integer
• Length: 10 digits

---

id

Unique ID for the StorageLayer account.

• Type: integer

---

notes

Any Notes related to the StorageLayer service.

• Type: string
• Length: 400 characters

---

password

The password used to access the StorageLayer volume except for EVault. The password is used to register the EVault server agent with the vault.

• Type: string
• Length: 20 characters

---

username

The username used to access the StorageLayer volume except for EVault. The username is used to register the EVault Server agent with the vault.

• Type: string
• Length: 100 characters

Relational Properties

account

The account that the StorageLayer services belongs to.
account can be queried by object mask.
account must be a unique value.

• Type: SoftLayer_Account

---

accountPassword

Other usernames and passwords associated with the StorageLayer volume.
accountPassword can be queried by object mask.
accountPassword must be a unique value.

• Type: SoftLayer_Account_Password

---

agentStatuses

Statuses (most of the time will be one status) for the agent tied to the EVault Storagelayer services.
agentStatuses can be queried by object mask.

• Type: SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatusArray

---

backupJobDetails

All the of the backup jobs for the EVault StorageLayer account.
backupJobDetails can be queried by object mask.

• Type: SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetailsArray

---

billingItem

The current billing item for the StorageLayer volume.
billingItem can be queried by object mask.
billingItem must be a unique value.

• Type: SoftLayer_Billing_Item

---

events

Events which have taken place on a network storage volume.
events can be queried by object mask.

• Type: SoftLayer_Network_Storage_EventArray

---

hardware

When applicable, the hardware associated with the StorageLayer service.
hardware can be queried by object mask.
hardware must be a unique value.

• Type: SoftLayer_Hardware

---

mountableFlag

Determines whether or not the network storage volume may be mounted.
mountableFlag can be queried by object mask.
mountableFlag must be a unique value.

• Type: string

---

notificationSubscribers

The subscribers that will be notified for usage amount warnings and overages.
notificationSubscribers can be queried by object mask.

• Type: SoftLayer_Notification_User_SubscriberArray

---

parentPartnerships

The volumes or snapshots partnered with a network storage volume in a parental role.
parentPartnerships can be queried by object mask.

• Type: SoftLayer_Network_Storage_PartnershipArray

---

partnerships

The volumes or snapshots partnered with a network storage volume.
partnerships can be queried by object mask.

• Type: SoftLayer_Network_Storage_PartnershipArray

---

pluginBillingItems

The billing items for plugins tied to the EVault StorageLayer service.
pluginBillingItems can be queried by object mask.

• Type: SoftLayer_Billing_ItemArray

---

properties

Properties used to provide additional details about a network storage volume.
properties can be queried by object mask.

• Type: SoftLayer_Network_Storage_PropertyArray

---

restoreJobDetails

All the of the restore jobs for the EVault StorageLayer account.
restoreJobDetails can be queried by object mask.

• Type: SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetailsArray

---

schedules

Schedules which are associated with a network storage volume.
schedules can be queried by object mask.

• Type: SoftLayer_Network_Storage_ScheduleArray

---

serviceResource

The resource the StorageLayer service is connect to.
serviceResource can be queried by object mask.
serviceResource must be a unique value.

• Type: SoftLayer_Network_Service_Resource

---

serviceResourceBackendIpAddress

The IP address of the StorageLayer's resource.
serviceResourceBackendIpAddress must be a unique value.

• Type: string

---

serviceResourceName

The name of the StorageLayer's resource.
serviceResourceName must be a unique value.

• Type: string

---

softwareComponent

The software component for the EVault base client.
softwareComponent can be queried by object mask.
softwareComponent must be a unique value.

• Type: SoftLayer_Software_Component

---

tasks

Retrieve the task information for the EVault StorageLayer service.
tasks can be queried by object mask.

• Type: SoftLayer_Container_Network_Storage_Evault_Vault_TaskArray

---

totalBytesUsed

Number of bytes used in the vault.
totalBytesUsed can be queried by object mask.
totalBytesUsed must be a unique value.

• Type: unsigned long

---

usageNotification

The usage notification for SL StorageLayer services.
usageNotification can be queried by object mask.
usageNotification must be a unique value.

• Type: SoftLayer_Notification

---

volumeHistory

The username/password history for the StorageLayer service.
volumeHistory can be queried by object mask.

• Type: SoftLayer_Network_Storage_HistoryArray

---

webccAccount

The account username and password for the webCC interface (EVault).
webccAccount can be queried by object mask.
webccAccount must be a unique value.

• Type: SoftLayer_Account_Password

Count Properties

agentStatusCount

A count of statuses (most of the time will be one status) for the agent tied to the EVault Storagelayer services.
agentStatusCount must be a unique value.

• Type: unsigned long

---

backupJobDetailCount

A count of all the of the backup jobs for the EVault StorageLayer account.
backupJobDetailCount must be a unique value.

• Type: unsigned long

---

eventCount

A count of events which have taken place on a network storage volume.
eventCount must be a unique value.

• Type: unsigned long

---

notificationSubscriberCount

A count of the subscribers that will be notified for usage amount warnings and overages.
notificationSubscriberCount must be a unique value.

• Type: unsigned long

---

parentPartnershipCount

A count of the volumes or snapshots partnered with a network storage volume in a parental role.
parentPartnershipCount must be a unique value.

• Type: unsigned long

---

partnershipCount

A count of the volumes or snapshots partnered with a network storage volume.
partnershipCount must be a unique value.

• Type: unsigned long

---

pluginBillingItemCount

A count of the billing items for plugins tied to the EVault StorageLayer service.
pluginBillingItemCount must be a unique value.

• Type: unsigned long

---

propertyCount

A count of properties used to provide additional details about a network storage volume.
propertyCount must be a unique value.

• Type: unsigned long

---

restoreJobDetailCount

A count of all the of the restore jobs for the EVault StorageLayer account.
restoreJobDetailCount must be a unique value.

• Type: unsigned long

---

scheduleCount

A count of schedules which are associated with a network storage volume.
scheduleCount must be a unique value.

• Type: unsigned long

---

taskCount

A count of retrieve the task information for the EVault StorageLayer service.
taskCount must be a unique value.

• Type: unsigned long

---

volumeHistoryCount

A count of the username/password history for the StorageLayer service.
volumeHistoryCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_Account::getObject