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

Примечание

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

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

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

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

Новая функция в cisco.meraki 2.16.0

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
applianceIp строка	Локальный IP-адрес устройства на VLAN.
cidr строка	CIDR-блок пула подсетей. Применимо только для шаблонной сети. Каждая сеть, привязанная к шаблону, автоматически выбирает подсеть из этого пула для создания собственной VLAN.
dhcpBootFilename строка	DHCP-параметр для имени файла загрузки.
dhcpBootNextServer строка	DHCP-параметр, указывающий сервер, на который клиенты должны перейти для загрузки файла загрузки.
dhcpBootOptionsEnabled логическое значение	Использовать параметры DHCP, указанные в других свойствах. Варианты: `false` `true`
dhcpHandling строка	Обработка DHCP-запросов устройством на этом VLAN. Один из вариантов: «Запустить DHCP-сервер», «Перенаправить DHCP на другой сервер» или «Не отвечать на DHCP-запросы».
dhcpLeaseTime строка	Срок аренды DHCP, если на этом VLAN запущена DHCP-служба устройства. Один из вариантов: «30 минут», «1 час», «4 часа», «12 часов», «1 день» или «1 неделя».
dhcpOptions список / элементы=словарь	Список DHCP-параметров, которые будут включены в DHCP-ответы. Каждый элемент списка должен иметь свойства «код», «тип» и «значение».
code строка	Код DHCP-параметра. Должно быть целое число от 2 до 254.
type строка	Тип DHCP-параметра. Один из вариантов: «текст», «ip», «шестнадцатеричный» или «целое число».
value строка	Значение DHCP-параметра.
dhcpRelayServerIps список / элементы=строка	IP-адреса DHCP-серверов, на которые должны перенаправляться DHCP-запросы.
dnsNameservers строка	DNS-серверы, используемые для DHCP-ответов: «upstream_dns», «google_dns», «opendns» или строка IP-адресов или доменных имён, разделённых новой строкой.
fixedIpAssignments словарь	Фиксированные IP-адреса DHCP на VLAN. Это объект, содержащий соответствия между MAC-адресами и объектами, каждый из которых содержит поля «ip» и «name» типа строка. Более подробная информация представлена в примере запроса/ответа.
groupPolicyId строка	Идентификатор политики группы, которую необходимо применить к VLAN.
id строка	Идентификатор VLAN новой VLAN (должно быть значение от 1 до 4094).
ipv6 словарь	Настройка IPv6 на VLAN.
enabled логическое значение	Включить IPv6 на VLAN. Варианты: `false` `true`
prefixAssignments список / элементы=словарь	Назначения префиксов на VLAN.
autonomous логическое значение	Автоматическое назначение префикса /64 из источника VLAN. Варианты: `false` `true`
origin словарь	Источник префикса.
interfaces список / элементы=строка	Интерфейсы, связанные с префиксом.
type строка	Тип источника.
staticApplianceIp6 строка	Ручная настройка IP-адреса устройства IPv6.

staticPrefix string	Ручная настройка префикса /64 на VLAN.
mandatoryDhcp dictionary	Принудительный DHCP обеспечит, что клиенты, подключающиеся к этой VLAN, должны использовать IP-адрес, назначенный DHCP-сервером. Клиенты, использующие статический IP-адрес, не смогут подключиться. Доступно только в версиях прошивки 17.0 и выше.
enabled boolean	Включить принудительный DHCP на VLAN. Choices: `false` `true`
mask integer	Маска, используемая для подсети всех сетей, привязанных к шаблону. Применимо только для шаблона сети.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным ресурсам Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить выходные данные журнала в консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`

meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания повторной попытки при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логический), имитировать вызовы POST/PUT/DELETE для предотвращения изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логический), отключить всю запись в журнал? Тогда вы сами за себя! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логический), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логический), повторить попытку при обнаружении ошибки ограничения скорости 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 подсети, если VPN и перевод VPN подсети включены в VLAN.

Примечания

Примечание

Используемые методы 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 DNAC 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_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
    groupPolicyId: '101'
    id: '1234'
    ipv6:
      enabled: true
      prefixAssignments:
      - autonomous: 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: 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_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

- 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_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/24
    - 192.168.128.0/24
    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
        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
    vlanId: string
    vpnNatSubnet: 192.168.1.0/24

Значения возврата

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

Ключ	Описание
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"}

Авторы

Франсиско Муньос (@fmunoz)

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

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