cisco.aci.aci_epg_useg_attribute_block_statement 模块 – 管理 EPG useg 属性块语句 (fv:SCrtrn)

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.aci.aci_epg_useg_attribute_block_statement。

概要

• 管理 EPG useg 属性块语句

参数

参数	注释
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 的值。
epg 别名：epg_name 字符串	现有端点组的名称。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改为使用环境变量 ACI_HOST 的值。
match 字符串	块语句的匹配类型。 在创建期间未设置时，APIC 默认值为 any。 选项 "any" "all"
name 别名：block_statement, block_statement_name 字符串	块语句的名称。
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 的值。
parent_block_statements 别名：blocks, parent_blocks 列表 / 元素=字符串	父块语句的列表。 提供的列表的顺序很重要，假设列表为 [“A”, “B”]。 块语句 “A” 将是 “B” 的父级。 块语句 “A” 将是默认块语句的子级。 父块语句的最大数量为 2。
password 字符串	用于身份验证的密码。 此选项与private_key互斥。如果同时提供了private_key，则将优先使用它。 如果在任务中未指定此值，则将改用环境变量ACI_PASSWORD或ANSIBLE_NET_PASSWORD的值。
端口 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果在任务中未指定此值，则将改用环境变量ACI_PORT的值。
私钥 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果同时提供了password，则将忽略它。 如果在任务中未指定此值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
状态 字符串	使用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_name 字符串	现有租户的名称。
超时 整数	以秒为单位的套接字级别超时。 如果在任务中未指定此值，则将改用环境变量ACI_TIMEOUT的值。 默认值为30。
使用代理 布尔值	如果为false，即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果在任务中未指定此值，则将改用环境变量ACI_USE_PROXY的值。 默认值为true。 选项 false true
使用SSL 布尔值	如果为false，则将使用HTTP连接而不是默认的HTTPS连接。 如果在任务中未指定此值，则将改用环境变量ACI_USE_SSL的值。 当连接为本地连接时，默认值为true。 选项 false true
用户名 别名：user 字符串	用于身份验证的用户名。 如果在任务中未指定此值，则将改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为admin。
验证证书 布尔值	如果为false，则不会验证SSL证书。 只有在使用自签名证书的个人控制站点上才应将其设置为false。 如果在任务中未指定此值，则将改用环境变量ACI_VALIDATE_CERTS的值。 默认值为true。 选项 false true

备注

注意

• 在您的playbook中使用此模块之前，必须存在使用的租户、ap和epg。cisco.aci.aci_tenant、cisco.aci.aci_ap和cisco.aci.aci_epg模块可用于此目的。

另请参见

另请参见

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_ap

管理顶级应用程序配置文件 (AP) 对象 (fv:Ap)。

cisco.aci.aci_epg

管理端点组 (EPG) 对象 (fv:AEPg)。

APIC管理信息模型参考

有关内部APIC类fv:SCrtrn的更多信息。

Cisco ACI指南

有关如何使用Ansible管理您的ACI基础设施的详细信息。

开发Cisco ACI模块

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

示例

- name: Add a new block statement
  cisco.aci.aci_epg_useg_attribute_block_statement:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    name: block_a
    state: present
  delegate_to: localhost

- name: Add a new nested block statement
  cisco.aci.aci_epg_useg_attribute_block_statement:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    parent_block_statements:
      - block_a
      - block_b
    name: block_c
    match: any
    state: present
  delegate_to: localhost

- name: Query a block statement
  cisco.aci.aci_epg_useg_attribute_block_statement:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    name: block_a
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all block statements
  cisco.aci.aci_epg_useg_attribute_block_statement:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove an existing block statement
  cisco.aci.aci_epg_useg_attribute_block_statement:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    name: block_a
    state: absent
  delegate_to: localhost

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
当前 列表 / 元素=字符串	模块完成后的APIC现有配置 返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	APIC返回的错误信息 返回：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
过滤字符串 字符串	用于请求的过滤字符串 返回：失败或调试 示例："?rsp-prop-include=config-only"
方法 字符串	用于向APIC发送请求的HTTP方法 返回：失败或调试 示例："POST"
先前 列表 / 元素=字符串	模块启动前APIC的原始配置 返回：信息 示例：[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
建议 字典	用户提供的参数组装的配置 返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始 字符串	APIC REST API返回的原始输出 (xml或json) 返回：解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
响应 字符串	APIC返回的HTTP响应 返回：失败或调试 示例： "OK (30 bytes)"
已发送 列表 / 元素=字符串	实际/最小配置已推送到APIC 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
状态 整数	APIC返回的HTTP状态码 返回：失败或调试 示例： 200
URL 字符串	用于向APIC发送请求的HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Akini Ross (@akinross)

资源链接

• 问题追踪器
• 代码库 (源代码)