community.general.icx_copy (0.1.1) — module

Transfer files from or to remote Ruckus ICX 7000 series switches

Authors: Ruckus Wireless (@Commscope)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module transfers files from or to remote devices running ICX.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: upload running-config to the remote scp server
  icx_copy:
    upload: running-config
    protocol: scp
    remote_server: 172.16.10.49
    remote_filename: running.conf
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: download running-config from the remote scp server
  icx_copy:
    download: running-config
    protocol: scp
    remote_server: 172.16.10.49
    remote_filename: running.conf
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: download running-config from the remote scp server using rsa public key
  icx_copy:
    download: running-config
    protocol: scp
    remote_server: 172.16.10.49
    remote_filename: running.conf
    remote_user: user1
    remote_pass: pass123
    public_key: rsa
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: upload startup-config to the remote https server
  icx_copy:
    upload: startup-config
    protocol: https
    remote_server: 172.16.10.49
    remote_filename: config/running.conf
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: upload startup-config to the remote https server
  icx_copy:
    upload: startup-config
    protocol: https
    remote_server: 172.16.10.49
    remote_filename: config/running.conf
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Download OS image into the flash from remote scp ipv6 server
  icx_copy:
    download: startup-config
    protocol: scp
    remote_server: ipv6 FE80:CD00:0000:0CDE:1257:0000:211E:729C
    remote_filename: img.bin
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Download OS image into the secondary flash from remote scp ipv6 server
  icx_copy:
    Download: flash_secondary
    protocol: scp
    remote_server: ipv6 FE80:CD00:0000:0CDE:1257:0000:211E:729C
    remote_filename: img.bin
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Download OS image into the secondary flash from remote scp ipv6 server on port 5000
  icx_copy:
    Download: flash_secondary
    protocol: scp
    remote_server: ipv6 FE80:CD00:0000:0CDE:1257:0000:211E:729C
    remote_port: 5000
    remote_filename: img.bin
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Download OS image into the primary flash from remote https ipv6 server
  icx_copy:
    Download: flash_primary
    protocol: https
    remote_server: ipv6 FE80:CD00:0000:0CDE:1257:0000:211E:729C
    remote_filename: images/img.bin
    remote_user: user1
    remote_pass: pass123
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Download OS image into the primary flash from remote https ipv6 server on port 8080
  icx_copy:
    Download: flash_primary
    protocol: https
    remote_server: ipv6 FE80:CD00:0000:0CDE:1257:0000:211E:729C
    remote_port: 8080
    remote_filename: images/img.bin
    remote_user: user1
    remote_pass: pass123

Inputs

    
upload:
    choices:
    - running-config
    - startup-config
    - flash_primary
    - flash_secondary
    description:
    - Name of the resource to be uploaded. Mutually exclusive with download.
    type: str

download:
    choices:
    - running-config
    - startup-config
    - flash_primary
    - flash_secondary
    - bootrom
    - fips-primary-sig
    - fips-secondary-sig
    - fips-bootrom-sig
    description:
    - Name of the resource to be downloaded. Mutually exclusive with upload.
    type: str

protocol:
    choices:
    - scp
    - https
    description:
    - Data transfer protocol to be used
    required: true
    type: str

public_key:
    choices:
    - rsa
    - dsa
    description:
    - public key type to be used to login to scp server
    type: str

remote_pass:
    description:
    - remote password to be used for scp login.
    type: str

remote_port:
    description:
    - The port number of the remote host. Default values will be selected based on protocol
      type. Default scp:22, http:443
    type: str

remote_user:
    description:
    - remote username to be used for scp login.
    type: str

remote_server:
    description:
    - IP address of the remote server
    required: true
    type: str

remote_filename:
    description:
    - The name or path of the remote file/resource to be uploaded or downloaded.
    required: true
    type: str

Outputs

changed:
  description: true when downloaded any configuration or flash. false otherwise.
  returned: always
  type: bool