1. Manuals
  2. Brands
  3. Novell Manuals
  4. Software
  5. PLATESPIN ORCHESTRATE 2.0.2 - ADMINISTRATOR REFERENCE...
  6. Reference

Novell PLATESPIN ORCHESTRATE 2.0.2 - COMMAND LINE REFERENCE 06-17-2009 Reference

Command line reference
Hide thumbs Also See for PLATESPIN ORCHESTRATE 2.0.2 - COMMAND LINE REFERENCE 06-17-2009:
Table of Contents

Advertisement

Quick Links

Download this manual
AUTHORIZED DOCUMENTATION
Command Line Reference
Novell
®
PlateSpin
Orchestrate
®
2.0.2
June 17, 2009
www.novell.com
PlateSpin Orchestrate 2.0 Command Line Reference

Advertisement

Table of Contents
loading

Related Manuals for Novell PLATESPIN ORCHESTRATE 2.0.2 - COMMAND LINE REFERENCE 06-17-2009

Summary of Contents for Novell PLATESPIN ORCHESTRATE 2.0.2 - COMMAND LINE REFERENCE 06-17-2009

  • Page 1 AUTHORIZED DOCUMENTATION Command Line Reference Novell ® PlateSpin Orchestrate ® 2.0.2 June 17, 2009 www.novell.com PlateSpin Orchestrate 2.0 Command Line Reference...
  • Page 2 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.
  • Page 3 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.
  • Page 4 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 5: Table Of Contents

    Contents About This Reference 1 The zos Command Line Tool List of zos Commands ............9 Getting Started with the zos Command .
  • Page 6 dump ..............75 get .

  • Page 7: About This Reference

    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 ( , etc.) denotes a Novell trademark. An asterisk (*) denotes a third-party trademark.
  • Page 8 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 9: The Zos Command Line Tool

    PlateSpin Orchestrate ® from Novell . The command line tool can be used to log in to the Orchestrate Server, to submit jobs, monitor jobs, and perform other user functions.

  • Page 10: Getting Started With The Zos Command

    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 a job search Perform grid object search status Display the status of a running or previously run job tail...

  • Page 11: Running A Job

    1.2.2 Running a Job Use the 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.
  • Page 12 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...

  • Page 13: Details, Usage, And Syntax Examples Of Zos Commands

    1.3 Details, Usage, and Syntax Examples of zos Commands This section includes a detailed list of the 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”...

  • Page 14: Cancel

    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.
  • Page 15 zos cancel Example 2 To cancel the named job instance <jobid> for the login user, use the following command: zos cancel <jobid> The zos Command Line Tool...

  • Page 16: 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. -h, --help Displays a help message for this operation.
  • Page 17 Example 2 To display the file for the active or last run job, use the following command: job.log zos cat grid:///^/job.log The zos Command Line Tool...

  • Page 18: Copy

    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 -r, --recursive Processes directories recursively.
  • Page 19 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:...

  • Page 20: Delete

    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. -h, --help Displays a help message for this operation.

  • Page 21: 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. -h, --help Displays a help message for this operation.
  • Page 22 Example 2 To list the deployed files for the job named animation, use the following command: zos dir grid:///\!animation PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 23: Event

    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.
  • Page 24 zos event MyEvent myarg=12345 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 25: Fail

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

  • Page 26: Head

    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.
  • Page 27 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 The zos Command Line Tool...

  • Page 28: Info

    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 resource group...
  • Page 29 -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.

  • Page 30: Jobinfo

    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.
  • Page 31 zos jobinfo quickie The zos Command Line Tool...

  • Page 32: Joblist

    joblist This command lists all of the available jobs and arguments. Syntax zos joblist [--detail] [--description] Options -e, --detail Displays detailed job information for each job. -D, --description Displays a description for each job. -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.

  • Page 33: Jobs

    jobs This command lists the running queued or historical jobs. Syntax zos jobs [--all] [--detail] [--errors] [--submit=] [--hours=] [--active] [-- count=] [--parent=] Options -a, --all Lists all users’ jobs, not just the logged in user’s jobs. -e, --detail Displays detailed job information for each job. -E, --errors Displays details of job and node errors.
  • Page 34 -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.

  • Page 35: Listen

    listen This command starts a process to listen to events generated by a running job. Syntax zos listen [jobid] [--detail=] 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.

  • Page 36: Log

    This command displays the log for the specified job. Syntax zos log [jobid] 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 -C, --cols=<value> Specifies the terminal width for formatting.
  • Page 37 Example 2 To display the log for job ID itsajob, use the following command zos log itsajob The zos Command Line Tool...

  • Page 38: Login

    login This command logs the user into the PlateSpin Orchestrate grid. Syntax zos login [servername] [--check] [--user=] [--passwd=] [--port=] [--env=] Arguments servername The user must enter the hostname of the Orchestrate Server he or she is logging into. The default is localhost Options -c, --check...
  • Page 39 -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 log in to the server Eng as tester20 you would use the following command: zos login Eng --user=tester20 Example 2 To check the current login, you would use the following command:...

  • Page 40: Logout

    logout This command logs the user out of the current PlateSpin Orchestrate grid. Syntax zos logout 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 the logout operation.

  • Page 41: Mkdir

    mkdir This command makes a new directory in the datagrid. Syntax zos mkdir path [--parents] Arguments path The path on the datagrid. Options -p, --parents Creates parent directories if needed. -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.
  • Page 42 zos mkdir grid:///images Example 2 To create a new directory in the job deployment area for the job myjob, use the following command: zos mkdir grid:///!myjob/newdir PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 43: Move

    move This command moves files and directories in the datagrid. Syntax zos move source dest Arguments source The datagrid source from which the files or directories are to be moved. dest The datagrid destination where the files or directories are to be moved. Options -C, --cols=<value>...

  • Page 44: Password

    password This command lets the user change his or her password on the current Orchestrate Server. Syntax zos password [--passwd=] [--newpasswd=] Options -p, --passwd=<value> Current password for authentication. The user must enter a value with this option. -n, --newpasswd=<value> New password for authentication. The user must enter a value with this option. -C, --cols=<value>...

  • Page 45: Pause

    pause This command directs the running job to pause. Syntax zos pause [jobid] 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 -C, --cols=<value> Specifies the terminal width for formatting.
  • Page 46 Example 2 To pause the named running job instance, use the following command: zos pause griduser.myjob.1234 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 47: Priority

    priority This command changes the priority of a running job. Syntax zos priority [jobid] [--priority=] 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 -r, --priority=<value>...
  • Page 48 zos priority --priority=lowest Example 2 To reset priority back to the user default (paul), the user would enter the following command: zos priority paul.quickie.23 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 49: Resume

    resume This command directs the running job to resume. Syntax zos resume [jobid] 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 -C, --cols=<value> Specifies the terminal width for formatting.

  • Page 50: Run

    This command runs a job. Syntax zos run jobname [--priority=] [--as=] [--watch] [--env=] [--start=] [--listen] [--detail] [--policy=] [--policyfile] [--trace] Arguments jobname The user must enter the name of the job he or she wants to run. Options -r, priority=<value> Specifies the priority level for a job. The user must enter a value with this option. -a, --as=<value>...
  • Page 51 -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>...
  • Page 52 NOTE: The date and time values should be specified as shown in the example—in the format and enclosed in quotes— DD/YY hour:minute AM/PM "11/21/08 5:01 PM" PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 53: Search

    search This command performs a grid object search. Syntax zos search [--type=] [--detail] [--facts] [--constraint=] [--order=] Options -t, --type=<value> Specify the grid object type (user, resource, job, jobinstance, vmhost, grid. XXXgroup). The user must enter a value with this option. -e, --detail Displays detailed information for each grid object rather than just a name.
  • Page 54 Examples Example 1 To generate a detailed listing of all users in group eng, the user would enter the following command: zos search -t user -c '<contains fact="user.groups" value="eng"/>' -o "user.location/d" PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 55: Status

    status This command displays the status of a running or previously run job. Syntax zos status [jobid] [--detail] [--errors] [--recurse] [--joblets] Arguments jobid The user must enter the job ID that he or she is interested in. The default for this argument is the last job run.
  • Page 56 -Y, --tlsYesAll Force acceptance of all TLS server certificates. Examples Example 1 To display a detailed status for the last job run by the login user, the user would enter the following command: zos status -e PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 57: Tail

    tail This command displays the end of a datagrid file. Syntax zos tail [--retry] [--bytes=] [--follow] [--by-name] [--follow-retry] [-- lines=] [--max-unchanged=] [--jobid=] [--sleep-interval=] [--refresh=] [-- count=] [--timeout=] [--quiet] path Arguments path The path on the datagrid. Options -r, --retry Continues trying to open the file if it is not yet accessible. -c, --bytes=<value>...
  • Page 58 -R, refresh=<value> Server connection refresh rate. The user must enter a value with this option. -X, --count=<value> Maximum number of lines/bytes to display. -t, --timeout=<value> The maximum number of seconds to follow a file. -q, --quiet Suppress all warning and informational messages. -C, --cols=<value>...
  • Page 59 Example 3 To follow a file in (approximately) real time, use the following command: zos tail -f grid:///^myjob/job.log Example 4 To continually watch the job log of the latest job, use the following command: zos tail --follow --by-name --retry grid:///!/lastjob/job.log Example 5 To watch the job log of job myname.myjob.123 while it runs, use the following command: zos tail -F -J myname.myjob.123 grid:///^myname.myjob.123/job.log...
  • Page 60 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 61: The Zosadmin Command Line Tool

    The zosadmin Command Line Tool ® The zosadmin command line tool is used by administrators of PlateSpin Orchestrate from Novell to log in to the server, add or remove server components such as jobs and policies, to report on the status of nodes, users, and the audit database, and to perform other administrative functions.

  • Page 62: Getting Started With The Zosadmin Command

    Command Description rotatelogs Back up and rotate the log files sessions Display session information Set an attribute start Start a local server status Collect the status of a server stop Shut down the server undeploy Undeploy a component from the server upgrade Upgrade old server snapshot to current version users...

  • Page 63: Logging Out

    >zosadmin login -c Currently logged into testgrid on server 'tszen5' 2.2.3 Logging Out Enter the following command to log out of the Orchestrate Server: >zosadmin logout Logged out from testgrid The zosadmin Command Line Tool...

  • Page 64: Details, Usage, And Syntax Examples Of Zosadmin Commands

    2.3 Details, Usage, and Syntax Examples of zosadmin Commands This section includes a detailed list of the commands you can use. It also includes zosadmin 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: “auditclean”...

  • Page 65: Auditclean

    auditclean This command cleans the audit database by removing old data. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin auditclean --dayskept= [--grid=] [--table=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 66: Auditcount

    auditcount This command retrieves the count of the number of jobs in the audit database. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin auditcount [--root] [--grid=] [--table=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 67: Auditreport

    auditreport This command displays an audit report generated from the audit database. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin auditreport [--username=] [--from=] [--to=] [--limit=] [--grid=] [-- childjobs] [--table=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).
  • Page 68 Examples Example 1 To display a report of job records for the logged in grid, use the following command: zosadmin auditreport Example 2 To display a report of action status records for the logged in grid, use the following command: zosadmin auditreport --table=actions PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 69: Cancelalljobs

    cancelalljobs This command cancels all running jobs. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin cancelalljobs Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 70: Create

    create This command creates a new server instance. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin create [--newdir=] [--upgrade=] [--profile=] [--id=] [--grid=] [-- user=] [--passwd=] [--rmiport=] [--rmihost=] [--httpport=] [--adminport=] [-- agentport=] [--auditurl=] [--audituser=] [--auditpasswd=] [--cert=] [--key=] [<hostname>] Arguments hostname...
  • Page 71 -H, --rmihost <value> Select or specify the RMI host (can be different from server host). -W, --httpport <value> Specify the http port used for the User Portal (the default is 80). -M, --adminport <value> Specify the http port used for Administrative Information Portal (default 8001). -A, --agentport <value>...
  • Page 72 Example 3 To create a new server instance in the directory, use the following command: /zos/myserver/ zosadmin create --newdir=/zos/myserver Example 4 To create a new upgraded server instance in an existing directory ( ), use the /zos/myserver/ following command: zosadmin create --newdir=/zos/myserver --upgrade IMPORTANT: This command removes the previous server instance data from the directory.

  • Page 73: Deploy

    deploy This command deploys a new component onto a server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin deploy [--port=] file|dir Arguments file|dir Specify the deployable file or a directory containing deployable files. Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 74: Disconnect

    disconnect This command allows forceful disconnect or revocation of user or node sessions. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin disconnect [--id=] [--node=] [--user=] [--all] [--allUsers] [-- allNodes] [--revoke] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 75: Dump

    dump This command dumps the contents of namespace. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin dump [--dir=] --jndi= Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 76: Get

    This command retrieves an attribute. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin get --mbean= --attr= Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 77: Init

    init This command restores a server configuration to its initial state. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin init [--dir=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 78: Invoke

    invoke This command invokes an mbean method. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin invoke --mbean= --method= Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 79: List

    list This command lists all of the running servers. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin list [--grid=] [--id=] [--server=] [--rmiport] [--rmipath] [-- rmihost=] [--rmiurl=] [--timeout=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 80: Login

    login This command logs into the Orchestrate Server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin login [--grid=] [--id=] [--rmiport=] [--rmipath=] [--rmihost=] [-- rmiurl=] [--timeout=] [--user=] [--passwd=] [--check=] [<server host>] Arguments <server host> Enter the server host name that you are logging into.
  • Page 81 -c, --check Check and report existing login. Ignores other options. -V, --debug Turns on debug output during the login operation. -v, --verbose Turns on verbose output during the login operation. -h, --help Display a help message for this operation. Examples Example 1 To login to server Eng, use the following command: zosadmin login Eng...

  • Page 82: Logout

    logout This command logs out of the PlateSpin Orchestrate Server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin logout Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 83: Nodes

    nodes This command retrieves a list of all, online, offline, or mismatched nodes. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin nodes [--offline] [--mismatch] [--all] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 84: Password

    password This command lets the administrator or developer change his or her password on the PlateSpin Orchestrate Server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin password [--passwd=] [--newpasswd=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 85: Redeploy

    redeploy This command redeploys a component onto a server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin redeploy [--session=] file|dir Arguments file|dir Specify the deployable file or a directory containing deployable files. Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 86: Rotatelogs

    rotatelogs This command backs up and rotates the log files. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin rotatelogs Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 87: Sessions

    sessions This command displays session information. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin sessions [id=] [--node=] [--user=] [--all] [--allNodes] [--allUsers] [--subSessions] [--inactive] [--full] [--connaddr] [--noDns] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).
  • Page 88 -V, --debug Turn on debug output during this operation. -v, --verbose Turn on verbose output during this operation. -h, --help Display a help message for this operation. PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 89: Set

    This command sets an attribute on an MBean. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin set --mbean= --attr= --value= --type= Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 90: Start

    start This command starts a local server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin start [--dir=] [--jvmargs=] [--javaargs=] [--timeout=] [--upgrade] [- -snapshot=] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).
  • Page 91 Example 2 To start a server instance using directory , use the following command: /zos/server/ zosadmin start --dir=/zos/server Example 3 To start a server instance and upgrade from an existing server snapshot, use the following command: zosadmin start --upgrade --snapshot=/oldzos/server/snapshot NOTE: Before you use this option, you must be using the “zosadmin upgrade”...

  • Page 92: Status

    status This command displays the status of a server (including information on managed components) Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin status [--mbeans] [--sessions] [--facilities] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 93: Stop

    stop This command shuts down the PlateSpin Orchestrate Server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin stop [--force] [--snap] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 94: Undeploy

    undeploy This command undeploys a component from the server. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin undeploy [--session=] component|dir Arguments component|dir Specify the deployed file or a directory containing the deployed files. Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 95: Upgrade

    upgrade This command upgrades an older server snapshot to a current version. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin upgrade snapshotdir Arguments snapshotdir Specify the directory containing a server configuration snapshot. Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 96: Users

    users This command retrieves a list of all active or inactive users. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin users [--offline] [--all] Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).

  • Page 97: Verify

    verify This command verifies a component for syntax. Syntax Enter the command using the syntax shown below. Available options are shown in brackets. zosadmin verify file Arguments file Specify the deployable file to verify. Options When you add an option, use the syntax in the command line as shown above (where options are shown in their long form).
  • Page 98 PlateSpin Orchestrate 2.0 Command Line Reference...

  • Page 99: A Documentation Updates

    Documentation Updates This section contains information about documentation content changes that were made in this PlateSpin Orchestrate Command Line Reference after the initial release of PlateSpin Orchestrate 2.0. The changes are listed according to the date they were published. The documentation for this product is provided on the Web in two formats: HTML and PDF. The HTML and PDF documentation are both kept up-to-date with the changes listed in this section.
  • Page 100 100 PlateSpin Orchestrate 2.0 Command Line Reference...

This manual is also suitable for:

Platespin orchestrate 2.0.2

Table of Contents