netbox_prefix – Создаёт или удаляет префиксы из Netbox

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

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

Описание

Создаёт или удаляет префиксы из Netbox

Требования

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

pynetbox

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
data - / обязательно			Определяет конфигурацию префикса
	custom_fields словарь		Должен существовать в Netbox и иметь формат ключ/значение
	description строка		Описание префикса
	family целое число	Варианты: 4 6	Указывает семейство адресов, к которому принадлежит префикс
	is_pool булево значение	Варианты: нет да	Все IP-адреса в этом префиксе считаются используемыми
	parent строка		Требуется, если состояние равно `present` и first_available равно `yes`. Получит новый доступный префикс в этом родительском префиксе.
	prefix строка		Требуется, если состояние равно `present` и first_available равно False. Выделит или освободит этот префикс.
	prefix_length строка		Требуется ТОЛЬКО, если состояние равно `present` и first_available равно `yes`. Получит новый доступный префикс заданной длины в этом родительском префиксе.
	role строка		Роль префикса
	site строка		Сайт, с которым ассоциирован префикс
	status строка	Варианты: Активный Контейнер Устаревший Зарезервированный	Статус префикса
	tags список		Любые теги, которые могут потребоваться для ассоциации с префиксом
	tenant строка		Клиент, которому будет назначен префикс
	vlan словарь		VLAN, которому будет назначен префикс
	vrf строка		VRF, с которым ассоциирован префикс
first_available булево значение		Варианты: нет ← да	Если `yes` и состояние `present`, если задан родитель, он получит первый доступный префикс заданной длины внутри заданного родителя (и vrf, если задан). Не используется при состоянии `absent`.
netbox_token строка / обязательно			Токен, созданный в Netbox для авторизации доступа к API
netbox_url строка / обязательно			URL экземпляра Netbox, разрешаемый управляющим хостом Ansible
state -		Варианты: отсутствует наличие ←	Используйте `present` или `absent` для добавления или удаления.
validate_certs булево значение		Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты.

Примечания

Примечание

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

Примеры

- name: "Test Netbox prefix module"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create prefix within Netbox with only required information
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 10.156.0.0/19
        state: present

    - name: Delete prefix within netbox
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 10.156.0.0/19
        state: absent

    - name: Create prefix with several specified options
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          family: 4
          prefix: 10.156.32.0/19
          site: Test Site
          vrf: Test VRF
          tenant: Test Tenant
          vlan:
            name: Test VLAN
            site: Test Site
            tenant: Test Tenant
            vlan_group: Test Vlan Group
          status: Reserved
          role: Network of care
          description: Test description
          is_pool: true
          tags:
            - Schnozzberry
        state: present

    - name: Get a new /24 inside 10.156.0.0/19 within Netbox - Parent doesn't exist
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          parent: 10.156.0.0/19
          prefix_length: 24
        state: present
        first_available: yes

    - name: Create prefix within Netbox with only required information
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          prefix: 10.156.0.0/19
        state: present

    - name: Get a new /24 inside 10.156.0.0/19 within Netbox
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          parent: 10.156.0.0/19
          prefix_length: 24
        state: present
        first_available: yes

    - name: Get a new /24 inside 10.157.0.0/19 within Netbox with additional values
      netbox_prefix:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          parent: 10.157.0.0/19
          prefix_length: 24
          vrf: Test VRF
          site: Test Site
        state: present
        first_available: yes

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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_prefix_module.html