HP Operations Orchestration

Software Version: 10.20

Windows and Linux Operating Systems

Operations Orchestration Shell User Guide

Document Release Date: November 2014

Software Release Date: November 2014
Operations Orchestration Shell User Guide

Legal Notices

Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.

Restricted Rights Legend

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software,
Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Copyright Notice
© Copyright 2005-2014 Hewlett-Packard Development Company, L.P.

Trademark Notices
Adobe™ is a trademark of Adobe Systems Incorporated.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
This product includes an interface of the 'zlib' general purpose compression library, which is Copyright © 1995-2002 Jean-loup Gailly and Mark Adler.

Documentation Updates
The title page of this document contains the following identifying information:
l Software Version number, which indicates the software version.
l Document Release Date, which changes each time the document is updated.
l Software Release Date, which indicates the release date of this version of the software.

To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.com/selfsolve/manuals
This site requires that you register for an HP Passport and sign in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html
Or click the New users - please register link on the HP Passport login page.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.

Support
Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport
This web site provides contact information and details about the products, services, and support that HP Software offers.
HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your
business. As a valued support customer, you can benefit by using the support web site to:
l Search for knowledge documents of interest
l Submit and track support cases and enhancement requests
l Download software patches
l Manage support contracts
l Look up HP support contacts
l Review information about available services
l Enter into discussions with other software customers
l Research and register for software training

Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to:
http://h20229.www2.hp.com/passport-registration.html
To find more information about access levels, go to:
http://h20230.www2.hp.com/new_access_levels.jsp

HP Operations Orchestration (10.20) Page 2 of 19

Operations Orchestration Shell User Guide

HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site. This site enables you to explore HP Product Solutions to meet your business
needs, includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this Web site is
http://h20230.www2.hp.com/sc/solutions/index.jsp

HP Operations Orchestration (10.20) Page 3 of 19

Operations Orchestration Shell User Guide

Contents
Running HP OO Commands from the Command Line 5
Running Commands 6
Connecting to a Central 10.x server 7
Displaying information about a flow 8
Running a flow 8
Deploying a content pack 8
Displaying help about the OOSH utility 8
Creating a script to run HP OO commands from the OOSH utility 9
Adding OOSH as the parser of an executable file 9
Reference Material 9

HP Operations Orchestration (10.20) Page 4 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

Running HP OO Commands from the Command

Line
The Operations Orchestration Shell (OOSH) lets you run HP OO commands from the command
line, instead of from the Central 10.x web interface. This enables you to create scripts to run
commands, to automate your HP OO processes.

You can perform actions such as:

l Run flows

l Deploy content packs

l Manage files - import, upload, delete, and so on

l Display flow information

l Manage system configuration

HP Operations Orchestration (10.20) Page 5 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

See the reference section for a complete list of commands that can be used with the OOSH utility and
the options that can be used with each command.

The OOSH utility is located under <installation path>\central\bin and <installation path>\ras\bin.

Note: Users invoking commands from the OOSH utility must have the relevant Central
permissions (otherwise, they will face "Unauthorized" errors).

Running Commands
You can run commands within the OOSH utility or from a normal prompt/shell.

To run commands from a normal prompt/shell, type c:\hpoo\central\bin> oosh.bat <command>.

For example:

c:\hpoo\central\bin> oosh.bat trigger --uuid ABC --user ABC --password ABC --url
ABC

HP Operations Orchestration (10.20) Page 6 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

Note: If you used to work with RSFlowInvoke and JRSFlowInvoke with HP OO 9.x, note that
this is the alternative for HP OO 10.x.

Note: The OOSH utility is also available under ras\bin.

Connecting to a Central 10.x server

If you are running commands in the OOSH utility's shell interface, you can use the connect command
to connect to the Central 10.x server.

If the connection is successful, consequent commands will use it (until you exit OOSH or the Central
session times out).

All other commands support basic connection properties: url, user, password.This enables you to
invoke them directly from the command line without using the connect command first.

Note: It is possible to specify the user name (with the user property) without specifying the
password (with the password) property. You will be prompted for the password upon making the
connection.

Note also that in a multi-LDAP environment, you should enter the user name in the following
format: domain\username. If you enter the user name without a domain, OOSH will try to
authenticate the user with the default LDAP first and if this fails, will to authenticate within the HP
OO internal domain.

The connect command has more options. It also allows connection via an HTTP proxy.

For a complete list of all the options you can use with the connect command, see the reference section
or type help connect in the command line.

1. Double-click the oosh.bat batch file, to start the OOSH utility.

2. In the command line, type (for example):

connect --url <Central server URL>

3. Press the Enter key.

If the connection is successful, the command line displays:

Connected

HP Operations Orchestration (10.20) Page 7 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

Displaying information about a flow

1. In the command line of the OOSH utility, type:

finfo --uuid <the UUID of the flow>

Note: The UUID of the flow is displayed in the Flow Library information pane.

2. Press the Enter key.

The flow information is displayed in the command line.

Running a flow
With the trigger command, you can use the options --user, --password, --url, and so on. For a
complete list of all the options you can use with the trigger command, see the reference section or
type help trigger in the command line.

1. In the command line of the OOSH utility, type (for example):

trigger --uuid <the UUID of the flow>

