drpcli extended¶
drpcli extended¶
Manage extended DRP objects by --ldata type
Synopsis¶
The extended command provides CRUD access to plugin-provided or
dynamically registered object types that are not part of the core DRP schema.
Use the --ldata flag to specify the extended object type name. This allows
operators to manage arbitrary object types contributed by plugins without
requiring dedicated CLI commands for each type.
Common operations:
drpcli extended list --ldata <type>- list all objects of the extended typedrpcli extended show --ldata <type> <key>- show a specific objectdrpcli extended create --ldata <type> <json>- create a new objectdrpcli extended update --ldata <type> <key> <json>- update an objectdrpcli extended destroy --ldata <type> <key>- delete an object
Examples¶
# List all objects of an extended type provided by a plugin
drpcli extended list --ldata my-plugin-type
# Show a specific extended object
drpcli extended show --ldata my-plugin-type my-object-key
# Create a new extended object from JSON
drpcli extended create --ldata my-plugin-type - < object.json
# Update an extended object
drpcli extended update --ldata my-plugin-type my-object-key '{"Field":"value"}'
# Delete an extended object
drpcli extended destroy --ldata my-plugin-type my-object-key
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 extended action - Show details for a specific action on the extended
- drpcli extended actions - List all available actions for the extended
- drpcli extended add - Add a parameter to a extended, failing if the key already exists
- drpcli extended addprofile - Add one or more profiles to a extended's profile list
- drpcli extended await - Wait for a extended's field to become a value within a number of seconds
- drpcli extended count - Count all
- drpcli extended create - Create a new extended with the passed-in JSON or string key
- drpcli extended destroy - Destroy extended by id
- drpcli extended etag - Get the etag for a by id
- drpcli extended exists - See if a exists by id
- drpcli extended fieldinfo - Return the documentation for all the fields or the provided field
- drpcli extended generate - Generate an object of type in the content directory
- drpcli extended get - Get a single parameter value from a extended
- drpcli extended indexes - Get indexes for
- drpcli extended list - List all
- drpcli extended meta - Get all metadata key/value pairs for a extended
- drpcli extended params - Get or set all parameters for a extended
- drpcli extended patch - Patch extended by ID using the passed-in JSON Patch
- drpcli extended remove - Remove a parameter from a extended
- drpcli extended removeprofile - Remove one or more profiles from a extended's profile list
- drpcli extended runaction - Run a plugin action on a extended
- drpcli extended set - Set a parameter on a extended, creating or replacing the value
- drpcli extended show - Show a single by id
- drpcli extended update - Unsafely update extended by id with the passed-in JSON
- drpcli extended uploadiso - This will attempt to upload the ISO from the specified ISO URL.
- drpcli extended wait - Wait for a extended's field to become a value within a number of seconds