fieldinfo¶
drpcli generate fieldinfo¶
Display field documentation for DRP object types
Synopsis¶
Look up and display documentation for fields on DRP object types.
Each subcommand corresponds to an object type (e.g. params, bootenvs,
machines). Run without arguments to show all documented fields; pass a
field name to display documentation for that specific field.
Use --full-object to include read-only fields in the output.
Examples¶
# Show all field documentation for params
drpcli generate fieldinfo params
# Show documentation for a specific field on machines
drpcli generate fieldinfo machines Workflow
# Include read-only fields in the output
drpcli generate fieldinfo machines --full-object
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 generate - Generate DRP content pack scaffolding and object YAML files
- drpcli generate fieldinfo blueprints - Show field documentation for
blueprintsobjects - drpcli generate fieldinfo bootenvs - Show field documentation for
bootenvsobjects - drpcli generate fieldinfo catalog_items - Show field documentation for
catalog_itemsobjects - drpcli generate fieldinfo contents - Show field documentation for
contentsobjects - drpcli generate fieldinfo contexts - Show field documentation for
contextsobjects - drpcli generate fieldinfo filters - Show field documentation for
filtersobjects - drpcli generate fieldinfo identity_providers - Show field documentation for
identity_providersobjects - drpcli generate fieldinfo instances - Show field documentation for
instancesobjects - drpcli generate fieldinfo params - Show field documentation for
paramsobjects - drpcli generate fieldinfo plugins - Show field documentation for
pluginsobjects - drpcli generate fieldinfo pools - Show field documentation for
poolsobjects - drpcli generate fieldinfo profiles - Show field documentation for
profilesobjects - drpcli generate fieldinfo reservations - Show field documentation for
reservationsobjects - drpcli generate fieldinfo roles - Show field documentation for
rolesobjects - drpcli generate fieldinfo stages - Show field documentation for
stagesobjects - drpcli generate fieldinfo store_objects - Show field documentation for
store_objectsobjects - drpcli generate fieldinfo subnets - Show field documentation for
subnetsobjects - drpcli generate fieldinfo tasks - Show field documentation for
tasksobjects - drpcli generate fieldinfo templates - Show field documentation for
templatesobjects - drpcli generate fieldinfo tenants - Show field documentation for
tenantsobjects - drpcli generate fieldinfo trigger_providers - Show field documentation for
trigger_providersobjects - drpcli generate fieldinfo triggers - Show field documentation for
triggersobjects - drpcli generate fieldinfo users - Show field documentation for
usersobjects - drpcli generate fieldinfo ux_options - Show field documentation for
ux_optionsobjects - drpcli generate fieldinfo ux_settings - Show field documentation for
ux_settingsobjects - drpcli generate fieldinfo ux_views - Show field documentation for
ux_viewsobjects - drpcli generate fieldinfo version_sets - Show field documentation for
version_setsobjects - drpcli generate fieldinfo workflows - Show field documentation for
workflowsobjects - drpcli generate fieldinfo zones - Show field documentation for
zonesobjects