ACG Users Guide
ACG Users Guide
Users Guide
Abstract
This document is an introduction and reference manual for users of the As-Deployed
Configuration Generator (ACG). The target audience is composed of Dell Technologies Solution
Architects and Delivery personnel.
1
Table of Contents
Introduction......................................................................................................................... 4
Overview, Requirements and Process Description (When do I use the ACG) ............... 5
Running the As-Deployed Configuration Generator Guide Generator ........................... 6
Invoking application ....................................................................................................................................... 6
Entering Data ................................................................................................................................................ 6
Profiles .......................................................................................................................................................... 7
Avamar ................................................................................................................................ 8
Installation Details ......................................................................................................................................... 8
Logging into an Avamar grid and generating an ACDC input file ................................................................. 9
Overview and Execution .......................................................................................................................... 9
Requirements for Performing this Procedure ........................................................................................ 10
ACDC Script Package (Optional) ........................................................................................................... 10
Load and run the acdc.pl script .............................................................................................................. 11
Materials required to perform this activity .............................................................................................. 12
Establish a Connection to the Avamar® ................................................................................................ 12
SSH into the Avamar® Utility Node or Single Node Server .................................................................. 12
Load the dpn keys .................................................................................................................................. 14
Move acdc.pl script onto Avamar Utility Node ....................................................................................... 14
Set the Permissions to executable ........................................................................................................ 14
Run the acdc.pl script ............................................................................................................................ 15
Collect ACDC.xml script output information ........................................................................................... 16
Data Domain...................................................................................................................... 17
Installation Details ....................................................................................................................................... 17
Backup/Archive Apps .................................................................................................................................. 18
Server Manager .......................................................................................................................................... 19
PowerScale ....................................................................................................................... 24
Installation Details ....................................................................................................................................... 24
Getting an Input file from the PowerScale Cluster ...................................................................................... 25
Pre-Requisites ....................................................................................................................................... 25
Steps to Generate and Acquire cfg_capture Output File ....................................................................... 25
PowerStore........................................................................................................................ 26
Installation Details ....................................................................................................................................... 26
Getting an Input file from the PowerStore Cluster ...................................................................................... 27
Pre-Requisites ....................................................................................................................................... 27
Steps to Generate and Acquire array_config_collection(.tar.gz) Output File ........................................ 27
VxRail ................................................................................................................................ 29
Installation Details ....................................................................................................................................... 29
Generating Full JSON File or JSON and XML Output Files ....................................................................... 30
Introduction
The As-Deployed Configuration Generator (ACG) exists to help field personnel document the
configuration of a Data Domain, Avamar, NetWorker, ECS, PowerScale, PowerProtect Data Protection
Series Appliance, PowerStore and VxRail installation. It produces a customer deliverable from an input
file directly from the Data Domain system, Avamar grid, NetWorker instance, ECS appliance, PowerScale
cluster, VxRail appliance and PowerProtect Data Protection Series Appliance.
Inputs:
• GUI
• One of the following:
• Avamar ACDC (Avamar Data Collector) Script output file
• Data Domain Auto support file
• Elastic Cloud Storage (ECS) script output file
• NetWorker NSRDump output file
• PowerProtect Data Protection Series Appliance (IDPA) output file
• PowerScale script output
• PowerStore output files (tar.gz) or JSON file
• VxRail Full JSON or JSON and XML output files
Outputs:
• Word Document.
Regular updates will occur for the ACG tool. The latest version of the as-deployed configuration
generator will be automatically available via a web browser. The client version can be downloaded from
within the Web ACG Tool.
Note: The Data Domain Auto support file, the NetWorker NSRDump file, the VxRail JSON and XML files,
PowerScale python script, ECS Python script, PowerProtect Data Protection Series Appliance XML/DUMP
file, PowerStore tar.gz and json and the Avamar acdc.pl script will be referred to as input files for the
remainder or this document.
Entering Data
When started, the application has five tabs Read First, Dell EMC, Customer, Select Product
(encompassing Data Domain, Avamar, NetWorker, VxRail, ECS, PowerScale, PowerProtect Data
Protection Series Appliance, PowerStore and Generate AC. When selected each tab displays elements
available for editing. It contains edit controls for defining properties strings.
Figure 1
A red border on text field indicates that field is required or indicates the current value in the field is invalid.
A required field may not be blank. In addition, certain fields may not contain certain values, as an
example a phone number may not contain letters. See tooltips on text fields for context sensitive help.
See Figure 2.
Figure 2
Profiles
This application uses profiles to save all the information entered for future reference or to use in the
creation of additional reports. On the Customer screen, after entering all fields’ information will be saved
after changing to different tab.
For example, enter some information in Dell EMC tab with all required field then change tab to Customer
tab, then it will save all entered data automatically.
Note: You may enter multiple SO number’s comma separated into the SO# field.
To embed the customer logo image onto the cover page of the ACG, simply select the Manage Images
button, upload, and select the image file from the drop down. When the thumbnail image appears, this
indicates the selected image will appear on the ACG Report cover page. See Figure 3
Figure 3
Information such as Dell EMC Address, SE and Implementation Consultant are shared across profiles as
they generally stay the same. If you have multiple machines or wish to regen a report, simply select the
profile, and activate it via the pull-down in the Customer Info box on the customer tab and all information
will be reloaded. If you wish you can remove a profile, click the button next to the pull-down in the
Customer Info box on the customer tab and you may edit or delete pull down entries. See Figure 4
Figure 4
Avamar
Installation Details
By using the Avamar tab, users can select Installation and Integration details and specify installation
issues. See Figure 5
Figure 5
Figure 6
Click the download button to download ACDC.pl script to your local system in a directory of your
discretion. Please follow the Readme instructions in the pop-up window.
Note: For instances of customer supplied hardware the script will not return any hardware errors. All
output will be limited to Avamar software checks only.
1. Working with the customer contact, establish an Ethernet connection to the customers’ network.
2. This connection can be virtual with Zoom, using ESRS or physical by connecting to the customer’s
network directly.
Figure 7
Note: If PuTTy.exe is not in your system path, you may receive an error message indicating that the
file or program cannot be found. In this case, open windows explorer and browse to the following path:
C:\AvamarProcedureGenerator\Repository\Tools.
Note: Locate the file PuTTy.exe and double click on it to open the PuTTy application.
4. In the putty window that appears, input the IP Address of the Avamar Utility node that you are
connecting to and then click Open to launch the ssh session. See Figure 8.
Figure 8
5. In the ssh window that opens, you should be prompted to accept the security key, click yes to
continue, and then input the appropriate logon credentials.
6. Login to the Utility node as user admin:
Note: If you are unfamiliar with the login credentials, refer to the Dell EMC® Avamar® Procedure.
Generator → Information Sheet → User Name and Password reference document for proper
credentials.
The banner specifies that you are on the utility node, as shown in the following example.
*****************************************************************
* *
* This is an Avamar Utility Node *
* *
* Please read the documentation before performing *
* any administrative functions on this node. *
* For help, contact EMC at 877.534.2867 (USA only) or *
* http://support.emc.com. *
* *
*****************************************************************
If the keys were not loaded, the the output will say:
Could not open a connection to your authentication agent.
-or-
The agent has no identities.
Note: Notice the permissions bit on the left of the example string. The file is listed as executable by the
‘x’ listed in the permissions bits.
ACDC Completed
13. Once the acdc.pl script is finished, review the output displayed on screen for any checks that reported
a status other than “Collected”. All checks reported other than “Not Configured” will need to be
investigated, prior to continuing with your next activity. Both files are located in the /tmp directory
instead of the ~admin/acdc/ directory as previous releases.
Note: All “FAILED” checks need to be addressed before continuing with your activity. If you are unable to
resolve the issues on your own, follow your normal escalation process to have an SR opened with Dell
EMC Customer Support.
14. Close the SSH session and the DOS box used for this activity.
15. Ensure you are logged into the Avamar Utility Node as admin
16. Use WinSCP or PSCP or an equivalent program to copy the acdc.xml & acdc.log files from the /tmp
directory on the Avamar Utility node to a folder to your desktop PC
17. Using WinScp or pscp copy the log files from the Avamar Utility node by copying and pasting the
following command from your Windows command prompt:
pscp -pw <password> admin@<IP Address>:/tmp/acdc* c:\acdc
Data Domain
Installation Details
The following screen shows the details associated with the Data Domain implementation engagement
and the environment in which the system is installed. See Figure 9
Figure 9
Backup/Archive Apps
The Backup/Archive Apps screen allows the user to specify and select the backup/archive software that is
writing to the Data Domain. The Backup Software Manager allows the user to rename and remove
entries. See Figure 10
Figure 10
Server Manager
The application allows the server to be created and a minimum of a DNS name is required for the server.
From the manager you can create multiple servers and rename or delete them as required per customer
(profile). You can navigate to these servers by pulling down and selecting the required server. You may
also add additional servers when you finished entering a server by click on the Add Server button on the
input screen. See Figure 11
Figure 11
Figure 12
Figure 13
NetWorker
Installation Details
The following screen shows the details associated with the NetWorker implementation engagement and
the environment in which the NetWorker server is installed. See Figure 14
Figure 14
a. Login into the NetWorker Authentication server as a user with Administrator privileges
b. nsrlogon –u Administrator (Syntex may be: NSRLOG*I*N –u Administrator) (This step may
be optional)
3. From the command line issue the following command:
Figure 15
PowerScale
Installation Details
The following screen shows the details associated with the PowerScale implementation engagement and
the environment in which the system is installed. See Figure 16
Figure 16
Figure 17
PowerStore
Installation Details
The following screen shows the details associated with the PowerScale implementation engagement and
the environment in which the system is installed. See Figure 18
Figure 18
1. SSH to Cluster
2. Login as service user (built-in account, port 22).
3. Create a child directory (mkdir cc)
4. svc_arrayconfig run -f json --output cc --type full --config
/cyc_host/cyc_service/conf/ConfigCaptureConfig_ProDeploy.json
5. Move the created JSON files to the current directory. (mv cc/* .)
6. Verify that in the region of 60 new JSON files have been created in the current directory. (ls *.json
|wc -l)
7. Tar/zip the json files (tar -zcvf array_config_collection.tar.gz *.json)
8. Verify that the tar-ball was created successfully. It should be tens of KB in size and should contain in
the region of 60 files. (tar -ztvf array_config_collection.tar.gz |wc -l)
9. Open WinSCP and download the file from the same directory
10. In either WinSCP or SSH (see example command), remove all unnecessary by-products of this
process. Be careful not to remove artifacts that might have been there beforehand. Be selective in
what to delete! e.g. (rm -Rf *.json & rmdir cc)
Optional, Steps to Convert the tar.gz file into a JSON file: (TBD)
VxRail
Installation Details
The following screen shows the details associated with the VxRail implementation engagement and the
environment in which the VxRail appliance is installed. See Figure 19
Figure 19
1. After the VxRail appliance has been successfully installed, log into the vCenter, click on the VxRail
cluster, then click Configure and then under VxRail select Troubleshooting. Click the Create log
bundle. Select VxRail Manager only then click Generate. (NOTE: The Full JSON is NOT
automatically generated as part of the Day 1 bring-up process as the previous JSON & XML file set.
You must generate a log bungle collection for the Full JSON file to be generated. This is functionality
that works as designed and is basically a Day 2 operation/activity.) See Figure 20.
Figure 20
After the log bundle has been generated, SSH into VxRail manager VM and copy the file from the
following location : /var/lib/vmware-marvin/info_for_acg.json
2. Download and save a copy of the VxRail Configuration JSON file (info_for_acg.json).
3. Move or Copy both the info_for_acg.json output file(s) generated from the VxRail appliance to
your local laptop into a designated directory. Direct the ACG Tool to this location to generate your As-
Deployed Configuration Guide report.
To download the JSON file (GUI or Command Line) for versions prior to 7.0.241:
Figure 21
2. Via the command line
Log into vxrial manager mystic / su (just like you're going to run the python script)
Enter the following commands:
cd /var/lib/vmware-marvin/
cp config.json VxRailConfigurationJSON.json
chown mystic VxRailConfigurationJSON.json
Using WINSCP or PSCP or an equialent program (same login as python script)
Log into the vxrail manager IP and mystic via WINSCP/PSCP
Go to ROOT (hit the folder at the top of the list with the up arrow until you hit "root")
Navigate and select /var/lib/vmware-marvin/ folder
Copy VxRailConfigurationJSON.json file to PC
Rename to standard file name (add store name and spaces)
Note: In case the cluster is already built, you must get the JSON file via SSH CLI.
1. Launch the VxRail Manager Dashboard, select > Support > View the Last Configuration Sent > Data
Details and Open XML data in a new window and save as the .XML file
Move or Copy both JSON and XML output files generated from the VxRail appliance to your local laptop
into a designated directory.
2. After the VxRail appliance has been successfully installed, log into the vCenter Server. Select the
VxRail Cluster Monitor tab and select Last Configuration Data Sent under VxRail. Click DOWNLOAD
and save a copy of the VxRail Congiuration XML file.
Figure 23
For detailed instructions on how to log into the Avamar grid, generate output from the acdc script and get
the input file for use in the ACG please see Logging into an Avamar grid and generating an ACDC input
file.
For information about how to generate an NSRDump file on a NetWoker server, please see the
Generating an NSRDump Output.
For information about how to generate Full JSON or JSON and XML file(s) on a VxRail Appliance, please
see the Generating Full JSON File or JSON and XML Output Files.
For information about how to generate an ECS file on a ECS server, please see the Getting an Input file
from the ECS Appliance.
For information about how to generate an PowerScale file on a PowerScale server, please see the
Getting an Input file from the PowerScale Cluster.
For information about how to generate an IDPA file on a IDPA server, please see the Generating an XML
(.dump) Output.
For information about how to generate a PowerStore file on a PowerStore cluster, please see Getting an
Input file from the PowerStore Cluster.
Input and output file location can be modified/changed/saved by going to Edit menu > preferences > or by
pressing Alt + P. Details on how to change locations in the Preferences screen are shown.
To embed the implementation diagram image into the ACG, simply check the Attach Images button,
browse, upload, and select the image file. This selected image will appear in the Implementation Design
Topology section within on the ACG Report. See Figure 24
Figure 24
If any of the required fields were omitted or are incorrect, when the generate button is pressed you will be
presented with dialog listing the fields that must be completed or corrected before a report can be
generated. See Figure 25
Figure 25
Figure 26
If the security warning stating, “Macros have been disabled” does not appear you must open the report,
select all text (ctrl + a) and click update field and update entire table. See Figure 27
Figure 27
Figure 28
Settings
The Settings screen is found under the User menu. See Figure 29
Figure 29
Figure 30
Figure 31
Figure 32
Figure 33
Trouble Shooting
If an error occurs during generation of a report, it will display a pop-up telling you of the error. More
information should be available in the log generated, which can be accessed through the Log item on the
menu bar.
3. [ ] Issue: The ACDC script runs but the screen output shows unconfigured items and the output
word document is incorrect.
Resolution: Verify the user has the latest version of the acdc.pl script. If the acdc version is
older than the most recent version they will need to download the most recent version of the ACG
tool. Download the acdc.pl script from the ACG tool. Load the newest acdc.pl script on the
Avamar utility node. Run the new version on the Avamar node and gather the new output. Rerun
the ACG. If this fails to resolve the issue, escalate.
Details: ACDC .pl script associated with Avamar output is not been updated to the latest version.
root@misdsava1-01:/usr/local/avamar/bin/#: ./acdc.pl
Avamar Configuration Data Collector (ACDC) 3.0.4.1
Localtime 2017/03/07-15:02:23EST
Check: SSH Agent context Available
Check: Avmaint Responding
Check: MC Database Access Established
Avmaint: Config Loaded ... Parsed
Avmaint: Nodelist Loaded ... Parsed
Avmaint: Networkconfig Loaded ... Parsed
Avmaint: Licensing Loaded ... Parsed
GC: Node Count 1
GC: System Name MISDSAVA1-01.CORPNET2.COM
GC: System ID 1487179373@00:1E:67:EB:F5:A2
GC: Customer Number CN-10010633945
GC: Customer Asset ID A-2010012880
GC: Licensed Capacity 8.19 TB
GC: Version GSAN 7.3.1-125
GC: Version EMS Skipped
GC: Version MCS 7.3.1-125
GC: Authentication Local Collected Users:2 Domains:1
GC: Authentication LDAP Maps Collected 2
GC: Authentication LDAP.conf Collected 1
GC: Email Home Collected 2
ACDC Completed
root@misdsava1-01:/usr/local/avamar/bin/#:
4. [ ] Issue: The ACG fails to generate an output and shows an error screen
Resolution: Exam the output file to ensure that it is properly formed and does not have garbage
contained within.
Details: The input file has been corrupted. This can occur on any of the three technologies that
the ACG currenlty parses for. Each technoliges output file will look different however, in all three
cases, large collection of garbage characters should be evident. They are usually, but not
always, contained at the beginning or end of the input file.
Figure 34
Networker Example
<administrator><![CDATA[mpezeur@* tokdemir@* estoermer@* tlozinsk@*
user=administrator,host=abcec1 root@abcec1 root@abcwc1 oracle@abc1 user=root,host=abcc1
user=system,host=abc1 user=abc!,host=* user=abcozz,host=* user=abcoz!,host=*
user=abcale,host=* user=abc!,host=* *@* SrvcEMCusr01@* vmuser@* *@abc1
user=system,host=abc001.us.domainname.com user=root,host=abc1]]></administrator>
<auth_code><![CDATA[510e1ebe]]></auth_code>
<checksum><![CDATA[fF)v^r'QLq<^Oj(17$Kzy*>#/3<T.#eDUT@FL7X_07vlE89~N'n_W%yHY30rB|~;B\
,?B>Nx"MR);\}V[0kL8WXY`V\iMf[P/OZj)C@M}s`IFh)-hCKFB&/OG{XOMXG]]></checksum>
<comment><![CDATA[]]></comment>
<enabler_code><![CDATA[b98c3b-7d45f9-1ba383]]></enabler_code>
<expiration_date><![CDATA[Authorized - No expiration date]]></expiration_date>
<host_id><![CDATA[f82d164c]]></host_id>
<hostname><![CDATA[abc1]]></hostname>
Avamar Example
<mcClient domain="/Exchange" name="mdur-dr-exch02.domainname.com" os="Windows Server 2008 R2
Enterprise Server Edition Service Pack 1 64-bit">
<plugin pid="Windows Agent" description="Windows Client Agent" version="7.0.100-396"/>
<plugin pid="Windows" description="Windows File System" version="7.0.100-396"/>
<plugin pid="VSS" description="Windows VSS" version="7.0.100-396"/>
<plugin pid="Exchange VSS Writer 2007" description="Windows Exchange VSS"
version="7.0.100-396"/>
<plugin pid="update" description="Windows Update" version="7.0.100-396"/>
"acdc.xml" 3731L, 350005C
5. [ ] Issue: The ACG fails to generate an output and shows an error screen
Resolution: Examine the output file to ensure that it is properly formed and the output file was
not “cut off” at the bottom. Rerun the ACG with the new output file.
Details: The input file has been corrupted. This can occur on any of the three technologies that
the ACG currenlty parses for. Each technoliges output file will look different however, in all three
cases, th file will abruptly terminate in the middle of well formed text. Have the user resend, rerun
or recollect the correct output file.
Figure 35
Data Domain ASUP File
KERBEROS Configuration
------------------------------
The system is not joined to any realm.
------------------------------
Connectemc Configuration
------------------------
ConnectEMC has not been configured.
6. [ ] Issue: The ACG fails to generate an output and shows an error screen
Resolution: Examine the output file to ensure that it is properly formed and does not have hideen
characters (line feeds, carriage returns, ascii spaces) contained within. Rerun the ACG with the
new input file.
Details: The input file has been corrupted. This can occur on any of the three technologies that
the ACG currenlty parses for. Each technoliges output file will look different however, in all three
cases, hidden cahracters may be buried in an otherwise nromal looking output. This will not be
obvious. They are usually, but not always, contained at the beginning or end of the input file.
This usually occurs when a user captures the output from a system and cuts and pastes that
inside wordpad as opposed to a text editor like notepad.
Figure 36
Data Domain ASUP
Version info from ddfs executable:
dd_version_timestamp=Wed May 25 00:52:12 2016 GMT
dd_version_checksum=46bb80fcfb698efa0d06a42d4944aad7
dd_version_build_level=nightly
dd_version_change_level=//prod/main/app/...@533819
dd_version_client=//ddfab:533819-052416203758/app/...
dd_version_opened_files=
dd_version_release=6.0.0.0-533819
========== ADD-ON LIST ========== <<< --- and empty space might be here or on any line
7. [ ] Issue: The ACG fails to generate an output and shows an error screen
Resolution: Examine the output file to ensure that user has used the correct type of input file to
generate an output. Rerun the ACG with the new output file.
Details: The input file is correct however, the wrong input product selection box is being used to
parse. An example of this is, if a file from a Data Domin system is used to generate a NetWorker
output this will obviously fail. Have the user either use this file on the correct Input file selection
box or have them generate the correct file from the system in the field and rerun the ACG.
Figure 37
8. [ ] Issue: The Avamar ACDC.pl script fails to execute after it is copied to the Avamar node.
Resolution: The user must follow the Avamar logging into an “Avamar grid and generating an
Ouput file” process included within this guide.
Details: The user does not follow the Avamar process included in this guide The user did not
log into the Avamar utility node with the proper creditials. The proper permissions have not been
set on acdc.pl script (chown).
10. [ ] Issue: The information in the ACG created word document is incorrect, missing or filled with
garbage.
Resolution: Review the specific information issue request with the user. Verify that the
information to be included in the word document is contained in the input file. If the information is
present in the input file but is not present, is wrong or is garbled in the word document then
escalate.
11. [ ] Issue: The user does not want to recreate contact information when migrating from the local
application to the web-based interface.
Resolution: The user should click the import local database feature in the web based
application.
Details: The import local database feature is on the toolbar in the upper right hand corner of the
web based application. Choose the proper location of your local database file.
12. [ ] Issue: The table of contents and references throughout the document are incorrect or refer to
items that should not be present.
Resolution: The user can either rerun the acg and click the buttons mentioned in the details
below, or they can manually update the document using word command features.
Details: The user should, but does not, click the “Enable Editting” and “Enable Content” button
inside Microsoft word when the word document first generates.
Known Issues
Below is the list of known issues that may occur when using the application.
Figure 38
2. [ ] Issue: Data Domain ASUP Only. NTP settings/FTP allowed hosts display $B, 1 or 00 instead of
valid information
Cause: The data in most cases is correct and resides in the dump file against which the report
has been run.
Resolution: Navigate the asup to confirm correctness of data.
4. [ ] Issue: Data Domain ASUP Only. DNS Table is not populated but doesn’t disappear
Cause: The DNS table is not set to disappear when not populated with data. This is to emphasize
importance of DNS configuration being present.
Resolution: If DNS configuration is knowingly omitted from the system, delete the document
section manually.
5. [ ] Issue: Data Domain ASUP Only. SNMP Trap host’s name is not appearing in the table header
Cause: Some SNMP configurations do not have a trap host configured.
Resolution: Navigate ASUP to “config.snmp.trap_hosts” and verify that there are no hosts
specified. Alternatively verify that the line doesn’t exist-as indicated by report output.
6. [ ] Issue: Data Domain ASUP Only. Tables in VTL Information section are empty
Cause: The VTL is enabled on the unit, but is not configured.
Resolution: Navigate through the ASUP to the “VTL Configuration” section and verify
correctness of the output. Delete the tables that are confirmed with not having any data.
Alternatively, leave the tables as an indicator of enabled but not configured VTL.
Report History
The ACG generates a Report History. Reports will be stored within the database and can be downloaded
or deleted from the following screen: See Figure 39
Figure 39
Support
If an error occurs and it cannot be trouble shot then the following files should be sent to
https://central.dell.com/central/help/request-support.
If an error occurs and it cannot be trouble shot then the following files should be sent to
https://central.dell.com/central/help/request-enhancement.
Figure 40