Модуль cisco.meraki.organizations_action_batches – Модуль ресурсов для организаций _actionbatches

Примечание

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

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

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

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

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

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

Описание

Управление операциями создания, обновления и удаления ресурсов организаций _actionbatches.
Создание пакета действий.
Удаление пакета действий.
Обновление пакета действий.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
actionBatchId строка	Параметр пути actionBatchId. Идентификатор группы действий.
actions список / элементы=словарь	Набор изменений, которые необходимо внести в рамках этого действия (<a href=’https //developer.cisco.com/meraki/api/#… details</a>).
body словарь	Тело действия.
operation строка	Операция, которая должна быть выполнена.
resource строка	Уникальный идентификатор ресурса, над которым будет выполняться действие.
callback словарь	Детали обратного вызова. Укажите либо httpServerId, либо url и sharedSecret.
httpServer словарь	Получатель веб-хука, используемый для веб-хука обратного вызова.
id строка	Идентификатор получателя веб-хука, который получит информацию. При указании этого поля оставьте поля url и sharedSecret пустыми.
payloadTemplate словарь	Шаблон полезной нагрузки веб-хука, используемого для обратного вызова.
id строка	Идентификатор шаблона полезной нагрузки. По умолчанию для обратного вызова (включенного) шаблона используется «wpt_00005».
sharedSecret строка	Секретный ключ, который будет включен в запросы, отправленные на URL обратного вызова. Он может использоваться для проверки того, что запрос отправлен Meraki. Если используется это поле, укажите также url.
url строка	URL обратного вызова для целевого веб-хука. Если используется это поле, укажите также sharedSecret.
confirmed логическое	Установите в значение true для немедленного выполнения. Установите в значение false, если действие должно быть предварительно просмотрено перед выполнением. Это свойство нельзя сбросить, когда оно равно true. По умолчанию равно false. Варианты: `false` `true`
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки ошибки параллельности группы действий Значение по умолчанию: `60`
meraki_api_key строка / требуется	meraki_api_key (строка), ключ API, сгенерированный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), предшествующая всем ресурсам конечных точек Значение по умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID Значение по умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная среды MERAKI_PYTHON_SDK_CALLER Значение по умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси Значение по умолчанию: `""`
meraki_inherit_logging_config логическое	meraki_inherit_logging_config (логическое), наследование собственного экземпляра логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала, дополненное датой и отметкой времени Значение по умолчанию: `"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 (целое число), время ожидания повтора запроса Nginx 429 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 (логическое значение), отключить все ведение журнала? тогда вы сами за себя! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторить попытку, если возникла ошибка ограничения скорости 429? Choices: `false` `true` ← (default)
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
synchronous boolean	Установите значение true, чтобы принудительно запустить пакет синхронно. В синхронном пакете может быть не более 20 действий. По умолчанию — false. Choices: `false` `true`

Примечания

Примечание

Используемые методы SDK — organizations.Organizations.create_organization_action_batch, organizations.Organizations.delete_organization_action_batch, organizations.Organizations.update_organization_action_batch,
Используемые пути — post /organizations/{organizationId}/actionBatches, delete /organizations/{organizationId}/actionBatches/{actionBatchId}, put /organizations/{organizationId}/actionBatches/{actionBatchId},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления соединения

См. также

Документация Cisco Meraki для организаций createOrganizationActionBatch: Полное описание API createOrganizationActionBatch.
Документация Cisco Meraki для организаций deleteOrganizationActionBatch: Полное описание API deleteOrganizationActionBatch.
Документация Cisco Meraki для организаций updateOrganizationActionBatch: Полное описание API updateOrganizationActionBatch.

Примеры

- name: Create
  cisco.meraki.organizations_action_batches:
    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
    actions:
    - operation: create
      resource: /devices/QXXX-XXXX-XXXX/switch/ports/3
    callback:
      httpServer:
        id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
      payloadTemplate:
        id: wpt_2100
      sharedSecret: secret
      url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
    confirmed: true
    organizationId: string
    synchronous: true

- name: Delete by id
  cisco.meraki.organizations_action_batches:
    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
    actionBatchId: string
    organizationId: string

- name: Update by id
  cisco.meraki.organizations_action_batches:
    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
    actionBatchId: string
    confirmed: true
    organizationId: string
    synchronous: false

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

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"actions": [{"body": {}, "operation": "string", "resource": "string"}], "callback": {"id": "string", "status": "string", "url": "string"}, "confirmed": true, "id": "string", "organizationId": "string", "status": {"completed": true, "createdResources": [{"id": "string", "uri": "string"}], "errors": ["string"], "failed": true}, "synchronous": true}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"actions": [{"body": {}, "operation": "string", "resource": "string"}], "callback": {"id": "string", "status": "string", "url": "string"}, "confirmed": true, "id": "string", "organizationId": "string", "status": {"completed": true, "createdResources": [{"id": "string", "uri": "string"}], "errors": ["string"], "failed": true}, "synchronous": true}

Авторы

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_action_batches_module.html