Module OSCPlugin
[hide private]
[frames] | no frames]

Module OSCPlugin

source code


Copyright: Copyright (C) 2008, 2010 Oracle and/or its affiliates. All rights reserved.

License: See the file COPYING for redistribution information.

Classes [hide private]
  IPlugin
The base interface for various Storage Connect plug-in interfaces.
  IStorageArrayPlugin
Plugin interface for Storage Array management.
  IFileSystemPlugin
Plugin interface for file system management.
  IPluginException
All IPlugin exceptions inherits from IPluginException to allow for blanket exception catching.
  NoSuchOperationEx
Exception that gets raised if the call is not valid for the plugin.
  OperationFailedEx
Exception that gets raised if the operation failed.
  MissingKeyEx
Exception that gets raised if a required key is not in the record.
  ValueFormatEx
Exception that gets raised when the plugin is unable to interpret the value passed in a key.
  StorageArrayLicenseEx
Exception that gets raised if the Storage Array feature is not licensed.
  TargetDiscoveryEx
Exception that gets raised if discovery failed.
  LoginFailedEx
Exception that gets raised if the login failed.
  LogoutFailedEx
Exception that gets raised if the logout failed.
  RefreshFailedEx
Exception that gets raised if the storage array refresh failed.
  ListFailedEx
Exception that gets raised if the storage element list failed.
  CreateSnapFailedEx
Exception that gets raised if a snapshot creation has failed.
  ListSnapFailedEx
Exception that gets raised if listing snapshots failed.
  SnapRestoreNotSafeEx
Exception that gets raised if snapshot cannot safely be rolled back.
  CloneFailedEx
Exception that gets raised if a clone opertaion failed.
  InvalidStorageArrayEx
Exception that gets raised if the ss_record is invalid.
  InvalidValueEx
Exception that gets raised on an invalid value in one of the records.
  PermissionDeniedEx
Exception that gets raised if permission is denied for the operation.
  StorageElementBusyEx
Exception that gets raised when the operation is not allowed while the Storage Element is still in use.
  OperationPreReqNotMetEx
Exception that gets raised if a operation's prerequisite have not been met.
  StorageNameRequiredEx
Exception that gets raised by the validate() method if the plug-in require a storage name to be set in the ss_record.
  InvalidFSTypeEx
Exception that gets raised if the FS record file system type is invalid.
  FileSystemBusyEx
Exception that gets raised if the FS is busy.
  CommandMissingEx
Exception that gets raised if the comand is not available.
  FileSystemAlreadyMountedEx
Exception that gets raised if the FS is already mounted.
Variables [hide private]
  default_cache = OSCCache.OSCDefaultCache()
  ABILITY_TYPES = PyEnum("UNSUPPORTED = 0x00", "OFFL...
Enum representing the possible values a plugin/storage server capability can be set to.
  SE_STATES = PyEnum("UNKNOWN = 0x00", "OFFL...
Enum representing all the possible Storage Element states.
  SE_STATES_TEXT = {0: 'Unknown', 1: 'Offline', 2: 'Busy (Creati...
Dictionary used to lookup the text description associated with the state of a Storage Element.
  FS_STATES = PyEnum("UNKNOWN = 0x00", "UNMO...
Enum representing all the possible File System states.
  FS_STATES_TEXT = {0: 'Unknown', 1: 'Not mounted', 2: 'Mounted'...
Dictionary used to lookup the text description associated with the state of a File System.
  BACKING_DEVICE_TYPES = PyEnum("UNSUPPORTED = 0...
Enum representing all the possible File System states.
  BACKING_DEVICE_TYPES_TEXT = {0: 'File system creation is not s...
Dictionary used to lookup the text description associated with the state of a File System.
  __package__ = None
Variables Details [hide private]

ABILITY_TYPES

Enum representing the possible values a plugin/storage server capability can be set to.

Value:
PyEnum("UNSUPPORTED             = 0x00", "OFFLINE                 = 0x\
01", "ONLINE                  = 0x02", "NO                      = 0x04\
", "YES                     = 0x08", "INVALID                 = 0xFF",\
)

SE_STATES

Enum representing all the possible Storage Element states.

Value:
PyEnum("UNKNOWN                     = 0x00", "OFFLINE                 \
    = 0x01", "BUSY_CREATE                 = 0x02", "BUSY_CLONE        \
          = 0x03", "BUSY_COPY                   = 0x04", "BUSY_CHILDRE\
N               = 0x05", "ERROR                       = 0x06", "ONLINE\
                      = 0x07",)

SE_STATES_TEXT

Dictionary used to lookup the text description associated with the state of a Storage Element.

Value:
{0: 'Unknown',
 1: 'Offline',
 2: 'Busy (Creating)',
 3: 'Busy (Cloning)',
 4: 'Busy (Copying)',
 5: 'Busy (Have children)',
 6: 'Error',
 7: 'Online'}

FS_STATES

Enum representing all the possible File System states.

Value:
PyEnum("UNKNOWN                     = 0x00", "UNMOUNTED               \
    = 0x01", "MOUNTED                     = 0x02", "MOUNTED_READONLY  \
          = 0x03", "ERROR                       = 0x04",)

FS_STATES_TEXT

Dictionary used to lookup the text description associated with the state of a File System.

Value:
{0: 'Unknown',
 1: 'Not mounted',
 2: 'Mounted',
 3: 'Mounted Read Only',
 4: 'Error'}

BACKING_DEVICE_TYPES

Enum representing all the possible File System states.

Value:
PyEnum("UNSUPPORTED                 = 0x00", "DEVICE_SINGLE           \
    = 0x01", "DEVICE_MULTI                = 0x02", "PLUGIN_SINGLE     \
          = 0x03", "PLUGIN_MULTI                = 0x04", "INVALID     \
                = 0x05",)

BACKING_DEVICE_TYPES_TEXT

Dictionary used to lookup the text description associated with the state of a File System.

Value:
{0: 'File system creation is not supported',
 1: 'Single block device',
 2: 'Multiple block devices',
 3: 'Single plugin defined value',
 4: 'Multiple plugin defined values',
 5: 'Invalid'}