The rsd_lib.resources.v2_1.node.node
Module¶
-
class
rsd_lib.resources.v2_1.node.node.
AssembleActionField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
target_uri
= <sushy.resources.base.Field object>¶
-
-
class
rsd_lib.resources.v2_1.node.node.
AttachEndpointActionField
(*args, **kwargs)¶ Bases:
sushy.resources.common.ActionField
-
allowed_values
= <sushy.resources.base.Field object>¶
-
-
class
rsd_lib.resources.v2_1.node.node.
DetachEndpointActionField
(*args, **kwargs)¶ Bases:
sushy.resources.common.ActionField
-
allowed_values
= <sushy.resources.base.Field object>¶
-
-
class
rsd_lib.resources.v2_1.node.node.
LinksField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
computer_system
= <sushy.resources.base.Field object>¶ Link to base computer system of this node
-
ethernet_interfaces
= <sushy.resources.base.Field object>¶ Link to ethernet interfaces of this node
-
local_drives
= <sushy.resources.base.Field object>¶ Link to local driver of this node
-
managed_by
= <sushy.resources.base.Field object>¶
-
memory
= <sushy.resources.base.Field object>¶ Link to memory of this node
-
processors
= <sushy.resources.base.Field object>¶ Link to processors of this node
-
remote_drives
= <sushy.resources.base.Field object>¶ Link to remote drives of this node
-
-
class
rsd_lib.resources.v2_1.node.node.
Node
(connector, path='', redfish_version=None, registries=None, reader=None)¶ Bases:
rsd_lib.base.ResourceBase
ComposedNode resource class
This schema defines a node and its respective properties.
-
assemble_node
()¶ Assemble the composed node.
-
asset_tag
= <sushy.resources.base.Field object>¶ The user definable tag that can be used to track this computer system for inventory or other client purposes
-
attach_endpoint
(endpoint=None, capacity=None)¶ Attach endpoint from available pool to composed node
- Parameters
endpoint – Link to endpoint to attach.
capacity – Requested capacity of the drive in GiB.
- Raises
InvalidParameterValueError
- Raises
BadRequestError if at least one param isn’t specified
-
boot
= <rsd_lib.resources.v2_1.system.system.BootField object>¶ Information about the boot settings for this system
-
composed_node_state
= <sushy.resources.base.Field object>¶
-
delete_node
()¶ Delete (disassemble) the node.
When this action is called several tasks are performed. A graceful shutdown is sent to the computer system, all VLANs except reserved ones are removed from associated ethernet switch ports, the computer system is deallocated and the remote target is deallocated.
-
detach_endpoint
(endpoint)¶ Detach already attached endpoint from composed node
- Parameters
endpoint – Link to endpoint to detach
- Raises
InvalidParameterValueError
- Raises
BadRequestError
-
get_allowed_attach_endpoints
()¶ Get the allowed endpoints for attach action.
- Returns
A set with the allowed attach endpoints.
-
get_allowed_detach_endpoints
()¶ Get the allowed endpoints for detach action.
- Returns
A set with the allowed detach endpoints.
-
get_allowed_node_boot_mode_values
()¶ Get the allowed values for the boot source mode.
- Returns
A set with the allowed values.
-
get_allowed_node_boot_source_values
()¶ Get the allowed values for changing the boot source.
- Returns
A set with the allowed values.
-
get_allowed_reset_node_values
()¶ Get the allowed values for resetting the node.
- Returns
A set with the allowed values.
-
links
= <rsd_lib.resources.v2_1.node.node.LinksField object>¶ Contains links to other resources that are related to this resource.
-
memory
= <rsd_lib.resources.v2_1.system.system.MemorySummaryField object>¶ This object describes the central memory of the system in general detail.
-
power_state
= <sushy.resources.base.Field object>¶ This is the current power state of the system
-
processors
= <rsd_lib.resources.v2_1.system.system.ProcessorSummaryField object>¶ This object describes the central processors of the system in general detail.
-
reset_node
(value)¶ Reset the node.
- Parameters
value – The target value.
- Raises
InvalidParameterValueError, if the target value is not allowed.
-
set_node_boot_source
(target, enabled='Once', mode=None)¶ Set the boot source.
Set the boot source to use on next reboot of the Node.
- Parameters
target – The target boot source.
enabled – The frequency, whether to set it for the next reboot only (“Once”) or persistent to all future reboots (“Continuous”) or disabled (“Disabled”).
mode – The boot mode, UEFI (“UEFI”) or BIOS (“Legacy”).
- Raises
InvalidParameterValueError, if any information passed is invalid.
-
status
= <rsd_lib.base.StatusField object>¶ This indicates the known state of the resource, such as if it is enabled.
-
uuid
= <sushy.resources.base.Field object>¶ The universal unique identifier (UUID) for this system
-
-
class
rsd_lib.resources.v2_1.node.node.
NodeActionsField
(*args, **kwargs)¶ Bases:
sushy.resources.base.CompositeField
-
assemble
= <sushy.resources.common.ActionField object>¶
-
attach_endpoint
= <rsd_lib.resources.v2_1.node.node.AttachEndpointActionField object>¶
-
detach_endpoint
= <rsd_lib.resources.v2_1.node.node.DetachEndpointActionField object>¶
-
reset
= <sushy.resources.common.ResetActionField object>¶
-
-
class
rsd_lib.resources.v2_1.node.node.
NodeCollection
(connector, path, redfish_version=None, registries=None)¶ Bases:
rsd_lib.base.ResourceCollectionBase
-
compose_node
(name=None, description=None, processor_req=None, memory_req=None, remote_drive_req=None, local_drive_req=None, ethernet_interface_req=None, total_system_core_req=None, total_system_memory_req=None)¶ Compose a node from RackScale hardware
- Parameters
name – Name of node
description – Description of node
processor_req – JSON for node processors
memory_req – JSON for node memory modules
remote_drive_req – JSON for node remote drives
local_drive_req – JSON for node local drives
ethernet_interface_req – JSON for node ethernet ports
total_system_core_req – Total processor cores available in composed node
total_system_memory_req – Total memory available in composed node
- Returns
The location of the composed node
When the ‘processor_req’ is not none: it need a computer system contains processors whose each processor meet all conditions in the value.
When the ‘total_system_core_req’ is not none: it need a computer system contains processors whose cores sum up to number equal or greater than ‘total_system_core_req’.
When both values are not none: it need meet all conditions.
‘memory_req’ and ‘total_system_memory_req’ is the same.
-