Skip to content

Commit

Permalink
Updated docs authentication options available
Browse files Browse the repository at this point in the history
  • Loading branch information
mandarb80 committed Feb 22, 2023
1 parent 23f1346 commit 8502a0a
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@
- [3.3 Install Python modules and packages](#install-python-modules-and-packages)
- [3.4 Update config.ini](#update-configini)
- [4. Running the Script](#running-the-script)
- [5. Support](support)
- [6. Documentation](documentation)
- [7. Release Notes](release-notes)
- [8. Known Issues](known-issues)
- [9. Contributing](contributing)
- [10. License](10-license)
- [5. Authentication](#authentication)
- [6. Support](#support)
- [7. Documentation](#documentation)
- [8. Release Notes](#release-notes)
- [9. Known Issues](#known-issues)
- [10. Contributing](#contributing)
- [11. License](#license)

## What is pyVMC?
Welcome to the Python Client for VMware Cloud on AWS! PyVMC is a Python tool developed for assisting system administrators with the deployment, configuration, and management of the VMware Cloud on AWS service.
Expand Down Expand Up @@ -89,6 +90,23 @@ To see the arguments for the show-routes command:
Try to view the route table for your SDDC:
``` ./pyVMC.py system show-routes -rt t0 ```

## Authentication
pyVMC supports both **refresh_token** and **OAuth AppId/Secret** way to authenticate.
Values for it needs to be specified in config.ini file. Default auth method is to use **refresh_token**.

If one wants to use OAuth, then **--oauth** switch needs to be provided when running the command.

Examples:

Using default 'refresh_token'
```shell
./pyVMC.py sddc show-sddcs
```

Using OAuth
```shell
./pyVMC.py sddc show-sddcs --oauth
```

## Support

Expand Down Expand Up @@ -164,6 +182,7 @@ positional arguments:
show Show information about the VCDR Scale-out file System(s).

optional arguments:
--oauth [OAUTH] Used to specify use of OAuth app ID and secret in config.ini instead of 'refresh_token' (default)
-h, --help show this help message and exit
```

Expand Down
Binary file modified README.pdf
Binary file not shown.
18 changes: 18 additions & 0 deletions docs/all-supported-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
## Table of Contents
<!-- TOC -->
- [Current Supported Commands](#current-supported-commands)
- [Authentication](#authentication)
- [Getting Help](#getting-help)
- [1. CSP - Cloud Service Portal related commands](#1-csp-commands)
- [2. SDDC - Software Defined Datacenter related commands](#2-sddc-commands)
Expand Down Expand Up @@ -43,7 +44,23 @@ Here are the currently supported 'super' commands:
vcdr Create, delete, update, and show information about VMware Cloud Disaster Recovery.
flexcomp Commands related to the Cloud Flex Compute itself.
```
## Authentication
pyVMC supports both **refresh_token** and **OAuth AppId/Secret** way to authenticate.
Values for it needs to be specified in config.ini file. Default auth method is to use **refresh_token**.

If one wants to use OAuth, then **--oauth** switch needs to be provided when running the command.

Examples:

Using default 'refresh_token'
```shell
./pyVMC.py sddc show-sddcs
```

Using OAuth
```shell
./pyVMC.py sddc show-sddcs --oauth
```
## Getting Help

To see the supported commands for any given category / super-command, simply use '-h'... for example:
Expand Down Expand Up @@ -77,6 +94,7 @@ positional arguments:
show Show information about the VCDR Scale-out file System(s).

optional arguments:
--oauth [OAUTH] Used to specify use of OAuth app ID and secret in config.ini instead of 'refresh_token' (default)
-h, --help show this help message and exit
```

Expand Down
Binary file modified docs/all-supported-commands.pdf
Binary file not shown.

0 comments on commit 8502a0a

Please sign in to comment.