Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. In Settings –> Setup –> NIOS IPAM Sync, select Sync in the Actions column for the required sync configuration. 
  2. Click Yes to confirm.
    The CSV import of discovered data to NIOS is performed. The IPv4 and IPv6 networks are added to the NIOS appliance database.

Open the NIOS GUI and verify that all the data are imported in to NIOS.

The following table lists the data fields in the CSV file used for IPAM Sync:

ipaddressA valid IPv4 address. Required.

Data Field in IPAM Sync Export File

NetMRIModel->Attribute

Field Description

General Device Data
discovered_name
DNS name of the IP.
ip_addressDevice -> DeviceIPDottedA valid IPv4 address. Required.

mac_address

Device -> DeviceMAC

A valid mac address. Must be lowercase. Optional.

last_discovered_timestamp

Device -> DeviceTimestamp

Timestamp of last time the discoverer has seen the device. A UTC timestamp. Required.

first_discovered_timestamp

Device -> DeviceFirstOccurrence

Timestamp of the first time the discoverer has seen the device. A UTC timestamp. Optional

netbios_name

<none>

The NetBIOS name of device. String type. Maximum size is 15 characters. Optional.

os

Device -> DeviceVersion

The OS of the IP. String Type. Maximum size is 256 characters. Optional.

device_model
The model of device.
device_vendor
The vendor of device.
device_location
The location of device.
device_contact
The contact of device.
oui
The OUI of device.
discoverer
Always "NetMRI".
Attached Device Data (only for endhosts)

network_component_type

Device -> DeviceType

The type of component connected to the IP. Eg Switch, Router, Other. Optional. String type. Max size 32.

network_component_name

Device -> DeviceName

Name of component connected to the IP. Optional. String type. Max size 64.

network_component_ description

Device -> DeviceSysDesc

Description of component connected to the IP. Optional. String type. Max size 256.

network_component_ip

Device -> DeviceIPDotted

IP address of component connected to the IP. Optional. String type. IPv4 address format.

network_component_model
The model of component connected to the IP.
network_component_vendor
Vendor of component connected to the IP.
network_component_location
Type of component connected to the IP.
network_component_contact
Contact of component connected to the IP.

network_component_port_ number


Port number on the component connected to the IP. Optional. Unsigned integer type. Range 0 - 9999.

network_component_port_ name


Port name on the component connected to the IP. Optional. String type. Max size 64.

network_component_port _description


Description of the Port on the component connected to the IP. Optional. String type. Max size 256.

Port Data

port_vlan_name

Vlan -> VlanName

Name of the Vlan on the Port. Optional. String type. Max size 64.

port_vlan_number

Vlan -> VlanIndex

Port Vlan Number. Optional. Unsigned integer type. Range 0 - 9999.

port_speed

Interface -> ifSpeed

Speed settings on the switch port. Optional. String type. Valid values are 10M, 100M, 1G, 10G, 100G, and Unknown.

port_duplex

Interface -> ifDuplex

Duplex settings on the switch port. Optional. String type. Valid values are Full and Half.

port_status

Interface -> ifAdminStatus

Administratively up or down. Optional. String type. Valid values are Up, Down, and Unknown.

port_link_status

Interface -> ifAdminStatus

Connected or not. Optional. String type. Valid values are: Connected, Not Connected, and Unknown.

Cisco ACI Data
VRF and BGP data

Overlay/Overwrite Logic

The following overlay/overwrite logic applies to IPAM Sync, complete the following:

...

  • If the imported subnet conflicts with an existing subnet, it is not accepted. The imported subnet can go into a container as long as there is no conflict.
  • If the subnet already exists, no changes are made.
  • If the subnet is in IPAM but not in NetMRI, it is left in IPAM.

...

tenant
ACI tenant.
bridge_domain
ACI bridge domain.
endpoint_groups
ACI endpoint groups.
VRF and BGP Data
vrf_name
VRF name of the IP address.
vrf_description
VRF description of the IP address.
vrf_rd
VRF route distinguisher of the IP address.
bgp_as
BGP autonomous system number of device.
Wireless Access Point Data
ap_name
Name of wireless access point.
ap_ip_address

IP address of wireless access point.

ap_ssid
SSID of wireless access point.

Overlay/Overwrite Logic

The following overlay/overwrite logic applies to IPAM Sync:

  • Network sync: Newly-imported subnets are imported as “managed”.
    • If the imported subnet conflicts with an existing subnet, it is not accepted. The imported subnet can go into a container as long as there is no conflict.
    • If the subnet already exists, no changes are made.
    • If the subnet is in IPAM but not in NetMRI, it is left in IPAM.
  • IP address sync: New IP addresses are added and marked as “unmanaged”. If an IP address already exists, the field values is overwritten during the import.
    • Before NetMRI 7.1.4 and NIOS 8.1, if the IP address exists in IPAM but it is not in the import file, it is left in IPAM.
    • As of NetMRI 7.1.4 and NIOS 8.1, if the IP address exists in IPAM but it is not in the import file, its discovered data is cleared out. You can control the time that the IP address stays in the NetMRI database after it is no longer discovered under NetMRI. To do so, go to Setup -> General Settings -> Advanced Settings.

Viewing IPAM Sync Discovered Data in NetMRI and NIOS

The following table helps to locate IPAM Sync discovered data in the NetMRI UI.

...

    • .1.4 and NIOS 8.1, if the IP address exists in IPAM but it is not in the import file, it is left in IPAM.
    • As of NetMRI 7.1.4 and NIOS 8.1, if the IP address exists in IPAM but it is not in the import file, its discovered data is cleared out. You can control the time that the IP address stays in the NetMRI database after it is no longer discovered under NetMRI. To do so, go to Setup -> General Settings -> Advanced Settings.

