Модуль cisco.meraki.networks_floor_plans — Модуль ресурсов для floorplans сетей
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.18.2).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: cisco.meraki.networks_floor_plans.
Добавлен в cisco.meraki 2.16.0
Обзор
- Управление операциями создания, обновления и удаления ресурсов networks_floorplans.
- Загрузка плана этажа.
- Удаление плана этажа.
- Обновление геолокации и других метаданных плана этажа.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
bottomLeftCorner dictionary | Долгота и широта левого нижнего угла вашего плана этажа. |
|
lat float |
Широта. |
|
lng float |
Долгота. |
bottomRightCorner dictionary | Долгота и широта правого нижнего угла вашего плана этажа. |
|
lat float |
Широта. |
|
lng float |
Долгота. |
center dictionary | Долгота и широта центра вашего плана этажа. Необходимо указать «center» или два смежных угла (например, «topLeftCorner» и «bottomLeftCorner»). Если указан «center», план этажа размещается над этой точкой без поворота. Если указаны два смежных угла, план этажа поворачивается, чтобы выровняться с двумя указанными точками. Соотношение сторон изображения плана этажа сохраняется независимо от того, какие углы/центр указаны. (Это означает, что если указано более двух углов, для сохранения соотношения сторон плана этажа могут использоваться только два угла). Никакие две точки не могут иметь одинаковые координаты широты и долготы. |
|
lat float |
Широта. |
|
lng float |
Долгота. |
floorPlanId string | Параметр пути FloorPlanId. Идентификатор плана этажа. |
imageContents string | Содержание файла (строка, закодированная в base64) вашего изображения. Поддерживаемые форматы: PNG, GIF и JPG. Обратите внимание, что все изображения сохраняются как файлы PNG, независимо от того, в каком формате они загружаются. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки Default: |
meraki_api_key string / required | meraki_api_key (string), API ключ, сгенерированный на панели управления; может также быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), предшествует всем конечным точкам ресурсов Default: |
meraki_be_geo_id string | meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID Default: |
meraki_caller string | meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER Default: |
meraki_certificate_path string | meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер Default: |
meraki_inherit_logging_config boolean | meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Choices:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: |
meraki_log_path string | log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог сценария, если не указано иное Default: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), Время ожидания повторной попытки Nginx 429 Default: |
meraki_output_log boolean | meraki_output_log (boolean), создать файл журнала вывода? Choices:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить журнал в консоль? Choices:
|
meraki_requests_proxy string | meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Choices:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX Default: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить весь ведение журнала? тогда вы сами за себя! Choices:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторять попытку при возникновении ошибки ограничения скорости 429? Choices:
|
name string | Название вашего плана этажа. |
networkId string | NetworkId параметр пути. Идентификатор сети. |
topLeftCorner dictionary | Долгота и широта левого верхнего угла вашего плана этажа. |
|
lat float |
Широта. |
|
lng float |
Долгота. |
topRightCorner dictionary | Долгота и широта правого верхнего угла вашего плана этажа. |
|
lat float |
Широта. |
|
lng float |
Долгота. |
Примечания
Примечание
- Используемые методы SDK: networks.Networks.create_network_floor_plan, networks.Networks.delete_network_floor_plan, networks.Networks.update_network_floor_plan,
- Используемые пути: post /networks/{networkId}/floorPlans, delete /networks/{networkId}/floorPlans/{floorPlanId}, put /networks/{networkId}/floorPlans/{floorPlanId},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления соединения
См. также
См. также
- Документация Cisco Meraki по API для создания плана сети
-
Полное описание API createNetworkFloorPlan.
- Документация Cisco Meraki по API для удаления плана сети
-
Полное описание API deleteNetworkFloorPlan.
- Документация Cisco Meraki по API для обновления плана сети
-
Полное описание API updateNetworkFloorPlan.
Примеры
- name: Create
cisco.meraki.networks_floor_plans:
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}}"
state: present
bottomLeftCorner:
lat: 37.770040510499996
lng: -122.38714009525
bottomRightCorner:
lat: 37.770040510499996
lng: -122.38714009525
center:
lat: 37.770040510499996
lng: -122.38714009525
imageContents: 2a9edd3f4ffd80130c647d13eacb59f3
name: HQ Floor Plan
networkId: string
topLeftCorner:
lat: 37.770040510499996
lng: -122.38714009525
topRightCorner:
lat: 37.770040510499996
lng: -122.38714009525
- name: Delete by id
cisco.meraki.networks_floor_plans:
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}}"
state: absent
floorPlanId: string
networkId: string
- name: Update by id
cisco.meraki.networks_floor_plans:
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}}"
state: present
bottomLeftCorner:
lat: 37.770040510499996
lng: -122.38714009525
bottomRightCorner:
lat: 37.770040510499996
lng: -122.38714009525
center:
lat: 37.770040510499996
lng: -122.38714009525
floorPlanId: string
imageContents: 2a9edd3f4ffd80130c647d13eacb59f3
name: HQ Floor Plan
networkId: string
topLeftCorner:
lat: 37.770040510499996
lng: -122.38714009525
topRightCorner:
lat: 37.770040510499996
lng: -122.38714009525
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
meraki_response словарь | Словарь или список, содержащий ответ, возвращённый Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на сборку
© 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_floor_plans_module.html
