WilliamLam.com

Exploring new VCSA VAMI API w/PowerCLI: Part 7

by // Leave a Comment

In the previous article (Part 6), we demonstrated how you can easily associate the list of VMDKs to their respective OS partitions within a VCSA or PSC node, which is useful when you need to increase the disk capacity for a specific OS partition. In Part 7, we are now going to drill down a bit further into the underlying filesystem and retrieve both the storage capacity as well as utilization of each partition.

VAMI UI Area of Focus

There is not a granular view of the individual OS partitions within the VAMI UI (https://[VCSA]:5480). However, this information is available as part of the VAMI information when logged into the vSphere Web Client by navigating to System Configuration->Nodes->Monitor->Storage as shown in the screenshot below.


The workflow for retrieving the storage statistics using the VAMI APIs is also applicable for retrieving other statistics such as compute, memory and networking. You first need to retrieve the list of VAMI Statistic IDs that are available from the monitoring API endpoint which is demonstrated with the Get-VAMIStatsList function. From each VAMI Stat ID, you can also drill down further to get more details such as description and the unit of measurement. Once you have the Stat IDs that you are interested in, you can then perform a query based on a specific set of search criteria which can be time range (start and stop time), interval, etc. To demonstrate how the query API works, I have created the Get-VAMIStorageUsed function to demonstrate its usage.

VAMI APIs Used

  • GET /appliance/monitoring
  • GET /appliance/monitoring/query

PowerCLI Function

Sample Output

The first function Get-VAMIStatsList does exactly as it sounds, it simply lists all VAMI Stat IDs that are available. Most of the Stat ID names are pretty descriptive but you can always retrieve more information by performing a GET on /appliance/monitoring/[VAMI-STAT-ID].


As stated in the beginning, we are interested in the grabbing the storage stats. The Get-VAMIStorageUsed function takes a subset of the VAMI Stats ID, specifically the storage ones that map to the OS partitions and retrieves both the total and used capacity (MB) as shown in the screenshot below.

Exploring new VCSA VAMI API w/PowerCLI: Part 6

by // Leave a Comment

In Part 6, we will take a look at how we can use the new VAMI APIs to easily associate the underlying VMDKs to their respective OS disk partitions for a VCSA or PSC node. In addition, the workflow of increasing the disk capacity for a specific partition has also been simplified further with the new VAMI APIs. After increasing the specific VMDK size, we can now also trigger the partition resize operation using the VAMI APIs, where as before this used to be a manual task that required SSH access. In vSphere 6.5, there have been a few minor changes to the VCSA's VMDK layout and sizes, for more details, please have a look at this blog post here.

VAMI UI Area of Focus

Unfortunately, there is not a page within the VAMI UI (https://[VCSA]:5480) that either lists or provides the actual mapping of the underlying VMDKs to their respective partition types. You can see the different VMDKs using the vSphere Web/C# Client, but historically the mapping of VMDK to partition type was done manually or you would refer to the table found in the blog post referenced above. Lets see if we can pull this information without needing to go to a UI 🙂

VAMI APIs Used

  • GET /appliance/system/storage
  • POST /appliance/system/storage/resize

PowerCLI Function

[Read more...]

Exploring new VCSA VAMI API w/PowerCLI: Part 5

by // 1 Comment

In Part 5, we are now going to have a look at networking section of the VAMI UI.

VAMI UI Area of Focus

In the Networking tab, under the "Manage" sub-tab, you can find details about the system Hostname (PNID), DNS servers as well as the configurations for each network interface (in the case of a VCHA deployment, you would have more than one network interface configured).

VAMI APIs Used

  • GET /appliance/networking/dns/hostname
  • GET /appliance/networking/dns/servers
  • GET /appliance/networking/interfaces
  • GET /appliance/techpreview/networking/ipv4

PowerCLI Function

Sample Output


This sample script only retrieves IPv4 networking information, but you can easily retrieve IPv6 information by calling into the IPv6 VAMI API endpoints which you can refer to the documentation or the API Explorer for more details.