IBM Cloud Orchestrator. Content Pack for IBM Endpoint Manager for Software Distribution IBM

IBM Cloud Orchestrator Content Pack for IBM Endpoint Manager for Software Distribution IBM

IBM Cloud Orchestrator Content Pack for IBM Endpoint Manager for Software Distribution IBM

Note Before using this information and the product it supports, read the information in Notices on page 9.

Contents Preface............... v Audience............... v IBM Cloud Orchestrator Content Pack For IBM Endpoint Manager for Software Distribution............. 1 Install and Configure the Content Pack..... 1 Toolkit scenarios............. 2 Submitting an IBM Endpoint Manager software task to a list of computers......... 2 Deploy a Cloud Service with Additional Software 3 Toolkit Developer's Reference......... 4 Business objects............ 5 FixletInPatternActivationRequest..... 5 IemSoftwarePackage.......... 5 PatternWithFixlets.......... 5 SwSelectionCoachData......... 5 DeployableNodeWithFixlets....... 5 DeploymentTemplateWithFixlet...... 5 IemFixletActivationProgress....... 5 PatternSelectionHolder......... 5 ServiceDeploySummary........ 5 Human services............ 6 Deploy a Cloud Service with Additional Software.............. 6 Manage Software Packages....... 6 Collect Fixlet Deploy Params for Nodes... 6 Select Fixlet and Set Deployment Options in Pattern.............. 6 Select Pattern............ 6 Select Software Task.......... 6 Business processes........... 6 Deploy a Cloud Service with Additional Software.............. 6 Activate Fixlet Actions......... 6 Deploy Heat Template......... 6 Run Software Task.......... 6 General system services.......... 6 GetTranslatedMessages......... 7 Integration services........... 7 ListApplicableTasksForSoftwarePackages... 7 ListSoftwarePackages......... 7 ListTasksForSoftwarePackages...... 7 Link VMs to Nodes (Heat)........ 7 InstallIEMAgents........... 7 IsIWDAvailable........... 7 Compute IEM Agents......... 7 Samples about how to use integration services... 7 Configuring an SMTP server in IBM Cloud Orchestrator.............. 8 Notices............... 9 Trademarks and Service Marks.... 13 Copyright IBM Corp. 2013, 2015 iii

iv IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

Preface This publication documents how to use the IBM Cloud Orchestrator Content Pack for IBM Endpoint Manager for Software Distribution. Audience This information is intended for content developers of IBM Cloud Orchestrator who implement or customize IBM Endpoint Manager for Software Distribution. Copyright IBM Corp. 2013, 2015 v

vi IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

IBM Cloud Orchestrator Content Pack For IBM Endpoint Manager for Software Distribution With IBM Cloud Orchestrator Content Pack for IBM Endpoint Manager for Software Distribution you can use an existing IBM Endpoint Manager environment from IBM Cloud Orchestrator and vice versa to enable Software Distribution operations. Supported versions v IBM Cloud Orchestrator version 2.5 v IBM Endpoint Manager versions 9.0 and 9.1 Install and Configure the Content Pack Before you use the content pack, you must download the content pack from the marketplace. Before you begin Knowledge of IBM Endpoint Manager infrastructure and its administration is required to use this content pack. In addition, ensure that the "Web Reports" engine is running in the IBM Endpoint Manager environment. The Software Distribution content site must be correctly configured in the IBM Endpoint Manager environment and at least one Software Package must be created with its installation task through the Manage Software Distribution dashboard. A prerequisite to run the Manage Software Packages offerings and actions is a good knowledge of IBM Cloud Orchestrator and Business Process Manager programming model. It is required to use the toolkit as a software development kit (SDK) for building new content. Procedure 1. Install the SCOrchestrator_IEM_SW_Integration Toolkit in Business Process Manager. 2. To import the following offerings XML definition files, use the Self-Service Catalog Population Tool, /opt/ibm/ico/ccs/catalog/catalogtool.sh, that is at node 1 of IBM Cloud Orchestrator setup 2.5: v SCOrchestrator_IEM_Integration_Toolkit_300-Catalog.xml v SCOrchestrator_IEM_SW_Integration_Toolkit_300-Catalog.xml 3. Run the Initialize the data Persistence Service offering that is in the Management Infrastructure category. You must initialize the Persistence engine that is used by this toolkit. 4. Register at least one IBM Endpoint Manager Server configuration in IBM Cloud Orchestrator. See the Register an IBM Endpoint Manager server section of the documentation for IBM Cloud Orchestrator Content Pack for IBM EndpointManager. Copyright IBM Corp. 2013, 2015 1

