HPE XP7 Automation Director User Manual
  1. Manuals
  2. Brands
  3. HPE Manuals
  4. Server
  5. XP7 Automation Director
  6. User manual
HPE XP7 Automation Director User Manual

HPE XP7 Automation Director User Manual

Hide thumbs Also See for XP7 Automation Director:
Table of Contents

Advertisement

Quick Links

Download this manual
HPE XP7 Automation Director User
Guide
Abstract
Automation Director is a software solution that provides the necessary tools to automate and
simplify the end-to-end storage provisioning process for storage and data center
administrators. The building blocks of the product are pre-packaged automation templates
known as service templates.
Part Number: P03776-005
Published: February 2019
Edition: 5

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XP7 Automation Director and is the answer not in the manual?

Questions and answers

Related Manuals for HPE XP7 Automation Director

Summary of Contents for HPE XP7 Automation Director

  • Page 1 HPE XP7 Automation Director User Guide Abstract Automation Director is a software solution that provides the necessary tools to automate and simplify the end-to-end storage provisioning process for storage and data center administrators. The building blocks of the product are pre-packaged automation templates known as service templates.
  • Page 2 © Copyright 2018, 2019 Hewlett Packard Enterprise Development LP The information contained herein is subject to change without notice. The only warranties for Hewlett Packard Enterprise 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.

  • Page 3: Table Of Contents

    Contents Getting started with Automation Director ..........8 About Automation Director......................8 User responsibilities ......................10 Operational workflow for service administrators and service users........11 Built-in user accounts........................12 Logging on..........................13 Accessing user profiles....................... 13 Editing a user profile ....................... 14 Changing the password for a user account..............14 Changing the system account password..................
  • Page 4 Managing scheduled tasks..............38 About tasks..........................38 Tasks tab.......................... 38 About task status........................40 Viewing task details........................42 Responding to tasks........................43 Suspending scheduled tasks...................... 43 Resuming scheduled tasks......................43 Canceling scheduled tasks......................44 Stopping tasks..........................44 Forcibly stopping tasks....................... 44 Retrying the task from the failed step..................
  • Page 5 Configuring external authentication for groups..............66 Deleting users........................67 Configuring connection settings....................67 Configuring VMware vCenter connections...............68 Configuring Configuration Manager REST API connections..........68 Configuring Web Service connections................70 Configuring a Web Service connection for ServiceNow...........71 Configuring remote connections..................72 Registering storage systems to a XP7 Configuration Manager REST API connection....73 Registering a local storage system to a XP7 Configuration Manager REST API connection........................73 Registering a remote storage system to a XP7 Configuration Manager REST API...
  • Page 6 Allocate Like Volumes service templates..................143 Allocate Like Volumes with Configuration Manager: Service details......143 Data mobility service templates....................147 Allocate Volumes from Virtual Storage Machine: Service details........147 Export Virtual Storage Machine Configuration Across Sites: Service details....152 Create High Availability Pair for Migration: Service details..........154 Migrate Data Using High Availability Pair: Service details..........
  • Page 7 Start virtual servers: Service details................320 Stop virtual servers: Settings..................321 Hyper-V 2012 service templates....................323 Add a virtual server (deploy/OS initial settings): Service details........324 Change virtual server specifications (CPU and memory): Service details..... 335 Delete virtual server: Service details................341 Add virtual server (virtual disk): Service details............. 346 Start virtual server: Service details.................350 Stop virtual server: Service details.................353 Restart virtual server: Service details................354...

  • Page 8: Getting Started With Automation Director

    Getting started with Automation Director About Automation Director As a storage administrator, you spend a lot of time performing repetitive manual tasks. These tasks are not only time-consuming, but they also can be error-prone. Considering the changing landscape of data center operation, you must spend your time on mission-critical tasks that assure the smooth functioning of the data center.
  • Page 9 Tasks A task is an instance of a service. When you submit a service, Automation Director creates a corresponding task that can be scheduled to run immediately or based on a schedule. A task can also be suspended, resumed, stopped, and archived based on your needs. The following figure shows the relationship between templates, services, and tasks.

  • Page 10: User Responsibilities

    User groups A user group is a set of users with a defined level of access. User groups are associated with service groups to enable users to access the services in the service group. Automation Director includes predefined user groups and users can also create new user groups. User responsibilities System administrator After installing Automation Director, the system administrator completes the initial setup tasks of creating...

  • Page 11: Operational Workflow For Service Administrators And Service Users

    Users Available Actions Automation Director User Roles System administrators Modify shared property settings. Admin Create users and user groups. Create service groups and associate services with the groups. Create infrastructure groups and add storage resources with the groups. Associate infrastructure groups with service groups to enable the services in the service groups to use resources in the infrastructure...

  • Page 12: Built-In User Accounts

    The following figure shows the high-level flow of operations for a service user. Built-in user accounts The System account (default password: manager) is for administering user management tasks, such as registering users, enabling access, and managing roles and permissions. It is also used to manage XP7 Command View Advanced Edition tasks and provides access to the XP7 Command View Advanced Edition UI.

  • Page 13: Logging On

    Automation Director and manage user access to storage systems registered in XP7 Command View Advanced Edition. The System account does not belong to any user group. NOTE: For information on how to change the system account password, see the HPE XP7 Automation Director Installation and Configuration Guide.

  • Page 14: Editing A User Profile

    • In the global toolbar, click Tools > User Profile. • If you are an Admin user, you can click User Profile in the Administration tab. • An Admin user can also access user profiles in the Administration tab by navigating to Resources and Permissions >...

  • Page 15: Registering A License

    Register a license when accessing Automation Director for the first time after installation or when a license is expired. NOTE: You must obtain the Automation Director server license from your HPE representative. Procedure 1. Enter the Automation Director URL in a web browser.
  • Page 16 Global task bar The global task bar provides menus for accessing various features provided by Automation Director and, in the upper, right area of the task bar, includes your user name and details about when you last logged on. A button is also included that you can use to quickly log off the system. The global task bar is always visible, regardless of which window is active.

  • Page 17: Navigating Help

    ◦ Select Online Manual and open Help with the navigation pane visible. ◦ Select About to open the About window to view license information. Global tabs The Dashboard and Tasks tabs are always visible, regardless of which window is active. Access to Services, Service Templates, and Administration tabs is dependent on the user role assigned.

  • Page 18: Using Search Features

    Provides a list of topics based on the search criteria entered in the search text box. Click topics returned by the search for details. Printing topics To print topics, right-click the topic and select Print or click the printer icon on the button bar. Role-based help Throughout Automation Director, help is provided based on the current user's logon ID and the assigned role and permissions.

  • Page 19: About Tags

    Mark as To Do If you must pay attention to a task or respond to a task, you can mark it as To Do. You can mark a task as To Do using any of the following methods: • In the Table View in the Tasks tab: ◦...

  • Page 20: User Workflows By Role

    • To create a tag, scroll to the end of the tag list, select Create Tag, enter a name and tag group for the new tag, and click OK. • To create a tag group, first create a tag. Then scroll to the bottom of the Tag Group list and click Create Tag Group to enter a tag group name.

  • Page 21: Develop User Workflow

    4. Create users. This step is not necessary if you have integrated users from XP7 Command View Advanced Edition with Active Directory. 5. Configure user groups, if needed. Automation Director includes four built-in user groups. 6. Create infrastructure groups and assign resources to them. If necessary, you can also assign Web Service Connections and Agentless Remote Connections to infrastructure groups.

  • Page 22: Submit User Workflow

    4. Test the service. 5. Release the service for use. More information Creating or editing a service on page 32 Releasing a service on page 36 Testing a new service on page 35 Services tab on page 29 Submit user workflow The Submit user can only access services that have already been released and does not have access to the Debug tab in the Tasks tab.

  • Page 23: Service Builder Workflow

    More information Service Builder workflow on page 23 Service Builder workflow Phase 1 - Preparing • Decide on the need and purpose of the service template. Consider the steps involved to automate the process and determine if the steps require creating a new template or modifying an existing template. •...

  • Page 24: Viewing Service And Task Summaries

    Viewing service and task summaries Viewing the dashboard Guidance Menu The Guidance menu serves as a navigation pane and provides links to information on how to perform common functions in Automation Director. The current user role determines which categories are visible. This menu pane can be turned on or off using the Dashboard Settings.

  • Page 25: Viewing Dashboard Reports

    Viewing dashboard reports The following sections provide information about each dashboard report. Most Frequently Failed Services report The Most Frequently Failed Service report can be viewed by Admin, Develop, and Modify users. You can click a link to open the Service Preview, where you can access further actions to take. More information Services tab on page 29 Most Frequently Used Services report...

  • Page 26: Tasks Waiting For Action Report

    You can click a link to open the Service Preview, where you can access further actions. More information Services tab on page 29 Tasks Waiting for Action report The Tasks Waiting for Action report lists tasks that require your attention, which includes the following: •...

  • Page 27: My Tasks Report

    My Tasks report The task states and corresponding statuses are as follows. Task state Task status Active • In Progress • In Progress (with Error) • In Progress (Terminating) • Waiting for Input • Long Running Scheduled • Waiting • Suspended Finished •...
  • Page 28 More information Submitting a service on page 36 Services tab on page 29 Viewing service and task summaries...

  • Page 29: Managing Services

    Managing services Overview of Automation Director services A service is a customized set of instructions that follow a process flow to automate data center tasks such as provisioning. Services are integrated with infrastructure groups so they operate within the designated storage profiles to help manage resources.
  • Page 30 Watermark Description Service is in Debug status. Service is in Test status or Maintenance status. Service is in Disable status. The following table contains the badges that are visible in the services Card View. Graphic Description OUTDATED The service is using an outdated version of a service template. You can use Apply Latest Version to update the service.

  • Page 31: Workflow For Creating A Service

    Action Description Create Opens the Select Service Template window, where Admin, Develop and Modify users can select a template and use it to create new services. Create Request Runs the service by creating the tasks required to perform the service. Edit Modifies a service.

  • Page 32: Creating Or Editing A Service

    Creating or editing a service You can create a new service, edit a service, or copy an existing service. Procedure 1. Determine whether you want to copy or edit an existing service or create a new service: • To copy a service, go to step 8. •...

  • Page 33: Create Service Window

    Scheduling Options: Immediate: Run the service when it is submitted. Scheduled: Run the service once. Recurrence: Run the service multiple times. 6. In the Navigation pane, click each settings group and configure the required and optional parameters. You can also navigate through the settings groups using the links at the bottom of the Settings pane. You can choose to retain default settings from the service or template you started with.
  • Page 34 Navigation pane The Navigation pane has settings groups that include General Settings and any other settings that are required or optional for the service. You can click a settings group to display and edit the settings in the Settings pane. You can also navigate through the settings groups using the links at the bottom of the Settings pane.

  • Page 35: Testing A New Service

    Settings/Parameters Description Preview Opens a view of the service as it will appear to a user. Save and Close Saves the service to the system and closes the window. Cancel Cancels any changes and closes the window. More information Workflow for creating a service on page 31 Importing property values on page 86 Exporting property values on page 87 Creating or editing a service on page 32...

  • Page 36: Releasing A Service

    Releasing a service Procedure 1. On the Services tab, select the service to release. 2. From the table view or from the service preview pane of the card view, click More Actions > Release. Submitting a service Prerequisites • If the service is in Release status, you must have the Submit (or higher) role. •...

  • Page 37: Disabling A Service

    More information Testing a new service on page 35 Releasing a service on page 36 Disabling a service Procedure 1. On the Services tab, select the service to disable. 2. From the table view or from the service preview pane of the card view, click More Actions > Disable. Deleting a service Prerequisites On the Tasks tab, in the task view, verify no tasks exist from the service you are deleting.

  • Page 38: Managing Scheduled Tasks

    Managing scheduled tasks About tasks The dashboard provides a quick way to monitor the tasks. From the dashboard, you can view the tasks that were generated by the services you submitted, or see the tasks that require a response. The Global Monitoring Bar Area found at the bottom of every tab in Automation Director provides a collective summary of the task status.
  • Page 39 Property Description Service Group Service group to which the service belongs. Tags Tags associated with the task. Submitted By Name of the user who submitted the task. Submit Time Time when the service was submitted. Schedule Interval Interval between recurring tasks. Recurrence Time Time when a recurring task is to start.

  • Page 40: About Task Status

    Action Description Suspend Schedules Prevents a scheduled task from starting at the scheduled time. Resume Schedules Allows a suspended task to start at the scheduled time. Cancel Schedules Clears all schedules from the task. Stop Stops a task in the In Progress, Waiting for Input, or Long Running status.
  • Page 41 Task category Task status Description Available actions Active In Progress Task is running. Stop the task. Forcibly stop the task. Waiting for Input Task is pending user input. Stop the task. Forcibly stop the task. Long Running Task is running longer than Stop the task.

  • Page 42: Viewing Task Details

    Archiving tasks on page 46 Viewing task details On the Tasks tab, select a task from the Tasks or Debug view, and click Show Details. The following controls are available: • Input Response: Click to respond if a task is in Waiting for Input status. •...

  • Page 43: Responding To Tasks

    Property Description Log tab The log information might be useful in debugging. You can copy a section or save the entire log by clicking Download and then specifying the location of the log file. Notes tab An HTML text editor is provided to enter additional information regarding the task.

  • Page 44: Canceling Scheduled Tasks

    Canceling scheduled tasks When you cancel a service, you must cancel the related tasks. Cancel a task when you want to cancel a service and its related tasks are scheduled but has not yet run. Procedure 1. On the Tasks tab, select the task that you want to cancel. 2.

  • Page 45: Retrying The Task From The Failed Step

    The tasks stops and the status changes to Terminated. 4. (Optional) You can verify the point at which the task was stopped by selecting the task and viewing the task details. Retrying the task from the failed step You can retry tasks from the step that failed for tasks that are in the Failed status. You enable retry actions in the Available Actions section of the Create/Edit Service window.

  • Page 46: Archiving Tasks

    NOTE: In Task Settings, a specified schedule is interpreted as a server time. Be aware if the server is in a different time zone from the client. 4. Click Submit to submit the service, or Submit & View Task to view the tasks. More information About task status on page 40 Archiving tasks...

  • Page 47: Working With Service Templates

    Working with service templates Viewing service template information The Service Templates tab enables users to do the following: • View and filter service templates with tags. • Create custom tags or tag groups using Organize Tags. • Using the Card View or Table View, see service template details, status, and actions. •...
  • Page 48 Import a template to Automation Director. This can be used to import a template from another environment. Create Launch Service Builder to create a new service template. For more information, see the HPE XP7 Automation Director Service Builder User Guide. Create Service Create a new service from the specified service template.

  • Page 49: Importing A Released Service Template

    Property Description Version Version number of the template. Description Description of the template. Service Template Key Name Identifier name of the template. Vendor Template vendor. Tags Tags applied to the template. Registered (in Table View) Date the template was created. Released (in Card View) Date the template was released.

  • Page 50: Creating A Service From The Service Templates Tab

    Procedure 1. In the Dashboard Guidance Menu select Import Service Template or from the Service Templates tab click Import to open the Import Service Template window. You can also import a service template from the Card View by clicking Import. 2.

  • Page 51: Exporting A Service Template

    4. Expand Advanced Options and select the options you want: Scheduling Options: Immediate: Run the service when it is submitted. Scheduled: Run the service once. Recurrence: Run the service multiple times. 5. In the Navigation pane, click each settings group and configure the required and optional parameters. You can also navigate through the settings groups using the links at the bottom of the Settings pane.

  • Page 52: About Provisioning Service Templates

    In the Templates tab, click Card View and click the template you must update to open the Copy Service Template dialog box in Service Builder. For more information, see the HPE XP7 Automation Director Service Builder User Guide. About provisioning service templates Automation Director provisioning templates automate the provisioning of newly added volumes.

  • Page 53: About Esx Cluster Service Templates

    NOTE: The performance of Data Mobility services are affected by the storage access mode setting of Configuration Manager. We recommend you to set "fcConnectionMode" to obtain higher performance. For details, see "Appendix A. Changing the communication mode of the REST API server" in the HPE XP7 Configuration Manager REST API Reference Guide.

  • Page 54: About Servicenow Ticketing Service Templates

    NOTE: For additional information on HA, see the HPE XP7 High Availability User Guide. A number of service templates support High Availability (HA) configurations. HA enables read/write copies of the same data in two places at the same time for continuous mirroring.
  • Page 55 Additional cross-path suppression problems • If the Alternate path software supports ALUA (Asymmetric Logical Unit Access), suppress the cross- path by setting ALUA to the preferred path. • If the Alternate path software does not support ALUA, you cannot suppress cross-path. •...

  • Page 56: Administering Automation Director

    Administering Automation Director Viewing the Administration tab The Administration tab includes the views and tools to set up and configure Automation Director. It includes the necessary connection settings to other hosts and third-party products, and the tools to set up users, groups, permissions, and relationships, as follows: •...

  • Page 57: Managing Groups In Automation Director

    Create infrastructure groups and assign resource and service groups. 7. Set up service groups. Managing groups in Automation Director • Resource groups: Resources can be grouped by system resource types that include storage system, parity groups, pools, LDEV IDs, and storage ports. •...

  • Page 58: About Service Groups

    About service groups There are three types of service groups: • All Service Group: A group that is automatically created during installation. Pre-defined user groups (AdminGroup, DevelopGroup, ModifyGroup, and SubmitGroup) are automatically registered in the All Service Group. This group cannot be associated with a specific service, agentless connection, or infrastructure group.

  • Page 59: About Infrastructure Groups

    Assigning services to a service group Procedure 1. On the Administration tab, click Resources and Permissions > Service Groups. 2. Select a service group to display the Services, Resources, and Permissions tabs. Use Create or Copy to add a new service. 3.
  • Page 60 • No. of Agentless Remote Connections: The number of associated agentless remote connections. • No. of Service Groups: The number of associated service groups. Click an infrastructure group to view the details under each tab: • Web Service Connections tab - a list of associated web service connections for XP7 Configuration Manager.

  • Page 61: Managing Your User Profile

    ◦ Name: Service group display name. ◦ Description: Description for the service group. Assigning resources to an infrastructure group Procedure 1. On the Administration tab, click Resources and Permissions > Infrastructure Groups. 2. From the Infrastructure Groups view, click the infrastructure group for which the resource is to be assigned.

  • Page 62: Viewing Your User Profile

    Viewing your user profile The User Profile window shows your User ID, Full Name, E-mail, Description, and the permissions assigned for each application. Procedure 1. On the Administration tab click User Profile to access your user profile. 2. From the User Profile window, you can: •...

  • Page 63: Viewing Users

    Role Access level description Included privileges Admin This level of access is intended for • Edit Service dialog box administrators to: • Submit Service dialog box • Manage users and user groups • Task Details dialog box • Manage storage including resource •...

  • Page 64: Editing The Profile For A User Account

    A user management window opens. 2. Display the current user list by clicking Users. 3. To add a user, click Add User and specify user profile information. 4. Click OK. The user list opens again and includes the new user. More information About user roles on page 62 Editing the profile for a user account...

  • Page 65: Changing The Lock Status Of User Accounts

    Prerequisites • The Automation Director server must be linked to an external authentication server. See the HPE XP7 Command View Advanced Edition Administrator Guide. • The Automation Director server must be configured to support user authentication, which activates the Change Auth button in the UI, and presents authentication options such as Internal for a local account or LDAP for external authentication.

  • Page 66: Configuring External Authentication For Groups

    Prerequisites • The Automation Director server must be linked to an external authentication (authorization) server. See the HPE XP7 Command View Advanced Edition Administrator Guide. • The Automation Director server must be configured to support group authentication, which activates the Groups folder in the UI.

  • Page 67: Deleting Users

    Procedure 1. From the Administration tab, select Users and Permissions. 2. Click the Groups folder to display the Domain List. This is a list of external authentication servers listed by domain name, and host name or IP address. If the Groups folder is not visible, see the prerequisites above.

  • Page 68: Configuring Vmware Vcenter Connections

    Configuring VMware vCenter connections Procedure 1. From the Administration tab, click Connection Settings > Web Service Connections. 2. Click Add and enter the following information: • Category: Select vCenter. • Name • IP Address/Host Name • Protocol: https. Cannot be changed. •...
  • Page 69 XP7 Configuration Manager REST API, see the HPE XP7 Configuration Manager REST API Reference Guide. NOTE: If you plan to use the XP7 Configuration Manager Settings option to register local and remote storage systems, you must use XP7 Configuration Manager REST API server v8.6.1-00 or later.

  • Page 70: Configuring Web Service Connections

    3. To use a proxy server, select the check box and enter the following information: • IP Address/Host Name • Port • Authentication • Authentication Type • User ID • Password 4. Enter assigned infrastructure groups. 5. Click OK. What to do next If you are using Data Mobility services, you must first ensure that all Virtual Storage Machines (VSMs) across sites use the same resource group name so that the services can recognize them.

  • Page 71: Configuring A Web Service Connection For Servicenow

    NOTE: When you use https with Web Service connections, you must first import certificates for the Web Service Connection and import certificates into the Java trust store. For detailed information, see the HPE XP7 Automation Director Installation and Configuration Guide. •...

  • Page 72: Configuring Remote Connections

    Prerequisites Consult "Windows prerequisites for agentless connections" or " SSH prerequisites for agentless connections" in the HPE XP7 Automation Director Installation and Configuration Guide for details on setting up a remote connection. When specifying a range of addresses (i.e., X.X.X.A to X.X.X.B) for IPv4, use a hyphen (-) as shown in the following format: Format: X.X.X.A-B...

  • Page 73: Registering Storage Systems To A Xp7 Configuration Manager Rest Api Connection

    When choosing SSH as your authentication protocol, you have the option of specifying Password Authentication, Public Key Authentication, or Keyboard Interactive Authentication. NOTE: Even when you want to perform remote operations on the local host, registering the local host setting is required. In this case, the setting for Authentication is not required. 3.
  • Page 74 • A Web Service connection exists for the XP7 Configuration Manager REST API server on which you plan to register the storage system in Connection Settings > Web Service Connections on the Administration tab. See "Configuring Configuration Manager REST API connections on page 68" for more information.

  • Page 75: Registering A Remote Storage System To A Xp7 Configuration Manager Rest Api Connection

    Registering a remote storage system to a XP7 Configuration Manager REST API connection Prerequisites Verify the following: • A Web service connection exists for both the XP7 Configuration Manager REST API server managing the local storage systems and for the XP7 Configuration Manager REST API server managing the remote storage systems.

  • Page 76: Deleting Local Storage System Information From A Xp7 Configuration Manager Rest Api Connection

    Deleting local storage system information from a XP7 Configuration Manager REST API connection Procedure 1. On the Administration tab, select Storage Service Settings > Configuration Manager Settings. 2. From the XP7 Configuration Manager Connection section at the top, select the XP7 Configuration Manager connection to which the local storage system is registered.

  • Page 77: Built-In Shared Properties

    Automation Director provides a set of built-in shared properties that are based on common provisioning tasks. Additionally, shared properties can be customized when creating a service template using Service Builder. More information Modifying the shared service properties on page 78 Built-in shared properties on page 77 Built-in shared properties NOTE: When a task runs, the values in the built-in shared properties are applied to the task.

  • Page 78: Modifying The Shared Service Properties

    Shared service properties Description Values Reflection of Volume Labels into Specifies whether to apply the True or False the Storage System volume labels to Remote Web Console during volume label configuration at volume allocation. If you specify "true", the volume label is applied.

  • Page 79: Configuring Email And Log Settings

    Procedure 1. On the Administration tab, click Shared Properties Settings. 2. Select the Virtual Storage Machine Names shared property and click Edit. The Set Service Shared Property window opens. 3. In the Value field, specify one or more resource group names used for your VSMs across sites. Use a comma to separate multiple resource group names.

  • Page 80: Setting Up An External Resource Provider

    Actions menu to export or delete an existing external resource provider entry. Additionally, you can click Import to import a previously exported external resource provider. For more information on how to implement an external resource provider, see the HPE XP7 Automation Director Service Builder User Guide.

  • Page 81: Servicenow Workflow Integration

    ServiceNow workflow integration The ServiceNow Workflow Integration package includes an XML file that contains the update set required to integrate an Automation Director service into a ServiceNow workflow. The XML file is located here: Automation-Director-installation-folder\public\ServiceNow\Automation_Adapter_for_ServiceNow_Version-number.xml NOTE: For information about using Automation Director ServiceNow templates to manage an entire workflow, see ServiceNow ticketing service templates on page 185.

  • Page 82: Installing A Mid Server

    • Name: Enter a descriptive name for the REST message. • Description: Enter a description of the REST message. • Endpoint: Enter the endpoint to which this REST message is sent. The endpoint value may include variables using the format ${variable}. To create a REST Message for Automation Director integration, enter the following: http(s)://Automation-Director-Server-IP-Address:port_number/Automation/$ {path}...

  • Page 83: Importing An Update Set

    HPE XP7 Automation Director Installation and Configuration Guide and Add SSL certificates in the ServiceNow product documentation. Importing an update set In ServiceNow, you can export and import database information for a specific version of an application or set of configuration changes by using an XML file.
  • Page 84 Input for Invoke Automation Service sub-workflow In the Invoke Automation Service sub-workflow, the following input service parameters are set: • REST Message Name • Request Parameters • Service Instance ID • Task Settings In the sample workflow Manipulate Input step, user input values are mapped to variables of the Invoke Automation Service flow.

  • Page 85: Running The Workflow

    In requestParams, the required Automation Director parameter Key and Value are set. You can also specify the service run schedule as a task setting. For details on the built-in service parameters and task settings, refer to "Submitting a service" in the HPE XP7 Automation Director REST API User and Reference Guide.

  • Page 86: Importing And Exporting Properties

    Importing and exporting properties Buttons at the bottom of the Create/Edit Service and Submit Service Request windows allow you to import and export property values. Importing property values Importing property values Follow these steps to import property values to a specified file. Procedure 1.

  • Page 87: Exporting Property Values

    If an error occurs during an import, the error dialog box appears, and the import is canceled, leaving all property values unchanged. An error occurs when the specified file does not exist or the property file definitions are invalid. Exporting property values While debugging, you can export property values to a property file.
  • Page 88 • The value for the password type property can be in plain text or encrypted. The "value" field of the password type property is not exported for security reasons. The defined value is imported as is, and the REST API determines whether it is in plain text or encrypted. •...
  • Page 89 • The absolute path of the property value file or the relative path from the property file must always be specified or an error occurs. • If the specified file does not contain a property value, an error occurs. • The property value file can contain end-of-line characters.

  • Page 90: Cli Commands

    XP7 Command View Advanced Edition Common Component commands. For more information about the XP7 Command View Advanced Edition Common Component CLI commands, command syntax and description, see the HPE XP7 Command View Advanced Edition Administrator Guide.

  • Page 91: Hcmds64Trust Command

    Return code Description The command succeeded. The argument is invalid. The command stopped due to an error other than the ones listed in this table. The server ID is case insensitive and can consist of any ASCII printable character code (0x20-7E) If you specify the server ID that has already been registered through the hcmds64trust command, the connection destination information is not registered, and an error message is output specifying the same server ID as the registered connection destination information.
  • Page 92 Deleting the destination information to the XP7 Command View Advanced Edition authentication zone, deletes the destination information that server ID matches. Syntax: (UNIX OS) hcmds64trust {-set -user User_Name -pass Password -host Host_Name_or_IP_Address {-port Port_Number | -sslport sslport_Port_Number [-sslprotocol SSL_Protocol] | [-ciphers {Encryption_Type_Name | CipherSuite[,CipherSuite[...]]}]} ] | -delete -name Server_ID | -print } Syntax: (Windows-based OS) hcmds64trust {/set /user User_Name /pass Password /host...
  • Page 93 Option Description delete Deletes the destination information. print Displays the registered destination information. Encryption Type Details Encryption type name Description CipherSuites SSL protocol SUITEB128 Low intensity setting in TLS_ECDHE_ECDSA_ TLSv1.2 Suite B standard. WITH_AES_256_GCM_ P-256[nistp256 SHA384 secp256r1] and TLS_ECDHE_ECDSA_ P-384[nistp384 WITH_AES_128_GCM_ secp384r1] SHA256...
  • Page 94 Encryption type name Description CipherSuites SSL protocol Setting in which only the TLS_RSA_WITH_AES_ TLSv1.2 CipherSuites using RSA 256_CBC_SHA256 are specified by TLS_RSA_WITH_AES_ considering the past 256_CBC_SHA, compatibility to the maximum extent. TLS_RSA_WITH_AES_ 128_CBC_SHA256 TLS_RSA_WITH_AES_ 128_CBC_SHA SSL_RSA_WITH_3DES _EDE_CBC_SHA Setting in which the past TLS_ECDHE_ECDSA_ TLSv1.2 compatibility is...
  • Page 95 Encryption type name Description CipherSuites SSL protocol TLS_RSA_WITH_AES_ 256_CBC_SHA TLS_RSA_WITH_AES_ 128_CBC_SHA256 TLS_RSA_WITH_AES_ 128_CBC_SHA SSL_RSA_WITH_3DES _EDE_CBC_SHA Return codes The following table lists the hcmds64trust command return codes and descriptions. Return code Description The command succeeded. The argument is invalid. The command stopped due to an error other than the ones listed in this table. Destination information can be registered for each server ID.

  • Page 96: Automation Director Cli Commands

    usage: hcmds64trust {-set -user userName -pass password -host hostName {- port portNumber | -sslport portNumber [-sslprotocol SSLProtocol] [-ciphers {CipherType | CipherSuite[,CipherSuite[...]]}] } | -delete -name trustedServerID | -print} Example: Processing failure >hcmds64trust -set -user local_user -pass local_pass -host 127.0.0.1 -sslport 22016 KAPM16075-E Failed to connect to the specified server.
  • Page 97 where: • /dir is an absolute or relative directory path that contains backup data. • /auto directs the Automation Director and XP7 Command View Advanced Edition services and database to start and stop automatically. The Admin role is not required to run this command. deleteremoteconnection The deleteremoteconnection deletes the agentless connection-destination definitions registered through Automation Director based on the definition ID derived with the listremoteconnections...
  • Page 98 encryptpassword The encryptpassword command creates a file that includes an encrypted user name and password. You can specify the password file instead of the password for any Automation Director command that allows the /passwordfile option. The syntax is: encryptpassword {/user username /password password /passwordfile passwordfile | /help } where: •...
  • Page 99 listservices The listservices command exports a list of services or a list of service templates to a CSV file. The syntax is: listservices {/output {services | servicetemplates} /file output-file [/ encoding encoding] /user username {/password password | /passwordfile passwordfile} | /help} where: •...
  • Page 100 The syntax is: restoresystem {/dir directoryname [/auto] | /help} where: • /dir is an absolute or relative directory path that contains data that is backed up by the backupsystem command • /auto directs the Automation Director and XP7 Command View Advanced Edition services and database to start and stop automatically.

  • Page 101: Submittask Command

    The syntax is: setupcluster {/exportpath exportpath | /help} where /exportpath is the absolute or relative path of the directory on a shared disk used to store the database and server information. stoptask The stoptask command stops a running task. The syntax is: stoptask {/taskid task-ID /user username {/password password | /passwordfile passwordfile} | /help} where: •...
  • Page 102 [/taskdescription TaskDescription] [{[/property Key "Value"]... | /propertyfile PropertyFile}] /user UserName {/password Password | /passwordfile PasswordFile} /scheduledate yyyy-mm-dd /scheduletime hh:mm | /help} Syntax: Recurrent execution of a service submittask {/servicename ServiceName [/servicegroup ServiceGroup] [/taskname TaskName] [/taskdescription TaskDescription] [{[/property Key "Value"]... | /propertyfile PropertyFile}] /user UserName {/password Password | /passwordfile PasswordFile}...
  • Page 103 Option Description /taskname Specify a task name. The name of the task. If you omit this option, the system defaults to service-name_YYYYMMDDhhmmss, where service-name is the value of the /servicename option and YYYYMMDDhhmmss is the time when the service runs. The task name can be 1 to 128 characters long and can consists of any characters except control characters ('\u0000'~'\u001F' or \u007F'~'\u009F').
  • Page 104 Option Description /propertyfile Specify a property file. Use an absolute or relative path. The name of a properties file, including an absolute or relative path, that defines the property settings that the service you want to perform uses. Property keys and values that are not specified in the properties file are set to default values.
  • Page 105 Option Description /wait Wait for a task to finish. Provides the task execution result (normal termination or failure). If the /wait option is not specified, the command terminates without waiting for the task to terminate. In this case, a message reporting the task ID is provided only when the task execution has started normally.
  • Page 106 Option Description /recurrencepattern Specify a pattern for a recurring service. Use this option with the /recurrencetime option, and the / recurrencestart option. When this option is specified, the following conditions will result in an error: • An invalid combination of arguments. •...
  • Page 107 Option Description /recurrencestart Specify a date for a recurring service to start. Use this option with the /recurrencepattern option, and the / recurrencetime option. When this option is specified, the following conditions will result in an error: • An invalid combination of arguments. •...
  • Page 108 Return code Description The command stopped. The service status is invalid. The number of commands that can be run simultaneously is exceeded. Communication failed. Authentication failed. An invalid path is specified. Path not found. Path cannot be accessed. You do not have permission to run the command. The service did not start.

  • Page 109: Listremoteconnections Command

    /user Bob /password password Example: Recurrent execution of a service submittask /servicename "Execute Remote Command" /propertyfile "C:\temp\properties.txt" /recurrencepattern weekly:sun,mon,sat /recurrencetime 12:34 /recurrencestart 2015-01-23 /user Bob /password password Example: Reregistration of tasks submittask /reregister /taskdetaildir "C:\temp\taskdetails" /user Bob /password password listremoteconnections command Functions The listremoteconnections command performs the following functions: •...
  • Page 110 Options Option Description /file Specifies the path of the file to which the list is output; if the specified file already exists, an error is generated. . /user Specifies the name of the user executing the command. The user name can consist of any single-byte alphanumeric characters including ( ! # $ % &...
  • Page 111 Return code Description Failed to output the specified file. User does not have permission to run the command. Failed to acquire a list of agentless connection-destination definitions. The command stopped because of an error not in this table. Data Format Agentless connection destinations are output in CSV format with one host in one line and with the following data items in the order in which they are shown in the following table.
  • Page 112 Property Header Section (first Data Section (second and subsequent line) lines) SSH authentication method SSH authentication When the protocol is not SSH, null method character ("") When the protocol is SSH, any one of the following: • Password Authentication • Public Key Authentication •...

  • Page 113: Setremoteconnection Command

    setremoteconnection command Function The setremoteconnection command adds or updates agentless connection-destination definitions in Automation Director. To add or update agentless connection-destination definitions, you define the information in a CSV file and then specify the file name as a command argument. NOTE: The CSV file must have the same format as the output file of the listremoteconnections command.
  • Page 114 Storage Destination installation-folder\bin Return codes The following table lists the setremoteconnection command return codes and descriptions: Return code Description The command succeeded. The argument is invalid. The command stopped. The service status is invalid. An exclusion error occurred. Communication failed. Authentication failed.
  • Page 115 Data item Description Specifies the ID of the agentless connection-destination definition Definition ID to update. If a null character is specified, the agentless connection- (Id) destination definitions are registered as an addition. If the agentless connection-destination definition of the specified ID does not exist, the system generates an error.
  • Page 116 Data item Description SSH authentication method Specifies the SSH authentication method: (SSH Authentication Method) • When the protocol is not SSH, specify a null character (""). • When the protocol is SSH, one of the following: ◦ Password Authentication (PW) ◦...
  • Page 117 Data item Description Status Specifies either Connection Successful, Error, Unknown, or "-" depending on the status. (Connection Status) Last connection time Specifies the last connection time. (Connected Time) Behavior of the setremoteconnections command The following lists includes details about the behavior of the setremoteconnections command when specifying an agentless connection-destination definition file for the /file option: •...

  • Page 118: Deleteremoteconnection Command

    Example: Error encountered in parameters KNAE03000-I The setremoteconnection command will now start. KNAE03333-E A required parameter was not found (parameter name: XXXXX, line number: 12345). Specify the required parameter, and then try again. KNAE03334-E Unnecessary parameter has been specified (parameter name: XXXXX, line number: 12345).
  • Page 119 Option Description /password Specifies is the password of the user that is specified in the /user option. Either this option or /passwordfile must be specified. If both options are specified, or if neither option is specified, an error is generated. The password can be from 1 to 256 single-byte alphanumeric characters in length including (! # $ % &...

  • Page 120: Services Catalog

    Services catalog This appendix provides service details for the settings associated with the service templates provided with Automation Director. Service Template category Supports Add Host feature Allocate Volumes Allocate Like Volumes Data Mobility ESX Cluster ServiceNow Ticketing Service template prerequisites The following table shows the software and setup prerequisites for each of the service templates.
  • Page 121 Service Template name Software prerequisites Setup prerequisites XP7 Configuration Manager Allocate Volumes with • Register the LDEV ID, DP v8.5.3-00 or later Configuration Manager Pool, Port, and Host Group ID used by this service to the same resource group or virtual storage machine.
  • Page 122 Service Template name Software prerequisites Setup prerequisites ◦ Security Administrator (View and Modify) ◦ Storage Administrator (Provisioning) Allocate Like Volumes with Configuration Manager REST API • Create a Web service Configuration Manager v8.6.2-00 or later connection for the Configuration Manager REST API.
  • Page 123 Service Template name Software prerequisites Setup prerequisites Data Mobility XP7 Configuration Manager • Create a VSM and assign v8.5.4-00 or later. resources before running • Allocate Volumes from Virtual Note: To use the Data Mobility this service. Storage Machine services, an administrator must install the Configuration Manager •...
  • Page 124 Service Template name Software prerequisites Setup prerequisites Allocate Fabric Aware Volumes • Configuration Manager REST • Create a datastore cluster. and Create Datastore for ESX API v8.5.3 or later. Cluster • Connect the storage • Brocade Network Advisor (BNA) system and hosts to the 14.2 (SAN System Administrator SAN and verify that they or Zone Administrator role is...
  • Page 125 Service Template name Software prerequisites Setup prerequisites • Register Configuration Manager REST API in Automation Director. • Register VMware vCenter Server in Automation Director. • Register Brocade Network Advisor in Automation Director. • Register the storage system in Configuration Manager REST API. •...
  • Page 126 Service Template name Software prerequisites Setup prerequisites Add Host to Cluster in vCenter • Configuration Manager REST • Create an ESX cluster. API v8.5.3 or later. • Add hosts to the ESX • Brocade Network Advisor (BNA) cluster. 14.2 (SAN System Administrator •...
  • Page 127 Service Template name Software prerequisites Setup prerequisites Remove Host from Cluster in • Configuration Manager v8.6.0-00 • Create an ESX cluster. vCenter or later. • Add hosts to the ESX • Brocade Network Advisor (BNA) cluster. 14.2 (SAN System Administrator •...

  • Page 128: Service Template Supported Platforms

    Service Template name Software prerequisites Setup prerequisites host that resides on the datastore: ◦ Make sure that the Storage DRS does not manage the datastore. ◦ Make sure that Storage I/O Control is disabled for the datastore. ◦ Make sure that the datastore is not used by vSphere HA Heartbeating.

  • Page 129: General Settings For Services

    Allocate Fabric Aware Volumes with Configuration Manager This template supports the following platforms: Models with Fibre Channel as the supported interface between host and storage system support XP7 storage. Data mobility service templates This group of service templates include the following: •...

  • Page 130: Allocate Volumes Service Templates

    Settings pane Description Name User-defined name for the service. Preconfigured services have default names. Description User-defined description for the service. Preconfigured services have default descriptions. Status Test or Release. Use Test if the service has not been tested. Tags Use tags to classify services and to help organize them.

  • Page 131: Allocate Fabric Aware Volumes With Configuration Manager: Service Details

    Allocate Fabric Aware Volumes with Configuration Manager: Service details The following service template details apply to the Allocate Fabric Aware Volumes with Configuration Manager service template. Software prerequisites The following software is required to use the Allocate Fabric Aware Volumes with XP7 Configuration Manager service template: •...
  • Page 132 Navigation pane Settings pane Description Volume Settings Configuration Manager Provides a table from which you can Connection choose the Configuration Manager connection. Storage System Provides a table from which you can choose the storage system. Resource Group Specify a resource group. Number of Volumes Specify the number of volumes to make available for the service.
  • Page 133 Navigation pane Settings pane Description Connection Names Specifies which FC switch manager services are used to select a path. The settings of each FC switch manager services must be assigned an Infrastructure Group from the Administration tab. Note: Use a comma when specifying multiple BNAs or DCNMs.
  • Page 134 Navigation pane Settings pane Description Maximum Number of Hops Specify the number of hops used when selecting a path. If "Use Fabric Settings" or "Number of Hops Restriction" is false, this field is ignored even if entered. Zone Settings Update Zone Configurations Determines whether to add to an existing zone or create a new zone.
  • Page 135 Navigation pane Settings pane Description Zone Configurations to Update Lists the zone configuration names to add (separated by commas). If Update Zone Configuration is false, this setting is ignored. Note: An error is generated if this setting is not specified and Update Current Active Zone Configuration is false.
  • Page 136 Navigation pane Settings pane Description Resource Criteria Storage Port Configuration Specify the Storage Port Configuration Expressions (Name and Value) that meets the specified criteria (Equals, Not Equals, Starts with, and Ends with) based on the selected condition (All or Any). Host Settings Port Type Specify fibre as the port type.
  • Page 137 Navigation pane Settings pane Description Target Fabrics Specifies the fabric to use where multiple values are delimited by commas. If omitted, all of the fabrics that FC switch manager services monitors are used. For DCNM, you can specify a VSAN in this field.
  • Page 138 Navigation pane Settings pane Description Use Existing Zone Aliases Determines whether to use existing zone aliases. Specify True to use predefined zone aliases regardless of the specified naming conventions. If you specify False, the system selects zone aliases that follow the naming conventions.
  • Page 139 Zone naming conventions The following table lists the zone naming conventions for use with the Allocate Fabric Aware Volumes with Configuration Manager service template. Type Zone name Zone alias name (Host side/ Storage side) Input One object has the following properties: •...

  • Page 140: Allocate Volumes With Configuration Manager: Service Details

    Allocate Volumes with Configuration Manager: Service details This service enables the allocation of sets of volumes from the associated infrastructure group through Configuration Manager for use by servers running a generic application. The following service template details apply to the Allocate Volumes with Configuration Manager service template.
  • Page 141 Navigation pane Settings pane Description Resource Group Specify the Resource Group. Number of Volumes Specify the number of volumes to make available for the service. If necessary, you can specify a Single Value, Multiple Values, or a Range. LDEV ID Starts From Specify the starting LDEV ID as a hexadecimal number for the volume to allocate.
  • Page 142 Navigation pane Settings Pane Description Volume Capacity Specify the volume capacity in MBs, GBs, or TBs. Pool Provides a table from which you can choose the pool. Volume Label Specify the volume label. LUN Starts from Specify the starting logical unit number assigned to the volume for a host.

  • Page 143: Allocate Like Volumes Service Templates

    Navigation pane Settings Pane Description Volume Capacity Specify the volume capacity in MBs, GBs, or TBs. Pool Provides a table from which you can choose the pool. Volume Label Specify the volume label. LUN Starts from Specify the starting logical unit number assigned to the volume for a host.
  • Page 144 Software prerequisites The following software is required to use the Allocate Like Volumes with Configuration Manager service template: Configuration Manager REST API v8.6.2-00 or later Setup prerequisites Complete the following setup prerequisites if you have not already done so: • Create a Web service connection for the XP7 Configuration Manager REST API.
  • Page 145 Navigation pane Settings pane Description Source Volume Filter Join Type Specify the join type of the source volume filter. Source Volume Specify the source volume. Capacity Specify the capacity of the volumes to create. Number of Volumes Specify the number of volumes to create.
  • Page 146 Navigation pane Settings pane Description Storage System Connection Select the XP7 Configuration Manager REST Web Service Connection. Information such as IP address and credentials is registered in Automation Director to communicate with XP7 Configuration Manager. Storage System Select the storage system. Volume Source Volume Filter Specify the source volume filter.

  • Page 147: Data Mobility Service Templates

    NOTE: Data Mobility service performance is affected by the XP7 Configuration Manager storage access mode setting. We recommend that you use the "fcConnectionMode" setting to obtain higher performance. For details, see "Appendix A. Changing the communication mode of the REST API server" in the HPE XP7 Configuration Manager REST API Reference Guide.
  • Page 148 Software prerequisites The following software is required to use the Allocate Volumes from Virtual Storage Machine service template: XP7 Configuration Manager v8.5.4-00 or later NOTE: To use the Data Mobility services, an administrator must install the XP7 Configuration Manager REST API on each site and register the storage systems by using the Add Web Service Connections option on the Administration tab.
  • Page 149 Navigation pane Settings pane Description Volume Settings Configuration Manager Provides a table from which you Connection: can choose the Configuration Manager connection. Storage System: Provides a table from which you can choose the storage system. Virtual Storage Machine: Specifies the Virtual Storage Machine (VSM) from a pull-down list.
  • Page 150 Navigation pane Settings pane Description Host Group Settings Specifies the parameters needed to create a new Host Group/ iSCSI target. Port: -- Specifies the port of the host group target. WWN Settings: -- Specifies the WWN settings when using the fibre port setting.
  • Page 151 Navigation pane Settings pane Description LDEV ID Starts From: Specifies the starting LDEV ID in hexadecimal format. Volume Capacity: Specifies the volume capacity in MBs, GBs, or TBs. Pool: Provides a table from which you can choose the pool. Volume Label: Specifies the volume label.

  • Page 152: Export Virtual Storage Machine Configuration Across Sites: Service Details

    NOTE: Data Mobility service performance is affected by the XP7 Configuration Manager storage access mode setting. We recommend that you use the "fcConnectionMode" setting to obtain higher performance. For details, see "Appendix A. Changing the communication mode of the REST API server" in the HPE XP7 Configuration Manager REST API Reference Guide.
  • Page 153 Software prerequisites The following software is required to use the Export Virtual Storage Machine Configuration Across Sites service template: XP7 Configuration Manager v8.5.4-00 or later NOTE: To use the Data Mobility services, an administrator must install the XP7 Configuration Manager REST API on each site and register the storage systems by using the Add Web Service Connections option on the Administration tab.

  • Page 154: Create High Availability Pair For Migration: Service Details

    NOTE: Data Mobility service performance is affected by the XP7 Configuration Manager storage access mode setting. We recommend that you use the "fcConnectionMode" setting to obtain higher performance. For details, see "Appendix A. Changing the communication mode of the REST API server" in the HPE XP7 Configuration Manager REST API Reference Guide.
  • Page 155 • Use common resource group names for all VSMs across the Storage Systems used in this service and modify the associated shared service property from Shared Properties Settings pane. • Install XP7 Configuration Manager and register remote storage system information across all systems used by this service.
  • Page 156 Navigation pane Settings pane Description Source Volumes: Provides a table from which you can choose the source volumes. Your selections are shown below the table. Migration Target Settings: Target Configuration Manager Provides a table from which you Connection: can choose the target Configuration Manager connection used for the migration.
  • Page 157 Navigation pane Settings pane Description Host Group Settings: Specifies the parameters needed to create a new Host Group/ iSCSI target. Port: -- Specifies the port of the host group target. WWN Settings: -- Specifies the WWN settings when using the fibre port setting.
  • Page 158 NOTE: Automation Director automatically sets the ALUA attribute as follows for data migration: • P-VOL -- Active/Optimized • S-VOL -- Active/Non-optimized If necessary, you can set the ALUA attribute manually to continue using high availability technology after using this service. Submit Service Request settings The following table lists the Submit Service Request settings for the Create High Availability Pair for Migration service template.
  • Page 159 Navigation pane Settings pane Description Host Settings: Target Host Group/iSCSI Target: Specifies the option of using an existing, or creating a new Target Host Group/iSCSI Target. You can choose an existing target from the provided table or, when creating a new target, you can specify the Host Group Settings depending on the port type you select.

  • Page 160: Migrate Data Using High Availability Pair: Service Details

    NOTE: Data Mobility service performance is affected by the XP7 Configuration Manager storage access mode setting. We recommend that you use the "fcConnectionMode" setting to obtain higher performance. For details, see "Appendix A. Changing the communication mode of the REST API server" in the HPE XP7 Configuration Manager REST API Reference Guide.
  • Page 161 • Install XP7 Configuration Manager and register remote storage system information across all systems used by this service. • Create one web service connection for the XP7 Configuration Manager REST API that uses the same credentials for each storage system managed by the XP7 Configuration Manager REST API. In addition to using the same credentials to access all storage systems, ensure that these credentials are assigned the following roles: ◦...
  • Page 162 Navigation pane Settings pane Description Source Volumes: Provides a table from which you can choose the source volumes. Your selections are shown below the table. Target Configuration Manager Provides a table from which you Connection: can choose the target Configuration Manager connection used for migration.

  • Page 163: Esx Cluster Service Templates

    Navigation pane Settings pane Description Target Storage System: Provides a table from which you can choose the target storage system. Copy Group: Provides a table from which you can choose an existing copy group. ESX cluster service templates The Automation Director ESX cluster service templates are provided with the software and are preconfigured.

  • Page 164: Installing Python And Python Library (Linux Os)

    ◦ From the command line, run the following command to download the library and install it into the Python environment: pip install pyvmomi . ◦ Verify that the library is installed correctly by using the following command: pip list pyvmomi . ◦...

  • Page 165: Allocate Fabric Aware Volumes And Create Datastore For Esx Cluster: Service Details

    ◦ ./configure ◦ make ◦ sudo make install • In the Administration tab of Automation Director, use the Shared Properties Settings to configure the python install path to the shared property of the Python Interpreter Path. 2. Install pyvmomi (Python library for Automation Director to talk with vCenter). •...
  • Page 166 Software prerequisites The following prerequisites are required to use the Allocate Fabric Aware Volumes and Create Datastore for ESX Cluster service template: • Configuration Manager REST API v8.5.3 or later • Brocade Network Advisor (BNA) 14.2 (SAN System Administrator or Zone Administrator role is required) •...
  • Page 167 NOTE: When you use https with Web Service Connections, you must first import certificates for Web Service Connections and import certificates into the Java trust store. Detailed information is provided in the HPE XP7 Automation Director Installation and Configuration Guide. Default Ports...
  • Page 168 Navigation pane Settings pane Description Resource Group Specify the resource group from which resources are used (for example LDEV ID and host group ID). You must specify the resource group for VSM when allocating volumes in VSM. Virtual Model Select the Virtual Model associated with VSM.
  • Page 169 Navigation pane Settings pane Description Host Group Settings Script for Host Group Naming Specify a naming rule for the Host Group name as a script. Host Mode Specify the host mode. Host Mode Options Specify the host mode options. Fabric Settings Use Fabric Settings Determines whether to use fabric information from the FC switch...
  • Page 170 Navigation pane Settings pane Description Script for Zone Naming Enables zone naming using javascript. Script for Host Zone Alias Enables naming of the Host Zone Naming Alias for host WWNs using javascript. Script for Storage Zone Alias Enables naming of the Storage Naming Zone Alias for storage ports using javascript.
  • Page 171 Navigation pane Settings pane Description Target ESX Cluster vCenter Connection Specify a vCenter Server that is registered as a Web Service Connection in the Administration Tab. ESX Cluster Specify the ESX Cluster name. Target Storage Configuration Manager Select the Configuration Manager Connection server which is registered as a Web Service Connection in the...
  • Page 172 Navigation pane Settings pane Description Volume Capacity Specify the volume capacity. Pool Provides a table from which you can choose the pool. Volume Label Specify the volume label. LUN Starts From Specify the starting logical unit number assigned to the volume for a host.
  • Page 173 Navigation pane Settings pane Description Zone Configurations to Update Specify a range of zones in which zones are created when "Update Current Active Zone Config" is False. Interval for each Fabric Settings Specify the wait time in minutes between configuring fabrics. Script for Zone Naming Enables zone naming using javascript.
  • Page 174 Navigation pane Settings pane Description Body Specify the email body. Response Input Dialog Box Specify HTML or text in the Response Entry dialog box. To change a service property value in the Response Entry dialog box, specify the property key for the 'name' attribute of an input tag (<input>) or a select tag (<select>).

  • Page 175: Add Host To Cluster In Vcenter: Service Details

    Type Zone name Zone alias name (Host side/Storage side) If the output string is When the output string is over 60 When the output string is over 64 too long characters, the 61st and subsequent characters or more, the 65th and characters are truncated.
  • Page 176 NOTE: When you use https with Web Service Connections, you must first import certificates for Web Service Connections and import certificates into the Java trust store. Detailed information is provided in the HPE XP7 Automation Director Installation and Configuration Guide. Default Ports...
  • Page 177 Navigation pane Settings pane Description Resource Group Specify the resource group from which resources are used (for example LDEV ID and host group ID). You must specify the resource group for VSM when allocating volumes in VSM. Port Selection Select the storage port selection criteria: •...
  • Page 178 Navigation pane Settings pane Description Maximum Num. of Hops Specify the maximum number of hops when "Num. of Hops Restriction" is set to True. Zone Settings Update Zone Configurations Specify whether to add or create zones. Use Existing Zone Aliases Specify whether to update existing zone alias.
  • Page 179 Navigation pane Settings pane Description Resource Group Specify the resource group from which resources are used (for example LDEV ID and host group ID). You must specify the resource group for VSM when allocating volumes in VSM. Port Selection Select the storage port selection criteria: •...
  • Page 180 Navigation pane Settings pane Description Zone Settings Update Zone Configurations Specify whether to add or create zones. Use Existing Zone Aliases Specify whether to update existing zone alias. Update Current Active Zone Determines whether to use Zone Configuration Active configuration when adding or creating a zone.

  • Page 181: Remove Host From Cluster In Vcenter: Service Details

    Type Zone name Zone alias name (Host side/Storage side) Handling when the Same zone name of the same fabric Same zone alias name of the same output is the same refers to the same zone. fabric refers to the same alias. name In the case of an existing zone: Add In the case of an existing alias: Add...
  • Page 182 NOTE: When you use https to talk with Web Service Connections you must first import certificates for Web Service Connections and import certificates into the Java trust store. Detailed information is provided in the HPE XP7 Automation Director Installation and Configuration Guide. Default Ports...
  • Page 183 Edit Service settings The following table lists the Edit Service settings for the Remove Host from Cluster in vCenter service template. Navigation pane Settings pane Description Target ESX Host vCenter Connection Specify a vCenter Server that is registered as a Web Service Connection in the Administration Tab.
  • Page 184 Navigation pane Settings pane Description Unallocate Settings Delete Host Group Select this option if you want to delete the host group. Remove Zoning Settings Remove Zoning Select this option if you want to remove zoning settings. By default, this checkbox is not selected.

  • Page 185: Servicenow Ticketing Service Templates

    Navigation pane Settings pane Description Unmount Datastore Select this option if you want to unmount the datastore from the ESX host before migrating or shutting down the storage volume. Unallocate Settings Delete Host Group Select this option if you want to delete the host group.
  • Page 186 Software prerequisites ServiceNow version Kingston, London Setup prerequisites Register the ServiceNow Web Service Connection in Automation Director. Default ports Port number Secure communication from Automation Director to ServiceNow. Edit Service settings The following table lists the Edit Service settings for the Call ServiceNow Table API service template. Navigation pane Settings pane Description...

  • Page 187: Create Servicenow Incident Ticket: Service Details

    Navigation pane Settings pane Description ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection. This setting is required. Table Name Specify the table name to execute the API. This setting is required. HTTP Method Specify the method, which is POST, PUT, or GET.
  • Page 188 Navigation pane Settings pane Description ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection. This setting is required. Request Section active Active activity_due Activity due additional_assignee_list Additional assignee list approval Approval approval_history Approval history approval_set Approval set assigned_to...
  • Page 189 Navigation pane Settings pane Description group_list Group list hold_reason On hold reason impact Impact incident_state Incident state location Location made_sla Made SLA notify Notify number Number opened_at Opened opened_by Opened by order Order parent Parent parent_incident Parent incident priority Priority reassignment_count Reassignment count rejection_goto...
  • Page 190 Navigation pane Settings pane Description upon_reject Upon reject urgency Urgency user_input User input variables Variables wf_activity Workflow activity work_end Work end work_start Work start Note Section comments Additional comments comments_and_work_notes Comments and work notes watch_list Watch list work_notes Work notes work_notes_list Work notes list Related Record Section...
  • Page 191 Navigation pane Settings pane Description sysparm_fields Specify the field names you want to return in the response in comma-separated values. The specified value will be encoded before sending a Table API request. sysparm_input_display_value Whether to set the input values as the display value or as the actual value.
  • Page 192 Navigation pane Settings pane Description approval_set Approval set assigned_to Assigned to assignment_group Assignment group business_duration Business duration business_service Business service business_stc Business resolve time calendar_duration Duration calendar_stc Resolve time caller_id Caller category Category child_incidents Child incidents closed_at Closed closed_by Closed by cmdb_ci Configuration item company...
  • Page 193 Navigation pane Settings pane Description opened_at Opened opened_by Opened by order Order parent Parent parent_incident Parent incident priority Priority reassignment_count Reassignment count rejection_goto Rejection goto reopen_count Reopen count reopened_by Last reopened by reopened_time Reopened time severity Severity short_description Short description sla_due SLA due state...
  • Page 194 Navigation pane Settings pane Description Note Section comments Additional comments comments_and_work_notes Comments and work notes watch_list Watch list work_notes Work notes work_notes_list Work notes list Related Record Section caused_by Caused by Change problem_id Problem Change Request Resolution Information Section close_code Resolution code close_notes Resolution notes...

  • Page 195: Update Servicenow Incident Ticket: Service Details

    Navigation pane Settings pane Description sysparm_input_display_value Whether to set the input values as the display value or as the actual value. • false: Actual value • true: Display value sysparm_suppress_auto_sys_fiel Whether to suppress auto generation of System field. • false: Do not suppress •...
  • Page 196 Navigation pane Settings pane Description ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection. This setting is required. sys_id Specify the system ID (sys_id) of the ticket. This setting is required. Request Section active Active activity_due Activity due...
  • Page 197 Navigation pane Settings pane Description escalation Escalation expected_start Expected start follow_up Follow up group_list Group list hold_reason On hold reason impact Impact incident_state Incident state location Location made_sla Made SLA notify Notify number Number opened_at Opened opened_by Opened by order Order parent Parent...
  • Page 198 Navigation pane Settings pane Description sys_updated_on Updated time_worked Time worked upon_approval Upon approval upon_reject Upon reject urgency Urgency user_input User input variables Variables wf_activity Workflow activity work_end Work end work_start Work start Note Section comments Additional comments comments_and_work_notes Comments and work notes watch_list Watch list work_notes...
  • Page 199 Navigation pane Settings pane Description sysparm_exclude_reference_link Whether to add detailed information for the reference field. • false: Do not add • true: Add sysparm_fields Specify the field names you want to return in the response in comma-separated values. The specified value will be encoded before sending a Table API request.
  • Page 200 Navigation pane Settings pane Description ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection. This setting is required. sys_id Specify the system ID (sys_id) of the ticket. This setting is required. Request Section active Active activity_due Activity due...
  • Page 201 Navigation pane Settings pane Description escalation Escalation expected_start Expected start follow_up Follow up group_list Group list hold_reason On hold reason impact Impact incident_state Incident state location Location made_sla Made SLA notify Notify number Number opened_at Opened opened_by Opened by order Order parent Parent...
  • Page 202 Navigation pane Settings pane Description sys_updated_on Updated time_worked Time worked upon_approval Upon approval upon_reject Upon reject urgency Urgency user_input User input variables Variables wf_activity Workflow activity work_end Work end work_start Work start Note Section comments Additional comments comments_and_work_notes Comments and work notes watch_list Watch list work_notes...

  • Page 203: Retrieve Servicenow Incident Tickets: Service Details

    Navigation pane Settings pane Description sysparm_exclude_reference_link Whether to add detailed information for the reference field. • false: Do not add • true: Add sysparm_fields Specify the field names you want to return in the response in comma-separated values. The specified value will be encoded before sending a Table API request.
  • Page 204 Software prerequisites ServiceNow version Kingston, London Setup prerequisites Register the ServiceNow Web Service Connection in Automation Director. Default ports Port number Secure communication from Automation Director to ServiceNow. Edit Service settings The following table lists the Edit Service settings for the Retrieve ServiceNow Incident Tickets service template.
  • Page 205 Navigation pane Settings pane Description sysparm_fields Specify the field names you want to return in the response in comma-separated values. The specified value will be encoded before sending a Table API request. sysparm_view A parameter that renders the response according to the specified UI view.
  • Page 206 Submit Service settings The following table lists the submit Service settings for the Retrieve ServiceNow Incident Tickets service template. Navigation pane Settings pane Description ServiceNow ServiceNow Connection Name Specify the ServiceNow connection name registered in the Web Service Connection. This setting is required. sys_id Specify the system ID (sys_id) of the ticket to retrieve information...

  • Page 207: Task Settings For Services

    Navigation pane Settings pane Description sysparm_query Specify the query string that filters the response data. The specified value will be encoded before sending a Table API request. (Only for multiple information acquisition) sysparm_suppress_pagination_h Whether to suppress the eader pagination header. (Only when acquiring multiple pieces of information.) •...

  • Page 208: Additional Service Templates

    Additional service templates Automation Director provides the following types of additional templates: • Service templates that are provided with the product by default, but do not have an associated service. • Service templates that are provided with the product, but are not imported by default and do not have an associated service.

  • Page 209: Modify Virtual Machine Configuration: Service Details

    Migrate Virtual Machine Migrates multiple virtual servers in a VMware vSphere environment. Stop Virtual Machine Stops multiple virtual servers in a VMware vSphere environment. Start Virtual Machine Starts multiple virtual servers in a VMware vSphere environment. Restart Virtual Machine Restarts multiple virtual servers in a VMware vSphere environment. Create Snapshot of Virtual Machine Creates a snapshot of the virtual machine for updating the status of a virtual server.
  • Page 210 NOTE: The maximum number of characters that you can specify for the virtual server name property (vmware.vmName) is 60. Service Definition Properties The following table lists the properties shown in the Edit Service window for the Modify Virtual Machine Configuration service template. Property Key Property Name Description...
  • Page 211 Property Key Property Name Description Required or optional UserResponsePlugin.to TO addresses Specify the email Address addresses to enter in the TO field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB UserResponsePlugin.cc CC addresses...
  • Page 212 Property Key Property Name Description Required or optional UserResponsePlugin.dia Additional dialog box Enter additional text to logText text appear in the response input dialog box, in text or HTML format. Supported HTML tags are anchor tags, bold tags, break tags, font tags, italics tags, and underline tags.
  • Page 213 Property Key Property Name Description Required or optional vmware.vmName Virtual server name Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS.
  • Page 214 Property Key Property Name Description Required or optional vmware.memReservatio Memory reservation Specifies, in megabyte, (MB) the Memory resources that are reserved by the virtual server. vmware.memLimitMB Memory limit (MB) Specifies, in megabyte, the maximum memory resources that are to be used by the virtual server.

  • Page 215: Clone Virtual Machine: Service Details

    Usage guidelines • Do not run multiple instances of this service on the same virtual server. • If you specify HTML tags in UserResponseplugin.dialogText, the permitted tags and attributes are the same as those for the user-response wait plug-in. • For VMware vCenter Server 5.0 or later, set the number of cores per socket to 1 on the target virtual server.
  • Page 216 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 217 Property Key Property Name Description Required or optional UserResponsePlugin.cc CC addresses Specify the email Address addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB UserResponsePlugin.bc BCC addresses...
  • Page 218 Property Key Property Name Description Required or optional UserResponsePlugin.res Response timeout time Specify how long (in ponseTimeOut (minutes) minutes) the service waits for a user response before timing out. In the event of a response timeout, the service will terminate abnormally.
  • Page 219 Property Key Property Name Description Required or optional vmware.vmHostName ESX server name Specify the ESX server name visible in the Hosts and Clusters inventory view managed by VMware vCenter Server, which serves as the cloning destination. vmware.dataStoreName Datastore name Specify the name of a data store as the cloning destination.

  • Page 220: Delete Cloned Virtual Machine: Service Details

    • Virtual server to be cloned -- Virtual server managed by vCenter server or VMware vSphere ESXi (or VMware ESX Server). • Clone -- Clone of the virtual server to be cloned. The clone name is the name of the virtual server clone.
  • Page 221 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 222 Property Key Property Name Description Required or optional vmware.vmName Name of a virtual server Specifies name of virtual as the cloning source server of clone source (display name of virtual server in VMware vCenter Server, not host name in OS). Specify this name for confirmation to prevent clone source from being...

  • Page 223: Delete Datastore On Vmware Vsphere: Service Details

    Delete Datastore on VMware vSphere: Service details The general steps for using this service template to delete a Datastore on VMware vSphere are as follows: 1. From the vCenter control server, perform data store deletion processing on an ESX server. 2.
  • Page 224 Property Key Property Name Description Required or optional vmware.vCenterServerN VMware vCenter server Specify the host name or name IP address of the VMware vCenter server. You cannot specify an IPv6 address. vmware.userName User name for VMware Specify the user name to vCenter Server use when connecting to connection...
  • Page 225 Property Key Property Name Description Required or optional hdvm.hdvmArrayFamily Storage system family Use this property to Text name (custom option) specify a storage system family name that is not included in the selection list for the hdvm.hdvmArrayFamily property. This property takes precedence over hdvm.hdvmArrayFamily property.

  • Page 226: Migrate Virtual Machine: Service Details

    Property Key Property Name Description Required or optional vmware.vmHostName ESX server name Specify the ESX server name to be visible in the Hosts and Clusters inventory view managed by VMware vCenter server. vmware.dataStoreName Datastore name Specify the datastore name. NOTE: Although some of the properties in the tables indicate that they can be omitted, they may be required when used in conjunction with some other property setting as indicated in the descriptions.
  • Page 227 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 228 Property Key Property Name Description Required or optional vmware.foreachVmNam Virtual server name(s) Specify the virtual server name or names. Specify server names as they appear in VMware vCenter Server, not by host name. Separate multiple virtual servers with commas. The maximum number of virtual servers you can specify is 99.

  • Page 229: Stop Virtual Machine: Service Details

    • The virtualization software that runs the virtual servers must be running. • The virtual server name, cluster name, vApp name, and resource pool name must be unique within the vCenter Server. NOTE: The same name cannot be assigned to more than one virtual server, cluster, vApp, and resource pool although their types are different, such as a duplication of a cluster name and a vApp name or a duplication of a cluster name and a resource pool name.
  • Page 230 Property Key Property Name Description Required or optional vmware.userName User name for VMware Specify the user name to vCenter Server use when connecting to connection the VMware vCenter server. vmware.password Password for VMware Specify the password to vCenter Server use when connecting to connection the VMware vCenter server.

  • Page 231: Start Virtual Machine: Service Details

    Property Key Property Name Description Required or optional vmware.foreachVmNam Virtual server name(s) Specify the virtual server name or names. Specify server names as they appear in VMware vCenter Server, not by host name. Separate multiple virtual servers with commas. The maximum number of virtual servers you can specify is 99.
  • Page 232 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 233 Property Key Property Name Description Required or optional vmware.checkPowerStat Power status check Specify the interval at eInterval interval which the service attempts to acquire the power status to confirm that the virtual server has started. common.icmpEchoTime Timeout period for ICMP Specify in milliseconds echo requests how long the service...

  • Page 234: Restart Virtual Machine: Service Details

    • vCenter server -- This is a server on which VMware vCenter Server is installed. • vCenter control server -- This is a server on which VMware vSphere PowerCLI is installed. • Virtual server -- This is a virtual server managed by the vCenter server and VMware vSphere ESX. Usage guidelines •...
  • Page 235 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 236 Property Key Property Name Description Required or optional vmware.checkPowerStat Power status check Specifies the interval in eInterval interval seconds for checking the power status when confirming that the virtual server is stopped or started. common.icmpEchoTime Timeout period for ICMP Specify in milliseconds echo requests how long the service waits for a reply to an...

  • Page 237: Create Snapshot Of Virtual Machine: Service Details

    • vCenter server -- This is a server on which VMware vCenter Server is installed. • vCenter control server -- This is a server on which VMware vSphere PowerCLI is installed. • Virtual server -- This is a virtual server managed by the vCenter server and VMware vSphere ESX. Usage guidelines •...
  • Page 238 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 239 Property Key Property Name Description Required or optional UserResponsePlugin.cc CC addresses Specify the email Address addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB UserResponsePlugin.bc BCC addresses...
  • Page 240 Property Key Property Name Description Required or optional UserResponsePlugin.dia Additional dialog box Enter additional text to logText text appear in the response input dialog box, in text or HTML format. Supported HTML tags are anchor tags, bold tags, break tags, font tags, italics tags, and underline tags.

  • Page 241: Add Virtual Disk To Virtual Machine: Service Details

    • vCenter server -- This is a server on which VMware vCenter Server is installed. • vCenter control server --This is a server on which VMware vSphere PowerCLI is installed. • Virtual server -- This is a virtual server managed by the vCenter server and VMware vSphere ESX. Usage guidelines •...
  • Page 242 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 243 Property Key Property Name Description Required or optional UserResponsePlugin.cc CC addresses Specify the email Address addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB UserResponsePlugin.bc BCC addresses...
  • Page 244 Property Key Property Name Description Required or optional UserResponsePlugin.res Response timeout time Specify how long (in ponseTimeOut (minutes) minutes) the service waits for a user response before timing out. In the event of a response timeout, the service will terminate abnormally.
  • Page 245 Property Key Property Name Description Required or optional vmware.capacity Volume size (GB) Specify the volume size in GB. This property is mandatory when "Flat" is specified as the virtual disk type. This property is ignored when the virtual disk type is "RawVirtual"...

  • Page 246: Remove Virtual Disk From Virtual Machine: Service Details

    Server requirements To use this service template, the following servers are required: • vCenter server -- This is a server on which VMware vCenter Server is installed. • vCenter control server -- This is a server on which VMware vSphere PowerCLI is installed. •...
  • Page 247 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 248 Property Key Property Name Description Required or optional UserResponsePlugin.cc CC addresses Specify the email Address addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB UserResponsePlugin.bc BCC addresses...
  • Page 249 Property Key Property Name Description Required or optional UserResponsePlugin.res Response timeout time Specify how long (in ponseTimeOut (minutes) minutes) the service waits for a user response before timing out. In the event of a response timeout, the service will terminate abnormally.

  • Page 250: Delete Virtual Machine: Service Details

    Server requirements To use this service template, the following servers are required: • vCenter server -- This is a server on which VMware vCenter Server is installed. • vCenter control server -- This is a server on which VMware vSphere PowerCLI is installed. •...
  • Page 251 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 252 Property Key Property Name Description Required or optional UserResponsePlugin.cc CC addresses Specify the email Address addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB UserResponsePlugin.bc BCC addresses...
  • Page 253 Property Key Property Name Description Required or optional UserResponsePlugin.res Response timeout time Specify how long (in ponseTimeOut (minutes) minutes) the service waits for a user response before timing out. In the event of a response timeout, the service will terminate abnormally.

  • Page 254: Deploy And Setup Os On Virtual Machine: Service Details

    • vCenter server -- This is a server on which VMware vCenter Server is installed. • vCenter control server --This is a server on which VMware vSphere PowerCLI is installed. • Virtual server -- This is a virtual server managed by the vCenter server and VMware vSphere ESX. Usage guidelines •...
  • Page 255 • An organization name and an owner name are required. If no organization name is specified, "Organization" is assumed; if no owner name is specified, "Owner" is assumed. • Entry and re-entry of an OS user password are required. If one of them is omitted or if the entered passwords do not match, "Password123"...
  • Page 256 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 257 Property Key Property Name Description Required or optional OS.selectWorkgroupDo Select workgroup or Specify whether the main domain : virtual server belongs to a workgroup or domain Windows only (Windows-based OS only). OS.workgroupNameDo Workgroup/domain Specify the name of the mainName name workgroup or domain of virtual server.
  • Page 258 Property Key Property Name Description Required or optional OS.dnsMan DNS server IP address Specify the IP address (management LAN) of the DNS server for the management LAN of the virtual server. You cannot specify an IPv6 address. OS.subnetMask2 Subnet mask (for Specify the 2nd subnet second NIC) mask for the virtual...
  • Page 259 Property Key Property Name Description Required or optional OS.defaultGW4 Default gateway (for Specifies the default fourth NIC) gateway that is set for the fourth NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. OS.dns4 DNS server IP address Specifies the IP address (for fourth NIC) of the DNS server that is...
  • Page 260 Property Key Property Name Description Required or optional vmware.vmName Virtual server name Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS.
  • Page 261 Property Key Property Name Description Required or optional OS.osUserPassword Administrator password: Specifies the Windows-specific Administrator password specified in the OS (Windows-based OS systems only). If nothing is entered, "Password123" is specified. OS.osUserPasswordRe Re-enter Administrator Re-enter the Enter password: Windows- Administrator password specific specified in the OS (Windows-based OS...
  • Page 262 Property Key Property Name Description Required or optional OS.ipAddress4 IP address (for fourth Specifies the IP address NIC) that is set for the fourth NIC recognized by the OS on the virtual server. IPv6 addresses are not supported. OS.timeZoneWin Time zone: Windows- Specifies the time zone based OS setting that the OS on the virtual...
  • Page 263 ◦ NICs are configured (up to two). ◦ The reception of and response to pings is allowed. ◦ For a Windows-based OS, the administrator password is left blank. ◦ For a Windows-based OS, run sysprep. To run sysprep, the maximum number of Windows-based OS initializations (three times) must not be reached.

  • Page 264: Get List Of Virtual Machines From Vmware Vsphere: Service Details

    • Do not specify in advance any template information that is specified when the virtual server is created. If a computer name or host name and IP address are already set in the template, virtual server creation might fail. If virtual server creation fails (for example, static route processing results in an error), delete the virtual server, re-create a template in which no computer name, host name, or IP address is set, and then run the service again.
  • Page 265 Property Key Property Name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 266 Property Key Property Name Description Required or optional vmware.vmHostName ESX server name Specify the ESX server name to show in the Hosts and Clusters inventory view managed by VMware vCenter server. vmware.listOutputFileNa Output file name Specifies the full path meRemote (remote) name of the temporary file to output virtual...

  • Page 267: Pre-Check For Os Deployment On Virtual Machine: Service Details

    Pre-check for OS Deployment on Virtual Machine: Service details The general steps for using this service template to perform a precheck for an OS deployment on a Virtual Machine are as follows: 1. Checks whether a connection can be established from the vCenter control server to a vCenter server. 2.
  • Page 268 Property Key Property Name Description Required or optional vmware.userName User name for VMware Specify the user name to vCenter Server use when connecting to connection the VMware vCenter server. vmware.password Password for VMware Specify the password to vCenter Server use when connecting to connection the VMware vCenter server.
  • Page 269 Property Key Property Name Description Required or optional vmware.vmHostName ESX server name Specify the ESX server name visible in the Hosts and Clusters inventory view managed by VMware vCenter server. vmware.dataStoreName Datastore name Specify the datastore name. vmware.resourcePoolNa Resource pool name Specify the resource pool, vApp, or cluster where the virtual server...

  • Page 270: Script Execution Through The Vcenter Server: Service Details

    ◦ Resource pool name. ◦ vApp name. • Conditions for the template used for deployment: ◦ VMware Tools are installed. ◦ The running of remote commands is allowed by the settings (administrative share for Windows- based OS and SSH for Linux OS is enabled.) ◦...
  • Page 271 Windows batch file (extension .bat): "& 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest-property)' 'script-argument-(vmware.scriptParameter-property)' ; exit $LASTEXITCODE" Windows PowerShell script (extension .ps1): "Set-ExecutionPolicy RemoteSigned -Scope Process ; & 'script-file-path-on- the-guest-OS-(vmware.scriptFileOnGuest-property)' 'script-argument- (vmware.scriptParameter-property)' ; exit $LASTEXITCODE" Shell script (extension .sh): "/bin/bash 'script-file-path-on-the-guest-OS-(vmware.scriptFileOnGuest- property)' 'script-argument-(vmware.scriptParameter-property)' " The standard output and standard error output of each script run on the virtual server is stored in the file on the target server that is specified as the output file path (vmware.scriptOutputFilePath property) of the script.
  • Page 272 ◦ Virtual servers must have a unique name. ◦ Server names are case-sensitive in VMware, but not in the vSphere PowerCLI instance run from this plug-in. • Conditions related to the virtual server: ◦ The virtual server must be running. ◦...
  • Page 273 Property key Property name Description Required or optional vmware.targetHost Host name of VMware Specify the host name or vCenter control server IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.
  • Page 274 Property key Property name Description Required or optional vmware.vmName Virtual server name Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS.

  • Page 275: Os Service Templates

    Property key Property name Description Required or optional vmware.scriptOutputFile Script output file path Specify the full path of Path the file on the VMware vCenter control server in which the standard output and standard error output of the script are stored. vmware.deleteScriptEna Whether to delete the Specify whether to...
  • Page 276 Property Key Property Name Description Required OS.targetHost Windows/Unix server Specify the host name or host name IP address of a Windows-based OS or Unix OS server from which an OS user list is to be obtained. IPv6 addresses are not supported.

  • Page 277: Get Lists Of Users From Multiple Servers: Service Details

    Get Lists of Users from Multiple Servers: Service details The general steps for using this service template to get a list of users from multiple servers are as follows: 1. A list of Windows-based OS or Unix OS servers is obtained from the specified column in the CSV file. State the column name in the first line of the CSV file.
  • Page 278 Property Key Property Name Description Required or optional OS.fileOpenRetryCount Retry count for reading a Specifies the number of file: Windows specific times to retry when reading a file fails (only applicable to Windows- based OS). This value multiplied by the retry interval gives the maximum waiting time.
  • Page 279 Property Key Property Name Description Required or optional OS.listOutputDirectoryN Output directory for Unix Specifies the full path of ameRemote_Linux (remote) the folder on the Unix OS server where the list of OS users is output. The remote file is deleted after the transfer.

  • Page 280: Execute Remote Command: Service Details

    Execute Remote Command: Service details Service Definition Properties The following table lists the properties shown in the Service Definition and Submit Service windows for the Execute Remote Command service template. Property Key Property Name Description Required or optional common.targetHost Host name of target Specifies the host name server or IP address of the...

  • Page 281: Windows Update Program Installation: Service Details

    Server requirements To use this service template, the following servers are required: Target server -- This is the server on which a supported version of Windows-based OS or UNIX OS is installed. The commands must already be stored on the server. Windows update program installation: Service details This service uses a list of target machines for which the OS update is required (referred to as the OS update information file, which is a CSV or Excel file.)
  • Page 282 • N-th column: Update target server: Specify an IP address or host name. When specifying an IP address, do not specify an IPv6 address. Specify a column number (N) for the property OS.updateServerInfoColumn. • M-th column: Exceptions list: Specify the numbers corresponding to the update programs that you do not want to install.
  • Page 283 Prerequisites • The update target server is running. • The update target server can access the website that allows Windows Update to run from Internet Explorer (without using a proxy server.) • The Windows Update service is running. • An OS update information file containing the following information is stored on the local server: ◦...
  • Page 284 ◦ The first character of the key value column name must not be a number (one-byte or two-byte) or any of the following symbols:! " # $ % & ' ( ) - = ^ ~ \ | ` ; + * [ ] { } , . < > ? _ / ◦...
  • Page 285 • For the number of the column to read, specify an integer no greater than 255 (or the task terminates abnormally). Note that empty columns after the first non-empty column and before the last non-empty column are counted as ordinary columns. •...
  • Page 286 Property key Property name Description Required windows.targetHost Host name of the update Specify the host name or information file server IP address of the Windows-based OS server on which the OS update information file is stored. IPv6 addresses are not supported. OS.fileOpenRetryCount Retry count for reading a Specifies the number of...

  • Page 287: Openstack Service Templates

    Property key Property name Description Required OS.updateServerInfoCol Execution target server Specify the number of column number the column that specifies the update target server in the OS update information file. Specify an integer in the range from 1 to 255. OS.updateExcludeListC Exceptions list column Specify the number of...

  • Page 288: Addition Of A Virtual Server (Deployment/Os Initial Setup): Service Details

    Obtain a virtual server information list Acquires an instance information list contained in the specified project in a KVM environment that is controlled by OpenStack. Addition of a virtual server (deployment/OS initial setup): Service details The general steps for using this service template to add a virtual server are as follows: 1.
  • Page 289 a. The server image, instance name, instance type, and networks (for management and job execution) are specified. Optionally, key pairs and security groups can also be specified. b. The OpenStack DHCP function is used to assign an IP address dynamically during OS startup. c.
  • Page 290 ◦ America/Monterrey ◦ America/Montevideo ◦ America/New_York ◦ America/Nome ◦ America/North_Dakota/Beulah ◦ America/North_Dakota/Center ◦ America/North_Dakota/New_Salem ◦ America/Phoenix ◦ America/Shiprock ◦ America/Tijuana ◦ America/Vancouver ◦ America/Yakutat ◦ Asia/Chongqing ◦ Asia/Hong_Kong ◦ Asia/Kolkata ◦ Asia/Macau ◦ Asia/Shanghai ◦ Asia/Singapore ◦ Asia/Tokyo ◦ Etc/UTC ◦...
  • Page 291 Property Key Property Name Description Required openstack.targetHost Host name of the Specify the host name or OpenStack control IP address of the server OpenStack control server. Make sure that you do not specify an IPv6 address. openstack.identityServer Host name of the Specify the host name or HostName Identity server...
  • Page 292 Property Key Property Name Description Required openstack.checkInstanc Instance status check Specify in seconds the eStateInterval interval interval at which to check the instance status to see whether the instance has been started. openstack.checkOSStat OS startup wait time Specify in seconds the eWaittime maximum wait time for checking startup of OS.
  • Page 293 Property Key Property Name Description Required OS.dnsSuffix DNS suffix name Specify the DNS suffix name. openstack.floatingIpOpti Whether to allocate a Specify whether to floating IP address allocate a floating IP address to the instance. If you want to allocate a floating IP address to the instance, select "yes".

  • Page 294: Add Virtual Server (Virtual Disk): Service Details

    ◦ To use an internal network for communication between the local server and an instance, you must first register the certificate information for the IP address to be assigned from the IP address pool to the instance. Make sure the IP address is registered for the agentless connection-destination definition in the [Management] tab.
  • Page 295 NOTE: During the creation of a new volume, a volume status check is performed based on the number of times specified by the property openstack.checkVolumeCreationCount, at intervals specified (in seconds) by the property openstack.checkVolumeCreationInterval. You can adjust the values of these properties based on your environmental requirements.
  • Page 296 Property Key Property Name Description Required or optional openstack.checkVolume Volume creation check Specify the number of CreationCount count times to check whether a volume has been created. This value and the volume creation check interval determine the maximum wait time. openstack.checkVolume Volume creation check Specify in seconds the...
  • Page 297 Property Key Property Name Description Required or optional openstack.volumeType Volume type Specify the type of volume. Specify one of the types set in the OpenStack environment. If a volume is not created, the specified volume type is ignored. openstack.volumeCapac Volume capacity (GB) Specify the capacity of a volume (in GB).

  • Page 298: Back Up Volumes: Service Details

    • If the property openstack.createVolumeEnabled is set to "yes", you cannot omit the property openstack.volumeCapacity. If you omit the property openstack.volumeCapacity, the task ends abnormally. • The maximum length of a character string that can be specified for an input property might be different from that of a character string that can be registered in OpenStack.
  • Page 299 a. Date and time when the backup was created (Header name: Backup time, format: yyyy/MM/dd HH:mm:ss). b. Project name (Header name: Project name). c. Instance name (Header name: Instance name). d. Volume ID (Header name: Volume ID). e. Volume name (Header name: Volume name). f.
  • Page 300 Property Key Property Name Description Required or optional openstack.portNumber Port number for Specify the port number connecting to the for logging on to the Identity server Identity server. openstack.projectName Project name Specify the project name. openstack.tempVolume Temporary volume name Specify the name of the Name temporary volume created during the...
  • Page 301 Property Key Property Name Description Required or optional common.encodeType Encoding type Specify the encoding type used for email notifications. Specifiable encoding names are us- ascii, iso-2022-jp, shift_jis, euc-jp, or utf-8. If specification is omitted, utf-8 is used. openstack.checkVolume Temporary-volume Specify the number of CreationCount creation check count times the check for...
  • Page 302 Service Definition and Submit Service Properties The following table lists the properties shown in the Service Definition and Submit Service windows for the Back Up Volumes service template. Property Key Property Name Description Required or optional openstack.containerNam Container name Specify the name of the container in which to store backups.

  • Page 303: Delete A Virtual Server: Service Details

    Usage guidelines • Make sure to specify either the instance name or volume name. If you do not specify either, the task ends abnormally. • This service can be run for an instance that is currently running. In such a case, if an I/O operation is performed on the guest OS, inconsistencies between the guest OS and the backup might occur.
  • Page 304 Property Key Property Name Description Required or optional openstack.targetHost Host name of the Specify the host name or OpenStack control IP address of the server OpenStack control server. Make sure that you do not specify an IPv6 address. openstack.identityServer Host name of the Specify the host name or HostName Identity server...

  • Page 305: Delete A Virtual Server (Virtual Disk): Service Details

    Property Key Property Name Description Required or optional openstack.instanceNam Instance name Specify the instance name. Note that the name you specify here is the display name of the instance in OpenStack, and is different from a host name in the OS. NOTE: Although some of the properties in the tables indicate that they can be omitted, they may be required when used in conjunction with some other property setting as indicated in the descriptions.
  • Page 306 NOTE: When volumes are disconnected, this service template waits the number of seconds that has been specified for the openstack.checkVolumeDetachmentInterval property, and then repeats the action to check the status of the volumes the number of times that is specified for the openstack.checkVolumeDetachmentCount property.
  • Page 307 Property Key Property Name Description Required or optional openstack.checkVolume Volume disconnection Specify the number of DetachmentCount check count times to check whether a volume has been disconnected. This value and the volume disconnection check interval determine the maximum wait time. openstack.checkVolume Volume disconnection Specify in seconds the...

  • Page 308: Start Virtual Server: Service Details

    • Each instance name must be unique in a single project. • Each volume name must be unique in a single project. Server requirements To use this service template, the following servers are required: • OpenStack server -- A server on which OpenStack is installed. •...
  • Page 309 Property Key Property Name Description Required or optional openstack.targetHost Host name of the Specify the host name or OpenStack control IP address of the server OpenStack control server. Make sure that you do not specify an IPv6 address. openstack.identityServer Host name of the Specify the host name or HostName Identity server...
  • Page 310 Property Key Property Name Description Required or optional openstack.checkInstanc Instance status (started) Specify the number of eStateEnabledCount check count times to check whether the startup of an instance has been completed. This value and the instance status (started) check interval determine the maximum wait time.

  • Page 311: Obtain A Virtual Server Information List: Service Details

    • If the network connection check is enabled, the firewall of the target virtual server must permit ICMP (ECHO) replies. • If the network connection check is enabled, the local server (the loopback address that can be resolved from the name "localhost") must be set as the connection destination for agentless monitoring.
  • Page 312 • Instance memory capacity (MB) (header name: MemoryMB) • Instance disk size (GB) (header name: TotalDiskOfFlavorGB) • Flavor name (header name: FlavorName). NOTE: The numbers of instance CPUs, instance memory capacity (MB), and instance disk size (GB) are flavor information that was specified when the instance started. Service Definition Properties The following table lists the properties shown in the Service Definition window for the Obtain a virtual server information list service template.

  • Page 313: Aws Service Templates

    Property Key Property Name Description Required or optional openstack.listOutputFile Output file name Specify the name of the NameRemote (remote) temporary file that is used when instance information is output to an OpenStack control server by using a full path. openstack.listOutputFile Output file name (local) Using a full path, specify NameLocal...

  • Page 314: Add A Virtual Server (Deploy): Service Details

    Delete a virtual server Deletes an instance from an Amazon EC2 environment. In addition, all network interfaces connected to the instance are deleted. Start virtual servers Starts instances in an Amazon EC2 environment. Stop virtual servers Stops instances in an Amazon EC2 environment. Add a virtual server (deploy): Service details The processing overview is as follows: 1.
  • Page 315 ◦ First private IP address (aws.privateIpAddress1 property) ◦ Second private IP address (aws.privateIpAddress2 property) • If starting an instance ends abnormally with the return value of 1 (/awsCreateVM step), the started instance remains. If starting an instance abnormally ends with the return value of 2, the created network interface remains in addition to the started instance.
  • Page 316 Property key Property name Description Required or optional aws.checkInstanceEnabl Instance status (started) Specify the number of edCount check count times to check for instance start. The maximum waiting time is determined by combining this count and the instance status (started) check interval. This property is also used to check the completion of adding...
  • Page 317 Property key Property name Description Required or optional aws.amiId AMI ID Specify an AMI ID used for instance start. aws.instanceType Instance type Specify an instance type used for instance start. aws.keyPairName Key pair name Specify a key pair name used for the instance. If this property is omitted, no key pair name is set for the instance.

  • Page 318: Delete A Virtual Server: Service Details

    Property key Property name Description Required or optional aws.subnetId2 Subnet ID 2 Specify the ID of the subnet that indicates the range of the second private IP address assigned to the instance. This property is required when the second IP address is set.
  • Page 319 Usage guidelines • An instance is deleted even if a user logs in to the instance. • The deleted instance is visible on the console for a specific duration, and you can obtain the status. However, you can no longer start the instance. •...

  • Page 320: Start Virtual Servers: Service Details

    Property key Property name Description Required or optional aws.checkInstanceDeleti Instance status (deleted) Specify the number of onCount check count times to check for instance deletion. The maximum waiting time is determined by combining this count and the instance status (deleted) check interval. This property is also used to check the completion of deleting...

  • Page 321: Stop Virtual Servers: Settings

    Property key Property name Description Required or optional aws.targetHost Host name of the AWS Specify the host name or control server IP address of the AWS control server. IPv6 address is not supported. aws.accessKeyId Access key ID Specify the access key ID for connecting to AWS.
  • Page 322 NOTE: To stop an instance, wait for the seconds specified in the aws.checkInstanceDisabledInterval property that indicates the interval for checking the completion of stopping an instance, and then repeat the number of times specified in the aws.checkInstanceDisabledCount property that indicates how many checks are performed for the completion of stopping the instance.

  • Page 323: Hyper-V 2012 Service Templates

    Property key Property name Description Required or optional aws.checkInstanceDisab Instance status Specify the number of ledCount (stopped) check count times to check for instance stop. The maximum waiting time is determined by combining this count and the instance status (stopped) check interval. aws.checkInstanceDisab Instance status Specify the interval (in...

  • Page 324: Add A Virtual Server (Deploy/Os Initial Settings): Service Details

    Restart virtual server This service template restarts multiple virtual servers in a Hyper-V 2012 environment. Obtain virtual server information list This service template obtains a list of information about virtual servers in a Hyper-V 2012 environment. Add a virtual server (deploy/OS initial settings): Service details The processing overview is as follows: 1.
  • Page 325 • When only one NIC is installed on the virtual server, the IP address to be set for the NIC is determined based on the following priority: IP address for management > second IP address > third IP address > fourth IP address. Among the specified IP addresses, only the one with the highest priority is set and the others are discarded.
  • Page 326 – IP address – Subnet mask – Default gateway – Preferred DNS server – Alternate DNS server ◦ The OS settings must have been initialized by using Sysprep. ◦ Also, the following conditions must be satisfied: – Enter System Out of Box Experience (OOBE) is selected from the System Cleanup Action list.
  • Page 327 A virtual server and its full set of configuration files • Container server A server that contains an exported virtual server to replicate Usage guidelines • If no virtual switch is specified, the connection-destination virtual switch information of the relevant NIC is deleted.
  • Page 328 of the system disk differs from the location specified for that property, a search for the system disk takes place. In this case, therefore, a longer time might be required to complete deployment. • If the OS of the virtual server is Windows Server 2012 or Windows Server 2012 R2, the system waits for initial OS setup to finish.
  • Page 329 • Specifiable locales are as follows: ◦ ja-JP ◦ en-US ◦ zh-CN • Specifiable OS names are as follows: ◦ Windows Server 2008 x86 ◦ Windows Server 2008 x64 ◦ Windows Server 2008 R2 ◦ Windows Server 2012 ◦ Windows Server 2012 R2 Service Definition Properties The following table lists the properties shown in the Service Definition window.
  • Page 330 Property key Property name Description Required OS.selectWorkgroupDo Select workgroup/ Select which type of main domain entity you want the virtual server to belong to: workgroup or domain. OS.workgroupNameDo Workgroup/domain Specify the name of the mainName name workgroup or domain that the virtual server belongs to.
  • Page 331 Property key Property name Description Required OS.dnsMan DNS server IP address Specify the IP address (management LAN) of the DNS server connected to the management LAN to be set on the virtual server. Do not specify an IPv6 address. hyperv.virtualSwitchMan Virtual switch name (for Specifies the virtual management) switch name (for...
  • Page 332 Property key Property name Description Required OS.dns3 DNS server IP address Specify the IP address (for third NIC) of the DNS server to be set for the third NIC recognized by the OS of the virtual server. Do not specify an IPv6 address. hyperv.virtualSwitch3 Virtual switch name (for Specifies the virtual...
  • Page 333 Property key Property name Description Required hyperv.scsiDiskLocation SCSI controller location Specify the location of the SCSI controller for which a system disk has been set. This property takes effect only if the generation number of the exported virtual server is 2. hyperv.osSettingWaitTim Wait time before initial Specify in seconds the...
  • Page 334 Service Definition and Submit Service Properties The following table lists the properties shown in the Service Definition window and the Submit Service window. Property key Property name Description Required hyperv.vmName Virtual server name Specifies the name of the virtual server. (This is the name of the virtual server as it is visible in Hyper-V.

  • Page 335: Change Virtual Server Specifications (Cpu And Memory): Service Details

    Property key Property name Description Required OS.ipAddress2 IP address (for second Specify the 2nd IP NIC) address for the virtual server. You cannot specify an IPv6 address. OS.ipAddress3 IP address (for third Specifies the IP address NIC) that is set for the third NIC recognized by the OS on the virtual server.
  • Page 336 • Relative Weight setting of virtual processor resources • Processor compatibility • Maximum number of processors that can be used on a NUMA node • Maximum number of NUMA nodes that can be used by a socket Memory settings that can be changed: •...
  • Page 337 Service Definition Properties The following table lists the properties shown in the Service Definition window. Property key Property name Description Required or optional hyperv.targetHost Hyper-V server host Specifies the host name name or IP address of the Hyper-V server. IPv6 addresses are not supported.
  • Page 338 Property key Property name Description Required or optional UserResponsePlugin.en Encoding Specify the encoding of codeType notification emails sent when the service is waiting for a user response. The encodings you can specify are us-ascii, iso-2022-jp, shift_jis, euc-jp, and utf-8. If you omit this property, utf-8 is set.
  • Page 339 Property key Property name Description Required or optional hyperv.selectVmMemory Whether to change the If you want to change Change virtual server memory the virtual server settings memory settings, select "yes". If you do not want to change the virtual server memory settings, select "no".
  • Page 340 Property key Property name Description Required or optional hyperv.cpuMaximumCou Maximum number of Specify the maximum ntPerNumaNode processors that can be number of processors used on a NUMA node that can be used on a virtual NUMA (Non- Uniform Memory Architecture) node. Specify an integer of 1 or greater.

  • Page 341: Delete Virtual Server: Service Details

    Property key Property name Description Required or optional hyperv.dynamicMemory Buffer for dynamic Specify the percentage Buffer memory of memory to be reserved as the buffer for dynamic memory of Hyper-V. Specify an integer in the range from 5 to 2,000. Specify this item only when dynamic memory is enabled.
  • Page 342 virtual server, the task does not delete the virtual disks that are used as the parents of those differential virtual disks. • If the attempt to delete virtual disk files on the virtual server fails, the file deletion processing stops, and the task terminates abnormally.
  • Page 343 Prerequisites • The name of each virtual server on the Hyper-V server must be unique. • The OS Shutdown service of Hyper-V Integration Services must be enabled on the target virtual server. Usage guidelines • Do not concurrently run multiple instances of this service on the same virtual server. •...
  • Page 344 Property key Property name Description Required or optional hyperv.targetHost Hyper-V server host Specifies the host name name or IP address of the Hyper-V server. IPv6 addresses are not supported. UserResponsePlugin.to TO addresses Specify the email Address addresses to enter in the TO field of notification emails sent when the service is waiting for a...
  • Page 345 Property key Property name Description Required or optional UserResponsePlugin.en Encoding Specify the encoding of codeType notification emails sent when the service is waiting for a user response. The encodings you can specify are us-ascii, iso-2022-jp, shift_jis, euc-jp, and utf-8. If you omit this property, utf-8 is set.

  • Page 346: Add Virtual Server (Virtual Disk): Service Details

    Property key Property name Description Required or optional hyperv.vhdListOutputFile Output file name Specifies, as a full path, NameRemote (remote) the temporary file name for when the virtual disk file list used by the virtual server is output to the Hyper-V server. hyperv.vhdListOutputFile Output file name (local) Specifies the name of...
  • Page 347 • If only the SCSI controller location number is specified, the Hyper-V server automatically connects the virtual disk to the specified SCSI controller location of an available SCSI controller (0 to 3). • If both the SCSI controller ID number and SCSI controller location number are specified, the virtual disk is connected to the specified location of the specified SCSI controller.
  • Page 348 Property key Property name Description Required or optional UserResponsePlugin.ma Email text Specify the body text of ilBody notification emails sent when the service is waiting for a user response. UserResponsePlugin.en Encoding Specify the encoding of codeType notification emails sent when the service is waiting for a user response.
  • Page 349 Property key Property name Description Required or optional hyperv.vHardDiskFolder Virtual disk storage Specify the full path to Path folder path the folder that stores the created virtual disk. If you omit this specification, the virtual disk is stored in the virtual disk folder specified for the Hyper-V server.

  • Page 350: Start Virtual Server: Service Details

    Server requirements The following servers are needed: • Hyper-V server Server on which Hyper-V is installed. • Virtual server Virtual server managed by Hyper-V Usage guidelines • This service template does not initialize the virtual disks that are added to the virtual server. If necessary, log on to the OS of the virtual server and initialize the disks.
  • Page 351 Server on which Hyper-V is installed. • Virtual server Virtual server managed by Hyper-V Prerequisites • The name of each virtual server must be unique within a single Hyper-V server. • The Data Exchange service of the Hyper-V Integration Service on the target virtual server must be enabled.
  • Page 352 Property key Property name Description Required or optional hyperv.targetHost Hyper-V server host Specifies the host name name or IP address of the Hyper-V server. IPv6 addresses are not supported. hyperv.waitTime Wait time before starting When performing a to obtain IP address network connectivity check, specifies the amount of time, in...

  • Page 353: Stop Virtual Server: Service Details

    Property key Property name Description Required or optional hyperv.foreachVmName Virtual server names Specifies one or more (multiple names can be names for the virtual specified) server. (This is the name of the virtual server as it is visible in Hyper-V. This is not the host name in the OS.) If specifying multiple...

  • Page 354: Restart Virtual Server: Service Details

    Property key Property name Description Required or optional hyperv.targetHost Hyper-V server host Specifies the host name name or IP address of the Hyper-V server. IPv6 addresses are not supported. Service Definition and Submit Service Properties The following table lists the properties shown in the Service Definition window and the Submit Service window.
  • Page 355 Prerequisites • The name of each virtual server must be unique within a single Hyper-V server. • The OS Shutdown service of the Hyper-V Integration Service on the target virtual server must be enabled. • If the network connection check is enabled, you must specify the address of the connection destination for agentless monitoring.

  • Page 356: Obtain Virtual Server Information List: Service Details

    Property key Property name Description Required or optional common.icmpEchoTime Timeout period for ICMP Specify in milliseconds echo requests how long the service waits for a reply to an ICMP echo request sent to confirm startup of a virtual server. hyperv.checkVmStateEn Virtual server status Specifies the number of abledCount...
  • Page 357 3. The temporary file on the remote PC is deleted. 4. The following items are output to the file in CSV (comma-separated value) format: • Name of the Hyper-V server (header name: ComputerName) • Name of the virtual server (header name: VMName) •...

  • Page 358: Plug-In Components For Developers

    Service Definition and Submit Service Properties The following table lists the properties shown in the Service Definition window and the Submit Service window. Property key Property name Description Required or optional hyperv.listOutputFileNa Output file name Specifies, as a full path, meRemote (remote) the temporary file name...

  • Page 359: Aws Components

    • If you are importing templates that are included with the product, you must log on to the Automation Director server machine by using a remote connection. • If you are importing templates that you downloaded, you can access the UI from your local machine without using a remote connection.

  • Page 360: Websites

    Websites General websites Hewlett Packard Enterprise Information Library www.hpe.com/info/EIL Single Point of Connectivity Knowledge (SPOCK) Storage compatibility matrix www.hpe.com/storage/spock Storage white papers and analyst reports www.hpe.com/storage/whitepapers For additional websites, see Support and other resources on page 361. XP websites XP7 documentation (Storage Information Library) www.hpe.com/info/xp7-docs...

  • Page 361: Support And Other Resources

    Support and other resources Accessing Hewlett Packard Enterprise Support • For live assistance, go to the Contact Hewlett Packard Enterprise Worldwide website: www.hpe.com/assistance • To access documentation and support services, go to the Hewlett Packard Enterprise Support Center website: www.hpe.com/support/hpesc Information to collect •...

  • Page 362: Customer Self Repair

    IMPORTANT: Access to some updates might require product entitlement when accessed through the Hewlett Packard Enterprise Support Center. You must have an HPE Passport set up with relevant entitlements. Customer self repair Hewlett Packard Enterprise customer self repair (CSR) programs allow you to repair your product. If a CSR part needs to be replaced, it will be shipped directly to you so that you can install it at your convenience.

  • Page 363: Regulatory Information

    Documentation feedback HPE is committed to providing documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback (docsfeedback@hpe.com). When submitting your feedback, include the document title, part number, edition, and publication date located on the front cover of the document.

Table of Contents