rsd

rsd delete

Delete a RSD resource

openstack rsd delete <resource> [<resource> ...]
resource

ID of the RSD resource(s) to delete.

This command is provided by the python-rsdclient plugin.

rsd fabric endpoint list

List all endpoints of one fabric

openstack rsd fabric endpoint list <fabric>
fabric

ID of the fabric.

This command is provided by the python-rsdclient plugin.

rsd fabric endpoint show

Show endpoint details

openstack rsd fabric endpoint show <endpoint>
endpoint

ID of the endpoint.

This command is provided by the python-rsdclient plugin.

rsd fabric list

List all Fabrics

openstack rsd fabric list

This command is provided by the python-rsdclient plugin.

rsd fabric show

Display fabric details

openstack rsd fabric show <fabric>
fabric

ID of the fabric.

This command is provided by the python-rsdclient plugin.

rsd get

Display the details of one RSD resource

openstack rsd get <resource>
resource

ID of the RSD resource.

This command is provided by the python-rsdclient plugin.

rsd node attach

Attach drive to existing node

openstack rsd node attach
    [--resource <resource uri>]
    [--protocol <protocol>]
    <node>
--resource <resource uri>

URI of the specific resource to attach to node.

--protocol <protocol>

Specified protocol of attaching resource.

node

ID of the node.

This command is provided by the python-rsdclient plugin.

rsd node bootsource

Set the boot source of the node

openstack rsd node bootsource
    [--target <boot source>]
    [--enabled <frequency>]
    [--mode <boot mode>]
    <node>
--target <boot source>

Boot source of this node, e.g. “pxe”, “hdd”.

--enabled <frequency>

The enabled frequency of this setting, e.g. “once”, “continuous”, “disabled”.

--mode <boot mode>

Boot mode, e.g. “legacy”, “uefi”.

node

ID of the node.

This command is provided by the python-rsdclient plugin.

rsd node compose

Compose a node

openstack rsd node compose
    [--name <name>]
    [--description <description>]
    [--processor <processor requirements>]
    [--memory <memory requirements>]
    [--remote-drives <remote drives requirements>]
    [--local-drives <local drives requirements>]
    [--ethernet <ethernet requirements>]
    [--security <security requirements>]
--name <name>

Name of the composed node.

--description <description>

Description of the composed node.

--processor <processor requirements>

Array of requirements for processor for composed node. Each processor requirement may contain one or more optional attributes:

  • Model: Type String, Processor model that should be used for composed node (exact model name)

  • TotalCores: Type Int, Minimum number of processor cores

  • AchievableSpeedMHz: Type Int, Minimum achievable processor operating frequency.

  • InstructionSet: Type String, Processor supported instruction set, such as “x86”, “x86-64”, “IA-64”, “ARM-A32”, “ARM-A64”, “MIPS32”, “MIPS64”, “OEM”

  • Resource: Object Reference to a particular processor that should be used in composed node

  • Chassis: Object Link to chassis object within this processor should be contained.

  • Brand: Type String, Brand of CPU that should be used to allocate node.

  • Capabilities: Array of strings describing processor capabilities (like reported in /proc/cpuinfo flags), such as “sse”, “avx”, etc.

For example:

[{
 "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series",
 "TotalCores": 2,
 "AchievableSpeedMHz": 2000,
 "InstructionSet": "x86",
 "Oem": {
   "Brand": "E5",
   "Capabilities": [ "sse" ],
 },
 "Resource": {
   "@odata.id": "/redfish/v1/Systems/System1/Processors/CPU1"
 }
}]
--memory <memory requirements>

Array of requirements for memory for composed node. Each memory requirement may contain one or more optional attributes:

  • CapacityMiB: Type Int, Minimum memory capacity requested for composed node

  • MemoryDeviceType: Type String, Type details of DIMM, such as “DDR3”, “DDR4”

  • SpeedMHz: Type Int, Minimum supported memory speed

  • Manufacturer: Type String, Requested memory manufacturer

  • DataWidthBits: Type Int, Requested memory data width in bits

  • Resource: Object Reference to a particular memory module that should be used in composed node

  • Chassis: Object Link to chassis object within this memory DIMM should be contained

For example:

