Spec-Zone.ru › Ansible

Модуль cisco.meraki.meraki_mx_vlan — Управление VLAN в облаке Meraki

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.2).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.meraki.

Для использования в плейбуке укажите: cisco.meraki.meraki_mx_vlan.

  • УСТЕРЕКШЕЕ
  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

УСТЕРЕКШЕЕ

Удалино в:

версия 3.0.0

Почему:

Обновленные модули с расширенными возможностями

Альтернатива:

cisco.meraki.networks_appliance_vlans

Описание

  • Создание, редактирование, запрос или удаление VLAN в среде Meraki.

Параметры

Параметр

Комментарии

appliance_ip

строка

IP-адрес устройства.

Адрес должен находиться в подсети, указанной в параметре subnet.

auth_key

строка / обязательно

Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не задана.

dhcp_boot_filename

строка

Имя файла для загрузки при DHCP-загрузке

dhcp_boot_next_server

строка

Параметр DHCP-загрузки для направления клиентов к серверу, с которого загружается файл загрузки.

dhcp_boot_options_enabled

логическое

Включить параметры DHCP-загрузки

Варианты:

  • false
  • true

dhcp_handling

строка

Обработка пакетов DHCP в сети.

Варианты:

  • "Run a DHCP server"
  • "Relay DHCP to another server"
  • "Do not respond to DHCP requests"
  • "none"
  • "server"
  • "relay"

dhcp_lease_time

строка

Настройка таймера аренды DHCP

Варианты:

  • "30 minutes"
  • "1 hour"
  • "4 hours"
  • "12 hours"
  • "1 day"
  • "1 week"

dhcp_options

список / элементы=словарь

Список значений параметров DHCP

code

целое число

Номер параметра DHCP.

type

строка

Тип значения параметра DHCP.

Варианты:

  • "text"
  • "ip"
  • "hex"
  • "integer"

value

строка

Значение параметра DHCP.

dhcp_relay_server_ips

список / элементы=строка

IP-адреса для перенаправления пакетов DHCP.

dns_nameservers

строка

Список IP-адресов DNS, разделенных точкой с запятой.

Укажите один из следующих вариантов для предварительно запрограммированных записей DNS: opendns, google_dns, upstream_dns

fixed_ip_assignments

список / элементы=словарь

Статические назначения IP-адресов, которые будут распределяться DHCP по MAC-адресу.

ip

строка

IP-адрес для привязки статического IP-адреса.

mac

строка

MAC-адрес для привязки статического IP-адреса.

name

строка

Дескриптивное имя привязки IP-адреса.

host

строка

Имя хоста для панели управления Meraki.

Может быть использовано для доступа к региональным средам Meraki, таким как Китай.

По умолчанию: "api.meraki.com"

internal_error_retry_time

целое число

Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера.

По умолчанию: 60

name

псевдонимы: vlan_name

строка

Имя VLAN.

net_id

строка

Идентификатор сети, в которой находится или должна находиться VLAN.

net_name

псевдонимы: network

строка

Имя сети, в которой находится или должна находиться VLAN.

org_id

строка

Идентификатор организации.
END_OF_DOCUMENT_MARKER

org_name

aliases: organization

string

Название организации.

output_format

string

Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).

Варианты:

  • "snakecase" ← (по умолчанию)
  • "camelcase"

output_level

string

Устанавливает количество отладочной информации во время выполнения модуля.

Варианты:

  • "debug"
  • "normal" ← (по умолчанию)

rate_limit_retry_time

integer

Количество секунд, которое модуль будет ждать, если ограничение скорости будет превышено.

По умолчанию: 165

reserved_ip_range

list / elements=dictionary

Диапазоны IP-адресов, которые должны быть зарезервированы и не распределяются через DHCP.

comment

string

Описание резервирования IP-адресов

end

string

Последний IP-адрес зарезервированного диапазона IP-адресов, включительно.

start

string

Первый IP-адрес зарезервированного диапазона IP-адресов, включительно.

state

string

Определяет, должен ли объект быть запрошен, создан/изменен или удален.

Варианты:

  • "absent"
  • "present"
  • "query" ← (по умолчанию)

subnet

string

Сеть в CIDR-нотации.

timeout

integer

Время ожидания для HTTP-запросов.

По умолчанию: 30

use_https

boolean

Если no, то будет использоваться HTTP. В противном случае используется HTTPS.

Полезно только для внутренних разработчиков Meraki.

Варианты:

  • false
  • true ← (по умолчанию)

use_proxy

boolean

Если no, то прокси не используется, даже если он определён в переменной окружения на целевых хостах.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

boolean

Требовать валидации HTTP-сертификатов.

Варианты:

  • false
  • true ← (по умолчанию)

vlan_id

integer

Идентификатор VLAN.

Идентификатор должен быть в диапазоне от 1 до 4096.

vpn_nat_subnet

string

Перевод подсети VPN, если VPN и перевод подсети VPN включены в VLAN.

Примечания

