cisco.aci.aci_system_banner 模块 – 管理别名和横幅 (aaa:PreLoginBanner)

注意

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

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

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

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

概要

• 管理 Cisco ACI 交换矩阵上的别名和横幅。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果未在任务中指定值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果未在任务中指定值，且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
application_banner 字符串	应用程序横幅消息。
certificate_name 别名：cert_name 字符串	用于基于签名的身份验证的附加到 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 的值。 如果未在任务中指定值，则将改为使用环境变量 ACI_CERTIFICATE_NAME 的值。
controller_banner 字符串	在用户登录身份验证之前显示的 CLI 信息横幅的内容。 CLI 横幅是以文本字符串形式打印到控制台的内容，按原样显示。
description 字符串	AAA 登录横幅的描述。
gui_alias 字符串	系统 GUI 别名。
gui_banner 字符串	在用户登录身份验证之前显示的 GUI 信息横幅的内容。 当 gui_banner 以 http:// 或 https:// 开头时，横幅将为 URL 类型。 请注意，URL 网站所有者必须允许将该网站放置在 iFrame 中以显示信息横幅。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果未在任务中指定值，则将改为使用环境变量 ACI_HOST 的值。
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 的值。
owner_key 字符串	用于 ACI 对象的 ownerKey 属性的用户定义字符串。 此属性表示用于使客户端能够拥有其用于实体关联的数据的密钥。 如果未在任务中指定值，则将改为使用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的用户定义字符串。 此属性表示一个标签，使客户端能够添加自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定值，则将改用环境变量 ACI_OWNER_TAG 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将使用它。 如果任务中未指定值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定值，则将改用环境变量 ACI_PORT 的值。
private_key 别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
severity 字符串	应用程序横幅的严重性。 选择 "critical" "info" "major" "minor" "warning"
state 字符串	使用 present 进行更新。 使用 query 列出对象。 选择 "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
switch_banner 字符串	交换机横幅消息。
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

参见

另请参阅

APIC 管理信息模型参考

有关内部 APIC 类 aaa:PreLoginBanner 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Configure banner
  cisco.aci.aci_system_banner:
    host: apic
    username: admin
    password: SomeSecretPassword
    gui_alias: "Test GUI Alias"
    controller_banner: "Test Controller Banner"
    application_banner: "Test Application Banner"
    severity: critical
    switch_banner: "Test Switch Banner"
    gui_banner: "Test GUI Banner"
    state: present
  delegate_to: localhost

- name: Configure banner with a url
  cisco.aci.aci_system_banner:
    host: apic
    username: admin
    password: SomeSecretPassword
    gui_alias: "Test GUI Alias"
    controller_banner: "Test Controller Banner Message"
    application_banner: "Test Application Banner"
    severity: critical
    switch_banner: "Test Switch Banner Message"
    gui_banner: https://www.cisco.com
    state: present
  delegate_to: localhost

- name: Query banner
  cisco.aci.aci_system_banner:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

返回值

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

键	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "生产 环境", "dn": "uni/tn-production", "name": "生产", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 返回: 失败 示例: {"code": "122", "text": "未知的 托管 对象 类 foo"}
filter_string 字符串	用于请求的过滤器字符串 返回: 失败或调试 示例: "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发送请求的 HTTP 方法 返回: 失败或调试 示例: "POST"
previous list / elements=string	模块启动之前，来自 APIC 的原始配置 返回: 信息 示例: [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "生产", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	从用户提供的参数组装的配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产 环境", "name": "生产"}}}
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 list / elements=string	推送给 APIC 的实际/最小配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}
状态 整数	来自 APIC 的 HTTP 状态 返回: 失败或调试 示例: 200
URL 字符串	用于向 APIC 发送请求的 HTTP URL 返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

• Akini Ross (@akinross)

集合链接

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