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

Примечание

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

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

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

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

Новая в cisco.meraki 1.3.0

УСТАНОВЛЕНО
Описание
Параметры
Примечания
Примеры
Значения возврата
Статус

УСТАНОВЛЕНО

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

Описание

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

Параметры

Параметр	Комментарии
auth_key строка / обязательный	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутреннего сервера. По умолчанию: `60`
name строка	Название стека.
net_id строка	ID сети, в которой находится брандмауэр MX.
net_name строка	Название сети, в которой находится брандмауэр MX.
org_id строка	ID организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать для ключей ответа snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите объем отладочной информации во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. По умолчанию: `165`
serials список / элементы=строка	Список серийных номеров коммутаторов, которые следует включить или исключить из стека.
stack_id строка	ID стека, который нужно изменить или удалить.
state строка	Создание или изменение организации. Варианты: `"present"` ← (по умолчанию) `"query"` `"absent"`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https булево	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy булево	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs булево	Включает проверку HTTP-сертификатов. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Не все действия являются идемпотентными. В частности, создание нового стека приведет к ошибке, если какой-либо коммутатор уже находится в стеке.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, установите переменную среды ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод camel case в Ansible 2.13. Пожалуйста, обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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 сложное	Настройки VPN. Возвращается: успешно
id строка	ID стека коммутаторов. Возвращается: всегда Пример: `"7636"`
name строка	Описание стека коммутаторов. Возвращается: всегда Пример: `"MyStack"`
serials список / элементы=строка	Список серийных номеров в стеке коммутаторов. Возвращается: всегда Пример: `["QBZY-XWVU-TSRQ", "QBAB-CDEF-GHIJ"]`

Статус

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