Spec-Zone.ru › Ansible

cisco.meraki.networks_clients_provision модуль — Модуль ресурсов для provision клиентов сетей

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.networks_clients_provision.

Новый в cisco.meraki 2.16.0

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

Описание

  • Управляет операцией создания ресурса provision клиентов сетей.
  • Настраивает клиента с именем и политикой. Клиенты могут быть настроены до подключения к сети.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

clients

список / элементы=словарь

Массив клиентов для настройки.

mac

строка

MAC-адрес клиента. Обязательно.

name

строка

Отображаемое имя клиента. Необязательно. Ограничено 255 байтами.

devicePolicy

строка

Политика, применяемая к указанному клиенту. Может быть «Политика группы», «Разрешено», «Заблокировано», «По подключению» или «Нормально». Обязательно.

groupPolicyId

строка

Идентификатор требуемой политики группы для применения к клиенту. Обязательно, если «devicePolicy» установлено в «Политика группы». В противном случае игнорируется.

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

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

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 ← (по умолчанию)

networkId

string

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

policiesBySecurityAppliance

dictionary

Объект, описывающий ассоциацию политики и подключения для прибора безопасности. (Актуально только если прибор безопасности находится в сети).

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Разрешено’, ‘Заблокировано’ или ‘Нормально’. Требуется.

policiesBySsid

dictionary

Объект, описывающий ассоциации политики и подключения для каждого активного SSID в сети. Ключи — номера активных SSID, сопоставленные с объектом, описывающим политику клиента.

0

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Разрешено’, ‘Заблокировано’, ‘Нормально’ или ‘Политика группы’. Требуется.

groupPolicyId

string

Идентификатор необходимой политики группы для применения к клиенту. Требуется, если ‘devicePolicy’ установлено в «Политика группы». В противном случае игнорируется.

1

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Разрешено’, ‘Заблокировано’, ‘Нормально’ или ‘Политика группы’. Требуется.

groupPolicyId

string

Идентификатор необходимой политики группы для применения к клиенту. Требуется, если ‘devicePolicy’ установлено в «Политика группы». В противном случае игнорируется.

10

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Разрешено’, ‘Заблокировано’, ‘Нормально’ или ‘Политика группы’. Требуется.

groupPolicyId

string

Идентификатор необходимой политики группы для применения к клиенту. Требуется, если ‘devicePolicy’ установлено в «Политика группы». В противном случае игнорируется.

11

dictionary

Номер SSID.
END_OF_DOCUMENT_MARKER

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы для применения к клиенту. Обязательно, если ‘devicePolicy’ установлено в «Group policy». В противном случае игнорируется.

12

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы для применения к клиенту. Обязательно, если ‘devicePolicy’ установлено в «Group policy». В противном случае игнорируется.

13

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы для применения к клиенту. Обязательно, если ‘devicePolicy’ установлено в «Group policy». В противном случае игнорируется.

14

dictionary

Номер SSID.
...
END_OF_DOCUMENT_MARKER

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы, применяемой к клиенту. Требуется, если ‘devicePolicy’ задано как «Group policy». В противном случае игнорируется.

7

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы, применяемой к клиенту. Требуется, если ‘devicePolicy’ задано как «Group policy». В противном случае игнорируется.

8

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы, применяемой к клиенту. Требуется, если ‘devicePolicy’ задано как «Group policy». В противном случае игнорируется.

9

dictionary

Номер SSID.

devicePolicy

string

Политика, применяемая к указанному клиенту. Может быть ‘Allowed’, ‘Blocked’, ‘Normal’ или ‘Group policy’. Обязательно.

groupPolicyId

string

Идентификатор желаемой политики группы, применяемой к клиенту. Требуется, если ‘devicePolicy’ задано как «Group policy». В противном случае игнорируется.

Примечания

Примечание

  • Используемый метод SDK — networks.Networks.provision_network_clients,
  • Используемые пути — post /networks/{networkId}/clients/provision,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki по networks provisionNetworkClients

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

Примеры

- name: Create
  cisco.meraki.networks_clients_provision:
    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}}"
    clients:
    - mac: 00:11:22:33:44:55
      name: Miles's phone
    devicePolicy: Group policy
    groupPolicyId: '101'
    networkId: string
    policiesBySecurityAppliance:
      devicePolicy: Normal
    policiesBySsid:
      '0':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '1':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '10':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '11':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '12':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '13':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '14':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '2':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '3':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '4':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '5':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '6':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '7':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '8':
        devicePolicy: Group policy
        groupPolicyId: '101'
      '9':
        devicePolicy: Group policy
        groupPolicyId: '101'

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"clients": [{"clientId": "string", "mac": "string", "message": "string", "name": "string"}], "devicePolicy": "string", "groupPolicyId": "string"}

Авторы

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

Spec-Zone.ru

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