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.
Cisco UCS Director offers REST APIs that enable applications to consume or manipulate the data stored in Cisco UCS Director. These APIs are used by any script capable of making HTTP or HTTPS requests to invoke operations on Cisco UCS Director.
Cisco UCS Director PowerShell Console is a Cisco developed application that provides a PowerShell interface to the Cisco UCS Director API. It is a connector that enables you to connect to Cisco UCS Director systems without a need to develop compiled code. The Console provides a set of PowerShell cmdlets wrapped in a module which then internally invokes REST APIs over HTTP. The console supports only JSON-based APIs.
A cmdlet runs natively in the PowerShell CLI session on a compatible Windows machine. Each cmdlet performs a single operation. Depending on the data returned by the JSON-based APIs, the cmdlet automatically interprets the data and converts it into Windows PowerShell object. You can chain multiple cmdlets together. A cmdlet supports common operations such as exporting to XML, searching, sorting, filtering, reporting, and more.
To view a list of available cmdlets, see Cmdlets List. For more information about REST APIs, see Cisco UCS Director REST API Getting Started Guide .
Cisco UCS Director PowerShell Console is different from Cisco UCS Director PowerShell Agent. PowerShell Console provides cmdlet wrappers for the JSON-based APIs that enable you to submit workflow requests, examine workflow inputs and output schemas, and fetch reports. PowerShell Agent provides an interface between Cisco UCS Director and any Windows machine that is included in the WinRM configuration to add automation and orchestration functionality to Cisco UCS Director.