sushy.resources.manager package¶
Submodules¶
sushy.resources.manager.constants module¶
-
class
sushy.resources.manager.constants.
CommandConnectType
¶ Bases:
enum.Enum
Command Shell constants
-
IPMI
= 'IPMI'¶ The controller supports a command shell connection through the IPMI Serial Over LAN (SOL) protocol.
-
OEM
= 'Oem'¶ The controller supports a command shell connection through an OEM- specific protocol.
-
SSH
= 'SSH'¶ The controller supports a command shell connection through the SSH protocol.
-
TELNET
= 'Telnet'¶ The controller supports a command shell connection through the Telnet protocol.
-
-
class
sushy.resources.manager.constants.
ConnectedVia
¶ Bases:
enum.Enum
Connected Via constants
-
APPLET
= 'Applet'¶ Connected to a client application.
-
NOT_CONNECTED
= 'NotConnected'¶ No current connection.
-
OEM
= 'Oem'¶ Connected through an OEM-defined method.
-
URI
= 'URI'¶ Connected to a URI location.
-
-
class
sushy.resources.manager.constants.
GraphicalConnectType
¶ Bases:
enum.Enum
Graphical Console constants
-
KVMIP
= 'KVMIP'¶ The controller supports a graphical console connection through a KVM- IP (redirection of Keyboard, Video, Mouse over IP) protocol.
-
OEM
= 'Oem'¶ The controller supports a graphical console connection through an OEM-specific protocol.
-
-
class
sushy.resources.manager.constants.
ManagerType
¶ Bases:
enum.Enum
Manager Type constants
-
AUXILIARY_CONTROLLER
= 'AuxiliaryController'¶ A controller that provides management functions for a particular subsystem or group of devices.
-
BMC
= 'BMC'¶ A controller that provides management functions for a single computer system.
-
ENCLOSURE_MANAGER
= 'EnclosureManager'¶ A controller that provides management functions for a chassis or group of devices or systems.
-
MANAGEMENT_CONTROLLER
= 'ManagementController'¶ A controller that primarily monitors or manages the operation of a device or system.
-
RACK_MANAGER
= 'RackManager'¶ A controller that provides management functions for a whole or part of a rack.
-
SERVICE
= 'Service'¶ A software-based service that provides management functions.
-
-
sushy.resources.manager.constants.
RESET_MANAGER_FORCE_RESTART
= <ResetType.FORCE_RESTART: 'ForceRestart'>¶ Perform an immediate (non-graceful) shutdown, followed by a restart
-
sushy.resources.manager.constants.
RESET_MANAGER_GRACEFUL_RESTART
= <ResetType.GRACEFUL_RESTART: 'GracefulRestart'>¶ Perform a graceful shutdown followed by a restart of the system
-
class
sushy.resources.manager.constants.
SerialConnectType
¶ Bases:
enum.Enum
Serial Console constants
-
IPMI
= 'IPMI'¶ The controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol.
-
OEM
= 'Oem'¶ The controller supports a serial console connection through an OEM- specific protocol.
-
SSH
= 'SSH'¶ The controller supports a serial console connection through the SSH protocol.
-
TELNET
= 'Telnet'¶ The controller supports a serial console connection through the Telnet protocol.
-
sushy.resources.manager.manager module¶
-
class
sushy.resources.manager.manager.
ActionsField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
reset
= <sushy.resources.common.ResetActionField object>¶
-
-
class
sushy.resources.manager.manager.
Manager
(connector, identity, redfish_version=None, registries=None, root=None)¶ Bases:
sushy.resources.base.ResourceBase
-
auto_dst_enabled
= <sushy.resources.base.Field object>¶ Indicates whether the manager is configured for automatic DST adjustment
-
property
chassis
¶ A list of chassis managed by this manager.
Returns a list of Chassis objects representing the chassis or cabinets managed by this manager.
- Raises
MissingAttributeError if ‘@odata.id’ field is missing.
- Returns
A list of Chassis instances
-
command_shell
= <sushy.resources.manager.manager.RemoteAccessField object>¶ A dictionary containing the remote access support service via command shell (e.g. Telnet, SSH) and max concurrent sessions
-
description
= <sushy.resources.base.Field object>¶ The manager description
-
firmware_version
= <sushy.resources.base.Field object>¶ The manager firmware version
-
get_allowed_reset_manager_values
()¶ Get the allowed values for resetting the manager.
- Returns
A set of allowed values.
- Raises
MissingAttributeError, if Actions/#Manager.Reset attribute not present.
-
get_supported_command_shell_types
()¶ Get the supported values for Command Shell connection types.
- Returns
A set of supported values.
-
get_supported_graphical_console_types
()¶ Get the supported values for Graphical Console connection types.
- Returns
A set of supported values.
-
get_supported_serial_console_types
()¶ Get the supported values for Serial Console connection types.
- Returns
A set of supported values.
-
graphical_console
= <sushy.resources.manager.manager.RemoteAccessField object>¶ A dictionary containing the remote access support service via graphical console (e.g. KVMIP) and max concurrent sessions
-
identity
= <sushy.resources.base.Field object>¶ The manager identity string
-
manager_type
= <sushy.resources.base.MappedField object>¶ The manager type
-
model
= <sushy.resources.base.Field object>¶ The manager model
-
name
= <sushy.resources.base.Field object>¶ The manager name
-
reset_manager
(value)¶ Reset the manager.
- Parameters
value – The target value.
- Raises
InvalidParameterValueError, if the target value is not allowed.
-
serial_console
= <sushy.resources.manager.manager.RemoteAccessField object>¶ A dictionary containing the remote access support service via serial console (e.g. Telnet, SSH, IPMI) and max concurrent sessions
-
property
systems
¶ A list of systems managed by this manager.
Returns a list of System objects representing systems being managed by this manager.
- Raises
MissingAttributeError if ‘@odata.id’ field is missing.
- Returns
A list of System instances
-
uuid
= <sushy.resources.base.Field object>¶ The manager UUID
-
property
virtual_media
¶
-
-
class
sushy.resources.manager.manager.
ManagerCollection
(connector, path, redfish_version=None, registries=None, root=None)¶
-
class
sushy.resources.manager.manager.
RemoteAccessField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
connect_types_supported
= <sushy.resources.base.Field object>¶
-
max_concurrent_sessions
= <sushy.resources.base.Field object>¶
-
service_enabled
= <sushy.resources.base.Field object>¶
-
sushy.resources.manager.virtual_media module¶
-
class
sushy.resources.manager.virtual_media.
ActionsField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
eject_media
= <sushy.resources.common.ActionField object>¶
-
insert_media
= <sushy.resources.common.ActionField object>¶
-
-
class
sushy.resources.manager.virtual_media.
VirtualMedia
(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)¶ Bases:
sushy.resources.base.ResourceBase
-
property
certificates
¶ Get the collection of certificates for this device.
-
connected_via
= <sushy.resources.base.MappedField object>¶ Current virtual media connection methods
Applet: Connected to a client application NotConnected: No current connection Oem: Connected via an OEM-defined method URI: Connected to a URI location
-
eject_media
()¶ Detach remote media from virtual media
After ejecting media inserted will be False and image_name will be empty.
-
identity
= <sushy.resources.base.Field object>¶ Virtual Media resource identity string
-
image
= <sushy.resources.base.Field object>¶ A URI providing the location of the selected image
-
image_name
= <sushy.resources.base.Field object>¶ The image name
-
insert_media
(image, inserted=True, write_protected=True, username=None, password=None, transfer_method=None)¶ Attach remote media to virtual media
- Parameters
image – a URI providing the location of the selected image
inserted – specify if the image is to be treated as inserted upon completion of the action.
write_protected – indicates the media is write protected
username – User name for the image URI.
password – Password for the image URI.
transfer_method – Transfer method (stream or upload) to use for the image.
-
inserted
= <sushy.resources.base.Field object>¶ Indicates if virtual media is inserted in the virtual device
-
is_transfer_method_required
(error=None)¶ Check the response code and body and in case of failure
Try to determine if it happened due to missing TransferMethod
-
is_transfer_protocol_required
(error=None)¶ Check the response code and body and in case of failure
Try to determine if it happened due to missing TransferProtocolType.
-
media_types
= <sushy.resources.base.MappedListField object>¶ List of supported media types as virtual media
-
name
= <sushy.resources.base.Field object>¶ The name of resource
-
set_verify_certificate
(verify_certificate)¶ Enable or disable certificate validation.
-
status
= <sushy.resources.common.StatusField object>¶ The virtual media status
-
transfer_method
= <sushy.resources.base.MappedField object>¶ The transfer method to use with the Image
-
user_name
= <sushy.resources.base.Field object>¶ The user name to access the Image parameter-specified URI
-
verify_certificate
= <sushy.resources.base.Field object>¶ Whether to verify the certificate of the server for the Image
-
write_protected
= <sushy.resources.base.Field object>¶ Indicates the media is write protected
-
property
-
class
sushy.resources.manager.virtual_media.
VirtualMediaCollection
(connector, path, redfish_version=None, registries=None, root=None)¶ Bases:
sushy.resources.base.ResourceCollectionBase
A collection of virtual media attached to a Manager