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, таким как Китай.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
name строка		Название VLAN. псевдонимы: vlan_name
net_id строка		ID сети, в которой находится или должна находиться VLAN.
net_name строка		Имя сети, в которой находится или должна находиться VLAN. псевдонимы: network
org_id строка		ID организации.
org_name строка		Название организации. псевдонимы: организация
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.
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. Пожалуйста, обновите свои playbook.

Примеры

- 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 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

Статус

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

Авторы

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.9/modules/meraki_vlan_module.html