Ironwood Networks NAA Starter Guide
Note: To Install NAA or Request new license, please see NAA Installation Guide.
First time Login NAA and Change Default Login Password
To change NAA default login passwords, follow these steps.
-
Login to NAA as admin user
Open a browser to https://<NAA IP>
user: admin
password: admin
-
Change default admin user's login passwords.
Click on the "admin" name at the top header to change its password.
-
Done. Goto Update NAA Software
Update NAA Software
Please update NAA version immediately after installation.
-
Goto
System > Update
-
Enable Daily Auto Update
See Method 1, enable Auto Update and select the hour of the day to check for updates so that your NAA is always uptodate.
-
Update NAA Now
See Method 2, if your NAA is outdated, update NAA now.
NAA will restart after update. You need to re-login NAA after update. -
Done. Goto Add the First Device
Add the first Device
To add the first device to NAA, follow these steps.
-
Setup Device Login Credentials
-
Goto
Setup > Credentials
- Add a credential for device login.
-
Goto
-
Add new Devices
Add a new Devices Entry and a list of similar devices into it. Similar devices share the same vendor OS, access methods, credential, Snapshots Cmds, etc.
-
Goto
Setup > Devices
-
Add a new Devices Entry and list of devices.
Also see how to Setup Auto Discovery. -
Select the appropriate attributes (Vendor OS, Access Method, Device Credential, Snapshots Cmds) for this Devices Entry.
If the Vendor OS is not listed, you can Create new Vendors OS.
If the Snapshots Cmds is not defined yet, create it in Setup Snapshots Commands.
-
Goto
-
Done. Goto Taking and Scheduling Snapshots
Run Task
To issue bulk command to one or more devices, follow these steps.
-
Create and Run Task
-
Goto "Create Task" to create a new task.
-
Enter the commands to be issued on the devices. Note the preceeding "cmd:" which tells NAA to send a command.
-
Select the desire device or devices. Then follow through the rest of confirmation pages and "Submit"
-
-
See Task results
After the task is submited, you will see the Tasks listed in the "Task Results" page.
-
Click on the task to see result when it is "Done". If not done, then "Refresh" to update status.
-
Click "ALL" to view all results on one page, or select individual device result.
-
Taking and Scheduling Snapshots
You can take Snapshot on demand or by schedule.
Snapshot use the commands defined in the Snapshots Commands. If Snapshots Commands are not defined yet, create them in Setup Snapshots Commands.
-
Taking Snapshots On Demand
You can take Snapshots on any devices on demand.
-
Goto
Snapshots > Take Snapshots
- Select desire devices or group of devices. You can filter on the device name.
-
Goto
-
Schedule Snapshots
You can schedule Snapshots. Scheduled Snapshots will be taken for all devices.
- Check the time for taking the Snapshot.
- Save and Activate Snapshots schedule.
-
Done. Goto View Snapshots and Changes History
View Snapshots and Changes History
You can view Snapshots and the Changes History.
-
View Snapshots
-
Goto
Snapshots > View Snapshots
-
Click on the device to see the latest Snapshot.
-
Goto
-
View Changes History
-
Goto
Snapshots > View Changes History
- Change the time period to list different history.
- Click on the device to see detail changes.
-
Goto
Create Vendors OS
Vendors OS defines how NAA interact with devices running on such OS.
You can add new Vendors OS when you have devices running on an OS that is not currently available in NAA.
-
Create new Vendors OS
-
Goto
Setup > Vendors OS
- Create a new Vendors OS
-
Goto
-
Define how to interact with the OS.
- Enter regex to detect device prompt. Be sure to cover all possible prompts that you expect NAA will encounter on the device (such as the privilege, non-privilege, and configuration modes).
- Enter the first and last commands to send to the device.
- If there are sensitive information, use the Hide Command Outputs to hide such information.
Setup Snapshots Commands
-
Setup Snapshots Commands
Snapshots Commands defines what information is captured in the Snapshot. They are commands to be issued to the devices.
-
Goto
Snapshots > Snapshots Commands
- Select the Snapshots Command name. Or Create one if not yet exists.
- Enter commands to be issued on the device
-
Goto
Setup/Run/Schedule Compliance Audit
Compliance Auditing compares devices commands outputs to the given Standard Rules expected output.
To setup, run, and schedule Compliance Auditing, follow these steps.
-
Create Rules
- Goto "Edit Rules"
-
Click on the plus icon to create a new Rule.
- Enter commands and the expected output.
-
Save the new Rule.
-
Create Standard
- Goto "Edit Standards"
-
Click on the plus icon to create a new Standard.
- Select the new Standard.
- Drag and Drop the new Rules to the appropriate Categories.
-
Save the new Standard.
-
Assign Standard to Devices
- Goto "Edit Devices".
-
Click on the pencil icon to edit the desire "Devices Set".
- Assign the Standard.
-
Save the "Device Set".
-
Test run Audit
- Goto "Run Audit Now".
- Select one or few devcies that belong to the "Device Set" with the new Standard.
-
Click "Run Now".
- After "Run Audit Now" is done, goto "See Report".
-
Click on the device audited.
-
Verify the device is audited successfully.
-
Schedule Compliance Audit
- Goto "Schedule Audit".
- Select how frequent to perform the Audit.
-
Save and Activate.
Setup Auto Discovery
-
Setup SNMP Credentials
Enter SNMPv2 and SNMPv3 credentials used in discovery.
-
Goto
Setup > Credentials
- Add all the SNMP credentials.
- Try the SNMP credential with a known devices to confirm SNMP access.
-
Goto
-
Setup Auto Discovery
Enter Auto Discovery day/time and the IP address networks to be covered in the discovery.
-
Goto
Setup > Discovery
-
Goto
-
View Discovered Devices
After the Auto Discovery is executed, view all the discovered devices.
-
Goto
Discovery > Discovered devices
- Auto Discovery should discover the sysName, sysDescr, and the DNS name if the IP address have reverse DNS lookup.
-
Goto
-
Assign Discovered Devices
Assign discovered devices to Device Set
-
Goto
Setup > Devices
-
Expand the Device Set.
Click on the "Discovered devices" to see unAssigned discovered devices. - Select the devices and assign them to the Device Set.
-
Goto
System Users
-
Add Local Users
System local users are authenticated locally. You must be admin user (privilege level 3) to edit system users.
The default local user password is "ironwood".-
Goto
System > Users
- Add (or Delete) user name in the "Local Users" text box of the appropriate privilege level.
-
Goto
-
Modify User Password
System local user password should be changed. The user can change the password as shown below.
- Login to NAA with the local user name.
- Click the name at the top right corner.
- Change the password.
- Done.
-
Add System LDAP users
System LDAP users are authenticated by their LDAP accounts. You must be admin user (privilege level 3) to edit system users.
-
Goto
System > Users
- Add (or Delete) user name in the "LDAP Users" text box of the appropriate privilege level.
-
Goto
System > Settings
- Enter LDAP server info.
-
Goto
-
Add System AD Groups
System users can be authenticated by their AD Group membership. You must be admin user (privilege level 3) to edit it.
-
Goto
System > Users
- Enter "Base DN" to search for the AD Groups.
- Add (or Delete) group names in the "AD Groups" text box of the appropriate privilege level.
-
Note that LDAP setup is required
GotoSystem > Settings
Enter LDAP server info.
-
Goto
-
Enable One-Time-Passcode
Optinally, you can enable One-Time-Passcode (OTP). OTP only works for LDAP users. Users will receive an one-time-passcode in their email during login.
-
Goto
System > Settings > Email Server
- Enter email server info.
-
Enable the
One-Time-Passcode
checkbox.
-
Goto
Setup Jumpbox
-
Add Jumpbox
If you need to SSH to a jumpbox server first and then SSH to the target devices, you can setup jumpbox as shown below.
-
Goto
Setup > Jumpbox
- Enter the jumpbox server info.
-
Goto
-
Use Jumpbox
Now you can use the jumpbox as the Access Method for the devices.
-
Goto
Setup > Device
- Select the Jumpbox as the Access Method.
-
Goto
Enable Email Notification
-
Enable email notification
To receive email notification when changes are detected, setup notification as below.
-
Goto
System > Settings > Notification
- Enable Email checkbox. Note that the "Email Server" setup is required.
- Enter recipents email names or full email addresses separated by comma.
- Enter default email domain.
-
Goto
Using API
With API, it is possible to integrate other systems with NAA. Such as updating NAA Devices with 3rd party source-of-true CMDB inventory.
-
Setup User API Passcode
To create an API passcode, follow these steps.
Note that the user must have an user account created on NAA (ie. not an AD Group user).- Login to NAA as the user
- Goto the user icon at the upper right
- Generate the API passcode
- Save it
-
Access API
Available API routes are listed in API UI.
-
Goto
https://<NAA IP>/docs
- Authorize with username and API passcode
- Try the API via UI
- Examine the API routes information and utilize them from your external automation scripts
-
Goto
-
API Example
For example, you can update devices from existing Device Sets using API calls
"get_devices"
and"save_devices"
.
Note that this example uses linux curl command for simplicity. You can integrate to your automation script or make API calls from a 3rd party device discovery management application.-
Get the devices in JSON format and save to local devices file.
curl -k -XGET -u "<username>:<api passcode>" "https://<NAA IP>/api/get_devices" | jq . > naa-devices.json
cat naa-devices.json
{ "devices": { "Cisco IOS switches": [ "router-1", "router-2" ], "NAA server": [ "192.168.86.10" ] } }
- Modify the devices in the file. Verify the file is valid JSON format such as using this JSON validation website.
-
Upload the new devices file to NAA.
curl -k -XPOST -u "<username>:<api passcode>" "https://<NAA IP>/api/save_devices" -H "Content-Type: application/json" -d @naa-devices.json
-
Get the devices in JSON format and save to local devices file.