dcTrack Upgrade and Reinstallation Quick Reference
dcTrack 6.0.3 Upgrade & Reinstallation Guide
This document contains proprietary information that is protected by copyright. All rights reserved. No part of this document may be photocopied, reproduced, or translated into another language without express prior written consent of Sunbird™. © Copyright 2017 Sunbird. All third-party software and hardware mentioned in this document are registered trademarks or trademarks of and are the property of their respective holders. FCC Information This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a commercial installation. This equipment generates, uses, and can radiate radio frequency energy and if not installed and used in accordance with the instruc tions, may cause harmful interference to radio communications. Operation of this equipment in a residential environment may cause harmful interference. VCCI Information (Japan)
Sunbird is not responsible for damage to this product resulting from accident, disaster, misuse, abuse, non-Sunbird modi fication of the product, or other events outside of Sunbird's reasonable control or not arising under normal operating con ditions. If a power cable is included with this product, it must be used exclusively for this product.
Table of Contents
Table of Contents Read This First - Who Needs to Upgrade and Who Needs to Reinstall Manually Back Up Your dcTrack Database Upgrading dcTrack
3 5 6 7
Recommended Steps Before Upgrading dcTrack
7
Update the Item Models Library
9
Download the dcTrack Upgrade BIN File
10
Change the Web Session Timeout for dcTrack
10
Reinstalling dcTrack
12
Reinstall High-Level Steps
12
Retrieve the ISO File
12
Verify The Datastore and Upload the ISO File to the Datastore
12
Create the dcTrack Virtual Machine
13
Load/Install/Reinstall dcTrack on the Virtual Machine
14
Configure Network Access
15
Restore a dcTrack Database from a Backup File
16
Impacts and Steps After Upgrading and/or Reinstalling dcTrack Virtual Machine Requirements and Recommendations
3
18 33
4
Read This First - Who Needs to Upgrade and Who Needs to Reinstall Depending on the current version of dcTrack you are using, you will either upgrade to dcTrack 6.0.0 and higher or rein stall dcTrack to move to Release 6.0.0 and higher. Contact Sunbird Professional Services and Support at http://support.sunbirddcim.com with issues or questions.
dcTrack 5.x Users - Upgrade dcTrack 5.x users upgrade to dcTrack 6.0.0. Download the BIN file that is available on the Sunbird Support site at http://support.sunbirddcim.com.
dcTrack 4.x Users - Reinstall dcTrack 4.x users must reinstall dcTrack to move to version 6.0.0. Download the ISO that is available on the Sunbird Support site at http://support.sunbirddcim.com.
dcTrack 3.x users - Reinstall dcTrack 3.x users must reinstall dcTrack to move to version 6.0.0. Download the ISO that is available on the Sunbird Support site at http://support.sunbirddcim.com.
dcTrack 2.x Users - Contact Professional Services and Support dcTrack 2.x users should contact Professional Services and Support via the Sunbird Support site at http://sup port.sunbirddcim.com or via email ([email protected]) for assistance.
5
Manually Back Up Your dcTrack Database Backups of system data, users and configuration settings are automatically created every 24 hours. Optionally, you can create a backup as needed by following the steps in this topic. It is recommended that you manually back up your dcTrack database before upgrading or reinstalling dcTrack (to cre ate a database backup file that you will use to restore your dcTrack data). Use a dcTrack recovery license in order to make a disaster recovery backup of your database, if needed. 1. In the Web Client, click Admin > Appliance Settings to open the Settings page. 2. Click Data Backups in the Data Management section to open the Data Backups page.
3. In the Backup Archives section, click Create. The file is created and added to the top of the list under Filename. An MD5 file is also created along with the backup file for verification purposes.
6
Upgrading dcTrack Note: It is recommended that you back up your dcTrack database manually and update your Models Library before upgrading dcTrack. Important: Do not reboot your dcTrack server before the upgrade is complete or your database may be corrupted.
Recommended Steps Before Upgrading dcTrack l l l l
Manually Back Up Your dcTrack Database Update the Item Models Library Download the dcTrack Upgrade BIN File Change the Web Session Timeout for dcTrack
To upgrade dcTrack: 1. In the Web Client, click Admin > Appliance Settings. The Settings page opens in a new browser window or tab. 2. In the Appliance Administration section, click Software Upgrades.
3. Click Browse and select the upgrade bundle .BIN file.
Note: The upload may take 90 minutes or more. The new firmware uploads to dcTrack, and a series of status bars and validations are displayed.
7
4. Click Check System Compatibility on the Release Notes dialog once the upgrade validation is complete. Contact Sunbird Professional Services and Support at http://support.sunbirddcim.com with any issues that are encountered.
5. Click Install on the System Check Status dialog once you receive a Success message. A progress shows the upgrade progress, and the system reboots when the upgrade is complete.
6. On the Upgrade Success dialog, click OK.
7. Log out of dcTrack. 8. Reopen your browser and log back in to dcTrack to begin using the application.
Important: Clear your browser's cache entirely, including all temp files, cookies, favorites and so on to ensure all Adobe Flash® content is removed, then close the browser. See your browser help for steps on clearing your browser's cache.
8
Update the Item Models Library Before adding data centers, items and locations for the first time, update the Item Models Library. This helps ensure you are work with the most current models available.
What To Do if a Model is Not in Your Item Models Library Note that you can do one of the following to request a model/make be added to the Sunbird Master Models Library file contact: l
Add a Model to the Models Library (provided you have privileges to do so).
l
Request a New Item Make/Model be Added to the Models Library.
l
Contact Sunbird Professional Services and Support to request a model be added to the library and included in the next Sunbird Master Models Library file releases
Item Models Library Updates Wizard Updates are performed using the Library Update Wizard that walks you through each step of the process.
Note: Customers currently on dcTrack 2.6.1 (or earlier) are advised to update to the latest available Sunbird Master Models Library file before upgrading to dcTrack 5.1.0.
Update the Models Library (High-Level Steps) 1. If you have not already done so, download the most recent Sunbird Master Models Library file and save it locally. 2. In the Models Library, select Actions > Update Models Library to access the Library Update Wizard. 3. On the first step (welcome screen), click Start a New Update Session to start the wizard. The results of the previous update will be displayed if available. 4. On the second step, click Browse to locate the Sunbird Master Models Library file you saved locally. The file upload takes place in two stages: uploading and then processing/staging. Once this step has completed, the following message is displayed: "Models Library Staging is successful without any errors or warnings. You may now proceed to next step." Click the green arrow to the right of the steps to proceed. 5. Map information. Each step displays the items that do not exactly match the database objects. Users will be able to add non-match ing items to the database or can select objects from a list of potential matches. Items that match exactly will be automatically updated in the database. These items are not displayed. If there is information in the Sunbird Master Models Library file that is not in your Item Models Library, it is auto matically copied to your library once the wizard completes.
9
n n n n n n n
Step 3 maps Data Connectors. Step 4 maps Power Connectors. Step 5 maps Protocols. Step 6 maps Data Rates. Step 7 maps Breakers and Fuses. Step 8 maps Makes. Step 9 maps Models.
Certain rows in the grid may be flagged with a Warning or Error icons. Hovering the mouse over the icon reveals the issue that you may be able to correct by changing the Best Match selection, or for certain errors, you must choose the Skip action and resolve the problem in your system. 6. In Step 9, you will be able to generate a spreadsheet of Classis and Blade Items affected by the update (if any) and a spreadsheet of Actions on Models in the Update. Click the Export button to view these options. 7. On Step 10, click Begin Library Update to begin the library update. New models are added and existing model information is updated once Begin Update is selected. As the process is underway, monitor the progress using the progress bar. No additional input is required, and the update can be left to run unattended. 8. Once the update is complete, the results will be displayed in the Results and Progress box.
Download the dcTrack Upgrade BIN File Download the upgrade BIN file available on the Sunbird Support site at http://support.sunbirddcim.com, and save it loc ally.
Change the Web Session Timeout for dcTrack The web session timeout determines the length of time dcTrack remains idle before logging a user off. 1. In the Web Client, click Admin > Appliance Settings.
The Settings page opens. 2. In the Security and Encryption section, click Other Security Settings.
10
3. In the User Session Timeout box, select Never from the "Log users out" drop-down. 4. Click Save Timeout. A "User sessions will not time out" confirmation appears at the top of the page. 5. To apply the new session timeout, log out of dcTrack, then log back in.
11
Reinstalling dcTrack This topic applies to dcTrack 3.x users who are moving to dcTrack 5.x. Contact Sunbird Professional Services and Support at http://support.sunbirddcim.com with issues or questions.
Note: It is recommended that you manually back up your dcTrack database before upgrading or reinstalling dcTrack (to create a database backup file that you will use to restore your dcTrack data).
Reinstall High-Level Steps l l l l l l l
Manually Back Up Your dcTrack Database Retrieve the ISO File Verify The Datastore and Upload the ISO File to the Datastore Create the dcTrack Virtual Machine Load/Install/Reinstall dcTrack on the Virtual Machine Configure Network Access Restore a dcTrack Database from a Backup File
Retrieve the ISO File If you have not already done so, download the most recent dcTrack ISO file from the Sunbird Support page at http://support.sunbirddcim.com/support
Verify The Datastore and Upload the ISO File to the Data store Verify the datastore has 160GB free for a new virtual machine, and 2.8GB free for the installation ISO file. Upload the ISO file to the datastore.
Note: An additional 3GB of space may be needed to upload the ISO so it can be installed.
12
Create the dcTrack Virtual Machine See Virtual Machine Requirements and Recommendations for information on the number of virtual processors and the amount of memory allocated for the virtual machine. These instructions apply to both new installations and reinstallations of dcTrack.
Note: The following steps are provided as an example of a virtual machine installation; follow your installation pref erences if they differ. 1. Connect to the VMware server using vSphere client. 2. Log in as a user that has permission to create, start, and stop virtual machines. 3. Select the server you want to create the virtual machine on. 4. In the Summary tab, click New Virtual Machine in the Command box. 5. Choose Custom. Click Next. 6. Enter a name for the virtual machine. Click Next. 7. Select a destination storage location for the virtual machine files. Click Next. 8. You may need to select the Virtual Machine Version, depending on your host. Select the version. Click Next. 9. Select Linux for the Guest Operating System, then select CentOS 64-bit, if available, from the Version drop-down. If CentOS 64-bit is not available, select Other Linux (64-bit). Click Next. 10. Select 1 for the "Number of virtual sockets". Select 1 for the "Number of cores per virtual socket". Click Next. 11. Adjust the amount of memory allocated for the virtual machine to at least the minimum required. Click Next. 12. Select the NIC and specify its Network. Click Next. 13. Select LSI Logic Parallel for the SCSI Controller. Click Next. 14. Select "Create a new virtual disk." Click Next. 15. Under Capacity, set the Disk Size to 160GB (based on your earlier datastore selection), select "Thick Provision Lazy Zeroed" under Disk Provisioning, and select "Store with the virtual machine" under Location. Click Next. 16. Leave all advanced options at default. Click Next. 17. Click Finish to save the drive and return to the main dialog. 18. Click Finish to create the virtual machine.
13
Load/Install/Reinstall dcTrack on the Virtual Machine 1. Select VM and right click Edit Settings. 2. Select Options > Advanced > Boot Options and select Force BIOS Setup. 3. Click "Power on" to power up the virtual machine. 4. Click on the CD/DVD ROM icon at the top of the console window and select "Connect to ISO image on datastore". 5. Locate and upload the ISO file. Download the ISO from the Sunbird Support page at http://support.sunbirddcim.com if you have not already done so. 6. Select the datastore. 7. Select the dcTrack ISO. 8. Click on the Console tab. 9. Click inside the console window. 10. Exit the BIOS by selecting Exit Saving Changes and pressing the Enter key. The dcTrack Kickstart page opens. 11. Press Enter to begin installation. 12. When the installation completes, press Enter to reboot the dcTrack virtual machine. The virtual machine reboots and displays a console prompt. 13. Next, Configure dcTrack Network Access.
14
Configure Network Access 1. 2. 3. 4. 5. 6.
7. 8. 9. 10. 11.
After installing or reinstalling the application, you must configure it for access over your network. Access the local port from the Console tab of the VMware Infrastructure Client. When prompted to log in, enter the username config and the password sunbird . The configuration page opens. Select Networking Setup, then select Setup LAN 1 to configure the primary Ethernet port. Press the Space bar to select "Enable this LAN Port". To manually assign the network settings to the application: l Deselect "Use DHCP". l Type the IP address and network masks into the appropriate fields. l Select Accept to reset the network interface. To setup the gateway IP address, select Setup IPv4 Network Routes and type the appropriate IP address in the Default Gateway Route field. Select Accept to reset the network interface. o If using DHCP, note the address. There must be a DHCP server available on the LAN. If you are using a second network interface, configure it by selecting Setup LAN 2 from the Network Con figuration menu, then perform the same steps as you did for LAN 1. Select Ping Network Test to ensure the application is communicating over the network. Select Name Servers under Network Configuration to setup the server names. o If server names are not set up, DNS names cannot be resolved.
Note: Failing to configure DNS servers causes LDAP integration issues. 12. To increase security, it is advisable to disable SSH remote access. Optional. 13. Select /Networking Setup/Setup Access Controls . 14. Enable Block SSH. By default, the config account has access to the application. SSH is re-enabled if a support connection is created. 15. Select Exit from the main menu. You can now access the application from any client on the network.
15
Restore a dcTrack Database from a Backup File Note: This topic is specific to a general database restore. For details on restoring your database after you reinstall dcTrack 4.0.0 when moving from a lower dcTrack version, see Reinstalling dcTrack. Provided you created a backup file of your dcTrack database, you can use the file to restore your database.
Supported Backup File Versions As a best practice, restore your database with a backup from the same version of dcTrack. For example, restore a dcTrack 4.0.0 database with a dcTrack 4.0.0 backup file, restore a dcTrack 3.2.0 database with a dcTrack 3.2.0 backup file, and so on. You can restore your database with a backup from an earlier version of dcTrack but the backup cannot be older dcTrack 3.1.0. Sunbird does not recommend doing this as standard practice.
Note: Since you cannot use a database backup file from dcTrack 3.0.1 and earlier, you must first upgrade to dcTrack 3.1.0 at a minimum. Follow the recommended upgrade process outlined in Upgrade Compatibility, and/or contact Sun bird Customer Support for assistance.
1. In the Web Client, click Admin > Appliance Settings to open the Settings page. 2. Click Data Backups in the Data Management section to open the Data Backups page.
16
3. In the "Restore a Backup Archive" section, click Browse to locate and select a backup file. 4. Click Upload. The amount of time it takes to restore your database depends on the size of your database. Once the completed, dcTrack data and configuration settings are restored to the backup's configuration settings, and the server is rebooted. 5. Log out of dcTrack. 6. Important - Clear your browser's cache entirely, including all Temp files, cookies, favorites and so on to ensure all Adobe Flash® content is removed, then close the browser. See your browser help for steps on clearing your browser's cache. 7. Reopen your browser and log back in to dcTrack to begin using the application.
17
Impacts and Steps After Upgrading and/or Rein stalling dcTrack The following refer to upgrading to dcTrack 5.1.0 from dcTrack 4.x, or moving to dcTrack 5.1.0 by reinstalling dcTrack and restoring a dcTrack 3.2 database.
Current Function
Change in New Release
Action Required/No Action Required
Virtual Power Chain is enabled for one or more locations
None
No action is required
dcTrack is integrated with one or more Power IQs
None
No action is required as long as data are in sync
Continuing to use local user authentication
None
No action is required
Continuing to use manual LDAP (Find LDAP Users)
LDAP settings are mapped to fields on new screens created to accommodate the new automatic LDAP feature
No action is required
Moving to import LDAP user groups and automatically adding users
New in dcTrack 5.0.0
Action is required if you are moving to the new feature from manual LDAP or local authentication
Moving to manual LDAP from local authentication
None
Action is required
Virtual Power Chain is Enabled for One or More Location and/or You Have Existing Virtual Power Chain Connections No Action Required This is an optional, existing feature as of dcTrack 4.0. For details of Virtual Power Chains and Virtual Power Chain con nections, see dcTrack online help. When you upgrade to dcTrack 5.0 or do a reinstall/restore to move to dcTrack 5.0, Virtual Power Chain remains enabled for each of your locations and all of your VPC connections remain.
18
Currently Integrated with One or More Power IQs No Action Required This is an optional, existing feature as of dcTrack 3.2.0. For details on Power IQ integration, see dcTrack online help. If you are managing multiple Power IQs in your dcTrack 3.2.0 or later application, as long as your data are synced cor rectly, you do not have to take extra steps after you reinstall dcTrack 5.0.0 and you restore your database. Important: If you believe your data are out of synch between dcTrack and Power IQ, Professional Services and Support must help you sync your data. Contact Professional Services and Support via the Support website at http://sup port.sunbirddcim.com or via email ([email protected] ).
Continuing to Use Local Authentication No Action Required This is an existing, default feature in dcTrack in which users are locally authenticated using their dcTrack credentials. There is no impact on this feature after an upgrade or reinstall/restore. So, if you plan on continuing to use local authen tication, you do not have to make any changes to your settings.
Continuing to Add LDAP Users Manually No Action Required If you are currently manually importing LDAP users, when you upgrade to dcTrack 5.0 or do a reinstall/restore to move to dcTrack 5.0, your current LDAP settings remain the same and you do not need to take further steps. The only dif ference you will notice is the change in pages and fields that contain the setting information. Your existing information is mapped to these fields automatically. To view the settings in dcTrack 5.0 that map to the 3.x or 4.x pages and fields 1. Select Admin > Appliance Settings to access the Settings page. 2. Select LDAP Server Settings to open the LDAP Servers page. 3. Your current server is displayed on the page. Only one server is listed since only one is supported by manual LDAP in 3.2 and 4.x.
19
4. Click on the server to view your settings in the General, Connection and Bind Sections. 5. Under Groups, 'Use Groups for Authorization' are unchecked since the setting is not applicable to manual LDAP and did not transfer. 6. Manage Certificates is not checked since it is a new setting to dcTrack 5.0. 7. Referrals is selected or deselected depending on your previous settings. 8. Click your browser's back button to return to the LDAP Servers page.
9. Click Common Settings on the LDAP Servers page. 10. Note that 'Enable LDAP sync' and 'Sync Group Members' are unchecked.
20
dcTrack 3.x and 4.0 LDAP Pages Compared to dcTrack 5.0
21
dcTrack 3.2 LDAP Settings
22
dcTrack 5.0.0 LDAP Settings
dcTrack 4.0 LDAP Settings
dcTrack 5.0 Settings
Moving to Import LDAP User Groups and Add Users Automatically in dcTrack 5.0 When You Are Currently Adding LDAP Users Manually Action Required Note: This topic is specific to users who are currently using manual LDAP. If you are using the import user groups and add users automatically feature for the first time, see Import LDAP User Groups and Add Users Automatically. Previous versions of dcTrack provided manual LDAP, also referred to as the "Find LDAP Users" feature. This feature allowed you to add and authenticate users via LDAP. However, since you could not sync each user's LDAP account with dcTrack, you had to maintain accounts for them on the LDAP server and dcTrack. In essence, you were maintaining user information in two places. dcTrack 5.0.0 now provides you with the ability to import user groups and add users automatically. Once added, you can enable automatic syncing. Syncing pushes user and user group updates from the LDAP server to dcTrack.
23
If you do not want to move to this new feature, you do not need to take additional action and can skip this topic - your cur rent LDAP settings were applied when you upgraded or performed a reinstallation/database restore to move to dcTrack 5.0.0. If do want to move to this new feature, there are additional steps you must take. Follow the steps outlined in this topic in order to ensure your current LDAP configuration is not impacted.
Note: dcTrack Administrators should work with LDAP Administrators to plan how dcTrack users will be grouped, as well as when performing the steps to add user groups to dcTrack and sync user groups between the LDAP server and dcTrack. 1. Select Admin > Appliance Settings to access the Settings page. 2. Select LDAP Server Settings. The LDAP Servers page opens. Your existing server appears on the LDAP Servers page. In steps that follow, we configure your existing server to import user groups and add users automatically. For steps on adding additional servers, see Import LDAP User Groups and Add Users Automatically.
3. Click on your server to edit it.
General, Connection and Bind Information This information is automatically populated based on your existing server information. 4. Update information, if needed. 5. If needed, update the server to Active Directory or LDAP.
24
6. Set the Search Credentials to use "admin credentials" to allow for automatic sync, if needed. 7. If you need to validate LDAP server certificates, select Check Server Certificate. This feature is new to dcTrack 5.0.0. 8. Next, click Manage Certificates to open the Trusted Certificates page.
9. Click Import Certificate to open the Import Trusted Certificate page. 10. Use the Browse function to locate the certificate, then click Import to import the certificate.
Group Information
25
Enter the information required to add user groups using LDAP. The information you enter may vary between LDAP serv ers and Active Directory servers.
Note: Ensure that user groups are added before syncing to prevent LDAP authenticated users from being inadvertently removed. 11. User Groups for Authorization and Common Setting – ‘User Groups for Authorization’ and ‘Sync Group Members’ are used together so user groups can be imported and then managed. Enabling ‘User Groups for Authorization’ will allow user groups to be discovered, reviewed and imported as needed. Then, after the user groups have been added, enabling ‘Sync Group Members’ will automatically add or remove users based on group membership information provided by LDAP. 12. Use Group Search DN - select to specify the group DN to search. Select this option if the group DN search is dif ferent than the search used for users. 13. Group Search DN - this is where the search for the user group will begin in the directory. 14. Group ID Attribute - the default for Active Directory is sAMAccountName. for Active Directory and gidNumber for LDAP. 15. Group Member Attribute - the default for Active Directory is member and the default for LDAP is memberUid. 16. Group Search Filter - the default for Active Directory is (objectClass=group)and the default for LDAP is(objectClass s=posixGroup). 17. Group Search Scope - level of the server directory to look for groups; either the Base DN and one level below the Base DN, or the Base DN and the entire subtree.
18. Optional Test Connection is to test with an account. If you have a known, valid test account to use to test the server setup, you can test from here without having to try to login with that account.
26
19. Click Save to save the settings. You are returned to the LDAP Server Settings page and success message is displayed. Search for Remote Users and/or User Groups and Add Them to dcTrack 1. On the Add LDAP Server page, click Search.
The Search for LDAP Users and Groups page opens. 2. Select the server you want to search. The remaining server information is completed based on the server you selected earlier, or you can edit the information by entering a new server to search. 3. Select the type of search - Users or Groups, depending on how the server is configured in dcTrack. 4. Select the Follow Referrals checkbox, if desired. 5. Search Scope is prepopulated based on the scope you defined when adding the server. You can change the scope of the search, if desired. This is the level of the server directory to look for users or groups. You can search just the Base DN by selecting "Base", search the Base DN and one level below the Base DN by selecting "One", or search the Base DN and the entire subtree by selecting "Subtree".
27
6. Click Search to locate users or user groups on the server. 7. A list of results is displayed once found. You can now add users and/or groups to dcTrack from those found. To add users or groups found in an LDAP search, select the checkbox next to each user and/or user group in the list, then click Add. In order to search and add user groups, the ‘Use Groups for Authorization’ option must be enabled on the Server page. When searching for and adding user groups, one or more groups can be selected at a time. The users will not be auto matically added unless the Common Settings – ‘Sync Group Members’ is enabled.
28
When searching for and adding user groups, clicking on a user group causes the group members to be listed below the user group grid. One or more group members can be selected to be added.
29
Successfully added users/user groups are listed as "Exists as LDAP user" and the checkbox next to the name is removed. Review the users in your user groups and verify they are correct. Once added, individual users are granted distinct permissions and authenticated on a per user basis. Users in user groups are granted common access to specific features or functionality. Any changes you make to a user or user group on the server are reflected in dcTrack. For example, if you delete a user from a user group, they are no longer able to access the features they previously could in dcTrack. Next, configure sync settings and sync to import user group members that are not already imported. 1. Click Common Settings on the LDAP Servers page.
30
2. Check 'Enable LDAP sync' and check 'Sync Group Members' before you sync.
3. Click Sync Now. On sync, dcTrack updates the user groups you added to reflect the group members reported by the LDAP server. This imports user groups into dcTrack from LDAP.
Import LDAP Users Groups and Add Users Automatically in dcTrack 5.0 When You Are Currently Using Local Authentication Action Required In dcTrack 5.0 and higher, you have the option to import user groups and add users in those groups automatically. You can then manage users and groups via LDAP by syncing with dcTrack. If you want to begin using this feature, you must configure it in dcTrack. See Automatically Add and Manage Users/User Groups via LDAP or Active Directory in dcTrack online help for steps.
Note: Follow the steps in the online help topic only if it is the first time you are setting up automatic, remote LDAP authen tication.
31
Moving to Manual LDAP Authentication in dcTrack 5.0 When You Are Cur rently Using Local Authentication Action Required Instead of using automatic, remote authentication, you are able to use the existing, manual LDAP feature. This is an optional feature in dcTrack that allows you to manually find and add users to dcTrack using LDAP. Users are authen ticated based on their LDAP credentials instead of their dcTrack credentials. However, you cannot manage users with this feature since an LDAP/dcTrack sync does not occur. For details on this feature, see Manually Add and Manage Users via LDAP or Active Directory (Find Users) in dcTrack online help. In previous versions of help, this feature was referred to as Find LDAP Users.
32
Virtual Machine Requirements and Recom mendations Requirements l
Your dcTrack virtual machine must be given priority.
l
Configure ESXi so that all required resources are available on the dcTrack virtual machine at all times.
l
Note that manipulating ESXi settings or changing the priority of other virtual machines running on the same ESXi host may impact the ESXi scheduling policy.
If this happens, resources may be diverted from the dcTrack virtual machine, which may result in poor performance or dcTrack malfunctioning.
Note: dcTrack supports VMware Version 5.0 and higher.
Minimum VMware Host Recommendations VMware host minimum configuration recommendations for dcTrack 5.1.0 and higher:
Number of Cabinets
RAM (GB)
CPU (Cores)
Datastore (GB)
CentOS
VMWare
Up to 200
8
4
160
64-Bit
ESX/ESXi
201 to 1000
8
6
160
64-Bit
ESX/ESXi
1001 to 1500
8
8
160
64-Bit
ESX/ESXi
1501 to 2000
10
8
160
64-Bit
ESX/ESXi
2000 to 3000
12
8
160
64-Bit
ESX/ESXi
More than 3000
14
8
160
64-Bit
ESX/ESXi
Note: An additional 3GB of space may be needed to upload the ISO so it can be installed. Alternatively, the ISO can be installed directly from the DVD.
Required TCP Ports The following TCP ports are required to be open when building your virtual machine:
33
l
443 - HTTPS (secure channel)
This port must be open in order to access the dcTrack login page. l
5432 - Postgres DB
PostgresDB 5432 is not encrypted but must remain open. Classic View uses this port to connect to the dcTrack database and does not work if the port is closed. l
443 - HTTPS (secure channel)
This port must be open in order to access the dcTrack login page. l
123 - UDP
This port must be open for NTP time sync to work.
Optional TCP Ports Leaving the following TCP ports open is optional. If you do not leave these ports open, note the requirements and/or limitations indicated here. l
22 - SSH
It is not necessary to have the SSH port open since SSH functionality is available directly on the virtual machine con sole. If port 22 is not open, however, SSH cannot be used to access dcTrack to perform diagnostic operations of any kind. l
80 - HTTP
If port 80 is not open, users must specify HTTPS:// when entering the dcTrack URL in their browser. l
514 - TCP
Port 514 is required to forward system logs. l
161 - TCP
Port 161 is required for SNMP discovery via Classic View. l
25, 465, 587 - SMTP
Email SMTP connectivity requires the appropriate port(s) be open. These may vary based on your organization.
34
This document contains proprietary information that is protected by copyright. All rights reserved. No part of this document may be photocopied, reproduced, or translated into another language without express prior written consent of Sunbird™. © Copyright 2017 Sunbird. All third-party software and hardware mentioned in this document are registered trademarks or trademarks of and are the property of their respective holders. FCC Information This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a commercial installation. This equipment generates, uses, and can radiate radio frequency energy and if not installed and used in accordance with the instruc tions, may cause harmful interference to radio communications. Operation of this equipment in a residential environment may cause harmful interference. VCCI Information (Japan)
Sunbird is not responsible for damage to this product resulting from accident, disaster, misuse, abuse, non-Sunbird modi fication of the product, or other events outside of Sunbird's reasonable control or not arising under normal operating con ditions. If a power cable is included with this product, it must be used exclusively for this product.
Table of Contents
Table of Contents Read This First - Who Needs to Upgrade and Who Needs to Reinstall Manually Back Up Your dcTrack Database Upgrading dcTrack
3 5 6 7
Recommended Steps Before Upgrading dcTrack
7
Update the Item Models Library
9
Download the dcTrack Upgrade BIN File
10
Change the Web Session Timeout for dcTrack
10
Reinstalling dcTrack
12
Reinstall High-Level Steps
12
Retrieve the ISO File
12
Verify The Datastore and Upload the ISO File to the Datastore
12
Create the dcTrack Virtual Machine
13
Load/Install/Reinstall dcTrack on the Virtual Machine
14
Configure Network Access
15
Restore a dcTrack Database from a Backup File
16
Impacts and Steps After Upgrading and/or Reinstalling dcTrack Virtual Machine Requirements and Recommendations
3
18 33
4
Read This First - Who Needs to Upgrade and Who Needs to Reinstall Depending on the current version of dcTrack you are using, you will either upgrade to dcTrack 6.0.0 and higher or rein stall dcTrack to move to Release 6.0.0 and higher. Contact Sunbird Professional Services and Support at http://support.sunbirddcim.com with issues or questions.
dcTrack 5.x Users - Upgrade dcTrack 5.x users upgrade to dcTrack 6.0.0. Download the BIN file that is available on the Sunbird Support site at http://support.sunbirddcim.com.
dcTrack 4.x Users - Reinstall dcTrack 4.x users must reinstall dcTrack to move to version 6.0.0. Download the ISO that is available on the Sunbird Support site at http://support.sunbirddcim.com.
dcTrack 3.x users - Reinstall dcTrack 3.x users must reinstall dcTrack to move to version 6.0.0. Download the ISO that is available on the Sunbird Support site at http://support.sunbirddcim.com.
dcTrack 2.x Users - Contact Professional Services and Support dcTrack 2.x users should contact Professional Services and Support via the Sunbird Support site at http://sup port.sunbirddcim.com or via email ([email protected]) for assistance.
5
Manually Back Up Your dcTrack Database Backups of system data, users and configuration settings are automatically created every 24 hours. Optionally, you can create a backup as needed by following the steps in this topic. It is recommended that you manually back up your dcTrack database before upgrading or reinstalling dcTrack (to cre ate a database backup file that you will use to restore your dcTrack data). Use a dcTrack recovery license in order to make a disaster recovery backup of your database, if needed. 1. In the Web Client, click Admin > Appliance Settings to open the Settings page. 2. Click Data Backups in the Data Management section to open the Data Backups page.
3. In the Backup Archives section, click Create. The file is created and added to the top of the list under Filename. An MD5 file is also created along with the backup file for verification purposes.
6
Upgrading dcTrack Note: It is recommended that you back up your dcTrack database manually and update your Models Library before upgrading dcTrack. Important: Do not reboot your dcTrack server before the upgrade is complete or your database may be corrupted.
Recommended Steps Before Upgrading dcTrack l l l l
Manually Back Up Your dcTrack Database Update the Item Models Library Download the dcTrack Upgrade BIN File Change the Web Session Timeout for dcTrack
To upgrade dcTrack: 1. In the Web Client, click Admin > Appliance Settings. The Settings page opens in a new browser window or tab. 2. In the Appliance Administration section, click Software Upgrades.
3. Click Browse and select the upgrade bundle .BIN file.
Note: The upload may take 90 minutes or more. The new firmware uploads to dcTrack, and a series of status bars and validations are displayed.
7
4. Click Check System Compatibility on the Release Notes dialog once the upgrade validation is complete. Contact Sunbird Professional Services and Support at http://support.sunbirddcim.com with any issues that are encountered.
5. Click Install on the System Check Status dialog once you receive a Success message. A progress shows the upgrade progress, and the system reboots when the upgrade is complete.
6. On the Upgrade Success dialog, click OK.
7. Log out of dcTrack. 8. Reopen your browser and log back in to dcTrack to begin using the application.
Important: Clear your browser's cache entirely, including all temp files, cookies, favorites and so on to ensure all Adobe Flash® content is removed, then close the browser. See your browser help for steps on clearing your browser's cache.
8
Update the Item Models Library Before adding data centers, items and locations for the first time, update the Item Models Library. This helps ensure you are work with the most current models available.
What To Do if a Model is Not in Your Item Models Library Note that you can do one of the following to request a model/make be added to the Sunbird Master Models Library file contact: l
Add a Model to the Models Library (provided you have privileges to do so).
l
Request a New Item Make/Model be Added to the Models Library.
l
Contact Sunbird Professional Services and Support to request a model be added to the library and included in the next Sunbird Master Models Library file releases
Item Models Library Updates Wizard Updates are performed using the Library Update Wizard that walks you through each step of the process.
Note: Customers currently on dcTrack 2.6.1 (or earlier) are advised to update to the latest available Sunbird Master Models Library file before upgrading to dcTrack 5.1.0.
Update the Models Library (High-Level Steps) 1. If you have not already done so, download the most recent Sunbird Master Models Library file and save it locally. 2. In the Models Library, select Actions > Update Models Library to access the Library Update Wizard. 3. On the first step (welcome screen), click Start a New Update Session to start the wizard. The results of the previous update will be displayed if available. 4. On the second step, click Browse to locate the Sunbird Master Models Library file you saved locally. The file upload takes place in two stages: uploading and then processing/staging. Once this step has completed, the following message is displayed: "Models Library Staging is successful without any errors or warnings. You may now proceed to next step." Click the green arrow to the right of the steps to proceed. 5. Map information. Each step displays the items that do not exactly match the database objects. Users will be able to add non-match ing items to the database or can select objects from a list of potential matches. Items that match exactly will be automatically updated in the database. These items are not displayed. If there is information in the Sunbird Master Models Library file that is not in your Item Models Library, it is auto matically copied to your library once the wizard completes.
9
n n n n n n n
Step 3 maps Data Connectors. Step 4 maps Power Connectors. Step 5 maps Protocols. Step 6 maps Data Rates. Step 7 maps Breakers and Fuses. Step 8 maps Makes. Step 9 maps Models.
Certain rows in the grid may be flagged with a Warning or Error icons. Hovering the mouse over the icon reveals the issue that you may be able to correct by changing the Best Match selection, or for certain errors, you must choose the Skip action and resolve the problem in your system. 6. In Step 9, you will be able to generate a spreadsheet of Classis and Blade Items affected by the update (if any) and a spreadsheet of Actions on Models in the Update. Click the Export button to view these options. 7. On Step 10, click Begin Library Update to begin the library update. New models are added and existing model information is updated once Begin Update is selected. As the process is underway, monitor the progress using the progress bar. No additional input is required, and the update can be left to run unattended. 8. Once the update is complete, the results will be displayed in the Results and Progress box.
Download the dcTrack Upgrade BIN File Download the upgrade BIN file available on the Sunbird Support site at http://support.sunbirddcim.com, and save it loc ally.
Change the Web Session Timeout for dcTrack The web session timeout determines the length of time dcTrack remains idle before logging a user off. 1. In the Web Client, click Admin > Appliance Settings.
The Settings page opens. 2. In the Security and Encryption section, click Other Security Settings.
10
3. In the User Session Timeout box, select Never from the "Log users out" drop-down. 4. Click Save Timeout. A "User sessions will not time out" confirmation appears at the top of the page. 5. To apply the new session timeout, log out of dcTrack, then log back in.
11
Reinstalling dcTrack This topic applies to dcTrack 3.x users who are moving to dcTrack 5.x. Contact Sunbird Professional Services and Support at http://support.sunbirddcim.com with issues or questions.
Note: It is recommended that you manually back up your dcTrack database before upgrading or reinstalling dcTrack (to create a database backup file that you will use to restore your dcTrack data).
Reinstall High-Level Steps l l l l l l l
Manually Back Up Your dcTrack Database Retrieve the ISO File Verify The Datastore and Upload the ISO File to the Datastore Create the dcTrack Virtual Machine Load/Install/Reinstall dcTrack on the Virtual Machine Configure Network Access Restore a dcTrack Database from a Backup File
Retrieve the ISO File If you have not already done so, download the most recent dcTrack ISO file from the Sunbird Support page at http://support.sunbirddcim.com/support
Verify The Datastore and Upload the ISO File to the Data store Verify the datastore has 160GB free for a new virtual machine, and 2.8GB free for the installation ISO file. Upload the ISO file to the datastore.
Note: An additional 3GB of space may be needed to upload the ISO so it can be installed.
12
Create the dcTrack Virtual Machine See Virtual Machine Requirements and Recommendations for information on the number of virtual processors and the amount of memory allocated for the virtual machine. These instructions apply to both new installations and reinstallations of dcTrack.
Note: The following steps are provided as an example of a virtual machine installation; follow your installation pref erences if they differ. 1. Connect to the VMware server using vSphere client. 2. Log in as a user that has permission to create, start, and stop virtual machines. 3. Select the server you want to create the virtual machine on. 4. In the Summary tab, click New Virtual Machine in the Command box. 5. Choose Custom. Click Next. 6. Enter a name for the virtual machine. Click Next. 7. Select a destination storage location for the virtual machine files. Click Next. 8. You may need to select the Virtual Machine Version, depending on your host. Select the version. Click Next. 9. Select Linux for the Guest Operating System, then select CentOS 64-bit, if available, from the Version drop-down. If CentOS 64-bit is not available, select Other Linux (64-bit). Click Next. 10. Select 1 for the "Number of virtual sockets". Select 1 for the "Number of cores per virtual socket". Click Next. 11. Adjust the amount of memory allocated for the virtual machine to at least the minimum required. Click Next. 12. Select the NIC and specify its Network. Click Next. 13. Select LSI Logic Parallel for the SCSI Controller. Click Next. 14. Select "Create a new virtual disk." Click Next. 15. Under Capacity, set the Disk Size to 160GB (based on your earlier datastore selection), select "Thick Provision Lazy Zeroed" under Disk Provisioning, and select "Store with the virtual machine" under Location. Click Next. 16. Leave all advanced options at default. Click Next. 17. Click Finish to save the drive and return to the main dialog. 18. Click Finish to create the virtual machine.
13
Load/Install/Reinstall dcTrack on the Virtual Machine 1. Select VM and right click Edit Settings. 2. Select Options > Advanced > Boot Options and select Force BIOS Setup. 3. Click "Power on" to power up the virtual machine. 4. Click on the CD/DVD ROM icon at the top of the console window and select "Connect to ISO image on datastore". 5. Locate and upload the ISO file. Download the ISO from the Sunbird Support page at http://support.sunbirddcim.com if you have not already done so. 6. Select the datastore. 7. Select the dcTrack ISO. 8. Click on the Console tab. 9. Click inside the console window. 10. Exit the BIOS by selecting Exit Saving Changes and pressing the Enter key. The dcTrack Kickstart page opens. 11. Press Enter to begin installation. 12. When the installation completes, press Enter to reboot the dcTrack virtual machine. The virtual machine reboots and displays a console prompt. 13. Next, Configure dcTrack Network Access.
14
Configure Network Access 1. 2. 3. 4. 5. 6.
7. 8. 9. 10. 11.
After installing or reinstalling the application, you must configure it for access over your network. Access the local port from the Console tab of the VMware Infrastructure Client. When prompted to log in, enter the username config and the password sunbird . The configuration page opens. Select Networking Setup, then select Setup LAN 1 to configure the primary Ethernet port. Press the Space bar to select "Enable this LAN Port". To manually assign the network settings to the application: l Deselect "Use DHCP". l Type the IP address and network masks into the appropriate fields. l Select Accept to reset the network interface. To setup the gateway IP address, select Setup IPv4 Network Routes and type the appropriate IP address in the Default Gateway Route field. Select Accept to reset the network interface. o If using DHCP, note the address. There must be a DHCP server available on the LAN. If you are using a second network interface, configure it by selecting Setup LAN 2 from the Network Con figuration menu, then perform the same steps as you did for LAN 1. Select Ping Network Test to ensure the application is communicating over the network. Select Name Servers under Network Configuration to setup the server names. o If server names are not set up, DNS names cannot be resolved.
Note: Failing to configure DNS servers causes LDAP integration issues. 12. To increase security, it is advisable to disable SSH remote access. Optional. 13. Select /Networking Setup/Setup Access Controls . 14. Enable Block SSH. By default, the config account has access to the application. SSH is re-enabled if a support connection is created. 15. Select Exit from the main menu. You can now access the application from any client on the network.
15
Restore a dcTrack Database from a Backup File Note: This topic is specific to a general database restore. For details on restoring your database after you reinstall dcTrack 4.0.0 when moving from a lower dcTrack version, see Reinstalling dcTrack. Provided you created a backup file of your dcTrack database, you can use the file to restore your database.
Supported Backup File Versions As a best practice, restore your database with a backup from the same version of dcTrack. For example, restore a dcTrack 4.0.0 database with a dcTrack 4.0.0 backup file, restore a dcTrack 3.2.0 database with a dcTrack 3.2.0 backup file, and so on. You can restore your database with a backup from an earlier version of dcTrack but the backup cannot be older dcTrack 3.1.0. Sunbird does not recommend doing this as standard practice.
Note: Since you cannot use a database backup file from dcTrack 3.0.1 and earlier, you must first upgrade to dcTrack 3.1.0 at a minimum. Follow the recommended upgrade process outlined in Upgrade Compatibility, and/or contact Sun bird Customer Support for assistance.
1. In the Web Client, click Admin > Appliance Settings to open the Settings page. 2. Click Data Backups in the Data Management section to open the Data Backups page.
16
3. In the "Restore a Backup Archive" section, click Browse to locate and select a backup file. 4. Click Upload. The amount of time it takes to restore your database depends on the size of your database. Once the completed, dcTrack data and configuration settings are restored to the backup's configuration settings, and the server is rebooted. 5. Log out of dcTrack. 6. Important - Clear your browser's cache entirely, including all Temp files, cookies, favorites and so on to ensure all Adobe Flash® content is removed, then close the browser. See your browser help for steps on clearing your browser's cache. 7. Reopen your browser and log back in to dcTrack to begin using the application.
17
Impacts and Steps After Upgrading and/or Rein stalling dcTrack The following refer to upgrading to dcTrack 5.1.0 from dcTrack 4.x, or moving to dcTrack 5.1.0 by reinstalling dcTrack and restoring a dcTrack 3.2 database.
Current Function
Change in New Release
Action Required/No Action Required
Virtual Power Chain is enabled for one or more locations
None
No action is required
dcTrack is integrated with one or more Power IQs
None
No action is required as long as data are in sync
Continuing to use local user authentication
None
No action is required
Continuing to use manual LDAP (Find LDAP Users)
LDAP settings are mapped to fields on new screens created to accommodate the new automatic LDAP feature
No action is required
Moving to import LDAP user groups and automatically adding users
New in dcTrack 5.0.0
Action is required if you are moving to the new feature from manual LDAP or local authentication
Moving to manual LDAP from local authentication
None
Action is required
Virtual Power Chain is Enabled for One or More Location and/or You Have Existing Virtual Power Chain Connections No Action Required This is an optional, existing feature as of dcTrack 4.0. For details of Virtual Power Chains and Virtual Power Chain con nections, see dcTrack online help. When you upgrade to dcTrack 5.0 or do a reinstall/restore to move to dcTrack 5.0, Virtual Power Chain remains enabled for each of your locations and all of your VPC connections remain.
18
Currently Integrated with One or More Power IQs No Action Required This is an optional, existing feature as of dcTrack 3.2.0. For details on Power IQ integration, see dcTrack online help. If you are managing multiple Power IQs in your dcTrack 3.2.0 or later application, as long as your data are synced cor rectly, you do not have to take extra steps after you reinstall dcTrack 5.0.0 and you restore your database. Important: If you believe your data are out of synch between dcTrack and Power IQ, Professional Services and Support must help you sync your data. Contact Professional Services and Support via the Support website at http://sup port.sunbirddcim.com or via email ([email protected] ).
Continuing to Use Local Authentication No Action Required This is an existing, default feature in dcTrack in which users are locally authenticated using their dcTrack credentials. There is no impact on this feature after an upgrade or reinstall/restore. So, if you plan on continuing to use local authen tication, you do not have to make any changes to your settings.
Continuing to Add LDAP Users Manually No Action Required If you are currently manually importing LDAP users, when you upgrade to dcTrack 5.0 or do a reinstall/restore to move to dcTrack 5.0, your current LDAP settings remain the same and you do not need to take further steps. The only dif ference you will notice is the change in pages and fields that contain the setting information. Your existing information is mapped to these fields automatically. To view the settings in dcTrack 5.0 that map to the 3.x or 4.x pages and fields 1. Select Admin > Appliance Settings to access the Settings page. 2. Select LDAP Server Settings to open the LDAP Servers page. 3. Your current server is displayed on the page. Only one server is listed since only one is supported by manual LDAP in 3.2 and 4.x.
19
4. Click on the server to view your settings in the General, Connection and Bind Sections. 5. Under Groups, 'Use Groups for Authorization' are unchecked since the setting is not applicable to manual LDAP and did not transfer. 6. Manage Certificates is not checked since it is a new setting to dcTrack 5.0. 7. Referrals is selected or deselected depending on your previous settings. 8. Click your browser's back button to return to the LDAP Servers page.
9. Click Common Settings on the LDAP Servers page. 10. Note that 'Enable LDAP sync' and 'Sync Group Members' are unchecked.
20
dcTrack 3.x and 4.0 LDAP Pages Compared to dcTrack 5.0
21
dcTrack 3.2 LDAP Settings
22
dcTrack 5.0.0 LDAP Settings
dcTrack 4.0 LDAP Settings
dcTrack 5.0 Settings
Moving to Import LDAP User Groups and Add Users Automatically in dcTrack 5.0 When You Are Currently Adding LDAP Users Manually Action Required Note: This topic is specific to users who are currently using manual LDAP. If you are using the import user groups and add users automatically feature for the first time, see Import LDAP User Groups and Add Users Automatically. Previous versions of dcTrack provided manual LDAP, also referred to as the "Find LDAP Users" feature. This feature allowed you to add and authenticate users via LDAP. However, since you could not sync each user's LDAP account with dcTrack, you had to maintain accounts for them on the LDAP server and dcTrack. In essence, you were maintaining user information in two places. dcTrack 5.0.0 now provides you with the ability to import user groups and add users automatically. Once added, you can enable automatic syncing. Syncing pushes user and user group updates from the LDAP server to dcTrack.
23
If you do not want to move to this new feature, you do not need to take additional action and can skip this topic - your cur rent LDAP settings were applied when you upgraded or performed a reinstallation/database restore to move to dcTrack 5.0.0. If do want to move to this new feature, there are additional steps you must take. Follow the steps outlined in this topic in order to ensure your current LDAP configuration is not impacted.
Note: dcTrack Administrators should work with LDAP Administrators to plan how dcTrack users will be grouped, as well as when performing the steps to add user groups to dcTrack and sync user groups between the LDAP server and dcTrack. 1. Select Admin > Appliance Settings to access the Settings page. 2. Select LDAP Server Settings. The LDAP Servers page opens. Your existing server appears on the LDAP Servers page. In steps that follow, we configure your existing server to import user groups and add users automatically. For steps on adding additional servers, see Import LDAP User Groups and Add Users Automatically.
3. Click on your server to edit it.
General, Connection and Bind Information This information is automatically populated based on your existing server information. 4. Update information, if needed. 5. If needed, update the server to Active Directory or LDAP.
24
6. Set the Search Credentials to use "admin credentials" to allow for automatic sync, if needed. 7. If you need to validate LDAP server certificates, select Check Server Certificate. This feature is new to dcTrack 5.0.0. 8. Next, click Manage Certificates to open the Trusted Certificates page.
9. Click Import Certificate to open the Import Trusted Certificate page. 10. Use the Browse function to locate the certificate, then click Import to import the certificate.
Group Information
25
Enter the information required to add user groups using LDAP. The information you enter may vary between LDAP serv ers and Active Directory servers.
Note: Ensure that user groups are added before syncing to prevent LDAP authenticated users from being inadvertently removed. 11. User Groups for Authorization and Common Setting – ‘User Groups for Authorization’ and ‘Sync Group Members’ are used together so user groups can be imported and then managed. Enabling ‘User Groups for Authorization’ will allow user groups to be discovered, reviewed and imported as needed. Then, after the user groups have been added, enabling ‘Sync Group Members’ will automatically add or remove users based on group membership information provided by LDAP. 12. Use Group Search DN - select to specify the group DN to search. Select this option if the group DN search is dif ferent than the search used for users. 13. Group Search DN - this is where the search for the user group will begin in the directory. 14. Group ID Attribute - the default for Active Directory is sAMAccountName. for Active Directory and gidNumber for LDAP. 15. Group Member Attribute - the default for Active Directory is member and the default for LDAP is memberUid. 16. Group Search Filter - the default for Active Directory is (objectClass=group)and the default for LDAP is(objectClass s=posixGroup). 17. Group Search Scope - level of the server directory to look for groups; either the Base DN and one level below the Base DN, or the Base DN and the entire subtree.
18. Optional Test Connection is to test with an account. If you have a known, valid test account to use to test the server setup, you can test from here without having to try to login with that account.
26
19. Click Save to save the settings. You are returned to the LDAP Server Settings page and success message is displayed. Search for Remote Users and/or User Groups and Add Them to dcTrack 1. On the Add LDAP Server page, click Search.
The Search for LDAP Users and Groups page opens. 2. Select the server you want to search. The remaining server information is completed based on the server you selected earlier, or you can edit the information by entering a new server to search. 3. Select the type of search - Users or Groups, depending on how the server is configured in dcTrack. 4. Select the Follow Referrals checkbox, if desired. 5. Search Scope is prepopulated based on the scope you defined when adding the server. You can change the scope of the search, if desired. This is the level of the server directory to look for users or groups. You can search just the Base DN by selecting "Base", search the Base DN and one level below the Base DN by selecting "One", or search the Base DN and the entire subtree by selecting "Subtree".
27
6. Click Search to locate users or user groups on the server. 7. A list of results is displayed once found. You can now add users and/or groups to dcTrack from those found. To add users or groups found in an LDAP search, select the checkbox next to each user and/or user group in the list, then click Add. In order to search and add user groups, the ‘Use Groups for Authorization’ option must be enabled on the Server page. When searching for and adding user groups, one or more groups can be selected at a time. The users will not be auto matically added unless the Common Settings – ‘Sync Group Members’ is enabled.
28
When searching for and adding user groups, clicking on a user group causes the group members to be listed below the user group grid. One or more group members can be selected to be added.
29
Successfully added users/user groups are listed as "Exists as LDAP user" and the checkbox next to the name is removed. Review the users in your user groups and verify they are correct. Once added, individual users are granted distinct permissions and authenticated on a per user basis. Users in user groups are granted common access to specific features or functionality. Any changes you make to a user or user group on the server are reflected in dcTrack. For example, if you delete a user from a user group, they are no longer able to access the features they previously could in dcTrack. Next, configure sync settings and sync to import user group members that are not already imported. 1. Click Common Settings on the LDAP Servers page.
30
2. Check 'Enable LDAP sync' and check 'Sync Group Members' before you sync.
3. Click Sync Now. On sync, dcTrack updates the user groups you added to reflect the group members reported by the LDAP server. This imports user groups into dcTrack from LDAP.
Import LDAP Users Groups and Add Users Automatically in dcTrack 5.0 When You Are Currently Using Local Authentication Action Required In dcTrack 5.0 and higher, you have the option to import user groups and add users in those groups automatically. You can then manage users and groups via LDAP by syncing with dcTrack. If you want to begin using this feature, you must configure it in dcTrack. See Automatically Add and Manage Users/User Groups via LDAP or Active Directory in dcTrack online help for steps.
Note: Follow the steps in the online help topic only if it is the first time you are setting up automatic, remote LDAP authen tication.
31
Moving to Manual LDAP Authentication in dcTrack 5.0 When You Are Cur rently Using Local Authentication Action Required Instead of using automatic, remote authentication, you are able to use the existing, manual LDAP feature. This is an optional feature in dcTrack that allows you to manually find and add users to dcTrack using LDAP. Users are authen ticated based on their LDAP credentials instead of their dcTrack credentials. However, you cannot manage users with this feature since an LDAP/dcTrack sync does not occur. For details on this feature, see Manually Add and Manage Users via LDAP or Active Directory (Find Users) in dcTrack online help. In previous versions of help, this feature was referred to as Find LDAP Users.
32
Virtual Machine Requirements and Recom mendations Requirements l
Your dcTrack virtual machine must be given priority.
l
Configure ESXi so that all required resources are available on the dcTrack virtual machine at all times.
l
Note that manipulating ESXi settings or changing the priority of other virtual machines running on the same ESXi host may impact the ESXi scheduling policy.
If this happens, resources may be diverted from the dcTrack virtual machine, which may result in poor performance or dcTrack malfunctioning.
Note: dcTrack supports VMware Version 5.0 and higher.
Minimum VMware Host Recommendations VMware host minimum configuration recommendations for dcTrack 5.1.0 and higher:
Number of Cabinets
RAM (GB)
CPU (Cores)
Datastore (GB)
CentOS
VMWare
Up to 200
8
4
160
64-Bit
ESX/ESXi
201 to 1000
8
6
160
64-Bit
ESX/ESXi
1001 to 1500
8
8
160
64-Bit
ESX/ESXi
1501 to 2000
10
8
160
64-Bit
ESX/ESXi
2000 to 3000
12
8
160
64-Bit
ESX/ESXi
More than 3000
14
8
160
64-Bit
ESX/ESXi
Note: An additional 3GB of space may be needed to upload the ISO so it can be installed. Alternatively, the ISO can be installed directly from the DVD.
Required TCP Ports The following TCP ports are required to be open when building your virtual machine:
33
l
443 - HTTPS (secure channel)
This port must be open in order to access the dcTrack login page. l
5432 - Postgres DB
PostgresDB 5432 is not encrypted but must remain open. Classic View uses this port to connect to the dcTrack database and does not work if the port is closed. l
443 - HTTPS (secure channel)
This port must be open in order to access the dcTrack login page. l
123 - UDP
This port must be open for NTP time sync to work.
Optional TCP Ports Leaving the following TCP ports open is optional. If you do not leave these ports open, note the requirements and/or limitations indicated here. l
22 - SSH
It is not necessary to have the SSH port open since SSH functionality is available directly on the virtual machine con sole. If port 22 is not open, however, SSH cannot be used to access dcTrack to perform diagnostic operations of any kind. l
80 - HTTP
If port 80 is not open, users must specify HTTPS:// when entering the dcTrack URL in their browser. l
514 - TCP
Port 514 is required to forward system logs. l
161 - TCP
Port 161 is required for SNMP discovery via Classic View. l
25, 465, 587 - SMTP
Email SMTP connectivity requires the appropriate port(s) be open. These may vary based on your organization.
34
