Модуль cisco.meraki.networks_switch_access_policies — модуль ресурсов для networks _switch _accesspolicies

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_switch_access_policies.

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

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

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

Управление операциями создания, обновления и удаления ресурса networks _switch _accesspolicies.
Создание политики доступа для сети коммутаторов. Чтобы включить аутентификацию Meraki, задайте для radiusServers пустой массив.
Удаление политики доступа для сети коммутаторов.
Обновление политики доступа для сети коммутаторов. Чтобы включить аутентификацию Meraki, задайте для radiusServers пустой массив.

Примечание

Этому модулю соответствует модуль действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
accessPolicyNumber string	Параметр пути AccessPolicyNumber. Номер политики доступа.
accessPolicyType string	Тип доступа для политики. Автоматически устанавливается в значение «Hybrid authentication», если hostMode имеет значение «Multi-Domain».
dot1x dictionary	Настройки 802.1x.
controlDirection string	Поддерживаются значения «both» и «inbound». Укажите «inbound», чтобы разрешить неавторизованный исходящий трафик через порт коммутатора. Укажите «both», чтобы управлять обоими направлениями трафика с помощью авторизации. По умолчанию используется значение «both».
guestGroupPolicyId string	Номер групповой политики для гостевой группы.
guestPortBouncing boolean	Если параметр включен, устройства Meraki будут периодически отправлять запросы доступа на эти серверы RADIUS. Варианты: `false` `true`
guestSgtId integer	ID тега группы безопасности для гостевой групповой политики.
guestVlanId integer	ID гостевой VLAN, которая предоставляет неавторизованным устройствам доступ к ограниченным сетевым ресурсам.
hostMode string	Выберите режим узла для политики доступа.
increaseAccessSpeed boolean	Включение этого параметра заставит коммутаторы одновременно выполнять аутентификацию 802.1X и MAC-bypass, чтобы ускорить аутентификацию клиентов. Требуется только, если accessPolicyType имеет значение «Hybrid Authentication». Варианты: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакетных действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), добавляется перед всеми ресурсами конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), к имени файла журнала добавляются дата и отметка времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для выходного журнала; по умолчанию используется рабочий каталог скрипта, если путь не указан По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное количество повторных попыток при получении ответов 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если необходимо По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять попытку при возникновении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить ведение журнала? Тогда вы предоставлены сами себе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять попытку при достижении ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
name string	Название политики доступа (максимальная длина — 255 символов).
networkId string	Параметр пути NetworkId. Идентификатор сети.
radius dictionary	Объект настроек RADIUS.
authentication dictionary	Объект настроек режима аутентификации.
mode string	Режим аутентификации политики (Open \| Closed).
cache dictionary	Объект настроек кэша RADIUS.
enabled boolean	Включите кэширование ответов авторизации и аутентификации на сервере RADIUS. Варианты: `false` `true`
timeout integer	Если кэширование RADIUS включено, это значение определяет, как долго кэш будет храниться на сервере RADIUS (в часах), позволяя получать доступ к сети без аутентификации.
criticalAuth dictionary	Настройки критической аутентификации на случай отклонения аутентификации сервером RADIUS.
dataGroupPolicyId string	Номер групповой политики для VLAN данных.
dataSgtId integer	ID тега группы безопасности для VLAN данных.
dataVlanId integer	VLAN, к которой будут относиться клиенты, использующие передачу данных, если аутентификация RADIUS завершится неудачно. Значение будет null, если hostMode имеет значение Multi-Auth.
suspendPortBounce boolean	Отключить перезапуск порта при недоступности серверов RADIUS. Варианты: `false` `true`
voiceGroupPolicyId string	Номер групповой политики для голосовой VLAN.
voiceSgtId integer	ID тега группы безопасности для голосовой VLAN.
voiceVlanId integer	VLAN, к которой будут относиться клиенты, использующие голосовую связь, если аутентификация RADIUS завершится неудачно. Значение будет null, если hostMode имеет значение Multi-Auth.
failedAuthGroupPolicyId string	Номер групповой политики для группы с неудачной аутентификацией.
failedAuthSgtId integer	ID тега группы безопасности для групповой политики с неудачной аутентификацией.
failedAuthVlanId integer	VLAN, к которой будут относиться клиенты, если аутентификация RADIUS завершится неудачно. Значение будет null, если hostMode имеет значение Multi-Auth.
preAuthenticationGroupPolicyId string	Номер групповой политики для политики предварительной аутентификации.
reAuthenticationInterval integer	Период повторной аутентификации в секундах. Значение будет null, если hostMode имеет значение Multi-Auth.
radiusAccountingEnabled boolean	Включите отправку сообщений start, interim-update и stop на настроенный сервер учета RADIUS для отслеживания подключенных клиентов. Варианты: `false` `true`
radiusAccountingServers list / elements=dictionary	Список серверов учета RADIUS, с которыми подключающиеся устройства должны пройти аутентификацию перед получением доступа к сети.
host string	Публичный IP-адрес сервера учета RADIUS.
organizationRadiusServerId string	Идентификатор сервера RADIUS организации. Если это поле задано, поля host, port и secret игнорируются.
port integer	Порт UDP, на котором сервер учета RADIUS принимает запросы доступа.
secret string	Общий секрет клиента RADIUS.

