1.2 Getting Started with the zos Command

Although many users prefer to use the PlateSpin Orchestrate Server Portal as they manage jobs, some might prefer a command line interface (CLI). This section is for advanced users or those who prefer CLI.

All zos commands begin with zos on the command line. The general format for a zos command is zos followed by the command name, followed by command line parameters, if needed:

zos command [command_parameters]

Before you use the zos CLI, make sure that your path is correctly pointing to the PlateSpin Orchestrate tools directory. On Windows platforms, the path is automatically set when you launch the PlateSpin Orchestrate command prompt window. If the path is set, you then need to log in to the PlateSpin Orchestrate Server before the commands work.

This section includes the following information:

1.2.1 Logging In to the Orchestrate Server

The administrator for PlateSpin Orchestrate provides a username, a password, and the name for the Orchestrate Server. The following shows a sample login sequence. Italics are used to indicate variable names.

>zos login -user=username Orchestrate_sserver_name
Please enter current password for 'Orchestrator_server_name': *******
Logged into Orchestrator_server_name_zos> as username

The login should now be complete.

Login information is stored in the home directory, so further zos commands on this server use the saved login information. To operate on a different Orchestrate Server, run zos login again with the new server information.

1.2.2 Running a Job

Use the run command to start a job. For example, if you want to run the “quickie” job, you would enter the following command:

>zos run quickie

If the job submission was successful, a JobID is displayed:

JobID: tester.1.quickie

To specify parameters when you start a job, add the parameters to the command line. For example, if you wanted to run the quickie job, specifying the numJoblets parameter with a value of 100, you would enter the following command:

>zos run quickie numJoblets=100
JobID: tester.2.quickie

The PlateSpin Orchestrate Server keeps track of your last started job so that further zos commands can default to the last started job. To operate on a different job, specify the Job ID as a command line parameter.

1.2.3 Monitoring a Job

A job can be monitored or managed when it is started or after it is started. To view the status of the last started job, use the status command:

>zos status

The server returns the status immediately. In the preceding example, the job is Running, which means the job is still being processed. Possible status messages include the following:

You can retrieve detailed status information about a job by using the -e option in the command line, as shown in the following example for the last started job:

>zos status -e
Job Status for tester.quickie.2
             State: Running (waiting for resources)
    Resource Count: 0              (0 this job)
  Percent Complete: 1%
         Queue Pos: n/a
   Child Job Count: 0              (0 this job)

     Instance Name: quickie
          Job Type: quickie
          Priority: medium
         Arguments: numJoblets=100

       Submit Time: 5/01/2005 12:20:19
     Delayed Start: n/a
        Start Time: 5/01/2005 12:20:19
          End Time: n/a  (estimated)
      Elapsed Time: 0:00:05
        Queue Time: 0:00:00
        Pause Time: 0:00:00

    Total CPU Time: 0:00:00        (0:00:00 this job)
     Total GCycles: 0:00:00        (0:00:00 this job)
        Total Cost: $0.0000        ($0.0000 this job)
         Burn Rate: $0.0000/hr     ($0.0000/hr this job)

       Cancel Type: <none>
         Job Error: <none>
   Job Error Count: 0              (0 this job)
Joblet Retry Count: 0              (0 this job)
  Node Error Count: 0              (0 this job)