Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Initial setup for connecting with Ops Center Automator

You can resolve performance issues by running the Ops Center Automator service templates. The procedure for performing initial configuration varies depending on whether Ops Center Automator is linked with Device Manager.

If you do not want to link Ops Center Automator with Device Manager, we recommend installing Ops Center Automator on the same host as the Analyzer server. For details about how to install Ops Center Automator, see the Hitachi Ops Center Automator Installation and Configuration Guide.

Connecting to Ops Center Automator when there is no link to Device Manager

To configure settings to connect to Ops Center Automator when it is not linked with Device Manager:

Prerequisites

Ops Center Automator is installed.

Procedure
  • Verify that the Ops Center Automator host name can be resolved.

  • Change the Common component settings (if Ops Center Automator and the Analyzer server are installed on separate hosts).

  • Check the permissions of the user account.

  • (Optional) Create Ops Center Automator service-integration definition files.

Verifying that the Ops Center Automator host name can be resolved

Verify that the Ops Center Automator host name can be resolved by the Analyzer server host and the host running the browser.

  1. Log on to the host on which Ops Center Automator is installed as a user with root permission.

  2. Display the Ops Center Automator URL by running the hcmds64chgurl command, and check the host name.

    Automator-installation-destination-directory/Base64/bin/hcmds64chgurl -list
  3. On the Analyzer server host and the host running the browser, verify that you can resolve Ops Center Automator host name reported by hcmds64chgurl command.

    If the name resolution fails, enable name resolution for the Ops Center Automator host name by using a method such as adding an entry to the hosts file.

Changing Common component settings

If Ops Center Automator and the Analyzer server are installed on different hosts, you must change the settings of the Common component so that the user accounts used by each product can be centrally managed on the Analyzer server. If you use Common Services, user information is centrally managed in Common Services. However, you are required to complete this procedure before you can connect to Ops Center Automator.

NoteIf Ops Center Automator and the Analyzer server are installed on the same host, skip this procedure.

The host that manages the user accounts is called the primary server. The host on which the user accounts are managed by the primary server is called the secondary server.

The following procedure sets the Analyzer server as the primary server and Ops Center Automator as the secondary server.

Procedure

  1. Log on to the host on which Ops Center Automator is installed as a user with root permission.

  2. Run the hcmds64prmset command to change the settings of the Common component.

    For the host, port, and sslport options, specify information about the Analyzer server to use as the primary server. The default port number for non-SSL communication is 22015. The default port number for SSL communication is 22016.

    Automator-installation-destination-directory/Base64/bin/hcmds64prmset -host host-name-or-IP-address {-port port-number-for-non-SSL-communication | -sslport port-number-for-SSL-communication}
  3. Stop and restart the services:

    1. Run the hcmds64srv command with the stop option.

    2. Run the hcmds64srv command with the start option.

Results

User account information on Ops Center Automator can now be managed in the Analyzer server.

Checking user account permissions

Check whether the required permissions are assigned to the user account used to connect to Ops Center Automator. Check the settings in both the Analyzer server and Ops Center Automator.

Procedure

  1. Log on to the Analyzer server by using the system account or as a user who has user management permissions.

  2. Check the settings of the user account for Ops Center Analyzer:

    1. In the Administration tab, select User Management Users and Permissions.

    2. In the Users and Permissions window, select Users. From the user list, click the user account to use to connect to Ops Center Automator.

    3. In the Granted Permission field, make sure that the IAA Admin or Modify permission is set. If the permission is not set, click Change Permission to set it.

  3. Log on to Ops Center Automator by using the system account.

  4. Assign the user account to use to connect Ops Center Automator to an Ops Center Automator user group:

    1. In the Administration tab, select Resources and Permissions User Groups.

    2. Select a user group that has permission to execute services in Ops Center Automator. On the Users tab, click Assign to assign the user account to the user group.

  5. Assign the user group to an Ops Center Automator service group:

    1. Select Resources and Permissions Service Groups.

    2. Select the service group of the Ops Center Automator, and then select the Permissions tab.

    3. Confirm that the user group is assigned to the service group.

