Spec-Zone.ru › Ansible 2.9

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
строка
    Варианты:
  • absent
  • present ←
Используйте present или absent для добавления или удаления.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если 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. [community]

Авторы

  • Михаил Юхман (@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.9/modules/netbox_site_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API