Модуль cisco.meraki.networks_appliance_vlans — модуль ресурсов для networks _appliance _vlans

Примечание

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

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

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

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

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

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

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

Управление операциями создания, обновления и удаления ресурса networks _appliance _vlans.
Добавление VLAN.
Удаление VLAN из сети.
Обновление VLAN.

Примечание

Для этого модуля предусмотрен соответствующий модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
applianceIp string	Локальный IP-адрес устройства в VLAN.
cidr string	CIDR-представление пула подсетей. Применяется только для сети-шаблона. Каждая сеть, привязанная к шаблону, автоматически выберет из этого пула подсеть для создания собственной VLAN.
dhcpBootFilename string	Параметр загрузки DHCP для имени загрузочного файла.
dhcpBootNextServer string	Параметр загрузки DHCP, указывающий клиентам, с какого сервера загружать загрузочный файл.
dhcpBootOptionsEnabled boolean	Использовать параметры загрузки DHCP, заданные в других свойствах. Варианты: `false` `true`
dhcpHandling string	Способ обработки устройством запросов DHCP в этой VLAN. Возможные значения: «Run a DHCP server», «Relay DHCP to another server» или «Do not respond to DHCP requests».
dhcpLeaseTime string	Срок аренды DHCP, если устройство выполняет роль DHCP-сервера в этой VLAN. Возможные значения: «30 minutes», «1 hour», «4 hours», «12 hours», «1 day» или «1 week».
dhcpOptions list / elements=dictionary	Список параметров DHCP, которые будут включены в ответы DHCP. Каждый объект в списке должен содержать свойства «code», «type» и «value».
code string	Код параметра DHCP. Это должно быть целое число от 2 до 254.
type string	Тип параметра DHCP. Возможные значения: «text», «ip», «hex» или «integer».
value string	Значение параметра DHCP.
dhcpRelayServerIps list / elements=string	IP-адреса (IPv4) DHCP-серверов, на которые следует перенаправлять DHCP-запросы. Запись в формате CIDR/подсети и имена хостов не поддерживаются.
dnsNameservers string	DNS-серверы имен, используемые в ответах DHCP: «upstream_dns», «google_dns», «opendns» или строка с IP-адресами либо доменными именами, разделенными символами новой строки.
fixedIpAssignments dictionary	Назначения фиксированных IP-адресов DHCP в VLAN. Это должен быть объект, содержащий сопоставления MAC-адресов с объектами, каждый из которых содержит строковые поля «ip» и «name». Дополнительные сведения см. в примере запроса/ответа.
groupPolicyId string	Идентификатор групповой политики, которую требуется применить к VLAN.
id string	Идентификатор новой VLAN (должен быть от 1 до 4094).
ipv6 dictionary	Конфигурация IPv6 в VLAN.
enabled boolean	Включить IPv6 в VLAN. Варианты: `false` `true`
prefixAssignments list / elements=dictionary	Назначения префиксов в VLAN.
autonomous boolean	Автоматически назначить VLAN префикс /64 из источника. Варианты: `false` `true`
disabled boolean	Отключить назначение префикса. Варианты: `false` `true`
origin dictionary	Источник префикса.
interfaces list / elements=string	Интерфейсы, связанные с префиксом.
type string	Тип источника.
staticApplianceIp6 string	Ручная настройка IPv6-адреса устройства.
staticPrefix string	Ручная настройка префикса /64 в VLAN.
mandatoryDhcp dictionary	Обязательный DHCP гарантирует, что клиенты, подключающиеся к этой VLAN, будут использовать IP-адрес, назначенный DHCP-сервером. Клиенты со статическим IP-адресом не смогут подключиться. Доступно только в версиях прошивки 17.0 и выше.
enabled boolean	Включить обязательный DHCP в VLAN. Варианты: `false` `true`
mask integer	Маска подсети для всех сетей, привязанных к шаблону. Применяется только для сети-шаблона.
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	Имя новой VLAN.
networkId string	Параметр пути NetworkId. Идентификатор сети.
reservedIpRanges list / elements=dictionary	Зарезервированные диапазоны IP-адресов DHCP в VLAN.
comment string	Текстовый комментарий к зарезервированному диапазону.
end string	Последний IP-адрес в зарезервированном диапазоне.
start string	Первый IP-адрес в зарезервированном диапазоне.
subnet string	Подсеть VLAN.
templateVlanType string	Тип разбиения VLAN на подсети. Применяется только для сети-шаблона.
vlanId string	Параметр пути VlanId. Идентификатор VLAN.
vpnNatSubnet string	Преобразованная подсеть VPN, если для VLAN включены VPN и преобразование подсети VPN.

