Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_switch_access_policies – Модуль ресурсов для networks_switch_accesspolicies

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.

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

Добавлен в cisco.meraki 2.16.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Описание

  • Управление операциями создания, обновления и удаления ресурсов networks_switch_accesspolicies.
  • Создание политики доступа для сетевого коммутатора. Если вы хотите включить аутентификацию Meraki, установите radiusServers в пустой массив.
  • Удаление политики доступа для сетевого коммутатора.
  • Обновление политики доступа для сетевого коммутатора. Если вы хотите включить аутентификацию Meraki, установите radiusServers в пустой массив.

Примечание

Для этого модуля имеется соответствующий плагин действий.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

accessPolicyNumber

строка

Параметр пути accessPolicyNumber. Номер политики доступа.

accessPolicyType

строка

Тип доступа по политике. Автоматически «Гибридная аутентификация» при hostMode «Многодоменный».

dot1x

словарь

Настройки 802.1x.

controlDirection

строка

Поддерживает значения «both» или «inbound». Установите значение «inbound», чтобы разрешить неавторизованный выходной трафик на порту коммутатора. Установите значение «both», чтобы управлять обоими направлениями трафика с авторизацией. По умолчанию значение «both».

guestPortBouncing

булево

При включении устройства Meraki периодически отправляют запросы доступа на эти RADIUS-серверы.

Варианты:

  • false
  • true

guestVlanId

целое число

Идентификатор VLAN для гостей, разрешающий неавторизованным устройствам доступ к ограниченным ресурсам сети.

hostMode

строка

Выбор режима работы Host для политики доступа.

increaseAccessSpeed

булево

Включение этого параметра позволит коммутаторам выполнять аутентификацию 802.1X и MAC-bypass одновременно, чтобы клиенты аутентифицировались быстрее. Требуется только тогда, когда accessPolicyType — «Гибридная аутентификация».

Варианты:

  • false
  • true

meraki_action_batch_retry_wait_time

целое число

meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке в пакетной обработке действий

По умолчанию: 60

meraki_api_key

строка / обязательно

meraki_api_key (строка), API-ключ, сгенерированный в панели управления; также может быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

строка

meraki_base_url (строка), предшествующая всем ресурсам конечной точки

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

строка

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная среды BE_GEO_ID

По умолчанию: ""

meraki_caller

строка

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER

По умолчанию: ""

meraki_certificate_path

строка

meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если за локальным прокси

По умолчанию: ""

meraki_inherit_logging_config

булево

meraki_inherit_logging_config (булево), использует собственную запись логов

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

строка

meraki_log_file_prefix (строка), имя файла логов, дополненное датой и отметкой времени

По умолчанию: "meraki_api_"

meraki_log_path

строка

log_path (строка), путь к выводу логов; по умолчанию — рабочая директория скрипта, если не указано

По умолчанию: ""

meraki_maximum_retries

целое число

meraki_maximum_retries (целое число), повторяет попытки до указанного числа раз при возникновении 429 или других ошибок на стороне сервера

По умолчанию: 2

meraki_nginx_429_retry_wait_time

целое число

meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки при ошибке Nginx 429

По умолчанию: 60
END_OF_DOCUMENT_MARKER

meraki_output_log

boolean

meraki_output_log (boolean), создать файл журнала вывода?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), выводить сообщения журнала в консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания повтора попытки при других ошибках 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя в ответе!

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторить попытку при возникновении ошибки ограничения скорости 429?

Choices:

  • false
  • true ← (default)

name

string

Имя политики доступа.

networkId

string

NetworkId параметр пути. Идентификатор сети.

radius

dictionary

Объект для настроек RADIUS.

criticalAuth

dictionary

Критические настройки авторизации, когда сервер RADIUS отклоняет аутентификацию.

dataVlanId

integer

VLAN, в который будут помещены клиенты, использующие данные, при сбое аутентификации RADIUS. Будет null, если hostMode — Multi-Auth.

suspendPortBounce

boolean

Включить приостановку перезапуска порта, когда серверы RADIUS недоступны.

Choices:

  • false
  • true

voiceVlanId

integer

VLAN, в который будут помещены клиенты, использующие голос, при сбое аутентификации RADIUS. Будет null, если hostMode — Multi-Auth.

failedAuthVlanId

integer

VLAN, в который будут помещены клиенты при сбое аутентификации RADIUS. Будет null, если hostMode — Multi-Auth.

reAuthenticationInterval

integer

Период переаутентификации в секундах. Будет null, если hostMode — Multi-Auth.

radiusAccountingEnabled

boolean

Включить для отправки сообщений start, interim-update и stop на конфигурированный сервер RADIUS для отслеживания подключенных клиентов.

Варианты:

  • false
  • true

radiusAccountingServers

list / elements=dictionary

Список серверов RADIUS для проверки подлинности подключенных устройств перед предоставлением сетевого доступа.

host

string

Общедоступный IP-адрес сервера RADIUS.

port

integer

Порт UDP, на котором сервер RADIUS Accounting прослушивает запросы доступа.

secret

string

Общий секрет RADIUS-клиента.

radiusCoaSupportEnabled

boolean

Изменение аутентификации для повторной аутентификации RADIUS и отключения.

Варианты:

  • false
  • true

radiusGroupAttribute

string

Допустимые значения: `””` для отсутствия или `”11”` для правил группового доступа ACL.

