checkports¶
drpcli preflight checkports¶
Verify that required DRP service ports are not already in use
Synopsis¶
Check that the ports DRP needs are free before installation.
The set of ports checked is controlled by environment variables:
RS_DISABLE_DHCP- skip DHCP port check (default port: 67/udp)RS_DISABLE_TFTP_SERVER- skip TFTP port check (default port: 69/udp)RS_DISABLE_DNS- skip DNS port checks (default port: 53/udp and 53/tcp)RS_DISABLE_PXE- skip BINL/PXE port check (default port: 4011/tcp)RS_DISABLE_PROVISIONER- skip static file server port (default port: 8091/tcp)RS_DISABLE_SECURE_PROVISIONER- skip secure static port (default port: 8090/tcp)
Port defaults can also be overridden individually using the corresponding
RS_<SERVICE>_PORT environment variables. The Metrics (8080/tcp) and API
(8092/tcp) ports are always checked.
Output is a JSON object listing any ports in use (Services) and any
ports that could not be checked due to insufficient privileges (Warnings).
Ports below 1024 require root to test; running as a non-root user will
produce a warning for those ports rather than a definitive in-use result.
Examples¶
# Check all enabled DRP service ports
drpcli preflight checkports
# Check ports while skipping DHCP (e.g., DHCP is managed elsewhere)
RS_DISABLE_DHCP=1 drpcli preflight checkports
# Use a custom API port and check
RS_API_PORT=9092 drpcli preflight checkports
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 preflight - Run pre-installation validation checks before deploying
dr-provision