Примечание

  • API Meraki вернёт ошибку, если VLAN не включены в сети. VLAN возвращаются корректно, если VLAN включены в сети.
  • Некоторые параметры, вероятно, используются только разработчиками Meraki.
  • API Meraki по умолчанию предполагает, что поддержка VLAN отключена в сетях, и нет способа включить поддержку VLAN через API. Поддержка VLAN должна быть включена вручную.
  • Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, используются только разработчиками Meraki.
  • Начиная с Ansible 2.9, модули Meraki выдают ключи в формате snake case. Для использования camel case, установите переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
  • Модули Meraki Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесённых изменениях, если существуют различия в конфигурациях, но не отправляет изменения в API для проверки изменений.

Примеры

- name: Query all VLANs in a network.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query information about a single VLAN by ID.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    vlan_id: 2
    state: query
  delegate_to: localhost

- name: Create a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlan_id: 2
    name: TestVLAN
    subnet: 192.0.1.0/24
    appliance_ip: 192.0.1.1
  delegate_to: localhost

- name: Update a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlan_id: 2
    name: TestVLAN
    subnet: 192.0.1.0/24
    appliance_ip: 192.168.250.2
    fixed_ip_assignments:
      - mac: "13:37:de:ad:be:ef"
        ip: 192.168.250.10
        name: fixed_ip
    reserved_ip_range:
      - start: 192.168.250.10
        end: 192.168.250.20
        comment: reserved_range
    dns_nameservers: opendns
  delegate_to: localhost

- name: Enable DHCP on VLAN with options
  meraki_vlan:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    vlan_id: 2
    name: TestVLAN
    subnet: 192.168.250.0/24
    appliance_ip: 192.168.250.2
    dhcp_handling: server
    dhcp_lease_time: 1 hour
    dhcp_boot_options_enabled: false
    dhcp_options:
      - code: 5
        type: ip
        value: 192.0.1.1
  delegate_to: localhost

- name: Delete a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: absent
    vlan_id: 2
  delegate_to: localhost

Значения возврата

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

Ключ

Описание

response

complex

Информация об организации, которая была создана или изменена

Возвращено: success

appliance_ip

string

IP-адрес устройства Meraki в VLAN

Возвращено: success

Пример: "192.0.1.1"

dhcp_boot_filename

string

Имя файла загрузки.

Возвращено: success

Пример: "boot.txt"

dhcp_boot_next_server

string

Параметр загрузки DHCP для направления клиентов загрузки на сервер для загрузки файла загрузки.

Возвращено: success

Пример: "192.0.1.2"

dhcp_boot_options_enabled

boolean

Включены ли параметры загрузки DHCP.

Возвращено: success

Пример: false

dhcp_handling

string

Статус DHCP-сервера в VLAN.

Возвращено: success

Пример: "Run a DHCP server"

dhcp_lease_time

string

Время аренды DHCP, когда сервер активен.

Возвращено: success

Пример: "1 day"

dhcp_options

complex

Параметры DHCP.

Возвращено: success

code

integer

Код для параметра DHCP.

Целое число от 2 до 254.

Возвращено: success

Пример: 43

type

string

Тип для параметра DHCP.

Варианты: text, ip, hex, integer.

Возвращено: success

Пример: "text"

value

string

Значение для параметра DHCP.

Возвращено: success

Пример: "192.0.1.2"

dnsnamservers

string

IP-адрес или определенные Meraki DNS-серверы, которые VLAN должен использовать по умолчанию

Возвращено: success

Пример: "upstream_dns"

fixed_ip_assignments

complex

Список MAC-адресов, которым назначены IP-адреса.

Возвращено: success

macaddress

complex

MAC-адрес, которому назначен IP-адрес. Ключевое значение - это фактический MAC-адрес.

Возвращено: success

ip

string

IP-адрес, назначенный MAC-адресу.

Возвращено: success

Пример: "192.0.1.4"

name

string

Описательное имя для привязки.

Возвращено: success

Пример: "fixed_ip"

id

integer

Номер VLAN ID.

Возвращено: success

Пример: 2

name

string

Описательное имя VLAN.

Возвращено: success

Пример: "TestVLAN"

networkId

string

Идентификатор сети Meraki, к которой относится VLAN.

Возвращаемое значение: success

Пример: "N_12345"

reserved_ip_ranges

complex

Список диапазонов IP-адресов, зарезервированных для статической привязки.

Возвращаемое значение: success

comment

string

Описание резервирования IP-адресов.

Возвращаемое значение: success

Пример: "reserved_range"

end

string

Последний IP-адрес в диапазоне резервирования.

Возвращаемое значение: success

Пример: "192.0.1.10"

start

string

Первый IP-адрес в диапазоне резервирования.

Возвращаемое значение: success

Пример: "192.0.1.5"

subnet

string

IP-подсеть VLAN в CIDR-нотации.

Возвращаемое значение: success

Пример: "192.0.1.0/24"

Статус

  • Этот модуль будет удалён в версии 3.0.0. [устаревший]
  • Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

  • Kevin Breit (@kbreit)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mx_vlan_module.html

Spec-Zone.ru

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