netbox_ip_address – Создание или удаление IP-адресов из Netbox

Новая версия с 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Создаёт или удаляет IP-адреса из Netbox

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

pynetbox

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
data - / обязательно			Определяет конфигурацию IP-адреса
	address -		Требуется, если состояние `present`
	custom_fields -		должны существовать в Netbox
	description -		Описание интерфейса
	family -	Варианты: 4 6	Указывает семейство адресов IP-адреса
	interface -		Имя и устройство интерфейса, которому должен быть назначен IP-адрес. Требуется, если состояние `present` и указан префикс.
	nat_inside -		Внутренний IP-адрес, назначенный этому IP
	prefix -		В состоянии `present`, если задан интерфейс, будет гарантироваться, что внутренний IP-адрес в этом префиксе (и vrf, если задан) подключён к этому интерфейсу. В противном случае будет получен следующий доступный IP-адрес этого префикса и подключён. В состоянии `new`, будет принудительно получен следующий доступный IP-адрес в этом префиксе. Если задан интерфейс, то он также будет принудительно подключен. Требуется, если состояние `present` или `new`, когда не указан адрес. Не используется, если указан адрес.
	role -	Варианты: Петлевой Вторичный Anycast VIP VRRP HSRP GLBP CARP	Роль IP-адреса
	status -	Варианты: Активный Зарезервированный Устаревший DHCP	Статус IP-адреса
	tags -		Любые метки, которые могут потребоваться IP-адресу
	tenant -		Абонент, которому будет назначено устройство
	vrf -		VRF, с которым связан IP-адрес
netbox_token - / обязательно			Токен, созданный в Netbox для авторизации доступа к API
netbox_url - / обязательно			URL экземпляра Netbox, разрешаемый хостом управления Ansible
state -		Варианты: absent new present ←	Используйте `present`, `new` или `absent` для добавления, принудительного добавления или удаления. `present` проверит, создан ли IP-адрес, и вернёт его, если да. `new` принудит к созданию (полезно для anycast, например).
validate_certs boolean		Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющими сертификатами.

Примечания

Примечание

Метки должны быть определены как список YAML
Это должно выполняться с подключением local и хостами localhost

Примеры

- 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_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_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_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_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_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          family: 4
          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_ip_address:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          family: 4
          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_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_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

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращённое значение	Описание
ip_address словарь	при создании	Сериализованный объект, как созданный или уже существующий в Netbox
msg строка	всегда	Сообщение, указывающее на ошибку или информацию о том, что было достигнуто

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Михаил Иоган (@FragmentedPacket)
Anthony Ruhier (@Anthony25)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для улучшения.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/netbox_ip_address_module.html