Модуль cisco.meraki.networks_switch_settings — модуль ресурсов для networks _switch _settings

Примечание

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

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

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

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

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

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

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

Управление операцией обновления ресурса networks _switch _settings.
Обновление параметров сети коммутаторов.

Примечание

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

Требования

Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
macBlocklist dictionary	Список блокировки MAC-адресов.
enabled boolean	Включить список блокировки MAC-адресов. Варианты: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), базовый адрес перед всеми конечными точками ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (логическое значение), использовать собственный экземпляр средства ведения журнала Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), префикс имени файла журнала, к которому добавляются дата и временная метка По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь для вывода журнала; если он не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), максимальное количество повторов при получении ошибки 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (логическое значение), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка), прокси-сервер и порт для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение), повторять запрос при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить ведение журналов? В этом случае вы действуете на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты 429? Варианты: `false` `true` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.
powerExceptions list / элементы=dictionary	Исключения для отдельных коммутаторов в отношении параметра “useCombinedPower”.
powerType string	Исключение для отдельного коммутатора (combined, redundant, useNetworkSetting).
serial string	Серийный номер коммутатора.
uplinkClientSampling dictionary	Выборка данных клиентов восходящего канала.
enabled boolean	Включить выборку данных клиентов восходящего канала. Варианты: `false` `true`
uplinkSelection dictionary	Параметры выбора восходящего канала на коммутаторах IOS-XE.
candidates string	Значение ‘all’ позволяет устройствам использовать любой потенциальный интерфейс. Значение ‘designated’ ограничивает выбор указанными кандидатами (настроенными на странице Routing & DHCP).
failback dictionary	Если предпочтительный восходящий канал перестанет работать, система будет периодически пытаться восстановить его использование.
enabled boolean	Включить возврат на предпочтительный восходящий канал. Варианты: `false` `true`
useCombinedPower boolean	Использовать комбинированное питание по умолчанию для резервных источников питания на поддерживаемых устройствах. Варианты: `false` `true`
vlan integer	Управляющая VLAN.

Примечания

Примечание

Используемые методы SDK: switch.Switch.update_network_switch_settings,
Используемые пути: put /networks/{networkId}/switch/settings,
Не поддерживает check_mode
Плагин запускается на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установки соединения

См. также

Документация Cisco Meraki по switch updateNetworkSwitchSettings: Полный справочник по API updateNetworkSwitchSettings.

Примеры

- name: Update all
  cisco.meraki.networks_switch_settings:
    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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    macBlocklist:
      enabled: true
    networkId: string
    powerExceptions:
      - powerType: string
        serial: string
    uplinkClientSampling:
      enabled: true
    uplinkSelection:
      candidates: string
      failback:
        enabled: true
    useCombinedPower: true
    vlan: 0

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"macBlocklist": {"enabled": true}, "powerExceptions": [{"powerType": "string", "serial": "string"}], "uplinkClientSampling": {"enabled": true}, "uplinkSelection": {"candidates": "string", "failback": {"enabled": true}}, "useCombinedPower": true, "vlan": 0}`

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращённым Python SDK Cisco Meraki

Возвращается: всегда

Пример: {"macBlocklist": {"enabled": true}, "powerExceptions": [{"powerType": "string", "serial": "string"}], "uplinkClientSampling": {"enabled": true}, "uplinkSelection": {"candidates": "string", "failback": {"enabled": true}}, "useCombinedPower": true, "vlan": 0}

Авторы

Francisco Munoz (@fmunoz)

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

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