модуль cisco.meraki.networks_switch_alternate_management_interface — модуль ресурсов для networks _switch _alternatemanagementinterface

Примечание

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

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

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

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

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

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

Обзор

Управление операцией обновления ресурса networks _switch _alternatemanagementinterface.
Обновление альтернативного интерфейса управления коммутатором для сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
enabled логическое значение	Логическое значение для включения или отключения конфигурации AMI. Если параметр включен, необходимо указать VLAN и протоколы. Варианты: `false` `true`
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 (строка), базовый URL для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; его также можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
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 логическое значение	meraki_output_log (логическое значение), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), прокси-сервер и порт для HTTPS, если они необходимы По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять попытку при получении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при другой ошибке 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логическое значение	meraki_suppress_logging (логическое значение), отключить ведение журнала? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое значение	meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое значение	meraki_wait_on_rate_limit (логическое значение), повторять попытку при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkId строка	Параметр пути NetworkId. Идентификатор сети.
protocols список / элементы=строка	Одно или несколько следующих значений: ‘radius’, ‘snmp’ или ‘syslog’.
switches список / элементы=словарь	Массив серийных номеров коммутаторов и назначенных IP-адресов. Если параметр указан, его значение не может быть пустым. Обратите внимание: параметр switches не применим к сетям-шаблонам; другими словами, не включайте ‘switches’ в тело запроса при обновлении сетей-шаблонов. Кроме того, пустой массив ‘switches’ удалит все предыдущие назначения.
alternateManagementIp строка	Альтернативный IP-адрес управления коммутатором. Чтобы удалить ранее заданный IP-адрес, укажите пустую строку.
gateway строка	Шлюз коммутатора должен быть указан в формате IP-адреса. Указывается только и обязательно для коммутаторов Polaris.
serial строка	Серийный номер коммутатора.
subnetMask строка	Маска подсети коммутатора должна быть указана в формате IP-адреса. Указывается только и обязательно для коммутаторов Polaris.
vlanId целое число	Альтернативный VLAN управления; значение должно быть в диапазоне от 1 до 4094.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_switch_alternate_management_interface:
    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
    enabled: true
    networkId: string
    protocols:
      - radius
      - snmp
      - syslog
    switches:
      - alternateManagementIp: 1.2.3.4
        gateway: 1.2.3.5
        serial: Q234-ABCD-5678
        subnetMask: 255.255.255.0
    vlanId: 100

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: `{"enabled": true, "protocols": ["string"], "switches": [{"alternateManagementIp": "string", "gateway": "string", "serial": "string", "subnetMask": "string"}], "vlanId": 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_alternate_management_interface_module.html