radiusServers

list / elements=dictionary

Список серверов RADIUS для проверки подлинности подключенных устройств перед предоставлением сетевого доступа.

host

string

Общедоступный IP-адрес сервера RADIUS.

port

integer

Порт UDP, на котором сервер RADIUS прослушивает запросы доступа.

secret

string

Общий секрет RADIUS-клиента.

radiusTestingEnabled

boolean

Если включено, устройства Meraki периодически отправляют сообщения об запросе доступа на эти серверы RADIUS.

Варианты:

  • false
  • true

urlRedirectWalledGardenEnabled

boolean

Включить для ограничения доступа клиентов к определенному набору IP-адресов или хостов перед аутентификацией.

Варианты:

  • false
  • true

urlRedirectWalledGardenRanges

list / elements=string

Диапазоны IP-адресов в нотации CIDR для ограничения доступа клиентов к определенному набору IP-адресов или хостов перед аутентификацией.

voiceVlanClients

boolean

Клиенты голосового VLAN, поддерживающие CDP/LLDP, смогут использовать этот VLAN. Автоматически True, когда hostMode равен ‘Multi-Domain’.

Варианты:

  • false
  • true

Примечания

Примечание

  • Используемые методы SDK: switch.Switch.create_network_switch_access_policy, switch.Switch.delete_network_switch_access_policy, switch.Switch.update_network_switch_access_policy,
  • Используемые пути: post /networks/{networkId}/switch/accessPolicies, delete /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber}, put /networks/{networkId}/switch/accessPolicies/{accessPolicyNumber},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki по switch createNetworkSwitchAccessPolicy

Полное описание API createNetworkSwitchAccessPolicy.

Документация Cisco Meraki по switch deleteNetworkSwitchAccessPolicy

Полное описание API deleteNetworkSwitchAccessPolicy.

Документация Cisco Meraki по switch updateNetworkSwitchAccessPolicy

Полное описание API updateNetworkSwitchAccessPolicy.

Примеры

- name: Create
  cisco.meraki.networks_switch_access_policies:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    accessPolicyType: Hybrid authentication
    dot1x:
      controlDirection: inbound
    guestPortBouncing: false
    guestVlanId: 100
    hostMode: Single-Host
    increaseAccessSpeed: false
    name: 'Access policy #1'
    networkId: string
    radius:
      criticalAuth:
        dataVlanId: 100
        suspendPortBounce: true
        voiceVlanId: 100
      failedAuthVlanId: 100
      reAuthenticationInterval: 120
    radiusAccountingEnabled: true
    radiusAccountingServers:
    - host: 1.2.3.4
      port: 22
      secret: secret
    radiusCoaSupportEnabled: false
    radiusGroupAttribute: '11'
    radiusServers:
    - host: 1.2.3.4
      port: 22
      secret: secret
    radiusTestingEnabled: false
    urlRedirectWalledGardenEnabled: true
    urlRedirectWalledGardenRanges:
    - 192.168.1.0/24
    voiceVlanClients: true

- name: Delete by id
  cisco.meraki.networks_switch_access_policies:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: absent
    accessPolicyNumber: string
    networkId: string

- name: Update by id
  cisco.meraki.networks_switch_access_policies:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    accessPolicyNumber: string
    accessPolicyType: Hybrid authentication
    dot1x:
      controlDirection: inbound
    guestPortBouncing: false
    guestVlanId: 100
    hostMode: Single-Host
    increaseAccessSpeed: false
    name: 'Access policy #1'
    networkId: string
    radius:
      criticalAuth:
        dataVlanId: 100
        suspendPortBounce: true
        voiceVlanId: 100
      failedAuthVlanId: 100
      reAuthenticationInterval: 120
    radiusAccountingEnabled: true
    radiusAccountingServers:
    - host: 1.2.3.4
      port: 22
      secret: secret
    radiusCoaSupportEnabled: false
    radiusGroupAttribute: '11'
    radiusServers:
    - host: 1.2.3.4
      port: 22
      secret: secret
    radiusTestingEnabled: false
    urlRedirectWalledGardenEnabled: true
    urlRedirectWalledGardenRanges:
    - 192.168.1.0/24
    voiceVlanClients: true

Значения возврата

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

Ключ

Описание

meraki_response

словарь

Словарь или список с ответом, возвращенным Cisco Meraki Python SDK

Возвращается: всегда

Пример: {"accessPolicyType": "string", "counts": {"ports": {"withThisPolicy": 0}}, "dot1x": {"controlDirection": "string"}, "guestPortBouncing": true, "guestVlanId": 0, "hostMode": "string", "increaseAccessSpeed": true, "name": "string", "radius": {"criticalAuth": {"dataVlanId": 0, "suspendPortBounce": true, "voiceVlanId": 0}, "failedAuthVlanId": 0, "reAuthenticationInterval": 0}, "radiusAccountingEnabled": true, "radiusAccountingServers": [{"host": "string", "port": 0}], "radiusCoaSupportEnabled": true, "radiusGroupAttribute": "string", "radiusServers": [{"host": "string", "port": 0}], "radiusTestingEnabled": true, "urlRedirectWalledGardenEnabled": true, "urlRedirectWalledGardenRanges": ["string"], "voiceVlanClients": true}

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Отслеживание проблем
  • Репозиторий (источники)

© 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/networks_switch_access_policies_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API