Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать её в playbook, укажите: 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 / required

Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не установлена.

host

string

Имя хоста для панели управления Meraki.

Может использоваться для доступа к региональным средам Meraki, таким как Китай.

Default: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд для повтора попытки, если сервер возвращает внутреннюю ошибку сервера.

Default: 60

net_id

string

ID сети, к которой необходимо привязать или отвязать шаблон конфигурации.

net_name

string

Имя сети, к которой необходимо привязать или отвязать шаблон конфигурации.

org_id

string

ID организации, связанной с шаблоном конфигурации.

org_name

aliases: organization

string

Имя организации, содержащей шаблон конфигурации.

output_format

string

Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).

Choices:

  • "snakecase" ← (default)
  • "camelcase"

output_level

string

Устанавливает объем отладочной информации во время выполнения модуля.

Choices:

  • "debug"
  • "normal" ← (default)

rate_limit_retry_time

integer

Количество секунд для повтора попытки, если срабатывает ограничитель скорости.

Default: 165

serial

string / required

Серийный номер устройства для настройки.

state

string

Указывает, следует ли запрашивать, изменять или удалять информацию о шаблоне конфигурации.

Choices:

  • "absent"
  • "query" ← (default)
  • "present"

timeout

integer

Время ожидания для HTTP-запросов.

Default: 30

use_https

boolean

Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.

Полезно только для внутренних разработчиков Meraki.

Choices:

  • false
  • true ← (default)

use_proxy

boolean

Если no, прокси использоваться не будет, даже если он определен в переменной среды на целевых хостах.

Choices:

  • false ← (default)
  • true

validate_certs

boolean

Проверять ли HTTP-сертификаты.

Choices:

  • false
  • true ← (default)

wan1

aliases: mgmt1

dictionary

Подробная информация о интерфейсе управления.

static_dns

list / elements=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

aliases: mgmt2

dictionary

Сведения об интерфейсе управления для интерфейса управления.

static_dns

list / elements=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.
  • Модули Meraki в Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Пожалуйста, обновите свои playbooks.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменении, если есть различия в конфигурациях, но не отправит изменения в 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: yes
      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. [deprecated]
  • Для получения дополнительной информации см. DEPRECATED.

Авторы

  • Kevin Breit (@kbreit)

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

  • Система отслеживания ошибок
  • Репозиторий (Исходный код)

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

Spec-Zone.ru

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