table of contents
other versions
- jessie-backports 8.1.9+dfsg-1~bpo8+1
- stretch 8.1.9+dfsg-4+deb9u2
- testing 8.1.9+dfsg-9
- unstable 8.1.9+dfsg-9
QCONF(1) | Grid Engine User Commands | QCONF(1) |
NAME¶
qconf - Grid Engine Queue ConfigurationSYNTAX¶
qconf optionsDESCRIPTION¶
Qconf allows the system administrator to add, delete, and modify the current Grid Engine configuration, including queue management, host management, complex management and user management. Qconf also allows you to examine the current queue configuration for existing queues. Qconf allows the use of the backslash, '\', character at the end of a line to indicate that the next line is a continuation of the current line. When displaying settings, such as the output of one of the -s* options, qconf will break up long lines (lines greater than 80 characters) into smaller lines using backslash line continuation where possible. Lines will only be broken up at commas or whitespace. This feature can be disabled by setting the SGE_SINGLE_LINE environment variable.OPTIONS¶
Unless denoted otherwise, the following options and the corresponding operations are available to all users with a valid account.- -Aattr obj_spec fname obj_instance,...
- <add to object attributes>
- -Acal fname <add calendar>
- Adds a new calendar definition to the Grid Engine environment. Calendars are used in Grid Engine for defining availability and unavailability schedules of queues. The format of a calendar definition is described in The calendar definition is taken from the file fname. Requires root or manager privileges.
- -Ackpt fname <add checkpointing environment>
- Add the checkpointing environment as defined in fname (see to the list of supported checkpointing environments. Requires root or manager privileges.
- -Aconf fname_list <add configurations>
- Add the configurations (see specified in the files in the comma-separated
fname_list. The configuration is added for the host that is
identical to the file name.
- -Ae fname <add execution host>
- Add the execution host defined in fname to the Grid Engine cluster. The format of the execution host specification is described in Requires root or manager privileges.
- -Ahgrp fname <add host group configuration>
- Add the host group configuration defined in file. The file format of fname must comply with the format specified in Requires root or manager privileges.
- -Arqs fname <add RQS configuration>
- Add the resource quota set (RQS) defined in the file named fname to the Grid Engine cluster. Requires root or manager privileges.
- -Ap fname <add PE configuration>
- Add the parallel environment (PE) defined in fname to the Grid Engine cluster. Requires root or manager privileges.
- -Aprj fname <add new project>
- Adds the project description defined in fname to the list of registered projects (see Requires root or manager privileges.
- -Aq fname <add new queue>
- Add the queue defined in fname to the Grid Engine cluster. Requires root or manager privileges.
- -Au fname <add an ACL>
- Add the user access list (ACL) defined in file fname to Grid Engine. User lists are used for queue usage authentication. Requires root, manager, or operator privileges. The file format of fname must comply with the format specified in
- -Dattr obj_spec fname obj_instance,...
- <del. from object attribs>
- -Mattr obj_spec fname obj_instance,...
- <mod. object attributes>
- -Mc fname <modify complex>
- Overwrites the complex configuration with the contents of fname. The argument file must comply with the format specified in Requires root or manager privileges.
- -Mcal fname <modify calendar>
- Overwrites the calendar definition as specified in fname. The argument file must comply with the format described in Requires root or manager privileges.
- -Mckpt fname <modify ckpt. environment>
- Overwrite an existing checkpointing environment with the definitions in fname (see The name attribute in fname has to match an existing checkpointing environment. Requires root or manager privileges.
- -Mconf fname_list <modify configurations>
- Modify the configurations (see specified in the files in the
comma-separated fname_list. The configuration is modified for the
host that is identical to the file name.
- -Me fname <modify execution host>
- Overwrites the execution host configuration for the specified host with the contents of fname, which must comply with the format defined in Requires root or manager privilege.
- -Mhgrp fname <modify host group configuration>
- Allows changing the host group configuration with a single command. All host group configuration entries contained in fname will be applied. Configuration entries not contained in fname will be deleted. The file format of fname must comply to the format specified in Requires root or manager privileges.
- -Mrqs fname [mrqs_name] <modify RQS configuration>
- Same as -mrqs (see below) but instead of invoking an editor to modify the RQS configuration, the file fname is considered to contain a changed configuration. The name of the rule set in fname must be the same as rqs_name. If rqs_name is not set, all rule sets are overwritten by the rule sets in fname Refer to for details on the RQS configuration format. Requires root or manager privileges.
- -Mp fname <modify PE configuration>
- Same as -mp (see below) but instead of invoking an editor to modify the PE configuration the file fname is considered to contain a changed configuration. Refer to for details on the PE configuration format. Requires root or manager privilege.
- -Mprj fname <modify project configuration>
- Same as -mprj (see below) but instead of invoking an editor to modify the project configuration the file fname is considered to contain a changed configuration. Refer to for details on the project configuration format. Requires root or manager privilege.
- -Mq fname <modify queue configuration>
- Same as -mq (see below) but instead of invoking an editor to modify the queue configuration the file fname is considered to contain a changed configuration. Refer to for details on the queue configuration format. Requires root or manager privilege.
- -Msconf fname <modify scheduler configuration from fname>
- The current scheduler configuration (see is overridden with the configuration specified in the file. Requires root or manager privilege.
- -Mstree fname <modify share tree>
- Modifies the definition of the share tree (see The modified sharetree is read from file fname. Requires root or manager privileges.
- -Mu fname <modify ACL>
- Takes the user access list (ACL) defined in fname to overwrite any existing ACL with the same name. See for information on the ACL configuration format. Requires root or manager privilege.
- -Muser fname <modify user>
- Modify the user defined in fname in the Grid Engine cluster. The format of the user specification is described in Requires root or manager privileges.
- -Rattr obj_spec fname obj_instance,...
- <replace object attribs>
- -aattr obj_spec attr_name val obj_instance,...
- <add to object attributes>
- -acal calendar_name <add calendar>
- Adds a new calendar definition to the Grid Engine environment. Calendars are used in Grid Engine for defining availability and unavailability schedules of queues. The format of a calendar definition is described in With the calendar name given in the option argument, qconf will open a temporary file and start up the text editor indicated by the environment variable EDITOR (default if EDITOR is not set). After entering the calendar definition and closing the editor the new calendar is checked and registered with Requires root/manager privileges.
- -ackpt ckpt_name <add checkpointing environment>
- Adds a checkpointing environment under the name ckpt_name to the list of checkpointing environments maintained by Grid Engine and to be usable to submit checkpointing jobs (see for details on the format of a checkpointing environment definition). Qconf retrieves a default checkpointing environment configuration and executes (or $EDITOR if the EDITOR environment variable is set) to allow you to customize the checkpointing environment configuration. Upon exit from the editor, the checkpointing environment is registered with Requires root/manager privileges.
- -aconf host,... <add configuration>
- Successively adds configurations (see For the hosts in the comma-separated
host list. For each host, an editor ($EDITOR, if defined, or is invoked
and the configuration for the host can be entered. The configuration is
registered with after saving the file and quitting the editor.
- -ae [host_template] <add execution host>
- Adds a host to the list of Grid Engine execution hosts. If a queue is
configured on a host this host is automatically added to the Grid Engine
execution host list. Adding execution hosts explicitly offers the
advantage to be able to specify parameters like load scale values with the
registration of the execution host. However, these parameters can be
modified (from their defaults) at any later time via the -me option
described below.
- -ah hostname,... <add administrative host>
- Adds hosts hostname to the Grid Engine trusted host list (a host must be in this list to execute administrative Grid Engine commands, the sole exception to this being the execution of qconf on the node). The default Grid Engine installation procedures usually add all designated execution hosts (see the -ae option above) to the Grid Engine trusted host list automatically. Requires root or manager privileges.
- -ahgrp group <add host group configuration>
- Adds a new host group with the name specified in group. This command invokes an editor (either or the editor indicated by the EDITOR environment variable). The new host group entry is registered after changing the entry and exiting the editor. Requires root or manager privileges.
- -arqs [rqs_name] <add new RQS>
- Adds one or more Resource Quota Set (RQS) description under the names rqs_name to the list of RQSs maintained by Grid Engine. (See for details on the format of an RQS definition.) Qconf retrieves a default RQS configuration and executes (or $EDITOR if the EDITOR environment variable is set) to allow you to customize the RQS configuration. Upon exit from the editor, the RQS is registered with Requires root or manager privileges.
- -am user,... <add managers>
- Adds the indicated users to the Grid Engine manager list. Requires root or
manager privileges.
- -ao user,... <add operators>
- Adds the indicated users to the Grid Engine operator list. Requires root
or manager privileges.
- -ap pe_name <add new PE>
- Adds a Parallel Environment (PE) description under the name pe_name to the list of PEs maintained by Grid Engine and to be usable to submit parallel jobs (see for details on the format of a PE definition). Qconf retrieves a default PE configuration and executes (or $EDITOR if the EDITOR environment variable is set) to allow you to customize the PE configuration. Upon exit from the editor, the PE is registered with Requires root/manager privileges.
- -at thread_name <activates thread in master>
- Activates an additional thread in the master process. thread_name can be either "scheduler" or "jvm". The corresponding thread is only started when it is not already running. There may be only one scheduler and only one JVM thread in the master process at the same time.
- -aprj <add new project>
- Adds a project description to the list of registered projects (see Qconf retrieves a template project configuration and executes (or $EDITOR if the EDITOR environment variable is set) to allow you to customize the new project. Upon exit from the editor, the template is registered with Requires root or manager privileges.
- -aq [queue_name] <add new queue>
- Qconf retrieves the default queue configuration (see and executes (or $EDITOR if the EDITOR environment variable is set) to allow you to customize the queue configuration. Upon exit from the editor, the queue is registered with A minimal configuration requires only that the queue name and queue hostlist be set. Requires root or manager privileges.
- -as hostname,... <add submit hosts>
- Add hosts hostname to the list of hosts allowed to submit Grid Engine jobs and control their behavior only. Requires root or manager privileges.
- -astnode node_path=shares,... <add share tree node>
- Adds the specified share tree node(s) to the share tree (see The node_path is a hierarchical path ([ /]node_name[[/.] node_name...]) specifying the location of the new node in the share tree. The base name of the node_path is the name of the new node. The node is initialized to the number of specified shares. Requires root or manager privileges.
- -astree <add share tree>
- Adds the definition of a share tree to the system (see A template share tree is retrieved and an editor (either or the editor indicated by $EDITOR) is invoked for modifying the share tree definition. Upon exiting the editor, the modification is registered with Requires root or manager privileges.
- -Astree fname <add share tree>
- Adds the definition of a share tree to the system (see from the file fname. Requires root or manager privileges.
- -au user,... acl_name,... <add users to ACLs>
- Adds users to Grid Engine user access lists (ACLs). User lists are used
for queue usage authentication. Requires root/manager/operator privileges.
- -Auser fname <add user>
- Add the user defined in fname to the Grid Engine cluster. The format of the user specification is described in Requires root or manager privileges.
- -auser <add user>
- Adds a user to the list of registered users (see This command invokes an editor (either or the editor indicated by the EDITOR environment variable) for a template user. The new user is registered after changing the entry and exiting the editor. Requires root or manager privileges.
- -bonsai <human-readable sharetree>
- Shows a textual tree layout of the share tree analogous to the graphical view in -sstree shows the same information in a less-readable (linearized) form.
- -clearusage [user_list] <clear sharetree usage>
- Clears usage from the sharetree, either just for user_list or for all users and projects if user_list isn't supplied. All specified usage will be set to zero.
- -cq wc_queue_list <clean queue>
- Cleans queue of jobs which haven't been reaped. (Actually purges jobs remaining on the queue.) Primarily a development tool. Requires root/manager/operator privileges. Find a description of wc_queue_list in
- -dattr obj_spec attr_name val obj_instance,...
- <delete in object attribs>
- -dcal calendar_name,... <delete calendar>
- Deletes the specified calendar definition from Grid Engine. Requires root/manager privileges.
- -dckpt ckpt_name <delete checkpointing environment>
- Deletes the specified checkpointing environment. Requires root/manager privileges.
- -dconf host,... <delete local configuration>
- The local configuration entries for the specified hosts are deleted from the configuration list. Requires root or manager privilege.
- -de host_name,... <delete execution host>
- Deletes hosts from the Grid Engine execution host list. Requires root or manager privileges.
- -dh host_name,... <delete administrative host>
- Deletes hosts from the Grid Engine trusted host list. The host on which is currently running cannot be removed from the list of administrative hosts. Requires root or manager privileges.
- -dhgrp group <delete host group configuration>
- Deletes host group configuration with the name specified in group. Requires root or manager privileges.
- -drqs rqs_name_list <delete RQS>
- Deletes the specified resource quota sets (RQS). Requires root or manager privileges.
- -dm user[,user,...] <delete managers>
- Deletes managers from the manager list. Requires root or manager privileges. It is not possible to delete the admin user or the user root from the manager list.
- -do user[,user,...] <delete operators>
- Deletes operators from the operator list. Requires root or manager privileges. It is not possible to delete the admin user or the user root from the operator list.
- -dp pe_name <delete parallel environment>
- Deletes the specified parallel environment (PE). Requires root or manager privileges.
- -dprj project,... <delete projects>
- Deletes the specified project(s). Requires root/manager privileges.
- -dq queue_name,... <delete queue>
- Removes the specified queue(s), which must be empty. Requires root or manager privileges.
- -ds host_name,... <delete submit host>
- Deletes hosts from the Grid Engine submit host list. Requires root or manager privileges.
- -dstnode node_path,... <delete share tree node>
- Deletes the specified share tree node(s). The node_path is a hierarchical path ([ /]node_name[[/.]node_name...]) specifying the location of the node to be deleted in the share tree. Requires root or manager privileges.
- -dstree <delete share tree>
- Deletes the current share tree. Requires root or manager privileges.
- -du user,... acl_name,... <delete users from ACL>
- Deletes one or more users from one or more Grid Engine user access lists (ACLs). Requires root/manager/operator privileges.
- -dul acl_name,... <delete user lists>
- Deletes one or more user lists from the system. Requires root/manager/operator privileges.
- -duser user,... <delete users>
- Deletes the specified user(s) from the list of registered users. Requires root or manager privileges.
- -help
- Prints a listing of all options.
- -k{m|s|e[j] {host,...|all}} <shutdown Grid Engine>
- Note: The -ks switch is deprecated and may be removed in
future release. Please use the -kt switch instead.
- -kt thread_name <terminate master thread>
- Terminates a thread in the master process. Currently it is only supported to shutdown the "scheduler" and the "jvm" thread. The command will only be successful if the corresponding thread is running.
- -kec {id,...|all} <kill event client>
- Used to shutdown event clients registered at The comma-separated event client list specifies the event clients to be addressed by the -kec option. If the keyword all is specified instead of an event client list, all running event clients except special clients like the scheduler thread are terminated. Requires root or manager privilege.
- -mattr obj_spec attr_name val obj_instance,...
- <modify object attributes>
- -mc <modify complex>
- The complex configuration (see is retrieved, an editor is executed (either or the editor indicated by $EDITOR) and the changed complex configuration is registered with upon exit of the editor. Requires root or manager privilege.
- -mcal calendar_name <modify calendar>
- The specified calendar definition (see is retrieved, an editor is executed (either or the editor indicated by $EDITOR) and the changed calendar definition is registered with upon exit of the editor. Requires root or manager privilege.
- -mckpt ckpt_name <modify checkpointing environment>
- Retrieves the current configuration for the specified checkpointing environment, executes an editor (either or the editor indicated by the EDITOR environment variable) and registers the new configuration with the Refer to for details on the checkpointing environment configuration format. Requires root or manager privilege.
- -mconf [host,...|global] <modify configuration>
- The configuration for the specified host is retrieved, an editor is
executed (either or the editor indicated by $EDITOR) and the changed
configuration is registered with upon exit of the editor. If the optional
host argument is omitted, or if the special host name global
is specified, the global configuration is modified. The format of the
configuration is described in
- -me hostname <modify execution host>
- Retrieves the current configuration for the specified execution host, executes an editor (either or the editor indicated by the EDITOR environment variable) and registers the changed configuration with upon exit from the editor. The format of the execution host configuration is described in Requires root or manager privilege.
- -mhgrp group <modify host group configuration>
- The host group entries for the host group specified in group are retrieved and an editor (either or the editor indicated by the EDITOR environment variable) is invoked for modifying the host group configuration. By closing the editor, the modification is registered. The format of the host group configuration is described in Requires root or manager privileges.
- -mrqs [rqs_name] <modify RQS configuration>
- Retrieves the resource quota set (RQS)configuration defined in rqs_name, or if rqs_name is not given, retrieves all resource quota sets, executes an editor (either or the editor indicated by the EDITOR environment variable) and registers the new configuration with the Refer to for details on the RQS configuration format. Requires root or manager privilege.
- -mp pe_name <modify PE configuration>
- Retrieves the current configuration for the specified parallel environment (PE), executes an editor (either or the editor indicated by the EDITOR environment variable) and registers the new configuration with the Refer to for details on the PE configuration format. Requires root or manager privilege.
- -mprj project <modify project>
- Data for the specific project is retrieved (see and an editor (either or the editor indicated by $EDITOR) is invoked for modifying the project definition. Upon exiting the editor, the modification is registered. Requires root or manager privileges.
- -mq queuename <modify queue configuration>
- Retrieves the current configuration for the specified queue, executes an editor (either or the editor indicated by the EDITOR environment variable) and registers the new configuration with the Refer to for details on the queue configuration format. Requires root or manager privilege.
- -msconf <modify scheduler configuration>
- The current scheduler configuration (see is retrieved, an editor is executed (either or the editor indicated by $EDITOR) and the changed configuration is registered with upon exit of the editor. Requires root or manager privilege.
- -mstnode node_path=shares,... <modify share tree node>
- Modifies the specified share tree node(s) in the share tree (see The node_path is a hierarchical path ( [fB/]node_name[[/.]node_name...]) specifying the location of an existing node in the share tree. The node is set to the number of specified shares. Requires root or manager privileges.
- -mstree <modify share tree>
- Modifies the definition of the share tree (see The present share tree is retrieved and an editor (either or the editor indicated by $EDITOR) is invoked for modifying the share tree definition. Upon exiting the editor, the modification is registered with Requires root or manager privileges.
- -mu acl_name <modify user access lists>
- Retrieves the current configuration for the specified user access list, executes an editor (either or the editor indicated by the EDITOR environment variable) and registers the new configuration with the The format of the configuration must comply with the format specified in Requires root or manager privilege.
- -muser user <modify user>
- Data for the specific user is retrieved (see and an editor (either or the editor indicated by the EDITOR environment variable) is invoked for modifying the user definition. Upon exiting the editor, the modification is registered. Requires root or manager privileges.
- -purge queue attr_nm,... obj_spec
- <purge divergent attribute settings>
- -rattr obj_spec attr_name val obj_instance,...
- <replace object attributes>
- -rsstnode node_path,... <show share tree node>
- Recursively shows the name and shares of the specified share tree node(s) and the names and shares of its child nodes (not showing leaves). See The node_path is a hierarchical path ([ /]node_name[{/| .}node_name...]) specifying the location of a node in the share tree.
- -sc <show complexes>
- Display the complex configuration.
- -scal calendar_name <show calendar>
- Display the configuration of the specified calendar.
- -scall <show calendar list>
- Show a list of all calendars currently defined.
- -sckpt ckpt_name <show checkpointing environment>
- Display the configuration of the specified checkpointing environment.
- -sckptl <show checkpointing environment list>
- Show a list of the names of all checkpointing environments currently configured.
- -sconf [host,...|global] <show configuration>
- Print the global or local (host specific) configuration. If the optional comma-separated host list argument is omitted, or the special string global is given, the global configuration is displayed. The configuration in effect on a certain host is the merger of the global configuration and the host specific local configuration. The format of the configuration is described in
- -sconfl <show configuration list>
- Display a list of hosts for which configurations are available. The special host name global refers to the global configuration.
- -sds <show detached settings>
- Displays detached settings in the cluster configuration (see
- -se hostname <show execution host>
- Displays the definition of the specified execution host.
- -sel <show execution hosts>
- Displays the Grid Engine execution host list.
- -secl <show event clients>
- Displays the Grid Engine event client list.
- -sh <show administrative hosts>
- Displays the Grid Engine administrative host list.
- -shgrp group <show host group configuration>
- Displays the host group entries for the group specified in group.
- -shgrpl <show host group lists>
- Displays a name list of all currently defined host groups which have a valid host group configuration.
- -shgrp_tree group <show host group tree>
- Shows a tree like structure of the host group.
- -shgrp_resolved group <show host group hosts>
- Shows a list of all hosts which are part of the definition of host group. If the host group definition contains sub host groups than also these groups are resolved and the hostnames are printed.
- -srqs [rqs_name_list] <show RQS configuration>
- Show the definition of the resource quota sets (RQS) specified by the argument.
- -srqsl <show RQS-list>
- Show a list of all currently defined resource quota sets (RQSs).
- -sm <show managers>
- Displays the managers list.
- -so <show operators>
- Displays the operator list.
- -sobjl obj_spec attr_name val <show object list>
- Shows a list of all configuration objects for which val matches at least one configuration value of the attributes whose name matches attr_name. obj_spec can be "queue" or "queue_domain" or "queue_instance" or "exechost". Note: When "queue_domain" or "queue_instance" is specified as obj_spec, matching is only done with the attribute overridings concerning the host group or the execution host. In this case queue domain names resp. queue instances are returned. attr_name can be any of the configuration file keywords listed in or Also wildcards can be used to match multiple attributes. val can be an arbitrary string or a wildcard expression.
- -sp pe_name <show PE configuration>
- Show the definition of the parallel environment (PE) specified by the argument.
- -spl <show PE-list>
- Show a list of all currently defined parallel environments (PEs).
- -sprj project <show project>
- Shows the definition of the specified project (see
- -sprjl <show project list>
- Shows the list of all currently defined projects.
- -sq wc_queue_list <show queues>
- Displays one or multiple cluster queues or queue instances. A description of wc_queue_list can be found in
- -sql <show queue list>
- Show a list of all currently defined cluster queues.
- -ss <show submit hosts>
- Displays the Grid Engine submit host list.
- -ssconf <show scheduler configuration>
- Displays the current scheduler configuration in the format explained in
- -sstnode node_path,... <show share tree node>
- Shows the name and shares of the specified share tree node(s) (see The node_path is a hierarchical path ([ /]node_name[{/| .}node_name...]) specifying the location of a node in the share tree.
- -sstree <show share tree>
- Shows the definition of the share tree (see A different view is provided by -bonsai.
- -sst <show formatted share tree>
- Shows the definition of the share tree in a tree view (see
- -sss <show scheduler status>
- Currently displays the host on which the Grid Engine scheduler is active or an error message if no scheduler is running.
- -su acl_name <show user ACL>
- Displays a Grid Engine user access list (ACL).
- -sul <show user lists>
- Displays a list of names of all currently defined Grid Engine user access lists (ACLs).
- -suser user,... <show user>
- Shows the definition of the specified user(s) (see
- -suserl <show users>
- Shows the list of all currently defined users.
- -tsm <trigger scheduler monitoring>
- The Grid Engine scheduler is forced by this option to print trace messages of its next scheduling run to the file <sge_root>/<cell>/common/schedd_runlog. The messages indicate the reasons for jobs and queues not being selected in that run. Requires root or manager privileges. Note, that the reasons for job requirements being invalid with respect to resource availability of queues are displayed using the format as described for the -F option (see description of Full Format in section OUTPUT FORMATS of the manual page.
ENVIRONMENT VARIABLES¶
- SGE_ROOT
- Specifies the location of the Grid Engine standard configuration files.
- SGE_CELL
- If set, specifies the default Grid Engine cell. To address a Grid Engine cell qconf uses (in the order of precedence):
The name of the cell specified in the environment
variable SGE_CELL, if it is set.
The name of the default cell, i.e. default.
- SGE_DEBUG_LEVEL
- If set, specifies that debug information should be written to stderr. In addition the level of detail in which debug information is generated is defined.
- SGE_QMASTER_PORT
- If set, specifies the tcp port on which is expected to listen for communication requests. Most installations will use a services map entry instead to define that port.
- SGE_EXECD_PORT
- If set, specifies the tcp port on which is expected to listen for communication requests. Most installations will use a services map entry instead to define that port.
- SGE_SINGLE_LINE
- If set, indicates that long lines should not be broken up using backslashes. This setting is useful for scripts which expect one entry per line.
RESTRICTIONS¶
Modifications to a queue configuration do not affect an active queue, taking effect on next invocation of the queue (i.e., the next job).FILES¶
<sge_root>/<cell>/common/act_qmaster Grid Engine master host file
SEE ALSO¶
COPYRIGHT¶
See for a full statement of rights and permissions.2012-09-17 | SGE 8.1.3pre |