QSTAT(1)                   POSIX Programmer's Manual                  QSTAT(1)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       qstat -- show status of batch jobs

SSYYNNOOPPSSIISS
       qstat [[-f]] _j_o_b___i_d_e_n_t_i_f_i_e_r...

       qstat -Q [[-f]] _d_e_s_t_i_n_a_t_i_o_n...

       qstat -B [[-f]] _s_e_r_v_e_r___n_a_m_e...

DDEESSCCRRIIPPTTIIOONN
       The status of a batch job, batch queue, or batch server is obtained by
       a request to the server. The _q_s_t_a_t utility is a user-accessible batch
       client that requests the status of one or more batch jobs, batch
       queues, or servers, and writes the status information to standard
       output.

       For each successfully processed batch _j_o_b___i_d_e_n_t_i_f_i_e_r, the _q_s_t_a_t utility
       shall display information about the corresponding batch job.

       For each successfully processed destination, the _q_s_t_a_t utility shall
       display information about the corresponding batch queue.

       For each successfully processed server name, the _q_s_t_a_t utility shall
       display information about the corresponding server.

       The _q_s_t_a_t utility shall acquire batch job status information by sending
       a _J_o_b _S_t_a_t_u_s _R_e_q_u_e_s_t to a batch server. The _q_s_t_a_t utility shall acquire
       batch queue status information by sending a _Q_u_e_u_e _S_t_a_t_u_s _R_e_q_u_e_s_t to a
       batch server. The _q_s_t_a_t utility shall acquire server status information
       by sending a _S_e_r_v_e_r _S_t_a_t_u_s _R_e_q_u_e_s_t to a batch server.

OOPPTTIIOONNSS
       The _q_s_t_a_t utility shall conform to the Base Definitions volume of
       POSIX.1-2017, _S_e_c_t_i_o_n _1_2_._2, _U_t_i_l_i_t_y _S_y_n_t_a_x _G_u_i_d_e_l_i_n_e_s.

       The following options shall be supported by the implementation:

       --ff        Specify that a full display is produced.

                 The minimum contents of a full display are specified in the
                 STDOUT section.

                 Additional contents and format of a full display are
                 implementation-defined.

       --QQ        Specify that the operand is a destination.

                 The _q_s_t_a_t utility shall display information about each batch
                 queue at each destination identified as an operand.

       --BB        Specify that the operand is a server name.

                 The _q_s_t_a_t utility shall display information about each server
                 identified as an operand.

OOPPEERRAANNDDSS
       If the --QQ option is presented to the _q_s_t_a_t utility, the utility shall
       accept one or more operands that conform to the syntax for a
       destination (see _S_e_c_t_i_o_n _3_._3_._2, _D_e_s_t_i_n_a_t_i_o_n).

       If the --BB option is presented to the _q_s_t_a_t utility, the utility shall
       accept one or more _s_e_r_v_e_r___n_a_m_e operands.

       If neither the --BB nor the --QQ option is presented to the _q_s_t_a_t utility,
       the utility shall accept one or more operands that conform to the
       syntax for a batch _j_o_b___i_d_e_n_t_i_f_i_e_r (see _S_e_c_t_i_o_n _3_._3_._1, _B_a_t_c_h _J_o_b
       _I_d_e_n_t_i_f_i_e_r).

SSTTDDIINN
       Not used.

IINNPPUUTT FFIILLEESS
       None.

EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS
       The following environment variables shall affect the execution of
       _q_s_t_a_t:

       _H_O_M_E      Determine the pathname of the user's home directory.

       _L_A_N_G      Provide a default value for the internationalization
                 variables that are unset or null. (See the Base Definitions
                 volume of POSIX.1-2017, _S_e_c_t_i_o_n _8_._2, _I_n_t_e_r_n_a_t_i_o_n_a_l_i_z_a_t_i_o_n
                 _V_a_r_i_a_b_l_e_s the precedence of internationalization variables
                 used to determine the values of locale categories.)

       _L_C___A_L_L    If set to a non-empty string value, override the values of
                 all the other internationalization variables.

       _L_C___C_O_L_L_A_T_E
                 Determine the locale for the behavior of ranges, equivalence
                 classes, and multi-character collating elements within
                 regular expressions.

       _L_C___C_T_Y_P_E  Determine the locale for the interpretation of sequences of
                 bytes of text data as characters (for example, single-byte as
                 opposed to multi-byte characters in arguments).

       _L_C___M_E_S_S_A_G_E_S
                 Determine the locale that should be used to affect the format
                 and contents of diagnostic messages written to standard
                 error.

       _L_C___N_U_M_E_R_I_C
                 Determine the locale for selecting the radix character used
                 when writing floating-point formatted output.

AASSYYNNCCHHRROONNOOUUSS EEVVEENNTTSS
       Default.

