cisco.meraki.networks_switch_stacks_routing_interfaces_dhcp_info модуль — Модуль информации о сети _switch _stacks _routing _interfaces _dhcp

Примечание

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

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

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

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

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

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

Описание

Получить все сети _switch _stacks _routing _interfaces _dhcp.
Возвратить конфигурацию DHCP интерфейса уровня 3 для стека коммутаторов.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers словарь	Дополнительные заголовки.
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 Значение по умолчанию: `""`

END_OF_DOCUMENT_MARKER

meraki_simulate boolean	meraki_simulate (boolean), моделировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова 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` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.
switchStackId string	Параметр пути SwitchStackId. Идентификатор стека коммутаторов.

Примечания

Примечание

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

См. также

Документация Cisco Meraki для switch getNetworkSwitchStackRoutingInterfaceDhcp: Полное описание API getNetworkSwitchStackRoutingInterfaceDhcp.

Примеры

- name: Get all networks _switch _stacks _routing _interfaces _dhcp
  cisco.meraki.networks_switch_stacks_routing_interfaces_dhcp_info:
    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}}"
    networkId: string
    switchStackId: string
    interfaceId: string
  register: result

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

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

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

Ключ

Описание

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/networks_switch_stacks_routing_interfaces_dhcp_info_module.html