diff --git a/README.md b/README.md index 064d375..584c51f 100644 --- a/README.md +++ b/README.md @@ -74,16 +74,16 @@ Now you can start making your script based on modules in pycentral or use differ Refer the sample scripts in *step3* and *step4* for examples. - * **OR** Provide the required variables using JSON/YAML file. Refer input files [sample_scripts/input_token_only.yaml](sample_scripts/input_token_only.yaml) and [sample_scripts/input_credentials.yaml](sample_scripts/input_credentials.yaml) for information. + * **OR** Provide the required variables using JSON/YAML file. Refer input files [sample_scripts/input_token_only.yaml](https://github.com/aruba/pycentral/blob/master/sample_scripts/input_token_only.yaml)and [sample_scripts/input_credentials.yaml](https://github.com/aruba/pycentral/blob/master/sample_scripts/input_credentials.yaml) for information. Use `pycentral.workflows_utils.get_conn_from_file()` function which accepts name of the file and returns the `ArubaCentralBase` instance object. Refer the sample script in *step5* for example. -3. **Making API call using pycentral base**: Using the base class `ArubaCentralBase`, any Aruba Central supported REST API calls can be made. Refer the following sample script [sample_scripts/pycentral_base_sample.py](sample_scripts/pycentral_base_sample.py). +3. **Making API call using pycentral base**: Using the base class `ArubaCentralBase`, any Aruba Central supported REST API calls can be made. Refer the following sample script [sample_scripts/pycentral_base_sample.py](https://github.com/aruba/pycentral/blob/master/sample_scripts/pycentral_base_sample.py) Obtain the HTTP Request related information from Aruba Central Swagger documentation or [API references](https://developer.arubanetworks.com/aruba-central/reference) page in Aruba Developer Hub. -4. **Making API call using pycentral modules**: Some API endpoints supported by Aruba Central are implemented as modules in the Python package. Refer the following sample script using modules [sample_scripts/pycentral_module_sample.py](sample_scripts/pycentral_module_sample.py). +4. **Making API call using pycentral modules**: Some API endpoints supported by Aruba Central are implemented as modules in the Python package. Refer the following sample script using modules [sample_scripts/pycentral_module_sample.py](https://github.com/aruba/pycentral/blob/master/sample_scripts/pycentral_module_sample.py) To obtain a list of implemented modules and its documentation refer the [pycentral module documentation](https://pycentral.readthedocs.io/en/latest/). @@ -105,9 +105,9 @@ Now you can start making your script based on modules in pycentral or use differ * **Access Token**: This process is more secure. By providing only the *access_token* instead of credentials, the package will not cache the tokens. But loses the ability to handle expired token and to generate new access tokens. ## How to contribute -Please see the accompanying [CONTRIBUTIONS.md](CONTRIBUTIONS.md) file for guidelines on how to contribute to this repository. +Please see the accompanying [CONTRIBUTIONS.md](https://github.com/aruba/pycentral/blob/master/CONTRIBUTIONS.md) file for guidelines on how to contribute to this repository. ## Troubleshooting Issues If you encounter module import errors, make sure that the package has been installed correctly. -Additionally, please read the [RELEASE-NOTES.md](RELEASE-NOTES.md) file for the current release information and known issues. +Additionally, please read the [RELEASE-NOTES.md](https://github.com/aruba/pycentral/blob/master/RELEASE-NOTES.md) file for the current release information and known issues. diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index c3be869..0d58c58 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,8 +1,15 @@ +* # 1.1.1 + +## Notable Changes +* Updated README links + +## Known Issues +* No known issues. + * # 1.1.0 ## Notable Changes * Added APConfiguration Class to Configuration Module -* Updated Documentation links ## Known Issues * No known issues. diff --git a/sample_scripts/pycentral_workflow_sample.py b/sample_scripts/pycentral_workflow_sample.py deleted file mode 100644 index 495940e..0000000 --- a/sample_scripts/pycentral_workflow_sample.py +++ /dev/null @@ -1,64 +0,0 @@ -# MIT License -# -# Copyright (c) 2020 Aruba, a Hewlett Packard Enterprise company - -""" -Sample script shows making how to use existing automation workflows 'pycentral.workflows'. -In this sample, AP renaming workflow for APs in the UI group is shown. The CSV file can be downloaded -from the Central UI. Using the CSV file, update the AP names. 'config_apsettings_from_csv.py'.ß - -1. central_filename: - The format for input file is provided in the files 'input_credentials' and 'input_token_only'. - Files in JSON and YAML formats are supported. Use either credentials based file or token based file. - - * Credentials based file will generate new access token using OAUTH API and cache the token locally. - Sample file in YAML format - -------------------------- - central_info: - username: "" - password: "" - client_id: "" - client_secret: "" - customer_id: "" - base_url: "" - token_store: - type: "local" - path: "temp" - ssl_verify: true - - * Token based file will directly use the API access token and will not cache the token locally. - Sample file in YAML format - -------------------------- - central_info: - base_url: "" - token: - access_token: "" - ssl_verify: true - -2. csv_filename: - A CSV file as downloaded from the Aruba Central UI, - * "Account Home -> Network Operations -> Pick a group from Global drop-down -> Devices -> Access Points" - * Click on the "Download CSV" icon/button to download the CSV file. - - The following fields can also be added to the CSV file manually. Complete list of the fields are shown below. - * SERIAL: Serial number of the AP for which the hostname will be modified - * DEVICE NAME: Set new name for the AP - * IP ADDRESS: Set valid IP to change the IP of the AP. If the AP has DHCP based IP, set "is_dhcp_ip" flag to true. - * ZONE: if provided, will be configured - * A CHANNEL: if provided, will be configured - * A TX POWER: if provided, will be configured - * G CHANNEL: if provided, will be configured - * G TX POWER: if provided, will be configured - * DOT11A RADIO DISABLE: if provided, will be configured - * DOT11G RADIO DISABLE: if provided, will be configured - * USB PORT DISABLE: if provided, will be configured - Only these fields in the CSV file will be updated. -""" - -# Create the following files by refering to the samples/documentation. -csv_filename = "csv_file.csv" -central_filename = "input_token_only.yaml" - -# Get instance of ArubaCentralBase from the central_filename -from pycentral.workflows.workflows_utils import get_conn_from_file -central = get_conn_from_file(filename=central_filename) \ No newline at end of file