meraki_vlan – Управление VLAN в облаке Meraki

Новое в версии 2.7.

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

Обзор

Создание, редактирование, запросы или удаление VLAN в среде Meraki.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
appliance_ip -		IP-адрес прибора. Адрес должен находиться в подсети, указанной в параметре `subnet`.
auth_key строка		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
dns_nameservers -		Список IP-адресов DNS, разделенных точкой с запятой. Укажите один из следующих вариантов для предопределённых записей DNS: opendns, google_dns, upstream_dns
fixed_ip_assignments -		Статические назначения IP-адресов, которые должны распределяться через DHCP по MAC-адресу.
host строка	По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может быть использован для доступа к региональным средам Meraki, например, в Китае.
name -		Имя VLAN. Псевдонимы: vlan_name
net_id -		Идентификатор сети, в которой находится VLAN или должна находиться.
net_name -		Имя сети, в которой находится VLAN или должна находиться. Псевдонимы: сеть
org_id целое число		Идентификатор организации.
org_name строка		Имя организации. Псевдонимы: организация
output_level строка	Варианты: debug normal ←	Установите объём отладочных выходов во время выполнения модуля.
reserved_ip_range -		Диапазоны IP-адресов, которые должны быть зарезервированы и не должны распределяться через DHCP.
state -	Варианты: absent present query ←	Указывает, должен ли объект быть запрошен, создан/изменён или удалён.
subnet -		Сеть CIDR.
timeout целое число	По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https boolean	Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy boolean	Варианты: no yes	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs boolean	Варианты: no yes ←	Проверять ли сертификаты HTTP.
vlan_id -		Идентификатор VLAN. Идентификатор должен быть в диапазоне от 1 до 4096.
vpn_nat_subnet -		Преобразованная подсеть VPN, если VPN и перевод подсети VPN включены в VLAN.

Примечания

Примечание

API Meraki вернёт ошибку, если VLAN не включены в сети. VLAN возвращаются правильно, если VLAN включены в сети.
Некоторые из опций, вероятно, используются только разработчиками Meraki.
API Meraki по умолчанию предполагает, что поддержка VLAN в сетях отключена, и нет способа включить поддержку VLAN через API. Поддержка VLAN должна быть включена вручную.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые из опций, вероятно, используются только разработчиками Meraki.

Примеры

- name: Query all VLANs in a network.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query information about a single VLAN by ID.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    vlan_id: 2
    state: query
  delegate_to: localhost

- name: Create a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlan_id: 2
    name: TestVLAN
    subnet: 192.0.1.0/24
    appliance_ip: 192.0.1.1
  delegate_to: localhost

- name: Update a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlan_id: 2
    name: TestVLAN
    subnet: 192.0.1.0/24
    appliance_ip: 192.168.250.2
    fixed_ip_assignments:
      - mac: "13:37:de:ad:be:ef"
        ip: 192.168.250.10
        name: fixed_ip
    reserved_ip_range:
      - start: 192.168.250.10
        end: 192.168.250.20
        comment: reserved_range
    dns_nameservers: opendns
  delegate_to: localhost

- name: Delete a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: absent
    vlan_id: 2
  delegate_to: localhost

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

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

Ключ				Возвращаемое значение	Описание
response сложный				успех	Информация об организации, которая была создана или изменена
	applianceIp строка			успех	IP-адрес прибора Meraki во VLAN Пример: 192.0.1.1
	dhcpBootFilename строка			успех	Имя файла для загрузки. Пример: boot.txt
	dhcpBootNextServer строка			успех	Опция DHCP для направления загрузки клиентов на сервер для загрузки файла загрузки. Пример: 192.0.1.2
	dhcpBootOptionsEnabled булево			успех	Включены ли опции DHCP для загрузки.
	dhcpHandling строка			успех	Состояние DHCP-сервера во VLAN. Пример: Запуск DHCP-сервера
	dhcpLeaseTime строка			успех	Срок аренды DHCP, когда сервер активен. Пример: 1 день
	dhcpOptions сложный			успех	DHCP-опции.
		code целое число		успех	Код DHCP-опции. Целое число от 2 до 254. Пример: 43
		type строка		успех	Тип DHCP-опции. Варианты: `text`, `ip`, `hex`, `integer`. Пример: текст
		value строка		успех	Значение DHCP-опции. Пример: 192.0.1.2
	dnsnamservers строка			успех	IP-адрес или определенные Meraki DNS-серверы, которые VLAN должен использовать по умолчанию Пример: upstream_dns
	fixedIpAssignments сложный			успех	Список MAC-адресов, которым назначены IP-адреса.
		macaddress сложный		успех	MAC-адрес, которому назначен IP-адрес. Значение ключа - фактический MAC-адрес.
			ip строка	успех	IP-адрес, назначенный MAC-адресу. Пример: 192.0.1.4
			name строка	успех	Дескриптивное имя привязки. Пример: fixed_ip
	id целое число			успех	Номер идентификатора VLAN. Пример: 2
	name строка			успех	Дескриптивное имя VLAN. Пример: TestVLAN
	networkId строка			успех	Номер идентификатора Meraki сети, к которой VLAN привязан. Пример: N_12345
	reservedIpRanges сложный			успех	Список диапазонов IP-адресов, зарезервированных для статического назначения.
		comment строка		успех	Описание резервирования IP-адресов. Пример: reserved_range
		end строка		успех	Последний IP-адрес в диапазоне резервирования. Пример: 192.0.1.10
		start строка		успех	Первый IP-адрес в диапазоне резервирования. Пример: 192.0.1.5
	subnet строка			успех	IP-подсеть VLAN в CIDR-нотации. Пример: 192.0.1.0/24

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Kevin Breit (@kbreit)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/meraki_vlan_module.html