INTERNAL DOCUMENT Workflow Automation (WFA) 1.1 ...community.netapp.com/fukiw75442/attachments/fukiw75442/oncomma… · INTERNAL DOCUMENT Workflow Automation (WFA) ... INSTALLATION

INTERNAL DOCUMENT

Workflow Automation (WFA) 1.1

Installation and Setup Guide

NetApp®

April 29, 2012 | Revision 1.7

2 Table of Contents

Rev 1.7 - 2012-4-15

TABLE OF CONTENTS

1 PURPOSE ................................................................................................................................... 4

General ........................................................................................................................................ 4

Installation requirements ............................................................................................................ 4

2 WFA PRE-INSTALLATION ........................................................................................................ 5

Installation kit available on designated VM ................................................................................ 5

Collecting Setup data ................................................................................................................... 5

3 WFA INSTALLATION ................................................................................................................. 6

Verifying VM setup ...................................................................................................................... 6

Installing WFA .............................................................................................................................. 6

Third party software .................................................................................................................... 8

4 WFA SETUP ............................................................................................................................... 9

Working with WFA ...................................................................................................................... 9

Acquiring Data ............................................................................................................................. 9

Configuring Credentials ............................................................................................................. 10

Configuring Mail ........................................................................................................................ 13

Configuring ASUP ....................................................................................................................... 14

Configuring LDAP ....................................................................................................................... 15

Configuring SNMP ..................................................................................................................... 17

APPENDIX A – INSTALLATION KIT CHECKLIST ........................................................................ 18

WFA installation kit essentials ................................................................................................... 18

WFA license ............................................................................................................................... 18

WFA installation kit supplemental tools ................................................................................... 18

APPENDIX B – UPGRADING WFA ............................................................................................... 19

Backing up current configuration .............................................................................................. 19

Uninstalling existing WFA .......................................................................................................... 20

Installing latest version of WFA ................................................................................................. 20

Restoring backup ....................................................................................................................... 20

APPENDIX C – WFA POC REQUIREMENTS ............................................................................... 21

WFA Platform – VM hardware and software requirements ..................................................... 21

Storage lab environmental requirements ................................................................................. 21

NetApp

WFA 1.1 Installation and Setup Guide

3

Rev 1.7 - 2012-4-1

APPENDIX D – AUTOMATED ONCOMMAND 5 (DFM 4.1) SETUP FOR WFA .......................... 22

Installing OnCommand on Linux ............................................................................................... 22

Installing OnCommand on Windows ......................................................................................... 22

Validating the automated OnCommand setup ......................................................................... 23

APPENDIX E – CONFIGURING WFA TO VCENTER CONNECTION .......................................... 24

Creating read-only user ............................................................................................................. 24

Setting the data source in WFA ................................................................................................. 28

Troubleshooting ........................................................................................................................ 30

APPENDIX F – WFA EXTERNAL BACKUP .................................................................................. 36

APPENDIX G – ENABLING PERL COMMANDS .......................................................................... 39

4 Purpose

Rev 1.7 - 2012-4-15

1 PURPOSE

This document describes how to install and configure the Workflow Automation (WFA) version

1.1 on a designated Virtual Machine (VM) or a physical host server.

Note: For the purpose of this document, the term VM will be used when describing the

installation process.

Attention: This document is primarily intended for a clean, new installation. However, if you are

upgrading the WFA from an earlier version and the existing data is needed, see Appendix B –

Upgrading WFA for detailed information.

The document includes information about the following topics:

• Pre-installation requirements

• WFA installation

• WFA setup

• Appendices containing additional information for the install process

o Installation kit

o Upgrade procedure

o Proof of concept (POC) requirements

o Remote read-only access to WFA

o Connecting WFA to vCenter

o External backup procedure

o Enabling Perl Commands

GENERAL

To successfully install and configure WFA, you will generally perform the following sequence of

events:

1. Create an installation kit.

2. Deliver the kit to the designated installation target.

3. Collect and verify setup data.

4. Install WFA and related software.

5. Configure WFA.

6. Perform sanity testing.

INSTALLATION REQUIREMENTS

For detailed information regarding installation requirements for the VM, see Appendix C – WFA

POC requirements.

NetApp


5

Rev 1.7 - 2012-4-1

2 WFA PRE-INSTALLATION

INSTALLATION KIT AVAILABLE ON DESIGNATED VM

Before installing WFA, you need to provide the WFA installation kit and a WFA license for the

designated VM. For detailed information, see Appendix A – Installation Kit Checklist.

