cisco.meraki.meraki_network модуль — Управление сетями в облаке Meraki

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki.

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

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

УСТАНОВЛЕНО

Удалено в:: версии 3.0.0
Почему:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks

Описание

Позволяет создавать, управлять и получать доступ к сетям Meraki.

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
copy_from_network_id строка	Новая сеть наследует свойства из этой сети с ID. Другие предоставленные параметры переопределят скопированную конфигурацию. Тип, который должен точно совпадать с типом этой сети.
enable_vlans логическое значение	Логическое значение, определяющее, поддерживаются ли VLAN на сети. Требуется указать `net_name` или `net_id`. Варианты: `false` `true`
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. Значение по умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. Значение по умолчанию: `60`
local_status_page_enabled логическое значение	Эта функция больше не работает и, вероятно, будет перемещена в отдельный модуль. - Включает страницы состояния локального устройства (U[my.meraki.com](my.meraki.com), U[ap.meraki.com](ap.meraki.com), U[switch.meraki.com](switch.meraki.com), U[wired.meraki.com](wired.meraki.com)). - Может быть указано только самостоятельно или с `remote_status_page_enabled`. Варианты: `false` `true`
net_id строка	Идентификационный номер сети.
net_name псевдонимы: name, network строка	Название сети.
... (rest of the translated table)	...

type aliases: net_type список / элементы=строка	Тип сетевого устройства, которое управляет сетью. Требуется при создании сети. Начиная с Ansible 2.8, `combined` значение типа больше не поддерживается. Начиная с Ansible 2.8, изменения в этом параметре больше не являются идемпотентными. Выбираемые значения: `"appliance"` `"switch"` `"wireless"` `"sensor"` `"systemsManager"` `"camera"` `"cellularGateway"`
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. Для использования camelCase, установите переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible перестанут поддерживать вывод camelCase в Ansible 2.13. Обновите свои playbook'ы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о различиях в конфигурациях, но не отправит изменения в API для проверки изменений.

Примеры

- delegate_to: localhost
  block:
    - name: List all networks associated to the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
    - name: Query network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
    - name: Create network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type: switch
        timezone: America/Chicago
        tags: production, chicago
    - name: Create combined network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type:
          - switch
          - appliance
        timezone: America/Chicago
        tags: production, chicago
    - name: Create new network based on an existing network
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type:
          - switch
          - appliance
        copy_from_network_id: N_1234
    - name: Enable VLANs on a network
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        enable_vlans: yes
    - name: Modify local status page enabled state
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        local_status_page_enabled: yes

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

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

Ключ	Описание
data сложный	Информация о созданном или изменённом объекте. Возвращается: информация
id строка	Строка идентификации сети. Возвращается: успех Пример: `"N_12345"`
local_status_page_enabled логическое	Указывает, должны ли быть включены my.meraki.com и другие порталы устройств. Возвращается: успех Пример: `true`
name строка	Наименование сети. Возвращается: успех Пример: `"YourNet"`
organization_id строка	Идентификатор организации, которой принадлежит сеть. Возвращается: успех Пример: `"0987654321"`
remote_status_page_enabled логическое	Включает доступ к странице состояния устройства. Возвращается: успех Пример: `true`
tags список / элементы=строка	Теги, разделённые пробелами, назначенные сети. Возвращается: успех Пример: `["production"]`
time_zone строка	Временная зона сети. Возвращается: успех Пример: `"America/Chicago"`
type список / элементы=строка	Функциональный тип сети. Возвращается: успех Пример: `["switch"]`

Статус

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