Assigning Primary IPv4 address to a device via script

[smgray315uk]

I am trying to bulk import IP addresses into IPAM via csv and assigning the required IP address to a devices interface also making the IP address the primary ipv4 IP address.

The script I created below successfully imports the IP Address and assigns the IP address to a devices interface, although I cannot get the IP address to set as the Primary IPv4 address on the device.

class create_ip_address(Script):
    class Meta:
        name = "Creates a new IP Address in IPAM"
        description = "Script to add a new IP Address in IPAM"
        field_order = ['input_file']

    input_file = FileVar(
        description = "Select file containing ipaddress(Col: ipaddress), typevalue(col: typevalue), desc(Col: desc), devicename(Col: devicename), interfacename(Col: interfacename)"
    )

    def run(self, data, commit):
        self.log_info("File Name {}".format(data['input_file']))
        data = pd.read_csv(data['input_file'], header=0)
        
        #Sets the required variables
        for ind in data.index:
            ipaddress = str(data['ipaddress'][ind])
            typevalue = str(data['typevalue'][ind])           
            desc = str(data['desc'][ind])
            devicename = str(data['devicename'][ind])            
            interfacename = str(data['interfacename'][ind])
            self.log_debug("Data reading: {} - {} - {} - {} - {}".format(ipaddress,typevalue,desc,devicename,interfacename))
            
            #Creates an IP Address and assigns to an interface
            addressnew = IPAddress(
                address = ipaddress,
                dns_name = devicename,
                description = desc,
                role = str(typevalue.lower()),
                assigned_object = Interface.objects.get(name=interfacename),
                primary_ip4_for = Device.objects.get(name=devicename)       
            )
            addressnew.save()

[DanSheps]

You cannot generally use the _for auto generated keys to assign.

What you want instead is...

Interface.device.primary_ip4 = address or interface.device.primary_ip6 = address and then interface.device.save()

[smgray315uk]

I'm not the best at this :) - I have tried quite a few different ways as you mentioned although cannot seem to get passed, this issue:-
An exception occurred: AttributeError: 'str' object has no attribute 'save'

Traceback (most recent call last):
File "/opt/netbox-3.0.11/netbox/extras/scripts.py", line 430, in _run_script
script.output = script.run(data=data, commit=commit)
File "/opt/netbox-3.0.11/netbox/scripts/network.py", line 109, in run
Interface.device.primary_ip4=primaryip.save()
AttributeError: 'str' object has no attribute 'save'

Copy of my updated scripts below:-

class create_ip_address(Script):
    class Meta:
        name = "Creates a new IP Address in IPAM"
        description = "Script to add a new IP Address in IPAM"
        field_order = ['input_file']

    input_file = FileVar(
        description = "Select file containing ipaddress(Col: ipaddress), typevalue(col: typevalue), desc(Col: desc), devicename(Col: devicename), interfacename(Col: interfacename)"
    )

    def run(self, data, commit):
        self.log_info("File Name {}".format(data['input_file']))
        data = pd.read_csv(data['input_file'], header=0)
#Sets the required variables
        for ind in data.index:
            ipaddress = str(data['ipaddress'][ind])
            typevalue = str(data['typevalue'][ind])           
            desc = str(data['desc'][ind])
            devicename = str(data['devicename'][ind])            
            interfacename = str(data['interfacename'][ind])
            self.log_debug("Data reading: {} - {} - {} - {} - {}".format(ipaddress,typevalue,desc,devicename,interfacename))
            
            #Creates an IP Address and assigns to an interface
            addressnew = IPAddress(
                address = ipaddress,
                dns_name = devicename,
                description = desc,
                role = str(typevalue.lower()),
                assigned_object = Interface.objects.get(name=interfacename),                
            )
            addressnew.save()
            
            #Assigns IP Address as Primary IPv4 address
            Interface.device.primary_ip4=ipaddress.save() 
            
            #Displays what has been created and modified 
            self.log_success("IP Assignment address: {}, dns_name: {}, Description: {}, Assigned Interface: {}, Role: {}".format(addressnew.address, addressnew.dns_name, addressnew.description, addressnew.assigned_object, addressnew.role))

[DanSheps]

That is because you are doing it wrong...

Example:

You should be doing:

interface.device.primary_ip4 = addressnew
interface.device.save()

[smgray315uk]

Thanks for the update, although I get a similar error when updating as above:-
An exception occurred: AttributeError: 'ForwardManyToOneDescriptor' object has no attribute 'save'

Traceback (most recent call last):
File "/opt/netbox-3.0.11/netbox/extras/scripts.py", line 430, in _run_script
script.output = script.run(data=data, commit=commit)
File "/opt/netbox-3.0.11/netbox/scripts/network.py", line 110, in run
Interface.device.save()
AttributeError: 'ForwardManyToOneDescriptor' object has no attribute 'save'