Note: If you are upgrading WFA, there might be a WFA database (DB) backup .gz file and/or .dar

file(s). For more information, see Appendix B – Upgrading WFA.

COLLECTING SETUP DATA

When setting up WFA in an environment, the following information will be either required or

needed as applicable:

Unit/System Details Purpose Required

DFM IP Data acquisition Yes

Username,

Password

-- For DFM 4.1, see

Appendix D

Array(s) IP, Username,

Password

Credentials for performing

operations on arrays

Yes

vSphere IP, VC-Login:

User/Pass

Credentials for operations by using

VMware APIs

As applicable

VC_DB-Login:

User/Pass

Data acquisition (for details, see

Appendix E)

As applicable

External

repositories

IP, Username,

Password

Data acquisition As applicable

Mail server IP, Username,

Password

Receive WFA notifications by using

email

Yes; required for

Notifications and

Auto Support (ASUP)

ASUP server Mail host Sending ASUP messages using

SMTP

As applicable

LDAP server IP, Username,

Password, Group

Name

Authentication and Authorization

by using LDAP server

As applicable

SNMP

Management

Application

IP, Port Receive WFA SNMP traps As applicable

It is recommended that you collect and validate the information prior to starting the installation

process.

6 WFA Installation

Rev 1.7 - 2012-4-15

3 WFA INSTALLATION

VERIFYING VM SETUP

Prior to any POC, the customer is given the VM requirements document and is responsible for

setting up and preparing the VM according to these requirements prior to the installation

process. Before you install WFA, it is recommended that you verify the VM is set up correctly.

Perform the following steps to check the VM:

1. Verify the version of the installed Microsoft Powershell.

The Powershell version installed on the VM must be 2.0. To verify the version, perform

one of the following:

• Check the URL http://www.asoft.be/prod_netver.html. (This link also provides

additional links to download the correct version.) Or,

• Open Powershell (select Start > Run and enter Powershell). At the prompt,

enter $host.version. The major version should be “2” as shown below:

2. Verify the access to the filers and DataFabric Manager (DFM).

Verify that the applicable DFM and storage controllers can be reached from the

intended installation machine. Secure shell (SSH) accessibility is not mandatory but may

be required for certain use cases. Verify that SSH is enabled on the target controllers.

INSTALLING WFA

The WFA installation is a relatively simple and straight forward process.

1. Verify that there is not a previously installed version of WFA on the VM.

Attention: If you are upgrading an existing installation of WFA, perform the procedures

provided in Appendix B. Otherwise, remove the existing WFA (for instructions, see

Uninstalling existing WFA) before proceeding with the installation process.

2. Create a WFA folder on the desktop.

NetApp


7

Rev 1.7 - 2012-4-1

3. Verify that the appropriate file(s) from the installation kit is available on the VM; move

the file(s) to the WFA folder.

Note: For detailed information about these files, see Appendix A.

• New, fresh install: WFA installer executable

• Upgrade: WFA installer executable, a .gz DB backup (optional), and .dar export

files (optional)

4. Run the WFA installer executable file and complete the steps in the wizard to complete

the installation process.

Note: For Windows Server 2008, run the executable file as Administrator (use the right-

click menu).

5. Wait for the WFA application server to initialize (approximately 2 minutes); then, verify

that WFA is operating correctly.

Note: The Adobe Flash player must be installed for your web browser. See Third party

software for information.

a. Open the VM web browser and navigate to the URL:

http://<wfa_server_vm_ip>/wfa

Where <wfa_server_vm_ip> is the local host

b. Log in to WFA (admin/admin).

6. WFA starts without a license; insert the license.

a. Select Help > License.

b. Type the license in the License Key field.

c. Click Update License.

7. Change the password after logging in the first time.

a. Click Tools > Account Settings.

b. Select the Change Password check box.

c. Type the old password, the new password; then, type the new password again

in the Confirm field.

d. Click Save.

8. Refresh the web browser.

Tip: It is recommend that you create a bookmark (or Add to Favorites) for the WFA interface.

8 WFA Installation

Rev 1.7 - 2012-4-15

THIRD PARTY SOFTWARE

Various third party software may be needed during the installation process:

• VMware Power CLI – version 5. A PowerShell extension for VMware APIs; install if the

POC includes integration with e-VMware vSphere. For additional information or

downloads:

http://communities.vmware.com/community/vmtn/server/vsphere/automationtools/p

owercli?view=overview

• Web browsers. The following are recommended:

o Mozilla Firefox – versions 7.x and 8.x

o Microsoft Internet Explorer (IE) – version 8

o Google Chrome – version 15.x

