Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_switch_stacks_routing_interfaces — модуль ресурсов для networks _switch _stacks _routing _interfaces

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

defaultGateway

string

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

interfaceId

string

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

interfaceIp

string

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

ipv6

dictionary

Параметры IPv6 интерфейса.

address

string

IPv6-адрес интерфейса. Обязателен, если assignmentMode имеет значение ‘static’. Не указывайте, если assignmentMode имеет значение ‘eui-64’.

assignmentMode

string

Режим назначения IPv6-адреса интерфейсу. Возможные значения: ‘eui-64’ или ‘static’.

gateway

string

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

prefix

string

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

loopback

dictionary

Параметры loopback-интерфейса.

meraki_action_batch_retry_wait_time

integer

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

По умолчанию: 60

meraki_api_key

string / обязательный

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

meraki_base_url

string

meraki_base_url (string), базовый URL для всех конечных точек ресурсов

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

По умолчанию: ""

meraki_certificate_path

string

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

По умолчанию: ""

meraki_inherit_logging_config

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

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

По умолчанию: "meraki_api_"

meraki_log_path

string

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

По умолчанию: ""

meraki_maximum_retries

integer

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

По умолчанию: 2

meraki_nginx_429_retry_wait_time

integer

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

По умолчанию: 60

meraki_output_log

boolean

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

Варианты:

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

mode

string

Режим интерфейса L3: ‘vlan’, ‘routed’ или ‘loopback’. По умолчанию — ‘vlan’. Для режима ‘routed’ требуется CS 17.18 или более поздняя версия.

multicastRouting

string

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

name

string

Понятное имя или описание интерфейса либо VLAN (максимальная длина — 128 символов).

networkId

string

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

ospfSettings

dictionary

Параметры маршрутизации OSPF интерфейса.

area

string

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

cost

integer

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

isPassiveEnabled

boolean

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

Варианты:

  • false
  • true

networkType

string

Тип сети OSPF.

subnet

string

Сеть, к которой относится этот интерфейс L3, в нотации CIDR (например, 10.1.1.0/24).

switchPortId

string

Идентификатор порта коммутатора в режиме Routed (требуется CS 17.18 или более поздняя версия).

switchStackId

string

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

vlanId

integer

VLAN, к которой относится этот интерфейс L3. Значение VLAN должно быть в диапазоне от 1 до 4094.

vrf

dictionary

Параметры VRF интерфейса. Требуется IOS XE 17.18 или более поздняя версия.

name

string

Имя VRF, к которой относится этот интерфейс.

Примечания

Примечание

  • Используются методы SDK: switch.Switch.create_network_switch_stack_routing_interface, switch.Switch.delete_network_switch_stack_routing_interface, switch.Switch.update_network_switch_stack_routing_interface,
  • Используются пути: post /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces, delete /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}, put /networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId},
  • Не поддерживает check_mode
  • Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а использует встроенный менеджер подключений
  • из Cisco Dashboard API Python(SDK)
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки подключения

См. также

См. также

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

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

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

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

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

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

Примеры

- name: Create
  cisco.meraki.networks_switch_stacks_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_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
    defaultGateway: 192.168.1.1
    interfaceIp: 192.168.1.2
    ipv6:
      address: 2001:db8::1
      assignmentMode: static
      gateway: 2001:db8::2
      prefix: 2001:db8::/32
    mode: vlan
    multicastRouting: disabled
    name: L3 interface
    networkId: string
    ospfSettings:
      area: '0'
      cost: 1
      isPassiveEnabled: true
      networkType: broadcast
    subnet: 192.168.1.0/24
    switchPortId: '1'
    switchStackId: string
    vlanId: 100
    vrf:
      name: Blue
- name: Update by id
  cisco.meraki.networks_switch_stacks_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_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
    defaultGateway: 192.168.1.1
    interfaceId: string
    interfaceIp: 192.168.1.2
    ipv6:
      address: 2001:db8::1
      assignmentMode: static
      gateway: 2001:db8::2
      prefix: 2001:db8::/32
    multicastRouting: disabled
    name: L3 interface
    networkId: string
    ospfSettings:
      area: '0'
      cost: 1
      isPassiveEnabled: true
      networkType: broadcast
    subnet: 192.168.1.0/24
    switchPortId: '1'
    switchStackId: string
    vlanId: 100
    vrf:
      name: Blue
- name: Delete by id
  cisco.meraki.networks_switch_stacks_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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: absent
    interfaceId: string
    networkId: string
    switchStackId: string

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"defaultGateway": "string", "interfaceId": "string", "interfaceIp": "string", "ipv6": {"address": "string", "assignmentMode": "string", "gateway": "string", "prefix": "string"}, "loopback": {}, "mode": "string", "multicastRouting": "string", "name": "string", "ospfSettings": {"area": "string", "cost": 0, "isPassiveEnabled": true, "networkType": "string"}, "ospfV3": {"area": "string", "cost": 0, "isPassiveEnabled": true, "networkType": "string"}, "serial": "string", "subnet": "string", "switchPortId": "string", "uplinkV4": true, "uplinkV6": true, "vlanId": 0, "vrf": {"name": "string"}}

Авторы

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

Spec-Zone.ru

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