[{
 "CapacityMiB": 16000,
 "MemoryDeviceType": "DDR3",
 "SpeedMHz": 1600,
 "Manufacturer": "Intel",
 "DataWidthBits": 64,
 "Resource": {
   "@odata.id": "/redfish/v1/Systems/System1/Memory/Dimm1"
 },
 "Chassis": {
   "@odata.id": "/redfish/v1/Chassis/Rack1"
 }
}]
--remote-drives <remote drives requirements>

Array of requirements for remote drives that should be created/connected to composed node. Each remote drives requirement may contain one or more optional attributes:

  • CapacityGiB: Positive value expected, required if Master Drive supplied. Should be at least the size of Logical Drive used as Master Drive

  • Protocol: Defines protocol used to communicate with attached drive. Currently supported: “iSCSI” “NVMeOverFabrics”

  • Master -> Type: One of allowed enumerated values (“Snapshot” “Clone”). Required if Master Drive supplied

  • Master -> Resource: URI of Master volume that should be used for clone or snapshot operation

  • Resource: Object Reference to particular local drive that should be used in composed node

For example:

# Using existing NVMe over Fabrics Remote Drive
[{
 "Protocol": "NVMeOverFabrics",
 "Resource": {
   "@odata.id": "/redfish/v1/StorageServices/NVMeoE1/Volumes/1"
 }
}]

# Using a Master Drive for fresh Remote Drive Creation
[{
 "CapacityGiB": 80,
 "Protocol": "NVMeOverFabrics",
 "Master": {
   "Type": "Snapshot",
   "Resource": {
     "@odata.id": "/redfish/v1/StorageServices/NVMeoE1/Volumes/102"
   }
 }
}]
--local-drives <local drives requirements>

Array of requirements for local drives for composed node. Each local drives requirement may contain one or more optional attributes:

  • CapacityGiB: Type Int, Minimum drive capacity requested for composed node

  • Type: Type String, Drive type: “HDD”, “SSD”

  • MinRPM: Type Int, Minimum rotation speed of requested drive

  • SerialNumber: Type String, Serial number of requested drive

  • Interface: Type String, Interface of requested drive: “SAS”, “SATA”, “NVMe”

  • Resource: Object Reference to particular local drive that should be used in composed node

  • Chassis: Object Link to chassis object within this drive should be contained

  • FabricSwitch: Type Boolean, Determine if local drive should be connected using fabric switch or local connected

For example:

[{
 "CapacityGiB": 500,
 "Type": "HDD",
 "MinRPM": 5400,
 "SerialNumber": "12345678",
 "Interface": "SATA",
 "Resource": {
   "@odata.id": "redfish/v1/Chassis/Blade1/Drives/Disk1"
 },
 "FabricSwitch": false
}]
--ethernet <ethernet requirements>

Array of requirements for Ethernet interfaces of composed node. Each Ethernet interface requirement may contain one or more optional attributes:

  • SpeedMbps: Type Int, Minimum speed of Ethernet interface requested for composed node

  • VLANs: Type Array, Array of VLANs that should be configured on connected switch port for composed node for given Ethernet interface in the following format: VLANId - number indicating VLAN Id, Tagged - Boolean value describing if given VLAN is tagged

  • PrimaryVLAN: Type Int, Primary VLAN ID that should be set for a given Ethernet Interface

  • Resource: Object Reference to a particular Ethernet interface that should be used in composed node

  • Chassis: Object Link to chassis object within this network interface should be contained

For example:

[{
 "SpeedMbps": 1000,
 "PrimaryVLAN": 100,
 "VLANs": [{
   "VLANId": 100,
   "Tagged": false
 }],
 "Resource": {
   "@odata.id": "/redfish/v1/Systems/System1/EthernetInterfaces/LAN1"
 }
}]
--security <security requirements>

The security requirements of composed node. It may contain one or more optional attributes:

  • TpmPresent: determine if Composed Node should be equipped with TPM module

  • TpmInterfaceType: overrides TpmPresent parameter (if specified TPM module expected). System must be equipped with only defined TPM interface type.

  • TxtEnabled: determine if Composed Node should have Trusted Execution Technology (TXT) mode enabled.

  • ClearTPMOnDelete: used to specify if TPM module should be cleared on composed node DELETE request.

For example:

{
 "TpmPresent": True,
 "TpmInterfaceType": "TPM2_0",
 "TxtEnabled": True,
 "ClearTPMOnDelete": True
}

This command is provided by the python-rsdclient plugin.

rsd node delete

Delete a node

