Change existing format of REDFISH-cheatsheet.md
removed $ on each of curl commands
removed bullets and used horizontal rules to break up cheatsheet
Signed-off-by: Timothy W. Kilmer <Timothy.Kilmer@ibm.com>
Change-Id: Id8cc03758370aa4148fd99e9ac568036adea8143
diff --git a/REDFISH-cheatsheet.md b/REDFISH-cheatsheet.md
index 5278fc8..56ccb8a 100644
--- a/REDFISH-cheatsheet.md
+++ b/REDFISH-cheatsheet.md
@@ -4,91 +4,117 @@
## Query Root
```
-$ export bmc=xx.xx.xx.xx
-$ curl -b cjar -k https://${bmc}/redfish/v1
+export bmc=xx.xx.xx.xx
+curl -b cjar -k https://${bmc}/redfish/v1
```
-## Establish Redfish connection session
-- Method 1
- ```
- $ export bmc=xx.xx.xx.xx
- $ curl --insecure -X POST -D headers.txt https://${bmc}/redfish/v1/SessionService/Sessions -d '{"UserName":"root", "Password":"0penBmc"}'
- ```
- A file, headers.txt, will be created. Find the `"X-Auth-Token"`
- in that file. Save it away in an env variable like so:
- ```
- export bmc_token=<token>
- ```
-- Method 2
- ```
- $ export bmc=xx.xx.xx.xx
- $ export token=`curl -k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" : "root", "password" : "0penBmc"}' | grep token | awk '{print $2;}' | tr -d '"'`
- $ curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/...
- ```
- Note: Method 2 is used in this document.
+---
+
+## Establish Redfish connection session
+##### Method 1
+```
+export bmc=xx.xx.xx.xx
+curl --insecure -X POST -D headers.txt https://${bmc}/redfish/v1/SessionService/Sessions -d '{"UserName":"root", "Password":"0penBmc"}'
+```
+A file, headers.txt, will be created. Find the `"X-Auth-Token"`
+in that file. Save it away in an env variable like so:
+
+```
+export bmc_token=<token>
+```
+
+##### Method 2
+```
+export bmc=xx.xx.xx.xx
+export token=`curl -k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" : "root", "password" : "0penBmc"}' | grep token | awk '{print $2;}' | tr -d '"'`
+curl -k -H "X-Auth-Token: $token" https://${bmc}/redfish/v1/...
+```
+Note: Method 2 is used in this document.
+
+---
+
## View Redfish Objects
```
-$ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Chassis
-$ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Managers
-$ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems
+curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Chassis
+curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Managers
+curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems
```
+
+---
+
## Host power
-- Host soft power off:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "GracefulShutdown"}'
- ```
-- Host hard power off:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "ForceOff"}'
- ```
-- Host power on:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "On"}'
- ```
-- Reboot Host:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "GracefulRestart"}'
- ```
+Host soft power off:
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "GracefulShutdown"}'
+```
+
+Host hard power off:
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "ForceOff"}'
+```
+
+Host power on:
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "On"}'
+```
+
+Reboot Host:
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset -d '{"ResetType": "GracefulRestart"}'
+```
+
+---
+
## Log entry
-- Display logging entries:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries
- ```
-- Delete logging entries:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.Reset
- ```
+Display logging entries:
+```
+curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries
+```
+
+Delete logging entries:
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.Reset
+```
+
+---
+
## Firmware ApplyTime:
- ```
-$ curl -k -H "X-Auth-Token: $token" -X PATCH -d '{ "ApplyTime":"Immediate"}' https://${bmc}/redfish/v1/UpdateService
- ```
+```
+curl -k -H "X-Auth-Token: $token" -X PATCH -d '{ "ApplyTime":"Immediate"}' https://${bmc}/redfish/v1/UpdateService
+```
or
```
-$ curl -k -H "X-Auth-Token: $token" -X PATCH -d '{ "ApplyTime":"OnReset"}' https://${bmc}/redfish/v1/UpdateService
+curl -k -H "X-Auth-Token: $token" -X PATCH -d '{ "ApplyTime":"OnReset"}' https://${bmc}/redfish/v1/UpdateService
```
+
+---
+
## Firmware update
-- Firmware update:
- Note the `<image file path>` must be a tarball.
+Firmware update:
+Note the `<image file path>` must be a tarball.
- ```
- $ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" -X POST -T <image file path> https://${bmc}/redfish/v1/UpdateService
- ```
-- TFTP Firmware update using TransferProtocol:
- Note: The `<image file path>` contains the address of the TFTP service: `xx.xx.xx.xx/obmc-phosphor-xxxxx-xxxxxxxxx.static.mtd.tar`
+```
+curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/octet-stream" -X POST -T <image file path> https://${bmc}/redfish/v1/UpdateService
+```
+TFTP Firmware update using TransferProtocol:
+Note: The `<image file path>` contains the address of the TFTP service: `xx.xx.xx.xx/obmc-phosphor-xxxxx-xxxxxxxxx.static.mtd.tar`
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate -d '{"TransferProtocol":"TFTP","ImageURI":"<image file path>"}'
- ```
-- TFTP Firmware update with protocol in ImageURI:
- ```
- $ curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate -d '{"ImageURI":"tftp://<image file path>"}'
- ```
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate -d '{"TransferProtocol":"TFTP","ImageURI":"<image file path>"}'
+```
+TFTP Firmware update with protocol in ImageURI:
+```
+curl -k -H "X-Auth-Token: $token" -X POST https://${bmc}/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate -d '{"ImageURI":"tftp://<image file path>"}'
+```
+
+---
+
## Update "root" password
Change password to "0penBmc1":
```
-$ curl -k -H "X-Auth-Token: $token" -X PATCH -d '{"Password": "0penBmc1"}' https://${bmc}/redfish/v1/AccountService/Accounts/root
+curl -k -H "X-Auth-Token: $token" -X PATCH -d '{"Password": "0penBmc1"}' https://${bmc}/redfish/v1/AccountService/Accounts/root
```
## BIOS firmware boot control