drpcli license¶
drpcli license¶
Manage and inspect the DRP license
Synopsis¶
The license commands provide access to the DigitalRebar Provision (DRP) licensing
system. DRP uses a license bundle (rackn-license content pack) to control access
to features, limit the number of managed endpoints, and track entitlements.
License operations include: - Inspecting current license features, expiry dates, and endpoint limits - Checking and updating the license against the RackN license server - Downloading and uploading license content packs - Airgap workflows for environments without direct internet access
The license is stored on the DRP server as the rackn-license profile, which
contains the encrypted license token (rackn/license) and a JWT for authentication
with the RackN licensing service.
Most subcommands require a running DRP server. The ping and postAirgapReport
commands can be used without DRP server access.
Examples¶
# Show the decoded license contents
drpcli license get
# Check which features are currently licensed
drpcli license features
# Check if the license is valid and up to date
drpcli license check
# Get the license expiry date
drpcli license expiry
# Update the license from the RackN license server and upload it
drpcli license update --upload
# Download the license content pack to a file
drpcli license download --output my-license.json
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 license addEndpoint - Add a new endpoint ID to the license via the RackN license server
- drpcli license check - Verify the license is valid and up to date with the RackN license server
- drpcli license counts - Show current resource counts compared to the upto-nodes license limits
- drpcli license download - Download the current license as a content pack from the DRP server
- drpcli license endpoints - List the licensed DRP endpoints from the current license
- drpcli license expiry - Get the license expiry date, exits with status 1 if expired
- drpcli license features - List the currently active licensed features
- drpcli license get - Get the current decoded license bundle from the DRP server
- drpcli license getAirgapReport - Generate a billing report for airgap license renewal
- drpcli license getJwt - Get the RackN license JWT authentication token from the DRP server
- drpcli license getRaw - Get the current encrypted license token from the DRP server
- drpcli license hasFeature - Exit with an error if the named feature is not in the active license
- drpcli license limits - Show the licensed node/resource limits from the upto-nodes license entry
- drpcli license ping - Test connectivity to the RackN license server
- drpcli license postAirgapReport - Submit an airgap billing report to RackN and save the returned license
- drpcli license update - Fetch an updated license from the RackN license server
- drpcli license upload - Upload a license content pack file to the DRP server