How to read/follow the Orchestrator API

[BWinchell]

Hello,

Purely a newbie question for someone who is not a developer/programmer. 

How do I follow the API to get the syntax of a command?

E.g. var allPools = cluster.resourcePool.resourcePool_ResourcePool

How would I compile this syntax string by following the API?  Is there any type of beginner guide to how to use the API?  Trying to find the proper syntax is my main issue.

Thanks

B

[eoinbyrne]

The syntax is Javascript so I'd recommend going through any basic Javascript tutorial first (even web page related will be fine - complete all exercises etc) , then do an Intermediate one. After that, open the API explorer in the client and look at the documentation for any Object types you are interested in.

The programming environment is all contained within the client so start with simple workflows e.g., System.log("Hello world");

There's not really any super-easy path to learn this other than through work and practice and yet more work

HTH and best of luck!

[rmitchell1028 · Accepted solution]

I find the web documentation to be very useful as well (easier/faster to follow than trying to dig through what's available in the scripting interface).  For example:

https://www.vmware.com/support/orchestrator/doc/vco_vsphere55_api/html/index-so_types.html

I usually read through this when I want to see what properties and methods an object has.

[iiliev]

There is also a very useful tool called Onyx to monitor API calls made when you perform some operation in vSphere client.

Check http://www.vcoportal.de/2012/05/using-onyx-for-fast-workflow-development/ or https://labs.vmware.com/flings/onyx

[BWinchell]

I have used Onyx in the past (when it connected to the thick client).

I would like to use the new version but it actually replaces the VCSA vsphere-client components.  That is too intrusive for a production VCSA.  I wish there was a way to keep the ability to run this outside modifying production servers.  I can run it against my test systems but not all my systems I would like to run some workflows against are in the Test environment.  Also, I would need another vCenter license to keep Onyx on the test system.

Thanks

B

[BWinchell]

Thanks for the answers.  I marked them as helpful as I cannot give multiple correct answers.

I guess between the suggestions, I can piece together how the API works.

Thanks

B

[carl1]

True but have you looked at VMUG Advantage program for that vCenter license.  Makes it real cheap!

Carl L.