netbox_device – Создание, обновление или удаление устройств в Netbox
Новая версия 2.8.
Описание
- Создаёт, обновляет или удаляет устройства из Netbox
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- pynetbox
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| data - / обязательно | Определяет конфигурацию устройства | ||
| asset_tag - | Тег актива, связанный с устройством | ||
| cluster - | Кластер, к которому будет назначено устройство | ||
| comments - | Комментарии, которые могут содержать дополнительную информацию о устройстве | ||
| custom_fields - | должен существовать в Netbox | ||
| device_role - | Требуется, если state=present и устройство ещё не существует | ||
| device_type - | Требуется, если state=present и устройство ещё не существует | ||
| face - | Требуется, если определён rack | ||
| name - / обязательно | Название устройства | ||
| platform - | Платформа устройства | ||
| position - | Позиция устройства в стойке, определённой выше | ||
| rack - | Название стойки, к которой нужно назначить устройство | ||
| serial - | Серийный номер устройства | ||
| site - | Требуется, если state=present и устройство ещё не существует | ||
| status - |
| Статус устройства | |
| tags - | Любые метки, которые необходимо присвоить устройству | ||
| tenant - | Абонент, которому будет назначено устройство | ||
| netbox_token - / обязательно | Токен, созданный в Netbox для авторизации доступа к API | ||
| netbox_url - / обязательно | URL экземпляра Netbox, доступного хосту управления Ansible | ||
| state - |
| Используйте present или absent для добавления или удаления. | |
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем с самозаверенными сертификатами. | |
Примечания
Примечание
- Метки должны быть определены в виде списка YAML
- Это следует запускать с подключением
localи хостамиlocalhost
Примеры
- name: "Test Netbox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create device within Netbox with only required information
netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Device
device_type: C9410R
device_role: Core Switch
site: Main
state: present
- name: Delete device within netbox
netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Device
state: absent
- name: Create device with tags
netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Another Test Device
device_type: C9410R
device_role: Core Switch
site: Main
tags:
- Schnozzberry
state: present
- name: Update the rack and position of an existing device
netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Device
rack: Test Rack
position: 10
face: Front
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| device словарь | успех (при state=present) | Сериализованный объект, как созданный или уже существующий в Netbox |
| msg строка | всегда | Сообщение, указывающее на ошибку или информацию о том, что было достигнуто |
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Михаил Юхман (@FragmentedPacket)
- Давид Гомес (@amb1s1)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_device_module.html