How to Export and Import a Device List

You can export a device list from NetSight Console to a text file that lists all the devices that are members of one or more selected device groups. The file is created as a .ngf file (NetSight Generated Format), which is compatible with other NetSight applications where it can be imported. Likewise, device lists that are exported from other NetSight applications, or files that are manually created in a compatible format, can be imported into the NetSight database. You can also export a database backup file from Ridgeline that you can import into NetSight Console.

Import-Export File Format

The device list import-export file from NetSight Console is a text file (ASCII) with each line describing a specific device, using NetSight Generated Format (NGF), while the import-export file from Ridgeline is saved as a .sql file by default. The information for each device must be on a separate line with no line breaks in the string. Devices are identified by an IP address (the only mandatory attribute) and a set of optional attributes that define access parameters. When devices are exported, Console defaults to a .ngf file extension and Ridgeline defaults to a .sql file extension. However, these can be changed or omitted, without affecting the import or export operation.

SNMPv1/v2 devices and SNMPv3 devices use different NetSight Generated device list formats. The formats include the device name or IP address, and the device's SNMP access information. This information is used by Console to access and manage the device. You can mix SNMPv1/v2 and SNMPv3 formats in a single device list. If you list both an SNMPv1/v2 and SNMPv3 entry for a device, Console stores the v1/v2 values, but uses the v3 values to contact the device.

SNMPv1/v2

NGF lets you import a file that defines device name and SNMPv1/v2 security parameters for the device models being created by the import. The following parameters, separated by spaces, can be specified on each line within the import file to define a device. The minimum definition contains a device name (dev=IP address).

The following attributes are currently supported:

Attribute	Description	Valid Parameters
dev	Device IP Address (mandatory)	<IP address>
ro	Read-Only Community Name (optional) (see Note)	<community name>
rw	Read-Write Community Name (optional) (see Note)	<community name>
su	Super-User Community Name (optional) (see Note)	<community name>
mt	The poll type (monitor type) defined for the device (optional)	0 (Not Polled), 1 (Ping), 2 (SNMP)
pg	The poll group defined for the device (optional)	1, 2, or 3
cliDesc	A description of the CLI credential (optional)	<description>
cliUsername	The username used for device access (optional)	<username>
cliType	The communication protocol used for the connection (optional)	Telnet or SSH
snmp	The SNMP protocol version for the credential (optional)	v1, v2, or v3

SNMPv1/v2 access information consists of the read only, read write, and super user community names for devices. The device name or IP address is the only required information. The string of information for each device must be on a separate line with no line breaks in the string. If you create a device list without community names, devices will be imported into Console using the Default SNMPv1 profile defined in the Authorization/Device Access Window - Profiles/Credentials Tab.

Examples:
dev=Switch1 ro=public rw=public su=public dev=172.16.30.40 ro=public rw=public su=public dev=10.20.77.127 mt=2 pg=1 ro=public rw=public su=public cliDesc=Default cliUsername=admin cliType=Telnet snmp=v1

	NOTE:	For RoamAbout R2 devices. If you are importing the device with SNMPv1 (SNMPv3 is recommended), the community names on the device must be updated. There are four SNMPv1 community names on the R2: Community #1 -- allows limited read-only access (MIB II system group) Community #2 -- allows limited read/write access (MIB II system group) Community #3 -- allows read-only access to all MIBs Community #4 -- allows read/write access to all MIBs Console will import the device based on community names #3 and #4. For read-only access, set community name #3 on the device and then use that community name for the "ro" value in the device list. For read/write and super user access, set community name #4 on the device, and then use that community name for the "rw" and "su" values in the device list

SNMPv3

SNMPv3 access information can consist of the following settings. The device name or IP address and the user name is the only required information. Each device must be on a separate line.