Toolkit scenarios There are a number of scenarios that are immediately available from the toolkit. The following scenarios are available: v Submitting an IBM Endpoint Manager software task to a list of computers v Deploy a Cloud Service with Additional Software on page 3 Submitting an IBM Endpoint Manager software task to a list of computers You can submit an IBM Endpoint Manager software task to a list of computers. You can submit the execution of a software task, belonging to a specified software package and available in a IBM Endpoint Manager environment, to a set of IBM Endpoint Manager computers that typically, but not necessarily, correspond to a virtual machines deployed through IBM Cloud Orchestrator. Note: You must already have configured at least one IBM Endpoint Manager sever into IBM Cloud Orchestrator. At least one shared Software Package with the related activation tasks must be available from the IBM Endpoint Manager server. To run this scenario, perform the following steps: 1. Go to Assigned Resources and enter the Stacks or VMs page. 2. Once there, select one or more resources (only for virtual machines) and start the Deploy fixlet action from the left menu. The action is available only for active instances. 3. When the offering starts: a. Select an IBM Endpoint Manager server Optional. This step appears on the UI only if more than one IBM Endpoint Manager server configuration has been registered on the system. If only one configuration is available, it is used automatically. b. Select a Software Package The list of the available shared Software Packages, created through the IBM Endpoint Manager Software Distribution Dashboard, is displayed. Select one of them. You can search the table where Software Packages are displayed by specifying a search string in the corresponding box and clicking Search. All the rows having at least one column that contains the search string are returned. The search is not case-sensitive. c. Select a Software Task After selecting a Software Package, the list of tasks linked to that package is loaded and you must select one of them. d. Specify additional deployment options You can specify the Execution Mode, specify the Reboot Options, and set or update the values of custom parameters that can be defined inside the action belonging to the task selected for execution. When Re-execute Whenever Applicable is checked, the selected task is activated on the agents enabling the policy reevaluation mode, meaning that the IBM Endpoint Manager agent, after executing the task, continuously checks its compliance. If it becomes non-compliant, the task action gets reexecuted. When Execute Once is checked, the action defined in the selected task is executed just once and is marked as completed. 2 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

Through the Reboot Options parameter, you can specify if the target machines must be restarted or shut down at the end of the operation. e. Submit and monitor the operation When you click Submit, the activation of the task is triggered. You are redirected to the Action log page where you can monitor the execution of the operation. Based on the value specified for the Execution Mode parameter, the complete state of the operation assumes different meanings. More specifically, when Re-execute Whenever Applicable is checked, a complete operation means that the selected task has been activated on the target systems. In this case, the outcome of the execution of the action is not reported back to IBM Cloud Orchestrator. When Execute Once is checked, a complete operation means that the action specified in selected task has been successfully executed on the target systems. Table 1. Configuration of the action for OpenStack virtual machines Name Process Applies to Instance type Tags User interface Deploy software package Run Software Task (SCOrchestrator_IEM_SW_Integration_Toolkit) Multiple Instances openstackvms active Manage Software Packages (SCOrchestrator_IEM_SW_Integration_Toolkit) Table 2. Configuration of the action for OpenStack Heat stacks Name Process Applies to Instance type Tags User interface Deploy software package Run Software Task (SCOrchestrator_IEM_SW_Integration_Toolkit) Single Instance heat createcomplete Manage Software Packages (SCOrchestrator_IEM_SW_Integration_Toolkit) Deploy a Cloud Service with Additional Software You can submit the deployment of an OpenStack Heat template, and for each node of those artifacts, specify an additional Software Package or Fixlet. It must be deployed onto the virtual machines that corresponds to the node. This use case is available as a Self-Service Offering. To run this scenario, do the following steps: 1. Go to Self-Service Catalog and open the Deploy cloud services category. 2. Start the Deploy cloud service with additional software offering. 3. After the offering starts: a. Select the cloud service to deploy an OpenStack template. b. Configure the parameters that are required for the selected cloud service. The set of parameters depends on the chosen type of cloud services. c. For each part, the selected stack includes the following: IBM Cloud Orchestrator Content Pack For IBM Endpoint Manager for Software Distribution 3

