68 lines
2.3 KiB
Markdown
68 lines
2.3 KiB
Markdown
|
# cvprac labs
|
||
|
|
|
||
|
|
The following lab examples will walk through the most commonly used REST API calls using cvprac
|
||
|
|
to help users interact with Arista CloudVision easily and automate the provisioning of network devices.
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
1. [Authentication](#authentication)
|
||
|
|
- [Password Authentication](#password-authentication)
|
||
|
|
- [Service Account Token Authentication](#service-account-token-authentication)
|
||
|
|
1. [Known Limitations](#known-limitations)
|
||
|
|
|
||
|
|
## Authentication
|
||
|
|
|
||
|
|
There are two ways to authenticate using the REST APIs:
|
||
|
|
|
||
|
|
- user/password (on-prem only)
|
||
|
|
- service account token (available on CVP 2020.3.0+ and CVaaS)
|
||
|
|
|
||
|
|
### Password Authentication
|
||
|
|
|
||
|
|
```python
|
||
|
|
from cvprac.cvp_client import CvpClient
|
||
|
|
clnt = CvpClient()
|
||
|
|
clnt.connect(['10.83.13.33'],'cvpadmin', 'arastra')
|
||
|
|
```
|
||
|
|
|
||
|
|
### Service Account Token Authentication
|
||
|
|
|
||
|
|
To access the CloudVision as-a-Service and send API requests, "Service Account Token" is needed.
|
||
|
|
After obtaining the service account token, it can be used for authentication when sending API requests.
|
||
|
|
|
||
|
|
Service accounts can be created from the Settings page where a service token can be generated as seen below:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
The token should be copied and saved to a file that can later be referred to.
|
||
|
|
|
||
|
|
```python
|
||
|
|
from cvprac.cvp_client import CvpClient
|
||
|
|
clnt = CvpClient()
|
||
|
|
with open("token.tok") as f:
|
||
|
|
token = f.read().strip('\n')
|
||
|
|
clnt.connect(nodes=['www.arista.io'], username='', password='', is_cvaas=True, api_token=token)
|
||
|
|
```
|
||
|
|
|
||
|
|
>NOTE In case of CVaaS the `is_cvaas` parameters has to be set to `True`
|
||
|
|
|
||
|
|
Service accounts are supported on CVP on-prem starting from `2020.3.0`. More details in the [TOI](https://eos.arista.com/toi/cvp-2020-3-0/service-accounts/) and the [CV config guide](https://www.arista.com/en/cg-cv/cv-service-accounts).
|
||
|
|
|
||
|
|
```python
|
||
|
|
from cvprac.cvp_client import CvpClient
|
||
|
|
|
||
|
|
with open("token.tok") as f:
|
||
|
|
token = f.read().strip('\n')
|
||
|
|
|
||
|
|
clnt = CvpClient()
|
||
|
|
clnt.connect(nodes=['10.83.13.33'], username='',password='',api_token=token)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Known Limitations
|
||
|
|
|
||
|
|
- for any APIs that interact with EOS devices, the service account name must match the name of the username
|
||
|
|
configured on EOS and CVP
|
||
|
|
- Support for REST API bindings for the Resource APIs (Lab 8) was added in CVP 2021.1.0
|