Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_inventory_onboarding_cloud_monitoring_prepare — Модуль ресурсов для организации _инвентаризации_ _загрузки_ _облачного_ _мониторинга_ _подготовки_

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

Описание

  • Управляет операцией создания ресурса организации _инвентаризации_ _загрузки_ _облачного_ _мониторинга_ _подготовки_.
  • Инициализирует или обновляет сеанс импорта. Будет сгенерирован идентификатор импорта, который будет использован, когда вы будете готовы подтвердить импорт.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

devices

list / elements=dictionary

Набор устройств для импорта (или обновления).

sudi

string

Сертификат SUDI устройства.

tunnel

dictionary

Параметры, связанные с TLS.

certificateName

string

Имя настроенного сертификата TLS.

localInterface

integer

Номер VLAN, который предполагается использовать для подключения к облаку.

loopbackNumber

integer

Номер настроенного интерфейса Loopback, используемого для TLS-оверлея.

name

string

Имя настроенного TLS-туннеля.

user

dictionary

Параметры пользователя.

username

string

Имя пользователя устройства для мониторинга Meraki.

vty

dictionary

Параметры, связанные с VTY.

accessList

dictionary

Подробности AccessList.

vtyIn

dictionary

ACL для входящего VTY.

name

string

Имя.

vtyOut

dictionary

ACL для исходящего VTY.

name

string

Имя.

authentication

dictionary

AAA-аутентификация VTY.

group

dictionary

Подробности группы.

name

string

Имя группы.

authorization

dictionary

AAA-авторизация VTY.

group

dictionary

Подробности группы.

name

string

Имя группы.

endLineNumber

integer

Конечный номер линии VTY.

rotaryNumber

integer

Номер SSH-ротации.

startLineNumber

integer

Начальный номер линии VTY.

meraki_action_batch_retry_wait_time

integer

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

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

integer

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

Default: 60

meraki_simulate

boolean

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

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

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

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

organizationId

string

Параметр пути OrganizationId. Идентификатор организации.

Примечания

Примечание

  • Используемые методы SDK: organizations.Organizations.create_organization_inventory_onboarding_cloud_monitoring_prepare,
  • Используемые пути: post /organizations/{organizationId}/inventory/onboarding/cloudMonitoring/prepare,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki для создания организации createOrganizationInventoryOnboardingCloudMonitoringPrepare

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

Примеры

- name: Create
  cisco.meraki.organizations_inventory_onboarding_cloud_monitoring_prepare:
    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}}"
    devices:
    - sudi: "-----BEGIN CERTIFICATE-----\n        MIIDyTCCArGgAwIBAgIKBBNXOVCGU1YztjANBgkqhkiG9w0BAQsFADAnMQ4wDAYD\n\
        \        VQQKEwVDaXNjbzEVMBMGA1UEAxMMQUNUMiBTVURJIENBMB4XDTIxMDUzMTEzNTUx\n  \
        \      NVoXDTI5MDUxNDIwMjU0MVowbTEpMCcGA1UEBRMgUElEOkM5MjAwTC0yNFAtNEcg\n    \
        \    U046SkFFMjUyMjBSMksxDjAMBgNVBAoTBUNpc2NvMRgwFgYDVQQLEw9BQ1QtMiBM\n      \
        \  aXRlIFNVREkxFjAUBgNVBAMTDUM5MjAwTC0yNFAtNEcwggEiMA0GCSqGSIb3DQEB\n        AQUAA4IBDwAwggEKAoIBAQDaUPxW76g...
        \        TR1TuP36bHh13X3vtGiDsCD88Ci2TZIqd/EDkkc7v9ipUUYVVH+YDrPt2Aukb1PH\n  \
        \      D6K0R+KhgEzRo5x54TlU6oWvjUpwNZUwwdhMWIQaUVkMyZBYNy0jGPLO8jwZhyBg\n    \
        \    1Fneybr9pwedGbLrAaz+gdEikB8B4a/fvPjVfL5Ngb4QRjFqWuE+X3nLc0kHedep\n      \
        \  6nfgpUNXMlStVm5nIXKP6OjmzfCHPYh9L2Ehs1TrSk1ser9Ofx0ZMVL/jBZR2EIj\n        OZ8tH6KlX2/B2pbSPIO6kD5c4UA8Cf1...
        \        VR0PAQH/BAQDAgXgMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUSNjx8cJw1Vu7\n  \
        \      fHMJk6+4uDAD+H8wTQYDVR0RBEYwRKBCBgkrBgEEAQkVAgOgNRMzQ2hpcElEPVVV\n    \
        \    VUNNaElGcUVFMklFUUVBQWNBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUE9MB0GA1Ud\n      \
        \  DgQWBBRdhMkFD/z5hokaQeLbaRsp4hkvbzANBgkqhkiG9w0BAQsFAAOCAQEAMtuh\n        YpBz4xEZ7YdJsLpw67Q0TTJGnTBRpzA...
        \        OwmH/iZ+tDfYQ3W3ElWTW93871DkuW4WQIfbnoHg/F7bF0DKYVkD3rpZjyz3NhzH\n  \
        \      d7cjTdJXQ85bTAOXDuxKH3qewrXxxOGXgh3I6NUq0UwMTWh84lND7Jl+ZAQkYNS2\n    \
        \    iHanTZFQBk3ML0NUb7fKDYGRTZRqwQ/upIO4S6LV1cxH/6V0qbMy3sCSHZoMLrW3\n      \
        \  0m3M6yKpe5+VZzHZwmWdUf3Ot+zKjhveK5/YNsMIASdvtvymxUizq2Hr1hvR/kPc\n        p1vuyWxipU8JfzOh/A==\n\
        \        -----END CERTIFICATE-----\n        "
      tunnel:
        certificateName: DeviceSUDI
        localInterface: 1
        loopbackNumber: 1000
        name: MERAKI
      user:
        username: Meraki
      vty:
        accessList:
          vtyIn:
            name: MERAKI_IN
          vtyOut:
            name: MERAKI_OUT
        authentication:
          group:
            name: ''
        authorization:
          group:
            name: MERAKI
        endLineNumber: 17
        rotaryNumber: 50
        startLineNumber: 16
    organizationId: string

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

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

Ключ

Описание

meraki_response

list / elements=string

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

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

Пример: ["[\n  {\n    \"configParams\": {\n      \"cloudStaticIp\": \"string\"", "\n      \"tunnel\": {\n        \"host\": \"string\"", "\n        \"mode\": \"string\"", "\n        \"name\": \"string\"", "\n        \"port\": \"string\"", "\n        \"rootCertificate\": {\n          \"content\": \"string\"", "\n          \"name\": \"string\"\n        }\n      }", "\n      \"user\": {\n        \"publicKey\": \"string\"", "\n        \"secret\": {\n          \"hash\": \"string\"\n        }", "\n        \"username\": \"string\"\n      }\n    }", "\n    \"deviceId\": \"string\"", "\n    \"message\": \"string\"", "\n    \"status\": \"string\"", "\n    \"udi\": \"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/organizations_inventory_onboarding_cloud_monitoring_prepare_module.html

Spec-Zone.ru

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