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 (integer),操作批处理并发错误重试等待时间 默认值:  | |
| meraki_api_key (字符串),在仪表板中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY | |
| meraki_base_url (字符串),在所有端点资源之前 默认值:  | |
| meraki_be_geo_id (字符串),用于 API 使用跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID 默认值:  | |
| meraki_caller (字符串),用于 API 使用跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值:  | |
| meraki_certificate_path (字符串),如果位于本地代理之后,用于 TLS/SSL 证书验证的路径 默认值:  | |
| meraki_inherit_logging_config (布尔值),继承您自己的记录器实例 选择 
 | |
| meraki_log_file_prefix (字符串),附加日期和时间戳的日志文件名 默认值:  | |
| log_path (字符串),输出日志的路径;默认情况下,如果未指定,则为脚本的工作目录 默认值:  | |
| meraki_maximum_retries (integer),遇到 429 或其他服务器端错误时,最多重试此次数 默认值:  | |
| meraki_nginx_429_retry_wait_time (integer),Nginx 429 重试等待时间 默认值:  | |
| meraki_output_log (布尔值),创建输出日志文件? 选择 
 | |
| meraki_print_console (布尔值),将日志输出打印到控制台? 选择 
 | |
| meraki_requests_proxy (字符串),如果需要,用于 HTTPS 的代理服务器和端口 默认值:  | |
| meraki_retry_4xx_error (布尔值),如果遇到其他 4XX 错误(除了 429)是否重试? 选择 
 | |
| meraki_retry_4xx_error_wait_time (integer),其他 4XX 错误重试等待时间 默认值:  | |
| meraki_simulate (布尔值),模拟 POST/PUT/DELETE 调用以防止更改? 选择 
 | |
| meraki_single_request_timeout (integer),每次 API 调用的最大秒数 默认值:  | |
| meraki_suppress_logging (布尔值),禁用所有日志记录?那你只能靠自己了! 选择 
 | |
| meraki_use_iterator_for_get_pages (布尔值),list* 方法将返回一个迭代器,其中包含每个对象,而不是包含所有项的完整列表 选择 
 | |
| meraki_wait_on_rate_limit (布尔值),如果遇到 429 速率限制错误是否重试? 选择 
 | |
| OrganizationId 路径参数。组织 ID。 | |
| 防火墙规则的有序数组(不包括默认规则)。 | |
| 规则的描述(可选)。 | |
| 目标 IP 地址列表(以逗号分隔,可以是 IP 或 CIDR 表示法)或 ‘any’(不支持 FQDN)。 | |
| 目标端口列表(以逗号分隔,整数范围为 1-65535),或 ‘any’。 | |
| ‘allow’ 或 ‘deny’,表示此规则指定的流量是允许还是拒绝。 | |
| 协议类型(必须是 ‘tcp’、‘udp’、‘icmp’、‘icmp6’ 或 ‘any’)。 | |
| 源 IP 地址列表(以逗号分隔,可以是 IP 或 CIDR 表示法),或 ‘any’(不支持 FQDN)。 | |
| 源端口列表(以逗号分隔,整数范围为 1-65535),或 ‘any’。 | |
| 是否将此规则记录到系统日志 (true 或 false,布尔值) - 仅当配置了系统日志时适用(可选)。 选择 
 | |
| 是否记录特殊的默认规则(布尔值 - 仅当您配置了系统日志服务器时启用)(可选)。 选择 
 | 
注释
注意
- 使用的 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
返回值
常见的返回值记录在 这里,以下是此模块特有的字段
| 键 | 描述 | 
|---|---|
| 由 Cisco Meraki Python SDK 返回的字典或列表形式的响应 返回: 总是 示例:  | 
