openstack.cloud.security_group_rule_info 模块 – 获取 OpenStack 网络 (Neutron) 安全组规则

注意

此模块是 openstack.cloud 集合（版本 2.3.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：openstack.cloud.security_group_rule_info。

概要

• 从 OpenStack 网络 (Neutron) API 获取安全组规则。

要求

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

• python >= 3.6

• openstacksdk >= 1.0.0

参数

参数	说明
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给请求库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证方式，则应在此处指示插件的名称，并且应相应地更新 auth 参数的内容。
ca_cert 别名：cacert 字符串	可用于验证 SSL API 请求的 CA 证书包的路径。
client_cert 别名：cert 字符串	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名：key 字符串	用作 SSL 事务一部分的客户端密钥的路径。
cloud 任意	要操作的命名云或云配置。如果 cloud 是一个字符串，它引用 OpenStack clouds.yaml 文件中定义的命名云配置。提供 auth 和 auth_type 的默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是一个字典，则它包含完整的云配置，如 clouds.yaml 的某个部分中所示。
description 字符串	按资源的人工可读描述筛选列表结果。
direction 字符串	按应用安全组规则的方向筛选安全组规则列表结果。 选项 "egress" "ingress"
ether_type 别名：ethertype 字符串	按网络流量的 ether_type 筛选安全组规则列表结果。该值必须为 IPv4 或 IPv6。 选项 "IPv4" "IPv6"
id 别名：rule 字符串	按安全组规则的 ID 筛选列表结果。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。 选项 "admin" "internal" "public" ← （默认）
port_range_max 整数	结束端口
port_range_min 整数	起始端口
project 字符串	项目的唯一名称或 ID。
protocol 字符串	按 IP 协议筛选安全组规则列表结果。
region_name 字符串	区域的名称。
remote_group 字符串	按与此安全组规则关联的远程组的名称或 ID 筛选安全组规则列表结果。
remote_ip_prefix 字符串	以 CIDR 表示法表示的源 IP 地址（与 remote_group 互斥）
revision_number 整数	按资源的修订号筛选列表结果。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选项 "INFO" ← （默认） "DEBUG"
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
security_group 字符串	安全组的名称或 ID
timeout 整数	Ansible 应等待请求的资源多长时间。 默认值： 180
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。 在 Ansible 2.3 之前，此项默认为 true。 选项 false true
wait 布尔值	Ansible 是否应等待直到请求的资源完成。 选项 false true ← （默认）

备注

注意

• 可以使用标准的 OpenStack 环境变量（例如 OS_USERNAME）而不是提供显式值。

• 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。可以在 https://docs.openstack.org/openstacksdk/ 找到更多信息

示例

- name: Fetch all security group rules
  openstack.cloud.security_group_rule_info:
    cloud: devstack

- name: Filter security group rules for port 80 and name
  openstack.cloud.security_group_rule_info:
    cloud: devstack
    security_group: foo
    protocol: tcp
    port_range_min: 80
    port_range_max: 80
    remote_ip_prefix: 0.0.0.0/0

- name: Filter for ICMP rules
  openstack.cloud.security_group_rule_info:
    cloud: devstack
    protocol: icmp

返回值

通用返回值记录在此处，以下是此模块独有的字段

键	描述
security_group_rules 列表 / 元素=字典	描述安全组规则的字典列表。 返回: 总是
created_at 字符串	安全组规则创建的时间戳。 返回: 成功
description 字符串	资源的易读描述。 返回: 成功 示例: "我的描述。"
direction 字符串	安全组规则应用的方向。 返回: 成功 示例: "出口"
ether_type 字符串	IPv4 或 IPv6 之一。 返回: 成功 示例: "IPv4"
id 字符串	唯一的规则 UUID。 返回: 成功
name 字符串	资源的名称。 返回: 成功
port_range_max 整数	安全组规则匹配的端口范围中的最大端口号。 返回: 成功 示例: 8000
port_range_min 整数	安全组规则匹配的端口范围中的最小端口号。 返回: 成功 示例: 8000
project_id 字符串	项目的 ID。 返回: 成功 示例: "e4f50856753b4dc6afee5fa6b9b6c550"
protocol 字符串	安全组规则匹配的协议。 返回: 成功 示例: "tcp"
remote_address_group_id 字符串	要与此安全组规则关联的远程地址组 ID。 返回: 成功
remote_group_id 字符串	要与此安全组规则关联的远程安全组 ID。 返回: 成功
remote_ip_prefix 字符串	要与此安全组规则关联的远程 IP 前缀。 返回: 成功
revision_number 字符串	要与此安全组规则关联的远程 IP 前缀。 返回: 成功 示例: "0.0.0.0/0"
security_group_id 字符串	要与此安全组规则关联的安全组 ID。 返回: 成功 示例: "729b9660-a20a-41fe-bae6-ed8fa7f69123"
tags 字符串	要与此安全组规则关联的安全组 ID。 返回: 成功 示例: "729b9660-a20a-41fe-bae6-ed8fa7f69123"
tenant_id 字符串	项目的 ID。已弃用。 返回: 成功 示例: "e4f50856753b4dc6afee5fa6b9b6c550"
updated_at 字符串	资源更新的时间（UTC ISO8601 格式）。 返回: 成功 示例: "2018-03-19T19:16:56Z"

作者

• OpenStack Ansible SIG

集合链接

• 问题跟踪器
• 存储库（源）