Skip to main content
Previous sectionNext section

Controlling an InterSystems IRIS Instance

Controlling an InterSystems IRIS Instance

The iris command supports a number of functions beyond terminal, and is invoked in the format iris function instname arguments, where instname is the instance name that you chose during the installation and arguments depends on the platform and function. As previously noted, on Windows, run the command from the install-dir\bin directory (or include the full path with the command).

Typical uses of the iris command are shown in the following table.

Important:

The iris help command displays all the command functions and arguments; the file IRISHelp.html is in the install-dir\Help directory. Some platform-specific functions of the iris command are not listed in this table, but are shown in the help display; functions that are internal to InterSystems do not appear there.

Note:

The iris command often displays error information in a message box. You can suppress this message box by adding quietly as the final argument to the iris command, which runs the command non-interactively with minimal dialog. This argument is also useful with other commands, such as iris stop and iris stopstart when you want shut the instance down without having to confirm the command.

InterSystems IRIS iris Command Functions and Arguments
Command and Description Arguments
iris start instname [arguments] — Starts the instance.
Note:
You may be prompted to start in “Emergency Mode;” if so, see Emergency Access for more information.
[full pathname of .cpf file] — Starts InterSystems IRIS instance instname, optionally using the specified name.cpf file. If a name.cpf file is not specified, the InterSystems IRIS instance uses the iris.cpf file.
nostu — On all platforms except Windows, starts the specified instance without running ^STU.
iris startnostu instname — On Windows, starts the specified instance without running ^STU.  
iris stop instname [arguments] — Shuts down the instance. An optional /nofailover argument can be specified for stop. Specifying this option prevents triggering a mirror failover.
restart — On all platforms except Windows, starts the instance after shutting it down.
iris stopstart instname — On Windows, starts the instance after shutting it down. An optional /nofailover argument can be specified for stopstart. Specifying this option prevents triggering a mirror failover.  
iris stopnoshut instname — Shuts down the named instance using INTNOSHUT^SHUTDOWN. An optional /nofailover argument can be specified for stoponshut. Specifying this option prevents triggering a mirror failover.
Note:
Only the instance owner and irisusr can run INTNOSHUT^SHUTDOWN without logging into the Terminal.
 
iris force instname — Forces down the instance .  
iris list instname — Lists the following information for the specified instance, or fall all installed instances if none is specified:
  • Instance name (and installation type)
  • Installation directory
  • InterSystems IRIS version
  • Pathname of InterSystems IRIS parameter (.cpf) file
  • Superserver and webserver port numbers
  • Instance status, as follows
    • running
    • down
    • starting or stopping
    • incomplete start or stop, logins disabled
  • Instance’s system health state, if running (see System Monitor Health State in the “Using the System Monitor” chapter of the Monitoring Guide) (not included on Windows)
  • Mirror member type and status (if a mirror member) (see %SYSTEM.Mirror.GetMemberType() and %SYSTEM.Mirror.GetMemberStatus())
 
iris qlist — Lists essentially the same information for each instance as iris list, plus the JDBC Gateway port, but without labels and all on one line, separated by carets (^), in the following order. You can specify a single instance on the command line to display information for that instance only.
  • Instance name (and installation type)
  • Installation directory
  • InterSystems IRIS version
  • Instance status
  • Pathname of InterSystems IRIS parameter (.cpf) file
  • Superserver, webserver, and JDBC Gateway port numbers
  • Instance’s system health state, if running (not included on Windows)
  • Mirror member type and status (if a mirror member)
 
iris all
Lists the following information for all installed instances, one instance per line:
  • Instance status, as follows
    • <blank> (status unavailable, logins disabled)
    • dn (down or has crashed)
    • up (running)
    • st (starting or stopping)
  • Instance name
  • InterSystems IRIS version
  • Superserver port number
  • Installation directory
Note:
If you need complete information, such as for parsing or reporting purposes, use iris list.
 
iris allw — Lists the same information for each instance as iris all, without wrapping long field values. Lines longer than 80 characters may result.  
iris qall — On platforms other than Windows, lists the same information for each instance as iris all, except that long lines are truncated to 78 characters plus a terminating tilde (~).  
iris stat instname — Retrieves system statistics, except on Windows systems. The same as the irisstat utility (see the appendix “Monitoring InterSystems IRIS Using the irisstat Utility” in the C Monitoring Guide), which is available on Windows.  
iris rename instname newname — Renames the instance (not available on Windows systems).  
iris terminal instname — Opens the InterSystems Terminal for the instance.
-B — Enables system administrator emergency login to the Terminal (see Administrator Terminal Session in the “Licensing” chapter).
-b partition_size — Specifies the maximum partition size (in KB) for the process.
routine — Runs the named InterSystems IRIS routine in application mode in the Terminal for $Principal. (Windows only).
"[label[+offset]]^routine" — Specifies the name of an ObjectScript program to run in user mode. In addition to the specified formats, you can pass parameter lists consisting of string and/or numeric literals, as well as omitted (void) parameters, as follows:
  • "routine[([parameter-list])]"
  • "[label]^routine[([parameter-list])]"
  • "##CLASS(package.class).method[([parameter-list])]"
where, for example, parameter-list is specified in the form "string literal",,-+-000123.45600E+07, and omitted parameters are passed to the target as $Data(parameter)=0.
Note:
Whitespace and shell meta characters must be quoted in an operating-system dependent form.
-U namespace — Specifies the Terminal login namespace.
namespace — Used with routine, runs the routine in the indicated namespace (Windows only).
Note:
The namespace and -U arguments have no effect if you are starting InterSystems IRIS with a user account whose Startup Namespace is specified (see User Account Properties).
iris console instname — Opens the InterSystems Terminal in an operating system command window rather than a Terminal window. Same arguments as iris terminal.
iris run instname — Runs InterSystems IRIS in programmer mode with no input/output device for $Principal (Windows only). Same arguments as iris terminal.
iris runw instname routine — Runs the named InterSystems IRIS routine in application mode with no input/output device for $Principal (Windows only). When run from a batch script, the command waits for the InterSystems IRIS process to terminate before returning the exit code from the process. namespace — Runs the routine in the specified namespace.
Note:
The namespace argument has no effect if you are starting InterSystems IRIS with a user account whose Startup Namespace is specified (see User Account Properties).
iris help — Displays the most recent information about the iris command. start, stop, force — Display function-specific help for the start, stop, and force functions.