emc ionix it orchestrator scalent v/oe 3.2 adapter...overview page 1 emc ionix it orchestrator...

9
Developer Guide EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter P/N 300-011-503 REV A01 EMC Corporation Corporation Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.EMC.com

Upload: others

Post on 28-Aug-2020

11 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Developer Guide

EMC Ionix IT Orchestrator Scalent V/OE 3.2 AdapterP/N 300-011-503

REV A01

EMC Corporation

Corporation Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000

www.EMC.com

Page 2: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Copyright © 2010 EMC Corporation. All rights reserved.

Published September 2010

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change withoutnotice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESEN-TATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, ANDSPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PUR-POSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date regulatory document for your product line, go to the Technical Documentation and Advisories section onEMC Powerlink.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks usedherein are the property of their respective owners.

Page 3: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Scalent V/OE 3.2 Adapter

Page iii EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter

Table of Contents1. Overview .................................................................................................................................. 1

Installation ............................................................................................................................ 1Using the Adapter .................................................................................................................. 1Using the Adapter as a Managed Element .................................................................................. 2

2. Reference ................................................................................................................................. 3

Page 4: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Intentionally blank.

Page 5: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Overview

Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter

Chapter 1. OverviewThe Scalent Adapter for IT Orchestrator provides an interface to the Scalent Virtual Operating Environment (V/OE). The adapter is a plugin to IT Orchestrator that makes access to Scalent Web Services available through acorresponding set of IT Orchestrator Tasks. In addition, the adapter can be extended to create a fully-fledgedManaged Element capable of generating sensor events.

The adapter is compatible with version 3.2 of the Scalent V/OE.

The following sections describe how to install and use the Scalent adapter:

• “Installation”

• “Using the Adapter”

• “Using the Adapter as a Managed Element”

InstallationThe Scalent Adapter plugin is provided in a .zip file. To install the plugin and make it available in IT Orches-trator Studio, the archive must be unzipped into the <ITO-INSTALL-LOCATION>\ITOrchestrator-studio direc-tory. Unzipping will add a com.enigmatec.ext.scalent_3.2_1.0.0.jar archive to the <ITO-INSTALL-LOCA-TION>\ITOrchestrator-studio\plugins directory. The Scalent Tasks will be available when the IT Orchestra-tor Studio is started.

In addition, all containers that will execute Services that make use of the Scalent adapter must havethe com.enigmatec.ext.scalent_3.2_1.0.0.jar file available and the JAR must be added to theCONTAINER_CLASSPATH variable for the machine hosting the container.

For a container running on a machine that has an IT Orchestrator Studio install, this will mean that theCONTAINER_CLASSPATH is set to:

CONTAINER_CLASSPATH=<ITO-INSTALL-LOCATION>\ITOrchestrator-studio\plugins\ com.enigmatec.ext.scalent_3.2_1.0.0.jar

For a IT Orchestrator Platform installation, the com.enigmatec.ext.scalent_3.2_1.0.0.jar must be copied tothe machine hosting the Platform installation and the CONTAINER_CLASSPATH must be set to point to thislocation, as follows:

CONTAINER_CLASSPATH=<JAR-LOCATION>\com.enigmatec.ext.scalent_3.2_1.0.0.jar

Using the AdapterWhen IT Orchestrator Studio is started, the Scalent plugin project is shown in the Service Designer palette and,within this project, a set of Scalent Tasks are made available to the Service Designer. The Tasks can be used inthe same way as any IT Orchestrator Task (refer to the Service Designer Manual for more details).

When using the Scalent Tasks, you will need to specify the Web Service endpoint and, in most cases, specify aSession Id:

• “Specifying the Web Service Endpoint and Security String”

• “Obtaining a Session Id”

Specifying the Web Service Endpoint and Security StringWhen a Scalent Task is inserted in a scenario, the end point for the Web Service (wsEndpoint) must be specifiedat the Properties view. The wsEndpoint string is in the format: http://<Scalent-Server-Name>:80\axis\<Ser-vice-Name>. The endpoints for each Scalent task are provided in the following table:

Task wsEndpoint

Session http://<server-name>:80/axis/Session

Page 6: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Overview

REV A01 300-011-503 Page 2

Task wsEndpoint

State http://<server-name>:80/axis/State

Update http://<server-name>:80/axis/Update

View http://<server-name>:80/axis/View

HostOp http://<server-name>:80/axis/HostOp

Layout http://<server-name>:80/axis/Layout

OperatorWsSession http://<server-name>:80/axis/OperatorWsSession

OperatorWsV1 http://<server-name>:80/axis/OperatorWsV1

NoteIn a development environment, where the Scalent Server is accessed as localhost, the endpoint port is 8080rather than 80.

The wsSecurity value can be set as an empty string.

Obtaining a Session Id

In order to call the Scalent methods a security token, called a Session Id, is required. The Session Id is obtainedby calling the loginRequest method on the Session Task. The Auth object that is returned holds the Session Id re-quired when calling other methods.

Because the Auth object required by each of the Scalent Tasks is in a different namespace, it is necessary to ob-tain the Session Id returned by the Session Task and use it to create the Auth object required by the Task youwant to call.

NoteThe View and Update tasks require an Auth object of type: com.scalent.ws.config.Auth.

Using the Adapter as a Managed ElementTo create a Managed Element, one or more Scalent Tasks can be wrapped within a Service and IT OrchestratorTimers can be used to call the Tasks at defined intervals (and hence provide a mechanism for polling the WebService). Each time a Scalent method is polled, the Service can publish a sensor event using the value returnedfrom the Web Service.

The Service Designer Manual provides more information on the use of Timers.

Page 7: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Reference

Page 3 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter

Chapter 2. ReferenceThe Scalent SDK is normally provided in the form of a command-line interface (CLI). The Scalent Web Serviceallows access to the methods provided by the CLI and, as such, the reference information for the Scalent WebService is the documentation provided for the SDK.

Page 8: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

Intentionally blank.

Page 9: EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter...Overview Page 1 EMC Ionix IT Orchestrator Scalent V/OE 3.2 Adapter Chapter 1. Overview The Scalent Adapter for IT Orchestrator

EMC Coprporation

Coprporate HeadquartersHopkinton, MA 01748-9103U.S.ATel:1-508-435-1000http://www.EMC.com