ux_options options¶
drpcli ux_options¶
Manage DRP web UI ux_options configuration settings
Synopsis¶
UX options are configuration objects that control option choices and selection lists presented in the DigitalRebar Provision web UI.
ux_options allow administrators to customize drop-down lists, selection
menus, and other option-driven UI elements without modifying the UI code directly.
Content packs and plugins can contribute ux_options to extend the UI.
Common operations:
drpcli ux_options list- list all defined UX optionsdrpcli ux_options show <name>- display a specific UX optiondrpcli ux_options create <json>- create a new UX optiondrpcli ux_options update <name> <json>- update an existing UX optiondrpcli ux_options destroy <name>- remove a UX option
Examples¶
# List all UX options
drpcli ux_options list
# Show a specific UX option by name
drpcli ux_options show bootenv-choices
# Create a UX option from a JSON file
drpcli ux_options create - < ux_option.json
# Update a UX option
drpcli ux_options update bootenv-choices '{"Description":"Updated bootenv options"}'
# Destroy a UX option
drpcli ux_options destroy bootenv-choices
Options¶
Options inherited from parent commands¶
--ca-cert string CA certificate used to verify the server certs (with the system set)
-c, --catalog string The catalog file to use to get product information (default "https://repo.rackn.io")
--catalog-path string The path to where the catalog file exists on the drp server. By default and historically this has been /files/rebar-catalog. For example, if no catalog urls are provided, the complete path will be https://drp-ip:8090/files/rebar-catalog (default "/files/rebar-catalog")
-S, --catalog-source string A location from which catalog items can be downloaded. For example, in airgapped mode it would be the local catalog
--client-cert string Client certificate to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
--client-key string Client key to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
-C, --colors string The colors for JSON and Table/Text colorization. 8 values in the for 0=val,val;1=val,val2... (default "0=32;1=33;2=36;3=90;4=34,1;5=35;6=95;7=32;8=92")
-d, --debug Whether the CLI should run in debug mode
-D, --download-proxy string HTTP Proxy to use for downloading catalog and content
-E, --endpoint string The Digital Rebar Provision API endpoint to talk to (default "https://127.0.0.1:8092")
-X, --exit-early Cause drpcli to exit if a command results in an object that has errors
--fetch-catalogs all Determines which catalog urls to use to fetch the catalog. If set to all, all the catalog urls defined with catalog_url and catalog_urls as well as the default catalog will be used. If set to server, only the catalog urls defined on the server will be used. If set to cli, then the specific url specified with the -c flag will be used. It defaults to `all`. Allowed values `all, `server`, `cli`. (default "all")
-f, --force When needed, attempt to force the operation - used on some update/patch calls
--force-new-session Should the client always create a new session
-F, --format string The serialization we expect for output. Can be "json" or "yaml" or "text" or "table" (default "json")
--http-request-retry-count int Specifies the number of retries for downloads in case of failure
--http-request-retry-delay-max int Specifies the maximum delay (in seconds) between HTTP/HTTPS retry attempts (default 60)
--ignore-unix-proxy Should the client ignore unix proxies
-N, --no-color Whether the CLI should output colorized strings
-H, --no-header Should header be shown in "text" or "table" mode
-x, --no-token Do not use token auth or token cache
-P, --password string password of the Digital Rebar Provision user (default "r0cketsk8ts")
-p, --platform string Platform to filter details by. Defaults to current system. Format: arch/os
-J, --print-fields string The fields of the object to display in "text" or "table" mode. Comma separated
-r, --ref string A reference object for update commands that can be a file name, yaml, or json blob
--server-verify Should the client verify the server cert
-G, --show-global-help-flags Show global flags in help message
-T, --token string token of the Digital Rebar Provision access
-t, --trace string The log level API requests should be logged at on the server side
-Z, --trace-token string A token that individual traced requests should report in the server logs
-j, --truncate-length int Truncate columns at this length (default 40)
-u, --url-proxy string URL Proxy for passing actions through another DRP
-U, --username string Name of the Digital Rebar Provision user to talk to (default "rocketskates")
SEE ALSO¶
- drpcli - A CLI application for interacting with the DigitalRebar Provision API
- drpcli ux_options action - Show details for a specific action on the ux_option
- drpcli ux_options actions - List all available actions for the ux_option
- drpcli ux_options add - Add a parameter to a ux_option, failing if the key already exists
- drpcli ux_options await - Wait for a ux_option's field to become a value within a number of seconds
- drpcli ux_options count - Count all ux_options
- drpcli ux_options create - Create a new ux_option with the passed-in JSON or string key
- drpcli ux_options destroy - Destroy ux_option by id
- drpcli ux_options etag - Get the etag for a ux_options by id
- drpcli ux_options exists - See if a ux_options exists by id
- drpcli ux_options fieldinfo - Return the documentation for all the fields or the provided field
- drpcli ux_options generate - Generate an object of ux_options type in the content directory
- drpcli ux_options get - Get a single parameter value from a ux_option
- drpcli ux_options indexes - Get indexes for ux_options
- drpcli ux_options list - List all ux_options
- drpcli ux_options meta - Get all metadata key/value pairs for a ux_option
- drpcli ux_options params - Get or set all parameters for a ux_option
- drpcli ux_options patch - Patch ux_option by ID using the passed-in JSON Patch
- drpcli ux_options remove - Remove a parameter from a ux_option
- drpcli ux_options runaction - Run a plugin action on a ux_option
- drpcli ux_options set - Set a parameter on a ux_option, creating or replacing the value
- drpcli ux_options show - Show a single ux_options by id
- drpcli ux_options update - Unsafely update ux_option by id with the passed-in JSON
- drpcli ux_options uploadiso - This will attempt to upload the ISO from the specified ISO URL.
- drpcli ux_options wait - Wait for a ux_option's field to become a value within a number of seconds