drpcli machines¶
drpcli machines¶
Manage and interact with machines resources
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 machines action - Show details for a specific action on the machine
- drpcli machines actions - List all available actions for the machine
- drpcli machines add - Add a parameter to a machine, failing if the key already exists
- drpcli machines addprofile - Add one or more profiles to a machine's profile list
- drpcli machines addtask - Append a task to the end of a machine's task list
- drpcli machines await - Wait for a machine's field to become a value within a number of seconds
- drpcli machines bootenv - Set the
bootenvfor a machine - drpcli machines cleanup - Cleanup a machine by removing associated runtime state
- drpcli machines connections - List active API and WebSocket connections for this machine
- drpcli machines count - Count all machines
- drpcli machines create - Create a new machine with the passed-in JSON or string key
- drpcli machines currentlog - Get the log for the most recent job run on the machine
- drpcli machines deletejobs - Delete all jobs associated with machine
- drpcli machines deleteworkorders - Delete all work orders associated with machine
- drpcli machines destroy - Destroy machine by id
- drpcli machines etag - Get the etag for a machines by id
- drpcli machines exists - See if a machines exists by id
- drpcli machines fieldinfo - Return the documentation for all the fields or the provided field
- drpcli machines generate - Generate an object of machines type in the content directory
- drpcli machines get - Get a single parameter value from a machine
- drpcli machines indexes - Get indexes for machines
- drpcli machines inserttask - Insert a task at a position relative to the currently running task on a machine
- drpcli machines inspect - Deep-inspect task and job execution history on DRP machines
- drpcli machines jobs - Access commands for manipulating the current job on a machine
- drpcli machines list - List all machines
- drpcli machines meta - Get all metadata key/value pairs for a machine
- drpcli machines migrate - Migrate a machine from the current endpoint to another DRP endpoint
- drpcli machines migrateTicket - Get a migration ticket for moving machines to this endpoint
- drpcli machines params - Get or set all parameters for a machine
- drpcli machines patch - Patch machine by ID using the passed-in JSON Patch
- drpcli machines pause - Mark the machine as NOT runnable
- drpcli machines processjobs - Process the pending task list on a machine until done
- drpcli machines releaseToPool - Release this machine back to its pool
- drpcli machines remove - Remove a parameter from a machine
- drpcli machines removeprofile - Remove one or more profiles from a machine's profile list
- drpcli machines removetask - Remove the first occurrence of a task from a machine's task list
- drpcli machines render - Render a Go template string in the context of a machine
- drpcli machines run - Mark the machine as runnable
- drpcli machines runaction - Run a plugin action on a machine
- drpcli machines set - Set a parameter on a machine, creating or replacing the value
- drpcli machines show - Show a single machines by id
- drpcli machines stage - Set the machine's stage
- drpcli machines start - Start or restart the machine's workflow
- drpcli machines tasks - Access task manipulation for machines
- drpcli machines update - Unsafely update machine by id with the passed-in JSON
- drpcli machines uploadiso - This will attempt to upload the ISO from the specified ISO URL.
- drpcli machines wait - Wait for a machine's field to become a value within a number of seconds
- drpcli machines whoami - Find the machine UUID that best matches the current system's hardware
- drpcli machines work_order - Manage the work order queue and work order mode for a machine
- drpcli machines workflow - Set the machine's workflow