Spec-Zone.ru › Ansible

Модуль cisco.meraki.devices_management_interface — Модуль ресурсов для управления интерфейсом устройств

Примечание

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

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

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

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

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

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

Обзор

  • Управление операциями создания и обновления ресурсов устройств _managementinterface.
  • Перезагрузка устройства.
  • Обновление настроек интерфейса управления устройства.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий

Default: 60

meraki_api_key

string / required

meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), предшествует всем ресурсам конечной точки

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может быть также установлен как переменная окружения BE_GEO_ID

Default: ""

meraki_caller

string

meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала, к которому добавляется дата и метка времени

Default: "meraki_api_"

meraki_log_path

string

log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), повторить до такого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), выводить выходные данные журнала на консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

Default: 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 ← (по умолчанию)

serial

string

Параметр пути к серийному номеру.

wan1

dictionary

Настройки WAN 1.

staticDns

list / elements=string

Максимально два IP-адреса DNS.

staticGatewayIp

string

IP-адрес шлюза на WAN.

staticIp

string

IP-адрес, который должно использовать устройство на WAN.

staticSubnetMask

string

Маска подсети для WAN.

usingStaticIp

boolean

Настроить интерфейс на использование статических настроек IP или DHCP.

Варианты:

  • false
  • true

vlan

integer

VLAN, с которым должна быть помечена управляющая трафика. Применяется независимо от того, является ли usingStaticIp истинным или ложным.

wanEnabled

string

Включить или отключить интерфейс (только для устройств MX). Допустимые значения: «enabled», «disabled» и «not configured».

wan2

dictionary

Настройки WAN 2 (только для устройств MX).

staticDns

list / elements=string

Максимально два IP-адреса DNS.

staticGatewayIp

string

IP-адрес шлюза на WAN.

staticIp

string

IP-адрес, который должно использовать устройство на WAN.

staticSubnetMask

string

Маска подсети для WAN.

usingStaticIp

boolean

Настроить интерфейс на использование статических настроек IP или DHCP.

Варианты:

  • false
  • true

vlan

integer

VLAN, с которым должна быть помечена управляющая трафика. Применяется независимо от того, является ли usingStaticIp истинным или ложным.

wanEnabled

string

Включить или отключить интерфейс (только для устройств MX). Допустимые значения: «enabled», «disabled» и «not configured».

Примечания

Примечание

  • Используемые методы SDK: devices.Devices.reboot_device, devices.Devices.update_device_management_interface,
  • Используемые пути: post /devices/{serial}/reboot, put /devices/{serial}/managementInterface,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki по устройствам rebootDevice

Полное описание API rebootDevice.

Документация Cisco Meraki по устройствам updateDeviceManagementInterface

Полное описание API updateDeviceManagementInterface.

Примеры

- name: Update all
  cisco.meraki.devices_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    serial: string
    wan1:
      staticDns:
      - 1.2.3.2
      - 1.2.3.3
      staticGatewayIp: 1.2.3.1
      staticIp: 1.2.3.4
      staticSubnetMask: 255.255.255.0
      usingStaticIp: true
      vlan: 7
      wanEnabled: not configured
    wan2:
      staticDns:
      - 1.2.3.2
      - 1.2.3.3
      staticGatewayIp: 1.2.3.1
      staticIp: 1.2.3.4
      staticSubnetMask: 255.255.255.0
      usingStaticIp: false
      vlan: 2
      wanEnabled: enabled

- name: Create
  cisco.meraki.devices_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    serial: string

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"ddnsHostnames": {"activeDdnsHostname": "string", "ddnsHostnameWan1": "string", "ddnsHostnameWan2": "string"}, "wan1": {"staticDns": ["string"], "staticGatewayIp": "string", "staticIp": "string", "staticSubnetMask": "string", "usingStaticIp": true, "vlan": 0, "wanEnabled": "string"}, "wan2": {"staticDns": ["string"], "staticGatewayIp": "string", "staticIp": "string", "staticSubnetMask": "string", "usingStaticIp": true, "vlan": 0, "wanEnabled": "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/devices_management_interface_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API