netbox_ip_address_module.rst

orphan

netbox.netbox.netbox_ip_address module -- Creates or removes IP addresses from NetBox

Note

This module is part of the netbox.netbox collection (version 3.13.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements <ansible_collections.netbox.netbox.netbox_ip_address_module_requirements> for details.

To use it in a playbook, specify: netbox.netbox.netbox_ip_address.

ansible-version-added

New in netbox.netbox 0.1.0

Synopsis

• Creates or removes IP addresses from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

ansible-option-table

Parameter	Comments
ansible-option-title cert ansible-option-type-line any	Certificate path
ansible-option-title data ansible-option-type-line dictionary / required	Defines the IP address configuration
ansible-option-title address ansible-option-type-line string	Required if state is present
ansible-option-title assigned_object ansible-option-type-line dictionary	Definition of the assigned object.
ansible-option-title device ansible-option-type-line string	The device the interface is attached to.
ansible-option-title name ansible-option-type-line string	The name of the interface
ansible-option-title virtual_machine ansible-option-type-line string	The virtual machine the interface is attached to.
ansible-option-title comments ansible-option-type-line string added in netbox.netbox 3.10.0	Comments that may include additional information in regards to the IP Address
ansible-option-title custom_fields ansible-option-type-line dictionary	must exist in NetBox
ansible-option-title description ansible-option-type-line string	The description of the interface
ansible-option-title dns_name ansible-option-type-line string	Hostname or FQDN
ansible-option-title family ansible-option-type-line integer	(DEPRECATED) - NetBox now handles determining the IP family natively. Specifies with address family the IP address belongs to ansible-option-line Choices: 4 6
ansible-option-title interface ansible-option-type-line any	The name and device of the interface that the IP address should be assigned to Required if state is present and a prefix specified.
ansible-option-title nat_inside ansible-option-type-line any	The inside IP address this IP is assigned to
ansible-option-title prefix ansible-option-type-line any	With state present, if an interface is given, it will ensure that an IP inside this prefix (and vrf, if given) is attached to this interface. Otherwise, it will get the next available IP of this prefix and attach it. With state new, it will force to get the next available IP in this prefix. If an interface is given, it will also force to attach it. Required if state is present or new when no address is given. Unused if an address is specified.
ansible-option-title role ansible-option-type-line string	The role of the IP address ansible-option-line Choices: "Loopback" "Secondary" "Anycast" "VIP" "VRRP" "HSRP" "GLBP" "CARP"
ansible-option-title status ansible-option-type-line any	The status of the IP address
ansible-option-title tags ansible-option-type-line list / elements=any	Any tags that the IP address may need to be associated with
ansible-option-title tenant ansible-option-type-line any	The tenant that the device will be assigned to
ansible-option-title vrf ansible-option-type-line any	VRF that IP address is associated with
ansible-option-title netbox_token ansible-option-type-line string / required	The NetBox API token.
ansible-option-title netbox_url ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
ansible-option-title query_params ansible-option-type-line list / elements=string	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
ansible-option-title state ansible-option-type-line string	Use present, new or absent for adding, force adding or removing. present will check if the IP is already created, and return it if true. new will force to create it anyway (useful for anycasts, for example). ansible-option-line Choices: "absent" "new" "present" ← (default)
ansible-option-title validate_certs ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line Default: true

Notes

Note

- Tags should be defined as a YAML list - This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox IP address module"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create IP address within NetBox with only required information
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          address: 192.168.1.10
        state: present

    - name: Force to create (even if it already exists) the IP
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          address: 192.168.1.10
        state: new

    - name: Get a new available IP inside 192.168.1.0/24
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 192.168.1.0/24
        state: new

    - name: Delete IP address within netbox
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          address: 192.168.1.10
        state: absent

    - name: Create IP address with several specified options
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          address: 192.168.1.20
          vrf: Test
          tenant: Test Tenant
          status: Reserved
          role: Loopback
          description: Test description
          tags:
            - Schnozzberry
        state: present

    - name: Create IP address and assign a nat_inside IP
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          address: 192.168.1.30
          vrf: Test
          nat_inside:
            address: 192.168.1.20
            vrf: Test
          interface:
            name: GigabitEthernet1
            device: test100

    - name: Ensure that an IP inside 192.168.1.0/24 is attached to GigabitEthernet1
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 192.168.1.0/24
          vrf: Test
          interface:
            name: GigabitEthernet1
            device: test100
        state: present

    - name: Attach a new available IP of 192.168.1.0/24 to GigabitEthernet1
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 192.168.1.0/24
          vrf: Test
          interface:
            name: GigabitEthernet1
            device: test100
        state: new

    - name: Attach a new available IP of 192.168.1.0/24 to GigabitEthernet1 (NetBox 2.9+)
      netbox.netbox.netbox_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 192.168.1.0/24
          vrf: Test
          assigned_object:
            name: GigabitEthernet1
            device: test100
        state: new

Return Values

Common return values are documented here <common_return_values>, the following are the fields unique to this module:

ansible-option-table

Key	Description
ansible-option-title ip_address ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox ansible-option-line Returned: on creation
ansible-option-title msg ansible-option-type-line string	Message indicating failure or info about what has been achieved ansible-option-line Returned: always

Authors

• Mikhail Yohman (@FragmentedPacket)
• Anthony Ruhier (@Anthony25)

Collection links

Issue Tracker Repository (Sources)