Knowledge Center Contents Previous Next |
ls_clusterinfo()
Returns general information about LSF clusters.
DESCRIPTION
This routine returns general configuration information about LSF clusters.
ls_clusterinfo() returns an array of clusterInfo data structures, as defined in <lsf/lsf.h>. Each entry contains information about one cluster. The information includes cluster name, cluster status, the master host name, LSF primary administrator login name (for backward compatibility), LSF primary administrator user Id (for backward compatibility), total number of server hosts, total number of client hosts, available resource names, host types, host models, total number of LSF administrators, LSF administrator user Ids and LSF administrator login names.
The parameter resreq is designed to select eligible clusters that satisfy the given resource requirements from candidate clusters. This parameter is currently ignored. clusterlist gives a list of cluster names whose information should be returned, if they satisfy the resreq. If clusterlist is NULL, then all clusters known to LSF satisfying resreq will be returned. listsize gives the size of the clusterlist. If numhosts is not NULL, then *numhosts will be modified to return the number of clusters selected. The parameter options is currently ignored.
This routine returns a pointer to dynamically allocated data which can be freed in subsequent calls.
SYNOPSIS
#include <lsf/lsf.h> struct clusterInfo *ls_clusterinfo(char *resreq, int *numclusters, char **clusterlist, int listsize, int options) struct clusterInfo { char clusterName[MAXNAMELEN]; int status; char masterName[MAXHOSTNAMELEN]; char managerName[MAXHOSTNAMELEN]; int managerId; int numServers; int numClients; int nRes; char **resources; int nTypes; char **hostTypes; int nModels; char **hostModels; int nAdmins; int *adminIds; char **admins; int jsLicFlag; char afterHoursWindow[MAXLINELEN]; char preferAuthName[MAXLSFNAMELEN]; char inUseAuthName[MAXLSFNAMELEN]; };PARAMETERS
*resreq
Select eligible clusters that satisfy the given resource requirements from candidate clusters. This parameter is currently ignored.
*numclusters
If numclusters is not NULL, then *numclusters will be modified to return the number of clusters selected.
**clusterlist
Gives a list of cluster names whose information should be returned, if they satisfy the resreq. If clusterlist is NULL, then all clusters known to LSF satisfying resreq will be returned.
listsize
The size of the clusterlist.
option
The parameter options is currently ignored.
RETURN VALUES
array:
Function was successful.
struct:NULL
Function failed.
ERRORS
If the function fails, lserrno is set to indicate the error.
SEE ALSO
Related APIs
none
Equivalent line command
none
Files
$LSF_CONFDIR/lsf.shared
$LSF_CONFDIR/lsf.cluster.cluster_name
Platform Computing Inc.
www.platform.com |
Knowledge Center Contents Previous Next |