Spec-Zone.ru › Ansible

Модуль cisco.meraki.devices_switch_routing_interfaces_dhcp – Модуль ресурса для устройств _switch _routing _interfaces _dhcp

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.devices_switch_routing_interfaces_dhcp.

Впервые в cisco.meraki 2.16.0

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

Описание

  • Управление обновлением операции ресурса devices _switch _routing _interfaces _dhcp.
  • Обновление конфигурации DHCP для интерфейса уровня 3 коммутатора.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

bootFileName

строка

Имя файла сервера PXE для DHCP-сервера, работающего на интерфейсе коммутатора.

bootNextServer

строка

IP-адрес сервера PXE-загрузки для DHCP-сервера, работающего на интерфейсе коммутатора.

bootOptionsEnabled

булево

Включить параметры загрузки DHCP для настройки параметров загрузки PXE для DHCP-сервера, работающего на интерфейсе коммутатора.

Варианты:

  • false
  • true

dhcpLeaseTime

строка

Настройка времени аренды DHCP для DHCP-сервера, работающего на интерфейсе коммутатора ('30 минут', '1 час', '4 часа', '12 часов', '1 день' или '1 неделя').

dhcpMode

строка

Параметры режима DHCP для интерфейса коммутатора ('dhcpDisabled', 'dhcpRelay' или 'dhcpServer').

dhcpOptions

список / элементы=словарь

Массив параметров DHCP, состоящий из кода, типа и значения для DHCP-сервера, работающего на интерфейсе коммутатора.

code

строка

Код параметра DHCP, который должен быть от 2 до 254.

type

строка

Тип параметра DHCP, который должен быть одним из ('текст', 'ip', 'целое число' или 'шестнадцатеричный').

value

строка

Значение параметра DHCP.

dhcpRelayServerIps

список / элементы=строка

IP-адреса реле DHCP, на которые будут пересылаться пакеты DHCP для интерфейса коммутатора.

dnsCustomNameservers

список / элементы=строка

IP-адреса именных серверов DHCP, когда параметр имени сервера DHCP равен ‘custom’.

dnsNameserversOption

строка

Параметр имени сервера DHCP для DHCP-сервера, работающего на интерфейсе коммутатора ('googlePublicDns', 'openDns' или 'custom').

fixedIpAssignments

список / элементы=словарь

Массив присвоений фиксированных IP-адресов DHCP для DHCP-сервера, работающего на интерфейсе коммутатора.

ip

строка

IP-адрес клиента, которому назначен фиксированный IP-адрес.

mac

строка

MAC-адрес клиента, которому назначен фиксированный IP-адрес.

name

строка

Имя клиента, которому назначен фиксированный IP-адрес.

interfaceId

строка

Параметр пути interfaceId. Идентификатор интерфейса.

meraki_action_batch_retry_wait_time

целое число

meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки ошибки параллельного выполнения действия

По умолчанию: 60

meraki_api_key

строка / обязательно

meraki_api_key (строка), API-ключ, сгенерированный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

строка

meraki_base_url (строка), предшествующая всем ресурсам конечной точки

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

строка

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID

По умолчанию: ""

meraki_caller

строка

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная среды MERAKI_PYTHON_SDK_CALLER

По умолчанию: ""
END_OF_DOCUMENT_MARKER

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 (integer), время ожидания повтора для других ошибок 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя!

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429?

Choices:

  • false
  • true ← (default)

reservedIpRanges

list / elements=dictionary

Массив назначений зарезервированных IP-адресов DHCP для сервера DHCP, работающего на интерфейсе коммутатора.

комментарий

строка

Комментарий к зарезервированному диапазону IP-адресов.

конец

строка

Конечный IP-адрес зарезервированного диапазона IP-адресов.

начало

строка

Начальный IP-адрес зарезервированного диапазона IP-адресов.

серийный номер

строка

Параметр пути серийного номера.

Примечания

Примечание

  • Используемый метод SDK: switch.Switch.update_device_switch_routing_interface_dhcp,
  • Используемые пути: put /devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный диспетчер подключений Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki для switch updateDeviceSwitchRoutingInterfaceDhcp

Полное описание API updateDeviceSwitchRoutingInterfaceDhcp.

Примеры

- name: Update all
  cisco.meraki.devices_switch_routing_interfaces_dhcp:
    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
    bootFileName: home_boot_file
    bootNextServer: 1.2.3.4
    bootOptionsEnabled: true
    dhcpLeaseTime: 1 day
    dhcpMode: dhcpServer
    dhcpOptions:
    - code: '5'
      type: text
      value: five
    dhcpRelayServerIps:
    - 1.2.3.4
    dnsCustomNameservers:
    - 8.8.8.8, 8.8.4.4
    dnsNameserversOption: custom
    fixedIpAssignments:
    - ip: 192.168.1.12
      mac: 22:33:44:55:66:77
      name: Cisco Meraki valued client
    interfaceId: string
    reservedIpRanges:
    - comment: A reserved IP range
      end: 192.168.1.10
      start: 192.168.1.1
    serial: string

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"bootFileName": "string", "bootNextServer": "string", "bootOptionsEnabled": true, "dhcpLeaseTime": "string", "dhcpMode": "string", "dhcpOptions": [{"code": "string", "type": "string", "value": "string"}], "dhcpRelayServerIps": ["string"], "dnsCustomNameservers": ["string"], "dnsNameserversOption": "string", "fixedIpAssignments": [{"ip": "string", "mac": "string", "name": "string"}], "reservedIpRanges": [{"comment": "string", "end": "string", "start": "string"}]}

Авторы

  • Francisco Munoz (@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/devices_switch_routing_interfaces_dhcp_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API