Примечания

Примечание

Используемые методы SDK: appliance.Appliance.create_network_appliance_vlan, appliance.Appliance.delete_network_appliance_vlan, appliance.Appliance.update_network_appliance_vlan,
Используемые пути: post /networks/{networkId}/appliance/vlans, delete /networks/{networkId}/appliance/vlans/{vlanId}, put /networks/{networkId}/appliance/vlans/{vlanId},
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо них — встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco Meraki по appliance createNetworkApplianceVlan: Полный справочник по API createNetworkApplianceVlan.
Документация Cisco Meraki по appliance deleteNetworkApplianceVlan: Полный справочник по API deleteNetworkApplianceVlan.
Документация Cisco Meraki по appliance updateNetworkApplianceVlan: Полный справочник по API updateNetworkApplianceVlan.

Примеры

- name: Create
  cisco.meraki.networks_appliance_vlans:
    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
    applianceIp: 192.168.1.2
    cidr: 192.168.1.0/24
    dhcpBootFilename: sample.file
    dhcpBootNextServer: 1.2.3.4
    dhcpBootOptionsEnabled: true
    dhcpHandling: Run a DHCP server
    dhcpLeaseTime: 30 minutes
    dhcpOptions:
      - code: '3'
        type: text
        value: five
    dhcpRelayServerIps:
      - 192.168.1.0
      - 192.168.128.0
    groupPolicyId: '101'
    id: '1234'
    ipv6:
      enabled: true
      prefixAssignments:
        - autonomous: false
          disabled: false
          origin:
            interfaces:
              - wan0
            type: internet
          staticApplianceIp6: 2001:db8:3c4d:15::1
          staticPrefix: 2001:db8:3c4d:15::/64
    mandatoryDhcp:
      enabled: true
    mask: 28
    name: My VLAN
    networkId: string
    subnet: 192.168.1.0/24
    templateVlanType: same
- name: Update by id
  cisco.meraki.networks_appliance_vlans:
    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
    adaptivePolicyGroupId: '1234'
    applianceIp: 192.168.1.2
    cidr: 192.168.1.0/24
    dhcpBootFilename: sample.file
    dhcpBootNextServer: 1.2.3.4
    dhcpBootOptionsEnabled: false
    dhcpHandling: Run a DHCP server
    dhcpLeaseTime: 1 day
    dhcpOptions:
      - code: '5'
        type: text
        value: five
    dhcpRelayServerIps:
      - 192.168.1.0
      - 192.168.128.0
    dnsNameservers: google_dns
    fixedIpAssignments:
      22:33:44:55:66:77:
        ip: 1.2.3.4
        name: Some client name
    groupPolicyId: '101'
    ipv6:
      enabled: true
      prefixAssignments:
        - autonomous: false
          disabled: false
          origin:
            interfaces:
              - wan0
            type: internet
          staticApplianceIp6: 2001:db8:3c4d:15::1
          staticPrefix: 2001:db8:3c4d:15::/64
    mandatoryDhcp:
      enabled: true
    mask: 28
    name: My VLAN
    networkId: string
    reservedIpRanges:
      - comment: A reserved IP range
        end: 192.168.1.1
        start: 192.168.1.0
    subnet: 192.168.1.0/24
    templateVlanType: same
    uplinks:
      - interface: wan1
        nat:
          enabled: true
    vlanId: string
    vpnNatSubnet: 192.168.1.0/24
    vrf:
      id: '1000'
      name: VRF BLUE
- name: Delete by id
  cisco.meraki.networks_appliance_vlans:
    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: absent
    networkId: string
    vlanId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: `{"applianceIp": "string", "cidr": "string", "groupPolicyId": "string", "id": "string", "interfaceId": "string", "ipv6": {"enabled": true, "prefixAssignments": [{"autonomous": true, "origin": {"interfaces": ["string"], "type": "string"}, "staticApplianceIp6": "string", "staticPrefix": "string"}]}, "mandatoryDhcp": {"enabled": true}, "mask": 0, "name": "string", "subnet": "string", "templateVlanType": "string"}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"applianceIp": "string", "cidr": "string", "groupPolicyId": "string", "id": "string", "interfaceId": "string", "ipv6": {"enabled": true, "prefixAssignments": [{"autonomous": true, "origin": {"interfaces": ["string"], "type": "string"}, "staticApplianceIp6": "string", "staticPrefix": "string"}]}, "mandatoryDhcp": {"enabled": true}, "mask": 0, "name": "string", "subnet": "string", "templateVlanType": "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_appliance_vlans_module.html