модуль cisco.meraki.meraki_ms_access_policies — Управление политиками доступа к коммутаторам в облаке Meraki

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.meraki.meraki_ms_access_policies.

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновленные модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_switch_access_policies

Краткое описание

Модуль для управления политиками доступа к коммутаторам в облаке Meraki

Параметры

Параметр	Комментарии
access_policy_type string	Задает тип политики доступа Варианты: `"802.1x"` `"MAC authentication bypass"` `"Hybrid authentication"`
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная окружения `MERAKI_KEY` не задана.
auth_method string	Задает метод аутентификации в политике. Варианты: `"Meraki authentication"` `"my RADIUS server"`
data_vlan_id integer	Задает идентификатор VLAN данных для критической VLAN аутентификации
guest_vlan integer	Гостевая VLAN
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
host_mode string	Выберите режим хоста для политики доступа. Варианты: `"Single-Host"` `"Multi-Domain"` `"Multi-Host"` `"Multi-Auth"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
name string	Имя политики доступа.
net_id string	Идентификатор сети.
net_name псевдонимы: network string	Имя сети.
number псевдонимы: access_policy_number integer	Номер политики доступа.
org_id string	Идентификатор организации, связанной с сетью.
org_name псевдонимы: organization string	Имя организации.
output_format string	Указывает модулю, следует ли возвращать ключи ответа в змеином регистре (например, `net_id`) или в верблюжьем регистре (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задает объем отладочных данных, выводимых во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
radius_accounting_enabled boolean	Включает или отключает учет RADIUS. Варианты: `false` `true`
radius_accounting_servers list / elements=dictionary	Список серверов RADIUS для учета RADIUS.
host string / обязательный	IP-адрес или имя хоста сервера RADIUS.
port integer	Номер порта, который прослушивает сервер RADIUS.
secret string	Пароль RADIUS.
radius_attribute_group_policy_name string	Включает этот атрибут для RADIUS Варианты: `"Filter-Id"` `""` ← (по умолчанию)
radius_coa_enabled boolean	Включает или отключает CoA RADIUS (изменение авторизации). Варианты: `false` `true`
radius_servers list / elements=dictionary	Список серверов RADIUS.
host string / обязательный	IP-адрес или имя хоста сервера RADIUS.
port integer	Номер порта, который прослушивает сервер RADIUS.
secret string	Пароль RADIUS. Установка пароля не является идемпотентной.
radius_testing boolean	Задает состояние тестирования RADIUS. Варианты: `false` `true` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки, если сработало ограничение частоты запросов. По умолчанию: `165`
state string	Указывает, следует ли запрашивать или изменять сведения SNMP. Варианты: `"absent"` `"query"` `"present"` ← (по умолчанию)
suspend_port_bounce boolean	Включает или отключает приостановку перезапуска порта при недоступности серверов RADIUS. Варианты: `false` ← (по умолчанию) `true`
systems_management_enrollment boolean	Задает, включена или отключена регистрация в Systems Manager Варианты: `false` ← (по умолчанию) `true`
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Проверять ли сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)
voice_vlan_clients boolean	Если параметр включен, клиентам голосовой VLAN требуется аутентификация Варианты: `false` `true` ← (по умолчанию)
voice_vlan_id integer	Задает идентификатор голосовой VLAN для критической VLAN аутентификации

Примечания

Примечание

Дополнительные сведения об API Meraki см. на странице https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в змеином регистре. Чтобы использовать верблюжий регистр, задайте для переменной окружения ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki для Ansible перестанут поддерживать вывод в верблюжьем регистре. Обновите плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в API для проверки.

Примеры

- name: Create access policy with auth_method is "Meraki authentication"
  cisco.meraki.meraki_ms_access_policies:
    auth_key: abc123
    state: present
    name: Meraki authentication policy
    auth_method: Meraki authentication
    net_name: YourNet
    org_name: YourOrg
  delegate_to: localhost
- name: Create access policy with auth_method is "my Radius Server"
  cisco.meraki.meraki_ms_access_policies:
    auth_key: abc123
    access_policy_type: 802.1x
    host_mode: Single-Host
    state: present
    name: Meraki authentication policy
    auth_method: my RADIUS server
    radius_servers:
      - host: 192.0.1.18
        port: 7890
        secret: secret123
    net_name: YourNet
    org_name: YourOrg
    radius_coa_enabled: false
    radius_accounting_enabled: false
    guest_vlan: 10
    voice_vlan_clients: false

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

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

Ключ	Описание
data complex	Список политик доступа Возвращается: success
access_policy_type string	Тип политики доступа Возвращается: success Пример: `"802.1x"`
guest_vlan_id integer	Идентификатор гостевой VLAN Возвращается: success Пример: `10`
host_mode string	Выбранный режим хоста для политики доступа Возвращается: success Пример: `"Single-Host"`
name string	Название политики доступа Возвращается: success Пример: `"Policy with 802.1x"`
number integer	Номер политики доступа Возвращается: success Пример: `1`
radius complex	Список параметров RADIUS Возвращается: success
critial_auth complex	Список параметров критической аутентификации Возвращается: success
data_vlan_id integer	Идентификатор VLAN для данных Возвращается: success Пример: `10`
suspend_port_bounce boolean	Включение или отключение приостановки переключения порта Возвращается: success Пример: `false`
voice_vlan_id integer	Идентификатор VLAN для голосового трафика Возвращается: success Пример: `10`
failed_auth_vlan_id integer	Идентификатор VLAN при сбое аутентификации Возвращается: success Пример: `11`
re_authentication_interval integer	Интервал повторной аутентификации Возвращается: success
radius_accounting_enabled boolean	Включение или отключение учета RADIUS. Возвращается: success
radius_accounting_servers list / elements=dictionary	Список серверов RADIUS для учета RADIUS. Возвращается: success
radius_attribute_group_policy_name string	Включение группового атрибута RADIUS Возвращается: success Может возвращать только: `"11"` `""` Пример: `"11"`
radius_coa_enabled boolean	Включение или отключение CoA RADIUS (изменение авторизации). Возвращается: success
radius_servers list / elements=dictionary	Список серверов RADIUS. Возвращается: success
radius_testing_enabled boolean	Включение или отключение тестирования RADIUS Возвращается: success Пример: `true`
voice_vlan_clients boolean	Включение или отключение клиентов голосовой VLAN Возвращается: success Пример: `false`

Статус

Этот модуль будет удален в версии 3.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Marcin Woźniak (@y0rune)

Ссылки на коллекцию

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