Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_switch_stacks_routing_interfaces_dhcp — Модуль ресурсов для сетей _switch _stacks _routing _interfaces _dhcp

Примечание

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

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

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

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

Новинка в cisco.meraki 2.16.0

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

Обзор

  • Управление обновлением операций ресурса сети _switch _stacks _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, должен быть одним из ('text', 'ip', 'integer' или 'hex').

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

string

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

Default: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (булево), наследует ваш собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), имя файла журнала с добавлением даты и времени

Default: "meraki_api_"

meraki_log_path

string

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

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), повторить до такого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания повтора запроса Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (булево), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (булево), выводить выходные данные журнала на консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (булево), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (целое число), время ожидания повтора попытки при ошибке 4XX

Default: 60

meraki_simulate

boolean

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

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

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

Default: 60

meraki_suppress_logging

boolean

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

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

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

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

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

Choices:

  • false
  • true ← (default)

networkId

string

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

reservedIpRanges

list / elements=dictionary

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

comment

string

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

end

string

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

start

string

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

switchStackId

string

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

Примечания

Примечание

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

См. также

См. также

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

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

Примеры

- name: Update all
  cisco.meraki.networks_switch_stacks_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
    networkId: string
    reservedIpRanges:
    - comment: A reserved IP range
      end: 192.168.1.10
      start: 192.168.1.1
    switchStackId: string

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

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

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращенным 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/networks_switch_stacks_routing_interfaces_dhcp_module.html

Spec-Zone.ru

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