Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_policies_by_client_info – Информационный модуль для сетей _policies _byclient

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

Обзор

  • Получение всех сетевых _policies _byclient.
  • Получение политик для всех клиентов с политиками.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница

Default: "https://api.meraki.com/api/v1"

endingBefore

string

Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна его определять.

headers

dictionary

Дополнительные заголовки.

meraki_action_batch_retry_wait_time

integer

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

Default: 60

meraki_api_key

string / required

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

meraki_base_url

string

meraki_base_url (строка), предшествует всем конечным ресурсам

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

Default: ""

meraki_caller

string

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

Default: ""

meraki_certificate_path

string

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

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение), наследует собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), имя файла журнала с добавлением даты и времени

Default: "meraki_api_"

meraki_log_path

string

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

Default: ""

meraki_maximum_retries

integer

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

Default: 2

meraki_nginx_429_retry_wait_time

integer

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

Default: 60

meraki_output_log

boolean

meraki_output_log (логическое значение), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (логическое значение), выводить выходные данные журнала в консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

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

Default: ""

meraki_retry_4xx_error

boolean

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

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

целое число

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

Значение по умолчанию: 60

meraki_simulate

логическое значение

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

Допустимые значения:

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

meraki_single_request_timeout

целое число

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

Значение по умолчанию: 60

meraki_suppress_logging

логическое значение

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

Допустимые значения:

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

meraki_use_iterator_for_get_pages

логическое значение

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

Допустимые значения:

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

meraki_wait_on_rate_limit

логическое значение

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

Допустимые значения:

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

networkId

строка

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

perPage

целое число

Параметр запроса perPage. Количество записей на страницу, возвращаемых. Допустимый диапазон 3 - 1000. По умолчанию 50.

startingAfter

строка

Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.

t0

строка

Параметр запроса T0. Начало временного интервала для данных. Максимальный период просмотров составляет 31 день от текущей даты.

timespan

число с плавающей точкой

Параметр запроса Timespan. Временной интервал, для которого будут извлечены данные. Если вы указываете временной интервал, не указывайте параметр t0. Значение должно быть в секундах и не должно превышать 31 день. По умолчанию 1 день.

total_pages

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

total_pages(целое число), используется с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

  • Используемый метод SDK: networks.Networks.get_network_policies_by_client,
  • Используемые пути: get /networks/{networkId}/policies/byClient,
  • Поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco Meraki SDK
  • Параметры, начинающиеся с meraki_, используются Cisco Meraki Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki для сети getNetworkPoliciesByClient

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

Примеры

- name: Get all networks _policies _byclient
  cisco.meraki.networks_policies_by_client_info:
    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}}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    t0: string
    timespan: 0
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n  {\n    \"assigned\": [\n      {\n        \"groupPolicyId\": \"string\",\n        \"name\": \"string\",\n        \"ssid\": [\n          {\n            \"ssidNumber\": 0\n          }\n        ],\n        \"type\": \"string\"\n      }\n    ],\n    \"clientId\": \"string\",\n    \"name\": \"string\"\n  }\n]\n"

Авторы

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

Spec-Zone.ru

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