Модуль cisco.meraki.meraki_action_batch — управление заданиями пакетных действий в панели управления Meraki.

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.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

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

Позволяет управлять заданиями пакетных действий Meraki.

Параметры

Параметр	Комментарии
action_batch_id string	ID существующего задания пакетных действий.
actions list / elements=dictionary	Список действий, которые должно выполнить задание.
body any	Обязательное тело действия.
operation string	Тип операции действия Варианты: `"create"` `"destroy"` `"update"` `"claim"` `"bind"` `"split"` `"unbind"` `"combine"` `"update_order"` `"cycle"` `"swap"` `"assignSeats"` `"move"` `"moveSeats"` `"renewSeats"`
resource string	Путь к ресурсу пакетных действий.
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
confirmed boolean	Следует ли выполнить задание. Варианты: `false` ← (по умолчанию) `true`
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
net_id string	ID сети, если применимо.
net_name string	Имя сети, если применимо.
org_id string	ID организации.
org_name псевдонимы: organization string	Имя организации.
output_format string	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочных сообщений во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки, если сработало ограничение частоты запросов. По умолчанию: `165`
state string	Указывает, следует ли искать, создавать или удалять задание пакетных действий. Варианты: `"query"` `"present"` ← (по умолчанию) `"absent"`
synchronous boolean	Является ли задание синхронным или асинхронным. Варианты: `false` `true` ← (по умолчанию)
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
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. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki в Ansible прекратят поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в 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 dictionary	Список действий, связанных с заданием. Возвращается: success
confirmed boolean	Подтверждено ли выполнение задания пакетных действий. Возвращается: success
id string	Уникальный ID задания пакетных действий. Возвращается: success Пример: `"123"`
organization_id string	Уникальный ID организации, которой принадлежит пакетное задание. Возвращается: success Пример: `"2930418"`
status complex	Сведения о состоянии задания пакетных действий. Возвращается: success
completed boolean	Завершено ли задание. Возвращается: success
created_resources list / elements=string	Список ресурсов, созданных во время выполнения. Возвращается: success Пример: `[{"id": 100, "uri": "/networks/L_XXXXX/groupPolicies/100"}]`
errors list / elements=string	Список ошибок, если таковые возникли во время выполнения. Возвращается: success
failed boolean	Завершилось ли выполнение задания пакетных действий с ошибкой. Возвращается: success
synchronous boolean	Выполняется ли задание пакетных действий синхронно или асинхронно. Возвращается: success

Статус

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

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

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