Next steps

Check the connection between Ops Center Analyzer and Ops Center Automator.

Connecting to Ops Center Automator when linked to Device Manager

To configure Ops Center Automator connection settings when linked with Device Manager:

  • Verify that the Ops Center Automator host name can be resolved.

  • Change the Common component settings (if Device Manager and the Analyzer server are installed on separate hosts).

  • Create a user account.

  • Check the permissions of the user account.

  • (Optional) Create Ops Center Automator service-integration definition files.

Verifying that the Ops Center Automator host name can be resolved

Verify that the Ops Center Automator host name can be resolved by the Analyzer server host and the host running the browser.

  1. Log on to the host on which Ops Center Automator is installed as a user with root permission.

  2. Display the Ops Center Automator URL by running the hcmds64chgurl command, and check the host name.

    Automator-installation-destination-directory/Base64/bin/hcmds64chgurl -list
  3. On the Analyzer server host and the host running the browser, verify that you can resolve Ops Center Automator host name reported by hcmds64chgurl command.

    If the name resolution fails, enable name resolution for the Ops Center Automator host name by using a method such as adding an entry to the hosts file.

Changing Common component settings

If Device Manager and the Analyzer server are installed on different hosts, you must change the settings of the Common component so that the user accounts used by each product can be centrally managed in Device Manager. If you use Common Services, user information is centrally managed in Common Services. However, you are required to complete this procedure before you can connect to Ops Center Automator.

NoteIf Device Manager and the Analyzer server are installed on the same host, skip this procedure.

The host that manages the user accounts is called the primary server. The host on which the user accounts are managed by the primary server is called the secondary server.

Perform the following steps to set Device Manager as the primary server and the Analyzer server as the secondary server.

Procedure

  1. Log on to the host on which the Analyzer server is installed as a user with root permission.

  2. Run the hcmds64prmset command to change the settings of the Common component.

    For the host, port, and sslport options, specify information about the Device Manager instance to use as the primary server. The default port number for non-SSL communication is 22015, and the default port number for SSL communication is 22016.

    Common-component-installation-destination-directory/bin/hcmds64prmset -host host-name-or-IP-address {-port port-number-for-non-SSL-communication | -sslport port-number-for-SSL-communication}
  3. Stop and restart the services:

    1. Run the hcmds64srv command with the stop option.

    2. Run the hcmds64srv command with the start option.

Results

User account information on the Analyzer server can now be managed in Device Manager.

Creating user accounts

If you set the Analyzer server as a secondary server using the hcmds64prmset command, Ops Center Analyzer users (other than the system account and users with the User Management permission) that were created previously will no longer be able to log on to the Analyzer server. In this case, you must use the Ops Center Analyzer web client to create new user accounts that have Ops Center Analyzer permissions.

NoteThis procedure only applies to local user authentication. If Common Services is used, this procedure is not necessary.

Procedure

  1. Log on to the Analyzer server by using the system account.

  2. In the Administration tab, select User Management Users and Permissions.

  3. In the Users and Permissions window, select Users, and then click Add User.

  4. Specify all required items, and then click OK.

  5. From the list of users, click the link for the user account that you created in the previous step, and then click Change Permission.

  6. Select the check box for Admin or Modify permission for IAA, and then click OK.

Checking user account permissions

Check whether the user account used to connect to Ops Center Automator has the required permissions. Check the settings in Ops Center Automator.

Procedure

  1. Log on to Ops Center Automator as a user who belongs to the Admin group of Ops Center Automator.

  2. Assign the user account to use to connect to Ops Center Automator, to an Ops Center Automator user group:

    1. In the Administration tab, select Resources and Permissions User Groups.

    2. Select a user group that has permission to execute services in Ops Center Automator. On the Users tab, click Assign to assign the user account to the user group.

  3. Assign the user group to the service group of the Ops Center Automator:

    1. Select Resources and Permissions Service Groups.

    2. Select the service group of the Ops Center Automator, and then select the Permissions tab.

    3. Confirm that the user group is assigned to the service group.

