Skip to content

Commit 38e3fe7

Browse files
authored
Merge pull request #804 from ritza-co/945-955-ipam-updates
945 955 ipam updates
2 parents ddca697 + 945374f commit 38e3fe7

123 files changed

Lines changed: 377 additions & 116 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/infrastructure-management/ipam/dns-records.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,18 @@ title: "DNS Records"
33
sidebar_position: 1
44
---
55

6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
8+
69
### Types of Records
710

8-
![wpid576-Types_of_Records.png](/assets/images/wpid576-Types_of_Records.png)
11+
<ThemedImage
12+
alt="Types of DNS Records"
13+
sources={{
14+
light: useBaseUrl('/assets/images/dns-records/wpid576-Types_of_Records-light.png'),
15+
dark: useBaseUrl('/assets/images/dns-records/wpid576-Types_of_Records-dark.png'),
16+
}}
17+
/>
918

1019
A/AAAA, CNAME, MX and PTR records are supported and can be automatically populated using [DNS auto-discovery.](auto-discovery/setup-dns-autodiscovery.mdx)
1120

docs/infrastructure-management/ipam/dns-zones.mdx

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,35 @@ title: "DNS Zones"
33
sidebar_position: 2
44
---
55

6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
8+
69
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)
710

811
## DNS Zone Add/Edit page
912

1013
The DNS Zones add/edit page can be reached via the main menu, _Network -> DNS Zones_. Click the "Add DNS Zone" 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, tags relevant to your new zone, and 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.
1114

12-
![Add DNS Zo ne](/assets/images/add_DNS_zone.png)
15+
<ThemedImage
16+
alt="Add DNS Zone"
17+
sources={{
18+
light: useBaseUrl('/assets/images/dns-zones/add_DNS_zone-light.png'),
19+
dark: useBaseUrl('/assets/images/dns-zones/add_DNS_zone-dark.png'),
20+
}}
21+
/>
1322

1423
To define a DNS Zone, add/edit the zone specific fields show above.
1524

1625
## Editing existing records
1726

18-
To edit an existing DNS Zone Record, click the name of the DNS Zone Record you're trying to edit: ![Edit DNS Zone Record](/assets/images/DNS_Zone_Records_List.png)
27+
To edit an existing DNS Zone Record, click the name of the DNS Zone Record you're trying to edit:
28+
29+
<ThemedImage
30+
alt="Edit DNS Zone Record"
31+
sources={{
32+
light: useBaseUrl('/assets/images/dns-zones/DNS_Zone_Records_List-light.png'),
33+
dark: useBaseUrl('/assets/images/dns-zones/DNS_Zone_Records_List-dark.png'),
34+
}}
35+
/>
1936

2037
You can edit individual \\records from the DNS Records list page, _Network menu -> DNS Records_

docs/infrastructure-management/ipam/ip-addresses.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ You can search for IPs with full or partial entries right here. Clicking on an I
2828

2929
### Bulk Actions for IP Addresses
3030

31-
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 click on the **hammer** icon to perform the selected bulk action.
31+
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.
3232

3333
<ThemedImage
3434
alt="Bulk actions menu"
@@ -41,16 +41,16 @@ To perform a bulk action, check the IP addresses to affect from the list and sel
4141

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

44-
- **Export selected items to CSV**: create CSV export file.
44+
- **Export selected items to CSV**: Create CSV export file.
45+
- **Do a re-importable export for selected items**: Create an export file that you can re-import.
4546
- **Delete with Detailed Confirmation:** Displays prompt before deleting.
4647
- **Fast Background Delete**: Delete without prompt.
4748
- **Mark selected IP as available:** Will only mark those IPs available that have no device association.
48-
- **Mark selected IPs as not available** : Will mark selected IPs as not available.
49-
- **Clear ALL fields and Mark selected IPs as available** : This command will clear all device association for the selected IPs and mark those IPs as available.
50-
- **Relocate Selected IPs** : This will bring up a matching subnets page based on first selected IPs. You can choose to move IPs to another subnet with this. Only IPs that are within the range will be moved.
51-
- **Do a re-importable export for selected items**: Create an export file that you can re-import.
49+
- **Mark selected IPs as not available**: Will mark selected IPs as not available.
50+
- **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.
51+
- **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.
5252
- **Add tags to selected items**: add a comma-separated list of tags.
53-
- **Check/Fix selected IPs Subnet assignment**: Displays a page to check or fix Subnet assignment.
53+
- **Check/Fix selected IPs Subnet assignment**: Displays a page to check or fix the Subnet assignment.
5454

