Skip to main content

vCO-CLI

I attended a VMworld TAM Customer Central session this morning title "What's Next in vCenter Orchestrator" (a.k.a. vRealize Orchestrator).  One of the cool features is vCO-CLI, which has actually been available for about 8 months now as a VMware Fling ( https://labs.vmware.com/flings/vco-cli ).  I'm by no means an expert but have used vCO-CLI to debug an issue I was having so I thought I would throw together a short page on it.  This will hopefully give an idea of how the tool can be used.  I'm not going to go through how to install the plug-in.

 I'll start with creating a very basic workflow which takes just a VcHostSystem as an Input parameter.

Next, I'll add just a Scriptable task with my VcHostSystem as an IN parameter.  This Scriptable task has only one line which is what starts the vCO-CLI session.

That's it!  Now we can run the workflow providing a VcHostSystem object.

If you check the Logs tab on the running workflow then you'll see the session id assigned.

Now we can start the vcocli-gui (either vcocli-gui.bat if using Windows or vcocli if using Linux).  When the application starts you get the following login screen.  Login using the same credentials as the running workflow.

Click the "Attach" button so you can get the session you have running.

Highlight your session and click "Attach" again.  Now you get vCO-CLI GUI.  I recommend you look over the "Help" section to see what's available (this will show you how you can execute workflows, actions from the command window along with other items).

For my workflow I'll be looking at the vmhost object used as the IN parameter.  I'll expand the inventory to show that we see in the output window matches what we see in the inventory.

Now to check the vmhost object

As you can see, these are the same properties you use in Scriptable tasks or actions you create.  You can also use any of the methods available to the object.  If you've made any changes to the object prior to executing "startSession()" then those changes will be reflected here.  Using vCO actions then it's pretty simple as well (note the syntax difference):


When you're done debugging/troubleshooting you can simply disconnect from the session which will cause the workflow to continue where it left off.


Remember, when you're working in the vCO-CLI gui you are working on the actual object so anything you do in this GUI is real-time - so be careful what you do.

Comments

Post a Comment

Popular posts from this blog

Reconnecting ESXi servers with PowerCLI

We recently needed to re-ip our vCenter servers; each with ~200 ESXi servers which needed to be reconnected - thank goodness for PowerCLI.  Since there isn't a "Reconnect-VMHost" cmdlet provided by PowerCLI we needed to check the HostSystem Object at h ttps://www.vmware.com/support/developer/converter-sdk/conv55_apireference/vim.HostSystem.html and to see what methods were available (hint: there's a ReconnectHost_Task method which will do the trick).  We can still leverage the "Get-VMHost" cmdlet to return the disconnected ESXi servers and then call the ReconnectHost_Task method to reconnect each ESXi server.  The code is fairly short: Get-VMHost -state Disconnected | foreach-object {   $vmhost = $_   $connectSpec = New-Object VMware.Vim.HostConnectSpec   $connectSpec.force = $true   $connectSpec.hostName =  $vmhost .name   $connectSpec.userName = 'root'   $connectSpec.password = 'MySecretPassword'    $vmhost .ex...
4 comments
Read more

Querying for nested folders with PowerCLI

Have you fought trying to query nested, duplicate-named folders?  Hopefully this will help solve the problem!  Suppose you have a VM folder-tree similar to this:   So, how do you get the "\dotcom\linux\dev" folder using PowerCLI?  If you query for just "dev" then you can get an array of folders.    You can parse through the array and, using the parent object, traverse the tree backwards validating the folder names.  But, what if you have 100s of folders?  In my opinion, this is not an optimal approach.   We really need to do this: This is great case for  recursion .  In my words, recursion is a "stack" of operations.  When an operation completes its result is used by the next operation in the "stack".  Most importantly there has to be base-case which causes the last operation in the stack to return a valid result.  Then each operation can be popped off the "stack" and its result can be used by...
1 comment
Read more

Unmounting VMFS Datastores using vRO

Being a diligent admin, I always unmount a datastore from an ESXi server prior to completely deleting it.  It's a good way to verify the datastore isn't being used before the storage admin removes the ESXi server's visibility to the lun.  This is a task that I really want to perform in vRealize Orchestrator (vRO) instead of having to unmount the datastore from the ESXi server manually.   SPOILER ALERT - I'll include a workflow that allows you to execute the unmount across multiple ESXi servers in parallel at the end of this post. The first step is to see what's available from an unmount standpoint.  We start by bringing up the API Explorer under the Tools menu. From here we can search the "Attributes & methods" for text that contains the word unmount.  There quite a few methods which contain the text unmount.  I'm going to focus on the VcHostStorageSystem.unmountVmfsVolume() method.   This method takes a single argument - the uuid of ...
3 comments
Read more