cisco.aci.aci_file_remote_path 模块 – 管理导入/导出文件远程路径 (file:RemotePath)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中的导入/导出文件远程路径。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，且环境变量 ACI_ANNOTATION 也未设置，则将使用默认值。 默认值： "orchestrator:ansible"
auth_type 字符串	远程主机的身份验证类型。 如果协议为 ftp，则不能设置为 ssh_key。 选项 "password" "ssh_key"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
description 字符串	文件远程路径的描述。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
management_epg 字符串	连接到远程主机的管理 EPG。
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 的值。
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的值。
remote_host 字符串	远程主机的主机名或IP地址。
remote_password 字符串	访问远程主机的密码。 仅当auth_type为password时使用。 提供此选项将始终导致更改，因为它是一个无法从APIC检索的安全属性。
remote_path 字符串	数据将在远程主机上驻留的路径。
remote_port 整数	访问远程主机的端口。
remote_protocol 字符串	用于连接到远程主机的协议。 选项 "ftp" "scp" "sftp"
remote_ssh_key 别名：remote_key 字符串	用于访问远程主机的私有SSH密钥。 仅当auth_type为ssh_key时使用。 提供此选项将始终导致更改，因为它是一个无法从APIC检索的安全属性。
remote_ssh_passphrase 别名：passphrase 字符串	用于解码private_key的密码短语。 仅当auth_type为ssh_key时使用。 提供此选项将始终导致更改，因为它是一个无法从APIC检索的安全属性。
remote_user 字符串	访问远程主机的用户名。
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
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类file:RemotePath的更多信息。

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Add a Remote Path
  cisco.aci.aci_file_remote_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_remote_path
    remote_host: test.example.com
    remote_port: 22
    remote_protocol: scp
    remote_user: test_user
    auth_type: password
    remote_password: test_pass
    remote_path: /tmp
    state: present
  delegate_to: localhost

- name: Query a Remote Path
  cisco.aci.aci_file_remote_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_remote_path
    state: query
  delegate_to: localhost

- name: Query all Remote Paths
  cisco.aci.aci_file_remote_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove a Remote Path
  cisco.aci.aci_file_remote_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_remote_path
    state: absent
  delegate_to: localhost

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后的APIC现有配置 返回值：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	APIC返回的错误信息 返回值：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	请求使用的过滤器字符串 返回值：失败或调试 示例："?rsp-prop-include=config-only"
method 字符串	对APIC发出的请求使用的HTTP方法 返回值：失败或调试 示例："POST"
previous 列表 / 元素=字符串	模块启动前APIC的原始配置 返回值：信息 示例：[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	用户提供的参数组装的配置 返回值：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw 字符串	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>"
response 字符串	来自APIC的HTTP响应 返回值：失败或调试 示例："OK (30 bytes)"
sent 列表 / 元素=字符串	实际/最小推送到APIC的配置 返回值：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment"}}}
status 整数	来自APIC的HTTP状态 返回值：失败或调试 示例：200
url 字符串	对APIC发出的请求使用的HTTP url 返回值：失败或调试 示例："https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Tim Cragg (@timcragg)

集合链接

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