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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki.

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

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

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.devices_management_interface

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

Позволяет настраивать интерфейсы управления на устройствах Meraki MX, MS и MR.

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку сервера. По умолчанию: `60`
net_id string	Идентификатор сети, к которой привязывается или от которой отвязывается шаблон конфигурации.
net_name string	Имя сети, к которой привязывается или от которой отвязывается шаблон конфигурации.
org_id string	Идентификатор организации, связанной с шаблоном конфигурации.
org_name псевдонимы: organization string	Имя организации, содержащей шаблон конфигурации.
output_format string	Определяет, должны ли ключи ответа использовать snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочных данных во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки при срабатывании ограничителя частоты запросов. По умолчанию: `165`
serial string / обязательный	Серийный номер настраиваемого устройства.
state string	Указывает, следует ли запросить, изменить или удалить сведения о шаблоне конфигурации. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
timeout integer	Время ожидания перед истечением срока ожидания HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Проверять ли сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)
wan1 псевдонимы: mgmt1 dictionary	Сведения об интерфейсе управления.
static_dns list / элементы=string	Используемые DNS-серверы. Можно указать не более 2 адресов.
static_gateway_ip string	IP-адрес шлюза по умолчанию. Допустимо, только если `using_static_ip` — `True`.
static_ip string	IP-адрес, назначенный интерфейсу управления. Допустимо, только если `using_static_ip` — `True`.
static_subnet_mask string	Маска подсети для статического IP-адреса. Допустимо, только если `using_static_ip` — `True`.
using_static_ip boolean	Настраивает интерфейс на использование статического IP-адреса или DHCP. Варианты: `false` `true`
vlan integer	Номер VLAN для сети управления.
wan_enabled string	Указывает, включён ли интерфейс управления. Применимо только к устройствам MX. Варианты: `"disabled"` `"enabled"` `"not configured"`
wan2 псевдонимы: mgmt2 dictionary	Сведения об интерфейсе управления.
static_dns list / элементы=string	Используемые DNS-серверы. Можно указать не более 2 адресов.
static_gateway_ip string	IP-адрес шлюза по умолчанию. Допустимо, только если `using_static_ip` — `True`.
static_ip string	IP-адрес, назначенный интерфейсу управления. Допустимо, только если `using_static_ip` — `True`.
static_subnet_mask string	Маска подсети для статического IP-адреса. Допустимо, только если `using_static_ip` — `True`.
using_static_ip boolean	Настраивает интерфейс на использование статического IP-адреса или DHCP. Варианты: `false` `true`
vlan integer	Номер VLAN для сети управления.
wan_enabled string	Указывает, включён ли интерфейс управления. Применимо только к устройствам MX. Варианты: `"disabled"` `"enabled"` `"not configured"`

Примечания

Примечание

Параметр WAN2 применим только к устройствам MX.
Параметр wan_enabled не следует указывать для устройств, отличных от MX.
Дополнительные сведения об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, предназначены только для разработчиков Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki для Ansible перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправит изменения в API для проверки.

Примеры

- name: Set WAN2 as static IP
  meraki_management_interface:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_id: YourNetId
    serial: AAAA-BBBB-CCCC
    wan2:
      wan_enabled: enabled
      using_static_ip: true
      static_ip: 192.168.16.195
      static_gateway_ip: 192.168.16.1
      static_subnet_mask: 255.255.255.0
      static_dns:
        - 1.1.1.1
      vlan: 1
  delegate_to: localhost

- name: Query management information
  meraki_management_interface:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_id: YourNetId
    serial: AAAA-BBBB-CCCC
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация о запрошенном объекте. Возвращается: при успехе
wan1 complex	Конфигурация управления интерфейсом WAN1 Возвращается: при успехе
static_dns list / elements=string	Список IP-адресов DNS Возвращается: только если используется статическое назначение IP-адреса Пример: `["1.1.1.1"]`
static_gateway_ip string	Назначенный статический IP-адрес шлюза Возвращается: только если используется статическое назначение IP-адреса Пример: `"192.0.1.1"`
static_ip string	Назначенный статический IP-адрес Возвращается: только если используется статическое назначение IP-адреса Пример: `"192.0.1.2"`
static_subnet_mask string	Назначенная маска подсети для статического IP-адреса Возвращается: только если используется статическое назначение IP-адреса Пример: `"255.255.255.0"`
using_static_ip boolean	Логическое значение, указывающее, используется ли для интерфейса статическое назначение IP-адреса Возвращается: при успехе Пример: `true`
vlan integer	Идентификатор тега VLAN управляющей VLAN Возвращается: при успехе Пример: `2`
wan_enabled string	Состояние включения интерфейса Возвращается: при успехе Пример: `"enabled"`
wan2 complex	Конфигурация управления интерфейсом WAN1 Возвращается: при успехе
static_dns list / elements=string	Список IP-адресов DNS Возвращается: только если используется статическое назначение IP-адреса Пример: `["1.1.1.1"]`
static_gateway_ip string	Назначенный статический IP-адрес шлюза Возвращается: только если используется статическое назначение IP-адреса Пример: `"192.0.1.1"`
static_ip string	Назначенный статический IP-адрес Возвращается: только если используется статическое назначение IP-адреса Пример: `"192.0.1.2"`
static_subnet_mask string	Назначенная маска подсети для статического IP-адреса Возвращается: только если используется статическое назначение IP-адреса Пример: `"255.255.255.0"`
using_static_ip boolean	Логическое значение, указывающее, используется ли для интерфейса статическое назначение IP-адреса Возвращается: при успехе Пример: `true`
vlan integer	Идентификатор тега VLAN управляющей VLAN Возвращается: при успехе Пример: `2`
wan_enabled string	Состояние включения интерфейса Возвращается: при успехе Пример: `"enabled"`

Статус

Этот модуль будет удален в версии 3.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕВШИЕ ЭЛЕМЕНТЫ.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 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/meraki_management_interface_module.html