One of the new features in vRops 6.3 is the documentation and I assume support for the Cluster Management API aka Casa API. I have in the past documented some of these Cluster Management API calls. In blog posts such as, vRops undocumented API calls which is from vRops 6.2 or Exploring vRops Internal API going even further back.
Luckily for us all, the vRops team have now added documentation to the Casa API, making it even easier for all to consume. First things first. How do you access it. Just like the regular API the documentation is contained within the vRops appliance. All you have to do is point your browser at your vRops installation and append “casa/api-guide.html”. Such as seen here:
https://vRops.MichaelRyom.dk/casa/api-guide.html
I have copy/pasted the below table straight from the documentation to give you an idea as to what you can achieve with Cluster Management API/Casa API.
Public APIs
| Name | HTTP Method | Endpoint | Description |
|---|---|---|---|
|
Configure cluster |
POST |
/casa/cluster |
Configure and initialize an entire cluster |
|
Initialize the Cluster |
GET |
/casa/cluster/init |
Initialize the cluster |
|
Configure master node |
POST |
/casa/node/master |
Configure and initialize master node |
|
Configure data node |
POST |
/casa/node/data |
Configure and initialize data node |
|
Configure replica node |
POST |
/casa/node/replica |
Configure and initialize replica node |
|
Configure remote collector node |
POST |
/casa/node/remotecollector |
Configure and initialize remote collector node |
As it can be seen the purpose is to configure the vRops cluster and nodes. It is not that comprehensive at this moment, but I’m hopeful that this will extent to more use cases in the coming releases.
Currently the tasks that can be performed are set admin password, ntp servers and simple configuration of the different types of vRops nodes. For each node you will be able to define a name, an address and a thumbprint. More on thumbprint retrieval can be found in the Casa documentation.
It is worth noting that this is all the documentation so far. If you are use to the suite api documentation, this might seem extremely small in comparison. As I stated earlier, I hope this will continue to grow in a rapid pace.
This is all for now. Take care and enjoy the new Cluster Management API calls.