The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter contains the following sections:
Cisco UCS Director provides automated, profile-based provisioning, management, and reporting of infrastructure resources. Cisco UCS Director incorporates a powerful orchestration engine that enables complex operations on any element of your converged infrastructure, both physical and virtual. These operations are embodied in workflows, which are scripted sequences of individual tasks. Cisco UCS Director comes complete with a large library of tasks.
The tasks in Cisco UCS Director are written in CloupiaScript, a version of JavaScript with libraries that enable orchestration operations. With CloupiaScript, it is possible to embed scripts in workflow tasks and to write custom tasks.
You should be familiar with Cisco UCS Director and Cisco UCS Director Orchestrator to take advantage of the scripted examples in this Cookbook.
For information about installation and administration of Cisco UCS Director, see the Cisco UCS Director Administration Guide. For help using the Cisco UCS Director Orchestrator, see the Cisco UCS Director Orchestration Guide. For a reference to CloupiaScript classes and methods, see the CloupiaScript Javadoc included with the Cisco UCS Director Script Bundle.
Under a descriptive title, each example comprises the following sections:
What the example is designed to accomplish.
When you would use the example, when you would not use it, and why.
What conditions have to exist for the example to work.
Which objects and methods are used in the example, and what the input variables represent.
The example code.
What output is expected from the example code.
Notes on implementing the example, including what modifications might be necessary to implement it.
Related Examples
This document is a collection of examples, recipes, if you will, for using CloupiaScript, a server-side scripting solution for use with Cisco UCS Director; Orchestrator. Like a cookbook, you can use this document in at least three ways:
You can follow the examples as written (substituting your own variables, of course) to complete tasks without necessarily knowing everything about the steps you are following.
You can use the examples as templates and adapt them to similar tasks in your work.
You can study the examples to figure out “how things are done” in CloupiaScript and, along with the CloupiaScript Javadoc reference, generalize to using different methods for other tasks you need to script.
The examples are chosen to illustrate common use cases and are intended to facilitate all three of these modes of use.
To view the input or output of a service request, do the following: