netbox_interface – Создаёт или удаляет интерфейсы в Netbox

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

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

Описание

Создаёт или удаляет интерфейсы в Netbox

Требования

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

pynetbox

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
data - / обязательно			Определяет конфигурацию префикса
	description строка		Описание префикса
	device строка / обязательно		Имя устройства, к которому будет привязан интерфейс (регистрозависимо)
	enabled логическое значение	Варианты: нет да	Устанавливает, отображается ли интерфейс как активный или отключенный
	form_factor строка		Тип интерфейса: например, 1000Base-T (1GE), Виртуальный, 10GBASE-T (10GE). Должен быть указан точно так же, как в пользовательском интерфейсе
	lag словарь		Родительский интерфейс LAG, членом которого будет являться данный интерфейс
	mac_address строка		MAC-адрес интерфейса
	mgmt_only логическое значение	Варианты: нет да	Этот интерфейс используется только для управления вне зоны сети
	mode строка	Варианты: Доступ Опознанные Все опознанные	Режим интерфейса
	mtu строка		MTU интерфейса
	name строка / обязательно		Имя создаваемого интерфейса
	tagged_vlans список		Список опознанных VLAN, которые должны быть назначены интерфейсу. Режим должен быть установлен либо на `Tagged`, либо на `Tagged All`.
	tags список		Любые метки, которые могут потребоваться для ассоциации с префиксом
	untagged_vlan словарь		VLAN без тегов, который должен быть назначен интерфейсу
netbox_token строка / обязательно			Токен, созданный в Netbox для авторизации доступа к API
netbox_url строка / обязательно			URL экземпляра Netbox, доступного для хоста Ansible
state строка		Варианты: absent present ←	Используйте `present` или `absent` для добавления или удаления.
validate_certs логическое значение		Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяемые сертификаты.

Примечания

Примечание

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

Примеры

- name: "Test Netbox interface module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create interface within Netbox with only required information
      netbox_interface:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: test100
          name: GigabitEthernet1
        state: present
    - name: Delete interface within netbox
      netbox_interface:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: test100
          name: GigabitEthernet1
        state: absent
    - name: Create LAG with several specified options
      netbox_interface:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: test100
          name: port-channel1
          form_factor: Link Aggregation Group (LAG)
          mtu: 1600
          mgmt_only: false
          mode: Access
        state: present
    - name: Create interface and assign it to parent LAG
      netbox_interface:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: test100
          name: GigabitEthernet1
          enabled: false
          form_factor: 1000Base-t (1GE)
          lag:
            name: port-channel1
          mtu: 1600
          mgmt_only: false
          mode: Access
        state: present
    - name: Create interface as a trunk port
      netbox_interface:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: test100
          name: GigabitEthernet25
          enabled: false
          form_factor: 1000Base-t (1GE)
          untagged_vlan:
            name: Wireless
            site: Test Site
          tagged_vlans:
            - name: Data
              site: Test Site
            - name: VoIP
              site: Test Site
          mtu: 1600
          mgmt_only: true
          mode: Tagged
        state: present

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

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

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

Статус

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

Авторы

Михаил Йохан (@FragmentedPacket)

Подсказка

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

© 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_interface_module.html