5555
### View IP Address Page
5656

@@ -65,17 +65,17 @@ Click on an IP address to view its details.
6565
/>
6666
<br/><br/>
6767

68-
You can see the history of changes for that IP address from the **History (Audit Logs)** button at the top right 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.
68+
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.
6969

70-
In the example above, clicking on the link called _demo_ in the **Resource** field will take you to the K8s cluster that is currently holding that IP.
70+
Clicking on the link in the **Resource** field will take you to the K8s cluster that is currently holding that IP.
7171

7272
:::note
73-
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 field should not be populated for a regular IP address.
73+
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.
7474
:::
7575

7676
### Add/Edit Page
7777

78-
Click on the **Add IP Address** button on the view page to add an IP address.
78+
Click on the **Create** button on the view page to add an IP address.
7979

8080
<ThemedImage
8181
alt="Add IP address button"
@@ -86,7 +86,7 @@ Click on the **Add IP Address** button on the view page to add an IP address.
8686
/>
8787
<br/><br/>
8888

89-
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 IP to be added in that VRF group or subnet (if not a VRF group). You can choose an existing Device and Port or add a new ones from this page.
89+
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.
9090

9191
<ThemedImage
9292
alt="Add IP address form"
@@ -97,7 +97,7 @@ When Adding or editing an IP, the Subnet field is required. Device42 will automa
9797
/>
9898
<br/><br/>
9999

100-
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 another device association** button.
100+
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.
101101

102102
<ThemedImage
103103
alt="Add device from editing view"
@@ -114,4 +114,4 @@ Select **Resources > DNS > All DNS Records** from the main menu to add DNS A/AAA
114114

115115
### IP Address Management from the Command Line
116116

117-
With Device42, you can find if an IP is already in a D42 instance, suggest a 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/)
117+
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/)

docs/infrastructure-management/ipam/ip-nat-map.mdx

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,50 @@ title: "IP NAT/Map"
33
sidebar_position: 4
44
---
55

6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
8+
69
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.
710

8-
- To create an IP Nat/Map, go to _Resources > IPs > IP NAT_ to display Nat/Map list page, and then click _Add IP Nat/Map_ at the top right.
11+
- 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.
912

10-
![](/assets/images/WEB-597_ip-nat-map-menu-1-700x351.png)
13+
<ThemedImage
14+
alt="IP NAT/Map menu"
15+
sources={{
16+
light: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-menu-1-700x351-light.png'),
17+
dark: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-menu-1-700x351-dark.png'),
18+
}}
19+
/>
1120

1221
Device42 displays the Nat/Map add page.
1322

