Spec-Zone.ru › Ansible

модуль cisco.meraki.meraki_ms_stack — изменение конфигурации стека коммутаторов в Meraki.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

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

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

  • УСТАРЕЛО
  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалено в:

версии 3.0.0

Причина:

Выпущены обновлённые модули с расширенными функциональными возможностями

Альтернатива:

cisco.meraki.networks_switch_stacks

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

  • Позволяет изменять стеки коммутаторов Meraki MS.

Параметры

Параметр

Комментарии

auth_key

string / обязательный

Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды MERAKI_KEY не задана.

host

string

Имя хоста панели управления Meraki.

Можно использовать для доступа к региональным средам Meraki, например в Китае.

По умолчанию: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд до повтора запроса в случае, если сервер возвращает внутреннюю ошибку.

По умолчанию: 60

name

string

Имя стека.

net_id

string

Идентификатор сети, в которой находится межсетевой экран MX.

net_name

string

Имя сети, в которой находится межсетевой экран MX.

org_id

string

Идентификатор организации.

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

serials

list / элементы=string

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

stack_id

string

Идентификатор стека, который требуется изменить или удалить.

state

string

Создать или изменить организацию.

Варианты:

  • "present" ← (по умолчанию)
  • "query"
  • "absent"

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: Create new stack
  meraki_switch_stack:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test stack
    serials:
      - "ABCD-1231-4579"
      - "ASDF-4321-0987"

- name: Add switch to stack
  meraki_switch_stack:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987
    serials:
      - "ABCD-1231-4579"

- name: Remove switch from stack
  meraki_switch_stack:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987
    serials:
      - "ABCD-1231-4579"

- name: Query one stack
  meraki_switch_stack:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987

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

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

Ключ

Описание

data

complex

Настройки VPN.

Возвращается: при успехе

id

string

Идентификатор стека коммутаторов.

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

Пример: "7636"

name

string

Описательное имя стека коммутаторов.

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

Пример: "MyStack"

serials

list / элементы=string

Список серийных номеров коммутаторов в стеке.

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

Пример: ["QBZY-XWVU-TSRQ", "QBAB-CDEF-GHIJ"]

Статус

  • Этот модуль будет удалён в версии 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_ms_stack_module.html

Spec-Zone.ru

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