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

Примечание

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

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

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

Для использования в playbook, укажите: cisco.meraki.meraki_mx_network_vlan_settings.

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

УСТАРЕВШИЙ

Удалено в:: версия 3.0.0
Почему:: Обновленные модули выпущены с расширенной функциональностью
Альтернатива:: cisco.meraki.networks_appliance_vlans_settings

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

Редактирует статус включения VLAN в сети Meraki.

Параметры

Параметр	Комментарии
auth_key string / required	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная окружения `MERAKI_KEY` не установлена.
host string	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд для повтора попытки, если сервер возвращает ошибку внутреннего сервера. По умолчанию: `60`
net_id string	Идентификационный номер сети.
net_name псевдонимы: name, network string	Название сети.
org_id string	Идентификатор организации.
org_name псевдонимы: 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`
state string	Создать или изменить оповещение. Варианты: `"present"` `"query"`
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` ← (по умолчанию)
vlans_enabled boolean	Включены ли VLAN в сети. Варианты: `false` `true`

Примечания

Примечание

Дополнительную информацию об 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. Пожалуйста, обновите свои playbook-файлы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесённых изменениях, если в конфигурациях есть различия, но не отправляет изменения в 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mx_network_vlan_settings_module.html