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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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 строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
host строка	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным окружениям Meraki, например, в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки. По умолчанию: `60`
local_status_page словарь	Секция конфигурации локальной страницы состояния.
authentication словарь	Настройки аутентификации локальной страницы состояния.
enabled булево	Устанавливает, включена ли аутентификация на локальной странице состояния. Варианты: `false` `true`
password строка	Установка пароля на локальной странице состояния.
local_status_page_enabled булево	Включает локальные страницы состояния устройств (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 строка	Идентификационный номер сети.
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`
remote_status_page_enabled булево	Включает доступ к странице состояния устройства (http://device LAN IP). Может быть установлено только если `local_status_page_enabled:` установлено в `yes`. Может быть указан только сам по себе или вместе с `local_status_page_enabled`. Варианты: `false` `true`
secure_port словарь	Конфигурация параметров SecureConnect, примененных к сети.
enabled булево	Устанавливает, включен ли SecureConnect в сети. Варианты: `false` `true`
state строка	Создать или изменить организацию. Варианты: `"present"` `"query"` ← (по умолчанию)
timeout целое число	Время ожидания для 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.
Модули Meraki Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Обновите свои playbook-файлы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о изменениях, если существуют различия в конфигурациях, но не отправляет изменения в 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 сложный	Информация об объекте, созданном или измененном. Возвращаемое значение: info
expire_data_older_than целое число	Количество дней, недель или месяцев в формате эпохи, чтобы истекло время действия данных до Возвращаемое значение: успех Пример: `1234`
fips сложный	Хэш параметров FIPS, примененных к сети. Возвращаемое значение: успех
enabled булево	Включает/выключает FIPS в сети. Возвращаемое значение: успех Пример: `true`
local_status_page сложный	Хэш параметров аутентификации страницы локального статуса, примененных к сети. Возвращаемое значение: успех
authentication сложный	Хэш параметров аутентификации страниц локального статуса, примененных к сети. Возвращаемое значение: успех Пример: `true`
enabled булево	Включает/выключает аутентификацию на страницах локального статуса. Возвращаемое значение: успех
username строка	Имя пользователя, используемое для страниц локального статуса. Возвращаемое значение: успех Пример: `"admin"`
local_status_page_enabled булево	Указывает, должны ли быть включены my.meraki.com и другие порталы устройств. Возвращаемое значение: успех Пример: `true`
named_vlans сложный	Хэш параметров Именных VLAN, примененных к сети. Возвращаемое значение: успех
enabled булево	Включает/выключает Именные VLAN в сети. Возвращаемое значение: успех Пример: `true`
remote_status_page_enabled булево	Включает доступ к странице статуса устройства. Возвращаемое значение: успех Пример: `true`
secure_port сложный	Хэш параметров SecureConnect, примененных к сети. Возвращаемое значение: успех
enabled булево	Включает/выключает SecureConnect в сети. Возвращаемое значение: успех Пример: `true`

Статус

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