The CSV importing of nodes is a helpful way to add a list of nodes to UpGuard.

CSV Import

Prepare

Before starting, you will need:

Retrieving the Example CSV

To download the example CSV file (which contains headings for each column), perform the following:

  1. In the UpGuard UI, navigate to Discover -> Add Nodes
  2. Select Import CSV
  3. Select Download Template

Populate CSV

Once you have the example CSV, you can edit it to add your nodes. There are many columns that may or may not need values, depending on your deployment. The following section will go through each column and what is required.

Name

Every node needs a name defined. The name field is the display name that will be shown in UpGuard.

Node Type

The node_type must be defined for each node with a code from the following table:

Code Type
SV Server
DT Desktop
SW Network Switch
FW Firewall
RT Router
PH Smart Phone
RB Robot
SS SAN Storage
WS Website

This table is also available in the Node API endpoint.

Medium Type

Each node requires a medium type defined. This is the method that UpGuard will use to contact the node to gather configuration data.

For most deployments, you will likely use:

  • 1: Any node with the UpGuard agent installed
  • 3: Any Linux agentless node (also applies to network nodes)
  • 7: Any Windows agentless node (also applies to database nodes)
Value Type
1 Agent
3 SSH
6 HTTPS
7 WinRM
8 Service
9 Web

This table is also available in the Node API endpoint.

Medium Username

The username must be provided if all of the following apply:

  • You are using an agentless scanning method (SSH or WinRM)
  • (SSH) You are not using a public key to login to the node
  • (WinRM) You are not running the UpGuard service on the connection manager as a service account

Medium Password

The password is required only if the Medium Username is provided.

Medium Port

The port field is optional for any node.

If you are using an agentless scanning method, the port will be automatically filled in (22 for SSH, 5985 for WinRM).

Medium Hostname

The hostname is the address to connect to for agentless scanning (SSH or WinRM). This is usually the FQDN, but may also be the IP address if DNS isn’t working properly for a node (or group of nodes).

Short Description

The short description is optional for any node, and is mainly used as a notes field.

Connection Manager Group ID

In order to scan a node agentlessly, you will need to have a connection manager in your environment.

This field will specify the connection manager group that will scan this node.

To find the Connection Manager Group ID, you can use the Connection Manager Groups API endpoint or use the method below:

  1. In the UpGuard UI, navigate to Discover -> Connection Managers
  2. Select the connection manager group you would like to use
  3. Find the ID in the URL bar in your browser

find-connection-manager-group-id

Operating System Family ID

The Operating System Family ID must be from the list below (this is also available through the Operating System Families API endpoint)

ID OS Family
1 Windows
2 Linux
3 Unix
5 Mac OS
7 Cisco
8 Juniper
9 IBM
11 HP
12 Palo Alto
13 Brocade
14 Cloud App
15 Riverbed
16 Web Site
17 Arista
18 Custom
19 Database
20 Hypervisor
21 Aruba
22 Citrix
23 A10
24 NetApp
25 Dell

Operating System ID

The Operating System ID must be from the list below (this is also available through the Operating Systems API endpoint)

Operating System OS ID OS Family ID
Debian 211 2
Ubuntu 221 2
CentOS 231 2
CloudLinux 235 2
RedHat 241 2
Amazon Linux 245 2
F5 248 2
F5 Linerate 249 2
SUSE 251 2
Fedora 261 2
Oracle Linux 271 2
CoreOS 281 2
Arch Linux 282 2
Other 299 2
Exchange 2010 127 1
Windows Server 2016 129 1
Windows Server 2012 125 1
Windows Server 2008 123 1
Windows Server 2003 122 1
Windows 10 126 1
Windows 8 124 1
Windows Vista 113 1
Windows 7 112 1
Windows XP 111 1
Other 199 1
AIX 311 3
AIX-WPAR 351 3
HP-UX 321 3
Solaris 331 3
Other 399 3
FreeBSD 411 4
NetBSD 421 4
OpenBSD 431 4
Other 499 4
Mac OS X 511 5
Other 599 5
Gingerbread 611 6
Honeycomb 612 6
Ice Cream Sandwich 613 6
Jelly Bean 614 6
Other 699 6
Cisco IOS 711 7
Cisco NX-OS 721 7
Cisco ASA 731 7
Cisco FWSM 741 7
Cisco CATOS 751 7
Other 799 7
JunOS 811 8
ScreenOS 821 8
Other 899 8
IBM XIV 911 9
IBM SVC 912 9
IBM Z/OS 913 9
HP Comware OS 1111 11
HP Procurve 1131 11
Other 1199 11
Palo Alto 500 1211 12
Palo Alto M-100 1212 12
Palo Alto 6 1213 12
Other 1299 12
FabricOS 1311 13
Other 1399 13
CloudFlare 1411 14
Azure 1412 14
Salesforce 1413 14
Office 365 Exchange 1414 14
AWS EC2 1415 14
AWS S3 1416 14
Azure Resource Manager 1417 14
Other 1499 14
Riverbed Steelhead 1511 15
Riverbed CMC 1512 15
Web Site 1600 16
Arista EOS 1711 17
JSON file 1811 18
Script path 1812 18
PowerShell 1813 18
Microsoft SQL 1901 19
MySQL 1902 19
Oracle 1903 19
PostgreSQL 1904 19
DB2 1905 19
VMware ESXi 5.1 2001 20
VMware ESXi 5.5 2002 20
VMware ESXi 6.0 2003 20
ArubaOS 2101 21
Citrix Netscaler 2201 22
Data Ontap 2401 24
Clustered Data Ontap 2402 24
SonicOS 2501 25

URL

The URL field is used depending on the node type:

  • Database: Connection string for the database
  • Web Site: Web site URL

For any other node types, this field is unused.

External ID

The External ID is the reference value for an external system (for example, Service-Now).

It is only advised to use this field if you plan to use Service-Now with UpGuard to validate changes made on a node.

Environment ID

You can specify an environment ID that this node will be a part of.

If you do not provide a value here, this node will be a member of the Default environment.

You can find the environment ID through the Environments API endpoint or use the method below:

  1. In the UpGuard UI, navigate to Discover -> Monitored
  2. Select the environment you would like to use (in the bottom of the left sidebar)
  3. Find the ID in the URL bar in your browser

find-environment-id

Target Node Group ID

This field allows you to specify a primary node group (which must be a static node group with no Node Rules or Dynamic Group Queries). The Target Node Group ID is generally not used unless specified by UpGuard support.

Import

To import your own CSV, drag a file into the browser window or:

  1. In the UpGuard UI, navigate to Discover -> Add Nodes
  2. Click the Import CSV button
  3. Drag the file into the browser window or click the Browse button to select a file
  4. Click the View Nodes button to submit

Each attempted CSV import will create a dated node group for the import, such as CSV Import 1 - 2017-11-07. This will allow you to see what was properly imported, and what may have been missed. It also gives you the ability to remove all of the nodes in this import, in case you made a mistake.

If there are validation errors with the CSV, you will see them in a banner at the top of the UpGuard UI after you attempt the CSV import.

However, if you still have nodes that are not added through CSV, please contact UpGuard Support for further troubleshooting.