Next steps

Check the connection between Ops Center Analyzer and Ops Center Automator.

Creating a definition file to connect with Ops Center Automator

If you create a definition file to connect with Ops Center Automator, the Ops Center Automator service defined in that file is displayed in the Execute Action window. This allows you to select the service. Information about the selected resources (such as resource names, IP addresses, and virtual host names) is inherited as parameters when the Submit Service Request window of Ops Center Automator is opened. In addition, by specifying resource information as filtering conditions, you can display the Ops Center Automator services that meet the conditions in the Execute Action window.

The sample definition files to connect with Ops Center Automator are stored in the following location:

Analyzer-server-installation-destination-directory/Analytics/conf/template/automation_sample

Sample files usually must be revised to match your environment; however, the following sample file for the built-in service of Ops Center Automator can be used without change: AllocateLikeVolumeswithConfigurationManager_016200.

  • Allocate Like Volumes with Configuration Manager

    In the definition file to connect with Ops Center Automator, filtering conditions are specified so that this service is displayed in the Execute Action window only when a volume of the storage system is selected.

Note, however, that if you change the service group to which this service template is assigned from Default Service Group to a different service group in Ops Center Automator, you must also change the contents of the sample file.

For details, see Format of definition files used to connect with Ops Center Automator.

Procedure

  1. Create a definition file corresponding to the service to be executed in Ops Center Automator.

    In the definition file, you can define the property key to use for the Ops Center Automator service. If you specify information (variables) about the resource owned by Ops Center Analyzer, you can apply the information about the specified resource in the service execution window of Ops Center Automator launched from Ops Center Analyzer.
  2. Store the created definition file in the following location:

    Analyzer-server-installation-destination-directory/Analytics/conf/template/automation

  3. Restart the Analyzer server or execute the reloadtemplate command for changes to take effect.

Format of definition files used to connect with Ops Center Automator