• Adobe Flash player – Required. Install the latest version for your browser (IE, Firefox, or

Chrome).

NetApp


9

Rev 1.7 - 2012-4-1

4 WFA SETUP

WORKING WITH WFA

Attention: If you are upgrading WFA, you must perform the procedures contained in Appendix B.

During the Restore Backup process, the entire system data including the setup (users,

configuration, ASUP, and so on) is restored. After the backup is restored, you can use the

following sections to edit the various restored configurations as needed.

The VM on which WFA is installed can be anywhere within the customer network; however, this

VM must have access to the filers and the DFM server. As long as this VM is accessible by using

HTTP, WFA can be accessed using any of the recommended web browsers from anywhere.

Notes:

• The Adobe Flash player must be installed for your web browser.

• You may need to turn off the Pop up blocker for WFA to work correctly.

Run WFA:

1. Open the VM web browser and navigate to the URL:

http://<wfa_server_vm_ip>/wfa

Where <wfa_server_vm_ip> is the local host

2. Log in to WFA (admin/<password>).

Note: The password should have been changed after logging in the first time (see

Installing WFA; if not changed, use admin).

ACQUIRING DATA

For data acquisition, the first process is to set up WFA data sources.

The WFA currently supports the following data source types:

• DFM 3.7.1

• DFM 4.0

• DFM 4.1

• VMware vCenter 4

Perform the following steps to set a data source:

1. In the left pane, click Execution; then, click Data Sources.

2. Create a new data source:

a. Select Actions > New.

Note: If you upgraded WFA and want to edit the restored data source, select

the existing data source entry and select Actions > Edit. In the Edit Data Source

dialog box, modify the fields as needed.

b. Type the name of the data source in the Name field.

10 WFA Setup

Rev 1.7 - 2012-4-15

c. Select the data source type from the Data Source Type drop-down list.

The Port, User name, and Password fields are populated with default data.

(These fields can be edited, if needed.)

d. Type the IP or host name in the Host Name field.

e. Select the value for the Interval (minutes) field using the up and down arrows.

(It is recommended that 5 minutes is the selected interval; 0 means that the

information will be updated manually only and automatic acquisition will be not

performed.)

f. Click Save.

3. Click Acquire Now and follow the status updates on acquiring data.

Notes:

• If you are using OnCommand 5.0 or higher (includes DFM 4.1 or higher), you are

required to complete the OC5 setup. For more information, see Appendix D.

• During the initial acquisition, warnings may occur. Review them carefully.

• See Appendix E for the setup instructions for VMware vCenter 4.

CONFIGURING CREDENTIALS

After initial data acquisition, the credentials must be set for the arrays on which commands will

be performed.

PowerShell WFA controller connection works in two modes:

• With credentials – WFA tries to establish a connection using HTTPS and then falls back

to HTTP.

• Without credentials – WFA tries to establish a connection using domain authentication;

this mode uses RPC protocol, which is secured using NTLM protocol.

NetApp


11

Rev 1.7 - 2012-4-1

There are three ways to define credentials:

• Exact match – define single credentials for a specific IP or Host Name.

• Default credentials – define single credentials for the entire subnet or IP range. With

Pattern selected, use regular expression syntax.

• LDAP authentication – connect to array without defining credentials in WFA, but using

domain credentials (the array should be configured to perform authentication with

same the LDAP).

Perform the following steps to set Exact match and Default credentials:

1. In the left pane menu, click Execution; then, click Credentials.

2. Create new credentials for the applicable arrays:

a. Select Actions > New.

Note: If you upgraded the WFA and want to edit the restored array credentials,

select the existing array and click Edit. In the Edit Credentials dialog box, modify

the fields as needed.

b. Select the match type (Exact or Pattern) from the Match drop-down list.

c. Select the credential type from the Type drop-down list.

d. Type the IP or host name in the Name/IP field.

e. Type the user name in the User Name field.

f. Type the password in the Password field.

g. If Exact is the match type, you can test the connectivity by clicking Test.

Note: If Pattern is selected, you can test the connectivity–described later in this

procedure (see step 4)–by clicking Test Connectivity.

h. Click Save.

12 WFA Setup

Rev 1.7 - 2012-4-15

3. Repeat step 2 for all of the relevant systems.

• If the workflows include VMware vSphere operation, then create applicable

credentials for the type VMware vCenter.

Note: If the workflows include any of the optional Protection Manager (ProtMgr),

Provisioning Manager (ProvMgr), or Service Catalog operations, then create the

credentials for the DFM-type server.

