Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_appliance_vpn_vpn_firewall_rules – Модуль ресурсов для организаций _appliance _vpn _vpnfirewallrules

Примечание

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

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

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

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

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

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

Описание

  • Управление обновлением ресурсов организаций _appliance _vpn _vpnfirewallrules.
  • Обновление правил брандмауэра для VPN сайта-к-сайту организации.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

meraki_action_batch_retry_wait_time

integer

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

Default: 60

meraki_api_key

string / required

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

meraki_base_url

string

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

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

Default: ""

meraki_caller

string

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

Default: ""

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

целое число

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

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

meraki_suppress_logging

логическое значение

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

Доступные значения:

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

meraki_use_iterator_for_get_pages

логическое значение

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

Доступные значения:

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

meraki_wait_on_rate_limit

логическое значение

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

Доступные значения:

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

organizationId

строка

Параметр пути OrganizationId. Идентификатор организации.

rules

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

Отсортированный массив правил брандмауэра (без правила по умолчанию).

comment

строка

Описание правила (необязательно).

destCidr

строка

Список IP-адресов назначения (в формате IP или CIDR), разделенный запятыми, или «any» (FQDN не поддерживается).

destPort

строка

Список портов назначения (целые числа в диапазоне 1-65535), разделенный запятыми, или ‘any’.

policy

строка

«allow» или «deny» для трафика, указанного в данном правиле.

protocol

строка

Тип протокола (должен быть ‘tcp’, ‘udp’, ‘icmp’, ‘icmp6’ или ‘any’).

srcCidr

строка

Список IP-адресов источника (в формате IP или CIDR), разделенный запятыми, или ‘any’ (FQDN не поддерживается).

srcPort

строка

Список портов источника (целые числа в диапазоне 1-65535), разделенный запятыми, или ‘any’.

syslogEnabled

логическое значение

Регистрировать это правило в syslog (true или false, логическое значение) — применимо только в случае, если syslog настроен (необязательно).

Доступные значения:

  • false
  • true

syslogDefaultRule

логическое значение

Регистрировать специальное правило по умолчанию (логическое значение — активировать только если настроен сервер syslog) (необязательно).

Доступные значения:

  • false
  • true

Примечания

Примечание

  • Используемые методы SDK: appliance.Appliance.update_organization_appliance_vpn_vpn_firewall_rules,
  • Используемые пути: put /organizations/{organizationId}/appliance/vpn/vpnFirewallRules,
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины соединения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki по appliance updateOrganizationApplianceVpnVpnFirewallRules

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

Примеры

- name: Update all
  cisco.meraki.organizations_appliance_vpn_vpn_firewall_rules:
    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
    organizationId: string
    rules:
    - comment: Allow TCP traffic to subnet with HTTP servers.
      destCidr: 192.168.1.0/24
      destPort: '443'
      policy: allow
      protocol: tcp
      srcCidr: Any
      srcPort: Any
      syslogEnabled: false
    syslogDefaultRule: false

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: "[\n  {\n    \"comment\": \"string\",\n    \"destCidr\": \"string\",\n    \"destPort\": \"string\",\n    \"policy\": \"string\",\n    \"protocol\": \"string\",\n    \"srcCidr\": \"string\",\n    \"srcPort\": \"string\",\n    \"syslogEnabled\": true\n  }\n]\n"

Авторы

  • 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/organizations_appliance_vpn_vpn_firewall_rules_module.html

Spec-Zone.ru

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