cisco.aci.aci_syslog_remote_dest 模块 – 管理 Syslog 远程目标 (syslog:RemoteDest)

注意

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

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

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

要在剧本中使用它，请指定：cisco.aci.aci_syslog_remote_dest。

概要

• 管理现有 syslog 组对象中的 syslog 消息的远程目标。

参数

参数	注释
admin_state 字符串	syslog 远程目标的管理状态 选择 "enabled" "disabled"
annotation 字符串	用于注释对象的用户定义字符串。 如果任务中未指定值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定值，并且环境变量 ACI_ANNOTATION 也未指定，则将使用默认值。 默认值： "orchestrator:ansible"
certificate_name 别名：cert_name 字符串	附加到用于基于签名身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则此默认值为 private_key 的基本名称，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则此默认值为 username 值。 如果任务中未指定值，则将改为使用环境变量 ACI_CERTIFICATE_NAME 的值。
description 字符串	远程目标的描述
destination 字符串	用于发送 syslog 消息的主机名或 IP 地址
facility 字符串	syslog 消息的转发工具 选择 "local0" "local1" "local2" "local3" "local4" "local5" "local6" "local7"
format 字符串	syslog 消息的格式 选择 "aci" "nxos"
group 别名：syslog_group, syslog_group_name 字符串	现有 syslog 组的名称
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将改为使用环境变量 ACI_HOST 的值。
mgmt_epg 字符串	用于发送 syslog 消息的管理 EPG 的名称
name 别名：remote_destination_name, remote_destination 字符串	syslog 远程目标的名称
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 的值。
private_key 别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则会被忽略。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
severity 字符串	发送到远程 syslog 的消息的严重性 选择 "alerts" "critical" "debugging" "emergencies" "error" "information" "notifications" "warnings"
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
syslog_port 整数	用于发送 syslog 消息的 UDP 端口
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 类 syslog:RemoteDest 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a syslog remote destination
  cisco.aci.aci_syslog_remote_dest:
    host: apic
    username: admin
    password: SomeSecretPassword
    group: my_syslog_group
    facility: local7
    destination: 10.20.30.40
    syslog_port: 5678
    mgmt_epg: oob-default
    state: present
  delegate_to: localhost

- name: Delete syslog remote destination
  cisco.aci.aci_syslog_remote_dest:
    host: apic
    username: admin
    password: SomeSecretPassword
    group: my_syslog_group
    destination: 10.20.30.40
    state: absent
  delegate_to: localhost

- name: Query a syslog remote destination
  cisco.aci.aci_syslog_remote_dest:
    host: apic
    username: admin
    password: SomeSecretPassword
    group: my_syslog_group
    destination: 10.20.30.40
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all syslog remote destinations
  cisco.aci.aci_syslog_remote_dest:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
current 列表 / elements=字符串	模块完成后 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 列表 / elements=字符串	模块启动之前 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 列表 / elements=字符串	推送到 APIC 的实际/最小配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}
status 整数	来自 APIC 的 HTTP 状态 返回: 失败或调试 示例: 200
url 字符串	用于向 APIC 发出请求的 HTTP URL 返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

集合链接

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