KB 00011¶
By default, Digital Rebar Platform provides returned output in JSON
format. It's possible to have the returned format converted to YAML via
the use of --format=yaml. In addition, more "human readable"
output formats can be specified. This article describes how to produce
human readable table output.
Note
This feature is experimental and minimally implemented. If you have issues or enhancements related to this featuere, please contact RackN or file a new Github issue
Solution¶
To access the human readable format output, use the --format flag to
the drpcli command line tool.
These output formats can be configured by setting environment shell variables, or use of the .drpclirc (see: rs_drpclirc) file for setting default usage.
The shell environment variables are as follows.
| value | notes |
|---|---|
RS_FORMAT |
command line output format to use (json,yaml,text,table) |
RS_PRINT_FIELDS |
comma separate list of fields to show in output "table" or "text" format |
RS_NO_HEADER |
remove the header fields from "table" or "text" format output |
RS_TRUNCATE_LENGTH |
limits the length of fields displayed for "table" or "text" output formats |
Setting environment variables
drpcli usage
drpcli subnets list --format table
drpcli machines list --format table --print-fields Name,Uuid,Workflow,Stage,BootEnv --no-header
drpcli machines list --format table --print-fields Name,Uuid,Workflow,Stage,BootEnv
drpcli profiles list --format table --truncate-length 30
drpcli machines params Name:jane --format=table --truncate-length=120
drpcli extended -l endpoints list --format table --truncate-length 30
Additional Information¶
Additional resources and information related to this Knowledge Base article.
See Also¶
Versions¶
- v4.2.0-beta2.0 or newer