4. To test the credentials (important when using regular expressions (Pattern)):

a. Select Actions > Test Connectivity.

b. Select the credential type from the Type drop-down list.

c. Type the IP or host name in the Name/IP field.

d. Click Test.

If LDAP connectivity to the array is required, then WFA service needs to be configured to run

with the domain user. Perform the following steps to set up LDAP authentication:

NetApp


13

Rev 1.7 - 2012-4-1

1. Open Windows services.

2. Right-click the service NetApp WFA Server.

3. Select the This account option.

4. Type the password and then confirm the password.

5. Click OK.

CONFIGURING MAIL

To configure email notifications regarding workflow operations such as workflow started or

workflow failed, specify the Mail server configuration.

1. Select Tools > WFA Configuration.

2. Click the Mail tab.

14 WFA Setup

Rev 1.7 - 2012-4-15

3. Select the Enable Email Notifications check box.

4. Enter information in the fields as needed. The Mail Host and Sender are required.

5. To test the Mail settings:

a. Click Send test mail.

b. Type the email address to where you want to send the email, and click Test.

c. Verify the email is on the specified mail host.

6. Click Save.

CONFIGURING ASUP

To configure Auto Support (ASUP) scheduling and content of ASUP messages, modify the ASUP

server configuration.


2. Click the ASUP tab.

NetApp


15

Rev 1.7 - 2012-4-1

3. Verify the Enable ASUP check box is selected.

4. Enter information in the fields as needed. The Mail Host (only when using SMTP),

Sender, and Destination are required.

5. To test the ASUP settings:

• To test downloading an ASUP message:

a. Click Download; then, click Save.

b. Select the location to where you want to save the ASUP message, and

click Save.

c. Verify the file is saved to the specified location.

• To test sending an ASUP message to the specified destination, click Send Now;

then, verify the message was sent.

6. Click Save.

CONFIGURING LDAP

To configure WFAs authentication and authorization to use an external Lightweight Directory

Access Protocol (LDAP) server, modify the LDAP configuration.


2. Click the LDAP tab.

16 WFA Setup

Rev 1.7 - 2012-4-15

3. Select the Enable LDAP check box.

4. Enter information in the fields as needed.

Field Description

User Principal Name

Attribute

Principal name of each user in the LDAP server

Group Membership Attribute The group in which a user is a member

Mail Attribute The user email address

Distinguished Name Attribute The user distinguished name

TimeOut (s) Length of time (in seconds) to wait for a response

from the LDAP server before timing out

LDAP Servers Comma-separated list of LDAP server URIs.

LDAP server URI formatted as:

ldap://<ldap-server-address>[:port]

If you want to use the same Active Directory

server as the domain, type the following:

ldap://

WFA administrators group Name of the LDAP group that identifies a user with

Admin role

WFA architects group Name of the LDAP group that identifies a user with

Architect role

WFA operators group Name of the LDAP group that identifies a user with

Operator role

5. Click Save.

NetApp


17

Rev 1.7 - 2012-4-1

CONFIGURING SNMP

To configure Simple Network Management Protocol (SNMP) notifications regarding workflow

operations, modify the management application server configuration.


2. Click the SNMP tab.

3. Select the Enable SNMP check box.

4. Enter information in the fields as needed.

5. Select the appropriate Notify On check box(es).

6. To test the SNMP settings:

a. Click Send Test Notifications.

b. Verify the notification is on the specified management host.

7. Click Save.

18 Appendix A – Installation Kit Checklist

Rev 1.7 - 2012-4-15

APPENDIX A – INSTALLATION KIT CHECKLIST

The WFA installation kit contains the following items:

• Essential files

• WFA license

• Supplemental tools

WFA INSTALLATION KIT ESSENTIALS

File Filename (or Example) Note

WFA installer exe WFA-x86-V1.x.x.x.x-Bxxxx.exe

For example:

WFA-x86-V1.1.0.1.2-B1234.exe

--

WFA DB backup* GNU zip (.gz) file with DB backup relevant to the

installation

Optional; file

emailed if

needed

Dar definitions file* A .dar file containing exported certified and

customer-specific content definition

Optional; file(s)

emailed if

needed

* The backup and definitions files depend on each case. When upgrading WFA from an earlier

version, the existing configuration is backed up before uninstalling WFA and then these files are

used to restore the earlier configuration after installing the upgraded WFA.

WFA LICENSE

The license string is provided at the time of installation. The license is not distributed prior to

the installation (if installed by using WebEx).

License key will be supplied on demand. Please reach out to your NetApp Rep or account SE for

