Cx_Exceptions

NoPartitionError	Raised when a partition is not found.
InvalidImageError	Raised when an image is not valid.
TimeoutError	Raised when a timeout has been reached.
PartitionInUseError	Raised when trying to upload to a CDB/BOOT_LOG partition that’s in use.
NoSensorError	Raised when a sensor or sensors are not found.
NoFirmwareInfoError	Raised when the firmware info cannot be obtained from a node.
IPDiscoveryError	Raised when server IP discovery fails for any reason.
CommandFailedError	Raised when a command has failed.
FirmwareConfigError	Raised when there are slot/firmware version inconsistencies.
SocmanVersionError	Raised when there is an error with the users socman version.
ImageSizeError	Raised when the actual size of the image is not what is expected.
UnknownBootCmdError	Raised when the boot command is not: run bootcmd_pxe, run bootcmd_sata, run bootcmd_mmc, setenv bootdevice, or reset.
PriorityIncrementError	Raised when the Priority on a SIMG image cannot be altered.
TransferFailure	Raised when the transfer of a file has failed.

class NoPartitionError(msg)

Bases: exceptions.Exception

Raised when a partition is not found.

>>> from cxmanage_api.cx_exceptions import NoPartitionError
>>> raise NoPartitionError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.NoPartitionError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When a partition is not found.

class InvalidImageError(msg)

Bases: exceptions.Exception

Raised when an image is not valid. (i.e. fails verification).

>>> from cxmanage_api.cx_exceptions import InvalidImageError
>>> raise InvalidImageError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.InvalidImageError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When an image is not valid. (i.e. fails verification).

class TimeoutError(msg)

Bases: exceptions.Exception

Raised when a timeout has been reached.

>>> from cxmanage_api.cx_exceptions import TimeoutError
>>> raise TimeoutError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.TimeoutError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When a timeout has been reached.

class PartitionInUseError(msg)

Bases: exceptions.Exception

Raised when trying to upload to a CDB/BOOT_LOG partition that’s in use.

>>> from cxmanage_api.cx_exceptions import PartitionInUseError
>>> raise PartitionInUseError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.PartitionInUseError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When trying to upload to a CDB/BOOT_LOG partition that’s in use.

class NoSensorError(msg)

Bases: exceptions.Exception

Raised when a sensor or sensors are not found.

>>> from cxmanage_api.cx_exceptions import NoSensorError
>>> raise NoSensorError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.NoSensorError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When a sensor or sensors are not found.

class NoFirmwareInfoError(msg)

Bases: exceptions.Exception

Raised when the firmware info cannot be obtained from a node.

>>> from cxmanage_api.cx_exceptions import NoFirmwareInfoError
>>> raise NoFirmwareInfoError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.NoFirmwareInfoError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When the firmware info cannot be obtained from a node.

class IPDiscoveryError(msg)

Bases: exceptions.Exception

Raised when server IP discovery fails for any reason.

>>> from cxmanage_api.cx_exceptions import IPDiscoveryError
>>> raise IPDiscoveryError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.IPDiscoveryError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When IP discovery fails for any reason.

class CommandFailedError(results, errors)

Bases: exceptions.Exception

Raised when a command has failed.

>>> from cxmanage_api.cx_exceptions import CommandFailedError
>>> raise CommandFailedError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.CommandFailedError: My custom exception text!

Parameters:

• results (dictionary) – Command results. (map of nodes->results)
• errors (dictionary) – Command errors. (map of nodes->errors)

Raised :

When a command has failed.

class FirmwareConfigError(msg)

Bases: exceptions.Exception

Raised when there are slot/firmware version inconsistencies.

>>> from cxmanage_api.cx_exceptions import FirmwareConfigError
>>> raise FirmwareConfigError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.FirmwareConfigError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When there are slot/firmware version inconsistencies.

class SocmanVersionError(msg)

Bases: exceptions.Exception

Raised when there is an error with the users socman version.

>>> from cxmanage_api.cx_exceptions import SocmanVersionError
>>> raise SocmanVersionError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.SocmanVersionError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When there is an error with the users socman version.

class ImageSizeError(msg)

Bases: exceptions.Exception

Raised when the actual size of the image is not what is expected.

>>> from cxmanage_api.cx_exceptions import ImageSizeError
>>> raise ImageSizeError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.ImageSizeError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When the actual size of the image is not what is expected.

class UnknownBootCmdError(msg)

Bases: exceptions.Exception

Raised when the boot command is not: run bootcmd_pxe, run bootcmd_sata,

run bootcmd_mmc, setenv bootdevice, or reset.

>>> from cxmanage_api.cx_exceptions import UnknownBootCmdError
>>> raise UnknownBootCmdError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.UnknownBootCmdError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When the boot command is not: run bootcmd_pxe, run bootcmd_sata, run bootcmd_mmc, setenv bootdevice, or reset.

class PriorityIncrementError(msg)

Bases: exceptions.Exception

Raised when the Priority on a SIMG image cannot be altered.

>>> from cxmanage_api.cx_exceptions import PriorityIncrementError
>>> raise PriorityIncrementError('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.PriorityIncrementError: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When the Priority on a SIMG image cannot be altered.

class TransferFailure(msg)

Bases: exceptions.Exception

Raised when the transfer of a file has failed.

>>> from cxmanage_api.cx_exceptions import TransferFailure
>>> raise TransferFailure('My custom exception text!')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
cxmanage_api.cx_exceptions.TransferFailure: My custom exception text!

Parameters:msg (string) – Exceptions message and details to return to the user. Raised :When the transfer of a file has failed.