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 -	Варианты: Loopback Вторичный 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)
Энтони Руйе (@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.8/modules/netbox_ip_address_module.html