Merge pull request #232 from ritza-co/update-ipam-addresses

DOCS-188 update IPAM IP addresses screenshots

docs/infrastructure-management/ipam/index.md

@@ -17,20 +17,3 @@ There are multiple ways Device42 can discover IP Addresses and related informati
 ## Importing IP addresses into Device42
 
 Importing existing IP addresses from [Microsoft Excel & CSV spreadsheets](getstarted/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.
-
-
-
-
-## Table of contents
-
-- [DNS Records](infrastructure-management/ipam/dns-records.md)
-- [DNS Zones](infrastructure-management/ipam/dns-zones.md)
-- [IP Addresses](infrastructure-management/ipam/ip-addresses.md)
-- [IP NAT/Map](infrastructure-management/ipam/ip-nat-map.md)
-- [MAC Addresses](infrastructure-management/ipam/mac-addresses.md)
-- [Subnet Tree View](infrastructure-management/ipam/subnet-tree-view.md)
-- [Subnets](infrastructure-management/ipam/subnets.md)
-- [Switch Ports](infrastructure-management/ipam/switch-ports.md)
-- [Switch Templates](infrastructure-management/ipam/switch-templates.md)
-- [VLANs](infrastructure-management/ipam/vlans.md)
-- [VRF Groups](infrastructure-management/ipam/vrf-groups.md)

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

@@ -0,0 +1,117 @@
+---
+title: "IP Addresses"
+sidebar_position: 3
+---
+
+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.
+
+As of v18.03.00, we 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.
+
+### IP Addresses List Page
+
+Navigate to the IP Addresses list page by going to **Resources > IPs > All IP Addresses**.
+
+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.
+
+<ThemedImage
+  alt="IP Addresses list page"
+  sources={{
+    light: useBaseUrl('/assets/images/ipam-ip-addresses/ip-addresses-list-light.png'),
+    dark: useBaseUrl('/assets/images/ipam-ip-addresses/ip-addresses-list-dark.png'),
+  }}
+/>
+
+### 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 click on the **hammer** icon to perform the selected bulk action.
+
+<ThemedImage
+  alt="Bulk actions menu"
+  sources={{
+    light: useBaseUrl('/assets/images/ipam-ip-addresses/bulk-actions-menu-light.png'),
+    dark: useBaseUrl('/assets/images/ipam-ip-addresses/bulk-actions-menu-dark.png'),
+  }}
+/>
+<br/><br/>
+
+The following bulk actions are available for IP addresses:
+
+- **Export selected items to CSV**: create CSV export file. 
+- **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 association for the selected IPs and mark those IPs as available. 
+- **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. 
+- **Do a re-importable export for selected items**: Create an export file that you can re-import.
+- **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 Subnet assignment.
+
+### View IP Address Page
+
+Click on an IP address to view its details.
+
+<ThemedImage
+  alt="View IP address"
+  sources={{
+    light: useBaseUrl('/assets/images/ipam-ip-addresses/view-ip-address-light.png'),
+    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)** 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.
+
+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.
+
+:::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 field should not be populated for a regular IP address.
+:::
+
+### Add/Edit Page
+
+Click on the **Add IP Address** button on the view page to add an IP address.
+
+<ThemedImage
+  alt="Add IP address button"
+  sources={{
+    light: useBaseUrl('/assets/images/ipam-ip-addresses/add-ip-button-light.png'),
+    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 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.
+
+<ThemedImage
+  alt="Add IP address form"
+  sources={{
+    light: useBaseUrl('/assets/images/ipam-ip-addresses/add-ip-address-form-light.png'),
+    dark: useBaseUrl('/assets/images/ipam-ip-addresses/add-ip-address-form-dark.png'),
+  }}
+/>
+<br/><br/>
+
+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.
+
+<ThemedImage
+  alt="Add device from editing view"
+  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.
+:::
+
+### IP Address Management from the Command Line
+
+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/)