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

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.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 строка	Установите тип политики доступа Варианты: `"802.1x"` `"MAC authentication bypass"` `"Hybrid authentication"`
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
auth_method строка	Установите метод аутентификации в политике. Варианты: `"Meraki authentication"` `"my RADIUS server"`
data_vlan_id целое число	Установите идентификатор VLAN данных для критически важной VLAN аутентификации
guest_vlan целое число	Гостевая VLAN
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
host_mode строка	Выберите режим хоста для политики доступа. Варианты: `"Single-Host"` `"Multi-Domain"` `"Multi-Host"` `"Multi-Auth"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. По умолчанию: `60`
name строка	Имя политики доступа.
net_id строка	Идентификатор сети.
net_name псевдонимы: network строка	Имя сети.
number псевдонимы: access_policy_number целое число	Номер политики доступа.
org_id строка	Идентификатор организации, связанной с сетью.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите объем отладочного вывода во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
radius_accounting_enabled булево	Включить или отключить RADIUS учёт. Варианты: `false` `true`
radius_accounting_servers список / элементы=словарь	Список RADIUS серверов для RADIUS учёта.
host строка / обязательно	IP-адрес или имя хоста RADIUS сервера.
port целое число	Номер порта, на котором RADIUS сервер прослушивает.
secret строка	Пароль RADIUS.

END_OF_DOCUMENT_MARKER

radius_attribute_group_policy_name string	Включить этот атрибут для RADIUS Выбором: `"Filter-Id"` `""` ← (по умолчанию)
radius_coa_enabled boolean	Включить или отключить RADIUS CoA (Изменение авторизации). Выбором: `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	Установить, включена или отключена система управления устройствами. Выбором: `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	Если включено, клиенты Voice VLAN требуют авторизации Выбором: `false` `true` ← (по умолчанию)
voice_vlan_id integer	Установить идентификатор VLAN для голосового VLAN для критической VLAN авторизации

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только для разработчиков Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, установите переменную среды ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод в формате camelCase в Ansible 2.13. Пожалуйста, обновите свои playbook-файлы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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 сложное	Список правил доступа Возвращаемое значение: успех
access_policy_type строка	Тип правила доступа Возвращаемое значение: успех Пример: `"802.1x"`
guest_vlan_id целое число	Идентификатор гостевого VLAN Возвращаемое значение: успех Пример: `10`
host_mode строка	Выбранный режим хоста для правила доступа Возвращаемое значение: успех Пример: `"Single-Host"`
name строка	Имя правила доступа Возвращаемое значение: успех Пример: `"Policy with 802.1x"`
number целое число	Номер правила доступа Возвращаемое значение: успех Пример: `1`
radius сложное	Список списков, специфичных для radius Возвращаемое значение: успех
critial_auth сложное	Список критических авторизаций Возвращаемое значение: успех
data_vlan_id целое число	Идентификатор VLAN для данных Возвращаемое значение: успех Пример: `10`
suspend_port_bounce булево	Включить или отключить приостановку отражения порта Возвращаемое значение: успех Пример: `false`
voice_vlan_id целое число	Идентификатор VLAN для голоса Возвращаемое значение: успех Пример: `10`
failed_auth_vlan_id целое число	Идентификатор VLAN при ошибке авторизации Возвращаемое значение: успех Пример: `11`
re_authentication_interval целое число	Интервал повторной аутентификации Возвращаемое значение: успех
radius_accounting_enabled булево	Включить или отключить RADIUS учёт. Возвращаемое значение: успех
radius_accounting_servers список / элементы=словарь	Список RADIUS серверов для RADIUS учёта. Возвращаемое значение: успех
radius_attribute_group_policy_name строка	Включить атрибут группы radius Возвращаемое значение: успех Может возвращать только: `"11"` `""` Пример: `"11"`
radius_coa_enabled булево	Включить или отключить RADIUS CoA (изменение авторизации). Возвращаемое значение: успех
radius_servers список / элементы=словарь	Список RADIUS серверов. Возвращаемое значение: успех

END_OF_DOCUMENT_MARKER

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_ms_access_policies_module.html