Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/infrastructure-management/ipam/dns-records.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: "DNS Records"
sidebar_position: 1
sidebar_position: 8
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

A/AAAA, CNAME, MX and PTR records are supported and can be automatically populated using [DNS auto-discovery.](auto-discovery/setup-dns-autodiscovery.mdx)
Device42 supports A/AAAA, CNAME, MX, and PTR records. Records can be added manually or populated automatically using [DNS discovery](/auto-discovery/setup-dns-autodiscovery.mdx).

A/AAAA records are automatically associated with existing IP addresses (or can be associated with new IP Addresses when they are created).
A/AAAA records are automatically associated with existing IP addresses, or can be associated with new IP addresses when they are created.

You can search for records or filter by domain to edit or view certain records.
Navigate to **Resources > DNS > All DNS Records** to view, search, and filter records by domain.

<ThemedImage
alt="Types of DNS Records"
alt="DNS records list"
sources={{
light: useBaseUrl('/assets/images/dns-records/wpid576-Types_of_Records-light.png'),
dark: useBaseUrl('/assets/images/dns-records/wpid576-Types_of_Records-dark.png'),
Expand Down
22 changes: 11 additions & 11 deletions docs/infrastructure-management/ipam/dns-zones.mdx
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
---
title: "DNS Zones"
sidebar_position: 2
sidebar_position: 7
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

DNS zones can be added manually or (preferrably) via DNS auto-discovery as discussed at: [discovery/setup-dns-autodiscovery.mdx](auto-discovery/setup-dns-autodiscovery.mdx)
DNS zones represent sections of the domain name space managed by a specific nameserver. Zones can be added manually or populated via [DNS discovery](/auto-discovery/setup-dns-autodiscovery.mdx).

## DNS Zone Add/Edit page
## Add a DNS Zone

The DNS Zones add or edit page can be reached via the main menu, under **Resources > DNS Zones**. Click the **Create** button in the upper right to add a new zone. Give your zone a name, and specify the **Nameserver** for that zone. Optionally, you can specify the **VRF Group** that your new Zone belongs to, add **Tags** relevant to your new zone, and add any relevant **Notes**. Click **Save** in the bottom right when finished, and you'll be brought back to the DNS Zones list page, where you will see your new zone along with any others that exist.
Navigate to **Resources > DNS > DNS Zones** and click **Create** to add a new zone.

Enter a name and specify the **Nameserver** for the zone. Optionally, specify the **VRF Group** the zone belongs to, add **Tags**, and add any relevant **Notes**. Click **Save** when finished.

<ThemedImage
alt="Add DNS Zone"
alt="Add DNS zone"
sources={{
light: useBaseUrl('/assets/images/dns-zones/add_DNS_zone-light.png'),
dark: useBaseUrl('/assets/images/dns-zones/add_DNS_zone-dark.png'),
}}
style={{ width: '70%' }}
style={{ width: '70%' }}
/>

To define a DNS Zone, add or edit the zone specific fields show above.

## Editing existing records
## Edit an Existing DNS Zone

To edit an existing DNS Zone record (under under **Resources > DNS Zones**), click the name of the DNS Zone record you want to edit and click the **Edit** button in the upper right.
Navigate to **Resources > DNS > DNS Zones**, click the name of the DNS zone you want to edit, then click **Edit**.

<ThemedImage
alt="Edit DNS Zone Record"
alt="DNS zone records list"
sources={{
light: useBaseUrl('/assets/images/dns-zones/DNS_Zone_Records_List-light.png'),
dark: useBaseUrl('/assets/images/dns-zones/DNS_Zone_Records_List-dark.png'),
Expand Down
18 changes: 9 additions & 9 deletions docs/infrastructure-management/ipam/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
title: "IPAM"
---

**IP Address Management _\[aka IPAM\]_** software helps IT systems admins track and manage the IP addresses in their computer networks.
Device42's IP Address Management (IPAM) module lets you track and manage IP addresses, subnets, VLANs, VRF groups, DNS records, switch ports, and NAT mappings across your network infrastructure.

[IP Address Management (IPAM)](https://www.device42.com/features/ip-address-management/) is an essential part of Device42. With Device42's comprehensive network autodiscovery, it's never been easier to maintain up-to-date documentation of your IP Addresses, MAC Addresses, and DNS Infrastructure. In this section, we will cover VLAN, Subnet, IP Address, MAC Address, Switch Port Connectivity, and IP NATs.
This section covers how to organize your address space with VRF groups and VLANs, manage subnets and individual IP addresses, configure DNS zones and records, and work with switch port connectivity. Most IPAM data is populated automatically through network discovery, but you can also add and edit entries manually.

## Discovering IP Addresses
## Discover IP Addresses

There are multiple ways Device42 can discover IP Addresses and related information:
Device42 can discover IP addresses and related network information through several methods:

- [Network SNMP Discovery](/auto-discovery/network-auto-discovery.mdx): Configuring and running SNMP autodiscovery to gather subnets, IP to MAC Address relationships, and MAC Address to Switch Port relationship information.
- [Device42's Auto Discovery](/auto-discovery/windows-and-hyper-v-auto-discovery.mdx): Using the autodiscovery client to discover Microsoft Windows and Linux and/or UNIX devices on your network, including their IP and MAC Address details.
- [Device42's Ping Sweep Tool](/auto-discovery/d42-ping-sweep.mdx): This page details usage of the ping sweep utility to keep your IP Address information up-to-date.
- [Network SNMP Discovery](/auto-discovery/network-auto-discovery.mdx): Discover subnets, IP-to-MAC address relationships, and MAC-to-switch-port connectivity.
- [Windows and Hyper-V Discovery](/auto-discovery/windows-and-hyper-v-auto-discovery.mdx): Discover Windows, Linux, and UNIX devices on your network, including their IP and MAC address details.
- [Ping Sweep](/auto-discovery/d42-ping-sweep.mdx): Keep your IP address records up to date by sweeping address ranges for active hosts.

## Importing IP addresses into Device42
## Import IP Addresses

Importing existing IP addresses from [Microsoft Excel & CSV spreadsheets](/getstarted/using-device42/importing-data-from-existing-spreadsheets.mdx) is easy - Take advantage of this powerful feature to import existing IP Address data from MS Excel and/or .CSV _\[Comma Separated Value\]_ spreadsheets into Device42 IPAM.
You can import existing IP address data from Microsoft Excel or CSV spreadsheets. See [Importing Data From Existing Spreadsheets](/getstarted/using-device42/importing-data-from-existing-spreadsheets.mdx) for instructions.
63 changes: 28 additions & 35 deletions docs/infrastructure-management/ipam/ip-addresses.mdx
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
---
title: "IP Addresses"
sidebar_position: 3
sidebar_position: 5
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

IP Addresses in the Device42 database must be unique per VRF group. So, you can have two subnets with overlapping IP ranges as long as they are in different VRF groups. The only issue with overlapping subnet ranges is that autodiscovery and import will add or modify the IP into first subnet it finds in the list.
IP addresses in Device42 must be unique per VRF group. You can have two subnets with overlapping IP ranges as long as they are in different VRF groups. With overlapping subnet ranges, discovery and import will add or modify the IP in the first matching subnet found in the list.

Device42 can return information about IP addresses that are associated with multiple devices. The IP list page now includes a **Devices** column displaying the device or devices associated with an IP (in comma-separated format). You can also use the IP edit page to add or delete devices associated with an IP address as shown in the [Add/Edit Page](#addedit-page) section below.
The IP list page includes a **Devices** column displaying all devices associated with an IP in comma-separated format. You can also add or remove device associations from the IP edit page.

## IP Addresses List Page

Navigate to the IP Addresses list page by going to **Resources > IPs > All IP Addresses**.
Navigate to **Resources > IPs > All IP Addresses** to view the IP addresses list page.

The list page shows IPv4 and IPv6 addresses that you can sort by any field. You can also filter by type, availability, updated time stamp, subnet, VRF group, and tags.

You can search for IPs with full or partial entries right here. Clicking on an IP takes you to its view page.
The list page shows IPv4 and IPv6 addresses that you can sort by any field. You can also filter by type, availability, updated time stamp, subnet, VRF group, and tags. Search for IPs with full or partial entries, and click on any IP to view its details.

<ThemedImage
alt="IP Addresses list page"
Expand All @@ -28,7 +26,7 @@ You can search for IPs with full or partial entries right here. Clicking on an I

### Bulk Actions for IP Addresses

To perform a bulk action, check the IP addresses to affect from the list and select an action from the **Select an action** dropdown menu. Then confirm the action in the dialog to perform the selected bulk action.
Select IP addresses from the list, choose an action from the **Select an action** dropdown menu, and confirm in the dialog.

<ThemedImage
alt="Bulk actions menu"
Expand All @@ -37,22 +35,21 @@ To perform a bulk action, check the IP addresses to affect from the list and sel
dark: useBaseUrl('/assets/images/ipam-ip-addresses/bulk-actions-menu-dark.png'),
}}
/>
<br/><br/>

The following bulk actions are available for IP addresses:
The following bulk actions are available:

- **Export selected items to CSV**: Create CSV export file.
- **Do a re-importable export for selected items**: Create an export file that you can re-import.
- **Delete with Detailed Confirmation:** Displays prompt before deleting.
- **Fast Background Delete**: Delete without prompt.
- **Mark selected IP as available:** Will only mark those IPs available that have no device association.
- **Mark selected IPs as not available**: Will mark selected IPs as not available.
- **Clear ALL fields and Mark selected IPs as available**: This command will clear all device associations for the selected IPs and mark those IPs as available.
- **Relocate Selected IPs**: This will bring up a matching subnets page based on the first selected IPs. You can choose to move IPs to another subnet with this. Only IPs that are within the range will be moved.
- **Add tags to selected items**: add a comma-separated list of tags.
- **Check/Fix selected IPs Subnet assignment**: Displays a page to check or fix the Subnet assignment.
- **Export selected items to CSV:** Create a CSV export file.
- **Do a re-importable export for selected items:** Create an export file that you can re-import.
- **Delete with Detailed Confirmation:** Display a prompt before deleting.
- **Fast Background Delete:** Delete without a prompt.
- **Mark selected IP as available:** Mark IPs as available only if they have no device association.
- **Mark selected IPs as not available:** Mark selected IPs as not available.
- **Clear ALL fields and Mark selected IPs as available:** Clear all device associations for the selected IPs and mark them as available.
- **Relocate Selected IPs:** Display a matching subnets page based on the selected IPs. Only IPs within the target subnet range will be moved.
- **Add tags to selected items:** Add a comma-separated list of tags.
- **Check/Fix selected IPs Subnet assignment:** Display a page to check or fix the subnet assignment.

### View IP Address Page
### View an IP Address

Click on an IP address to view its details.

Expand All @@ -63,19 +60,18 @@ Click on an IP address to view its details.
dark: useBaseUrl('/assets/images/ipam-ip-addresses/view-ip-address-dark.png'),
}}
/>
<br/><br/>

You can see the history of changes for that IP address from the **History (Audit Logs)** tab at the top of the page (similar to all other view pages in the application). If you have appropriate permissions, the **Edit** button will be available. All DNS records that use this IP are shown in the view page as well.
View the history of changes from the **History (Audit Logs)** tab at the top of the page. If you have appropriate permissions, the **Edit** button is available. All DNS records that use this IP are shown on the view page as well.

Clicking on the link in the **Resource** field will take you to the K8s cluster that is currently holding that IP.
The **Resource** field links to the Kubernetes cluster that is currently holding that IP.

:::note
Entries in the **Configuration Resource** and **Configuration Resource Item** fields make sense only in the context of a Kubernetes cloud discovery job ([cloud platforms autodiscovery](auto-discovery/cloud-auto-discovery/index.mdx)) and are filled in automatically. These fields should not be populated for a regular IP address.
The **Configuration Resource** and **Configuration Resource Item** fields apply only to Kubernetes cloud discovery jobs (see [cloud platforms discovery](/auto-discovery/cloud-auto-discovery/index.mdx)) and are populated automatically. Do not populate these fields for a regular IP address.
:::

### Add an IP Address

Click on the **Create** button on the view page to add an IP address.
Click **Create** on the list page to add a new IP address.

<ThemedImage
alt="Add IP address button"
Expand All @@ -84,9 +80,8 @@ Click on the **Create** button on the view page to add an IP address.
dark: useBaseUrl('/assets/images/ipam-ip-addresses/add-ip-button-dark.png'),
}}
/>
<br/><br/>

When adding or editing an IP, the Subnet field is required. Device42 will automatically check if the IP falls within the allowed IP range in the subnet and will not allow duplicate IPs to be added in that VRF group or subnet (if not a VRF group). You can choose an existing device and port or add new ones from this page.
The **Subnet** field is required. Device42 automatically checks that the IP falls within the allowed range in the subnet and prevents duplicate IPs within the same VRF group or subnet. You can choose an existing device and port or add new ones from this page.

<ThemedImage
alt="Add IP address form"
Expand All @@ -95,25 +90,23 @@ When adding or editing an IP, the Subnet field is required. Device42 will automa
dark: useBaseUrl('/assets/images/ipam-ip-addresses/add-ip-address-form-dark.png'),
}}
/>
<br/><br/>

