HP Operations Orchestration

For the Windows and Linux Operating Systems

Software Version: 10.10
Operations Orchestration Shell User Guide
Document Release Date: May 2014
Software Release Date: May 2014
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.
This product includes an interface of the ' zlib' general purpose compression library, which is Copyright 1995-2002 Jean-loup Gailly and Mark Adler.
AMD and the AMD Arrow symbol are trademarks of Advanced Micro Devices, Inc.
Google and Google Maps are trademarks of Google Inc.
Intel, Itanium, Pentium, and Intel Xeon are trademarks of Intel Corporation in the U.S. and other countries.
Java is a registered trademark of Oracle and/or its affiliates.
Microsoft, Windows, Windows NT, Windows XP, and Windows Vista are U.S. registered trademarks of Microsoft Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
UNIX is a registered trademark of The Open Group.
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 Newusers - 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 Software Solutions Nowaccesses 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.10) Page 2 of 19
Contents
Contents 3
Running HP OOCommands from the Command Line 4
Running Commands 5
Display information about a flow 6
Run a flow 6
Deploy a content pack 6
Display help about the OOSH utility 7
Create a script to run HP OOcommands fromthe OOSH utility 7
Add OOSH as the parser of an executable file 7
Reference Material 8
Operations Orchestration Shell User Guide
Contents
Page 3 of 19
HP Operations Orchestration (10.10)
Running HP OO Commands from the
Command Line
The Operations Orchestration Shell (OOSH) lets you run HP OOcommands fromthe command
line, instead of fromthe Central 10.x web interface. This enables you to create scripts to run
commands, to automate your HP OOprocesses.
You can performactions such as:
l Run flows
l Deploy content packs
l Manage files - import, upload, delete, and so on
l Display flow information
l Manage systemconfiguration
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 4 of 19
HP Operations Orchestration (10.10)
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 who invoke upgrade-related commands fromthe OOSH utility must have the
corresponding permissions.
Note: The OOSHutility works with java 1.7.
Running Commands
You can run commands within the OOSH utility or froma normal prompt/shell.
To run commands froma 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
Note: If you used to work with RSFlowInvoke and JRSFlowInvoke with HP OO9.x, note that
this is the alternative for HP OO10.x.
Note: The OOSH utility is also available under ras\bin.
Connect to a Central 10.x server
If you are running OOSH in shell mode, you can use the connect command to connect to the
Central 10.x server.
All other commands support basic connection properties: url, user, password.This enables you to
invoke themdirectly fromthe 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-LDP 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 OOinternal domain.
The connect command has more options. It also enables connection via an HTTP proxy.
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 5 of 19
HP Operations Orchestration (10.10)
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 OOSHutility.
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
Display information about a flow
1. In the command line of the OOSHutility, type:
finfo --uuid <the UUID of the flow>
Note: The UUID of the flow is displayed in the Flow Library information panel.
2. Press the Enter key.
The flow information is displayed in the command line.
Run 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 OOSHutility, type (for example):
trigger --uuid <the UUID of the flow>
2. Press the Enter key.
Deploy 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.
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 6 of 19
HP Operations Orchestration (10.10)
1. In the command line of the OOSHutility, type (for example):
deploy --url <URL of OO Central> --files <comma-separated list of files to d
eploy>
2. Press the Enter key.
Display help about the OOSH utility
To display a list and description of all available commands in the OOSH utility, type:
help
To display help about a particular command, type:
help <command>
For example:
help trigger
Create 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 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.
Add 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 fromthe command line:
./script-a
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 7 of 19
HP Operations Orchestration (10.10)
Reference Material
Available commands for OOSH utility
Command Argument Description
Default
Value/Behavior Required
connect Connects to an OO10.x
Central server
--url URL of OO10.x Central Yes
--user OOCentral user name
In a multi-LDAP
environment, enter the
user name in the 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 try to
authenticate
within the HP OO
internal domain.
No
--password OOCentral password No
--proxyhost http proxy host to connect
through
No
--proxyport http proxy port to connect
through
8080 No
--proxyuser http proxy user to connect
with
No
--proxypassword http proxy password to
connect with
No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 8 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
deploy Deploys a content pack
(requires an active
connection)
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--files Comma-separated list of
content packs to deploy
Yes
disconnect Disconnects fromthe OO
10.x Central server
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 9 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
trigger Runs a flow
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--uuid UUID of the flow to run.
For example, cd38b579-
4220-4fa5-bafd-
78d67f73eb6f
Yes
--inputs Comma-separated
key=value map of the flow
inputs. For example,
key1=value1,key2=valu
e2
No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 10 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
track Shows information about
a specific execution
(tracking)
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--id Execution id Yes
--property Displays a specific
property (default: all).
Available properties:
executionId,
executionName,
status,
resultStatusType,
resultStatusName
all No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 11 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
finfo
flow-info
Displays information
about a specific flow run
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--property Displays a specific
property (default: all).
Available properties: id,
name, path,
description, cpName,
version
all No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 12 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
lcp
list-content-
packs
Lists all currently
deployed content packs in
the connected server
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
lsc
list-sys-
config
Lists the system
configuration
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--key Lets you request the value
of a specific key only
No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 13 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
ssc
set-sys-
config
Sets the system
configuration
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--key Systemconfiguration key Yes
--value Systemconfiguration
value
empty string No
show
connection
Shows the connection
properties
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 14 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
historical-
data-start-
date
Sets the start date for the
import of historical data
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--date The date fromwhich to
start the import, in format
dd/MM/yyyy
Yes
historical-
data-status
Gets the status of
historical data import
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 15 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
import-
historical-
data
Imports the historical data
of deployed content with
the data defined in the 9.x
server
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
import-
permissions
Imports the permissions
of deployed content with
the permissions file
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 16 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
import-
schedules
Imports the schedules of
deployed content with the
schedules defined in the
9.x server
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
permissions-
status
Gets a list of all the
permissions that were
imported so far
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--output Full path where the output
should be written
No
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 17 of 19
HP Operations Orchestration (10.10)
Command Argument Description
Default
Value/Behavior Required
upload-
permissions-
file
Uploads the permissions
file created during content
upgrade
--url URL of OO10.x Central Yes,
unless
already
connected
to Central
with the
connect
command
--user OOCentral user name
In a multi-LDP
environment, enter the
user name in the format
domain\username.
No
--password OOCentral password No
--file The full path to the
permissions file, which is
in the Output folder of the
Content Upgrade Utility
No
Note: : After an upgrade fromHP OO9.x to 10.x (earlier than 10.02), using the HP OOShell
Utility to migrate historical data will get the result "Resolved" instead of "RESOLVED", as
required in HP OO10.x. This causes duplicates in the results distribution on the Dashboard. If
this occurs, upgrade to HP OO10.02 or 10.10.
Operations Orchestration Shell User Guide
Running HP OOCommands fromthe Command Line
Page 18 of 19
HP Operations Orchestration (10.10)