pacclient.py

-l URL

Specify the URL of the IBM Spectrum LSF Application Center web service in the format:

http://host_name:port_number/

-l

List all applications and application status.

-p app_name[:template_name]

List all parameters and default values for the specified application. To see parameter values saved in your application, specify both the published form name and the submission template name.

-a "app_name[:template_name]"

Required. Specify the published application form to use for default job submission parameters.

Specify the application name and optionally the name of your submission template.

[-c file_path ]

Set job submission parameters from a file.

Specify the path to a file on the local host that defines job parameters and input files. The file format is a list of field ID and value pairs:

• field_ID

  Specify the field ID from the application form template.

  You must be an administrator in Platform Application Center to access editing mode and view the field IDs.

• value

  Specify the value for the field input.

  If the field requires a file for input, you must also choose to upload the file, copy the file to the job directory, or link the file to the job directory.

  Specify the value in the following format. To specify multiple files, separate with a hash (#):

  file_path,upload[#file_path,upload]

  file_path,copy[#file_path,copy]

  file_path,copy[#file_path,copy]

For example:

Submit the job and copy the specified input file to the job directory:

MY_INPUT_FILE=/home/user1/myfile,copy

Submit the job and link the specified files to the job directory:

MY_INPUT_FILE=/home/user1/myfile3,link#/home/user1/myfile4,link

Submit the job and upload one file for FLUENT_JOURNAL and multiple CAS_INPUT files to the job directory:

[Parameter]
JOB_NAME=FF_20100329
VERSION=6.3.26
CONSOLE_SUPPORT=No
[Inputfile]
FLUENT_JOURNAL=C:\demo\fluent\fluent-test.jou,upload
CAS_INPUT_FILE=C:\demo\fluent\fluent-test.cas.gz,upload#C:\demo\fluent\fluent-test.cas2.gz,upload

[-p field_ID=value;[field_ID=value;]...]

Define the job submission parameters on the command line.

Specify field ID and value pairs as described for the -c option.

-l

Long format. Displays detailed information for each job, job array, or job group in a multiline format.

-u user_name | -u all

Only displays information about jobs that have been submitted by the specified user. The keyword all specifies all users.

-p hours

In addition to pending, running, and suspended jobs, displays information about all done and exited jobs that have ended within the specified number of hours. If the number of hours is not specified, displays information about done and exited jobs submitted by the user running this command that have ended within the past hour.

-s Pending|Running|Done|Exit|Suspended

Displays information only about jobs that have the specified state.

-n job_name

Displays information about jobs or job arrays with the specified job name. The wildcard character (*) can be used within a job name, but cannot appear within array indices. For example job* returns jobA and jobarray[1], *AAA*[1] returns the first element in all job arrays with names containing AAA, however job1[*] will not return anything since the wildcard is within the array index.

p job_ID

Display information for the job with the specified job ID.

-g job_group_name

Display information for jobs in the specified job group.

-h

Display subcommand usage.

-l job_ID

Specify the ID of the job for which to list files.

[-d directory]

Copy files to the specified directory.

[-f file_name [,file_name ...]]

Downloads the specified files. When specifying multiple file names, use a comma-separated list. 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 or wildcard characters in the text, you must use double-quotation marks to enclose the text.

[-c compression_command]

Command for the compression program to use to create compressed files to download. Files are compressed, then downloaded to the client. The client must decompress the files after download. The compression program must be installed on the Platform Application Center server and must be in the system path.

job_ID

Specify the job ID.

-d dir_name

Copies 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.

-d host_name:dir_name

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.

-f file_name[,file_name...]

Uploads the specified file. Specify the path. Separate multiple files with a comma. If no path is specified for the file, the job directory on the web server is used as the location of the file.

job_ID

Only used to upload files to the job directory on the web server. The ID of the job for which to upload files. The job must have the state Running. The ID must be a positive integer.

-h

Display subcommand usage.

-c user_command

Specify the executable command with its full path and options. The command must be listed in the configuration file $GUI_CONFDIR/webservice.usercmd.

-h

Display subcommand usage.

pacclient.py useradd -u testUser -e testUser@domain.com -r Role1,Role2,Role3

--help | -h

Display subcommand usage.

[--username|-u]

Required. The username to add to IBM Spectrum LSF Application Center.

[--email | -e]

Optional. Email address of the user to add.

[--role | -r]

Required. The role names to assign to the user. Multiple role names must be separated by a comma.

pacclient.py userdel -u User1

--help | -h

Display subcommand usage.

[--username|-u]

Required. The username to remove from IBM Spectrum LSF Application Center.

--file | -f file_path

Updates user emails by importing a CSV file with comma-separated user name and user email in fixed columns. For example:

user1,user1@company.com
user2,user2@company.com

Usage example: pacclient.py userupd -f /file/path/emails.csv

--register | -r workload_id [--param|-p "name=value[;name=value]"]

Registers notifications for a workload. For example, pacclient.py notification -r 128 -p "NOTIFY_EVENTS=START,END;NOTIFY_CHANNELS=EMAIL"

--settings | -s

Displays the notification settings for the current user. For example:

pacclient.py notification -s
Notification settings for the current user user1
Notification parameters:
NOTIFY_ENABLE=Y
NOTIFY_EVENTS=START,END
NOTIFY_CHANNELS=BROWSER

--register | -r workload_id

Specifies the ID of the workload for which to register notifications.

[--param|-p "name=value[;name=value]"]

Specifies notification parameters with name and value pairs delimited by a semicolon:

NOTIFY_EVENTS Specifies the workload state changes that will trigger a notification. Possible values: START, END, SUSPENDED, EXIT delimited by a comma (no white spaces). [optional]

NOTIFY_CHANNELS Specifies the channels for delivery of workload state change notifications. Possible values: BROWSER, DESKTOP, MOBILE, EMAIL delimited by a comma (no white spaces). BROWSER is always enabled by default.

Use double quotes around notification parameters.

If -p is omitted, the notification settings for the current user are applied.

--settings | -s

Displays the notification settings for the current user.

-f flow_name

Displays flow instances using the specified flow definition (short flow definition name). For example, pacclient.py flow -f flow1

-i flow_id

Displays flow instance with the specified flow ID. For example, pacclient.py flow -i 40

-u user_name | -u all

Displays flow instances that have been submitted by the specified user. The keyword "all" shows flow details for all users.

-s Running | Exit | Killed | Done | Suspended

Displays flow instances that are currently in the state specified.

--action | -a kill | suspend | resume flow_id

Specify the "Kill", "Suspend", or "Resume" flow action. For example, pacclient.py flowaction -a kill 40

--action | -a rerun [-v variables] flow_id

Specify the "Rerun" flow action and optionally specify the input variables. For example, pacclient.py flowaction -a rerun -v "a=1;b=2;c=3" 40

--action | -a setvar -v variables flow_id

Specify the set variables flow action and specify the input variables. For example, pacclient.py flowaction -a setvar -v "a=1;b=2;c=3" 40

-v variables

The input variables provided to the flow instance when using "rerun" or "setvar". This option is required for "setvar", and optional for "rerun". The variables are separated by semicolons (;).

flow_id

Specifies the flow instance ID.

-n flow_name

Displays flow definitions containing the specified flow definition name (short flow definition name). For example, pacclient.py flowdef -n flow1

-u user_name | -u all

Displays flow definitions owned by a specific user or use the keyword "all" to list flow definitions for all flow owners.

-s onhold | released

Displays flow definitions with a state of Onhold or Released.

-p

Displays published flow definitions.

--action | -a submit [-v variables] flow_name

Submits the flow definition. Optionally specify input variables to provide to the flow definition when it is submitted. The variables are separated by semicolons (;). For example, pacclient.py flowdefaction -a submit -v "a=1;b=2;c=3" "username:flow1"

--action | -a publish | unpublish | hold | release flow_name

Specifies a flow action. You can publish, unpublish, hold, or release a flow definition. For example, pacclient.py flowdefaction -a publish "username:flow1"

--action | -a commit [-c comment] [-v version] file_path

Commits the flow definition. Optionally set a comment and version to the flow definition when it is committed. For example, pacclient.py flowdefaction -a commit -c "A test flow" -v 1.2 "/home/user/flow1.xml"

--action | -a delete [-f] flow_name

Deletes a flow definition. Optionally use -f to request Process Manager to forcefully remove the flow definition even if there are proxy events associated with the flow definition. For example: pacclient.py flowdefaction -a delete -f "username:flow1"