a Key. They can submit a request for one at the license request portal in the WFA community.

WFA INSTALLATION KIT SUPPLEMENTAL TOOLS

When setting up WFA and testing the various scenarios, you may need to use additional tools to

assist in verifying the various functionality. For example:

• Editors (Notepad++) – License is required; obtain license before using

• DB viewers (SQLYog or Navicat) – License is required; obtain license before using

• Log file monitoring (Baretail)

NetApp


19

Rev 1.7 - 2012-4-1

APPENDIX B – UPGRADING WFA

If you are upgrading an existing WFA to this latest version, you must perform the following:

1. Back up the current WFA configuration.

2. Uninstall the existing WFA.

3. Install the latest version of WFA.

4. Restore the backup.

The following sections contain detailed instructions regarding the procedures for the upgrade

process.

BACKING UP CURRENT CONFIGURATION

Before upgrading WFA, the first step is to back up the current database, which contains both

configuration and cache information. You have the option to back up the entire database or just

the configuration information.

To manually back up the database, perform the following steps:

1. Select Tools > Backup & Restore.

2. Click Backup and save the file to the desktop.

3. Verify that the backup file is created in the correct location.

4. Click the Return to WFA link at the top right to return to the main WFA screen.

20 Appendix B – Upgrading WFA

Rev 1.7 - 2012-4-15

UNINSTALLING EXISTING WFA

To uninstall WFA, use the program removal feature for your Windows operating system (for

example, navigate to the Windows Control Panel and select Control Panel > Programs and

Features (Windows Server 2008)). For details, see the documentation for your operating system.

Note: If the uninstall process stalls before the process is complete, open the Services console

(select Start > Run and enter services.msc) and stop the NetApp WFA Database. Then, retry

the uninstall process.

INSTALLING LATEST VERSION OF WFA

After uninstalling the previous WFA version, perform the procedure provided in the WFA

Installation ONLY to install the latest version of WFA. DO NOT proceed to the WFA Setup phase.

After installing WFA, continue the upgrade process–perform the next procedure, Restoring

backup.

RESTORING BACKUP

After the installation is complete and WFA is started, you must restore the backup.

The restoration process migrates the backed up database to fit the newly installed (updated)

version. The system data that was selected to be backed up (such as Users, Configuration, ASUP,

and so on) is restored.

To restore the backup, perform the following steps:

1. Select Tools > Backup & Restore.

2. Click Browse and locate the backup file you created prior to the uninstall process.

3. If any changes were made in the previous installation to any of the pre-canned

definitions (such as Dictionary, commands, finders, and filters), clear the Upgrade

pre-canned definitions check box (by default, this check box is selected); otherwise,

these definitions will be overwritten.

Note: If you do not upgrade the pre-canned definitions, then you may not receive

important updates and fixes. Unless major changes were made to the pre-canned

definitions, it is recommended to update and upgrade those definitions.

4. Click Restore.

5. Click the Return to WFA link at the top right to return to the main WFA screen.

If any of the restored configuration settings need to be edited, proceed to WFA Setup for

instructions.

NetApp


21

Rev 1.7 - 2012-4-1

APPENDIX C – WFA POC REQUIREMENTS

The section details the requirements that the customer must provide for the designated VM on

which the WFA server will be installed and for their storage lab.

WFA PLATFORM – VM HARDWARE AND SOFTWARE REQUIREMENTS

The WFA platform should be installed on a dedicated VM for the purpose of the POC. The

designated VM name cannot include an underscore (“_”).

The requirements for the VM are listed in the following table:

Minimum (POC) Recommended

Operating system Windows Server 2008 R2

Windows Server 2008 SP2

Windows Server 2003

Windows Server 2008 R2

RAM 3 GB 4 GB

Free disk space 10 GB 20 GB

CPU 1 gigahertz (GHz) or faster, 32-bit

(x86) or 64-bit (x64) processor

2.27 GHz or faster, 64-bit (x64)

processor, 2 core

There are several applications that are deployed as part of WFA installation:

• JBoss application server

• MySQL

• PowerShell 2.0

Note: To install PowerShell 2.0, the .Net 2.0 framework run-time patches must be fully

updated on the VM.

The following ports must be open in the firewall to allow these applications to work properly:

• JBoss – 1098, 1099, 80, 443

• MySQL – 3306

STORAGE LAB ENVIRONMENTAL REQUIREMENTS

The WFA Server POC utilizes the customer’s storage lab. For the purpose of the POC, the

following will be required:

• IP access from the WFA server to the lab DFM server (in which the lab storage arrays are

registered)