SSTTDDOOUUTT
       If an operand presented to the _q_s_t_a_t utility is a batch _j_o_b___i_d_e_n_t_i_f_i_e_r
       and the --ff option is not specified, the _q_s_t_a_t utility shall display the
       following items on a single line, in the stated order, with white space
       between each item, for each successfully processed operand:

        *  The batch _j_o_b___i_d_e_n_t_i_f_i_e_r

        *  The batch job name

        *  The _J_o_b___O_w_n_e_r attribute

        *  The CPU time used by the batch job

        *  The batch job state

        *  The batch job location

       If an operand presented to the _q_s_t_a_t utility is a batch _j_o_b___i_d_e_n_t_i_f_i_e_r
       and the --ff option is specified, the _q_s_t_a_t utility shall display the
       following items for each success fully processed operand:

        *  The batch _j_o_b___i_d_e_n_t_i_f_i_e_r

        *  The batch job name

        *  The _J_o_b___O_w_n_e_r attribute

        *  The execution user ID

        *  The CPU time used by the batch job

        *  The batch job state

        *  The batch job location

        *  Additional implementation-defined information, if any, about the
           batch job or batch queue

       If an operand presented to the _q_s_t_a_t utility is a destination, the --QQ
       option is specified, and the --ff option is not specified, the _q_s_t_a_t
       utility shall display the following items on a single line, in the
       stated order, with white space between each item, for each successfully
       processed operand:

        *  The batch queue name

        *  The maximum number of batch jobs that shall be run in the batch
           queue concurrently

        *  The total number of batch jobs in the batch queue

        *  The status of the batch queue

        *  For each state, the number of batch jobs in that state in the batch
           queue and the name of the state

        *  The type of batch queue (execution or routing)

       If the operands presented to the _q_s_t_a_t utility are destinations, the --QQ
       option is specified, and the --ff option is specified, the _q_s_t_a_t utility
       shall display the following items for each successfully processed
       operand:

        *  The batch queue name

        *  The maximum number of batch jobs that shall be run in the batch
           queue concurrently

        *  The total number of batch jobs in the batch queue

        *  The status of the batch queue

        *  For each state, the number of batch jobs in that state in the batch
           queue and the name of the state

        *  The type of batch queue (execution or routing)

        *  Additional implementation-defined information, if any, about the
           batch queue

       If the operands presented to the _q_s_t_a_t utility are batch server names,
       the --BB option is specified, and the --ff option is not specified, the
       _q_s_t_a_t utility shall display the following items on a single line, in
       the stated order, with white space between each item, for each
       successfully processed operand:

        *  The batch server name

        *  The maximum number of batch jobs that shall be run in the batch
           queue concurrently

        *  The total number of batch jobs managed by the batch server

        *  The status of the batch server

        *  For each state, the number of batch jobs in that state and the name
           of the state

       If the operands presented to the _q_s_t_a_t utility are server names, the --BB
       option is specified, and the --ff option is specified, the _q_s_t_a_t utility
       shall display the following items for each successfully processed
       operand:

        *  The server name

        *  The maximum number of batch jobs that shall be run in the batch
           queue concurrently

        *  The total number of batch jobs managed by the server

        *  The status of the server

        *  For each state, the number of batch jobs in that state and the name
           of the state

        *  Additional implementation-defined information, if any, about the
           server

SSTTDDEERRRR
       The standard error shall be used only for diagnostic messages.

OOUUTTPPUUTT FFIILLEESS
       None.

EEXXTTEENNDDEEDD DDEESSCCRRIIPPTTIIOONN
       None.

EEXXIITT SSTTAATTUUSS
       The following exit values shall be returned:

        0    Successful completion.

       >0    An error occurred.

CCOONNSSEEQQUUEENNCCEESS OOFF EERRRROORRSS
       In addition to the default behavior, the _q_s_t_a_t utility shall not be
       required to write a diagnostic message to standard error when the error
       reply received from a batch server indicates that the batch
       _j_o_b___i_d_e_n_t_i_f_i_e_r does not exist on the server. Whether or not the _q_s_t_a_t
       utility waits to output the diagnostic message while attempting to
       locate the batch job on other servers is implementation-defined.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

EEXXAAMMPPLLEESS
       None.

RRAATTIIOONNAALLEE
       The _q_s_t_a_t utility allows users to display the status of jobs and list
       the batch jobs in queues.

       The operands of the _q_s_t_a_t utility may be either job identifiers, queues
       (specified as destination identifiers), or batch server names. The --QQ
       and --BB options, or absence thereof, indicate the nature of the
       operands.

       The other options of the _q_s_t_a_t utility allow the user to control the
       amount of information displayed and the format in which it is
       displayed. Should a user wish to display the status of a set of jobs
       that match a selection criteria, the _q_s_e_l_e_c_t utility may be used to
       acquire such a list.

       The --ff option allows users to request a ``full'' display in an
       implementation-defined format.

       Historically, the _q_s_t_a_t utility has been a part of the NQS and its
       derivatives, the existing practice on which it is based.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       The _q_s_t_a_t utility may be removed in a future version.

SSEEEE AALLSSOO
       _C_h_a_p_t_e_r _3, _B_a_t_c_h _E_n_v_i_r_o_n_m_e_n_t _S_e_r_v_i_c_e_s, _q_s_e_l_e_c_t

       The Base Definitions volume of POSIX.1-2017, _C_h_a_p_t_e_r _8, _E_n_v_i_r_o_n_m_e_n_t
       _V_a_r_i_a_b_l_e_s, _S_e_c_t_i_o_n _1_2_._2, _U_t_i_l_i_t_y _S_y_n_t_a_x _G_u_i_d_e_l_i_n_e_s

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                             QSTAT(1)
