cisco.meraki.meraki_switch_stack – Модификация конфигурации стекирования коммутаторов Meraki.
Примечание
Этот плагин входит в коллекцию cisco.meraki (версия 2.1.3).
Для его установки используйте: ansible-galaxy collection install cisco.meraki.
Чтобы использовать его в книге задач, укажите: cisco.meraki.meraki_switch_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 строка | Название организации. псевдонимы: организация | |
| 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 сложное | успех | Настройки VPN. | |
| id строка | всегда | Идентификатор стека коммутаторов. Пример: 7636 | |
| name строка | всегда | Дескриптивное имя стека коммутаторов. Пример: МойСтек | |
| serials список / элементы=строка | всегда | Список серийных номеров в стеке коммутаторов. Пример: ['QBZY-XWVU-TSRQ', 'QBAB-CDEF-GHIJ'] | |
Авторы
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/meraki/meraki_switch_stack_module.html