Spec-Zone.ru › Ansible

модуль cisco.meraki.networks_appliance_prefixes_delegated_statics — модуль ресурса для networks _appliance _prefixes _delegated _statics

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_appliance_prefixes_delegated_statics.

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

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

Краткое описание

  • Управление операциями создания, обновления и удаления ресурса networks _appliance _prefixes _delegated _statics.
  • Добавление статического делегированного префикса в сеть.
  • Удаление статического делегированного префикса из сети.
  • Обновление статического делегированного префикса в сети.

Примечание

Этому модулю соответствует модуль действий.

Требования

На узле, выполняющем этот модуль, необходимы следующие зависимости.

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

description

string

Имя или описание префикса.

meraki_action_batch_retry_wait_time

integer

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

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

meraki_api_key

string / обязательный

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

meraki_base_url

string

meraki_base_url (string) — URL-адрес, добавляемый перед всеми конечными точками ресурсов

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

meraki_be_geo_id

string

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

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

meraki_certificate_path

string

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

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

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean) — наследовать пользовательский экземпляр средства ведения журнала

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

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

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

meraki_log_path

string

log_path (string) — путь к файлу журнала; если не указан, используется рабочий каталог скрипта

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

meraki_maximum_retries

integer

meraki_maximum_retries (integer) — максимальное количество повторных попыток при получении ответа 429 или других ошибок на стороне сервера

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

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer) — время ожидания перед повторной попыткой при ответе Nginx 429

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

meraki_output_log

boolean

meraki_output_log (boolean) — создавать файл журнала вывода?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (boolean) — выводить журнал в консоль?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_requests_proxy

string

meraki_requests_proxy (string) — прокси-сервер и порт для HTTPS, если требуется

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

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean) — повторять попытку при других ошибках 4XX (кроме 429)?

Варианты:

  • false ← (по умолчанию)
  • true

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 ← (по умолчанию)

networkId

string

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

origin

dictionary

Источник префикса.

interfaces

list / элементы=string

Интерфейсы, связанные с префиксом.

type

string

Тип источника.

prefix

string

Статический префикс IPv6.

staticDelegatedPrefixId

string

Параметр пути StaticDelegatedPrefixId. Идентификатор статического делегированного префикса.

Примечания

Примечание

  • Используемые методы SDK: appliance.Appliance.create_network_appliance_prefixes_delegated_static, appliance.Appliance.delete_network_appliance_prefixes_delegated_static, appliance.Appliance.update_network_appliance_prefixes_delegated_static,
  • Используемые пути: post /networks/{networkId}/appliance/prefixes/delegated/statics, delete /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId}, put /networks/{networkId}/appliance/prefixes/delegated/statics/{staticDelegatedPrefixId},
  • Не поддерживает check_mode
  • Плагин запускается на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений
  • из Cisco Dashboard API Python (SDK)
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки подключения

См. также

См. также

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

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

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

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

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

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

Примеры

- name: Create
  cisco.meraki.networks_appliance_prefixes_delegated_statics:
    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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    description: Prefix on WAN 1 of Long Island Office network
    networkId: string
    origin:
      interfaces:
        - wan1
      type: internet
    prefix: 2001:db8:3c4d:15::/64
- name: Update by id
  cisco.meraki.networks_appliance_prefixes_delegated_statics:
    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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    description: Prefix on WAN 1 of Long Island Office network
    networkId: string
    origin:
      interfaces:
        - wan1
      type: internet
    prefix: 2001:db8:3c4d:15::/64
    staticDelegatedPrefixId: string
- name: Delete by id
  cisco.meraki.networks_appliance_prefixes_delegated_statics:
    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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: absent
    networkId: string
    staticDelegatedPrefixId: string

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {}

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/networks_appliance_prefixes_delegated_statics_module.html

Spec-Zone.ru

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