Spec-Zone.ru › Ansible

Модуль cisco.meraki.devices_switch_routing_interfaces — Модуль ресурсов для устройств _switch _routing _interfaces

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.devices_switch_routing_interfaces.

Новая функция в cisco.meraki 2.16.0

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

Обзор

  • Управление операциями создания, обновления и удаления ресурсов устройств _switch _routing _interfaces.
  • Создание интерфейса уровня 3 для коммутатора.
  • Удаление интерфейса уровня 3 из коммутатора.
  • Обновление интерфейса уровня 3 для коммутатора.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

defaultGateway

строка

Следующий хост для любого трафика, который не направляется в непосредственно подключенную подсеть или по статическому маршруту. Этот IP-адрес должен существовать в подсети с маршрутизируемым интерфейсом. Требуется, если это первый IPv4-интерфейс.

interfaceId

строка

Параметр пути InterfaceId. Идентификатор интерфейса.

interfaceIp

строка

IP-адрес, который этот коммутатор будет использовать для маршрутизации уровня 3 в этой VLAN или подсети. Он не может быть таким же, как IP-адрес управления коммутатора.

ipv6

словарь

Настройки IPv6 интерфейса.

address

строка

IPv6-адрес интерфейса. Требуется, если assignmentMode равен ‘static’. Не должен включаться, если assignmentMode равен ‘eui-64’.

assignmentMode

строка

Режим назначения IPv6 для интерфейса. Может быть либо ‘eui-64’, либо ‘static’.

gateway

строка

IPv6 шлюз по умолчанию интерфейса. Требуется, если префикс определен и это первый интерфейс с IPv6, настроенным для коммутатора.

prefix

строка

IPv6 префикс интерфейса. Требуется, если объект IPv6 включен.

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

логический тип

meraki_output_log (логический тип), создать файл лога вывода?

Варианты:

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

multicastRouting

string

Включить поддержку многоадресной рассылки, если требуется маршрутизация многоадресной рассылки между VLAN. Варианты: ‘disabled’, ‘enabled’ или ‘IGMP snooping querier’. По умолчанию ‘disabled’.

name

string

Наименование или описание интерфейса или VLAN.

ospfSettings

dictionary

Настройки маршрутизации OSPF для интерфейса.

area

string

Область OSPF, к которой должен принадлежать этот интерфейс. Может быть ‘disabled’ или идентификатор существующей области OSPF. По умолчанию ‘disabled’.

cost

integer

Стоимость пути для этого интерфейса. По умолчанию 1, но может быть увеличена до 65535 для присвоения более низкого приоритета.

isPassiveEnabled

boolean

При включении OSPF не будет работать на интерфейсе, но подсеть всё равно будет рекламироваться.

Варианты:

  • false
  • true

ospfV3

dictionary

Настройки маршрутизации OSPFv3 для интерфейса.

area

string

Область OSPFv3, к которой должен принадлежать этот интерфейс. Может быть ‘disabled’ или идентификатор существующей области OSPFv3. По умолчанию ‘disabled’.

cost

integer

Стоимость пути для этого интерфейса. По умолчанию 1, но может быть увеличена до 65535 для присвоения более низкого приоритета.

isPassiveEnabled

boolean

При включении OSPFv3 не будет работать на интерфейсе, но подсеть всё равно будет рекламироваться.

Варианты:

  • false
  • true
END_OF_DOCUMENT_MARKER

serial

string

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

subnet

string

Сеть, на которой находится этот маршрутизируемый интерфейс, в CIDR-нотации (например, 10.1.1.0/24).

vlanId

integer

VLAN, на котором находится этот маршрутизируемый интерфейс. VLAN должен быть в диапазоне от 1 до 4094.

Примечания

Примечание

  • Используемые методы SDK: switch.Switch.create_device_switch_routing_interface, switch.Switch.delete_device_switch_routing_interface, switch.Switch.update_device_switch_routing_interface,
  • Используемые пути: post /devices/{serial}/switch/routing/interfaces, delete /devices/{serial}/switch/routing/interfaces/{interfaceId}, put /devices/{serial}/switch/routing/interfaces/{interfaceId},
  • Не поддерживает check_mode
  • Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki по switch createDeviceSwitchRoutingInterface

Полная справка по API createDeviceSwitchRoutingInterface.

Документация Cisco Meraki по switch deleteDeviceSwitchRoutingInterface

Полная справка по API deleteDeviceSwitchRoutingInterface.

Документация Cisco Meraki по switch updateDeviceSwitchRoutingInterface

Полная справка по API updateDeviceSwitchRoutingInterface.

Примеры

- name: Create
  cisco.meraki.devices_switch_routing_interfaces:
    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
    defaultGateway: 192.168.1.1
    interfaceIp: 192.168.1.2
    ipv6:
      address: 1:2:3:4::1
      assignmentMode: static
      gateway: 1:2:3:4::2
      prefix: 1:2:3:4::/48
    multicastRouting: disabled
    name: L3 interface
    ospfSettings:
      area: '0'
      cost: 1
      isPassiveEnabled: true
    ospfV3:
      area: '1'
      cost: 2
      isPassiveEnabled: true
    serial: string
    subnet: 192.168.1.0/24
    vlanId: 100

- name: Delete by id
  cisco.meraki.devices_switch_routing_interfaces:
    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: absent
    interfaceId: string
    serial: string

- name: Update by id
  cisco.meraki.devices_switch_routing_interfaces:
    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
    defaultGateway: 192.168.1.1
    interfaceId: string
    interfaceIp: 192.168.1.2
    ipv6:
      address: 1:2:3:4::1
      assignmentMode: static
      gateway: 1:2:3:4::2
      prefix: 1:2:3:4::/48
    multicastRouting: disabled
    name: L3 interface
    ospfSettings:
      area: '0'
      cost: 1
      isPassiveEnabled: true
    ospfV3:
      area: '1'
      cost: 2
      isPassiveEnabled: true
    serial: string
    subnet: 192.168.1.0/24
    vlanId: 100

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"defaultGateway": "string", "interfaceId": "string", "interfaceIp": "string", "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "prefix": "string"}, "multicastRouting": "string", "name": "string", "ospfSettings": {"area": "string", "cost": 0, "isPassiveEnabled": true}, "ospfV3": {"area": "string", "cost": 0, "isPassiveEnabled": true}, "subnet": "string", "vlanId": 0}

Авторы

  • 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_switch_routing_interfaces_module.html

Spec-Zone.ru

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