cisco.meraki.meraki_ms_stack – Изменение конфигурации стекирования коммутаторов Meraki.
Примечание
Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).
Для его установки используйте: ansible-galaxy collection install cisco.meraki.
Для использования в плейбуке укажите: cisco.meraki.meraki_ms_stack.
Новое в версии 1.3.0: модуля cisco.meraki
Обзор
- Позволяет изменять стеки коммутаторов Meraki MS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_key строка / обязательно | Ключ аутентификации, предоставленный на панели управления. Требуется, если переменная среды MERAKI_KEY не установлена. | |
| host строка | Значение по умолчанию: "api.meraki.com" | Имя хоста панели управления Meraki. Может быть использовано для доступа к региональным средам Meraki, например, Китая. |
| internal_error_retry_time целое число | Значение по умолчанию: 60 | Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки. |
| name строка | Имя стека. | |
| net_id строка | Идентификатор сети, в которой находится брандмауэр MX. | |
| net_name строка | Имя сети, в которой находится брандмауэр MX. | |
| org_id строка | Идентификатор организации. | |
| org_name строка | Имя организации. псевдонимы: organization | |
| output_format строка |
| Указывает модулю, нужно ли использовать ключи ответа в формате snake case (например, net_id) или camel case (например, netId). |
| output_level строка |
| Устанавливает объем отладочной информации во время выполнения модуля. |
| rate_limit_retry_time целое число | Значение по умолчанию: 165 | Количество секунд для повторной попытки, если срабатывает ограничитель скорости. |
| serials список / элементы=строка | Список серийных номеров коммутаторов, которые следует добавить или удалить из стека. | |
| stack_id строка | Идентификатор стека, который необходимо изменить или удалить. | |
| state строка |
| Создать или изменить организацию. |
| timeout целое число | Значение по умолчанию: 30 | Время ожидания для HTTP-запросов. |
| use_https булево |
| Если no, то будет использоваться HTTP. В противном случае будет использоваться HTTPS.Полезно только для внутренних разработчиков Meraki. |
| use_proxy булево |
| Если no, то прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. |
| validate_certs булево |
| Подтверждать ли сертификаты HTTP. |
Примечания
Примечание
- Не все действия являются идемпотентными. В частности, создание нового стека вызовет ошибку, если какой-либо коммутатор уже входит в стек.
- Дополнительную информацию об 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 сложная | success | Настройки VPN. | |
| id строка | всегда | Идентификатор стека коммутаторов. Пример: 7636 | |
| name строка | всегда | Дескриптивное имя стека коммутаторов. Пример: MyStack | |
| serials список / элементы=строка | всегда | Список серийных номеров в стеке коммутаторов. Пример: ['QBZY-XWVU-TSRQ', 'QBAB-CDEF-GHIJ'] | |
Авторы
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_ms_stack_module.html