=================
About the UAC CLI
=================

********
Overview
********

The UAC Command Line Interface (UAC CLI) is a tool that enables you to interact with UAC services using commands in your command-line shell. With minimal configuration, the UAC CLI enables you to start running commands that implement functionality equivalent to that provided by the browser-based Universal Controller Web Interface, from the command prompt, all from your terminal:

* **Linux Shells**: Run commands seamlessly in commonly used Linux shell environments.
* **Windows Command Line**: Execute commands via the Windows Command Prompt or PowerShell.


*******************
Benefits of UAC CLI
*******************

UAC CLI interacts with Universal Controller through `RESTful Web Services API <https://stonebranchdocs.atlassian.net/wiki/x/zxZbLw>`_ . The benefits of using UAC CLI a numerous:

#. **Simplified Access to Server Functionality**
     * Interact directly with the server's API without needing to craft manual HTTP requests or rely on third-party tools
     * Use straightforward, human-readable commands to perform complex API operations
#. **Improved Developer Productivity**
     * Explore UAC service capabilities quickly and efficiently
     * Lower the learning curve for users unfamiliar with API integrations
     * Automate repetitive tasks with easy-to-use commands and options.
#. **Scripting and Automation**
     * Integrate CLI commands into scripts for batch processing, CI pipelines, and automated deployments
#. **Broad Accessibility**
     * Empower technical users, including system administrators, to perform tasks without requiring in-depth knowledge of REST APIs.


********
Features
********

Some notable features are the following: 

#. **Profiles**: Leverage configuration profiles to seamlessly connect and authenticate with various UC servers and user accounts.

#. **Templates**: Simplify resource creation using JSON templates, supported through the ``-i`` option.

#. **Response Filtering**: Employ powerful JSONPath filtering to parse and extract specific data from command responses efficiently.

#. **Extensive Coverage**: The UAC CLI supports a wide range of REST APIs, enabling the retrieval, creation, and updating of data. A robust suite of commands is available to manage resources comprehensively such as:


* Audits 
* Agent Clusters
* Agents 
* Bundles
* Business services
* Calendars
* Cluster Nodes
* Credentials
* Custom Days
* Database Connections
* Email Connections
* LDAP Configurations
* Metrics
* OAuth clients
* OMS servers
* PeopleSoft Connections
* Promotion Targets
* Properties
* Reports
* SAP connections
* Scripts
* Server Operations
* Simulations
* System Status
* Task Instances
* Tasks
* Triggers
* Universal Events
* Universal Templates
* User Groups
* Users
* Variables
* Virtual Resources
* Webhooks
* Workflows