solidfire.apiactual package

Module contents

Module contains objects directly mapped to the Element API. These are generated and then moved here before the API is regenerated with changes. Adaptors are used to transform actual API object into custom object and vice-versa.

class solidfire.apiactual.ApiGetScheduleResult(**kwargs)[source]

Bases: solidfire.common.model.DataObject

The object returned by the “get_schedule” API Service call.

Parameters:schedule (Schedule) – [required] The schedule attributes.
schedule = <class 'solidfire.apiactual.ApiSchedule'>
class solidfire.apiactual.ApiListSchedulesResult(**kwargs)[source]

Bases: solidfire.common.model.DataObject

The object returned by the “list_schedules” API Service call.

Parameters:schedules (Schedule) – [required] The list of schedules currently on the cluster.
schedules = <class 'solidfire.apiactual.ApiSchedule[]'>
class solidfire.apiactual.ApiModifyScheduleResult(**kwargs)[source]

Bases: solidfire.common.model.DataObject

The object returned by the “modify_schedule” API Service call.

schedule = <class 'solidfire.apiactual.ApiSchedule'>
class solidfire.apiactual.ApiSchedule(**kwargs)[source]

Bases: solidfire.common.model.DataObject

Schedule is an object containing information about each schedule created to autonomously make a snapshot of a volume. The return object includes information for all schedules. If schedule_id is used to identify a specific schedule then only information for that schedule_id is returned. Schedules information is returned with the API method, see list_schedules on the SolidFire API guide page 245.

Parameters:
  • attributes (dict) –

    [required] Indicates the frequency of the schedule occurrence.

    Valid values are:

    Day of Week

    Day of Month

    Time Interval

  • has_error (bool) – Indicates whether or not the schedule has errors.
  • hours (int) –

    [required] Shows the hours that will elapse before the next snapshot is created.

    Valid values are: 0 - 24

  • last_run_status (str) –

    Indicates the status of the last scheduled snapshot.

    Valid values are:

    Success

    Failed

  • last_run_time_started (str) –

    Indicates the last time the schedule started n ISO 8601 date string. Valid values are:

    Success

    Failed

  • minutes (int) – [required] Shows the minutes that will elapse before the next snapshot is created. Valid values are: 0 - 59
  • monthdays (int) – Shows the days of the month that the next snapshot will be created on. Valid values are: 0 - 31
  • paused (bool) – Indicates whether or not the schedule is paused.
  • recurring (bool) – Indicates whether or not the schedule is recurring.
  • run_next_interval (bool) – Indicates whether or not the schedule will run the next time the scheduler is active. When set to “true”, the schedule will run the next time the scheduler is active and then reset back to “false”.
  • schedule_id (int) – Unique ID of the schedule
  • schedule_info (ScheduleInfo) – [required] Includes the unique name given to the schedule, the retention period for the snapshot that was created, and the volume ID of the volume from which the snapshot was created.
  • schedule_name (str) – Unique name assigned to the schedule.
  • schedule_type (str) – [required] Only “snapshot” is supported at this time.
  • starting_date (str) – Indicates the date the first time the schedule began of will begin. Formatted in UTC time.
  • to_be_deleted (bool) – Indicates if the schedule is marked for deletion.
  • weekdays (Weekday) – Indicates the days of the week that a snapshot will be made.
attributes = <type 'dict'>
has_error = <type 'bool'>
hours = <type 'int'>
last_run_status = <type 'str'>
last_run_time_started = <type 'str'>
minutes = <type 'int'>
monthdays = <type 'int[]'>
paused = <type 'bool'>
recurring = <type 'bool'>
run_next_interval = <type 'bool'>
schedule_id = <type 'int'>
schedule_info = <class 'solidfire.apiactual.ApiScheduleInfo'>
schedule_name = <type 'str'>
schedule_type = <type 'str'>
starting_date = <type 'str'>
to_be_deleted = <type 'bool'>
to_json()[source]

Converts DataObject to json.

Returns:the DataObject as a json structure.
weekdays = <class 'solidfire.apiactual.ApiWeekday[]'>
class solidfire.apiactual.ApiScheduleInfo(**kwargs)[source]

Bases: solidfire.common.model.DataObject

This represents the ScheduleInfo object in the ApiSchedule class. It should not be used by users of this SDK. The ScheduleAdaptor will convert between ApiScheduleInfo and ScheduleInfo during calls. Refer to documentation about Schedule, ScheduleInfo, and Weekday for more information.

Parameters:
  • volume_id (int) – (optional) The ID of the volume to be included in the snapshot.
  • volumes (int) – (required) A list of volume ids to be included in the group snapshot.
  • name (str) – (optional) The snapshot name to be used.
  • enable_remote_replication (bool) – (optional) Indicates if the snapshot should be included in remote replication.
  • retention (str) – (optional) The amount of time the snapshot will be retained in HH:mm:ss.
enable_remote_replication = <type 'bool'>
name = <type 'str'>
retention = <type 'str'>
volume_id = <type 'int'>
volumes = <type 'int[]'>
class solidfire.apiactual.ApiWeekday(**kwargs)[source]

Bases: solidfire.common.model.DataObject

This represents the Weekday object used by the API when an ApiSchedule is setup for a Days Of Week frequency. It should not be used by users of this SDK. The ScheduleAdaptor will convert between ApiWeekday and Weekday during calls. Refer to documentation about Schedule, ScheduleInfo, and Weekday for more information.

Parameters:
  • day (int) – [required]
  • offset (int) – [required]
day = <type 'int'>
offset = <type 'int'>