Модуль cisco.meraki.organizations_inventory_onboarding_cloud_monitoring_prepare — модуль ресурса для organizations _inventory _onboarding _cloudmonitoring _prepare

Примечание

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

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

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

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

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

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

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

Управление операцией create ресурса organizations _inventory _onboarding _cloudmonitoring _prepare.
Инициирует или обновляет сеанс импорта. Будет создан идентификатор импорта, который используется при фиксации импорта.

Примечание

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

Требования

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

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), время ожидания перед повторной попыткой при ошибке параллелизма пакета действий По умолчанию: `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` ← (по умолчанию)
options dictionary	Дополнительные параметры импорта.
skipCommit boolean	Флаг, запрещающий добавление устройства в RDM. Варианты: `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 Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки подключения

См. также

Документация Cisco Meraki для organizations 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_caller: "{{ meraki_caller }}"
    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
    options:
      skipCommit: false
    organizationId: string

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

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

Ключ	Описание
meraki_response list / elements=string	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: ["[\n {\n \"message\": \"string\"", "\n \"udi\": \"string\"", "\n \"deviceId\": \"string\"", "\n \"status\": \"string\"", "\n \"configParams\": {\n \"tunnel\": {\n \"mode\": \"string\"", "\n \"port\": \"string\"", "\n \"host\": \"string\"", "\n \"name\": \"string\"", "\n \"rootCertificate\": {\n \"content\": \"string\"", "\n \"name\": \"string\"\n }\n }", "\n \"cloudStaticIp\": \"string\"", "\n \"user\": {\n \"publicKey\": \"string\"", "\n \"username\": \"string\"", "\n \"secret\": {\n \"hash\": \"string\"\n }\n }\n }\n }\n]\n"]

Ключ

Описание

meraki_response

list / elements=string

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

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

Пример: ["[\n {\n \"message\": \"string\"", "\n \"udi\": \"string\"", "\n \"deviceId\": \"string\"", "\n \"status\": \"string\"", "\n \"configParams\": {\n \"tunnel\": {\n \"mode\": \"string\"", "\n \"port\": \"string\"", "\n \"host\": \"string\"", "\n \"name\": \"string\"", "\n \"rootCertificate\": {\n \"content\": \"string\"", "\n \"name\": \"string\"\n }\n }", "\n \"cloudStaticIp\": \"string\"", "\n \"user\": {\n \"publicKey\": \"string\"", "\n \"username\": \"string\"", "\n \"secret\": {\n \"hash\": \"string\"\n }\n }\n }\n }\n]\n"]

Авторы

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/organizations_inventory_onboarding_cloud_monitoring_prepare_module.html