/ home / arubanetworks / arubanetworks.aoscx / 4.3.2 / module / aoscx_backup_config

arubanetworks.aoscx.aoscx_backup_config (4.3.2) — module

Download an existing configuration from AOS-CX switch.

| "added in version" 2.8.0 of arubanetworks.aoscx"

Authors: Aruba Networks (@ArubaNetworks)

preview | supported by certified

Install collection

Install with ansible-galaxy collection install arubanetworks.aoscx:==4.3.2

Add to requirements.yml

  collections:
    - name: arubanetworks.aoscx
      version: 4.3.2

Description

This module downloads an existing configuration from AOS-CX devices.

Usage examples

Scanned by Steampunk Spotter

 - name: Copy Running Config to local as JSON
   aoscx_backup_config:
     config_name: running-config
     output_file: /home/admin/running-config.json

Scanned by Steampunk Spotter

 - name: Copy Startup Config to local as JSON
   aoscx_backup_config:
     config_name: startup-config
     output_file: /home/admin/startup-config.json

Scanned by Steampunk Spotter

 - name: Copy Checkpoint Config to local as JSON
   aoscx_backup_config:
     config_name: checkpoint1
     output_file: /home/admin/checkpoint1.json

Scanned by Steampunk Spotter

 - name: Copy Running Config to TFTP server as JSON
   aoscx_backup_config:
     config_name: running-config
     remote_output_file_tftp_path: tftp://192.168.1.2/running.json
     config_type: json
     vrf: mgmt

Scanned by Steampunk Spotter

 - name: Copy Running Config to TFTP server as CLI
   aoscx_backup_config:
     config_name: running-config
     remote_output_file_tftp_path: tftp://192.168.1.2/running.cli
     config_type: cli
     vrf: mgmt

Scanned by Steampunk Spotter

 - name: Copy Startup Config to TFTP server as CLI
   aoscx_backup_config:
     config_name: startup-config
     remote_output_file_tftp_path: tftp://192.168.1.2/startup.cli
     config_type: cli
     vrf: mgmt

Inputs

    
vrf:
    description: 'VRF to be used to contact TFTP server, required if remote_output_file_tftp_path
      is provided.

      '
    required: false
    type: str

sort_json:
    default: true
    description: flag whether or not to sort JSON config
    required: false
    type: bool

config_name:
    default: running-config
    description: 'Config file or checkpoint to be downloaded. When using TFTP only running-config
      or startup-config can be used.

      '
    required: false
    type: str

config_type:
    choices:
    - json
    - cli
    default: json
    description: 'Configuration type to be downloaded, JSON or CLI version of the config.

      '
    required: false
    type: str

output_file:
    description: 'File name and path for locally downloading configuration, only JSON
      version of configuration will be downloaded.

      '
    required: false
    type: str

remote_output_file_tftp_path:
    description: 'TFTP server address and path for copying off configuration, must be
      reachable through provided vrf.

      '
    required: false
    type: str