https://github.com/borball/redfish-bash
Wrapper script(bash) of redfish API
https://github.com/borball/redfish-bash
Last synced: 5 months ago
JSON representation
Wrapper script(bash) of redfish API
- Host: GitHub
- URL: https://github.com/borball/redfish-bash
- Owner: borball
- Created: 2023-08-30T13:53:40.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-07-10T13:06:55.000Z (11 months ago)
- Last Synced: 2025-07-10T20:19:00.557Z (11 months ago)
- Language: Shell
- Homepage:
- Size: 36.1 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# redfish-bash
A wrapper script of redfish API, tested on ZT/HPE/Dell/Sushy-tools servers.
## Install
- Note: Install yq with instruction: https://github.com/mikefarah/yq?tab=readme-ov-file#install
- Note: Install jq(1.7+) with instruction: https://github.com/jqlang/jq?tab=readme-ov-file#installation
```shell
curl -fsSL -o /usr/local/bin/redfish-bash.sh https://raw.githubusercontent.com/borball/redfish-bash/master/redfish-bash.sh
chmod +x /usr/local/bin/redfish-bash.sh
```
## Usage
```shell
redfish-bash.sh
```
```shell
# ./redfish-bash.sh
Usage : ./redfish-bash.sh command
Available commands:
-------------------------------------------
#login BMC
login [bmc]
login [bmc] [kvm_uuid]
-------------------------------------------
#bmc server context
#all servers:
servers
#current server
server
#use server N
server N
-------------------------------------------
#resource management
root
system
system
manager
manager
#BMC reset
bmc-reboot
bios
#read attributes
bios
#modify attribute
bios
eths
power
power on|off|restart|nmi
virtual-media
virtual-media insert
virtual-media eject
boot-once-from-cd
secure-boot
secure-boot true|false
storage
storage
Examples:
./redfish-bash.sh login https://192.168.13.146
./redfish-bash.sh login https://192.168.13.146 [kvm_uuid]
./redfish-bash.sh servers
./redfish-bash.sh server
./redfish-bash.sh server 0
./redfish-bash.sh root
./redfish-bash.sh system
./redfish-bash.sh system Manufacturer,Model
./redfish-bash.sh manager
./redfish-bash.sh manager FirmwareVersion,PowerState,ManagerType
./redfish-bash.sh bios
./redfish-bash.sh bios Attributes.WorkloadProfile
./redfish-bash.sh bios WorkloadProfile=vRAN
./redfish-bash.sh eths
./redfish-bash.sh power
./redfish-bash.sh power on|off|restart|nmi
./redfish-bash.sh virtual-media
./redfish-bash.sh virtual-media insert http://192.168.58.15/iso/agent-130.iso
./redfish-bash.sh virtual-media eject
./redfish-bash.sh boot-once-from-cd
./redfish-bash.sh secure-boot
./redfish-bash.sh secure-boot true|false
./redfish-bash.sh storage
./redfish-bash.sh storage DA000000
./redfish-bash.sh get
./redfish-bash.sh get /redfish/v1/TelemetryService
Run : ./redfish-bash.sh login before using other commands for the first time.
BMC credential must be saved in $NETRC in following format
machine login password
default login password
```
## Examples
### login
The script uses credential in [netrc-file](https://everything.curl.dev/usingcurl/netrc.html) to access the redfish API.
Prepare a file .bmc.netrc in your HOME folder before running the script.
```shell
redfish-bash.sh login https://192.168.13.146
```
Example:
```shell
# redfish-bash.sh login https://192.168.13.130
login successful, will use this server for the following commands.
index: 1
bmc: https://192.168.14.130
## login to the BMC console simulated by sushy-tools:
# redfish-bash.sh login https://192.168.58.15:8080 22222222-1111-1111-0000-000000000010
login successful, will use this server for the following commands.
index: 2
bmc: https://192.168.58.15:8080
```
### servers
Check all servers managed by redfish-bash:
```shell
redfish-bash.sh servers
```
Example:
```
# redfish-bash.sh servers
following server is being used:
All servers in the list:
0 https://192.168.58.15:8080
1 https://192.168.13.146
2 https://192.168.13.147
3 https://192.168.13.148
4 https://192.168.13.149
5 https://192.168.14.130
6 https://192.168.14.131
7 https://192.168.14.132
8 https://192.168.14.133
use command 'server' to check the current server
use command 'server N' to switch the servers
```
Check current server managed by redfish-bash:
```shell
redfish-bash.sh server
```
Example:
```
# redfish-bash.sh server
following server is being used:
```
Switch to other server:
```shell
redfish-bash.sh server 1
```
Example:
```
# redfish-bash.sh server 1
following server will be used:
index: 1
bmc: https://192.168.13.146
```
### root
Check all resources managed by redfish:
```shell
redfish-bash.sh root
```
Example on ZT server:
```shell
# redfish-bash.sh root
{
"@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot",
"@odata.etag": "\"1710499398\"",
"@odata.id": "/redfish/v1",
"@odata.type": "#ServiceRoot.v1_5_2.ServiceRoot",
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"CertificateService": {
"@odata.id": "/redfish/v1/CertificateService"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"CompositionService": {
"@odata.id": "/redfish/v1/CompositionService"
},
"Description": "The service root for all Redfish requests on this host",
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"Id": "RootService",
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Name": "Root Service",
"Oem": {
"Ami": {
"@odata.type": "#AMIServiceRoot.v1_0_0.AMIServiceRoot",
"InventoryDataStatus": {
"@odata.id": "/redfish/v1/Oem/Ami/InventoryData/Status"
},
"RtpVersion": "1.8.a",
"configurations": {
"@odata.id": "/redfish/v1/configurations"
}
}
},
"Product": "AMI Redfish Server",
"ProtocolFeaturesSupported": {
"ExcerptQuery": true,
"ExpandQuery": {
"ExpandAll": false,
"Levels": false,
"Links": false,
"MaxLevels": 5,
"NoLinks": false
},
"FilterQuery": true,
"OnlyMemberQuery": true,
"SelectQuery": true
},
"RedfishVersion": "1.8.0",
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"TelemetryService": {
"@odata.id": "/redfish/v1/TelemetryService"
},
"UUID": "5a544443-4110-0031-3150-d04b30303633",
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"Vendor": "AMI"
}
```
Check endpoint of particular service(s):
```shell
redfish-bash.sh root Managers,Systems
```
Example:
```shell
# redfish-bash.sh root Managers,Systems
{
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
}
}
```
Get particular service(Manager):
```
# redfish-bash.sh get /redfish/v1/Managers
{
"@odata.context": "/redfish/v1/$metadata#ManagerCollection.ManagerCollection",
"@odata.etag": "\"1710499398\"",
"@odata.id": "/redfish/v1/Managers",
"@odata.type": "#ManagerCollection.ManagerCollection",
"Description": "The collection for Managers",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/Self"
}
],
"Members@odata.count": 1,
"Name": "Manager Collection"
}
```
Get particular service(System):
```
#redfish-bash.sh get /redfish/v1/Systems
{
"@Redfish.CollectionCapabilities": {
"@odata.type": "#CollectionCapabilities.v1_2_0.CollectionCapabilities",
"Capabilities": [
{
"CapabilitiesObject": {
"@odata.id": "/redfish/v1/Systems/Capabilities"
},
"Links": {
"RelatedItem": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceZones/1"
}
],
"TargetCollection": {
"@odata.id": "/redfish/v1/Systems"
}
},
"UseCase": "ComputerSystemComposition"
}
]
},
"@odata.context": "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection",
"@odata.etag": "\"1708975059\"",
"@odata.id": "/redfish/v1/Systems",
"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
"Description": "Collection of Computer Systems",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/Self"
}
],
"Members@odata.count": 1,
"Name": "Systems Collection"
}
```
### manager
Check all manager information:
```shell
redfish-bash.sh manager
```
Example on ZT:
```
## ZT
# redfish-bash.sh manager
{
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_2_2.Settings",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/Self/Bios/SD"
}
},
"@odata.context": "/redfish/v1/$metadata#Bios.Bios",
"@odata.etag": "\"1708975059\"",
"@odata.id": "/redfish/v1/Systems/Self/Bios",
"@odata.type": "#Bios.v1_1_0.Bios",
"Actions": {
"#Bios.ChangePassword": {
"@Redfish.ActionInfo": "/redfish/v1/Systems/Self/Bios/ChangePasswordActionInfo",
"target": "/redfish/v1/Systems/Self/Bios/Actions/Bios.ChangePassword"
},
"#Bios.ResetBios": {
"@Redfish.ActionInfo": "/redfish/v1/Systems/Self/Bios/ResetBiosActionInfo",
"target": "/redfish/v1/Systems/Self/Bios/Actions/Bios.ResetBios"
},
"#ZtVga.ChangeState": {
"@Redfish.ActionInfo": "/redfish/v1/Systems/Self/Bios/ChangeStateActionInfo",
"target": "/redfish/v1/Systems/Self/Bios/Actions/ZtVga.ChangeState"
}
},
...
```
Check particular manager attributes:
```shell
redfish-bash.sh manager FirmwareVersion,PowerState,ManagerType
```
Example on ZT:
```shell
# redfish-bash.sh manager FirmwareVersion,PowerState,ManagerType
{
"FirmwareVersion": "0.43.00",
"PowerState": "On",
"ManagerType": "BMC"
}
```
Example on HPE:
```
## HPE
# redfish-bash.sh manager
{
"@odata.context": "/redfish/v1/$metadata#Manager.Manager",
"@odata.etag": "W/\"5DF7965A\"",
"@odata.id": "/redfish/v1/Managers/1",
"@odata.type": "#Manager.v1_5_1.Manager",
"Id": "1",
"Actions": {
"#Manager.Reset": {
"ResetType@Redfish.AllowableValues": [
"ForceRestart",
"GracefulRestart"
],
"target": "/redfish/v1/Managers/1/Actions/Manager.Reset"
}
},
"CommandShell": {
"ConnectTypesSupported": [
"SSH",
"Oem"
],
"MaxConcurrentSessions": 9,
"ServiceEnabled": true
},
"DateTime": "2024-03-15T17:27:53Z",
"DateTimeLocalOffset": "+00:00",
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"
},
"FirmwareVersion": "iLO 5 v2.81",
...
```
Check particular manager attributes on HPE:
```shell
# redfish-bash.sh manager FirmwareVersion,PowerState,ManagerType
{
"FirmwareVersion": "iLO 5 v2.81",
"PowerState": null,
"ManagerType": "BMC"
}
```
Check all manager information on Dell:
```shell
## Dell
$ redfish-bash.sh manager
{
"@odata.context": "/redfish/v1/$metadata#Manager.Manager",
"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1",
"@odata.type": "#Manager.v1_17_0.Manager",
"Actions": {
"#Manager.Reset": {
"ResetType@Redfish.AllowableValues": [
"GracefulRestart"
],
"target": "/redfish/v1/Managers/iDRAC.Embedded.1/Actions/Manager.Reset"
},
"#Manager.ResetToDefaults": {
"ResetType@Redfish.AllowableValues": [
"ResetAll",
"PreserveNetworkAndUsers"
],
"target": "/redfish/v1/Managers/iDRAC.Embedded.1/Actions/Manager.ResetToDefaults"
},
...
```
Check particular manager attributes on Dell:
```shell
# redfish-bash.sh manager FirmwareVersion,PowerState,ManagerType
{
"FirmwareVersion": "7.00.30.00",
"PowerState": "On",
"ManagerType": "BMC"
}
```
### system
Check all system information on ZT:
```
## ZT
# redfish-bash.sh system
{
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_2_2.Settings",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/Self/SD"
}
},
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.etag": "\"1708975059\"",
"@odata.id": "/redfish/v1/Systems/Self",
"@odata.type": "#ComputerSystem.v1_8_0.ComputerSystem",
"Actions": {
"#ComputerSystem.Reset": {
"@Redfish.ActionInfo": "/redfish/v1/Systems/Self/ResetActionInfo",
"@Redfish.OperationApplyTimeSupport": {
"@odata.type": "#Settings.v1_2_2.OperationApplyTimeSupport",
"MaintenanceWindowDurationInSeconds": 600,
"MaintenanceWindowResource": {
"@odata.id": "/redfish/v1/Systems/Self"
},
"SupportedValues": [
"Immediate",
"AtMaintenanceWindowStart"
]
},
"ResetType@Redfish.AllowableValues": [
"Nmi",
"On",
"ForceRestart",
"ForceOff",
"GracefulShutdown"
],
"target": "/redfish/v1/Systems/Self/Actions/ComputerSystem.Reset"
}
},
...
```
Check particular system attributes on ZT:
```shell
{
"SystemType": "Physical",
"Name": "Proteus I_Mix",
"Manufacturer": "ZTSYSTEMS"
}
```
Check all system information on HPE:
```
## HPE
# redfish-bash.sh system
{
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.etag": "W/\"98A3D2D0\"",
"@odata.id": "/redfish/v1/Systems/1",
"@odata.type": "#ComputerSystem.v1_13_0.ComputerSystem",
"Id": "1",
"Actions": {
"#ComputerSystem.Reset": {
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff",
"GracefulShutdown",
"ForceRestart",
"Nmi",
"PushPowerButton",
"GracefulRestart"
],
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"
}
},
...
```
Check particular system attributes on HPE:
```shell
# redfish-bash.sh system SystemType,Name,Manufacturer
{
"SystemType": "Physical",
"Name": "Computer System",
"Manufacturer": "HPE"
}
```
Check all system information on Dell:
```
## Dell
# redfish-bash.sh system
{
"@Redfish.Settings": {
"@odata.context": "/redfish/v1/$metadata#Settings.Settings",
"@odata.type": "#Settings.v1_3_5.Settings",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/System.Embedded.1/Settings"
},
"SupportedApplyTimes": [
"OnReset"
]
},
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
"@odata.id": "/redfish/v1/Systems/System.Embedded.1",
"@odata.type": "#ComputerSystem.v1_20_0.ComputerSystem",
"Actions": {
"#ComputerSystem.Reset": {
"target": "/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset",
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff",
"ForceRestart",
"GracefulRestart",
"GracefulShutdown",
"PushPowerButton",
"Nmi",
"PowerCycle"
]
}
}
...
```
Check particular system attributes on Dell:
```shell
{
"SystemType": "Physical",
"Name": "System",
"Manufacturer": "Dell Inc."
}
```
### bios
Check BIOS settings:
```shell
redfish-bash.sh bios
```
BIOS settings on HPE:
```shell
# redfish-bash.sh bios
{
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_0_0.Settings",
"ETag": "E9BA1662",
...
"SettingsObject": {
"@odata.id": "/redfish/v1/systems/1/bios/settings/"
},
"Time": "2024-03-15T15:43:53+00:00"
},
"@odata.context": "/redfish/v1/$metadata#Bios.Bios",
"@odata.etag": "W/\"9D2EF994B025595959AECBAC77CFEBA9\"",
"@odata.id": "/redfish/v1/systems/1/bios/",
"@odata.type": "#Bios.v1_0_4.Bios",
"Actions": {
"#Bios.ChangePassword": {
"target": "/redfish/v1/systems/1/bios/settings/Actions/Bios.ChangePasswords/"
},
"#Bios.ResetBios": {
"target": "/redfish/v1/systems/1/bios/settings/Actions/Bios.ResetBios/"
}
},
"AttributeRegistry": "BiosAttributeRegistryH10.v1_1_66",
"Attributes": {
"AccessControlService": "Enabled",
"AcpiHpet": "Enabled",
"AcpiRootBridgePxm": "Enabled",
"AcpiSlit": "Enabled",
"AdjSecPrefetch": "Enabled",
"AdminEmail": "",
"AdminName": "",
"AdminOtherInfo": "",
"AdminPhone": "",
"AdvCrashDumpMode": "Disabled",
"AdvancedMemProtection": "Auto",
"AllowLoginWithIlo": "Disabled",
"AssetTagProtection": "Unlocked",
"AutoPowerOn": "RestoreLastState",
"BootMode": "Uefi",
"BootOrderPolicy": "RetryIndefinitely",
"CollabPowerControl": "Disabled",
"ConsistentDevNaming": "LomsAndSlots",
"CustomPostMessage": "",
"DaylightSavingsTime": "DaylightSavingsTimeDisabled",
"DcuIpPrefetcher": "Enabled",
"DcuStreamPrefetcher": "Enabled",
"DeadBlockPredictor": "Disabled",
...
```
Check particular BIOS settings on HPE:
```shell
# redfish-bash.sh bios Attributes.Sriov,Attributes.WorkloadProfile
{
"Attributes": {
"Sriov": "Enabled",
"WorkloadProfile": "vRAN"
}
}
```
Update BIOS settings to disable SR-IOV:
```shell
# redfish-bash.sh bios Sriov=Disabled
```
Update BIOS settings to enable vRAN workload profile:
```shell
# redfish-bash.sh bios WorkloadProfile=vRAN
```
### power
Check power status:
```
redfish-bash.sh power
```
Example:
```
# redfish-bash.sh power
On
```
Power on:
```
redfish-bash.sh power on
```
Example:
```shell
# redfish-bash.sh power on
204 https://192.168.18.171/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset
```
Power off:
```
redfish-bash.sh power off
```
Example:
```shell
# redfish-bash.sh power off
204 https://192.168.18.171/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset
```
Power reset:
```
redfish-bash.sh power restart
```
Example:
```shell
# redfish-bash.sh power restart
204 https://192.168.18.171/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset
```
Power nmi:
This will trigger NMI event to generate vmcore
```shell
redfish-bash.sh power nmi
```
Example:
```shell
# redfish-bash.sh power nmi
204 https://192.168.18.171/redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset
```
### virtual-media
Check current virtual-media status:
```shell
redfish-bash.sh virtual-media
```
Example:
```shell
# redfish-bash.sh virtual-media
{
"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia",
"@odata.etag": "W/\"14700DD6\"",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/2",
"@odata.type": "#VirtualMedia.v1_3_0.VirtualMedia",
"Id": "2",
"Actions": {
"#VirtualMedia.EjectMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/VirtualMedia.EjectMedia"
},
"#VirtualMedia.InsertMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/VirtualMedia.InsertMedia"
}
},
"ConnectedVia": "NotConnected",
"Description": "Virtual Removable Media",
"Image": "",
"Inserted": false,
"MediaTypes": [
"CD",
"DVD"
],
"Name": "VirtualMedia",
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeiLOVirtualMedia.HpeiLOVirtualMedia",
"@odata.type": "#HpeiLOVirtualMedia.v2_2_0.HpeiLOVirtualMedia",
"Actions": {
"#HpeiLOVirtualMedia.EjectVirtualMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/Oem/Hpe/HpeiLOVirtualMedia.EjectVirtualMedia"
},
"#HpeiLOVirtualMedia.InsertVirtualMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/Oem/Hpe/HpeiLOVirtualMedia.InsertVirtualMedia"
}
},
"BootOnNextServerReset": false
}
},
"WriteProtected": true
}
```
Mount ISO as a virtual-media:
```shell
redfish-bash.sh virtual-media insert http://192.168.58.15/iso/sno130.iso
```
Example:
```shell
# redfish-bash.sh virtual-media insert http://192.168.58.15/iso/sno130.iso
{"error":{"code":"iLO.0.10.ExtendedInfo","message":"See @Message.ExtendedInfo for more information.","@Message.ExtendedInfo":[{"MessageId":"Base.1.4.Success"}]}}200 https://192.168.14.130/redfish/v1/Managers/1/VirtualMedia/2/Actions/VirtualMedia.InsertMedia
```
Check status again:
```shell
# redfish-bash.sh virtual-media
{
"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia",
"@odata.etag": "W/\"091272C1\"",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/2",
"@odata.type": "#VirtualMedia.v1_3_0.VirtualMedia",
"Id": "2",
"Actions": {
"#VirtualMedia.EjectMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/VirtualMedia.EjectMedia"
},
"#VirtualMedia.InsertMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/VirtualMedia.InsertMedia"
}
},
"ConnectedVia": "URI",
"Description": "Virtual Removable Media",
"Image": "http://192.168.58.15/iso/sno130.iso",
"ImageName": "sno130.iso",
"Inserted": true,
"MediaTypes": [
"CD",
"DVD"
],
"Name": "VirtualMedia",
"Oem": {
"Hpe": {
"@odata.context": "/redfish/v1/$metadata#HpeiLOVirtualMedia.HpeiLOVirtualMedia",
"@odata.type": "#HpeiLOVirtualMedia.v2_2_0.HpeiLOVirtualMedia",
"Actions": {
"#HpeiLOVirtualMedia.EjectVirtualMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/Oem/Hpe/HpeiLOVirtualMedia.EjectVirtualMedia"
},
"#HpeiLOVirtualMedia.InsertVirtualMedia": {
"target": "/redfish/v1/Managers/1/VirtualMedia/2/Actions/Oem/Hpe/HpeiLOVirtualMedia.InsertVirtualMedia"
}
},
"BootOnNextServerReset": false
}
},
"TransferProtocolType": "HTTP",
"WriteProtected": true
}
```
Eject virtual media:
```shell
redfish-bash.sh virtual-media eject
```
Example:
```shell
# redfish-bash.sh virtual-media eject
{"error":{"code":"iLO.0.10.ExtendedInfo","message":"See @Message.ExtendedInfo for more information.","@Message.ExtendedInfo":[{"MessageId":"Base.1.4.Success"}]}}200 https://192.168.14.130/redfish/v1/Managers/1/VirtualMedia/2/Actions/VirtualMedia.EjectMedia
```
### eths
Check ethernet devices on the server:
```shell
redfish-bash.sh eths
```
Example:
```shell
# redfish-bash.sh eths
{
"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
"@odata.etag": "W/\"BF82DB05\"",
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/1",
"@odata.type": "#EthernetInterface.v1_4_1.EthernetInterface",
"Id": "1",
"FullDuplex": false,
"IPv4Addresses": [],
"IPv4StaticAddresses": [],
"IPv6AddressPolicyTable": [],
"IPv6Addresses": [],
"IPv6StaticAddresses": [],
"IPv6StaticDefaultGateways": [],
"InterfaceEnabled": null,
"LinkStatus": null,
"MACAddress": "b4:96:91:da:5a:ec",
"Name": "",
"NameServers": [],
"SpeedMbps": null,
"StaticNameServers": [],
"Status": {
"Health": null,
"State": null
},
"UefiDevicePath": "PciRoot(0x1)/Pci(0x2,0x0)/Pci(0x0,0x0)"
}...
```
### secure-boot
Check if secure boot is enabled on the node:
```shell
redfish-bash.sh secure-boot
```
Example:
```shell
# redfish-bash.sh secure-boot
false
```
Enable secure-boot:
```shell
redfish-bash.sh secure-boot true
```
Example:
```shell
# redfish-bash.sh secure-boot true
{"@Message.ExtendedInfo":[{"Message":"The request completed successfully.","MessageArgs":[],"MessageArgs@odata.count":0,"MessageId":"Base.1.12.Success","RelatedProperties":[],"RelatedProperties@odata.count":0,"Resolution":"None","Severity":"OK"},{"Message":"The operation is successfully completed.","MessageArgs":[],"MessageArgs@odata.count":0,"MessageId":"IDRAC.2.9.SYS430","RelatedProperties":[],"RelatedProperties@odata.count":0,"Resolution":"No response action is required.However, to make them immediately effective, restart the host server.","Severity":"Informational"}]}secure boot has been set as true, you may need to reboot the node to take effect.
```
Disable secure-boot:
```shell
redfish-bash.sh secure-boot false
```
Example:
```shell
# redfish-bash.sh secure-boot false
{"error":{"@Message.ExtendedInfo":[{"Message":"Unable to apply the configuration changes because an import or export operation is currently in progress.","MessageArgs":["SecureBootEnable"],"MessageArgs@odata.count":1,"MessageId":"IDRAC.2.9.SYS431","RelatedProperties":["#/SecureBootEnable"],"RelatedProperties@odata.count":1,"Resolution":"Wait for the current import or export operation to complete and retry the operation. If the issue persists, contact your service provider.","Severity":"Warning"},{"Message":"Unable to complete the operation because the provider is not ready.","MessageArgs":[],"MessageArgs@odata.count":0,"MessageId":"IDRAC.2.9.RAC0508","RelatedProperties":[],"RelatedProperties@odata.count":0,"Resolution":"Wait for few minutes, refresh the page and retry. If the problem persists, reset the iDRAC and retry the operation.","Severity":"Critical"}],"code":"Base.1.12.GeneralError","message":"A general error has occurred. See ExtendedInfo for more information"}}secure boot has been set as false, you may need to reboot the node to take effect.
```
### storage
Check storages:
```shell
redfish-bash.sh storage
```
Example:
```shell
# redfish-bash.sh storage
{
"@odata.context": "/redfish/v1/$metadata#StorageCollection.StorageCollection",
"@odata.etag": "W/\"570254F2\"",
"@odata.id": "/redfish/v1/Systems/1/Storage",
"@odata.type": "#StorageCollection.StorageCollection",
"Description": "Storage subsystems known to this system",
"Name": "Storage",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/DA000000"
},
{
"@odata.id": "/redfish/v1/Systems/1/Storage/DA000001"
}
],
"Members@odata.count": 2
}
```
Check particular storage:
```shell
redfish-bash.sh storage DA000000
```
Example:
```shell
# redfish-bash.sh storage DA000000
{
"@odata.context": "/redfish/v1/$metadata#Storage.Storage",
"@odata.etag": "W/\"836C2E84\"",
"@odata.id": "/redfish/v1/Systems/1/Storage/DA000000",
"@odata.type": "#Storage.v1_12_0.Storage",
"Id": "DA000000",
"Controllers": {
"@odata.id": "/redfish/v1/Systems/1/Storage/DA000000/Controllers"
},
"Drives": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/DA000000/Drives/DA000000/"
}
],
"Links": {
"Enclosures": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
]
},
"Name": "NVMe Storage System",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"StorageControllers": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/DA000000#/StorageControllers/0/",
"FirmwareVersion": "EDA7602Q",
"Identifiers": [],
"Location": {
"PartLocation": {
"LocationOrdinalValue": 10,
"LocationType": "Slot",
"ServiceLabel": "Slot 10"
}
},
"MemberId": "0",
"Model": "SAMSUNG MZ1LB1T9HALS-00007",
"Name": "NVMe Storage Controller",
"SerialNumber": "S436NA0R757299",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"SupportedControllerProtocols": [
"PCIe"
],
"SupportedDeviceProtocols": [
"NVMe"
]
}
]
}
```
### get
If any command above cannot satisfy your needs, you can use command 'get' to fetch the information:
```shell
redfish-bash.sh get
```
Example:
```shell
# redfish-bash.sh get
{
"@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot",
"@odata.etag": "\"1710499398\"",
"@odata.id": "/redfish/v1",
"@odata.type": "#ServiceRoot.v1_5_2.ServiceRoot",
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"CertificateService": {
"@odata.id": "/redfish/v1/CertificateService"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"CompositionService": {
"@odata.id": "/redfish/v1/CompositionService"
},
"Description": "The service root for all Redfish requests on this host",
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"Id": "RootService",
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Name": "Root Service",
"Oem": {
"Ami": {
"@odata.type": "#AMIServiceRoot.v1_0_0.AMIServiceRoot",
"InventoryDataStatus": {
"@odata.id": "/redfish/v1/Oem/Ami/InventoryData/Status"
},
"RtpVersion": "1.8.a",
"configurations": {
"@odata.id": "/redfish/v1/configurations"
}
}
},
"Product": "AMI Redfish Server",
"ProtocolFeaturesSupported": {
"ExcerptQuery": true,
"ExpandQuery": {
"ExpandAll": false,
"Levels": false,
"Links": false,
"MaxLevels": 5,
"NoLinks": false
},
"FilterQuery": true,
"OnlyMemberQuery": true,
"SelectQuery": true
},
"RedfishVersion": "1.8.0",
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"TelemetryService": {
"@odata.id": "/redfish/v1/TelemetryService"
},
"UUID": "5a544443-4110-0031-3150-d04b30303633",
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"Vendor": "AMI"
}
```
```shell
# redfish-bash.sh get /redfish/v1/TelemetryService
{
"@odata.context": "/redfish/v1/$metadata#TelemetryService.TelemetryService",
"@odata.etag": "\"1710499398\"",
"@odata.id": "/redfish/v1/TelemetryService",
"@odata.type": "#TelemetryService.v1_2_1.TelemetryService",
"Actions": {
"#TelemetryService.SubmitTestMetricReport": {
"@Redfish.ActionInfo": "/redfish/v1/TelemetryService/SubmitTestMetricReportActionInfo",
"target": "/redfish/v1/TelemetryService/Actions/TelemetryService.SubmitTestMetricReport"
}
},
"Description": "TelemetryService",
"Id": "TelemetryService",
"LogService": {
"@odata.id": "/redfish/v1/TelemetryService/LogService"
},
"MaxReports": 5,
"MetricDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
},
"MetricReportDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
},
"MetricReports": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports"
},
"MinCollectionInterval": "PT5S",
"Name": "TelemetryService",
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"State": "Enabled"
},
"SupportedCollectionFunctions": [
"Average",
"Maximum",
"Summation",
"Minimum"
],
"SupportedCollectionFunctions@Redfish.AllowableValues": [
"Average",
"Maximum",
"Summation",
"Minimum"
],
"Triggers": {
"@odata.id": "/redfish/v1/TelemetryService/Triggers"
}
}
```
## How to extend?
Check if you can do with the existing command(s), If yes maybe add a new example in the instruction. If Not,
based on what function you are going to add, consider which command name you are going to use, define the function in the script like below:
your_command_name(){
logic here
}
Then add usage or example in function usage(), that is it, then you can test it on your target server(s).