Модуль cisco.meraki.meraki_action_batch – Управление заданиями Action Batch в панели Meraki.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki.

Для использования в книге задач укажите: cisco.meraki.meraki_action_batch.

УСТАРЕВШИЙ
Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕВШИЙ

Удален в:: версии 3.0.0
Почему:: Обновленные модули с повышенной функциональностью
Альтернатива:: cisco.meraki.organizations_action_batches

Описание

Позволяет управлять заданиями Action Batch для Meraki.

Параметры

Параметр	Комментарии
action_batch_id строка	ID существующей задачи Action Batch.
actions список / элементы=словарь	Список действий, которые должна выполнить задача.
body любой	Требуемое тело действия.
operation строка	Тип операции действия Выбор: `"create"` `"destroy"` `"update"` `"claim"` `"bind"` `"split"` `"unbind"` `"combine"` `"update_order"` `"cycle"` `"swap"` `"assignSeats"` `"move"` `"moveSeats"` `"renewSeats"`
resource строка	Путь к ресурсу Action Batch.
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
confirmed булево	Выполнять ли задачу. Выбор: `false` ← (по умолчанию) `true`
host строка	Имя хоста панели управления Meraki. Может быть использован для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер вернул ошибку внутренней серверной ошибки. По умолчанию: `60`

END_OF_DOCUMENT_MARKER

use_proxy boolean	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Подтверждать ли HTTP-сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Этот модуль находится в активной разработке, и интерфейс может изменяться.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible перестанут поддерживать вывод в формате camelCase в Ansible 2.13. Пожалуйста, обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в API для проверки изменений.

Примеры

- name: Query all Action Batches
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Query one Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: query
    action_batch_id: 12345
  delegate_to: localhost

- name: Create an Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: present
    actions:
    - resource: '/organizations/org_123/networks'
      operation: 'create'
      body:
        name: 'AnsibleActionBatch1'
        productTypes:
          - 'switch'
  delegate_to: localhost

- name: Update Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: present
    action_batch_id: 12345
    synchronous: false

- name: Create an Action Batch job with multiple actions
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: present
    actions:
    - resource: '/organizations/org_123/networks'
      operation: 'create'
      body:
        name: 'AnsibleActionBatch2'
        productTypes:
          - 'switch'
    - resource: '/organizations/org_123/networks'
      operation: 'create'
      body:
        name: 'AnsibleActionBatch3'
        productTypes:
          - 'switch'
  delegate_to: localhost

- name: Delete an Action Batch job
  meraki_action_batch:
    auth_key: abc123
    org_name: YourOrg
    state: absent
    action_batch_id: 12345
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация об заданиях пакетных действий. Возвращается: всегда
actions словарь	Список действий, связанных с заданием. Возвращается: успешно
confirmed boolean	Подтверждено ли задание пакетных действий для выполнения. Возвращается: успешно
id строка	Уникальный идентификатор задания пакетных действий. Возвращается: успешно Пример: `"123"`
organization_id строка	Уникальный идентификатор организации, владеющей заданием. Возвращается: успешно Пример: `"2930418"`
status complex	Информация о состоянии задания пакетных действий. Возвращается: успешно
completed boolean	Завершено ли задание. Возвращается: успешно
created_resources список / элементы=строка	Список ресурсов, созданных во время выполнения. Возвращается: успешно Пример: `[{"id": 100, "uri": "/networks/L_XXXXX/groupPolicies/100"}]`
errors список / элементы=строка	Список ошибок, если таковые имеются, созданных во время выполнения. Возвращается: успешно
failed boolean	Выполнено ли задание пакетных действий неудачно. Возвращается: успешно
synchronous boolean	Выполняется ли задание пакетных действий синхронно или асинхронно. Возвращается: успешно

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Для получения дополнительной информации см. УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на сборку

© 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/meraki_action_batch_module.html