Attribute	Description	Valid Parameters	Co-requisite Attributes
dev	Device IP Address (mandatory)	<IP address>	NA
user	User (optional)	<username>¹	NA
seclevel	Security Level (optional)
		NoAuthNoPriv	NA
		AuthNoPriv	authtype, authpwd
		AuthPriv	authtype, authpwd, privtype, privpwd
authtype	Authentication Type (optional)
		MD5	seclevel, authpwd
		SHA1	seclevel, authpwd
authpwd	Authentication Password (optional)	<password>¹	seclevel, authtype
privtype	Privacy Type (optional)	DES	seclevel, privpwd authtype, authpwd
privpwd	Privacy Password (optional)	<password>¹	seclevel, privtype authtype, authpwd
Although SNMPv3 supports user names and passwords containing spaces, the NetSight Generated Format does not. When spaces occur in the user names and passwords in a .ngf file they are interpreted as a delimiter between parameters. For more information on SNMPv3, read RFC2574.

Examples:

dev=172.16.17.18 ro=public rw=private dev=172.16.17.38 user=netmgr seclevel=AuthPriv authtype=MD5 authpwd=net_mgr.pwd privtype=DES privpwd=secret.pwd

How Credentials and Profiles are Handled when Importing a Device List

From NetSight Console

When the import (from a .ngf file or remote Console) defines a device using SNMPv3 parameters that match a credential that exists in the local database, then the device is created using the existing Credentials and a Profile that is associated with them.

Otherwise, a new Profile is created, named New (default name) with the User Name (user), Security Level (seclevel), Authentication Type (authtype) and Privacy Type (privtype) and Passwords (authpwd and privpwd) from the import. The Credential that is created will be used for all Access Levels (Read, Write, Max Secure).

If the Credential is created with an authtype and a privtype, the Profile is created with AuthPriv for all Access Levels.
If the Credential is created with an authtype, but no privtype, the Profile is created with AuthNoPriv for all Access Levels.
If the Credential is created with neither an authtype nor a privtype, the Profile is created with NoAuthNoPriv for all Access Levels.

From Ridgeline

When importing a database backup file from Ridgeline, Credentials and Profiles are created based on the existing Credentials and Profiles in the Ridgeline database.

Instructions on:

Exporting a Device List
Importing a Device List from a File

Exporting a Device List

From NetSight Console

The Export option in NetSight Console creates a device list in NetSight Generated Format.

To export a device list:

Pull down the File menu and select Device List > Export from the menu. A file browser window opens where you can name your exported device list and navigate to a folder/directory where you want to place the file.
Type a name for your export file and click OK. Console exports all devices that have an SNMP Profile. Ping only devices are not exported.

From Ridgeline

The backup utility in Ridgeline makes a backup copy of all data in the database. Database utilities are found in the database\bin directory in the folder in which you installed the Ridgeline software. For example, if you installed Ridgeline in the C:\Program Files\Ridgeline, the database utilities are saved in the C:\Program Files\Ridgeline\database\bin folder.

Importing a Device List from a File

This feature imports device information and profiles for unique devices (ones that do not exist locally) from a .ngf or .sql file.

	NOTE:	Although SNMPv3 supports user names and passwords containing spaces, the NetSight Generated Format does not. When spaces occur in the user names and passwords in a .ngf file they are interpreted as a delimiter between parameters.

To import a device list:

Pull down the File menu and select Device List > Import Devices from the menu. A file browser window opens where you can navigate to a folder/directory containing the import file.
Select the import file and click Import. Devices that do not already exist in the database are added to the All Devices group and are assigned the Poll Group that has been designated as the default in the Status Polling view of the Suite-Wide Options window. If a device being imported exists in the local database, the local device information is retained and the import information about that device is ignored.

	NOTE:	In the .ngf file, when the parameters for a given device are invalid, the device will be created using the profile that has been designated as the default on the Authorization/Device Access Window - Profiles/Credentials Tab. Update and check the Console Event Log for specific information.

Related Information

For information on related windows:

For information on related tasks: