Servers
Provides server management functionality.
The following operations are supported. For a formal definition, please review the Service Description.
-
GetServers
Returns an array of CJServer objects representing all servers that match the criteria in conditions.
Conditions is a formatted string of the same format of that used in Jobs.FindJobs() (in the jobs.asmx web service).
Please see Jobs.FindJobs() for further documentation on the conditions string.
The wsid of the user calling this method must have the admin priv.
The following are valid conditions keys:
string name : unique identifier of dbmachine/cjqueue assignment
int timeout : maximum query execution time
string context : the context this server belongs to
string dbuser : database user with which to login
string dbmachine : machine name of the database server
string dbcatalog : name of the database
int execcap : maximum number of concurrent executions
string gpriv : server is only available to users who are a member of a group with this priv
string dbpw : password with of dbuser
Parameters:
long admin_wsid : WebServicesID of admin account.
string admin_pw : Password of that account
string conditions : A formatted string describing the conditions for the search. See above for details on this.
Output:
CJServer[] : Contains objects matching conditions
A CJServer object contains:
Fields in CJServer are the same as GetServers() conditions
-
UpdateServer
Update server described identified by 'server_name' with information described in 'cjs' param.
Fields left null in the cjs object will also be updated as null in the db.
This method will fail if an attempt is made to set non-nullable fields to null
This method requires a user with the admin priv
Parameters:
long admin_wsid : WebServicesID of admin account.
string admin_pw : Password of that account
string server_name : identifier of the server entry to update CJServer cjs: Object containing server parameters to update. See GetServers() for CJServer field documentation.
Output:
void if succesful, exceptions if not