## Associate Devices With an IP Address

To enter additional device(s) to associate with an already-created IP address, click on the **Edit** button of the IP address from its view page. Then click on the **+ Add New** button.
To associate additional devices with an existing IP address, click **Edit** on the IP address view page, then click **+ Add New**.

<ThemedImage
alt="Add device from editing view"
alt="Add device association"
sources={{
light: useBaseUrl('/assets/images/ipam-ip-addresses/add-device-association-light.png'),
dark: useBaseUrl('/assets/images/ipam-ip-addresses/add-device-association-dark.png'),
}}
/>
<br/><br/>

:::tip
Select **Resources > DNS > All DNS Records** from the main menu to add DNS A/AAAA records for the IP and they will be updated on the IP address.
Navigate to **Resources > DNS > All DNS Records** to add DNS A or AAAA records for the IP. The records will be reflected on the IP address view page.
:::

## IP Address Management from the Command Line
## Manage IP Addresses from the Command Line

With Device42, you can find if an IP is already in a D42 instance, suggest the next available IP, and add an IP from the command line using the REST APIs. Here is a post discussing this: [https://www.device42.com/blog/2013/03/27/ip-address-management-from-the-command-line/](https://www.device42.com/blog/2013/03/27/ip-address-management-from-the-command-line/)
You can check whether an IP exists, suggest the next available IP, and add an IP from the command line using the [Device42 REST APIs](https://api.device42.com/).
34 changes: 17 additions & 17 deletions docs/infrastructure-management/ipam/ip-nat-map.mdx
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
---
title: "IP NAT/Map"
sidebar_position: 4
sidebar_position: 6
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

IP Nat/Map functions are used for routing, such as routing external IPs to internal IPs or routing traffic within different network segments. You define IP Nat/Maps as they are not found during discovery.
IP NAT/Map entries define network address translation (NAT) mappings, such as routing external IPs to internal IPs or routing traffic between different network segments. NAT mappings are not found during discovery and must be defined manually.

- To create an IP Nat/Map, go to **Resources > IPs > IP NAT** to display Nat/Map list page, and then click **Create** at the top right.
## Create an IP NAT/Map

Navigate to **Resources > IPs > IP NAT** to display the NAT/Map list page, then click **Create**.

<ThemedImage
alt="IP NAT/Map menu"
alt="IP NAT/Map list page"
sources={{
light: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-menu-1-700x351-light.png'),
dark: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-menu-1-700x351-dark.png'),
}}
/>

Device42 displays the Nat/Map add page.
Enter a **Name** for the NAT/Map, then enter the **Source IP Address Start** and **Target IP Address Start**. You can also use the **plus icon** to select an IP address.

<ThemedImage
alt="IP NAT/Map add page"
Expand All @@ -28,8 +30,6 @@ Device42 displays the Nat/Map add page.
}}
/>

- Enter a **Name** for the Nat/Map, and then enter the **Source IP Address Start** and **Target IP Address Start**. You can also use the plus icon to select an IP address.

<ThemedImage
alt="Select IP address"
sources={{
Expand All @@ -38,15 +38,15 @@ Device42 displays the Nat/Map add page.
}}
/>

- You can also select or enter these options:
The following optional fields are also available:

- **Two way relation**
- **Protocol**
- **Source IP Address End**
- **Source Port Stat**
- **Source Port End**
- **Target IP Address End**
- **Target Port Start**
- **Target Port End**
- **Two Way Relation**
- **Protocol**
- **Source IP Address End**
- **Source Port Start**
- **Source Port End**
- **Target IP Address End**
- **Target Port Start**
- **Target Port End**

- When done, click **Save**. The IP Nat/Map is added to the list.
Click **Save** to add the IP NAT/Map to the list.
Loading