<img src="https://certify.alexametrics.com/atrk.gif?account=VdU0q1FYxz20cv" style="display:none" height="1" width="1" alt="">
Embotics Cloud Management Blog

Extend your Reach with the vCommander REST API

vCommander REST API If you want to take full advantage of your cloud management platform to address business problems, Embotics® vCommander® comes out of the box with an extensive REST API and powershell cmdlet that enable any number of automation use cases. Valuable resources such as SaaS, IaaS, legacy systems, ERP, on-premise applications, data sources and databases, whether inside or outside of the enterprise can be integrated to automate workflows, orchestrate external systems, and provide continual service improvements.

Below are some examples of where the vCommander REST API can help you integrate to your business processes:

Virtual Lab Management and DevOps

If you want to give your development and business unit teams the power to be self-sufficient without sacrificing control over your infrastructure, leveraging vCommander’s REST APIs allows you to integrate directly with your continuous integration (CI)/continuous delivery (CD) with tools like Jenkins and vCommander’s Workflows to provide the full CI/CD pipeline in continuous testing and integration of software applications. The end goal being to enable fast, predictable test and delivery which also can drive blue-green production deployments virtually eliminating delivery times.

Automating Customer Onboarding

Embotics vCommander multi-tenancy is very powerful and flexible, and allows for completely unique experiences for each organization’s members, whether these are customers for      service providers, or business units in the enterprise. The onboarding process can become time-consuming in the configuration of quotas, deployment destinations, ownership policies, IP Pools, and many other settings that are specific to each organization. When this is the case, and you will onboard many organizations with the same basic settings, you can automate the process using the instructions included in this article, with the completion workflow taking the values users enter into the form, and passing them to scripts that do the onboarding work via the vCommander REST API.

Generate Quota Reporting for Organizations

vCommander administrators can generate quota reporting for organizations, via the REST API. While this solution can be run on an ad-hoc basis, the procedure outlined here describes scheduling it to run on a daily basis using Windows Task Scheduler, and appends the current date to the file name.

Scheduling Redeployment of a Virtual Service Classroom

If you are like the security company highlighted in one of our case studies, and are regularly finding yourself having to rapidly provision systems for multiple training courses each week, this article provides a solution for the automatic tear down and redeployment of a vCommander service based on a vCenter vApp using the vCommander REST API. In this example, A scheduled task on the vCommander application server is used as the scheduling mechanism, but any equivalent product on any system that can access the vCommander API will also work.

As you can see from these examples, by leveraging vCommander’s REST API, you can integrate with all of your existing back end systems to make the automation of processes such as customer on-boarding, billing, asset management and custom automations simpler and more straightforward. And when used to augment your DevOps processes, you can orchestrate provisioning at high rates of speed while still retaining your IT organization’s ITSM policies.

Other use cases include integration with ticketing systems, CMDB, billing rollup, or any other system in your IT infrastructure that requires input or outputs from your cloud automation platform. Examples of integrations with 3rd party systems such as Zerto, ServiceNow, Veeam, and others can be found in our knowledge base, and the comprehensive list of features are detailed below to show the breadth of capabilities, but for more information, you can check out the REST API Getting Started Guide.

vCommander REST API Capabilities

Cloud automation
  • Publish and edit services in the Service Catalog
  • Import and export request forms
  • Submit, update and fulfill new service requests and change requests
  • Retrieve the state of a service request
  • Manage workflow definitions
  • Import and export workflow definitions
  • Configure and update automated deployment destinations
  • Manage policies, such as Expiry (decommissioning) and Default Ownership
  • Share VMs by automatically creating a Service Catalog entry and sending a request hyperlink to recipients via email
  • Retrieve and assign groups (expiry, guest OS scan, maintenance, power schedule and rightsizing)
  • Manage quota reservation
System configuration and status
  • Publish and edit services in the Service Catalog
  • Import and export request forms
  • Submit, update and fulfill new service requests and change requests
  • Retrieve the state of a service request
  • Manage workflow definitions
  • Import and export workflow definitions
  • Configure and update automated deployment destinations
  • Manage policies, such as Expiry (decommissioning) and Default Ownership
  • Share VMs by automatically creating a Service Catalog entry and sending a request hyperlink to recipients via email
  • Retrieve and assign groups (expiry, guest OS scan, maintenance, power schedule and rightsizing)
  • Manage quota reservation
User management
  • Manage local user accounts
  • Retrieve roles
  • Manage organizations
  • Manage quota
Costing
  • Add or update custom attributes
  • Retrieve VM Access Proxy settings
  • Configure IP pools
  • Manage and apply network zones
  • Query task status
  • Activate a standby vCommander
VM and infrastructure inventory management
  • Synchronize the inventory of a managed system
  • Manage VMs, virtual services and public cloud instances
  • Set VM metadata (such as ownership, expiry date and custom attribute values)
  • Retrieve items such as hosts, clusters and datastores
  • Manage media folders
  • Connect/disconnect media files to a VM’s virtual hardware

Per-tenant API

A REST API user with a Service Portal role can:

  • Retrieve services assigned to an organization
  • Retrieve service requests
  • Request a service
  • Submit a change request for a VM
  • Manage VM snapshots
  • Retrieve quota information for an organization and its members (including quota usage)
  • Share a VM
  • Execute a command workflow on a VM
Topics: Integrations vCommander REST API