Skip to content

Commit

Permalink
fix doc and examples for issue#51
Browse files Browse the repository at this point in the history
- the example in .md for aoscx_upload_config is incorrect and the
wording is incorrect for some parameters
- the wording and example needs to be modified for clarity in
aoscx_upload_config.py

(cherry picked from commit 07f7e7eb08527d32d7a4f3234d93cd500b7a189c)
  • Loading branch information
tchiapuziowong authored and Kattia Chaves Ramirez committed Jun 8, 2023
1 parent b42ae3e commit 7e15776
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
22 changes: 11 additions & 11 deletions docs/aoscx_upload_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@ or it can also upload the configuration from a TFTP server.

```YAML
config_name:
description: "Config file or checkpoint to be uploaded to. When using TFTP
only running-config or startup-config can be used"
description: >
Switch config file to be uploaded to, only running-config or startup-config can be used
type: str
default: 'running-config'
required: false
config_json:
description: "JSON file name and path for locally uploading configuration,
only JSON version of configuration can be uploaded"
description: >
JSON file name and path for locally uploading configuration, only JSON version of configuration can be uploaded
type: str
required: false
config_file:
description: "File name and path for locally uploading configuration,
will be converted to JSON,
only JSON version of configuration can be uploaded"
description: >
File name and path of JSON formatted config for locally
uploading configuration, will be converted to JSON, CLI NOT SUPPORTED
type: str
required: false
remote_config_file_tftp_path:
description: "TFTP server address and path for uploading configuration,
can be JSON or CLI format, must be reachable through provided vrf
ex) tftp://192.168.1.2/config.txt"
description: >
TFTP server address and path for uploading configuration,
can be JSON or CLI format, must be reachable through provided vrf ex) tftp://192.168.1.2/config.txt
type: str
required: false
vrf:
Expand All @@ -43,7 +43,7 @@ or it can also upload the configuration from a TFTP server.
- name: Copy Running Config from local JSON file as JSON
aoscx_upload_config:
config_name: 'running-config'
remote_config_file_tftp_path: '/user/admin/running.json'
config_file: '/user/admin/running.json'

- name: Copy Running Config from TFTP server as JSON
aoscx_upload_config:
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/aoscx_upload_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
options:
config_name:
description: >
Config file or checkpoint to be uploaded to. When using TFTP only
running-config or startup-config can be used.
Switch config file to be uploaded to, only running-config or
startup-config can be used
type: str
default: 'running-config'
required: false
Expand Down Expand Up @@ -62,7 +62,7 @@
- name: Copy Running Config from local JSON file as JSON
aoscx_upload_config:
config_name: 'running-config'
config_json: '/user/admin/running.json'
config_file: '/user/admin/running.json'
- name: Copy Running Config from TFTP server as JSON
aoscx_upload_config:
Expand Down

0 comments on commit 7e15776

Please sign in to comment.