Replicated CLI Reference

Generated documentation on the default Replicated CLI commands available for all Replicated installed instances.

After installing replicated onto a remote host a CLI is enabled that can be utilized for both management and maintenance. This tool can be especially helpful when debugging issues that can arise if the replicated-ui is not fully installed or working properly.

Source replicated.alias

If command not found is displayed when attempting to execute the replicated CLI we will need to source the replicated.alias file.

source /etc/replicated.alias

Version

List version of currently running replicated components.

replicated -version

Status

This provides the current status of replicated.

replicated status

Apps

List ID, Sequence, and Status of running app and prior versions installed on this host.

replicated apps

App

App sub-commands allow manipulating app state and version.

Show app info in JSON format

replicated app <appid>

App state

Show and modify app state

replicated app <appid> status|components|rm|start|stop|pause|unpause|settings
Command Description
v2.0 status Show app status (Started, Paused, etc)
components List app components
rm Delete app
start | stop | pause | unpause Transition app into the specified state
v2.1 settings Export app settings in JSON format

The settings command is useful for automating an installation.

Sometimes app state might be locked for extended periods of time depending on the app launch procedure and various timeout settings. In cases like this, app can be forced to transition into the Stopped state by using the -f switch.

replicated app <app_id> stop -f

App updates

Trigger a check for updates. The -f switch can be used to ignore local cache and perform full YAML sync for pending updates.

replicated app <app_id> update-check -f

v2.2 List pending updates. Note that this will not trigger an update check.

replicated app <app_id> updates list

v2.0 Install the specified app version. Note that all preceding required versions will be installed as well.

Obsolete

This command has been superseded by the next command.

replicated app <appid> update install <sequence number>

v2.2 Install the specified app version. Note that all preceding required versions will be installed as well.

replicated app <appid> updates install <sequence number>

App preflight checks

v2.2 Run preflight checks

replicated app <appid> run-checks

v2.2 Show preflight checks status

replicated app <appid> run-checks status

v2.2 Dismiss preflight checks errors and warnings

replicated app <appid> run-checks dismiss

Generate Support Bundle

v1.2.63 Generate support bundle.

replicated support-bundle <app-id>

Reset your On-Prem UI password

Your console password can be reset by issuing the following command from the host machine where Replicated has been installed. (then visit https://<server>:8800/create-password and set a new password)

replicated auth reset

Hosts

v1.2 This lists all known hosts that are currently in use by Replicated. It includes the following information for each host : ID, NAME, PRIVATE ADDRESS, PUBLIC ADDRESS, CONNECTED, PROVISIONED, AGENT VERSION, API VERSION, TAGS

replicated hosts

v2.0 This lists all known nodes that are currently in use by Replicated. It includes the following information for each host: ID, PRIVATE ADDRESS, PUBLIC ADDRESS, CONNECTED, INITIALIZED, VERSION, TAGS

replicated nodes

Certificate Configuration via CLI

You can set the hostname, key, and cert using the following command.

replicated console cert set <hostname> /path/to/key /path/to/cert

Tasks

Show the running processes inside replicated.

replicated tasks

Show Logs of a Task

Using this command you can see the logs associated with a given task. Note: task-id is retrieved utilizing the apps command.

replicated task <task-id> logs

Snapshots

v2.5.0 Show available snapshots for an installed app. This command will use settings for installed app to discover information about snapshots.

replicated snapshot list app <app id>

v2.5.0 Show available snapshots from a location on the local file system. This command can be used when application has not been installed yet in cases when recovery from a snapshot is needed.

replicated snapshot list location <location>

v2.8.0 Start a snapshot. When the optional --wait flag is specified, the command will block until the current snapshot is complete. The optional --exclude-app-data flag indicates to back up only Replicated data, excluding all vendor application data from the snapshot.

replicated snapshot start <app id>:<version> --wait --exclude-app-data

v2.5.0 Restore an application from the specified snapshot. When optional --dismiss-prechecks flag is specified, failed preflight checks will be ignored. The optional --node-timeout flag indicates how long to wait for the initial node to connect. The default is 60 seconds.

Warning

This command cannot be used on a system with an already installed license.

replicated snapshot restore <location> <snapshot id> --dismiss-prechecks --node-timeout <seconds>

Admin

Additionally you can define ad-hoc commands that can be executed inside a running container, see the dedicated Admin Commands section for more details.