9.0 PowerShell Cmdlets for Environment Configuration
    • Dark
      Light
    • PDF

    9.0 PowerShell Cmdlets for Environment Configuration

    • Dark
      Light
    • PDF

    Article summary

    Version 9.0 comes with a bundle of new PowerShell cmdlets to configure your Real-Time DX environment.

    What's New?

    With these PowerShell cmdlets, you can do the following:

    Before version 9.0, you were required to install monitors using the Real-Time DX Console. Now, you can deploy via the ControlUp Automation module. The updates include:

    • API token-based authentication. The API token contains the user's email address as well as the 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 DEX organization ID and the user email address.

    • ControlUp.Automation module installation. You install the monitor with the module using the token.

    Download the PowerShell module here.

    Import ControlUp Automation Module

    After you download the module, you can starting using the module. Run all cmdlets locally on the machine on which you want to deploy, upgrade or uninstall the monitor.

    Install and import the module in a PowerShell session (open as administrator)

    Install-Module ControlUp.Automation 
    Import-Module ControlUp.Automation

    Install and configure monitors

    Run the following cmdlets to install, update, or uninstall a monitor

    Cmdlet

    Description

    Install-CUMonitor

    Installs a new ControlUp Monitor on the machine

    Invoke-CUMonitorUpdate

    Updates a previously installed 9.0 ControlUp monitor.

    Uninstall-CUMonitor

    Uninstalls ControlUp Monitor from the local machine.

    Invoke-CUMonitorUpdate

    SYNTAX

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

    DESCRIPTION

    To update the existing 9.0 ControlUp Monitor, you have two options: either supply the ZIP file containing the latest version or specify the desired version directly using the -Version parameter. When using -Version, the system automatically downloads the appropriate ZIP file from the ControlUp Cloud and places it on the local machine for installation. Note, however, that upgrading the monitors from version 8.8 with this cmdlet isn’t supported yet.

    Parameters

    Description

    Required

    -ZipFilePath

    Specify the full path to the ZIP folder containing the ControlUp Monitor installation files. If you don't have the ZIP file, please request it from our support team. In the absence of this parameter, the latest ControlUp Monitor version (hosted in our cloud) will be used.

    No

    -Version

    Switch parameter for -Latest, full name of the monitor version.

    Yes, if no -Latest

    -Latest

    Switch parameter for -Version, latest monitor version. If provided, overrides -Version.

    Yes, if no -Version

    -ProxySettings

    Proxy settings that the monitor will use to connect to the ControlUp services. If not provided, the default system proxy settings will be used.

    Example to create proxy settings variable:

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

    No

    Uninstall-CUMonitor

    SYNTAX

    Uninstall-CUMonitor 
    -Force
    <CommonParameters>

    DESCRIPTION

    Uninstalls the ControlUp Monitor from the local machine.

    Parameters

    Description

    -Force

    Uninstalls the monitor even if backend errors occur.

    Change security policy

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

    Cmdlet

    Description

    Add-CUPolicyRoles

    Creates new security policy role columns in the Security Policy panel with the Manage Solve and Use Web Application permissions set to Allow. You must configure the New-CUPolicyRoleDescriptor cmdlet before you run Add-CUPolicyRoles. Possible configurations include adding role members with New-CUPolicyRoleMember and configuring permissions set for folder with New-PolicyRoleAcl.

    Get-CUPolicyRoles

    Retrieves list of all security policy roles and members.

    Get-CUPermissionEntries

    Retrieves list of all available permission entries.

    New-CUPolicyRoleDescription

    Adds a new policy role description.

    New-CUPolicyRoleMember

    Adds a new policy role member.

    New-CUPolicyRoleAcl

    Adds a new policy role to the Access Control List (ACL) with permission to open the web UI without entering UPN credentials.

    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 your ControlUp Monitor cluster

    Cmdlet

    Description

    Set-MonitorMgmtAllowed

    Allows ControlUp to perform remediation actions on monitors.

    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:

    Cmdlet

    Description

    Get-CUAPIProfile

    Retrieves your current active profile.

    Set-CUAPIProfile

    Enables you to switch between different profiles. Syntax example: Set-CUAPIProfile -Profile <org-name>

    Set-CUAPIToken

    Stores an API token in a profile you define. This token is only readable by the defined user, and is securely encrypted (Base64-encoded) using DPAPI and saved under %appdata%\ControlUp\.cuapi. Syntax example: Set-CUAPIToken -Token <XXX> [-Profile “default”]

    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.

    Cmdlet

    Description

    Add-CUCloudConnection

    Creates a new cloud connection with Azure connection type.

    Get-CUCloudConnection

    Retrieves list of all cloud connections.

    Remove-CUCloudConnection

    Removes a connection by unique ID.

    Update-CUCloudConnection

    Updates your existing site with the subscription credentials of another site that you add and configure.

    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).

    Cmdlet

    Description

    Add-AddHorizonEUCConnection

    Creates a new Horizon connection.

    Get-EUCConnections

    Retrieves list of all EUC connections.

    Remove-EUCConnection

    Removes an EUC connection by unique ID.

    Update-HorizonEUCConnection

    Removes the existing Horizon connection.


    Was this article helpful?