Spec-Zone.ru › Ansible

модуль cisco.meraki.networks_appliance_ssids – модуль ресурсов для networks _appliance _ssids

Примечание

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

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

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

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

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

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

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

  • Управление операцией обновления ресурса networks _appliance _ssids.
  • Обновление атрибутов SSID MX.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

authMode

string

Метод управления подключением для SSID (‘open’, ‘psk’, ‘8021x-meraki’ или ‘8021x-radius’).

defaultVlanId

integer

Идентификатор VLAN, связанной с этой SSID. Этот параметр допустим, только если сеть работает в режиме маршрутизации.

dhcpEnforcedDeauthentication

dictionary

Принудительная деаутентификация DHCP позволяет отключать беспроводных клиентов в дополнение к обязательному DHCP. Этот параметр допустим только для версий прошивки >= MX 17.0, где для соответствующей локальной сети включен обязательный DHCP.

enabled

boolean

Включить принудительную деаутентификацию DHCP для SSID.

Варианты:

  • false
  • true

dot11w

dictionary

Текущая настройка защищенных кадров управления (802.11w).

enabled

boolean

Включен ли режим 802.11w.

Варианты:

  • false
  • true

required

boolean

(Необязательно) Требуется ли режим 802.11w.

Варианты:

  • false
  • true

enabled

boolean

Включена ли SSID.

Варианты:

  • false
  • true

encryptionMode

string

Режим шифрования PSK для SSID (‘wep’ или ‘wpa’). Этот параметр допустим, только если authMode имеет значение ‘psk’.

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), базовый URL для всех конечных ресурсов

По умолчанию: "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

Имя SSID.

networkId

string

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

number

string

Параметр пути Number.

psk

string

Ключ доступа для SSID. Этот параметр допустим, только если authMode имеет значение ‘psk’.

radiusServers

list / elements=dictionary

Серверы RADIUS 802.1x, используемые для аутентификации. Этот параметр допустим, только если authMode имеет значение ‘8021x-radius’.

host

string

IP-адрес вашего сервера RADIUS.

port

integer

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

secret

string

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

visible

boolean

Логическое значение, указывающее, должна ли MX объявлять эту SSID или скрывать ее.

Варианты:

  • false
  • true

wpaEncryptionMode

string

Типы шифрования WPA (‘WPA1 and WPA2’, ‘WPA2 only’, ‘WPA3 Transition Mode’ или ‘WPA3 only’). Этот параметр допустим только в следующих случаях: (1) authMode имеет значение ‘psk’, а encryptionMode — ‘wpa’; (2) authMode имеет значение ‘8021x-meraki’; или (3) authMode имеет значение ‘8021x-radius’.

Примечания

Примечание

  • Используемые методы SDK: appliance.Appliance.update_network_appliance_ssid,
  • Используемые пути: put /networks/{networkId}/appliance/ssids/{number},
  • Не поддерживает check_mode
  • Плагин выполняется на управляющем узле и не использует подключаемые модули соединения Ansible, а использует встроенный менеджер подключений
  • из Cisco Dashboard API Python(SDK)
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki по appliance updateNetworkApplianceSsid

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

Примеры

- name: Update by id
  cisco.meraki.networks_appliance_ssids:
    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
    authMode: 8021x-radius
    defaultVlanId: 1
    dhcpEnforcedDeauthentication:
      enabled: true
    dot11w:
      enabled: true
      required: true
    enabled: true
    encryptionMode: wpa
    name: My SSID
    networkId: string
    number: string
    psk: psk
    radiusServers:
      - host: 0.0.0.0
        port: 1000
        secret: secret
    visible: true
    wpaEncryptionMode: WPA2 only

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"authMode": "string", "defaultVlanId": 0, "enabled": true, "encryptionMode": "string", "name": "string", "number": 0, "radiusServers": [{"host": "string", "port": 0}], "visible": true, "wpaEncryptionMode": "string"}

Авторы

  • 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_appliance_ssids_module.html

Spec-Zone.ru

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