Модуль cisco.meraki.meraki_network_settings — управление настройками сетей в облаке Meraki

Примечание

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

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

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

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

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

УСТАРЕЛО

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

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

Позволяет управлять настройками сетей в Meraki.

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер вернул внутреннюю ошибку. По умолчанию: `60`
local_status_page dictionary	Блок настроек локальной страницы состояния.
authentication dictionary	Настройки аутентификации локальной страницы состояния.
enabled boolean	Указывает, включена ли аутентификация локальной страницы состояния. Варианты: `false` `true`
password string	Задать пароль для локальной страницы состояния.
local_status_page_enabled boolean	- Включает локальные страницы состояния устройств (U[my.meraki.com](my.meraki.com), U[ap.meraki.com](ap.meraki.com), U[switch.meraki.com](switch.meraki.com), U[wired.meraki.com](wired.meraki.com)). - Можно указывать только отдельно или вместе с `remote_status_page_enabled`. Варианты: `false` `true`
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`
remote_status_page_enabled boolean	Включает доступ к странице состояния устройства (http://device LAN IP). Можно задать только если для `local_status_page_enabled:` установлено значение `yes`. Можно указывать только отдельно или вместе с `local_status_page_enabled`. Варианты: `false` `true`
secure_port dictionary	Настройки SecureConnect, применяемые к сети.
enabled boolean	Указывает, включён ли SecureConnect в сети. Варианты: `false` `true`
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` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об 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: Get network settings
  cisco.meraki.meraki_network_settings:
    auth_key: '{{ auth_key }}'
    state: query
    org_name: '{{ test_org_name }}'
    net_name: NetworkSettingsTestNet
  delegate_to: localhost
- name: Update network settings
  cisco.meraki.meraki_network_settings:
    auth_key: '{{ auth_key }}'
    state: present
    org_name: '{{ test_org_name }}'
    net_name: NetworkSettingsTestNet
    local_status_page_enabled: false
  delegate_to: localhost
- name: Enable password on local page
  cisco.meraki.meraki_network_settings:
    auth_key: '{{ auth_key }}'
    state: present
    org_name: '{{ test_org_name }}'
    net_name: NetworkSettingsTestNet
    local_status_page_enabled: true
    local_status_page:
      authentication:
        enabled: true
        password: abc123
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация о созданном или изменённом объекте. Возвращается: при запросе сведений
expire_data_older_than integer	Количество дней, недель или месяцев в формате времени Epoch, по истечении которых данные удаляются Возвращается: при успешном выполнении Пример: `1234`
fips complex	Хеш параметров FIPS, применённых к сети. Возвращается: при успешном выполнении
enabled boolean	Включает или отключает FIPS в сети. Возвращается: при успешном выполнении Пример: `true`
local_status_page complex	Хеш параметров аутентификации локальных страниц состояния, применённых к сети. Возвращается: при успешном выполнении
authentication complex	Хеш параметров аутентификации локальных страниц состояния, применённых к сети. Возвращается: при успешном выполнении Пример: `true`
enabled boolean	Включает или отключает аутентификацию на локальных страницах состояния. Возвращается: при успешном выполнении
username string	Имя пользователя для локальных страниц состояния. Возвращается: при успешном выполнении Пример: `"admin"`
local_status_page_enabled boolean	Определяет, должны ли быть включены my.meraki.com и другие порталы устройств. Возвращается: при успешном выполнении Пример: `true`
named_vlans complex	Хеш параметров именованных VLAN, применённых к сети. Возвращается: при успешном выполнении
enabled boolean	Включает или отключает именованные VLAN в сети. Возвращается: при успешном выполнении Пример: `true`
remote_status_page_enabled boolean	Включает доступ к странице состояния устройства. Возвращается: при успешном выполнении Пример: `true`
secure_port complex	Хеш параметров SecureConnect, применённых к сети. Возвращается: при успешном выполнении
enabled boolean	Включает или отключает SecureConnect в сети. Возвращается: при успешном выполнении Пример: `true`

Статус

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