radiusCoaSupportEnabled boolean	Смена аутентификации для повторной аутентификации RADIUS и отключения. Варианты: `false` `true`
radiusGroupAttribute string	Допустимые значения: `””` для «Нет» или `”11”` для ACL групповых политик.
radiusServers list / elements=dictionary	Список серверов RADIUS, на которых подключающиеся устройства должны пройти аутентификацию, прежде чем получить доступ к сети.
host string	Общедоступный IP-адрес сервера RADIUS.
organizationRadiusServerId string	Идентификатор сервера RADIUS для всей организации. Если это поле указано, поля host, port и secret будут проигнорированы.
port integer	Порт UDP, на котором сервер RADIUS принимает запросы на доступ.
secret string	Общий секрет клиента RADIUS.
radiusTestingEnabled boolean	Если параметр включен, устройства Meraki будут периодически отправлять этим серверам RADIUS сообщения access-request. Варианты: `false` `true`
urlRedirectWalledGardenEnabled boolean	Включите параметр, чтобы до аутентификации ограничить доступ клиентов определенным набором IP-адресов или имен хостов. Варианты: `false` `true`
urlRedirectWalledGardenRanges list / elements=string	Диапазоны IP-адресов в нотации CIDR, ограничивающие доступ клиентов до аутентификации определенным набором IP-адресов или имен хостов.
voiceVlanClients boolean	Голосовые клиенты с поддержкой 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 Dashboard API Python(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_caller: "{{ meraki_caller }}"
    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
    guestGroupPolicyId: '1234'
    guestPortBouncing: false
    guestSgtId: 1284392014819
    guestVlanId: 100
    hostMode: Single-Host
    increaseAccessSpeed: false
    name: 'Access policy #1'
    networkId: string
    radius:
      authentication:
        mode: Open
      cache:
        enabled: false
        timeout: 24
      criticalAuth:
        dataGroupPolicyId: '1234'
        dataSgtId: 1234
        dataVlanId: 100
        suspendPortBounce: true
        voiceGroupPolicyId: '1234'
        voiceSgtId: 1234
        voiceVlanId: 100
      failedAuthGroupPolicyId: '1234'
      failedAuthSgtId: 1284392014819
      failedAuthVlanId: 100
      preAuthenticationGroupPolicyId: '1234'
      reAuthenticationInterval: 120
    radiusAccountingEnabled: true
    radiusAccountingServers:
      - host: 1.2.3.4
        organizationRadiusServerId: '42'
        port: 22
        secret: secret
    radiusCoaSupportEnabled: false
    radiusGroupAttribute: '11'
    radiusServers:
      - host: 1.2.3.4
        organizationRadiusServerId: '42'
        port: 22
        secret: secret
    radiusTestingEnabled: false
    urlRedirectWalledGardenEnabled: true
    urlRedirectWalledGardenRanges:
      - 192.168.1.0/24
    voiceVlanClients: true
- 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_caller: "{{ meraki_caller }}"
    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
    guestGroupPolicyId: '1234'
    guestPortBouncing: false
    guestSgtId: 1284392014819
    guestVlanId: 100
    hostMode: Single-Host
    increaseAccessSpeed: false
    name: 'Access policy #1'
    networkId: string
    radius:
      authentication:
        mode: Open
      cache:
        enabled: false
        timeout: 24
      criticalAuth:
        dataGroupPolicyId: '1234'
        dataSgtId: 1234
        dataVlanId: 100
        suspendPortBounce: true
        voiceGroupPolicyId: '1234'
        voiceSgtId: 1234
        voiceVlanId: 100
      failedAuthGroupPolicyId: '1234'
      failedAuthSgtId: 1284392014819
      failedAuthVlanId: 100
      preAuthenticationGroupPolicyId: '1234'
      reAuthenticationInterval: 120
    radiusAccountingEnabled: true
    radiusAccountingServers:
      - host: 1.2.3.4
        organizationRadiusServerId: '42'
        port: 22
        secret: secret
        serverId: '2'
    radiusCoaSupportEnabled: false
    radiusGroupAttribute: '11'
    radiusServers:
      - host: 1.2.3.4
        organizationRadiusServerId: '42'
        port: 22
        secret: secret
        serverId: '1'
    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_caller: "{{ meraki_caller }}"
    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

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: {"accessPolicyNumber": "string", "accessPolicyType": "string", "counts": {"ports": {"withThisPolicy": 0}}, "dot1x": {"controlDirection": "string"}, "enforceRadiusMonitoring": true, "guestGroupPolicyId": "string", "guestPortBouncing": true, "guestSgtId": 0, "guestVlanId": {}, "hostMode": "string", "increaseAccessSpeed": true, "name": "string", "radius": {"authentication": {"mode": "string"}, "cache": {"enabled": true, "timeout": 0}, "criticalAuth": {"dataGroupPolicyId": "string", "dataSgtId": 0, "dataVlanId": 0, "suspendPortBounce": true, "voiceGroupPolicyId": "string", "voiceSgtId": 0, "voiceVlanId": 0}, "failedAuthGroupPolicyId": "string", "failedAuthSgtId": 0, "failedAuthVlanId": 0, "preAuthenticationGroupPolicyId": "string", "reAuthenticationInterval": 0}, "radiusAccountingEnabled": true, "radiusAccountingServers": [{"host": "string", "organizationRadiusServerId": "string", "port": 0, "serverId": "string"}], "radiusCoaSupportEnabled": true, "radiusGroupAttribute": "string", "radiusServers": [{"host": "string", "organizationRadiusServerId": "string", "port": 0, "serverId": "string"}], "radiusTestingEnabled": true, "urlRedirectWalledGardenEnabled": true, "urlRedirectWalledGardenRanges": ["string"], "voiceVlanClients": true}

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"accessPolicyNumber": "string", "accessPolicyType": "string", "counts": {"ports": {"withThisPolicy": 0}}, "dot1x": {"controlDirection": "string"}, "enforceRadiusMonitoring": true, "guestGroupPolicyId": "string", "guestPortBouncing": true, "guestSgtId": 0, "guestVlanId": {}, "hostMode": "string", "increaseAccessSpeed": true, "name": "string", "radius": {"authentication": {"mode": "string"}, "cache": {"enabled": true, "timeout": 0}, "criticalAuth": {"dataGroupPolicyId": "string", "dataSgtId": 0, "dataVlanId": 0, "suspendPortBounce": true, "voiceGroupPolicyId": "string", "voiceSgtId": 0, "voiceVlanId": 0}, "failedAuthGroupPolicyId": "string", "failedAuthSgtId": 0, "failedAuthVlanId": 0, "preAuthenticationGroupPolicyId": "string", "reAuthenticationInterval": 0}, "radiusAccountingEnabled": true, "radiusAccountingServers": [{"host": "string", "organizationRadiusServerId": "string", "port": 0, "serverId": "string"}], "radiusCoaSupportEnabled": true, "radiusGroupAttribute": "string", "radiusServers": [{"host": "string", "organizationRadiusServerId": "string", "port": 0, "serverId": "string"}], "radiusTestingEnabled": true, "urlRedirectWalledGardenEnabled": true, "urlRedirectWalledGardenRanges": ["string"], "voiceVlanClients": true}

Авторы

Francisco Munoz (@fmunoz)

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

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