QCONF(1) General Commands Manual QCONF(1) NAME qconf - Univa Grid Engine Queue Configuration SYNTAX qconf options DESCRIPTION Qconf allows the system administrator to add, delete, and modify the current Univa 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 charac- ters) into smaller lines using backslash line continuation where possi- ble. Lines will only be broken up at commas or whitespace. This fea- ture can be disabled by setting the SGE_SINGLE_LINE environment vari- able. 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,... Similar to -aattr (see below) but takes specifications for the object attributes to be enhanced from file named fname. As opposed to -aattr, multiple attributes can be enhanced. Their specification has to be enlisted in fname following the file format of the corresponding object (see queue_conf(5) for the queue, for example). Requires root/manager privileges. -Acal fname Adds a new calendar definition to the Univa Grid Engine environ- ment. Calendars are used in Univa Grid Engine for defining availability and unavailability schedules of queues. The format of a calendar definition is described in calendar_conf(5). The calendar definition is taken from the file fname. Requires root/ manager privileges. -Ackpt fname Add the checkpointing environment as defined in fname (see checkpoint(5)) to the list of supported checkpointing environ- ments. Requires root or manager privileges. -Aconf fname_list Add the configurations (see sge_conf(5)) specified in the files enlisted in the comma separated fname_list. The configuration is added for the host that is identical to the file name. Requires root or manager privileges. -adjs session_name Adds a DRMAA2 job session in the master list for the calling user. The DRMAA2 job session can only be used, showed and deleted by the user who created the session. Users with manager privileges or root can use, show and delete all DRMAA2 job ses- sions. A DRMAA2 job session can only be used by DRMAA2 clients, which itself can create and destroy DRMAA2 job sessions. -Ae fname Add the execution host defined in fname to the Univa Grid Engine cluster. The format of the execution host specification is described in host_conf(5). Requires root or manager privileges. -Ahgrp fname Add the host group configuration defined in fname. The file format of fname must comply to the format specified in host- group(5). Requires root or manager privileges. -Ajc fname Add the job class defined in fname to the Univa Grid Engine cluster. The format of the job class specification is described in sge_job_class(5). This switch can be used by root, managers or users. -Arqs fname Add the resource quota set (RQS) defined in the file named fname to the Univa Grid Engine cluster. Requires root or manager priv- ileges. -Ap fname Add the parallel environment (PE) defined in fname to the Univa Grid Engine cluster. Requires root or manager privileges. -Aprj fname Adds the project description defined in fname to the list of registered projects (see project(5)). Requires root or manager privileges. -Aq fname Add the queue defined in fname to the Univa Grid Engine cluster. Requires root or manager privileges. -Asi fname Adds a new session to the Univa Grid Engine environment. Ses- sions are used in Univa Grid Engine for the synchronization of object state changes within the sge_qmaster(8) process to guar- antee a consistent view onto the Univa Grid Engine system. Find more information concerning sessions in session_conf(5). The format of a session definition is also described in that page. The session definition is taken from the file fname. The unique session ID of the created session will be shown as part of the success message when the qconf(1) command returns. This session id can be used with the -si switch of Univa Grid Engine client commands (like qstat(1), qhost(1), qsub(1) , ... ) Please note that the request to create a new session is automat- ically done as transaction within the new session if no other session ID is specified with -si switch. As result all other object state changes that have been done before the session was created will automatically be visible for client commands that use the created session with the corresponding -si switch. To avoid the necessity to specify session parameters and to parse the output of the qconf command it is possible to use the -csi switch of qconf(1) which creates a new session with default parameters and that prints only the unique session ID to stdout instead of a full message. Creating sessions requires root/manager privileges or the user needs to be a member of the access control list named ses- sionusers. -Au fname Add the user access list (ACL) defined in fname to Univa Grid Engine. User lists are used for queue usage authentication. Requires root/manager/operator privileges. -cb This parameter can be used since Univa Grid Engine version 6.2u5 in combination with the command line switch -sep. In that case the output of the corresponding command will contain information about the added job to core binding functionality. If -cb switch is not used then -sep will behave as in GE version 6.2u4 and below. Please note that this command-line switch will be removed from Univa Grid Engine with the next major release. -Dattr obj_spec fname obj_instance,... Similar to -dattr (see below) but the definition of the list attributes from which entries are to be deleted is contained in the file named fname. As opposed to -dattr, multiple attributes can be modified. Their specification has to be enlisted in fname following the file format of the corresponding object (see queue_conf(5) for the queue, for example). Requires root/manager privileges. -Mattr obj_spec fname obj_instance,... Similar to -mattr (see below) but takes specifications for the object attributes to be modified from file named fname. As opposed to -mattr, multiple attributes can be modified. Their specification has to be enlisted in fname following the file format of the corresponding object (see queue_conf(5) for the queue, for example). Requires root/manager privileges. -Mc fname Overwrites the complex configuration by the contents of fname. The argument file must comply to the format specified in com- plex(5). Requires root or manager privilege. -Mcal fname Overwrites the calendar definition as specified in fname. The argument file must comply to the format described in calen- dar_conf(5). Requires root or manager privilege. -Mckpt fname Overwrite an existing checkpointing environment with the defini- tions in fname (see checkpoint(5)). The name attribute in fname has to match an existing checkpointing environment. Requires root or manager privileges. -Mconf fname_list Modify the configurations (see sge_conf(5)) specified in the files enlisted in the comma separated fname_list. The configura- tion is modified for the host that is identical to the file name. Requires root or manager privileges. -Me fname Overwrites the execution host configuration for the specified host with the contents of fname, which must comply to the format defines in host_conf(5). Requires root or manager privilege. -Mhgrp fname Allows changing of host group configuration with a single com- mand. 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 hostgroup(5). Requires root or manager privilege. -Mjc fname Allows changing of job class configuration with a single com- mand. All job class configuration entries contained in fname will be applied. The file format of fname must comply to the format specified in sge_job_class(5). This switch might be used by managers and owners of the job class that should be modified. -Mrqs fname [mrqs_name] 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 sge_resource_quota(5) for details on the RQS configuration for- mat. Requires root or manager privilege. -Mp fname Same as -mp (see below) but instead of invoking an editor to modify the PE configuration the file fname is considered to con- tain a changed configuration. Refer to sge_pe(5) for details on the PE configuration format. Requires root or manager privi- lege. -Mprj fname 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 project(5) for details on the project configuration format. Requires root or manager privilege. -Mq fname 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 queue_conf(5) for details on the queue configuration format. Requires root or manager privilege. -Msi fname Overwrites the session definition as specified in fame. The argument file must comply to the format described in ses- sion_conf(5). Session modifications require root/manager privileges or the user, which must be the owner of the session, needs to be a mem- ber of the access control list named sessionusers. -Msconf fname The current scheduler configuration (see sched_conf(5)) is over- ridden with the configuration specified in the file. Requires root or manager privilege. -Mstree fname Modifies the definition of the share tree (see share_tree(5)). The modified sharetree is read from file fname. Requires root or manager privileges. -Mu fname Takes the user access list (ACL) defined in fname to overwrite any existing ACL with the same name. See access_list(5) for information on the ACL configuration format. Requires root or manager privilege. -Muser fname Modify the user defined in fname in the Univa Grid Engine clus- ter. The format of the user specification is described in user(5). Requires root or manager privileges. -Rattr obj_spec fname obj_instance,... Similar to -rattr (see below) but the definition of the list attributes whose content is to be replace is contained in the file named fname. As opposed to -rattr, multiple attributes can be modified. Their specification has to be enlisted in fname following the file format of the corresponding object (see queue_conf(5) for the queue, for example). Requires root/manager privileges. -aattr obj_spec attr_name val obj_instance,... Allows adding specifications to a single configuration list attribute in multiple instances of an object with a single com- mand. Currently supported objects are the queue, the host, the host group, the parallel environment, the resource quota sets and the checkpointing interface configuration being specified as queue , exechost , hostgroup , pe , resource_quota or ckpt in obj_spec. For the obj_spec queue the obj_instance can be a cluster queue name, a queue domain name or a queue instance name. Find more information concerning different queue names in sge_types(1). Depending on the type of the obj_instance this adds to the cluster queues attribute sublist the cluster queues implicit default configuration value or the queue domain config- uration value or queue instance configuration value. The queue load_thresholds parameter is an example of a list attribute. With the -aattr option, entries can be added to such lists, while they can be deleted with -dattr, modified with -mattr, and replaced with -rattr. For the obj_spec resource_quota the obj_instance is a unique identifier for a specific rule. The identifier consists of a rule-set name and either the number of the rule in the list, or the name of the rule, separated by a / The name of the configuration attribute to be enhanced is speci- fied with attr_name followed by val as a name=value pair. The comma separated list of object instances (e.g., the list of queues) to which the changes have to be applied are specified at the end of the command. The following restriction applies: For the exechost object the load_values attribute cannot be modified (see host_conf(5)). Requires root or manager privileges. -acal calendar_name Adds a new calendar definition to the Univa Grid Engine environ- ment. Calendars are used in Univa Grid Engine for defining availability and unavailability schedules of queues. The format of a calendar definition is described in calendar_conf(5). 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 editor is vi(1) if EDI- TOR is not set). After entering the calendar definition and closing the editor the new calendar is checked and registered with sge_qmaster(8). Requires root/manager privileges. -ackpt ckpt_name Adds a checkpointing environment under the name ckpt_name to the list of checkpointing environments maintained by Univa Grid Engine and to be usable to submit checkpointing jobs (see check- point(5) for details on the format of a checkpointing environ- ment definition). Qconf retrieves a default checkpointing envi- ronment configuration and executes vi(1) (or $EDITOR if the EDI- TOR environment variable is set) to allow you to customize the checkpointing environment configuration. Upon exit from the edi- tor, the checkpointing environment is registered with sge_qmas- ter(8). Requires root/manager privileges. -aconf host,... Successively adds configurations (see sge_conf(5)) For the hosts in the comma separated fname_list. For each host, an editor ($EDITOR indicated or vi(1)) is invoked and the configuration for the host can be entered. The configuration is registered with sge_qmaster(8) after saving the file and quitting the edi- tor. Requires root or manager privileges. -ae [host_template] Adds a host to the list of Univa Grid Engine execution hosts. If a queue is configured on a host this host is automatically added to the Univa 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. If the host_template argument is present, qconf retrieves the configuration of the specified execution host from sge_qmas- ter(8) or a generic template otherwise. The template is then stored in a file and qconf executes vi(1) (or the editor indi- cated by $EDITOR if the EDITOR environment variable is set) to change the entries in the file. The format of the execution host specification is described in host_conf(5). When the changes are saved in the editor and the editor is quit the new execution host is registered with sge_qmaster(8). Requires root/manager privileges. -ah hostname,... Adds hosts hostname to the Univa Grid Engine trusted host list (a host must be in this list to execute administrative Univa Grid Engine commands, the sole exception to this being the exe- cution of qconf on the sge_qmaster(8) node). The default Univa Grid Engine installation procedures usually add all designated execution hosts (see the -ae option above) to the Univa Grid Engine trusted host list automatically. Requires root or man- ager privileges. -ahgrp group Adds a new host group with the name specified in group. This command invokes an editor (either vi(1) 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. -ajc jc_name Adds a new job class with the name specified in jc_name. This command invokes an editor (either vi(1) or the editor indicated by the EDITOR environment variable). The new job class entry is registered after changing the entry and exiting the editor. Job classes can be created by users, root and managers. -arqs [rqs_name] Adds one or more Resource Quota Set (RQS) description under the names rqs_name to the list of RQSs maintained by Univa Grid Engine (see sge_resource_quota(5) for details on the format of a RQS definition). Qconf retrieves a default RQS configuration and executes vi(1) (or $EDITOR if the EDITOR environment vari- able is set) to allow you to customize the RQS configuration. Upon exit from the editor, the RQS is registered with sge_qmas- ter(8). Requires root or manager privileges. -am user|'@'unix_group,... Adds the indicated users or UNIX groups to the Univa Grid Engine manager list. Requires root or manager privileges. -ao user|'@'unix_group, ... Adds the indicated users or UNIX groups to the Univa Grid Engine operator list. Requires root or manager privileges. -ap pe_name Adds a Parallel Environment (PE) description under the name pe_name to the list of PEs maintained by Univa Grid Engine and to be usable to submit parallel jobs (see sge_pe(5) for details on the format of a PE definition). Qconf retrieves a default PE configuration and executes vi(1) (or $EDITOR if the EDITOR envi- ronment variable is set) to allow you to customize the PE con- figuration. Upon exit from the editor, the PE is registered with sge_qmaster(8). Requires root/manager privileges. -at thread_name Activates an additional thread in the master process. thread_name might be either scheduler, jvm, lothread or reader. There might be only one scheduler, JVM thread and LO thread. The maximum for reader threads is 64. The corresponding thread is only started when the corresponding maximum is not already reached. reader threads can only be started if the reader thread pool was enabled during start of qmaster. Initial start of the reader thread pool is enabled by setting the reader_threads variable in the bootstrap(5) file. -aprj Adds a project description to the list of registered projects (see project(5)). Qconf retrieves a template project configura- tion and executes vi(1) (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 sge_qmas- ter(8). Requires root or manager privileges. -aq [queue_name] Qconf retrieves the default queue configuration (see queue_conf(5)) and executes vi(1) (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 regis- tered with sge_qmaster(8). A minimal configuration requires only that the queue name and queue hostlist be set. Requires root or manager privileges. -as hostname,... Add hosts hostname to the list of hosts allowed to submit Univa Grid Engine jobs and control their behavior only. Requires root or manager privileges. -asi Adds a new session to the Univa Grid Engine environment. Ses- sions are used in Univa Grid Engine for the synchronization of object state changes within the sge_qmaster(8) process to guar- antee a consistent view onto the Univa Grid Engine system. Without using sessions a consistent view of the most recent changes is not guaranteed in exchange for better response times for client commands and less load on sge_qmaster(8). Find more information concerning sessions in session_conf(5). The format of a session definition is also described in that page. qconf(1) will open a temporary file and start up the text editor indicated by the environment variable EDITOR (default is vi(1) if EDITOR is not set). After entering the session definition and closing the editor the new session is created and registered with sge_qmaster(8). The unique session ID of the created session will be shown as part of the success message when the qconf(1) command returns. This session id can be used with the -si switch of Univa Grid Engine client commands (like qstat(1), qhost(1), qsub(1) , ...) Please note that the request to create a new session is automat- ically done as transaction within the new session if no other session ID is specified with the -si switch. As result all other object state changes that have been done before the session was created will automatically be visible for client commands that use the created session with the corresponding -si switch. To avoid the necessity to specify session parameters and to parse the output of the qconf(1) command it is possible to use the -csi switch of qconf(1) which creates a new session with default parameters and that prints only the unique session ID to stdout instead of a full message. Creating sessions requires root/manager privileges or the user needs to a member of the access control list named sessionusers. -astnode node_path=shares,... Adds the specified share tree node(s) to the share tree (see share_tree(5)). 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 Adds the definition of a share tree to the system (see share_tree(5)). A template share tree is retrieved and an edi- tor (either vi(1) or the editor indicated by $EDITOR) is invoked for modifying the share tree definition. Upon exiting the edi- tor, the modified data is registered with sge_qmaster(8). Requires root or manager privileges. -Astree fname Adds the definition of a share tree to the system (see share_tree(5)) from the file fname. Requires root or manager privileges. -au user|'@'unix_group,... acl_name,... Adds users or UNIX groups to Univa Grid Engine user access lists (ACLs). User lists are used for queue usage authentication. Requires root/manager/operator privileges. -Auser fname Add the user defined in fname to the Univa Grid Engine cluster. The format of the user specification is described in user(5). Requires root or manager privileges. -auser Adds a user to the list of registered users (see user(5)). This command invokes an editor (either vi(1) 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 edi- tor. Requires root or manager privileges. -clearusage Clears all user and project usage from the sharetree. All usage will be initialized back to zero. -clearltusage Clears all user and project long term usage. All usage will be initialized back to zero. -cq wc_queue_list Cleans queue from jobs which haven't been reaped. Primarily a development tool. Requires root/manager/operator privileges. Find a description of wc_queue_list in sge_types(1). -csi Adds a new session to the Univa Grid Engine environment. Ses- sions are used in Univa Grid Engine for the synchronization of object state changes within the sge_qmaster(8) process to guar- antee a consistent view onto the Univa Grid Engine system. Find more information concerning sessions in session_conf(5). The format of a session definition is also described in that page. The command uses defaults for all session parameters. The exe- cuting user of the qconf(1) command will be the owner of the session. The session duration will be 900 seconds if not speci- fied otherwise by the qmaster_param named gdi_request_ses- sion_timeout (see sge_conf(5) ). On success the command will print the new unique session ID to stdout or the keyword NONE if creation of the session failed. Creating sessions requires root/manager privileges or the user needs to be a member of the access control list named ses- sionusers. -dattr obj_spec attr_name val obj_instance,... Allows deleting specifications in a single configuration list attribute in multiple instances of an object with a single com- mand. Find more information concerning obj_spec and obj_instance in the description of -aattr -dcal calendar_name,... Deletes the specified calendar definition from Univa Grid Engine. Requires root/manager privileges. -dckpt ckpt_name Deletes the specified checkpointing environment. Requires root/manager privileges. -dconf host,... The local configuration entries for the specified hosts are deleted from the configuration list. Requires root or manager privilege. -ddjs session_name Deletes a DRMAA2 job session if the session exists and the ses- sion was created by the same user. Users with manager privileges or root can delete all DRMAA2 job sessions. Deleting a DRMAA2 session has the same effect like calling drmaa2_destroy_jses- sion() out of a DRMAA2 C application. -de host_name,... Deletes hosts from the Univa Grid Engine execution host list. Requires root or manager privileges. -dh host_name,... Deletes hosts from the Univa Grid Engine trusted host list. The host on which sge_qmaster(8) is currently running cannot be removed from the list of administrative hosts. Requires root or manager privileges. -dhgrp group Deletes host group configuration with the name specified in group. Requires root or manager privileges. -djc jc_name Deletes job class configuration with the name specified in jc_name. Requires root or manager privileges or the deleting user has to be owner of the job class. -drqs rqs_name_list Deletes the specified resource quota sets (RQS). Requires root or manager privileges. -dm user|'@'unix_group,...] Deletes managers or UNIX groups with manager permission from the manager list. Requires root or manager privileges. It is not possible to delete the admin user or the user root from the man- ager list. -do user|'@'unix_group,...] Deletes operators or UNIX groups with operator permissions 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 Deletes the specified parallel environment (PE). Requires root or manager privileges. -dprj project,... Deletes the specified project(s). Requires root/manager privi- leges. -dq queue_name,... Removes the specified queue(s). Active jobs will be allowed to run to completion. Requires root or manager privileges. -ds host_name,... Deletes hosts from the Univa Grid Engine submit host list. Requires root or manager privileges. -dsi session_id Deletes the specified session definition from Univa Grid Engine. Although sessions are automatically destroyed when the session lifetime ends it is recommended to delete sessions manually when they are not needed anymore. Destroying sessions requires root/manager privileges or the user, which must be the owner of the session, needs to be a mem- ber of the access control list named sessionusers. -dstnode node_path,... 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 Deletes the current share tree. Requires root or manager privi- leges. -du user|'@'unix_group,... acl_name,... Deletes one or more users or UNIX groups from one or more Univa Grid Engine user access lists (ACLs). Requires root/man- ager/operator privileges. -dul acl_name,... Deletes one or more user lists from the system. Requires root/manager/operator privileges. -duser user,... " 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}} Note: The -ks switch is deprecated, may be removed in future release. Please use the -kt switch instead. Used to shutdown Univa Grid Engine components (daemons). In the form -km sge_qmaster(8) is forced to terminate in a controlled fashion. In the same way the -ks switch causes termination of the scheduler thread. Shutdown of running sge_execd(8) pro- cesses currently registered is initiated by the -ke option. If -kej is specified instead, all jobs running on the execution hosts are aborted prior to termination of the corresponding sge_execd(8). The comma separated host list specifies the exe- cution hosts to be addressed by the -ke and -kej option. If the keyword all is specified instead of a host list, all running sge_execd(8) processes are shutdown. Job abortion, initiated by the -kej option will result in dr state for all running jobs until sge_execd(8) is running again. Requires root or manager privileges. -kt thread_name " Terminates one thread in the master process. Currently it is supported to shutdown the scheduler, jvm, lothread thread. The command will only be successful if the corresponding thread is running. Also one reader thread can be terminated with this command when reader thread pool was activated in the boot- strap(5) file of qmaster. To shutdown more than one reader thread it is required to execute this command multiple times. Any try to shutdown the last two reader threads is rejected. They need to remain active so that the sge_qmaster(1) process can work properly. -kec {id,...|all} Used to shutdown event clients registered at sge_qmaster(8). 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 are terminated. Special clients are the scheduler thread and the read-only thread pool. Both components provide essential functionality of the sge_qmaster(8) component. Killing the scheduler thread as an event client will automati- cally terminate the scheduler thread. The thread can be restarted with qconf(1) -at command. The read-only thread pool can be shutdown as event client but the pool will be automati- cally re-registered. Requires root or manager privilege. -mattr obj_spec attr_name val obj_instance,... Allows changing a single configuration attribute in multiple instances of an object with a single command. Find more infor- mation concerning obj_spec and obj_instance in the description of -aattr -mc The complex configuration (see complex(5)) is retrieved, an edi- tor is executed (either vi(1) or the editor indicated by $EDI- TOR) and the changed complex configuration is registered with sge_qmaster(8) upon exit of the editor. Requires root or man- ager privilege. -mcal calendar_name The specified calendar definition (see calendar_conf(5)) is retrieved, an editor is executed (either vi(1) or the editor indicated by $EDITOR) and the changed calendar definition is registered with sge_qmaster(8) upon exit of the editor. Requires root or manager privilege. -mckpt ckpt_name Retrieves the current configuration for the specified check- pointing environment, executes an editor (either vi(1) or the editor indicated by the EDITOR environment variable) and regis- ters the new configuration with the sge_qmaster(8). Refer to checkpoint(5) for details on the checkpointing environment con- figuration format. Requires root or manager privilege. -mconf [host,...|global] The configuration for the specified host is retrieved, an editor is executed (either vi(1) or the editor indicated by $EDITOR) and the changed configuration is registered with sge_qmaster(8) upon exit of the editor. If the optional host argument is omit- ted or if the special host name global is specified, the global configuration is modified. The format of the configuration is described in sge_conf(5). Requires root or manager privilege. -me hostname Retrieves the current configuration for the specified execution host, executes an editor (either vi(1) or the editor indicated by the EDITOR environment variable) and registers the changed configuration with sge_qmaster(8) upon exit from the editor. The format of the execution host configuration is described in host_conf(5). Requires root or manager privilege. -mhgrp group The host group entries for the host group specified in group are retrieved and an editor (either vi(1) or the editor indicated by the EDITOR environment variable) is invoked for modifying the host group configuration. By closing the editor, the modified data is registered. The format of the host group configuration is described in hostgroup(5). Requires root or manager privi- leges. -mjc jc_name The job class entries for the host group specified in jc_name are retrieved and an editor (either vi(1) or the editor indi- cated by the EDITOR environment variable) is invoked for modify- ing the job class configuration. By closing the editor, the mod- ified data is registered. The format of the job class configu- ration is described in sge_job_class(5). Requires root or man- ager privileges or the executing user has to be owner of the job class that should be modified. -mrqs [rqs_name] 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 vi(1) or the editor indi- cated by the EDITOR environment variable) and registers the new configuration with the sge_qmaster(8). Refer to sge_resource_quota(5) for details on the RQS configuration for- mat. Requires root or manager privilege. -mp pe_name Retrieves the current configuration for the specified parallel environment (PE), executes an editor (either vi(1) or the editor indicated by the EDITOR environment variable) and registers the new configuration with the sge_qmaster(8). Refer to sge_pe(5) for details on the PE configuration format. Requires root or manager privilege. -mprj project Data for the specific project is retrieved (see project(5)) and an editor (either vi(1) or the editor indicated by $EDITOR) is invoked for modifying the project definition. Upon exiting the editor, the modified data is registered. Requires root or man- ager privileges. -mq queuename Retrieves the current configuration for the specified queue, executes an editor (either vi(1) or the editor indicated by the EDITOR environment variable) and registers the new configuration with the sge_qmaster(8). Refer to queue_conf(5) for details on the queue configuration format. Requires root or manager privi- lege. -msi session_id The specified session definition (see session_conf(5) is retrieved, an editor is executed (either vi(1) or the editor indicated by $EDITOR) and the changed session definition is reg- istered with sge_qmaster(8) upon exit of the editor. Session modifications require root/manager privileges or the user, which must be the owner of the session, needs to be a mem- ber of the access control list named sessionusers. -msconf The current scheduler configuration (see sched_conf(5)) is retrieved, an editor is executed (either vi(1) or the editor indicated by $EDITOR) and the changed configuration is regis- tered with sge_qmaster(8) upon exit of the editor. Requires root or manager privilege. -mstnode node_path=shares,... Modifies the specified share tree node(s) in the share tree (see share_tree(5)). The node_path is a hierarchical path ([/]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 Modifies the definition of the share tree (see share_tree(5)). The present share tree is retrieved and an editor (either vi(1) or the editor indicated by $EDITOR) is invoked for modifying the share tree definition. Upon exiting the editor, the modified data is registered with sge_qmaster(8). Requires root or man- ager privileges. -mu acl_name Retrieves the current configuration for the specified user access list, executes an editor (either vi(1) or the editor indicated by the EDITOR environment variable) and registers the new configuration with the sge_qmaster(8). Requires root or manager privilege. -muser user Data for the specific user is retrieved (see user(5)) and an editor (either vi(1) or the editor indicated by the EDITOR envi- ronment variable) is invoked for modifying the user definition. Upon exiting the editor, the modified data is registered. Requires root or manager privileges. -purge queue attr_nm,... obj_spec Delete the values of the attributes defined in attr_nm from the object defined in obj_spec. Obj_spec can be "queue_instance" or "queue_domain". The names of the attributes are described in queue_conf(1). This operation only works on a single queue instance or domain. It cannot be used on a cluster queue. In the case where the obj_spec is "queue@@hostgroup", the attribute values defined in attr_nm which are set for the indicated hostgroup are deleted, but not those which are set for the hosts contained by that hostgroup. If the attr_nm is '*', all attribute values set for the given queue instance or domain are deleted. The main difference between -dattr and -purge is that -dattr removes a value from a single list attribute, whereas -purge removes one or more overriding attribute settings from a cluster queue configuration. With -purge, the entire attribute is deleted for the given queue instance or queue domain. -rattr obj_spec attr_name val obj_instance,... Allows replacing a single configuration list attribute in multi- ple instances of an object with a single command. Find more information concerning obj_spec and obj_instance in the descrip- tion of -aattr . Requires root or manager privilege. -rsstnode node_path,... Recursively shows the name and shares of the specified share tree node(s) and the names and shares of its child nodes. (see share_tree(5)). The node_path is a hierarchical path ([/]node_name[[/.]node_name...]) specifying the location of a node in the share tree. -sc Display the complex configuration. -scal calendar_name Display the configuration of the specified calendar. -scall Show a list of all calendars currently defined. -sckpt ckpt_name Display the configuration of the specified checkpointing envi- ronment. -sckptl Show a list of the names of all checkpointing environments cur- rently configured. -sconf [host,...|global] 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 dis- played. 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 sge_conf(5). -sconfl Display a list of hosts for which configurations are available. The special host name global refers to the global configuration. -sdjsl Shows all DRMAA2 job sessions currently defined for the calling user. Users with manager privileges or root can see DRMAA2 job sessions from all users. -sds Displays detached settings in the cluster configuration. -se hostname Displays the definition of the specified execution host. -sel Displays the Univa Grid Engine execution host list. -secl Displays the Univa Grid Engine event client list. The provided list columns show the event client id and the name. The table contains also information about the user who has started the event client and from which host the client is connected. -sec all | {id|name[,id|name]} Displays information about Univa Grid Engine event clients. If the keyword all is used the information for all currently regis- tered event clients is shown. Otherwise only the information for the event clients with the specified id or name is shown. It is possible to mix id and name specifiers in the argument list. For "qsub" event clients the job_id_string information is avail- able after one event interval has passed. The following event client information is available: id: Unique event client id. name: Name of the event client (e.g. "qsub", "drmaa"). host: Host on which the event client is running. session_key: Internal session key of the event client. owner: User who registered the event client. group: Name of the group where the user is member. event_interval: Configured event update interval. buffered_events: Nr. of events pending at the event master. These events are waiting for delivery to the event client. busy_state: Busy state of the client. If a client is busy the event master will not send events to the client. register_time: Event client registration time. busy_alter_time: Latest known time when event client changed the busy state. latest_ack_time: Time when event master received the latest acknowledge message from the event client. event_sub_alter_time: Time of last recent event client subscrip- tion change. latest_resync_time: Latest full update time. At startup or on connection errors it is necessary to resync the event client data. This field will be updated at such situations. job_id_string: Event clients of type "qsub" which are registered when using the qsub -sync option store the job id string into this field. This information is not available in the first update interval. -sep Displays a list of virtual processors. This value is taken from the underlying OS and it depends on underlying hardware and operating system whether this value represents sockets, cores or supported threads. If this option is used in combination with -cb parameter then two additional columns will be shown in the output for the num- ber of sockets and number of cores. Currently SGE will enlist these values only if the corresponding operating system of exe- cution host is Linux under kernel >= 2.6.16, or Solaris 10. Other operating systems or versions might be supported with the future update releases. In case these values won't be retrieved, '0' character will be displayed. -si session_id Requests sent by this client to the sge_qmaster(1) daemon will be done as part of the specified session. If the switch is omit- ted or if NONE is specified as session_id then such requests will be executed outside the control of a session. The attempt to create a session with the -asi, -Asi or -csi switch will be automatically done within the session that is created if there is no other session_id specified with -si. Find more information concerning sessions in session_conf(5). -sh Displays the Univa Grid Engine administrative host list. -shgrp group Displays the host group entries for the group specified in group. -shgrpl Displays a name list of all currently defined host groups which have a valid host group configuration. -shgrp_tree group Shows a tree like structure of host group. -shgrp_resolved group 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. -sjc [jc_name] Displays the job class parameters specified in jc_name. Jc_name might be a job class name or a job class variant name. In case the variant part of the name is omitted this command will show the full job class specification otherwise it will show the set- tings specific for one variant. If jc_name itself is omitted, a template job class is printed. -sjcl Displays a name list of all currently defined job classes. -srqs [rqs_name_list] Show the definition of the resource quota sets (RQS) specified by the argument. -srqsl Show a list of all currently defined resource quota setss (RQSs). -sm Displays the managers list. -so Displays the operator list. -sobjl obj_spec attr_name val Shows a list of all configuration objects for which val matches at least one configuration value of the attributes whose name matches with 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 enlisted in queue_conf(5) or host_conf(5). Also wildcards can be used to match multiple attributes. Val can be an arbitrary string or a wildcard expression. -sp pe_name Show the definition of the parallel environment (PE) specified by the argument. -spl Show a list of all currently defined parallel environments (PEs). -sprj project Shows the definition of the specified project (see project(5)). -sprjl Shows the list of all currently defined projects. -sq wc_queue_list Displays one or multiple cluster queues or queue instances. A description of wc_queue_list can be found in sge_types(1). -sql Show a list of all currently defined cluster queues. -ss Displays the Univa Grid Engine submit host list. -ssi session_id Displays the configuration of the specified session. -ssil Displays a list of active sessions including ownership and end time. -ssconf Displays the current scheduler configuration in the format explained in sched_conf(5). -sstnode node_path,... Shows the name and shares of the specified share tree node(s) (see share_tree(5)). The node_path is a hierarchical path ([/]node_name[[/.]node_name...]) specifying the location of a node in the share tree. -sstree Shows the definition of the share tree (see share_tree(5)). -sst Shows the definition of the share tree in a tree view (see share_tree(5)). -sss Currently displays the host on which the Univa Grid Engine scheduler is active or an error message if no scheduler is run- ning. -stl Shows the names of all activated threads within sge_qmaster(1) process. If multiple threads of one type are running then the corresponding names are suffixed by a unique number. The number of threads that are started during sge_qmaster(1) start are builtin into qmaster or configured in the bootstrap file. Cer- tain thread types can also be started/stopped dynamically with the -at/-kt switches of qconf(1). -su acl_name Displays a Univa Grid Engine user access list (ACL). -sul Displays a list of names of all currently defined Univa Grid Engine user access lists (ACLs). -suser user,... Shows the definition of the specified user(s) (see user(5)). -suserl Shows the list of all currently defined users. -tsm Triggers an immediate scheduling run. When the scheduler param WRITE_SCHEDD_RUNLOG is set, the Univa Grid Engine scheduler is forced by this option to print trace messages of its next sched- uling run to the file //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 qstat(1) -F option (see descrip- tion of Full Format in section OUTPUT FORMATS of the qstat(1) manual page. ENVIRONMENTAL VARIABLES SGE_ROOT Specifies the location of the Univa Grid Engine standard configuration files. SGE_CELL If set, specifies the default Univa Grid Engine cell. To address a Univa 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 writ- ten 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 sge_qmaster(8) 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 sge_execd(8) 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 //common/act_qmaster Univa Grid Engine master host file SEE ALSO sge_intro(1), qstat(1), checkpoint(5), complex(5), sge_conf(5), host_conf(5), sge_pe(5), queue_conf(5), session_conf(5), sge_execd(8), sge_qmaster(8), sge_resource_quota(5) COPYRIGHT See sge_intro(1) for a full statement of rights and permissions. Univa Grid Engine User Commands UGE 8.5.4 QCONF(1)