• At least two storage arrays (Filers), with the following criteria:

o Registered in the lab DFM

o Directly accessed from the designated VM on which WFA will be installed

o Contain usable primary and secondary aggregates, as per the naming

conventions previously supplied

o (Optional) SSH-enabled (only if using CLI ONTAP commands)

22 Appendix D – Automated OnCommand 5 (DFM 4.1) Setup for WFA

Rev 1.7 - 2012-4-15

APPENDIX D – AUTOMATED ONCOMMAND 5 (DFM 4.1) SETUP FOR WFA

Starting with OnCommand 5 (DFM 4.1), remote access to DFM Sybase database has to be

established actively. Use the oc5setup tool to grant remote read-only access to WFA. The

application does not actively install anything, but runs on the DFM machine in order to setup

said access.

Note: Both Windows (oc5setup.zip) and Linux (oc5setup.sh) versions of oc5setup can be found

at the WFA installation folder, under “bin” folder (ie C:\Program Files (x86)\NetApp\WFA\bin).

RUNNING OC5SETUP ON LINUX

1. Copy wfa_oc5setup.sh file to your home directory on the DFM server.

2. Change wfa_oc5setup.sh to be executable: chmod +x wfa_oc5setup.sh>

3. Run the script while providing the DFM home directory (./wfa_oc5setup.sh

<dfm-home>):

# chmod +x wfa_oc5setup.sh # ./wfa_oc5setup.sh /mnt/lun_nb_iscsi_prod_1_filerip_21/

The following displays during the process and after a successful setup:

Verifying archive integrity... All good. Uncompressing WFA OnCommand-5 Setup... >>> Connecting to database <<< Connected *** Dropped existing 'wfa' user === Created user 'wfa' >>> Granting access <<< Granted access #

RUNNING OC5SETUP ON WINDOWS

1. Copy and extract wfa_oc5setup.zip file to a folder on the DFM server.

2. Start the wfa_oc5setup.exe and locate the DFM home directory (The path

displayed is a suggestion, you should target the right path where DFM is installed and

specifically to the DFM folder under the installation (See screenshot below)) ; then, click

Next:

NetApp


23

Rev 1.7 - 2012-4-1

3. Review the setup results.

4. Click Next and then Finish to complete the process.

VALIDATING THE AUTOMATED ONCOMMAND SETUP

After a successful installation, set up a data source in WFA for the DFM server using

wfa/Wfa123 as the username/password and then acquire. For more information, see the

procedure in Appendix E: Setting the data-source in WFA.

Note: The setup may fail if the user wfa is currently logged in to the database via a SQL tool (i.e.

Squirrel). In this case, close the SQL tool (to ensure that no other client is connected to the same

DB from the host) and stop any scheduled acquisitions before trying again.

24 Appendix E – Configuring WFA to VCENTER Connection

Rev 1.7 - 2012-4-15

APPENDIX E – CONFIGURING WFA TO VCENTER CONNECTION

WFA has the ability to add VMware vCenter data to the WFA Cache by acquiring data from the

VirtualCenter database using the MSSQL JDBC driver. WFA connects to the VC SQL Server as a

read-only user and acquires the relevant data.

This appendix provides instructions for creating a Select/Read-only user in VirtualCenter

database, setting the data source in WFA, and troubleshooting information to ensure correct

connectivity to VMware vCenter.

CREATING READ-ONLY USER

WFA connects to the VC SQL Server as a read-only user for data acquisition. The User Mapping

should have public and db_datareader roles on the VIM_VCDB database.

You can create the read-only user using either the SQLCMD CLI or the Microsoft SQL Server

Management Studio.

Option 1: Using SQLCMD CLI

1. Open a cmd session (select Start > Run and enter cmd).

2. Connect to the SQL Server:

sqlcmd -S <HOME>\SQLEXP_VIM -E

Where:

<HOME> is the server name

-E means using Windows authentication

3. Set VIM_VCDB as the current database:

USE VIM_VCDB

GO

4. Create a new server login name (wfa) and password (wfa) as defined by default in WFA

data source type:

CREATE LOGIN wfa WITH PASSWORD = 'wfa',

DEFAULT_DATABASE=[VIM_VCDB], CHECK_EXPIRATION=OFF,

CHECK_POLICY=OFF

GO

5. Create a new database user linked to the login name:

CREATE USER wfa FOR LOGIN wfa

GO

6. Grant database SELECT permission to the user:

GRANT Select To wfa

GO

NetApp


25

Rev 1.7 - 2012-4-1

7. Set the user role to db_datareader:

