cisco.meraki.organizations_appliance_vpn_vpn_firewall_rules 模块 – 用于 organizations _appliance _vpn _vpnfirewallrules 的资源模块

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您正在使用 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 中的新增功能

概要

• 管理资源 organizations _appliance _vpn _vpnfirewallrules 的操作更新。

• 更新组织站点到站点 VPN 的防火墙规则。

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要满足以下要求。

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
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 默认值: ""
meraki_certificate_path 字符串	meraki_certificate_path (字符串), 如果在本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值: ""
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config (布尔值), 继承您自己的记录器实例 选择 false ← (默认) true
meraki_log_file_prefix 字符串	meraki_log_file_prefix (字符串), 附加日期和时间戳的日志文件名 默认值: "meraki_api_"
meraki_log_path 字符串	log_path (字符串), 输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值: ""
meraki_maximum_retries 整数	meraki_maximum_retries (整数), 遇到 429 或其他服务器端错误时最多重试此次数 默认值: 2
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time (整数), Nginx 429 重试等待时间 默认值: 60
meraki_output_log 布尔值	meraki_output_log (布尔值), 创建输出日志文件？ 选择 false true ← (默认)
meraki_print_console 布尔值	meraki_print_console (布尔值), 将日志输出打印到控制台？ 选择 false true ← (默认)
meraki_requests_proxy 字符串	meraki_requests_proxy (字符串), 如果需要，用于 HTTPS 的代理服务器和端口 默认值: ""
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error (布尔值), 如果遇到其他 4XX 错误（除了 429）是否重试？ 选择 false ← (默认) true
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time (整数), 其他 4XX 错误重试等待时间 默认值: 60
meraki_simulate 布尔值	meraki_simulate (布尔值), 模拟 POST/PUT/DELETE 调用以防止更改？ 选择 false ← (默认) 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 路径参数。组织 ID。
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

updateOrganizationApplianceVpnVpnFirewallRules API 的完整参考。

示例

- 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\": \"字符串\",\n    \"destCidr\": \"字符串\",\n    \"destPort\": \"字符串\",\n    \"policy\": \"字符串\",\n    \"protocol\": \"字符串\",\n    \"srcCidr\": \"字符串\",\n    \"srcPort\": \"字符串\",\n    \"syslogEnabled\": true\n  }\n]\n"

作者

• Francisco Munoz (@fmunoz)

集合链接

• 问题跟踪器
• 存储库 (源)