Home | Previous Page | Next Page   Utility Reference > xctl: Execute Utilities Across Coservers >

Syntax

Read syntax diagramSkip visual syntax diagram>>-xctl--+------+--+-----+-------------------------------------->
         '- -Xs-'  +- -b-+
                   '- -i-'

>--+----------------+--+-----------------------+--+- -C--------------------------------+-->
   '- -d--directory-'  |      .-,------------. |  '- -c--+-coserver_num--------------+-'
                       |      V              | |         | .-,---------------------. |
                       '- -e----env_var_name-+-'         | V                       | |
                                                         '---start_num-----end_num-+-'

>--command--+--------+-----------------------------------------><
            '-c-opts-'

Element Purpose
-Xs Specifies a substitution character that stands for the coserver number. Replace s with a substitution character that can be used in arguments to command. Use = or . as substitution characters. For details, see Specifying Coservers. You might need to use an escape character before some special characters to prevent interpretation by a particular operating-system shell.
-b Indicates that the command or operation is to be performed in the background on each applicable node.
-i Indicates that xctl is to print a message command or that operation is to be performed interactively; xctl asks for confirmation before it routes the command to each node.
-ddirectory Specifies the name of the directory on each applicable node in which to perform the command; directory must be a valid pathname on the target node or nodes. Do not type a space between -d and the directory name.
-e en_var_name Specifies an environment variable to export to each node. The variable must be defined in the environment of the user that performs the xctl command, and it must conform to the naming conventions for the target nodes.
-C Indicates that the command is to be executed for every coserver. This option is equivalent to the following xctl command:

xctl -b -X= command -yX=

The command is performed on the nodes assigned to each coserver. Use this option only with the oninit command.

-c coserver_num
start_num
- end_num
Specifies the coserver number of a single coserver or a range of coserver numbers. The indicated command is performed on the nodes assigned to the indicated coservers. Each coserver number must be listed in the ONCONFIG file. You can specify a list of coserver numbers. The list can include a range of coserver numbers.
command
c-opts
Specifies a database server utility or operating-system command. Typical database server utilities to use with xctl are as follows: oninit, onlog, onmode, and onstat.
Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]