модуль cisco.meraki.meraki_mx_network_vlan_settings — управление настройками VLAN для сетей Meraki

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в плейбуке, укажите: cisco.meraki.meraki_mx_network_vlan_settings.

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_appliance_vlans_settings

Краткое описание

Изменяет состояние включения VLAN в сети Meraki.

Параметры

Параметр	Комментарии
auth_key строка / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная окружения `MERAKI_KEY`.
host строка	Имя узла панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
net_id строка	Идентификатор сети.
net_name псевдонимы: name, network строка	Название сети.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать для ключей ответа формат snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Задаёт объём отладочных данных при выполнении модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд до повторной попытки при срабатывании ограничения частоты запросов. По умолчанию: `165`
state строка	Создать оповещение или изменить его. Варианты: `"present"` `"query"`
timeout целое число	Время ожидания ответа на HTTP-запросы. По умолчанию: `30`
use_https логический	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy логический	Если `no`, прокси использоваться не будет, даже если он задан переменной окружения на целевых узлах. Варианты: `false` ← (по умолчанию) `true`
validate_certs логический	Проверять ли HTTP-сертификаты. Варианты: `false` `true` ← (по умолчанию)
vlans_enabled логический	Включены ли VLAN в сети. Варианты: `false` `true`

Примечания

Примечание

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

Примеры

- name: Update settings
  meraki_mx_network_vlan_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlans_enabled: true

Возвращаемые значения

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

Ключ	Описание
data сложный тип	Информация о созданном или изменённом объекте. Возвращается: при запросе информации
vlans_enabled логический	Включены ли VLAN для этой сети. Возвращается: при успешном выполнении

Статус

Этот модуль будет удалён в версии 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_network_vlan_settings_module.html