Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_clients_provision — модуль ресурсов для networks _clients _provision

Примечание

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

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

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

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

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

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

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

  • Управление операцией создания ресурса networks _clients _provision.
  • Создаёт подготовленную запись клиента с именем и политикой. Записи клиентов можно создавать до их подключения к сети.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

clients

list / elements=dictionary

Массив клиентов для подготовки.

mac

string

MAC-адрес клиента. Обязательный параметр.

name

string

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

devicePolicy

string

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

groupPolicyId

string

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

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), время ожидания перед повтором после ошибки 429 от Nginx

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

networkId

string

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

policiesBySecurityAppliance

dictionary

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

devicePolicy

string

Политика, применяемая к указанному клиенту. Возможные значения: ‘Allowed’, ‘Blocked’ или ‘Normal’. Обязательный параметр.

policiesBySsid

dictionary

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

0

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

1

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

10

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

11

dictionary

Номер SSID.

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.

devicePolicy

string

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

groupPolicyId

string

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

2

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

3

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

4

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

5

dictionary

Номер SSID.

devicePolicy

string

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

groupPolicyId

string

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

6

dictionary

Номер SSID.

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 Dashboard API Python (SDK)
  • Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения

См. также

См. также

Документация 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_caller: "{{ meraki_caller }}"
    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

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

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

Пример: {"clients": [{"clientId": "string", "mac": "string", "message": "string", "name": "string"}], "devicePolicy": "string", "groupPolicyId": "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_clients_provision_module.html

Spec-Zone.ru

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