cisco.mso.mso_remote_location 模块 – 管理远程位置

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.mso。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定： cisco.mso.mso_remote_location。

概要

• 管理 Cisco ACI 多站点上的远程位置。

要求

以下是执行此模块的主机所需的条件。

• 多站点编排器 v2.1 或更高版本

参数

参数	注释
authentication_type 字符串	用于连接到远程服务器的认证方法。 选项 "password" "ssh"
description 字符串	远程位置的描述。
host 别名：hostname 字符串	ACI 多站点编排器主机的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 MSO_HOST 的值。
login_domain 字符串	用于身份验证的登录域名称。 默认值为 Local。 如果任务中未指定此值，则将使用环境变量 MSO_LOGIN_DOMAIN 的值。 使用 HTTPAPI 连接插件时，如果未指定此属性，则将使用清单变量 ansible_httpapi_login_domain。
output_level 字符串	影响此 MSO 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定此值，则将使用环境变量 MSO_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← (默认)
password 字符串	用于身份验证的密码。 如果任务中未指定此值，则将使用环境变量 MSO_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 `use_ssl`。 如果任务中未指定此值，则将使用环境变量 MSO_PORT 的值。
remote_host 字符串	远程服务器的主机名或 IP 地址。
remote_location 别名：name 字符串	远程位置的名称。
remote_password 字符串	用于登录远程服务器的密码。
remote_path 字符串	远程服务器上保存备份的目录的完整路径。 路径必须以斜杠 (/) 字符开头，并且不能包含句点 (.) 或反斜杠 (\)。 该目录必须已存在于服务器上。
remote_port 整数	用于连接到远程服务器的端口。 默认值： 22
remote_protocol 字符串	用于导出到远程服务器的协议。 如果远程位置是 Windows 服务器，则必须使用 sftp 协议。 选项 "scp" "sftp"
remote_ssh_key 字符串	用于登录远程服务器的私有 ssh 密钥。 私有 ssh 密钥必须以 PEM 格式提供。 私有 ssh 密钥必须是单行字符串，换行符表示为“\n”。
remote_ssh_passphrase 字符串	用于登录远程服务器的私有 ssh 密钥密码。
remote_username 字符串	用于登录远程服务器的用户名。
state 字符串	使用 present 或 absent 来添加或删除。 使用 query 来列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
timeout 整数	以秒为单位的套接字级别超时。 默认值为 30 秒。 如果任务中未指定此值，则将使用环境变量 MSO_TIMEOUT 的值。
use_proxy 布尔值	如果为 false，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定此值，则将使用环境变量 MSO_USE_PROXY 的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为 false，将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定此值，则将改用环境变量 MSO_USE_SSL 的值。 当使用 HTTPAPI 连接插件时，如果未指定此属性，将使用清单变量 ansible_httpapi_use_ssl。 使用 HTTPAPI 连接插件 (mso 或 nd) 时，默认值为 false；使用传统连接方法 (仅限 mso) 时，默认值为 true。 选项 false true
username 字符串	用于身份验证的用户名。 如果任务中未指定此值，则将改用环境变量 MSO_USERNAME 或 ANSIBLE_NET_USERNAME 的值。
validate_certs 布尔值	如果为 false，则不会验证 SSL 证书。 只有在使用自签名证书的个人控制站点上时，才应将其设置为 false。 如果任务中未指定此值，则将改用环境变量 MSO_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true

备注

注意

• 此模块编写用于支持 Multi Site Orchestrator v2.1 或更高版本。在早期版本上，某些或所有功能可能无法正常工作。

示例

- name: Query all remote locations
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    state: query
  register: backups

- name: Query a remote location
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    remote_location: ansible_test
    state: query
  register: query_result

- name: Configure a remote location
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    remote_location: ansible_test
    remote_protocol: scp
    remote_host: 10.0.0.1
    remote_path: /username/backup
    remote_authentication_type: password
    remote_username: username
    remote_password: password
    state: present

- name: Delete a remote location
  cisco.mso.mso_remote_location:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    remote_location: ansible_test
    state: absent

作者

• Akini Ross (@akinross)

资源链接

• 问题追踪器
• 主页
• 代码仓库