1) Specify whether an additional Software Configuration must be run on the virtual machines, through the IBM Endpoint Manager infrastructure that is originated from this node. The different options are as follows: Configure Software Packages You can specify an additional Software Package task to be run. Configure Advanced Content You can specify a Fixlet to be activated. None No additional configurations to be applied. 2) Specify any custom parameters that are associated to the node. 3) Specify any custom parameters for the script packages associated to the part. 4) If an additional Software Configuration is requested, a Software Task or a Fixlet with advanced deployment options must be specified. The selection of a Software Task or of a Fixlet and the deployment options is the same in the Deploy software package and Deploy fixlet actions. 5) If you want to install the IBM Endpoint Manager agent on the virtual machine that you are going to deploy, select Install IEM Agent and specify the necessary parameters: operating system of the virtual machine, the IBM Endpoint Manager Agent package location, the credentials to access the package and, if necessary, the credential to access the virtual machine. d. Review the Summary. Click Submit to trigger the operation and monitor it. At the end of the operation, a report with the detailed outcome of the operation is delivered to the user who requested the operation. However, a valid email address and a working Simple Mail Transfer Protocol (SMTP) server must be configured with IBM Cloud Orchestrator. For the installation of additional software to occur, an IBM Endpoint Manager agent must be installed on the virtual machines that are involved by the software installation. If not, a message is displayed reporting the virtual machines that are not hosting a configured IBM Endpoint Manager agent. Table 3. Configuration of the offering Name Category Process User interface Deploy cloud service with additional software Deploy cloud services Deploy a Cloud Service with Additional Software (SCOrchestrator_IEM_SW_Integration_Toolkit) Deploy a Cloud Service with Additional Software (SCOrchestrator_IEM_SW_Integration_Toolkit) Toolkit Developer's Reference There are Business Process Manager artifacts exposed in the toolkit contained in the content pack. They are intended to be used by IBM Cloud Orchestrator content developers to extend the already available scenarios or to write new scenarios leveraging the building blocks available from the toolkit. The SCOrchestrator_IEM_SW_Integration_Toolkit has dependencies against the following basic toolkits that are delivered as a part of IBM Cloud Orchestrator: v SCOrchestrator_IEM_Integration_Toolkit v SCOrchestrator_Persistence_Base_Toolkit 4 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

v SCOrchestrator_Scripting_Utilities_Toolkit v SCOrchestrator Nova Support Toolkit v SCOrchestrator Heat Support Toolkit v SCOrchestrator_Support_IaaS_Toolkit v SCOrchestrator_Toolkit The following items are the main building blocks of the toolkit: v Business objects v Human services on page 6 v Business processes on page 6 v General system services on page 6 v Integration services on page 7 Business objects There are Business Process Manager business objects defined in the toolkit. FixletInPatternActivationRequest This object is used for storing the information about the request for deploying Software Packages and Fixlets on the virtual machines originating from a part of a Virtual System Pattern. IemSoftwarePackage This object is used for storing the attributes of a IBM Endpoint Manager software package, created through the Software Distribution Dashboard. PatternWithFixlets This object is used for exchanging information between the Human Service and Business Process Designer process related to the deployment of a Virtual System Pattern with Additional Software. It contains all the information about the configuration of the pattern to be deployed, including the additional data for deploying Software Packages and Fixlets specified by the user. SwSelectionCoachData This object is used for storing temporary properties to manage the software selection step in the user interfaces of the Manage Software Packages wizards. DeployableNodeWithFixlets This object is used for storing information about the Fixlets to be applied to the virtual machines originating from a given node of a deployed pattern. DeploymentTemplateWithFixlet This object is used for associating a pattern deployment template with Fixlets activation information. IemFixletActivationProgress This object is used for monitoring the progress of Fixlet actions. PatternSelectionHolder This object is used for storing basic information of the available patterns. ServiceDeploySummary This object is used for storing information of the Summary page of the 'Deploy a Cloud Service with Additional Software' Human Service. IBM Cloud Orchestrator Content Pack For IBM Endpoint Manager for Software Distribution 5

