Модуль cisco.meraki.networks_appliance_single_lan – Модуль ресурсов для networks_appliance_singlelan

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.networks_appliance_single_lan.

Новое в cisco.meraki 2.16.0

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

Описание

Управление обновлением операций ресурса networks_appliance_singlelan.
Обновление конфигурации одного LAN.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
applianceIp строка	IP-адрес устройства single LAN.
ipv6 словарь	Конфигурация IPv6 на VLAN.
enabled логическое значение	Включить IPv6 на VLAN. Варианты: `false` `true`
prefixAssignments список / элементы=словарь	Назначения префиксов на VLAN.
autonomous логическое значение	Автоматически назначить префикс /64 из источника VLAN. Варианты: `false` `true`
origin словарь	Источник префикса.
interfaces список / элементы=строка	Интерфейсы, связанные с префиксом.
type строка	Тип источника.
staticApplianceIp6 строка	Ручная настройка IP-адреса устройства IPv6.
staticPrefix строка	Ручная настройка префикса /64 на VLAN.
mandatoryDhcp словарь	Принудительный DHCP будет требовать, чтобы клиенты, подключающиеся к этому LAN, использовали IP-адрес, назначенный DHCP-сервером. Клиенты, использующие статический IP-адрес, не смогут подключиться. Доступно только в версиях прошивки 17.0 и выше.
enabled логическое значение	Включить принудительный DHCP на LAN. Варианты: `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 (строка), предшествующая всем ресурсам конечной точки По умолчанию: `"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 (строка), путь для вывода лога; по умолчанию, рабочая директория скрипта, если не указано По умолчанию: `""`

END_OF_DOCUMENT_MARKER

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. Идентификатор сети.
subnet строка	Подсеть конфигурации single LAN.

Примечания

Примечание

Используемый метод SDK — appliance.Appliance.update_network_appliance_single_lan,
Используемые пути — put /networks/{networkId}/appliance/singleLan,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный диспетчер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki для appliance updateNetworkApplianceSingleLan: Полное руководство по API updateNetworkApplianceSingleLan.

Примеры

- name: Update all
  cisco.meraki.networks_appliance_single_lan:
    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
    applianceIp: string
    ipv6:
      enabled: true
      prefixAssignments:
      - autonomous: true
        origin:
          interfaces:
          - string
          type: string
        staticApplianceIp6: string
        staticPrefix: string
    mandatoryDhcp:
      enabled: true
    networkId: string
    subnet: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"applianceIp": "string", "ipv6": {"enabled": true, "prefixAssignments": [{"autonomous": true, "origin": {"interfaces": ["string"], "type": "string"}, "staticApplianceIp6": "string", "staticPrefix": "string"}]}, "mandatoryDhcp": {"enabled": true}, "subnet": "string"}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"applianceIp": "string", "ipv6": {"enabled": true, "prefixAssignments": [{"autonomous": true, "origin": {"interfaces": ["string"], "type": "string"}, "staticApplianceIp6": "string", "staticPrefix": "string"}]}, "mandatoryDhcp": {"enabled": true}, "subnet": "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_appliance_single_lan_module.html