9.0 PowerShell Cmdlets

From the 9.0 release, you can use the following PowerShell cmdlets to install and configure your Controlup Monitors, change your security policy, allow remediation actions, and manage API tokens for ControlUp user profiles, Azure cloud connections, or Horizon EUC environment connections.

Before version 9.0, you were required to install monitors using the Real-Time DX Console. Now you can deploy and manage monitors via an automated process using PowerShell. The updates include:

• API token-based authentication. The API token contains all the essential data required for the monitor to connect seamlessly with your organization.

• Web UI integration. You create and manage the token using our web UI. This ensures that each token is uniquely tied to specific organizational parameters, including the web UI organization ID and user ID.

• PowerShell cmdlets module installation. You install the monitor with the module using the token.

Download PowerShell cmdlets module here.

Import cmdlets

After you download the cmdlets module, you must launch all cmdlets from the module on the same host where the ControlUp Monitor service is installed.

To enable the cmdlets to use, you must first import the module:

1. Open a PowerShell session on the host with the ControlUp Monitor and run the following command:

   Import-Module ".\ControlUpAutomation\ControlUp.Automation.dll"

If successful, no results display.

2. Optionally, to verify the import of the module and list available cmdlets, run the following command:

   Get-Command -Module ControlUp.Automation

If successful, the results display similar to the following example:

Install and configure monitors

Run the following cmdlets to install and configure your monitors:

Invoke-CUMonitorUpdate

SYNTAX

Invoke-CUMonitorUpdate
-ZipFilePath <string>
-Version or -Latest <string>
-ProxySettings <ProxySettingsObject>

DESCRIPTION

Updates the current ControlUp Monitor by either providing the ZIP file with the latest version or by providing the specific version in the -Version parameter. -Version downloads the ZIP file from the ControlUp Cloud and provides it as a local file on the monitor machine.

$Secure = Read-Host -AsSecureString
$proxys = New-Object -TypeName ControlUp.Automation.ProxySettings
$proxys.Password=$Secure
$proxys.Address="127.0.0.1"
$proxys.Port=80802

Uninstall-CUMonitor

SYNTAX

Uninstall-CUMonitor 
-Force
<CommonParameters>

DESCRIPTION

Uninstalls ControlUp Monitor from the local machine.

Change security policy

Run the following cmdlets to make changes to your security policy:

Example below to configure the following two roles:

• ControlUp Admins. Built-in role to add new members only.

• Customers. Creates new role to add members and to configure the Manage Solve and Use Web Application permissions.

$role=New-CUPolicyRoleDescription -RoleName "ControlUp Admins"
New-CUPolicyRoleMember -Role $role -SecurityIdentifier 7d1a5930-0739-4eb5-8825-36ee10edd233 -DisplayName "Organization Engineer DW"

$customer=New-CUPolicyRoleDescription -RoleName "Customers"
New-CUPolicyRoleMember -Role $customer -SecurityIdentifier d09e999a-29ff-4be3-aeff-384ecf92b1d2 -DisplayName "Organization Customer DW"
$permissions=@{ `"1B5974A1-3487-4054-8DF9-941318F7E2B6"=$true; ` # Use solve
                 "5AD549BF-A0AA-4241-A5F6-B11FFBD21F3A"=$false ` # Manage solve}
New-CUPolicyRoleAcl -Role $customer -FolderId 00000000-0000-0000-0000-000000000000 -Entries $permissions

Add-CUPolicyRoles -Roles $role, $customer 

Allow remediation actions

Run the following cmdlet allow our support team to remotely perform remediation actions on the ControlUp Monitors in your organization:

SYNTAX

Set-MonitorMgmtAllowed -MonitorMgmtAllowed $true

Manage API tokens

Run the following cmdlets to manage API tokens for your ControlUp user profiles to enable use of cmdlets on workgroup machines:

Your tokens are securely stored and associated with profile names in the .cuapi file, for example:

{
    "current": "username-dev",
    "profiles": [
        {
            "name": "default",
            "token": "<encrypted token>"
        },
        {
            "name": "controlup demo",
            "token": "<encrypted token>"
        },
        {
            "name": "username-dev",
            "token": "<encrypted token>"
        }
    ]

Manage cloud connections

Run the following cmdlets to manage cloud connections:

Note

In version 9.0, you can use these cmdlets to manage Azure cloud connections only.

Add-CUCloudConnection syntax example:

Add-CUCloudConnection 
-Type Azure 
-TenantID <TenantID> 
-Site <SiteID> 
-Credentials <Credentials>
-Proxy <ProxyName>
-DataCollectors <DataCollector1, DataCollector2>
-EnableAvd <true>

Manage Horizon EUC environment connections

Run the following cmdlets to manage Horizon EUC environment connections:

Note

Only Horizon Standard architecture is supported for Horizon EUC environment connection cmdlets, not Cloud Pod Architecture (CPA).