openstack rsd node delete <node> [<node> ...]
node

ID of the node(s) to delete.

This command is provided by the python-rsdclient plugin.

rsd node detach

Detach drive from existing node

openstack rsd node detach [--resource <resource uri>] <node>
--resource <resource uri>

URI of the specific resource to detach from node.

node

ID of the node.

This command is provided by the python-rsdclient plugin.

rsd node list

List all nodes

openstack rsd node list

This command is provided by the python-rsdclient plugin.

rsd node reset

Reset the power of the node

openstack rsd node reset [--action <reset action>] <node>
--action <reset action>

Reset action of this node, e.g. “on”, “force off”.

node

ID of the node.

This command is provided by the python-rsdclient plugin.

rsd node show

Show node details

openstack rsd node show <node>
node

ID of the node.

This command is provided by the python-rsdclient plugin.

rsd patch

Issue HTTP PATCH to a target RSD resource

openstack rsd patch [--data <data>] <resource>
--data <data>

Payload of PATCH operation.

resource

ID of target RSD resource to PATCH.

This command is provided by the python-rsdclient plugin.

rsd post

Issue HTTP POST to a target RSD resource

openstack rsd post [--data <data>] <resource>
--data <data>

Payload of POST operation.

resource

ID of target RSD resource to POST.

This command is provided by the python-rsdclient plugin.

rsd storage drive list

List all drives of one storage service

openstack rsd storage drive list <storage service>
storage service

ID of the storage service.

This command is provided by the python-rsdclient plugin.

rsd storage drive show

Show drive details

openstack rsd storage drive show <drive>
drive

ID of the drive.

This command is provided by the python-rsdclient plugin.

rsd storage list

List all storage services

openstack rsd storage list

This command is provided by the python-rsdclient plugin.

rsd storage show

Show storage service details

openstack rsd storage show <storage service>
storage service

ID of the storage service.

This command is provided by the python-rsdclient plugin.

rsd storage storagepool list

List all storage pools of one storage service

openstack rsd storage storagepool list <storage service>
storage service

ID of the storage service.

This command is provided by the python-rsdclient plugin.

rsd storage storagepool show

Show storage pool details

openstack rsd storage storagepool show <storage pool>
storage pool

ID of the storage pool.

This command is provided by the python-rsdclient plugin.

rsd storage volume create

Create a new volume

openstack rsd storage volume create
    [--capacity <volume capacity>]
    [--access_capabilities <storage service>]
    [--capacity_sources <storage service>]
    [--replica_infos <storage service>]
    [--bootable <storage service>]
    <storage
    service>
--capacity <volume capacity>

Capacity of the volume.

--access_capabilities <storage service>

List of volume access capabilities, e.g. [‘Read’, ‘Write’, ‘WriteOnce’, ‘Append’, ‘Streaming’]

--capacity_sources <storage service>

JSON for volume providing source.

--replica_infos <storage service>

JSON for volume replica infos.

--bootable <storage service>

Determines if the volume should be bootable.

storage service

ID of the storage service.

This command is provided by the python-rsdclient plugin.

rsd storage volume delete

Delete a volume

openstack rsd storage volume delete <volume>
volume

ID of the volume.

This command is provided by the python-rsdclient plugin.

rsd storage volume init

Initialize (erase) volume

openstack rsd storage volume init [--init_type <init type>] <volume>
--init_type <init type>

Type of volume initialize (erase) process.

volume

ID of the volume.

This command is provided by the python-rsdclient plugin.

rsd storage volume list

List all volumes of one storage service

openstack rsd storage volume list <storage service>
storage service

ID of the storage service.

This command is provided by the python-rsdclient plugin.

rsd storage volume show

Show volume details

openstack rsd storage volume show <volume>
volume

ID of the volume.

This command is provided by the python-rsdclient plugin.

rsd storage volume update

Update the volume properties

openstack rsd storage volume update
    [--bootable <bootable>]
    [--erased <erased config>]
    <volume>
--bootable <bootable>

bootable ability of the volume.

--erased <erased config>

if the drive was erased.

volume

ID of the volume.

This command is provided by the python-rsdclient plugin.

rsd system list

List all Systems

openstack rsd system list

This command is provided by the python-rsdclient plugin.

rsd system show

Display system details

openstack rsd system show <system>
system

ID of the system.

This command is provided by the python-rsdclient plugin.