ICM Commands and Options - InterSystems Cloud Manager Guide - InterSystems IRIS Data Platform 2019.2

Command	Description	Important Options
provision	Provisions compute nodes	-definitions, -defaults, -instances
inventory	Lists provisioned compute nodes	-machine, -role, -json
unprovision	Destroys compute nodes	-stateDir, cleanup, force
ssh	Executes an operating system command on one or more compute nodes	-command, -machine, -role
scp	Copies a local file to one or more compute nodes	-localPath, -remotePath, -machine, -role
run	Deploys a container on compute nodes	-image, -container, -namespace, -options, -iscPassword, -command, -machine, -role
ps	Displays run states of containers deployed on compute nodes	-container, -json
stop	Stops containers on one or more compute nodes	-container, -machine, -role
start	Starts containers on one or more compute nodes	-container, -machine, -role
pull	Downloads an image to one or more compute nodes	-image, -container, -machine, -role
rm	Deletes containers from one or more compute nodes	-container, -machine, -role
upgrade	Replaces containers on one or more compute nodes	-image, -container, -machine, -role
exec	Executes an operating system command in one or more containers	-container, -command, -interactive. -options, -machine, -role
session	Opens an interactive session for an InterSystems IRIS instance in a container or executes an InterSystems IRIS ObjectScriptScript snippet on one or more instances	-namespace, -command, -interactive, , -options, -machine, -role
cp	Copies a local file to one or more containers	-localPath, -remotePath, -machine, -role
sql	Executes a SQL statement on the InterSystems IRIS instance	-namespace, -command, -machine, -role
docker	Executes a Docker command on one or more compute nodes	-container, -machine, -role

Option	Meaning	Default	Described in
-help	Display command usage information and ICM version		---
-version	Display ICM version		---
-verbose	Show execution detail	False	(can be used with any command)
-definitions filepath	Compute node definitions file	./definitions.json	Configuration, State and Log Files The icm provision Command
-defaults filepath	Compute node defaults file	./defaults.json
-instances filepath	Compute node instances file	./instances.json
-stateDir dir	Machine state directory	OS-specific	The State Directory and State Files The icm provision Command Unprovision the Infrastructure
-force	Don't confirm before reprovisioning or unprovisioning	False	The icm provision Command Unprovision the Infrastructure
-cleanUp	Delete state direcorty after unprovisioning	False	Unprovision the Infrastructure
-machine regexp	Target machine name pattern match	(all)	icm inventory icm ssh icm run icm exec icm session
-role role	Role of the InterSystems IRIS instance or instances for which a command is run, for example DM or QS	(all)	icm inventory icm ssh icm run icm exec
-namespace namespace	Namespace to create on deployed InterSystems IRIS instances and set as default execution namespace for the session and sql commands	USER	The Definitions File icm run icm session icm sql
-image image	Docker image to deploy; must include repository name.	DockerImage value in definitions file	icm run icm upgrade
-options options	Additional Docker options	none	icm run icm exec icm session Using ICM with Custom and Third-Party Containers
-container name	Name of the container	icm ps command: (all) other commands: iris	icm run
-command cmd	Command or query to execute	none	icm ssh icm run icm exec icm session icm sql
-interactive	Redirect input/output to console for the exec and ssh commands	False	icm ssh icm exec
-localPath path	Local file or directory	none	icm scp icm cp
-remotePath path	Remote file or directory	/home/SSHUser (value of SSHUser field)	icm scp icm cp
-iscPassword password	Password for deployed InterSystems IRIS instances	iscPassword value in configuration file	icm run
-json	Enable JSON response mode	False	Using JSON Mode