Try SpotterImplements Ansible module for switch configuration backup and restore.
| "added in version" 2.6.0 of arubanetworks.aos_switch"
Authors: Ashish Pant (@hpe)
preview | supported by community
Install with ansible-galaxy collection install arubanetworks.aos_switch:==1.7.0
collections:
- name: arubanetworks.aos_switch
version: 1.7.0This implement rest api's which can be used to backup switch configuration from server. Module takes 5 secs to execute each task. Default module action is to restore the configuration. Use config_type for configuration backup
- name: backup configuration files
arubaoss_config_bkup:
file_name: test1
server_type: ST_TFTP
server_ip: 192.168.1.2
- name: backup configuration files
arubaoss_config_bkup:
file_name: test1
config_type: CT_RUNNING_CONFIG
host:
description: 'Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as the destination
address for the transport.
'
type: str
port:
description: 'Specifies the port to use when building the connection to the remote
device.
'
type: int
state:
default: create
description:
- Adding or reading data
required: false
timeout:
description: 'Specifies the timeout in seconds for communicating with the network
device for either connecting or sending commands. If the timeout is exceeded before
the operation is completed, the module will error.
'
type: int
use_ssl:
description: 'Configures use SSL (HTTPS) for access to the remote device.
'
type: bool
password:
description: 'Specifies the password to use to authenticate the connection to the
remote device. This value is used to authenticate the SSH session. If the value
is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
will be used instead.
'
type: str
provider:
description: A dict object containing connection details.
suboptions:
api_version:
default: None
description: 'Configures (force) API version (vX.Y) for acces to the remote device.
'
type: str
host:
description: 'Specifies the DNS host name or address for connecting to the remote
device over the specified transport. The value of host is used as the destination
address for the transport.
'
type: str
password:
description: 'Specifies the password to use to authenticate the connection to
the remote device. This value is used to authenticate the SSH session. If the
value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD
will be used instead.
'
type: str
port:
description: 'Specifies the port to use when building the connection to the remote
device.
'
type: int
ssh_keyfile:
description: 'Specifies the SSH key to use to authenticate the connection to the
remote device. This value is the path to the key used to authenticate the SSH
session. If the value is not specified in the task, the value of environment
variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
'
type: path
timeout:
description: 'Specifies the timeout in seconds for communicating with the network
device for either connecting or sending commands. If the timeout is exceeded
before the operation is completed, the module will error.
'
type: int
transport:
default: aossapi
description: 'Configures the transport (aossapi or network_cli) mode.
'
type: str
use_proxy:
default: false
description: 'Configures use (Local) Proxy for access to the remote device.
'
type: bool
use_ssl:
description: 'Configures use SSL (HTTPS) for access to the remote device.
'
type: bool
username:
description: 'Configures the username to use to authenticate the connection to
the remote device. This value is used to authenticate the SSH session. If the
value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
will be used instead.
'
type: str
validate_certs:
default: false
description: 'Configures validation of certification for access to the remote
device.
'
type: bool
type: dict
username:
description: 'Configures the username to use to authenticate the connection to the
remote device. This value is used to authenticate the SSH session. If the value
is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME
will be used instead.
'
type: str
file_name:
description:
- configuration file name
required: true
server_ip:
description:
- Server ip address in which file is stored. Not applicable for ST_FLASH
required: false
sftp_port:
default: 22
description:
- TCP port number. Applicable for ST_SFTP.
required: false
user_name:
description: SFTP server Username
required: false
api_version:
default: None
description: 'Configures (force) API version (vX.Y) for acces to the remote device.
'
type: str
config_type:
choices:
- CT_RUNNING_CONFIG
- CT_STARTUP_CONFIG
description:
- Type of configuration file. If this option is used, configuration file is saved
to the system.
required: false
server_name:
description:
- Server name in which file is stored. Not applicable for ST_FLASH.
required: false
server_type:
choices:
- ST_FLASH
- ST_TFTP
- ST_SFTP
description:
- server type from/to which configuration needs to be copied
required: false
ssh_keyfile:
description: 'Specifies the SSH key to use to authenticate the connection to the remote
device. This value is the path to the key used to authenticate the SSH session.
If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE
will be used instead.
'
type: path
recover_mode:
description:
- To enable or disable recovery mode. Not applicable if is_forced_reboot_enabled is
true
required: false
forced_reboot:
description:
- Apply the configuration with reboot if the configuration has reboot required commands
required: false
server_passwd:
description: SFTP server password
required: false
validate_certs:
default: false
description: 'Configures validation of certification for access to the remote device.
'
type: bool
wait_for_apply:
default: true
description:
- Wait if there is already an ongoing configuration change on device.
required: false