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

Примечание

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

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

Для использования в книге задач, укажите: cisco.meraki.meraki_vlan.

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
appliance_ip строка			IP-адрес устройства. Адрес должен находиться в подсети, указанной в параметре `subnet`.
auth_key строка / обязательный			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
dhcp_boot_filename строка			Имя файла для загрузки при DHCP-загрузке.
dhcp_boot_next_server строка			Параметр DHCP для перенаправления клиентов на сервер для загрузки файла загрузки.
dhcp_boot_options_enabled логическое значение		Варианты: no yes	Включить параметры DHCP-загрузки.
dhcp_handling строка		Варианты: Запустить DHCP-сервер Перенаправить DHCP на другой сервер Не отвечать на запросы DHCP none server relay	Как обрабатывать пакеты DHCP в сети.
dhcp_lease_time строка		Варианты: 30 минут 1 час 4 часа 12 часов 1 день 1 неделя	Настройка таймера аренды DHCP.
dhcp_options список / элементы=словарь			Список значений параметров DHCP.
	code целое число		Номер параметра DHCP.
	type строка	Варианты: текст ip hex целое число	Тип значения для параметра DHCP.
	value строка		Значение для параметра DHCP.
dhcp_relay_server_ips список / элементы=строка			IP-адреса для переадресации пакетов DHCP.
dns_nameservers строка			Список IP-адресов DNS, разделенных точкой с запятой. Укажите один из следующих вариантов для предварительно запрограммированных записей DNS: opendns, google_dns, upstream_dns
fixed_ip_assignments список / элементы=словарь			Статические назначения IP-адресов, которые должны быть распределены через DHCP по MAC-адресу.
	ip строка		IP-адрес для привязки статического назначения IP.
	mac строка		MAC-адрес для привязки статического назначения IP.
	name строка		Описание привязки назначения IP.
host строка		По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера.
name строка			Имя VLAN. псевдонимы: vlan_name
net_id строка			Идентификатор сети, в которой находится или должна находиться VLAN.
net_name строка			Имя сети, в которой находится или должна находиться VLAN. псевдонимы: network
org_id строка			Идентификатор организации.
org_name строка			Название организации. псевдонимы: organization
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Устанавливает количество отладочных вывода во время выполнения модуля.
rate_limit_retry_time целое число		По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
reserved_ip_range список / элементы=словарь			Диапазоны IP-адресов, которые следует зарезервировать и не распределять через DHCP.
	comment строка		Описание резервирования IP-адресов.
	end строка		Последний IP-адрес диапазона зарезервированных IP-адресов (включительно).
	start строка		Первый IP-адрес диапазона зарезервированных IP-адресов (включительно).
state строка		Варианты: absent present query ←	Указывает, должен ли объект быть запрошен, создан/изменен или удален.
subnet строка			CIDR-запись подсети сети.
timeout целое число		По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логическое значение		Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое значение		Варианты: no ← yes	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.
validate_certs логическое значение		Варианты: 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.
Начиная с Ansible 2.9, модули Meraki выдают ключи в формате snake case. Для использования camel case, установите переменную окружения ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki Ansible перестанут поддерживать вывод camel case в Ansible 2.13. Обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в API для проверки изменения.

Примеры

- 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: Enable DHCP on VLAN with options
  meraki_vlan:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    vlan_id: 2
    name: TestVLAN
    subnet: 192.168.250.0/24
    appliance_ip: 192.168.250.2
    dhcp_handling: server
    dhcp_lease_time: 1 hour
    dhcp_boot_options_enabled: false
    dhcp_options:
      - code: 5
        type: ip
        value: 192.0.1.1
  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 complex				success	Информация об организации, которая была создана или изменена
	appliance_ip string			success	IP-адрес устройства Meraki в VLAN Пример: 192.0.1.1
	dhcp_boot_filename string			success	Имя файла загрузки. Пример: boot.txt
	dhcp_boot_next_server string			success	Параметр DHCP, указывающий клиентам загрузки файла загрузки с сервера. Пример: 192.0.1.2
	dhcp_boot_options_enabled boolean			success	Включены ли параметры загрузки DHCP.
	dhcp_handling string			success	Состояние DHCP-сервера в VLAN. Пример: Запуск DHCP-сервера
	dhcp_lease_time string			success	Срок действия аренды DHCP, когда сервер активен. Пример: 1 день
	dhcp_options complex			success	Параметры DHCP.
		code integer		success	Код параметра DHCP. Целое число от 2 до 254. Пример: 43
		type string		success	Тип параметра DHCP. Варианты: `text`, `ip`, `hex`, `integer`. Пример: text
		value string		success	Значение параметра DHCP. Пример: 192.0.1.2
	dnsnamservers string			success	IP-адрес или определенные Meraki DNS-серверы, которые VLAN должен использовать по умолчанию Пример: upstream_dns
	fixed_ip_assignments complex			success	Список MAC-адресов, которым назначены IP-адреса.
		macaddress complex		success	MAC-адрес, которому назначен IP-адрес. Значение ключа — фактический MAC-адрес.
			ip string	success	IP-адрес, назначенный MAC-адресу. Пример: 192.0.1.4
			name string	success	Дескриптивное имя привязки. Пример: fixed_ip
	id integer			success	Номер ID VLAN. Пример: 2
	name string			success	Дескриптивное имя VLAN. Пример: TestVLAN
	networkId string			success	Номер ID сети Meraki, к которой связан VLAN. Пример: N_12345
	reserved_ip_ranges complex			success	Список диапазонов IP-адресов, зарезервированных для статического назначения.
		comment string		success	Описание резервирования IP-адреса. Пример: reserved_range
		end string		success	Последний IP-адрес в диапазоне резервирования. Пример: 192.0.1.10
		start string		success	Первый IP-адрес в диапазоне резервирования. Пример: 192.0.1.5
	subnet string			success	IP-подсеть VLAN в CIDR-нотации. Пример: 192.0.1.0/24

Авторы

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.10/collections/cisco/meraki/meraki_vlan_module.html