Novell PLATESPIN ORCHESTRATE Command Line Reference

Command Line Reference

Novell®

PlateSpin® Orchestrate

novdocx (en) 13 May 2009

AUTHORIZED DOCUMENTATION

2.0.2

June 17, 2009

www.novell.com

PlateSpin Orchestrate 2.0 Command Line Reference

Legal Notices

Novell, Inc. makes no representations or warranties with respect to the contents or use of this documentation, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time, without obligation to notify any person or entity of such revisions or changes.

Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to notify any person or entity of such changes.

Any products or technical information provided under this Agreement may be subject to U.S. export controls and the trade laws of other countries. You agree to comply with all export control regulations and to obtain any required licenses or classification to export, re-export or import deliverables. You agree not to export or re-export to entities on the current U.S. export exclusion lists or to any embargoed or terrorist countries as specified in the U.S. export laws. You agree to not use deliverables for prohibited nuclear, missile, or chemical biological weaponry end uses. See the

Novell International Trade Services Web page (http://www.novell.com/info/exports/) for more information on

exporting Novell software. Novell assumes no responsibility for your failure to obtain any necessary export approvals.

novdocx (en) 13 May 2009

Copyright © 2009 Novell, Inc. All rights reserved. No part of this publication may be reproduced, photocopied, stored on a retrieval system, or transmitted without the express written consent of the publisher.

Novell, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed on the Novell Legal Patents Web page (http://www.novell.com/company/legal/patents/) and one or more additional patents or pending patent applications in the U.S. and in other countries.

Novell, Inc. 404 Wyman Street, Suite 500 Waltham, MA 02451 U.S.A. www.novell.com

Online Documentation: To access the latest online documentation for this and other Novell products, see

the Novell Documentation Web page (http://www.novell.com/documentation).

Novell Trademarks

For Novell trademarks, see the Novell Trademark and Service Mark list (http://www.novell.com/company/legal/

trademarks/tmlist.html).

Third-Party Materials

All third-party trademarks are the property of their respective owners.

novdocx (en) 13 May 2009

4 PlateSpin Orchestrate 2.0 Command Line Reference

Contents

About This Reference 7

1 The zos Command Line Tool 9

1.1 List of zos Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1.2 Getting Started with the zos Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.2.1 Logging In to the Orchestrate Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

1.2.2 Running a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.2.3 Monitoring a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

1.3 Details, Usage, and Syntax Examples of zos Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

cancel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

cat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

fail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

head . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

jobinfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

joblist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

listen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

mkdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

pause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

resume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

tail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

novdocx (en) 13 May 2009

2 The zosadmin Command Line Tool 61

2.1 List of zosadmin Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

2.2 Getting Started with the zosadmin Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

2.2.1 Logging In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

2.2.2 Checking Login Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

2.2.3 Logging Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

2.3 Details, Usage, and Syntax Examples of zosadmin Commands . . . . . . . . . . . . . . . . . . . . . . . 64

auditclean. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

auditcount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

auditreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

cancelalljobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

deploy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Contents 5

dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

init. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

invoke. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

redeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

rotatelogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

undeploy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

verify. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

novdocx (en) 13 May 2009

A Documentation Updates 99

A.1 May 15, 2009 (2.0.2 Release) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

6 PlateSpin Orchestrate 2.0 Command Line Reference

About This Reference

novdocx (en) 13 May 2009

This PlateSpin Orchestrate Command Line Reference introduces the two command line interface client tools of PlateSpin basic administration tools. The reference is organized as follows:

 Chapter 1, “The zos Command Line Tool,” on page 9

 Chapter 2, “The zosadmin Command Line Tool,” on page 61

Audience

This book is intended for data center managers and IT or Operations administrators. The zos command line interface is intended for the use of Job Managers. The book assumes that users of the product have the following background:

 General understanding of network operating environments and systems architecture.

 Knowledge of basic UNIX* shell commands and text editors.

Feedback

We want to hear your comments and suggestions about this manual and the other documentation included with this product. Please use the User Comments feature at the bottom of each page of the online documentation, or go to www.novell.com/documentation/feedback.html (http://

www.novell.com/documentation/feedback.html) and enter your comments there.

Documentation Updates

Orchestrate from Novell®, zos and zosadmin. These are the product’s

For the most recent version of this Command Line Reference, visit the PlateSpin Orchestrate 2.0

Web site (http://www.novell.com/documentation/pso_orchestrate20/).

Documentation Conventions

In Novell documentation, a greater-than symbol (>) is used to separate actions within a step and items in a cross-reference path.

A trademark symbol ( trademark.

When a single pathname can be written with a backslash for some platforms or a forward slash for other platforms, the pathname is presented with a backslash. Users of platforms that require a forward slash, such as Linux* or UNIX, should use forward slashes as required by your software.

, TM, etc.) denotes a Novell trademark. An asterisk (*) denotes a third-party

About This Reference 7

novdocx (en) 13 May 2009

8 PlateSpin Orchestrate 2.0 Command Line Reference

The zos Command Line Tool

novdocx (en) 13 May 2009

The zos command line tool can be used by logged-in users. To use the command line tool, each user requires a login name and password that are created by the administrator for PlateSpin from Novell jobs, monitor jobs, and perform other user functions.

This section includes information about the following:

 Section 1.1, “List of zos Commands,” on page 9

 Section 1.2, “Getting Started with the zos Command,” on page 10

 Section 1.3, “Details, Usage, and Syntax Examples of zos Commands,” on page 13

. The

zos

command line tool can be used to log in to the Orchestrate Server, to submit

Orchestrate

1.1 List of zos Commands

The following table includes a list of

Table 1-1 Available zos Commands and Their Descriptions

Command Description

cancel Cancel a running job

cat Displays the contents of a datagrid file

copy Copy files and directories to and from the datagrid

zos

commands and a description for each command.

delete Delete files and directories in the datagrid

dir List files and directories in the datagrid

event Send an event to a running job

fail Directs the job to end in failure

head Displays the first part of a datagrid file

help Displays help for any of the commands in this list

info Display information about a grid object

jobinfo Display important information for a job

joblist List all of the available jobs and arguments

jobs List the running queued or historical job

listen Listen to events generated by a running job

log Displays the log for the specified job

logout Log out of the grid

mkdir Make a new directory in the datagrid

The zos Command Line Tool

Command Description

move Move files and directories in the datagrid

password Change user password on current grid

pause Pause a running job

priority Change the priority of a running job

resume Resume a running job

run Run a job

search Perform grid object search

status Display the status of a running or previously run job

tail Displays the end of a datagrid file

1.2 Getting Started with the zos Command

novdocx (en) 13 May 2009

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

zos

All zos commands begin with

zos

followed by the command name, followed by command line parameters, if needed:

zos command [command_parameters]

on the command line. The general format for a zos command is

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:

 Section 1.2.1, “Logging In to the Orchestrate Server,” on page 10

 Section 1.2.2, “Running a Job,” on page 11

 Section 1.2.3, “Monitoring a Job,” on page 11

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 saved login information. To operate on a different Orchestrate Server, run new server information.

10 PlateSpin Orchestrate 2.0 Command Line Reference

zos

commands on this server use the

zos login

again with the

1.2.2 Running a Job

novdocx (en) 13 May 2009

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

>zos status Running

status

command:

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:

Submitted

Queued

Started

Running

Paused

Completing

Cancelling

Failing

Completed

Cancelled

Failed

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

The zos Command Line Tool 11

Child Job Count: 0 (0 this job)

Instance Name: quickie Job Type: quickie Memo: 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)

novdocx (en) 13 May 2009

12 PlateSpin Orchestrate 2.0 Command Line Reference

1.3 Details, Usage, and Syntax Examples of zos Commands

novdocx (en) 13 May 2009

This section includes a detailed list of the

zos

commands you can use. It also includes examples for

using these commands and shows the syntax of typical commands.

NOTE: Items shown in brackets [ ] are optional. Items shown in italics are contextual examples.

The section is organized according to the command names, which include the following:

 “cancel” on page 14

 “cat” on page 16

 “copy” on page 18

 “delete” on page 20

 “dir” on page 21

 “event” on page 23

 “fail” on page 25

 “head” on page 26

 “info” on page 28

 “jobinfo” on page 30

 “joblist” on page 32

 “jobs” on page 33

 “listen” on page 35

 “log” on page 36

 “login” on page 38

 “logout” on page 40

 “mkdir” on page 41

 “move” on page 43

 “password” on page 44

 “pause” on page 45

 “priority” on page 47

 “resume” on page 49

 “run” on page 50

 “search” on page 53

 “status” on page 55

 “tail” on page 57

The zos Command Line Tool 13

cancel

This command cancels a running job.

Syntax

zos cancel [jobid] [--reason=]

Arguments

jobid

The user must enter the jobid that he or she is interested in. The default for this argument is the last job run.

Options

-m, --reason=<value>

Specifies the reason to log for this action. The user must enter a value with this option.

novdocx (en) 13 May 2009

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To cancel the current job for the login user, use the following command:

14 PlateSpin Orchestrate 2.0 Command Line Reference

zos cancel

Example 2

To cancel the named job instance <jobid> for the login user, use the following command:

zos cancel <jobid>

novdocx (en) 13 May 2009

The zos Command Line Tool 15

cat

This command displays the contents of a datagrid file.

Syntax

zos cat path

Arguments

path

The path on the datagrid.

Options

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

novdocx (en) 13 May 2009

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To display the JDL file for the

zos cat grid:///!quickie/quickie.jdl

16 PlateSpin Orchestrate 2.0 Command Line Reference

quickie

job, use the following command:

Example 2

novdocx (en) 13 May 2009

To display the

zos cat grid:///^/job.log

job.log

file for the active or last run job, use the following command:

The zos Command Line Tool 17

copy

This command copies files and directories to and from the data zos.

Syntax

zos copy source dest [--recursive]

Arguments

source

The datagrid source from which the files or directories are to be copied.

dest

The datagrid destination to which the files or directories are to be copied.

Options

novdocx (en) 13 May 2009

-r, --recursive

Processes directories recursively.

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

18 PlateSpin Orchestrate 2.0 Command Line Reference

Examples

Example 1

To copy a local file into a previously created datagrid subdirectory, use the following command:

zos copy local.txt grid:///images

Example 2

To copy a file from the current job instance directory to a local file, use the following command:

zos copy grid:///^/results.txt local.txt

Example 3

To copy a file from a named job instance directory to a local file, use the following command:

zos copy grid:///^user.myjob.1024/results.txt local.txt

novdocx (en) 13 May 2009

Example 4

To copy a local file into the job directory for job myjob, use the following command:

zos copy local.txt grid:///!myjob

Example 5

To copy a local file into the current user’s home directory, use the following command:

zos copy local.txt grid:///~/local.txt

Example 6

To copy a local file into another user’s (barney) home directory, use the following command:

zos copy local.txt grid:///~barney/local.txt

Example 7

To copy a local file into a subdirectory of the job directory, use the following command:

zos copy local.txt grid:///!myjob/subdir

Example 8

To copy a local file into the current job instance directory, use the following command:

zos copy local.txt grid:///^/

Example 9

To recursively copy a local directory to the datagrid root, creating a new directory, use the following command:

zos copy /home/tester/myDir grid:/// -r

The zos Command Line Tool 19

delete

This command deletes files and directories in the datagrid.

Syntax

zos delete path

Arguments

path

The path on the datagrid.

Options

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

novdocx (en) 13 May 2009

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To delete a file under the datagrid directory images, use the following command:

zos delete grid:///images/myFile

20 PlateSpin Orchestrate 2.0 Command Line Reference

dir

This command lists files and directories in the datagrid.

Syntax

zos dir path

Arguments

path

The path on the datagrid.

Options

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

novdocx (en) 13 May 2009

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To list files for the current job instance, use the following command:

zos dir grid:///^

The zos Command Line Tool 21

Example 2

To list the deployed files for the job named animation, use the following command:

zos dir grid:///\!animation

novdocx (en) 13 May 2009

22 PlateSpin Orchestrate 2.0 Command Line Reference

event

This command sends an event to a running job.

Syntax

zos event jobid eventname

Arguments

jobid

The user must enter the jobid that he or she is interested in. The default for this argument is the last job run.

eventname

The user must enter the name of the event he or she wants to send to the job.

novdocx (en) 13 May 2009

Options

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To send the event

MyEvent

to the current job with a simple parameter, use the following command:

The zos Command Line Tool 23

zos event MyEvent myarg=12345

novdocx (en) 13 May 2009

24 PlateSpin Orchestrate 2.0 Command Line Reference

fail

This command directs the job to end in failure.

Syntax

zos fail [jobid] [--reason=]

Arguments

jobid

The user must enter the jobid that he or she is interested in. The default for this argument is the last job run.

Options

-m, --reason=<value>

Specifies the reason to log for this action. The user must enter a value with this option.

novdocx (en) 13 May 2009

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

The zos Command Line Tool 25

head

This command displays the first part of a datagrid file.

Syntax

zos head [--bytes=] [--lines=] [--quiet] path

Arguments

path

The path on the datagrid.

Options

-c, --bytes=<value>

Generate file output of the specified number of bytes only. The user must enter a value with this option.

novdocx (en) 13 May 2009

-n, --lines=<value>

Generate file output of the specified number of lines only. The user must enter a value with this option.

-q, --quiet

Suppress all warning and informational messages.

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

26 PlateSpin Orchestrate 2.0 Command Line Reference

Examples

Example 1

To display the first ten lines of the job log for the last job, use the following command:

zos head grid:///^/job.log

novdocx (en) 13 May 2009

The zos Command Line Tool 27

info

This command displays information about a grid object.

Syntax

zos info objectName --type= [--detail] [--xml] [--python]

Arguments

objectName

The user must enter the name of the grid object that he or she is interested in.

Options

-t, --type=<value>

The user must specify one of the following grid object types:



user

novdocx (en) 13 May 2009



resource



group



job



jobinstance



vmhost



grid



XXXgroup

-e, --detail

Displays detailed job information for each job.

-x, --xml

Displays information in formatted XML document instead of in human readable form.

-P, --python

Displays fact information as parseable python dictionary.

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

28 PlateSpin Orchestrate 2.0 Command Line Reference

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To get detailed information on user paul, use the following command:

zos info paul -t user

novdocx (en) 13 May 2009

Example 2

To get detailed information in XML format on resource

zos info vmh1 -t resource -e -x

vmh1

, use the following command:

The zos Command Line Tool 29

jobinfo

This command displays important information about a given job for PlateSpin Orchestrate.

Syntax

zos jobinfo [--detail] jobname

Arguments

jobname

The user must enter the name of the job for which he or she is seeking information.

Options

-e, --detail

Displays detailed job information for each job.

novdocx (en) 13 May 2009

-C, --cols=<value>

Specifies the terminal width for formatting. The user must enter a value with this option.

-h, --help

Displays a help message for this operation.

-d, --debug

Turns on debug output during this operation.

-v, --verbose

Turns on verbose output during this operation.

-z, --tls=<value>

Force TLS/SSL encryption [on|off]. The user must enter a value with this option.

-Z, --tlsPort=<value>

Port number for TLS/SSL connections. The user must enter a value with this option.

-y, --tlsYesNew

Force acceptance of new TLS server certificates.

-Y, --tlsYesAll

Force acceptance of all TLS server certificates.

Examples

Example 1

To display a quick list of job parameters for the command:

30 PlateSpin Orchestrate 2.0 Command Line Reference

quickie

sample job, the user would enter this

+ 70 hidden pages

Novell PLATESPIN ORCHESTRATE Command Line Reference

Specifications and Main Features

Frequently Asked Questions

User Manual

PlateSpin Orchestrate 2.0 Command Line Reference

About This Reference

The zos Command Line Tool

1.1 List of zos Commands

1.2 Getting Started with the zos Command

1.2.1 Logging In to the Orchestrate Server

1.2.2 Running a Job

1.2.3 Monitoring a Job

1.3 Details, Usage, and Syntax Examples of zos Commands