14-
![](/assets/images/WEB-597_ip-nat-map-add-700x390.png)
15-
16-
- 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 magnifying glass icon to select an IP address.
17-
18-
![](/assets/images/WEB-597_ip-nat-map-select-ipaddress-1-700x313.png)
19-
20-
- You can also or select or enter these options:
21-
- _Two way relation_
22-
- _Protocol_
23-
- _Source IP Address End_
24-
- _Source Port Stat_
25-
- _Source Port End_
26-
- _Target IP Address End_
27-
- _Target Port Start_
28-
- _Target Port End_
29-
- When done, click _Save_. The IP Nat/Map is added to the list.
23+
<ThemedImage
24+
alt="IP NAT/Map add page"
25+
sources={{
26+
light: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-add-700x390-light.png'),
27+
dark: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-add-700x390-dark.png'),
28+
}}
29+
/>
30+
31+
- 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.
32+
33+
<ThemedImage
34+
alt="Select IP address"
35+
sources={{
36+
light: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-select-ipaddress-1-700x313-light.png'),
37+
dark: useBaseUrl('/assets/images/ip-nat-map/WEB-597_ip-nat-map-select-ipaddress-1-700x313-dark.png'),
38+
}}
39+
/>
40+
41+
- You can also select or enter these options:
42+
43+
- **Two way relation**
44+
- **Protocol**
45+
- **Source IP Address End**
46+
- **Source Port Stat**
47+
- **Source Port End**
48+
- **Target IP Address End**
49+
- **Target Port Start**
50+
- **Target Port End**
51+
52+
- When done, click **Save**. The IP Nat/Map is added to the list.

docs/infrastructure-management/ipam/subnet-tree-view.mdx

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,62 @@ title: "Subnet Tree View"
33
sidebar_position: 6
44
---
55

6+
import ThemedImage from '@theme/ThemedImage'
7+
import useBaseUrl from '@docusaurus/useBaseUrl'
8+
69
A subnet tree view is available via the main menu; find it by navigating to _Resources_ -> _Network_ -> _Subnet Tree_
710

811
## Subnet Tree View
912

10-
![](/assets/images/subnet_tree_view-1512.png)
13+
<ThemedImage
14+
alt="Subnet Tree View"
15+
sources={{
16+
light: useBaseUrl('/assets/images/subnet-tree-view/subnet_tree_view-1512-light.png'),
17+
dark: useBaseUrl('/assets/images/subnet-tree-view/subnet_tree_view-1512-dark.png'),
18+
}}
19+
/>
1120

1221
Subnets in the tree view are grouped into VRF groups. Because VRF groups have building associations, VRF group display also contains the building name.
1322

1423
New subnets can be added to a VRF group by hovering over a VRF group and clicking _+ New Subnet_ button.
1524

1625
## Hover for details pop-up
1726

18-
![subnet tree hover details](/assets/images/hover_subnet_tree.png)
27+
<ThemedImage
28+
alt="subnet tree hover details"
29+
sources={{
30+
light: useBaseUrl('/assets/images/subnet-tree-view/hover_subnet_tree-light.png'),
31+
dark: useBaseUrl('/assets/images/subnet-tree-view/hover_subnet_tree-dark.png'),
32+
}}
33+
/>
1934

2035
You can hover your mouse over any VRF groups, subnet, or IP and get more details on each. The subnet details includes a small graph that indicates the Percentage (%) of IP addresses used.
2136

2237
Each subnet and VRF group has an Edit button next to it. Click it to make changes from the subnet tree view.
2338

2439
## Add / edit IPs per subnet
2540

26-
![Add / edit IPs per subnet](/assets/images/wpid6691-media_1424648468104.png)
41+
<ThemedImage
42+
alt="Add / edit IPs per subnet"
43+
sources={{
44+
light: useBaseUrl('/assets/images/subnet-tree-view/wpid6691-media_1424648468104-light.png'),
45+
dark: useBaseUrl('/assets/images/subnet-tree-view/wpid6691-media_1424648468104-dark.png'),
46+
}}
47+
/>
2748

2849
Using the _+ New IP_ button after each subnet, you can add a new IP. If the subnet is smaller than 24 mask bits, you will see a list of all IPs that don’t exist yet in that subnet and you can just pick one for the list. For larger subnets you will be presented with a dialog to let you enter the information directly.
2950

3051
Also, next to each IP, you will see an _Edit_ button that will enable you to edit the IP right from this page.
3152

3253
## Nest subnets right from the tree view
3354

