ICM Commands and Options

ICM Commands and Options

The first table that follows lists the commands that can be executed on the ICM command line. Each of the commands is covered in detail in Using ICM.

The second table lists the options that can be used with commands. Command-line options serve two purposes, as follows:

• To provide required or optional arguments to commands. For example, to list the run state of only the InterSystems IRIS containers in your deployment, you could use this command:

  icm ps -container iris
  

  

  To execute a command to open a shell inside the container deployed on node ANDY-DM-TEST, you could use this command:

  icm exec -command bash -machine ANDY-DM-TEST -interactive
  

  

• To override a field’s default or configuration file value, in one of two ways:

  • The -image, –namespace, and -iscpassword options can be used to override the values of the DockerImage, Namespace, and ISCPassword fields, respectively, in any command, including icm provision.

  • Following the provisioning phase, the -overrides option can be used to override the values of one or more fields for the current command only. For example, assume your defaults file includes the following fields:

    "DockerUsername": "prodriguez",
    "DockerPassword": "xxxxxxx",
    "DockerRegistry": "https://containers.intersystems.com",
    "DockerImage": "containers.intersystems.com/intersystems/iris:2022.1.0.223.0",
    

    

    When executing the icm provision command you could override the Dockermage field using the -image option, but not to use an image from a different registry, because you could not override the registry location and credentials. In the icm upgrade command, however, you could specify an image from a different registry by using the -overrides option to override all three fields, for example:

    icm upgrade -overrides '{"DockerUsername":"mwyszynska","DockerPassword":"xxxxxx",
      "DockerRegistry":"docker.io"}' -image docker.io/acme/iris:latest-em
    

    
    Note:

    When -overrides is used with the icm run, icm install, or icm upgrade commands to specify field values that are intended to persist, these should be updated in the instances.json file so they won't be reverted during a subsequent reprovisioning operation. Following the icm upgrade command above, for example, the DockerImage, DockerRegistry, DockerUsername, and DockerPassword fields should be updated in the instances file. (The -image, –namespace, and -iscpassword options automatically do this.)

Both tables include links to relevant text.