Viewing IPAM Sync Discovered Data in NetMRI and NIOS

In NIOS, you can view the data discovered by NetMRI and synchronized using IPAM Sync as follows:

  • IP addresses data: IPAM –> select a network –> IP List.
  • Networks data: IPAM –> Networks.

The following table helps to locate IPAM Sync discovered data in the NetMRI UI.

Device/Network Explorer Device Identification DescriptionVLAN NameACI Name IP SSID
UI Name of Discovered Data FieldData Field DescriptionPlace in NetMRI UI
General Device Data
IP AddressThe IP address of discovered network device or end host interface.Network Explorer -> Discovery
Last DiscoveredThe timestamp when the IP address was last discovered.
First DiscoveredThe timestamp when the IP address was first discovered.
Discovered MAC AddressThe discovered MAC address for the network device or end host. The discovery acquires the MAC address for hosts that are located on the same network as the Grid member that is running the discovery.Interface Viewer
DiscovererSpecifies whether the IP address was discovered by NetMRI or Network Insight discovery process. Equals to “NetMRI” of “Network Insight” correspondingly.N/A
OSGuess for OS by network discovery. OS info is collected from device by SNMP. Depending on device SNMP settings, this field can be populated with OS version or remain empty (mostly for end hosts) -- in last case Device Type will contain OS name. In NIOS 8.4 and newer versions fingerprint scan result will be displayed as OS of end hosts.Device Viewer
Discovered NameThe name of the network device or end host associated with the discovered IP address.
Device ModelModel name of the device in the vendor terminology.
Device VendorThe vendor name of the discovered device.
Device LocationThe physical location of the network device or endhost.Device Viewer -> Device/Network Explorer -> Device Identification
Device ContactThe contact details for the network device or endhost.
NetBIOS NameThe name returned in the NetBIOS reply or the name you manually register for the discovered host.Switch Port Management -> End hosts
Device Type(s)Identifies the device type.
Device Management IPManagement IP address of the device if the device has more than one IP.
Device Port NameSystem name of the interface the IP associates with.
Device Port TypeHardware type of the interface the IP associates with.
Open Port(s)Open ports of the device. Sample format is "TCP: 21,22,25,80 UDP: 137,139". Limited to max total 1000 ports. Data is collected by Nmap and refreshes every 24 hours. Port scanning must be enabled.
Device OUIThe OUI of device.N/A
Attached Device Data
Attached Device VendorThe vendor name of the switch port connected to the discovered device.For an attached device: Device Viewer
Attached Device AddressThe IP address of the switch that is connected to the network device or endhost.
Attached Device NameIf a reverse lookup was successful for the IP address associated with this switch, the host name is displayed here.
Attached Device TypeIdentifies the switch that is connected to the discovered device.
Attached Device ModelIf a reverse lookup was successful for the IP address associated with this switch, the device model is displayed here.

Attached Device Description

A textual description of the switch that is connected to the discovered device.For an attached device: Device Viewer -> Device/Network Explorer -> Device IdentificationDevice ContactNetBIOS NameSwitch Port Management -> End hosts
Device OUIThe OUI of device.
Attached Device Data
Attached Device VendorFor an attached device: Device ViewerAttached Device AddressAttached Device NameAttached Device TypeAttached Device Model

Attached Device Description

Attached Device LocationThe physical location of the network device to which the discovered host is connected, as detected from the device during discovery.
Attached Device ContactThe contact details of the network device to which the endhost is connected, as detected from the device during discovery.
Attached Device Port DescriptionA textual description of the switch port that is connected to the discovered device.For an attached device: Device Viewer -> Interface -> Configuration
Attached Device LocationPort NameThe name of the switch port connected to the discovered device.
Attached Device ContactPortThe number of the switch port connected to the discovered device.
Attached Device Port For an attached device: Device Viewer -> Interface -> ConfigurationAttached Device Port NameAttached Device Port
Port Data
Port DuplexInterface ViewerPort LinkPort SpeedPort StatusIDIdentificator of the switch port that is connected to the discovered device.
Port Data
Port TypeHardware type of the interface with which the IP is associated.
Port DuplexDuplex settings of the port ofn the network component. Possible values: Full, Half.Interface Viewer
Port LinkLink Status of the port on the network component. Possible values: Connected, Not Connected, Unknown.
Port SpeedSpeed settings of the port of the network component. Possible values:  100G, 100M, 10G, 10M, 1G, Unknown.
Port StatusStatus of the port of the network component. Possible values: Down, Unknown, Up.
VLAN NameName of the VLAN of the network component port.Device Viewer -> Interfaces -> Configuration
VLAN IDNumber of the VLAN of the network component port.
Cisco ACI Data
TenantACI Discovered tenant.Device Viewer -> ACI
Bridge domainACI Discovered bridge domain.
EPGList of comma-separated discovered endpoint groups.
VRF and BGP Data
VRF NameVRF name of IP address.Device Viewer -> Router -> VRF table
VRF DescriptionVRF description of IP address.
VRF RDVRF route distinguisher of IP address.
BGP ASBGP autonomous system number of device.Device Viewer -> Router -> BGP
Wireless Access Point Data
AP NameDiscovered name of Wireless Access Point.Device Viewer -> Wireless

AP IP address

Discovered IP address of Wireless Access Point

.

SSIDService set identifier (SSID) associated with Wireless Access Point.


Fields related to Cisco ACI data (tenant, bridge_domain, endpoint_groups) are specific for SDN elements and controllers.

...