Contact Us 1-800-596-4880

CLI for Local Cluster Servers

Command Description

Adds server to cluster

Deletes cluster

Lists all clusters in the environment

Removes server from a cluster

Creates new cluster

Describes server cluster

Modifies cluster

runtime-mgr:cluster:add:server

> runtime-mgr:cluster:add:server [flags] <clusterId> <serverId>

This command adds the cluster in clusterId to the server passed in serverId.

This command accepts only the default flag --help.

runtime-mgr:cluster:delete

> runtime-mgr:cluster:delete [flags] <clusterId>

This command deletes the cluster passed in clusterId.

This command accepts only the default flag --help.

This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation.

runtime-mgr:cluster:list

> runtime-mgr:cluster:list [flags]

This command lists all clusters in the environment.

This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.

This command also accepts the default flag --help.

runtime-mgr:cluster:remove:server

> runtime-mgr:cluster:remove:server [flags] <clusterId> <serverId>

This command removes the server passed in serverId from the cluster passed in clusterId.

This command accepts only the default flag --help.

runtime-mgr:cluster:create

> runtime-mgr:cluster:create <name> [flags]

This command creates a cluster using the id passed in name.

Besides the default --help flag, this command also accepts:

Flag Description

--multicast

Whether cluster should be multicast

--server <id:ip>

Pair of server ID and IP address. Latter is optional for multicast cluster. Provide multiple values to add multiple servers

This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter.

runtime-mgr:cluster:describe

> runtime-mgr:cluster:describe [flags] <clusterId>

This command describes the cluster passed in clusterId.

This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.

This command also accepts the default flag --help.

runtime-mgr:cluster:modify

> runtime-mgr:cluster:modify [flags] <clusterId>

This command modifies the cluster passed in clusterId.
In order to update the id for the cluster, you need to pass the --name flag.

Besides the --name flag, this command also has the default --help flag.