Модуль cisco.meraki.networks_switch_dhcp_server_policy — Модуль ресурсов для networks_switch_dhcpserverpolicy

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: cisco.meraki.networks_switch_dhcp_server_policy.

Добавлен в cisco.meraki 2.16.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Управление обновлением операции ресурса networks_switch_dhcpserverpolicy.
Обновление настроек DHCP-сервера. Заблокированные/разрешённые серверы применяются только при использовании политики по умолчанию allow/block соответственно.

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

meraki >= 2.4.9
python >= 3.5

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
alerts словарь	Настройки оповещений для DHCP-серверов.
email словарь	Настройки оповещений по электронной почте для DHCP-серверов.
enabled логическое значение	При включении отправляет электронное письмо, если обнаружен новый DHCP-сервер. Значение по умолчанию — false. Варианты: `false` `true`
allowedServers список / элементы=строка	Список MAC-адресов DHCP-серверов, разрешенных в сети, когда defaultPolicy установлен в block. Пустой массив очистит записи.
arpInspection словарь	Настройки динамической проверки ARP.
enabled логическое значение	Включить или выключить динамическую проверку ARP в сети. Значение по умолчанию — false. Варианты: `false` `true`
blockedServers список / элементы=строка	Список MAC-адресов DHCP-серверов, которые следует заблокировать в сети, когда defaultPolicy установлен на allow. Пустой массив очистит записи.
defaultPolicy строка	‘allow’ или ‘block’ новых DHCP-серверов. Значение по умолчанию — ‘allow’.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания при повторных попытках в случае ошибки пакетной обработки действий По умолчанию: `60`
meraki_api_key строка / обязательно	meraki_api_key (строка), ключ API, сгенерированный в панели управления; также может быть задан как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), предшествующая всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная окружения BE_GEO_ID По умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследует собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла лога, дополненное датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода логов; по умолчанию — рабочая директория скрипта, если не указано По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), количество попыток повтора при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания при повторе попыток для ошибки Nginx 429 По умолчанию: `60`

meraki_output_log boolean	meraki_output_log (boolean), создать файл логов вывода? Выбор: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить логи в консоль? Выбор: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Выбор: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания при повторной попытке других ошибок 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), смоделировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Выбор: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить всю логирование? Вам придется справиться самостоятельно! Выбор: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* вернут итератор с каждым объектом вместо полного списка со всеми элементами Выбор: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Выбор: `false` `true` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

Используемый метод SDK - switch.Switch.update_network_switch_dhcp_server_policy,
Используемые пути - put /networks/{networkId}/switch/dhcpServerPolicy,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по switch updateNetworkSwitchDhcpServerPolicy: Полное описание API updateNetworkSwitchDhcpServerPolicy.

Примеры

- name: Update all
  cisco.meraki.networks_switch_dhcp_server_policy:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    alerts:
      email:
        enabled: true
    allowedServers:
    - 00:50:56:00:00:01
    - 00:50:56:00:00:02
    arpInspection:
      enabled: true
    blockedServers:
    - 00:50:56:00:00:03
    - 00:50:56:00:00:04
    defaultPolicy: block
    networkId: string

Значения возврата

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"alerts": {"email": {"enabled": true}}, "allowedServers": ["string"], "arpInspection": {"enabled": true, "unsupportedModels": ["string"]}, "blockedServers": ["string"], "defaultPolicy": "string"}`

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 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/networks_switch_dhcp_server_policy_module.html