The following items are set in the definition file used to connect with Ops Center Automator:

  • Format

    specified-key-name=specified-value

  • File

    • You can specify any file name and file extension.
    • Save the file in UTF-8 format.
    • The maximum number of files that can be set in Ops Center Analyzer (including the number of email template definition files and command definition files) is 1,000. Files load in alphabetical order by file name, and any files after the 1,000th file are not loaded.
  • Folder

    Analyzer-server-installation-destination-directory/Analytics/conf/template/automation

  • Update frequency

    Indicates when the Analyzer server is started or the reloadtemplate command is run.

  • Content to specify

    Specify each key name and value on a single line. The following rules apply when you specify settings in a definition file to connect with Ops Center Automator:

    • A line starting with # is treated as a comment line.
    • Blank lines are ignored.
    • The entered values are case-sensitive.
    • If you specify an invalid value, the default value is used.
    • If you specify the same key more than once in the same file, the last key is used.
    • To display \, specify \\.
    • To display %, specify %%.
    • If you specify the filter condition SE.template.filter.xxxxxxx.string more than once, settings display when all of the conditions are met.
  • Setting descriptions

    Key name

    Setting description

    Specifiable values

    Default value

    Optional or required

    SE.automation.template.serviceGroupName.string

    Specify the service group name used in Ops Center Automator.

    The same service group name as the one used in Ops Center Automator

    N/A

    Required

    SE.automation.template.serviceName.string

    Specify the service name used in Ops Center Automator.

    The same service name as the one used in Ops Center Automator

    N/A

    Required

    SE.template.filter.resourceName.string

    Specify conditions to narrow down the resource names that appear in the Execute Actions list.1

    Values of no more than 255 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    SE.template.filter.resourceType.string

    Specify conditions to narrow down the types of resources that display in the Execute Actions list.1

    Values of no more than 32 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    SE.template.filter.vmHostname.string

    Specify conditions to narrow down the virtual machine names that display in the Execute Actions list.1

    Values of no more than 64 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    SE.template.filter.ipaddress.string

    Specify conditions for the IP addresses that display in the action list during resource selection.1

    Values of no more than 255 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    SE.template.filter.upperResourceName.string

    Specify conditions to narrow down the names of higher-level resources during resource selection.1

    Values of no more than 512 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    SE.template.filter.upperResourceType.string

    Specify conditions to narrow down the higher-level resource types during resource selection.1

    Values of no more than 32 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    SE.template.filter.MultipleResources.boolean

    To execute actions for multiple selected resources, specify whether to display the services in the Execute Actions list.

    true or false

    false

    Optional

    If this key is omitted, the default value is used.

    SE.automation.template.service.parameter.Ops Center Automator-service-property-key

    Specify the property key2 used for the Ops Center Automator service.

    Values of no more than 1,024 bytes that do not include control characters

    Null character

    Optional

    If this key is omitted, the default value is used.

    Notes:

    1. Settings display only when the Execute Action window is called from a resource that matches the specified conditions.
    2. You cannot specify a property key whose data type is password or composite. To check the property key, use the flow window of the service template.

    By using variables, you can set information about a selected resource as the value of a setting.

    The following table lists the variables you can use.

    Variable name

    Variable description

    Remarks

    %ANALYTICS_RESOURCENAME%

    Name of the selected resource

    N/A

    %ANALYTICS_UPPERRESOURCENAME%

    Name of the higher-level resource of the selected resource

    N/A

    %ANALYTICS_IPADDRESS%

    IP address

    N/A

    %ANALYTICS_VIRTUALMACHINENAME%

    Name of the virtual host

    Displays only when the resource is a virtual machine

    %ANALYTICS_RESOURCETYPE%

    Resource type

    N/A

    %ANALYTICS_UPPERRESOURCETYPE%

    Type of higher-level resource

    N/A

    If no value is set for the selected resource, a null character displays.

    To display information about virtual hosts and IP addresses, VMware Tools must be installed on virtual hosts.

  • Definition example

    The following is a definition example of displaying the service for stopping virtual machines defined in Ops Center Automator, in the Execute Action window of the virtual machine selected:

    SE.automation.template.serviceGroupName.string=Services for VM
    SE.automation.template.serviceName.string=Stop Virtual Machine
    SE.template.filter.MultipleResources.boolean=true
    SE.template.filter.resourceType.string=VM
    SE.automation.template.service.parameter.vmware.foreachVmName=%ANALYTICS_IPADDRESS%
    

Resetting Common component settings

If you no longer integrate Ops Center Analyzer with Ops Center Automator, or if you want to remove Ops Center Analyzer, remove the authentication information about the secondary server from the primary server, and reset the settings of the Common component.

Procedure

  1. Log on to the host of the primary server as a user with root permission.

  2. Run the hcmds64intg command to remove the authentication information about the secondary server from the primary server.

    The following is an example of running the command if the Analyzer server is a primary server:
    Common-component-installation-destination-directory/bin/hcmds64intg -delete -type component-name

    For the type option, specify either of the following as the component name for the secondary server where the authentication information is to be deleted:

    • For Ops Center Automator Automation
    • For the Analyzer server Analytics

    If you are prompted to enter a username, enter a user ID for the primary server that has the User Management permission.

  3. Stop and restart the services:

    1. Run the hcmds64srv command with the stop option to stop the services.

    2. Run the hcmds64srv command with the start option to start the services.

  4. Log on to the host of the secondary server as a user with root permission.

  5. Run the hcmds64prmset command to change the settings of the Common component.

    The following is an example of running the command if Ops Center Automator is a secondary server:
    Automator-installation-destination-directory/Base64/bin/hcmds64prmset -setprimary

Results

The relationship between the primary server and the secondary server is released, and user accounts are managed at each host.

User accounts that were registered before connecting to the primary server can be used again in the secondary server.

NoteIf Device Manager was used as the primary server, after the Common component settings are removed, the user accounts created on the Analyzer server remain in Device Manager. If these user accounts are no longer necessary, delete them in the user management window of Device Manager.