Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.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

строка

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

org_name

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

строка

Имя организации.

output_format

строка

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

Варианты:

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

output_level

строка

Задает уровень подробности отладочных сообщений во время выполнения модуля.

Варианты:

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

rate_limit_retry_time

целое число

Количество секунд до повторного запроса при срабатывании ограничения частоты запросов.

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

reserved_ip_range

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

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

comment

строка

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

end

строка

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

start

строка

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

state

строка

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

Варианты:

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

subnet

строка

Подсеть сети в нотации CIDR.

timeout

целое число

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

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

use_https

логический

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

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

Варианты:

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

use_proxy

логический

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

Варианты:

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

validate_certs

логический

Следует ли проверять HTTP-сертификаты.

Варианты:

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

vlan_id

целое число

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

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

vpn_nat_subnet

строка

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

Примечания

Примечание

  • API Meraki возвращает ошибку, если VLAN не включены в сети. VLAN возвращаются корректно, если они включены в сети.
  • Некоторые параметры, вероятно, предназначены только для разработчиков Meraki.
  • По умолчанию API Meraki отключает поддержку VLAN в сетях, и включить ее через API невозможно. Поддержку VLAN необходимо включить вручную.
  • Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, предназначены только для разработчиков Meraki.
  • Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, задайте переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
  • В Ansible 2.13 модули Meraki перестанут поддерживать вывод в формате camelCase. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, но изменения не отправляются в 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-адрес или DNS-серверы Meraki, используемые 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.

Возвращается: 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/meraki_mx_vlan_module.html

Spec-Zone.ru

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