netbox_site – Создаёт или удаляет сайты в Netbox
Новая версия с 2.8.
Обзор
- Создаёт или удаляет сайты в Netbox
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- pynetbox
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| data - / обязательно | Определяет конфигурацию сайта | ||
| asn целое число | ASN, связанный с сайтом | ||
| comments строка | Комментарии к сайту. Можно использовать разметку Markdown | ||
| contact_email строка | Электронная почта контакта сайта | ||
| contact_name строка | Имя контакта сайта | ||
| contact_phone строка | Номер телефона контакта сайта | ||
| custom_fields словарь | должен существовать в Netbox | ||
| description строка | Описание префикса | ||
| facility строка | Провайдер или место расположения дата-центра, например Equinix NY7 | ||
| latitude целое число | Широта в десятичном формате | ||
| longitude целое число | Долгота в десятичном формате | ||
| name строка / обязательно | Название сайта, который будет создан | ||
| physical_address строка | Физический адрес сайта | ||
| region строка | Регион, с которым должен быть связан сайт | ||
| shipping_address строка | Адрес доставки сайта | ||
| status строка |
| Статус сайта | |
| tags список | Любые метки, которые могут потребоваться для связи с префиксом | ||
| tenant строка | Клиент, которому будет назначен сайт | ||
| time_zone строка | Часовой пояс, связанный с сайтом, например America/Denver | ||
| netbox_token строка / обязательно | Токен, созданный в Netbox для авторизации доступа к API | ||
| netbox_url строка / обязательно | URL-адрес экземпляра Netbox, разрешимый хостом управления Ansible | ||
| state строка |
| Используйте present или absent для добавления или удаления. | |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющимися сертификатами. | |
Примечания
Примечание
- Метки должны быть определены как список YAML
- Это должно выполняться с подключением
localи хостамиlocalhost
Примеры
- name: "Test Netbox site module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create site within Netbox with only required information
netbox_site:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test - Colorado
state: present
- name: Delete site within netbox
netbox_site:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test - Colorado
state: absent
- name: Create site with all parameters
netbox_site:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test - California
status: Planned
region: Test Region
tenant: Test Tenant
facility: EquinoxCA7
asn: 65001
time_zone: America/Los Angeles
description: This is a test description
physical_address: Hollywood, CA, 90210
shipping_address: Hollywood, CA, 90210
latitude: 10.100000
longitude: 12.200000
contact_name: Jenny
contact_phone: 867-5309
contact_email: jenny@changednumber.com
comments: ### Placeholder
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| msg строка | всегда | Сообщение, указывающее на ошибку или информацию о том, что было достигнуто |
| site словарь | при создании | Сериализованный объект, созданный или уже существующий в Netbox |
Статус
- Не гарантируется обратная совместимость этого модуля. [предварительный просмотр]
- Этот модуль поддерживается сообществом 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_site_module.html