.\" OpenPBS (Portable Batch System) v2.3 Software License .\" .\" Copyright (c) 1999-2000 Veridian Information Solutions, Inc. .\" All rights reserved. .\" .\" --------------------------------------------------------------------------- .\" For a license to use or redistribute the OpenPBS software under conditions .\" other than those described below, or to purchase support for this software, .\" please contact Veridian Systems, PBS Products Department ("Licensor") at: .\" .\" www.OpenPBS.org +1 650 967-4675 sales@OpenPBS.org .\" 877 902-4PBS (US toll-free) .\" --------------------------------------------------------------------------- .\" .\" This license covers use of the OpenPBS v2.3 software (the "Software") at .\" your site or location, and, for certain users, redistribution of the .\" Software to other sites and locations. Use and redistribution of .\" OpenPBS v2.3 in source and binary forms, with or without modification, .\" are permitted provided that all of the following conditions are met. .\" After December 31, 2001, only conditions 3-6 must be met: .\" .\" 1. Commercial and/or non-commercial use of the Software is permitted .\" provided a current software registration is on file at www.OpenPBS.org. .\" If use of this software contributes to a publication, product, or service .\" proper attribution must be given; see www.OpenPBS.org/credit.html .\" .\" 2. Redistribution in any form is only permitted for non-commercial, .\" non-profit purposes. There can be no charge for the Software or any .\" software incorporating the Software. Further, there can be no .\" expectation of revenue generated as a consequence of redistributing .\" the Software. .\" .\" 3. Any Redistribution of source code must retain the above copyright notice .\" and the acknowledgment contained in paragraph 6, this list of conditions .\" and the disclaimer contained in paragraph 7. .\" .\" 4. Any Redistribution in binary form must reproduce the above copyright .\" notice and the acknowledgment contained in paragraph 6, this list of .\" conditions and the disclaimer contained in paragraph 7 in the .\" documentation and/or other materials provided with the distribution. .\" .\" 5. Redistributions in any form must be accompanied by information on how to .\" obtain complete source code for the OpenPBS software and any .\" modifications and/or additions to the OpenPBS software. The source code .\" must either be included in the distribution or be available for no more .\" than the cost of distribution plus a nominal fee, and all modifications .\" and additions to the Software must be freely redistributable by any party .\" (including Licensor) without restriction. .\" .\" 6. All advertising materials mentioning features or use of the Software must .\" display the following acknowledgment: .\" .\" "This product includes software developed by NASA Ames Research Center, .\" Lawrence Livermore National Laboratory, and Veridian Information .\" Solutions, Inc. .\" Visit www.OpenPBS.org for OpenPBS software support, .\" products, and information." .\" .\" 7. DISCLAIMER OF WARRANTY .\" .\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES .\" OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT .\" ARE EXPRESSLY DISCLAIMED. .\" .\" IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE .\" U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT, .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, .\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF .\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING .\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" .\" This license will be governed by the laws of the Commonwealth of Virginia, .\" without reference to its choice of law rules. .if \n(Pb .ig Ig .TH pbs_statserver 3B "" Local PBS .so ../ers/ers.macros .Ig .SH NAME pbs_statserver \- obtain status of a pbs batch server .SH SYNOPSIS #include .br #include .sp .nf .ft 3 struct batch_status *pbs_statserver(\^int/ connect, struct/ attrl/ *attrib, char/ *extend) .sp void pbs_statfree(\^struct batch_status *psj\^) .fi .ft 1 .SH DESCRIPTION Issue a batch request to obtain the status of a batch server. .LP A .I "Status Server" batch request is generated and sent to the server over the connection specified by .Ar connect which is the return value of \fBpbs_connect\fP(). .LP The parameter, .Ar attrib , is a pointer to an .I attrl structure which is defined in pbs_ifl.h as: .sp .Ty .nf struct attrl { struct attrl *next; char *name; char *resource; char *value; }; .fi .sp .ft 1 The .Ar attrib .ft 1 list is terminated by the first entry where .Ty next is a null pointer. If .Ar attrib is given, then only the attributes in the list are returned by the server. Otherwise, all the attributes of the server are returned. When an .Ar attrib list is specified, the .Ty name member is a pointer to a attribute name as listed in pbs_alter(3) and pbs_submit(3). The .Ty resource member is only used if the name member is ATTR_l, otherwise it should be a pointer to a null string. The .Ty value member should aways be a pointer to a null string. .LP The parameter, .Ar extend , is reserved for implementation defined extensions. .if !\n(Pb .ig Ig It is not currently used by this function. .Ig .LP The return value is a pointer to a list of batch_status structures, which is defined in pbs_ifl.h as: .sp .Ty .nf struct batch_status { struct batch_status *next; char *name; struct attrl *attribs; char *text; } .fi .ft 1 .LP It is up the user to free the space when no longer needed, by calling \fBpbs_statfree\fP(). .LP .SH "SEE ALSO" qstat(1B) and pbs_connect(3B) .SH DIAGNOSTICS When the batch request generated by \fBpbs_statserver\fP() function has been completed successfully by a batch server, the routine will return a pointer to a batch_status structure. Otherwise, a null pointer is returned and the error code is set in pbs_errno. \" turn off any extra indent left by the Sh macro .RE