Server Methods

Method Description
addServer Adds a server to the system.

The user calling this method must have UpdateServerRight or AdministratorRight without being assigned to a department.

updateServer Updates a server in the system.

The user calling this method must have UpdateServerRight or AdministratorRight. If the calling user is assigned to a department, the user must have UpdateServerRight; this user can update servers assigned to the department and the departments that this user can manage .

Note: When performing an update, only set the fields that you want to update in the server object. The rest of the fields will be null.
To update a field to become null:
  • String objects should be set to be an empty string (for example: "").
  • The members of DateTime objects should be set to zero.
removeServer Removes a server from the system.

The user calling this method must have UpdateServerRight or AdministratorRight without being assigned to a department.

retrieveAllServers Retrieves all servers from the system as an array of servers.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

You must have UpdateServerRight or ViewServerRight, or be a super administrator to call this method. Super administrators will retrieve all servers in the system. Department administrators will retrieve all servers assigned to their departments and the departments that they can manage.

retrieveAllMonitorServers Retrieves all monitor servers from the system as an array of servers.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

You must have UpdateServerRight or ViewServerRight, or be a super administrator. Super administrators will retrieve all servers in the system. Department administrators will retrieve all servers assigned to their departments and the departments that they can manage.

retrieveAllServerNames Retrieves all server names from the system as an array of strings.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

Super administrators will retrieve all server names in the system. Department administrators will retrieve the names of all the servers assigned to their departments and the departments that they can manage, and the names of all public servers assigned to other departments.

retrieveAllServerNamesInDept Retrieves all server names from your department as an array of strings.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

Super administrators will retrieve all server names in the system. Department administrators will retrieve the names of all servers assigned to their departments and the departments that they can manage.

retrieveAllPGPlatform ServerNamesInDept Retrieves all PGP enabled server names from your department as an array of strings.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

Super administrators will retrieve all server names in the system. Department administrators will retrieve the names of all servers assigned to their departments and the departments that they can manage.

retrieveAllServerNamesInDeptByType Retrieves all enabled server names of this type from your department as an array of strings.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

Super administrators will retrieve all server names in the system. Department administrators will retrieve the names of all servers assigned to their departments and the departments that they can manage.

retrieveAllCfServerNames Retrieves all TIBCO MFT Platform Server names from the system as an array of strings.

The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

Super administrators will retrieve all node names in the system. Department administrators will retrieve the names of all servers assigned to their departments and the departments that they can manage, and the names of all public servers assigned to other departments.

getServer Gets a server from the system.

If the server is not found, a null is returned.

The user calling this method must have UpdateServerRight or ViewServerRight, or be a super administrator. Super administrators can get any server in the system. Department administrators can only get a server assigned to their departments and the departments that they can manage.

searchServers Retrieves all servers that match the search criteria specified in the server object.

Searches are only done on the following fields:

  • Node Name
  • IP Name
  • Node Type
  • Server Type
  • Department

Set the fields in the server object that you want to search on. All other fields will be ignored. You can set from one to all the fields. Use the percent sign (%) as a wildcard character. The results are returned as an array of server objects. The last element of the array is null. If no servers are found, an array of one element is returned with a value of null.

The user calling this method must have UpdateServerRight or ViewServerRight, or be a super administrator. Super administrators will retrieve all nodes in the system. Department administrators will retrieve all nodes assigned to their departments and the departments that they can manage.