Configuration
From NACCompanionWiki
Visit NACCompanion User Guide for additional information.
NACCompanion has a variety of configuration options that may be used to get it up and running as well as the ability to make some customization changes for your needs.
There are two sections highlighted in color that are the minimal requirements to setup NACCompanion.
- Required Configuration
- License Keys
Contents |
Required Configuration
Enter the NAC Manager "Service IP" address. The format should be x.x.x.x without a preceeding http://. You will also want to enter your NAC Manager's "root" user password. This is not to be confused with your admin web password. This password is needed in order to build an ssh tunnel to your NAC Manager where all communications take place (between NACCompanion and your NAC system.)
License Keys
Enter the license key provided to you by your NACCompanion sales/technical representative. This is also a required entry in order for your NACCompanion system to function properly.
Note: this license and the NAC Manager "Service IP" address/password are all that are needed for basic NACCompanion setup.
Recommended Configuration Options:
- User Administration
By default, NACCompanion has one admin user account (admin) with a default password (admin). In order to add additional users, enter the appropriate user name and password information. If any of these users will have admin permissions (the ability to make changes to all NACCompanion modules), select the 'Administrator' checkbox.
There two types of admin users who can log into the NACCompanion interface:
- Administrators
- Administrators have full access to NACCompanion
- Users
- Have read-only access and cannot access certain sections within NACCompanion
- Setup NAC Licensing and Passwords
This section is primarily used for NACDashboard and NACReports. The information on this page is configurable specific to your environment and pertains to the number of licenses your NAC Manager and NAC Server are licensed for. By default NACCompanion sets the value of your NAC Manager to 20 and your NAC Servers to 1500. These values should coincide with the numbers of licenses you have purchased from Cisco. By keeping the proper license counts on this page, NACDashboard will keep you informed as to your license status.
- Email Notification Setup
NACCompanion can send alerts to email recipients when issues are detected on NACDashboard. For example, if a NAM or NAS was to become unresponsive, an email would automatically be sent to the intended recipient. Emails to report recipients can also be scheduled using this interface.
Optional Configuration Options:
- Configure (Key System Events) reported to NACDashboard
A key system event is any "interesting" event that is seen within the Cisco NAC Manager logs. Using this query tool, administrators can look for "interesting" string matches and have these events sent to NACDashboard. Additionally, NACDashboard can email these key system events to intended recipients.
Note: NACDashboard will only show these interesting events for a period of 24 hours from the time of the initial event taking place at which point the event will fall off of the key system events list. If a 'red alert' email recipient is configured, NACDashboard will send only 1 email per "interesting" event.
- Configure NACCompanion Details
The settings on this page are set to predefined defaults. No changes are necessary unless you desire unique parameters with the exception given to the "NACCompanion OS Password". By default your naccompanion OS system user account has a password of naccompanion. If you were to change it from the default, you would need to change the value within this box.
Note: if you do not change this value after changing the password at the OS prompt, your NACBackup may not function properly as it will be unable to FTP any backups from the Cisco NAC System to your NACCompanion FTP server. For more information, visit the NACCompanion User Guide under the section "Installation."
Maintenance Configuration Options:
- NACCompanion Backup and Restore
Use this section of NACCompanion to make backups of your NACCompanion system. The backup will include all relevant information specific to your system. This information will be compressed up into a single file. This file can be saved off to a management system for future restores/disaster recovery.
- NACCompanion Upgrade
All patches and upgrades are incorporated into the NACCompanion system using this interface. When you wish to apply these patches, first obtain the patch/upgrade file, then import it within this interface. The upgraded files are uncompressed and placed into their appropriate locations at this point. These files are also check for integrity at this point.
After the upgrade and in most cases there will be no need for a system reboot.
Note: it may take up to 2 minutes for all services to be restarted and files to be recompiled so expect a small delay in functionality after the upgrade.
- NACCompanion Digest
This calculates hash codes for NACCompanion as a troubleshooting aid. If there NACCompanion is not performing as expected, it can be used to determine which version of the code is installed and help determine if the installation has become corrupted. NACCompanion technicians can use this feature to help identify exactly which files are out of sync or have become corrupted.
- Change IP address
The default IP address of your shipping NACCompanion system is 192.168.200.200/24. If you need to change this information you can do so using this GUI interface. After the changes, click the submit button for them to take affect. No system reboot is necessary at this point. It may take 10-15 seconds for the changes to take affect with future management IP address being the new IP address you made the changes to.
Note: if you need to change the IP address manually, not using the GUI, please refer to the NACCompanion User Guide installation section for exact details.
- Companion Resource Stats
Companion Resource Stats is meant to be a health check of your NACCompanion system. Based on periodic intervals, your NACCompanion system will be checked for system specific information. This information pertains to CPU and memory statistics, along with other important health statistics.
Example:
