Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

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

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

Добавлена в версии 1.1.0: модуля cisco.meraki

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_key
строка / обязательно
Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не задана.
host
строка
Значение по умолчанию:
"api.meraki.com"
Имя хоста для панели управления Meraki.
Может использоваться для доступа к региональным средам Meraki, например, в Китае.
internal_error_retry_time
целое число
Значение по умолчанию:
60
Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части.
net_id
строка
Идентификатор сети для привязки или отвязки шаблона конфигурации.
net_name
строка
Имя сети для привязки или отвязки шаблона конфигурации.
org_id
строка
Идентификатор организации, связанной с шаблоном конфигурации.
org_name
строка
Имя организации, содержащей шаблон конфигурации.

псевдонимы: организация
output_format
строка
    Варианты:
  • snakecase ←
  • camelcase
Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).
output_level
строка
    Варианты:
  • debug
  • normal ←
Устанавливает количество отладочной информации во время выполнения модуля.
rate_limit_retry_time
целое число
Значение по умолчанию:
165
Количество секунд для повторной попытки, если срабатывает ограничение скорости.
serial
строка / обязательно
Серийный номер устройства для настройки.
state
строка
    Варианты:
  • absent
  • query ←
  • present
Указывает, должна ли информация о шаблоне конфигурации быть запрошена, изменена или удалена.
timeout
целое число
Значение по умолчанию:
30
Время ожидания для HTTP-запросов.
use_https
логическое значение
    Варианты:
  • no
  • yes ←
Если no, будет использоваться HTTP. В противном случае используется HTTPS.
Полезно только для внутренних разработчиков Meraki.
use_proxy
логическое значение
    Варианты:
  • no ←
  • yes
Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs
логическое значение
    Варианты:
  • no
  • yes ←
Подтверждать ли HTTP-сертификаты.
wan1
словарь
Подробности интерфейса управления для интерфейса управления.

псевдонимы: mgmt1
static_dns
список / элементы=строка
DNS-серверы для использования.
Допускается максимум 2 адреса.
static_gateway_ip
строка
IP-адрес шлюза по умолчанию.
Действителен только если using_static_ip является True.
static_ip
строка
IP-адрес, назначенный интерфейсу управления.
Действителен только если using_static_ip является True.
static_subnet_mask
строка
Маска сети для статического IP-адреса.
Действителен только если using_static_ip является True.
using_static_ip
логическое значение
    Варианты:
  • no
  • yes
Настраивает интерфейс для использования статического IP-адреса или DHCP.
vlan
целое число
Номер VLAN для использования в сети управления.
wan_enabled
строка
    Варианты:
  • disabled
  • enabled
  • not configured
Указывает, включен ли интерфейс управления.
Действителен только для устройств MX.
wan2
словарь
Подробности интерфейса управления для интерфейса управления.

псевдонимы: mgmt2
static_dns
список / элементы=строка
DNS-серверы для использования.
Допускается максимум 2 адреса.
static_gateway_ip
строка
IP-адрес шлюза по умолчанию.
Действителен только если using_static_ip является True.
static_ip
строка
IP-адрес, назначенный интерфейсу управления.
Действителен только если using_static_ip является True.
static_subnet_mask
строка
Маска сети для статического IP-адреса.
Действителен только если using_static_ip является True.
using_static_ip
логическое значение
    Варианты:
  • no
  • yes
Настраивает интерфейс для использования статического IP-адреса или DHCP.
vlan
целое число
Номер VLAN для использования в сети управления.
wan_enabled
строка
    Варианты:
  • disabled
  • enabled
  • not configured
Указывает, включен ли интерфейс управления.
Действителен только для устройств MX.

Примечания

Примечание

  • 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. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если конфигурации отличаются, но не отправляет изменения в 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
success
Информация о запрошенном объекте.
wan1
complex
success
Настройка управления интерфейсом WAN1
static_dns
list / elements=string
только если используется статическое назначение IP-адреса
Список IP-адресов DNS

Пример:
['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
success
Булево значение, указывающее, используется ли статическое назначение IP-адреса на интерфейсе

Пример:
True
vlan
integer
success
Идентификатор тега VLAN управляющей VLAN

Пример:
2
wan_enabled
string
success
Состояние включения интерфейса

Пример:
enabled
wan2
complex
success
Настройка управления интерфейсом WAN1
static_dns
list / elements=string
только если используется статическое назначение IP-адреса
Список IP-адресов DNS

Пример:
['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
success
Булево значение, указывающее, используется ли статическое назначение IP-адреса на интерфейсе

Пример:
True
vlan
integer
success
Идентификатор тега VLAN управляющей VLAN

Пример:
2
wan_enabled
string
success
Состояние включения интерфейса

Пример:
enabled


Авторы

  • Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_management_interface_module.html

Spec-Zone.ru

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