Contact Us 1-800-596-4880

CLI for Local Server Groups

Use the serverGroup commands to automate your Local Server Groups Processes. For more information about how to use these commands, refer to the Runtime Manager documentation.

Command Description

Adds server to a server group

Creates server group from servers

Describes server group

Deletes server group

Lists all server groups in the environment

Modifies server group

Removes server from a server group

runtime-mgr:serverGroup:add:server

> runtime-mgr:serverGroup:add:server [flags] <serverGroupId> <serverId>

Adds the server passed in serverId to the server group passed in serverGroupId.

This command accepts only the default flag --help.

runtime-mgr:serverGroup:create

> runtime-mgr:serverGroup:create [flags] <name> [serverIds...]

Creates a server group with the name passed in name using the server Id(s) passed as argument(s) thereafter.

This command accepts only the default flag --help.

runtime-mgr:serverGroup:describe

> runtime-mgr:serverGroup:describe [flags] <serverGroupId>

Describes the server group passed in serverGroupId.

This command accepts 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:serverGroup:delete

> runtime-mgr:serverGroup:delete [flags] <serverGroupId>

Deletes the server groups passed in serverGroupId. 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:serverGroup:list

> runtime-mgr:serverGroup:list [flags]

Lists all server groups 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:serverGroup:modify

> runtime-mgr:serverGroup:modify [flags] <serverGroupId>

Modifies the server group passed in serverGroupId.

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.

runtime-mgr:serverGroup:remove:server

> runtime-mgr:serverGroup:remove:server [flags] <serverGroupId> <serverId>

Removes the server passed in serverId from the server group passed in serverGroupId.

This command accepts only the default flag --help.