EXEC sp_addrolemember 'db_datareader', wfa

GO

8. Exit and close the cmd session.

Option 2: Using Microsoft SQL Server Management Studio

1. Open Microsoft SQL Server Management Studio and connect to the SQL Server.

2. Right-click SQL Server Instance and select Security > Logins > New Login.

3. In the Login-New dialog box, select General in the left pane.

4. Select SQL Server authentication mode.


Rev 1.7 - 2012-4-15

5. Type wfa in the Login name field and wfa in the Password field, as defined by default

in the WFA data source type.

6. Verify that the following check boxes are cleared:

• User must change password in next login

• Enforce password expiration

• Enforce password policy

7. Select VIM_VCDB from the Default Database drop-down list.

8. Select English from the Default Language drop-down list.

9. Select Server Roles in the left pane.

10. Verify that the public check box is selected.

11. Select User Mapping in the left pane.

12. Map the VIM_VCDB database to the new user name (wfa) and the dbo schema.

a. Select the Map check box for the VIM_VCDB database.

b. Select wfa in the User column.

c. Select dbo in the Default Schema column.

NetApp


27

Rev 1.7 - 2012-4-1

13. Select Status in the left pane.

14. Select Grant as the Settings option.

15. Select Enabled as the Login option.

16. Click OK to save new user.


Rev 1.7 - 2012-4-15

17. Select SQL Server Instance > Databases > VIM_VCDB > Security > Users and double-

click the newly created user name (wfa) in the left pane.

18. In the Database User – wfa dialog box, select General in the left pane and select

db_datareader role check box.

19. Click OK to save the changes.

SETTING THE DATA SOURCE IN WFA

To set the data source in WFA for acquiring data from the VirtualCenter database, perform the

following steps:

1. Open WFA, if not already opened.

2. In the left pane, click Execution; then, click Data Sources.

3. Click New.

NetApp


29

Rev 1.7 - 2012-4-1

4. Type the name of the data source in the Name field.

5. Select VMware vCenter- 4 (MSSQL) from the Data Source Type drop-down list. The

Port, User name, and Password fields are populated with the default data.

6. Type the IP/host name of the specific VirtualCenter in the Host Name field.

7. If needed, replace the default value, 1433, in the Port field to the TCP port that the

VirtualCenter uses.

8. If needed, replace the default values (wfa/wfa) in the User name and Password fields.

9. Select 5 in the Interval (minutes) field using the up and down arrows. (5 minutes is the

recommended interval; 0 means that auto-update will be not performed.)

10. Click Save.

11. Select the newly created data source and click Acquire Now.


Rev 1.7 - 2012-4-15

When the acquisition process is complete, the WFA Cache contains information from the

specific VirtualCenter database.

If the acquisition fails, see the Troubleshooting section for possible solutions.

TROUBLESHOOTING

If the acquisition process failed, then perform the following troubleshooting procedures to make

sure the properties associated with connectivity are configured correctly.

Enabling remote access to the VC SQL Server

To enable the remote access, perform the following steps:

1. Open the SQL Server Configuration Manager (select Start > Programs > Microsoft SQL

Server [version] > Configuration Tools).

2. Expand SQL Server Network Configuration > [your SQL server instance].

3. Under Protocol Name, double-click TCP/IP.

4. In the TCP/IP Properties dialog box, perform the following:

Protocol tab:

• Verify Enabled is set to Yes.

IP Addresses tab:

• Scroll to the bottom and expand + IPAll; then, enter the TCP Port value.

Note: By default, 1433 defined as the port for the WFA data source type. If the SQL

Server uses another port, update the WFA data source type accordingly.

NetApp


31

Rev 1.7 - 2012-4-1

5. If the Firewall is enabled, create an exception for the SQL Server instance and port that

is being used.

a. Select Start > Run and enter Firewall.cpl.

b. Click the Exceptions tab.

c. Add the sqlservr.exe (typically located in C:\Program Files

(x86)\Microsoft SQL Server\MSSQL.x\MSSQL\Binn), and the port

that SQL Server uses (set in step 4).

6. If changes were made in steps 4–5, restart the SQL Server service and SQL Server

Browser processes.


Rev 1.7 - 2012-4-15

7. Check that there is connectivity to the SQL Server.

a. Open a Command Prompt window (select Start > Run and enter cmd).

b. At the prompt, enter the following:

netstat -ano| findstr 1433

telnet <IP> 1433

ping -a <IP>

Note: Record the server name, domain name, and IP address that you are using.

You will need this information when checking the connectivity.

c. Check the ports and IP addresses that are returned.

