cisco.meraki.meraki_ms_access_list – Управление списками доступа для коммутаторов Meraki в облаке Meraki

Примечание

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

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

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

Новое в версии 0.1.0: из cisco.meraki

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

Обзор

Настройка и запрос информации о списках доступа на коммутаторах Meraki в облаке Meraki.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не установлена.
host строка		По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
net_id строка			ID сети, к которой применяется конфигурация.
net_name строка			Имя сети, к которой применяется конфигурация. псевдонимы: network
org_id строка			ID организации.
org_name строка			Имя организации. псевдонимы: organization
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Устанавливает количество отладочных выводимых данных во время выполнения модуля.
rate_limit_retry_time целое число		По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
rules список / элементы=словарь			Список правил управления доступом.
	comment строка		Описание правила.
	dst_cidr строка		CIDR-нотация IP-адреса назначения для соответствия.
	dst_port строка		Номер порта назначения для соответствия. Может быть номером порта или 'any'.
	ip_version строка	Варианты: any ipv4 ipv6	Тип IP-пакетов для соответствия.
	policy строка	Варианты: allow deny	Действие, которое следует предпринять по соответствию трафика.
	protocol строка	Варианты: any tcp udp	Тип протокола для соответствия.
	src_cidr строка		CIDR-нотация IP-адреса источника для соответствия.
	src_port строка		Номер порта источника для соответствия. Может быть номером порта или 'any'.
	vlan строка		VLAN входящего трафика. Может быть любым портом от 1 до 4095 или 'any'.
state строка		Варианты: absent present query ←	Указывает, должен ли объект быть запрошен, создан/изменён или удалён.
timeout целое число		По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https булево		Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево		Варианты: no ← yes	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
validate_certs булево		Варианты: no yes ←	Производить ли проверку HTTP-сертификатов.

Примечания

Примечание

Некоторые из опций, вероятно, используются только разработчиками внутри Meraki.
Дополнительную информацию об 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 access list
  meraki_switch_access_list:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    rules:
      - comment: Fake rule
        policy: allow
        ip_version: ipv4
        protocol: udp
        src_cidr: 192.0.1.0/24
        src_port: "4242"
        dst_cidr: 1.2.3.4/32
        dst_port: "80"
        vlan: "100"
  delegate_to: localhost

- name: Query access lists
  meraki_switch_access_list:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

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

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

Ключ			Возвращённое	Описание
data сложное			успех	Список администраторов.
	rules список / элементы=строка		успех	Список правил управления доступом.
		comment строка	успех	Описание правила. Пример: Правило пользователя
		dst_cidr строка	успех	CIDR-нотация IP-адреса назначения для соответствия. Пример: 1.2.3.4/32
		dst_port строка	успех	Номер порта назначения для соответствия. Пример: 80
		ip_version строка	успех	Тип IP-пакетов для соответствия. Пример: ipv4
		policy строка	успех	Действие, которое следует предпринять по соответствию трафика. Пример: allow
		protocol строка	успех	Тип протокола для соответствия. Пример: udp
		src_cidr строка	успех	CIDR-нотация IP-адреса источника для соответствия. Пример: 192.0.1.0/24
		src_port строка	успех	Номер порта источника для соответствия. Пример: 1234
		vlan строка	успех	VLAN входящего трафика. Пример: 100

Авторы

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_ms_access_list_module.html