SoftLayer Network Storage Schedule (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Network_Storage_Schedule data type. For information on the SoftLayer_Network_Storage_Schedule service please see SoftLayer_Network_Storage_Schedule.

Contents 1 Overview 2 Local Properties 2.1 active 2.2 createDate 2.3 id 2.4 modifyDate 2.5 name 2.6 partnershipId 2.7 typeId 2.8 volumeId 3 Relational Properties 3.1 events 3.2 partnership 3.3 properties 3.4 type 3.5 volume 4 Count Properties 4.1 eventCount 4.2 propertyCount

Overview

Schedules can be created for select StorageLayer services, such as iscsi. These schedules are used to perform various tasks such as scheduling snapshots or synchronizing replicants.

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

active

A flag which determines if a schedule is active.
active is required for object creation.

• Type: integer
• Length: 1 digit

---

createDate

The date a schedule was created.

• Type: dateTime

---

id

A schedule's internal identifier.

• Type: integer

---

modifyDate

The date a schedule was last modified.

• Type: dateTime

---

name

A schedule's name, for example 'Daily'.
name is required for object creation.

• Type: string
• Length: 128 characters

---

partnershipId

The partnership id which a schedule is associated with.

• Type: integer
• Length: 10 digits

---

typeId

The type id which a schedule is associated with.
typeId is required for object creation.

• Type: integer
• Length: 10 digits

---

volumeId

The volume id which a schedule is associated with.
volumeId is required for object creation.

• Type: integer
• Length: 10 digits

Relational Properties

events

Events which have been created as the result of a schedule execution.
events can be queried by object mask.

• Type: SoftLayer_Network_Storage_EventArray

---

partnership

The associated partnership for a schedule.
partnership can be queried by object mask.
partnership must be a unique value.

• Type: SoftLayer_Network_Storage_Partnership

---

properties

Properties used for configuration of a schedule.
properties can be queried by object mask.

• Type: SoftLayer_Network_Storage_Schedule_PropertyArray

---

type

The type provides a standardized definition for a schedule.
type can be queried by object mask.
type must be a unique value.

• Type: SoftLayer_Network_Storage_Schedule_Type

---

volume

The associated volume for a schedule.
volume can be queried by object mask.
volume must be a unique value.

• Type: SoftLayer_Network_Storage

Count Properties

eventCount

A count of events which have been created as the result of a schedule execution.
eventCount must be a unique value.

• Type: unsigned long

---

propertyCount

A count of properties used for configuration of a schedule.
propertyCount must be a unique value.

• Type: unsigned long