Python API reference

A web service URL

Format: http://host_name:port_number/ or https://host_name:port_number/

"Web services are ready..."

"Web services are not ready..."

Non-empty string

Format: http://host_name:port_number/ or https://host_name:port_number/

Non-empty string

Non-empty string

Print error message

Print error message

(status="ok")

message = <AppInfos><AppInfo><appName>%s</appName><status>%s</status></AppInfo>

<AppInfo><appName>%s</appName><status>%s</status></AppInfo><AppInfo>...</AppInfo></AppInfos>

(status="error")

message = <AppInfo><errMsg>Error message </errMsg></AppInfo>

(status="ok")

message = <AppParams><AppParam><id>%s</id><label>%s</label<mandatory>%s</mandatory>

<defaultValue>%s</defaultValue>></AppParam>

<AppInfo>...</AppInfo>

<AppParams>

(status="error")

message = <AppInfo><errMsg>Error message </errMsg></AppInfo>

Job parameters dictionary. It must include all the following:

Where:

<ID> is the parameter ID from application form, could be from CONSOLE.

<LOADING_TYPE> is one of the following: “upload”, “copy”, “link”

The <FILEPATH> must be a local path for “upload”.

The <FILEPATH> must be a IBM Spectrum LSF Application Center server path for “copy” and “link”.

(status="ok") job ID

(status="error") error messages returned from the web service

• Pending
• Suspended
• Running
• Exit
• Done

• yes
• no

Short format:

(status="ok") 
message = <Jobs>
  <Job>
     <name>%s</name>
     <id>%s</id>
     <status>%s</status>
     <cmd>%s</cmd>
  </Job>
  <Job>
   ...
  </Job>
</Jobs>

Detailed format:

(status="ok") 
message = <Jobs>
  <Job>
     <name>%s</name>
     <id>%s</id>
     <status>%s</status>
     <cmd>%s</cmd>
     <cwd>/home/lsfadmin/generic_1342080220286ST0Yx</cwd> 
     <description>-</description>
     <exHosts>test</exHosts> 
     <execCwd>/home/lsfadmin/generic_1342080220286ST0Yx</execCwd> 
...
  <Job>
   ...
  </Job>
</Jobs>

The following is the information returned when the parameter details=yes. All returned information is of type String.

(status="error") error messages returned from the web service.

Non-empty string

Matches the LSF job ID

(status="ok") "<Job> <id>%s</id><name>%s</name><status>%s</status><cmd>%s</cmd><extStatus>%s</extStatus></Job>"

(status="error") error messages returned from the web service

One of the following:

(status="ok")

“<Jobs> <Job> <id>%s</id> <name>%s</name><status>%s</status><cmd>%s</cmd></Job><extStatus>%s</extStatus><Job> <id>%s</id> <name>%s</name><status>%s</status><cmd>%s</cmd><extStatus>%s</extStatus></Job>…</Jobs>”

(status="error") error messages returned from the web service

Job name string pattern

"*" is supported in the job name string to match multiple jobs

(status="ok")

“<Jobs><Job> <id>%s</id> <name>%s</name><status>%s</status><cmd>%s</cmd><extStatus>%s</extStatus></Job><Job> <id>%s</id> <name>%s</name><status>%s</status><cmd>%s</cmd><extStatus>%s</extStatus></Job>…</Jobs>”

(status="error") error messages returned from the web service

For example: "Error to get Job info for job name: fluent*"

One of the following:

A unique number for the job ID

(status="ok") action response message from LSF

(status="error") error messages returned from the web service

A command listed in the configuration file $GUI_CONFDIR/webservice.usercmd.

By default, the following LSF commands are listed in this file:

• bbot
• bchkpnt
• bkill
• bpost
• brequeue
• brestart
• bresume
• brun
• bstop
• btop
• bswitch
• bmig

You can also add any other commands to the file that you want to run such as for example, ls or hostname.

(status="ok") command response message from LSF

(status="error") error messages returned from the web service

Non-empty string

Matches the LSF job ID

The destination directory path

If it is an empty string, use the current directory

The name of the file.

If it is an empty string, download all files

To specify multiple files, separate with a comma(,). You can also use the following wildcard characters in a file name to indicate multiple files, including the following characters:

• * - any number of alphanumeric characters
• ? - a single alphanumeric character
• [0-9] - a numeric character between 0 and 9.
• [a-z] - a single lower case letter from a to z.
• [A-Z] - a single capital letter from A to Z.

If there are white spaces, commas, or wildcard characters in the text, you must use double-quotation marks to enclose the text.

Optional. Command to use to compress files before downloading. If you do not specify the command, files are not compressed before downloading. The compression program must be installed on the Platform Application Center server and must be in the system path. The output of the compression command is returned by the API.

Download the job files and copy them to <dstPath>.

If a compression command is specified, compresses each specified file, downloads, and copies to <dstPath>.

Do not copy any files, check error message in IBM Spectrum LSF Application Center log file

Only used to upload files to the job directory on the web server.

The ID of the job for which to upload files.

The ID must be a positive integer and must match an LSF job ID.

Format: [host_name:]dstPath

Optional. Uploads files to the specified directory on the web server. The directory can be an absolute path on the web server or a relative path to the job directory on the web server. If not specified, the job directory on the web server is used.

When a host name is specified, uploads files to the specified job directory on the specified host. The directory must be an absolute path to the remote job directory on the host. The host can be any LSF server host.

If it is an empty string, uploads all files.

Uploads the job files and copies them to <dstPath>.

Do not upload files, check error message in IBM Spectrum LSF Application Center log file

(status="ok")

message

 <UserNotificationSettings>
     <UserName>user1</UserName>
     <UserEmail>user1@company.com</UserEmail>
     <AppParam>
          <defaultValue>Y</defaultValue>
          <id>NOTIFY_ENABLE</id>
          <label>Enable notifications</label>
          <type></type>
          <value>Y</value>
     </AppParam>
     <AppParam>
          <defaultValue>START,END</defaultValue>
          <id>NOTIFY_EVENTS</id>
          <label>Workload events</label>
          <type></type>
          <value>START,END</value>
     </AppParam>
     <AppParam>
          <defaultValue>BROWSER,EMAIL</defaultValue>
          <id>NOTIFY_CHANNELS</id>
          <label>Notification channels</label>
          <type></type>
          <value>BROWSER,EMAIL</value>
     </AppParam>
</UserNotificationSettings>

(status="error")

message = Error message

(status="ok")

message =”The workload id workloadId has been registered for status change notifications.”

(status="error")

message = Error message