cisco.meraki.devices_cellular_gateway_lan модуль — модуль ресурсов для устройств _cellulargateway _lan

Примечание

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

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

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

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

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

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

Описание

Управление обновлением операций ресурса devices _cellulargateway _lan.
Обновление настроек LAN для одного MG.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
fixedIpAssignments список / элементы=словарь	Список всех статических IP-адресов для одного шлюза MG.
ip строка	IP-адрес, который вы хотите назначить определённому серверу или устройству.
mac строка	MAC-адрес сервера или устройства, на котором размещён внутренний ресурс, которому вы хотите назначить указанный IP-адрес.
name строка	Дескриптивное имя назначения.
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_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` ← (по умолчанию)
reservedIpRanges list / elements=dictionary	Список всех зарезервированных диапазонов IP-адресов для одного MG.
comment string	Комментарий, поясняющий зарезервированный диапазон IP-адресов.
end string	Конечный IP-адрес, включённый в зарезервированный диапазон IP-адресов.
start string	Начальный IP-адрес, включённый в зарезервированный диапазон IP-адресов.
serial string	Параметр пути serial.

Примечания

Примечание

Используемый метод SDK: cellular_gateway.CellularGateway.update_device_cellular_gateway_lan,
Используемые пути: put /devices/{serial}/cellularGateway/lan,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Update all
  cisco.meraki.devices_cellular_gateway_lan:
    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
    fixedIpAssignments:
    - ip: 192.168.0.10
      mac: 0b:00:00:00:00:ac
      name: server 1
    reservedIpRanges:
    - comment: A reserved IP range
      end: 192.168.1.1
      start: 192.168.1.0
    serial: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: `{"deviceLanIp": "string", "deviceName": "string", "deviceSubnet": "string", "fixedIpAssignments": [{"ip": "string", "mac": "string", "name": "string"}], "reservedIpRanges": [{"comment": "string", "end": "string", "start": "string"}]}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"deviceLanIp": "string", "deviceName": "string", "deviceSubnet": "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_cellular_gateway_lan_module.html