2. Press the Enter key.

Deploying a content pack

This command will only work if there is an active connection to a Central 10.x server. For a complete
list of all the options you can use with the deploy command, see the reference section or type help
deploy in the command line.

1. In the command line of the OOSH utility, type (for example):

deploy --url <URL of OO Central> --files <comma-separated list of files to

deploy>

2. Press the Enter key.

Displaying help about the OOSH utility

To display a list and description of all available commands in the OOSH utility, type:

HP Operations Orchestration (10.20) Page 8 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

help

To display help about a particular command, type:

help <command>

For example:

help trigger

Creating a script to run HP OO commands from the

OOSH utility
1. To create a script, write a simple text file with the OOSH commands that you want to run. Write
each command on a separate line, in the sequence that you want the commands to run.

2. To run the script, either set OOSH as its parser (Linux only, see the details below), or use the
script command in OOSH. For example:

script --file <path to script>

Adding OOSH as the parser of an executable file

In Linux only, it is also possible to add OOSH as the parser of an executable file.

1. For example, create script-a:

#!/<install-dir>/oosh

<command-sequence>

2. Chmod the file:

chmod 755 script-a

3. Run it from the command line:

./script-a

Reference Material
Available commands for the OOSH utility
connect

HP Operations Orchestration (10.20) Page 9 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

Default
Argument Description Value/Behavior Required

Connects to an OO 10.x
Central server

--url URL of OO 10.x Central Yes

--user OO Central user name If you enter the user No

name without a
In a multi-LDAP environment,
domain, OOSH will try
enter the user name in the
to authenticate the user
format domain\username.
with the default LDAP
first, and if this fails,
will try to authenticate
within the HP OO
internal domain.

--password OO Central password No

--proxyhost http proxy host to connect No

through

--proxyport http proxy port to connect 8080 No

through

--proxyuser http proxy user to connect with No

--proxypassword http proxy password to connect No

with

deploy

Deploys a content pack

(requires an active connection)

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

HP Operations Orchestration (10.20) Page 10 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

--files Comma-separated list of Yes

content packs to deploy

disconnect

Disconnects from the OO 10.x

Central server

trigger

Runs a flow

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the format
domain\username.

--password OO Central password No

--uuid UUID of the flow to run. For Yes

example, cd38b579-4220-4fa5-
bafd-78d67f73eb6f

HP Operations Orchestration (10.20) Page 11 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

--inputs Comma-separated key=value No

map of the flow inputs. For
example,
key1=value1,key2=value2

Note: If the input value

contains white spaces, and
you are using a Windows
command, you need to use
\" to escape the quotes. For
example:
--inputs \"title=my
title,message=my
message\"

If you open the OOSH

command line (by running
oosh.bat without
arguments), you can use
regular quotes. For example:

--inputs "title=my
title,message=my
message"

track

Shows information about a

specific execution (tracking)

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--id Execution id Yes

HP Operations Orchestration (10.20) Page 12 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

--property Displays a specific property all No

(default: all). Available
properties: executionId,
executionName, status,
resultStatusType,
resultStatusName

finfo,flow-info

Displays information about a

specific flow run

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--property Displays a specific property all No

(default: all). Available
properties: id, name, path,
description, cpName,
version

lcp, list-content-packs

Lists all currently deployed

content packs in the connected
server

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

HP Operations Orchestration (10.20) Page 13 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

lsc, list-sys-config

Lists the system configuration

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--key Lets you request the value of a No

specific key only

ssc, set-sys-config

Sets the system configuration

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--key System configuration key Yes

--value System configuration value empty string No

HP Operations Orchestration (10.20) Page 14 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

show connection

Shows the connection

properties

historical-data-start-date

Sets the start date for the

import of historical data

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--date The date from which to start the Yes

import, in format dd/MM/yyyy

historical-data-status

Gets the status of historical

data import

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

import-historical-data

HP Operations Orchestration (10.20) Page 15 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

Imports the historical data of

deployed content with the data
defined in the 9.x server

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

import-permissions

Imports the permissions of

deployed content with the
permissions file

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

import-schedules

Imports the schedules of

deployed content with the
schedules defined in the 9.x
server

HP Operations Orchestration (10.20) Page 16 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

permissions-status

Gets a list of all the

permissions that were imported
so far

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--output Full path where the output No

should be written

upload-permissions-file

Uploads the permissions file

created during content upgrade

--url URL of OO 10.x Central Yes, unless

already
connected to
Central with
the connect
command

HP Operations Orchestration (10.20) Page 17 of 19

Operations Orchestration Shell User Guide
Running HP OO Commands from the Command Line

--user OO Central user name No

In a multi-LDP environment,
enter the user name in the
format domain\username.

--password OO Central password No

--file The full path to the permissions No

file, which is in the Output
folder of the Content Upgrade
Utility

upgrade-execution-events

Note: : After an upgrade from HP OO 9.x to 10.x (earlier than 10.02), using the HP OO Shell Utility
to migrate historical data will get the result "Resolved" instead of "RESOLVED", as required in HP
OO 10.x. This causes duplicates in the results distribution on the Dashboard. If this occurs,
upgrade to HP OO 10.20.

HP Operations Orchestration (10.20) Page 18 of 19