Note: For more information, see http://www.linglom.com/2009/03/28/enable-remote-

connection-on-sql-server-2008-express/.

Setting Authentication Mode of VC SQL Server to Mixed Mode

WFA uses SQL Server Authentication to connect to the VC SQL Server.

To allow for this type of connection, the Authentication Mode of the VC SQL Server needs to be

set to “Mixed Mode” (Windows Authentication and SQL Server Authentication).

NetApp


33

Rev 1.7 - 2012-4-1

You can set the Authentication Mode to “Mixed Mode” using either the Registry or the

Microsoft SQL Server Management Studio.

Option 1: Using Registry

1. Select Start > Run and enter Regedit.

In the Registry Editor dialog box, locate the InstallDir file (typically located in

\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL

Server\MSSQL.x\MSSQLServer\). This file stores the Authentication Mode.

2. Edit the LoginMode key. Set the value to 2 (1 is for Windows Authentication Mode and

2 is for Mixed Mode Authentication).

3. Restart the SQL Server service.


Rev 1.7 - 2012-4-15

Option 2: Using Microsoft SQL Server Management Studio

1. Open Microsoft SQL Server Management Studio and connect to the SQL Server.

2. Right-click SQL Server Instance and select Properties.

3. In the Server Properties dialog box, select Security in the left pane. Then, select the SQL

Server and Windows Authentication mode option.

NetApp


35

Rev 1.7 - 2012-4-1

4. Click OK to save the changes. A confirmation dialog box appears prompting you to

restart the SQL Service to apply changes.

5. Right-click the SQL Server Instance and select Restart.

36 Appendix F – WFA External Backup

Rev 1.7 - 2012-4-15

APPENDIX F – WFA EXTERNAL BACKUP

When backing up the database on a frequent basis (such as daily backups), use the Powershell

script.

To back up the database using the Powershell script, perform the following steps:

1. Create a user with Backup role if one does not exist.

a. Select Tools > Users.

b. Click New.

c. Type the name of the user in the Name field.

d. Select Backup from the Role drop-down list.

e. Type the user email address in the Email field, if needed.

f. Type the password in the Password field.

g. Re-type the password in the Confirm field.

h. Verify the Notify On check box is cleared (not selected).

i. Click Save.

NetApp


37

Rev 1.7 - 2012-4-1

2. As Administrator on the specific server, run the Powershell Backup.ps1 script with

the three mandatory parameters: -User, -Password, -FileName.

a. Open Powershell (select Start > Run and enter Powershell).

b. At the prompt, enter:

&’<wfa_install_location>\WFA\bin\Backup.ps1’ -User

<user_name> -Password <password> -Filename

<backup_filename>

<backup_filename>.sql.gz

Where:

<wfa_install_location> is the directory for the WFA

installation (for example, C:\Program Files (x86)\NetApp).

<user_name> and <password> for the user with the Backup role

<backup_filename> is the full directory path for the backup file

(for example, C:\backups\backup_29_11_11).

3. Verify that the gzip backup file is created in the correct location.

38 Appendix F – WFA External Backup

Rev 1.7 - 2012-4-15

NetApp


39

Rev 1.7 - 2012-4-1

APPENDIX G – ENABLING PERL COMMANDS

To enable Perl commands to work, you must install Perl on the WFA server.

The following Perl installations have been tested to work with WFA and are recommended:

• ActivePerl: version 5.14.2

To downloaded: http://www.activestate.com/activeperl

• Strawberry Perl: version 5.10.1.5

To downloaded: http://strawberryperl.com/

Make sure the folder location of the Perl executable appears as part of your Path environment

variable and restart your NetApp WFA Server Service.

The following table contains additional required Perl modules:

Modules Installation

NetApp

Manageability

SDK version 4.1

Perform the following steps:

1. Download from http://now.netapp.com/NOW/cgi-

bin/software?product=NetApp+Manageability+SDK&platform=All+P

latforms.

2. Unzip.

3. Copy all Perl modules (all .pm files except test.pm) from

<your_sdk_folder>\lib\perl\NetApp to the lib folder

under your Perl installation.

SOAP::Lite Use cpanm to install (version 0.714 has been tested).

WFAUtil.pm Copy <your_wfa_installation_folder>/perl/WFAUtil.pm to the

lib folder under your Perl installation.

Documents

INTERNAL DOCUMENT Workflow Automation (WFA) 1.1 ...community.netapp.com/fukiw75442/attachments/fukiw75442/oncomma… · INTERNAL DOCUMENT Workflow Automation (WFA) ... INSTALLATION