модуль cisco.meraki.networks_campus_gateway_clusters — модуль ресурсов для networks _campus _gateway _clusters

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

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

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

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

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

Управление операциями создания и обновления ресурса networks _campus _gateway _clusters.
Создание кластера и добавление в него шлюзов кампуса.
Обновление кластера и добавление в него шлюзов кампуса или удаление шлюзов из него.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
clusterId string	Параметр пути ClusterId. Идентификатор кластера.
devices list / elements=dictionary	Устройства, добавляемые в кластер.
serial string	Серийный номер устройства.
tunnels list / elements=dictionary	Параметры туннеля устройства, если указан интерфейс туннеля кластера.
addresses list / elements=dictionary	IP-адреса туннеля устройства.
address string	IP-адрес интерфейса.
protocol string	Протокол интерфейса.
interface string	Имя интерфейса туннеля.
uplinks list / elements=dictionary	Параметры восходящего канала устройства, если для режима назначения восходящих каналов кластера задано значение «статический».
addresses list / elements=dictionary	IP-адреса восходящего канала устройства.
address string	IP-адрес интерфейса.
protocol string	Протокол интерфейса.
interface string	Имя интерфейса восходящего канала.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; также можно задать как переменную среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), добавляется перед всеми ресурсами конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также можно задать как переменную среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать собственный экземпляр средства ведения журнала Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), к имени файла журнала добавляются дата и метка времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для сохранения журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять попытку при возникновении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой при другой ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все ведение журнала? Тогда вы предоставлены сами себе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять попытку при возникновении ошибки ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
name string	Имя нового кластера.
nameservers dictionary	Серверы имен кластера.
addresses list / elements=string	Адреса серверов имен.
networkId string	Параметр пути NetworkId. Идентификатор сети.
notes string	Примечания о кластере длиной не более 511 символов.
portChannels list / elements=dictionary	Параметры агрегированных каналов кластера.
allowedVlans string	Разрешенные VLAN агрегированного канала.
name string	Имя агрегированного канала.
vlan integer	Идентификатор VLAN агрегированного канала.
tunnels list / elements=dictionary	Параметры интерфейса туннеля кластера. Повторно используйте восходящий канал или укажите интерфейс туннеля.
addresses list / elements=dictionary	Адреса интерфейса.
gateway string	Шлюз интерфейса.
protocol string	Протокол интерфейса.
subnetMask string	Маска подсети интерфейса.
interface string	Идентификатор интерфейса, должен иметь значение tun1. Указывайте этот интерфейс, только если восходящий канал не используется повторно в качестве туннеля.
uplink dictionary	Сведения об интерфейсе восходящего канала, если он повторно используется в качестве туннеля.
interface string	Идентификатор интерфейса восходящего канала.
vlan integer	Идентификатор VLAN интерфейса.
uplinks list / elements=dictionary	Параметры интерфейсов восходящих каналов кластера.
addresses list / elements=dictionary	Адреса интерфейса.
assignmentMode string	Режим назначения интерфейса.
gateway string	Шлюз интерфейса, если задан статический режим назначения.
protocol string	Протокол интерфейса, если задан статический режим назначения.
subnetMask string	Маска подсети интерфейса, если задан статический режим назначения.
interface string	Идентификатор интерфейса, должен иметь значение man1.
vlan integer	Идентификатор VLAN интерфейса.

Примечания

Примечание

Используются методы SDK: campus_gateway.CampusGateway.create_network_campus_gateway_cluster, campus_gateway.CampusGateway.update_network_campus_gateway_cluster,
Используются пути: post /networks/{networkId}/campusGateway/clusters, put /networks/{networkId}/campusGateway/clusters/{clusterId},
Не поддерживается check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по campusGateway createNetworkCampusGatewayCluster: Полный справочник по API createNetworkCampusGatewayCluster.
Документация Cisco Meraki по campusGateway updateNetworkCampusGatewayCluster: Полный справочник по API updateNetworkCampusGatewayCluster.

Примеры

- name: Create
  cisco.meraki.networks_campus_gateway_clusters:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    devices:
      - serial: Q234-ABCD-0001
        tunnels:
          - addresses:
              - address: 6.2.6.7
                protocol: ipv4
            interface: tun1
        uplinks:
          - addresses:
              - address: 5.1.2.3
                protocol: ipv4
            interface: man1
    name: North Campus
    nameservers:
      addresses:
        - 8.8.8.8
        - 8.8.4.4
    networkId: string
    notes: This cluster is for New York Office
    portChannels:
      - allowedVlans: 10-20
        name: Port-channel1
        vlan: 25
    tunnels:
      - addresses:
          - gateway: 2.3.5.6
            protocol: ipv4
            subnetMask: 255.255.255.0
        interface: tun1
        uplink:
          interface: man1
        vlan: 6
    uplinks:
      - addresses:
          - assignmentMode: static
            gateway: 1.2.3.5
            protocol: ipv4
            subnetMask: 255.255.255.0
        interface: man1
        vlan: 5
- name: Update by id
  cisco.meraki.networks_campus_gateway_clusters:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    clusterId: string
    devices:
      - serial: Q234-ABCD-0001
        tunnels:
          - addresses:
              - address: 6.2.6.7
                protocol: ipv4
            interface: tun1
        uplinks:
          - addresses:
              - address: 5.1.2.3
                protocol: ipv4
            interface: man1
    name: North Campus
    nameservers:
      addresses:
        - 8.8.8.8
        - 8.8.4.4
    networkId: string
    notes: This cluster is for New York Office
    portChannels:
      - allowedVlans: 10-20
        name: Port-channel1
        vlan: 25
    tunnels:
      - addresses:
          - gateway: 2.3.5.6
            protocol: ipv4
            subnetMask: 255.255.255.0
        interface: tun1
        uplink:
          interface: man1
        vlan: 6
    uplinks:
      - addresses:
          - assignmentMode: static
            gateway: 1.2.3.5
            protocol: ipv4
            subnetMask: 255.255.255.0
        interface: man1
        vlan: 5

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: {"clusterId": "string", "devices": [{"memberId": "string", "serial": "string", "tunnels": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}], "uplinks": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}]}], "name": "string", "nameservers": {"addresses": ["string"]}, "notes": "string", "portChannels": [{"allowedVlans": "string", "id": "string", "name": "string", "vlan": 0}], "tunnels": [{"addresses": [{"gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "uplink": {"interface": "string"}, "vlan": 0}], "uplinks": [{"addresses": [{"assignmentMode": "string", "gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "vlan": 0}], "url": "string"}

Ключ

Описание

meraki_response

словарь

Словарь или список с ответом, возвращённым Python SDK Cisco Meraki

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

Пример: {"clusterId": "string", "devices": [{"memberId": "string", "serial": "string", "tunnels": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}], "uplinks": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}]}], "name": "string", "nameservers": {"addresses": ["string"]}, "notes": "string", "portChannels": [{"allowedVlans": "string", "id": "string", "name": "string", "vlan": 0}], "tunnels": [{"addresses": [{"gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "uplink": {"interface": "string"}, "vlan": 0}], "uplinks": [{"addresses": [{"assignmentMode": "string", "gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "vlan": 0}], "url": "string"}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 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/networks_campus_gateway_clusters_module.html