34-
![Nest subnets right from the tree view](/assets/images/wpid6689-media_1424645974037.png)
55+
<ThemedImage
56+
alt="Nest subnets right from the tree view"
57+
sources={{
58+
light: useBaseUrl('/assets/images/subnet-tree-view/wpid6689-media_1424645974037-light.png'),
59+
dark: useBaseUrl('/assets/images/subnet-tree-view/wpid6689-media_1424645974037-dark.png'),
60+
}}
61+
/>
3562

3663
You can also nest subnets right from the tree view using the _+ New Subnet_ button after each subnet. If you click this button, you get a tree like view of available subnets within that subnet that you can click on and choose. You can also drag and drop subnets into another subnet or another VRF group.
3764

@@ -43,11 +70,23 @@ Please note that the drag and drop functionality is disabled for trees with over
4370

4471
When adding subnets, you can view used and available subnets at a glance by clicking the _Subnet Usage Tree_ button...
4572

46-
![View available subnets from the tree view](/assets/images/subnet-tree-availability-1.png)
73+
<ThemedImage
74+
alt="View available subnets from the tree view"
75+
sources={{
76+
light: useBaseUrl('/assets/images/subnet-tree-view/subnet-tree-availability-1-light.png'),
77+
dark: useBaseUrl('/assets/images/subnet-tree-view/subnet-tree-availability-1-dark.png'),
78+
}}
79+
/>
4780

4881
In the example above, you see the available subnets for the selected parent subnet. You will see the available subnets in green and the used (or partially used subnets) in red. You can drill further into the subnet tree by clicking "Expand All"...
4982

50-
![View available subnets from the tree view](/assets/images/subnet-tree-availability-2.png)
83+
<ThemedImage
84+
alt="View available subnets from the tree view"
85+
sources={{
86+
light: useBaseUrl('/assets/images/subnet-tree-view/subnet-tree-availability-2-light.png'),
87+
dark: useBaseUrl('/assets/images/subnet-tree-view/subnet-tree-availability-2-dark.png'),
88+
}}
89+
/>
5190

5291
These views will help you decide which subnet to assign.
5392

@@ -57,11 +96,23 @@ When you choose a subnet to assign, the subnet you choose will have a big impact
5796

5897
Device42 offers a patent-pending recommendation engine for choosing subnets. Just enter the desired _Mask Bits_ and click the "Suggest Subnet" button and Device42 will calculate the optimal subnet. You will be presented with two options to ignore parent subnets that are merged as Assigned or Allocated even if they are still empty. Once you click the "Run" button, Device42 will present its suggestion for you to accept or decline.
5998

60-
![Recommend a subnet from the tree view](/assets/images/subnet-tree-suggest-1.png)
99+
<ThemedImage
100+
alt="Recommend a subnet from the tree view"
101+
sources={{
102+
light: useBaseUrl('/assets/images/subnet-tree-view/subnet-tree-suggest-1-light.png'),
103+
dark: useBaseUrl('/assets/images/subnet-tree-view/subnet-tree-suggest-1-dark.png'),
104+
}}
105+
/>
61106

62107
## Add new IPs from the tree view
63108

64-
![Add new IPs from the tree view](/assets/images/wpid6690-media_1424646022240.png)
109+
<ThemedImage
110+
alt="Add new IPs from the tree view"
111+
sources={{
112+
light: useBaseUrl('/assets/images/subnet-tree-view/wpid6690-media_1424646022240-light.png'),
113+
dark: useBaseUrl('/assets/images/subnet-tree-view/wpid6690-media_1424646022240-dark.png'),
114+
}}
115+
/>
65116

66117
Using the _+ New IP_ button after each subnet, you can add a new IP. If the subnet is smaller than 24 mask bits, then you will see a list of all IPs that don’t exist yet in that subnet and you can just pick one for the list. If the subnet is larger, you will go directly to the _Add IP Address_ dialog where you can enter all the details directly.
67118

0 commit comments

Comments
 (0)