Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_floor_plans_auto_locate_jobs_recalculate — модуль ресурса для networks _floor _plans _auto _locate _jobs _recalculate

Примечание

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

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

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

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

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

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

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

  • Управление операцией создания ресурса networks _floor _plans _auto _locate _jobs _recalculate.
  • Запуск пересчёта автоматического определения местоположения для задания с возможностью задать точки привязки.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

devices

list / элементы=dictionary

Список устройств, для которых нужно обновить позиции точек привязки.

autoLocate

dictionary

Позиция автоматического определения местоположения для этого устройства.

isAnchor

boolean

Следует ли сохранить это местоположение как заданную пользователем точку привязки.

Варианты:

  • false
  • true

lat

float

Широта.

lng

float

Долгота.

serial

string

Серийный номер устройства, которое нужно обновить.

jobId

string

Параметр пути JobId. Идентификатор задания.

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

networkId

string

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

Примечания

Примечание

  • Используемый метод SDK: networks.Networks.recalculate_network_floor_plans_auto_locate_job,
  • Используемый путь: post /networks/{networkId}/floorPlans/autoLocate/jobs/{jobId}/recalculate,
  • Не поддерживает check_mode
  • Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
  • из Cisco Dashboard API Python(SDK)
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

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

Полный справочник по API recalculateNetworkFloorPlansAutoLocateJob.

Примеры

- name: Create
  cisco.meraki.networks_floor_plans_auto_locate_jobs_recalculate:
    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 }}"
    devices:
      - autoLocate:
          isAnchor: true
          lat: 37.4180951010362
          lng: -122.098531723022
        serial: Q234-ABCD-5678
    jobId: string
    networkId: string

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"success": 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_floor_plans_auto_locate_jobs_recalculate_module.html

Spec-Zone.ru

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