IPAM Overhaul: Assign IP Address to Multiple Interfaces

[martin-networker]

TODO

Beta Give feedback

1. Spike: IP to Multiple Interfaces: Can this be done with a single table instead of two separate ones (we eventually do want to collapse Device and VM) #3190
   type: feature +1
   
2. Assign IP to Multiple Interfaces: Prototype M2M Change #3236
   type: feature +1
   
3. Assign IP to Multiple Interfaces: Feature-completeness #3411
   epic type: feature +2

High Priority

Beta Give feedback

1. IP-Interface M2M: IPAddressFilterSet Filter on Interface Relationships #3634
   0 of 2
   type: feature +1
   
2. IP-Interface M2M: Validate GraphQL Representation #3635
   type: feature +1
   
3. IP-Interface M2M: "Assign IP Address(s)" Button on Interface List View #3636
   type: feature +1
   
4. IP-Interface M2M: Model clean, ORM Enforcement #3637
   type: feature +1
   
5. Interface(s), Interface Parent(s) Columns IP Address List View #4100
   type: feature +1
   
6. IPAddressToInterface: primary_for_device was Removed, Left in Data Migration #4104
   type: housekeeping +1
   
7. Error occurs when adding an IPAddress to a VirtualMachine #3536
   type: bug +1
   

---

As ...

Austin - Network Automation Engineer

I want ...

To be able to assign one IP address to multiple interfaces/devices.

So that ...

We can assign anycast and other shared IP addresses to all interfaces/devices which has this IP address assigned instead of assigning this IP.

I know this is done when...

Reason for request:
In our infrastructure we use anycast IP addresses extensively. For example in on DC around two hundred switches share about 40 anycast IP addresses. Another case is for NVE interface switches in VPC cluster has to share one IP so in every VPC cluster two switches share one IP.

Current Nautobot options:

1. Assign shared IP address to one device:
   This will be incorrect information and it will lead to confusions and cause mistakes.
2. Create a custom field for the interface object that points to the IP address object:
   This will not give us any connection between IP and interfaces. User or script would have to go through all interfaces of all devices to find out where is IP assigned which makes it unusable.
3. Create a One-To-Many relationship which will connect IP address to multiple interfaces:
   IP address is not seen in Interfaces view (if you open Device and switch to tab interfaces) you must open every interface to find where it is assigned.
   IP address does not have assignment (Operational Details > Assignment).
   This means the relationship is not visible from Interfaces view nor from IP address view.

Possible solution:
Change assignment of IPs from one-to-one to one-to-many. This would be a breaking change and require a database change.
In GUI it would be great to keep the current functionality and create condition:
a) if IP is assigned to only one Interface:
in Operational Details > Assignment it will show the one Device directly (just like it is now)
b) if IP is assigned to more than one Interface (or maybe it can be based on Role so if IP Role is Anycast/Shared/etc.):
Operational Details > Assignment will show something like Relationship is showing. Parameter interfaces and value will be link (x interfaces) which would open new window IP Address Associations (similar to Relationship Associations).
If the condition would cause difficulty the b) option would be sufficient.
If you have different idea how to achieve this we can discuss it in comments.

Optional - Feature groups this request pertains to.

• DCIM
• IPAM
• Virtualization

Database Changes

Yes: change of current IP address model.

External Dependencies

No response

[bryanculver]

Medium to low priority issues have been moved to "IP-Interface M2M Enhancements" epic in Zenhub. To be prioritized and committed to accordingly.

Closing as #3636 is in flight and last open issue of this epic.