mso_remote_location

Manage remote locations on Cisco Multi-Site Orchestrator

Collection: cisco.mso

Full Name: cisco.mso.mso_remote_location

Synopsis

Manage remote locations on Cisco Multi-Site Orchestrator

Parameters

Name	Type	Default	Description
host	string		IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable C(MSO_HOST) will be used instead.
port	int		Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable C(MSO_PORT) will be used instead.
username	string		The username to use for authentication. If the value is not specified in the task, the value of environment variables C(MSO_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead.
password	string		The password to use for authentication. If the value is not specified in the task, the value of environment variables C(MSO_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead.
output_level	string	`normal`	Influence the output of this MSO module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(MSO_OUTPUT_LEVEL) will be used instead.
timeout	int		The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable C(MSO_TIMEOUT) will be used instead.
use_proxy	bool		If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(MSO_USE_PROXY) will be used instead. The default is C(true).
use_ssl	bool		If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(MSO_USE_SSL) will be used instead. When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_use_ssl) will be used if this attribute is not specified. The default is C(false) when using a HTTPAPI connection plugin (mso or nd) and C(true) when using the legacy connection method (only for mso).
validate_certs	bool		If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(MSO_VALIDATE_CERTS) will be used instead. The default is C(true).
login_domain	string		The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable C(MSO_LOGIN_DOMAIN) will be used instead. When using a HTTPAPI connection plugin the inventory variable C(ansible_httpapi_login_domain) will be used if this attribute is not specified.
remote_location	string		The remote location’s name.
description	string		The remote location’s description.
remote_protocol	string		The protocol used to export to the remote server. If the remote location is a Windows server, you must use the C(sftp) protocol.
remote_host	string		The host name or IP address of the remote server.
remote_path	string		The full path to a directory on the remote server where backups are saved. The path must start with a slash (/) character and must not contain periods (.) or backslashes (). The directory must already exist on the server.
remote_port	int	`22`	The port used to connect to the remote server.
authentication_type	string		The authentication method used to connect to the remote server.
remote_username	string		The username used to log in to the remote server.
remote_password	string		The password used to log in to the remote server.
remote_ssh_key	string		The private ssh key used to log in to the remote server. The private ssh key must be provided in PEM format. The private ssh key must be a single line string with linebreaks represent as “\n”.
remote_ssh_passphrase	string		The private ssh key passphrase used to log in to the remote server.
state	string	`present`	Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects.

Example

yaml

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

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

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

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