Human services There are a number of Human Services artifacts available in the toolkit. Deploy a Cloud Service with Additional Software This is the Human Service used to collect the parameters required to trigger the deployment of a Pattern including the additional data for deploying Software Packages and Fixlets on the virtual machines of the pattern. Manage Software Packages This is the Human Service that is used to collect the parameters required to execute a software task on a list of computers. Collect Fixlet Deploy Params for Nodes This is an internal Human Service, used by the Deploy a Cloud Service with Additional Software service, that handles the UI pages for selecting the cloud service to deploy, the Software Packages and/or Fixlets, and to configure the deployment parameters. Select Fixlet and Set Deployment Options in Pattern This is an internal Human Service, used by the Deploy a Pattern with Additional Software service, that handles the UI pages for selecting Software Packages and Fixlets in the context of configuring the deployment of a Virtual System Pattern. Select Pattern This is an internal Human Service, used by the Deploy a Cloud Service with Additional Software service, that handles the UI pages for selecting the Pattern to deploy. Select Software Task This is an internal Human Service, used by the Manage Software Packages services to handle the selection of Software Packages and tasks. Business processes There are business processes available in the toolkit. Deploy a Cloud Service with Additional Software This business process handles the deployment of an OpenStack Heat template and deploys the specified additional Software Packages and/or Fixlets on the virtual machines through the IBM Endpoint Manager infrastructure. Activate Fixlet Actions This business process handles the Fixlet activation. Deploy Heat Template This business process takes care of handling the deployment of a specified OpenStack Heat template. Run Software Task This business process handles the Fixlet activation. General system services There are general system services available in the toolkit. 6 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

GetTranslatedMessages This service returns the translated version of a list of string given their message keys. Integration services There are a number of integration services artifacts available in the toolkit. These services can be reused by a IBM Cloud Orchestrator content developer to build new use cases other than the ones already provided. ListApplicableTasksForSoftwarePackages This service lists the IBM Endpoint Manager software tasks that belong to the provided software package and that are relevant for the list of computers provided as input. If the provided list of computers is empty, all the tasks of the given software package are returned. ListSoftwarePackages This service lists the shared software packages available from the IBM Endpoint Manager environment. ListTasksForSoftwarePackages This service lists the software tasks associated to the given software package available from the IBM Endpoint Manager environment. Link VMs to Nodes (Heat) This service retrieves the virtual machines of a deployed OpenStack Heat template. InstallIEMAgents This service installs the IBM Endpoint Manager agent on a specified list of the virtual machines. IsIWDAvailable This service is used to check if the Workload Deployer component is installed in the environment. Compute IEM Agents This service retrieves from a specified list of virtual machines the ones that have the IBM Endpoint Manager agent installed. Samples about how to use integration services The Business Processes and Human Services that are delivered as part of this content pack can be used as starting points and as samples for developing new content. Using samples can give you an idea about how to invoke and combine the Integration Services delivered in the content pack. You can clone and adapt them to better fit your needs. Once you are familiar with them, you can start creating your new offerings and actions. For information about how to develop new content, see the IBM Cloud Orchestrator Content Development Guide available in the IBM Knowledge Center: v IBM Cloud Orchestrator > Managing orchestration workflows > IBM Cloud Orchestrator content development IBM Cloud Orchestrator Content Pack For IBM Endpoint Manager for Software Distribution 7

Configuring an SMTP server in IBM Cloud Orchestrator To use the email notification feature, you must configure Business Process Manager to use an appropriate SMTP relay server inside your organization. Contact your mail server administration team to obtain the host name of the SMTP server. Business Process Manager does not support any type of SMTP authentication or non-standard SMTP ports. Create a file called 100Custom.xml with the following content: properties> <server merge="mergechildren"> <email merge="mergechildren"> <smtp-server merge="replace">$smtp_host_name</smtp-server> </email> </server> </properties> Replace $SMTP_HOST_NAME with your SMTP server host name. Put the 100Custom.xml file in the directory: /opt/ibm/bpm/v8.5/profiles/ DmgrProfile/config/cells/PCCell1/nodes/Node1/servers/SingleClusterMember1/ process-center/config If the file is already there, edit it adding or updating the server/email section with the provided information. Afterwards, restart the Business Process Manager server using the command: service bpm restart. 8 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. Copyright IBM Corp. 2013, 2015 9

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation Software Interoperability Coordinator, Department 49XA 3605 Highway 52 N Rochester, MN 55901 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, 10 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information softcopy, the photographs and color illustrations may not appear. Notices 11

12 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

Trademarks and Service Marks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml. Adobe, the Adobe logo, PostScript, and the PostScript logo are trademarks or registered trademarks of Adobe Systems, Incorporated, in the United States and/or other countries. Intel, the Intel logo, Intel Inside, the Intel Inside logo, Intel Centrino, the Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Copyright IBM Corp. 2013, 2015 13

14 IBM Cloud Orchestrator: Content Pack for IBM Endpoint Manager for Software Distribution

IBM Printed in USA