cisco.aci.aci_esg 模块 – 管理端点安全组 (ESG) 对象 (fv:ESg)

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.aci。

要在 Playbook 中使用它，请指定：cisco.aci.aci_esg。

概要

• 管理 Cisco ACI 结构上的端点安全组 (ESG)。

参数

参数	注释
admin_state 布尔值	使用 false 将 ESG 管理状态设置为“管理启动”，这是默认值。 使用 true 将 ESG 管理状态设置为“管理关闭” 选项 false true
annotation 字符串	用于注释对象的用户定义字符串。 如果任务中未指定该值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定该值且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
ap 别名：app_profile，app_profile_name 字符串	应用程序配置文件的名称。
certificate_name 别名：cert_name 字符串	附加到用于基于签名身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则此项默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则此项默认为 username 值。 如果任务中未指定该值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名：descr 字符串	端点安全组描述。
esg 别名：esg_name，name 字符串	端点安全组的名称。
host 别名：hostname 字符串	可通过 Ansible 控制主机解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。
intra_esg_isolation 字符串	Intra ESG 隔离的默认值为 unenforced。 选项 “enforced” “unenforced”
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 “debug” “info” "normal" ← (默认)
output_path 字符串	将用于转储模块生成的 ACI JSON 配置文件的文件路径。 如果任务中未指定该值，则将使用环境变量 ACI_OUTPUT_PATH 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改为使用它。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将改用环境变量 ACI_PORT 的值。
preferred_group_member 字符串	Preferred Group Member 的默认值为 exclude。 选项 "exclude" "include"
private_key 别名：cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响所使用的默认 certificate_name。 此选项与 password 互斥。如果同时提供了 password，则将被忽略。 如果任务中未指定该值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
state 字符串	使用 present 或 absent 添加或删除。 使用 query 列出单个或多个对象。 选项 "absent" "present" ←（默认） "query"
suppress_previous 别名：no_previous, ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 来检查先前状态。 如果任务中未指定该值，则将改用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新后，不会发送验证 GET。 如果任务中未指定该值，则将改用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前的返回值设置为建议的值。 在单个任务中，包括默认值在内的当前对象将无法验证。 选项 false true
tenant 别名：tenant_name 字符串	租户的名称。
timeout 整数	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将改用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy 布尔值	如果为 false，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将改用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将改用环境变量 ACI_USE_SSL 的值。 当连接为本地时，默认值为 true。 选项 false true
username 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定该值，则将改用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将改用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true
vrf 别名：vrf_name 字符串	VRF 的名称

参见

另请参见

cisco.aci.aci_aep_to_domain

将 AEP 绑定到物理或虚拟域 (infra:RsDomP)。

APIC 管理信息模型参考

有关内部 APIC 类 infra:AttEntityP 和 infra:ProvAcc 的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础架构的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以进行贡献的详细指南。

示例

- name: Add a new ESG
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    esg: web_esg
    vrf: 'default'
    description: Web Intranet ESG
    state: present
  delegate_to: localhost

- name: Add list of ESGs
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    esg: "{{ item.esg }}"
    description: Ticketing ESG
    vrf: 'default'
    state: present
  delegate_to: localhost
  with_items:
    - esg: web
    - esg: database

- name: Query an ESG
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    esg: web_esg
    state: query
  delegate_to: localhost

- name: Query all ESGs
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Query all ESGs with a Specific Name
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    esg: web_esg
    state: query
  delegate_to: localhost

- name: Query all ESGs of an App Profile
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    ap: ticketing
    state: query
  delegate_to: localhost

- name: Remove an ESG
  cisco.aci.aci_esg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    app_profile: intranet
    esg: web_esg
    state: absent
  delegate_to: localhost

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后，来自 APIC 的现有配置 返回：成功 示例： [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 返回：失败 示例： {"code": "122", "text": "未知的受管对象类 foo"}
filter_string 字符串	用于请求的筛选字符串 返回：失败或调试 示例： "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发送请求的 HTTP 方法 返回：失败或调试 示例： "POST"
previous 列表 / 元素=字符串	模块启动前来自 APIC 的原始配置 返回：信息 示例： [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	从用户提供的参数组装的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}
raw 字符串	APIC REST API 返回的原始输出（xml 或 json） 返回：解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知的受管对象类 foo\"/></imdata>"
response 字符串	来自 APIC 的 HTTP 响应 返回：失败或调试 示例： "OK (30 字节)"
sent 列表 / 元素=字符串	推送给 APIC 的实际/最小配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "生产环境"}}}
status 整数	来自 APIC 的 HTTP 状态 返回：失败或调试 示例： 200
url 字符串	用于向 APIC 发送请求的 HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Sabari Jaganathan (@sajagana)

集合链接

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