updated code:-

#Sets the required variables
        for ind in data.index:
            ipaddress = str(data['ipaddress'][ind])
            typevalue = str(data['typevalue'][ind])           
            desc = str(data['desc'][ind])
            devicename = str(data['devicename'][ind])            
            interfacename = str(data['interfacename'][ind])
            self.log_debug("Data reading: {} - {} - {} - {} - {}".format(ipaddress,typevalue,desc,devicename,interfacename))
            
            #Creates an IP Address and assigns to an interface
            addressnew = IPAddress(
                address = ipaddress,
                dns_name = devicename,
                description = desc,
                role = str(typevalue.lower()),
                assigned_object = Interface.objects.get(name=interfacename),                
            )
            addressnew.save()
            
            #Assigns IP Address as Primary IPv4 address
            Interface.device.primary_ip4 = addressnew
            Interface.device.save() 
                  
            #Displays what has been created and modified 
            self.log_success("IP Assignment address: {}, dns_name: {}, Description: {}, Assigned Interface: {}, Role: {}".format(addressnew.address, addressnew.dns_name, addressnew.description, addressnew.assigned_object, addressnew.role))
            #else: 
                #self.log_warning("Interface type is not valid for {} - {}, should be in (other)".format(old_device_name, TypeValue))

[candlerb]

Please can you edit your post to correct the formatting: add three backticks (```) on a line of their own, before and after the code. That will make it much easier to read.

Note that you can't do this on the class "Interface":

Interface.device.primary_ip4 = addressnew

You need to set the primary_ip4 on a specific device instance. If you have an interface instance then you can do it:

interface = Interface.objects.get(name=interfacename)   # but see below
device = interface.device
device.primary_ip4 = addressnew
device.save()

However this will have problems because of the lack of uniqueness in interface names, including what you wrote previously:

            assigned_object = Interface.objects.get(name=interfacename),  

Interface names are only unique within the context of a device, so if you have two devices both with interface "eth0" then this will fail. You need to get the interface on a specific device. I think something like this (untested):

device = Device.objects.get(name=devicename)
interface = Interface.objects.get(name=interfacename, device_id=device.id)

However, device names are also not necessarily unique (only within a site).

[smgray315uk]

Brilliant, that did the trick this worked. We are placing the FQDN of the hosts in the interface name to make them unique so this should do the trick.

Thanks

Working code below:-

class create_ip_address(Script):
    class Meta:
        name = "Creates a new IP Address in IPAM"
        description = "Script to add a new IP Address in IPAM"
        field_order = ['input_file']

    input_file = FileVar(
        description = "Select file containing ipaddress(Col: ipaddress), typevalue(col: typevalue), desc(Col: desc), devicename(Col: devicename), interfacename(Col: interfacename), primaryip(Col: primaryip)"
    )

    def run(self, data, commit):
        self.log_info("File Name {}".format(data['input_file']))
        data = pd.read_csv(data['input_file'], header=0)
        
        #Sets the required variables
        for ind in data.index:
            ipaddress = str(data['ipaddress'][ind])
            typevalue = str(data['typevalue'][ind])           
            desc = str(data['desc'][ind])
            devicename = str(data['devicename'][ind])            
            interfacename = str(data['interfacename'][ind])
            self.log_debug("Data reading: {} - {} - {} - {} - {}".format(ipaddress,typevalue,desc,devicename,interfacename))
            
            #Creates an IP Address and assigns to an interface
            addressnew = IPAddress(
                address = ipaddress,
                dns_name = devicename,
                description = desc,
                role = str(typevalue.lower()),
                assigned_object = Interface.objects.get(name=interfacename),                
            )
            addressnew.save()
            
            #Assigns IP Address as Primary IPv4 address
            interface = Interface.objects.get(name=interfacename)
            device = interface.device
            device.primary_ip4 = addressnew
            device.save()
                  
            #Displays what has been created and modified 
            self.log_success("IP Assignment address: {}, dns_name: {}, Description: {}, Assigned Interface: {}, Role: {}".format(addressnew.address, addressnew.dns_name, addressnew.description, addressnew.assigned_object, addressnew.role))
            #else: 
                #self.log_warning("Interface type is not valid for {} - {}, should be in (other)".format(old_device_name, TypeValue))

[candlerb]

There is a custom script here which may have some useful clues in it:
https://github.com/netbox-community/reports/blob/master/scripts/create_vm.py

It creates a VM, an interface, an IP address (or two: v4 and v6), and sets the VM's primary address(es).