netbox – Инвентаризация NetBox

Описание
Параметры
Примеры
Статус

Описание

Получение инвентарных узлов из NetBox

Параметры

Параметр	Варианты/Значения по умолчанию	Конфигурация	Комментарии
api_endpoint - / обязательно		env:NETBOX_API	Конечная точка API NetBox
compose словарь	По умолчанию: {}		Список пользовательских переменных ansible для хостов, создаваемых из объекта устройства, полученного из NetBox
config_context логическое значение	По умолчанию: "нет"		Если True, добавляет config-context в переменные хоста. Config-context позволяет сопоставлять произвольные данные с устройствами и виртуальными машинами, сгруппированными по региону, сайту, роли, платформе и/или арендатору. Для получения более подробной информации см. официальную документацию Netbox.
group_by список	Варианты: сайты арендаторы стеллажи метки роли устройств типы устройств производители платформы По умолчанию: []		Ключи, используемые для создания групп.
groups словарь	По умолчанию: {}		Добавление хостов в группу на основе условных выражений Jinja2.
keyed_groups список	По умолчанию: []		Добавление хостов в группу на основе значений переменной.
plugin - / обязательно	Варианты: netbox		Токен, гарантирующий, что это файл источника для плагина 'netbox'.
query_filters список	По умолчанию: []		Список параметров, передаваемых в строку запроса (несколько значений могут быть разделены запятыми).
strict логическое значение	Варианты: нет ← да		Если `yes` сделать некорректные записи ошибкой, иначе пропустить и продолжить. Поскольку в выражениях можно использовать факты, они могут не всегда быть доступны, и мы по умолчанию игнорируем эти ошибки.
timeout целое число	По умолчанию: 60		Таймаут запросов Netbox в секундах
token - / обязательно		env:NETBOX_TOKEN env:NETBOX_API_KEY	Токен NetBox.
validate_certs логическое значение	По умолчанию: "да"		Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false` когда сертификаты недостоверны.

Примеры

# netbox_inventory.yml file in YAML format
# Example command line: ansible-inventory -v --list -i netbox_inventory.yml

plugin: netbox
api_endpoint: http://localhost:8000
validate_certs: True
config_context: False
group_by:
  - device_roles
query_filters:
  - role: network-edge-router

# Query filters are passed directly as an argument to the fetching queries.
# You can repeat tags in the query string.

query_filters:
  - role: server
  - tag: web
  - tag: production

# See the NetBox documentation at https://netbox.readthedocs.io/en/latest/api/overview/
# the query_filters work as a logical **OR**
#
# Prefix any custom fields with cf_ and pass the field value with the regular NetBox query string

query_filters:
  - cf_foo: bar

# NetBox inventory plugin also supports Constructable semantics
# You can fill your hosts vars using the compose option:

plugin: netbox
compose:
  foo: last_updated
  bar: display_name
  nested_variable: rack.display_name

Статус

Гарантия обратной совместимости для этого инвентаря не предоставляется. [превью]
Данный инвентарь поддерживается Сообществом Ansible. [сообщество]

Авторы

Remy Leone (@sieben)
Anthony Ruhier (@Anthony25)
Nikhil Singh Baliyan (@nikkytub)

Подсказка

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

Подсказка

Элементы конфигурации для каждого типа записи имеют приоритет от низкого к высокому. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

© 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/plugins/inventory/netbox.html