Contents x
    PowerShell Cmdlets for Sites Management
    • 15 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    PowerShell Cmdlets for Sites Management

    • Updated on 15 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Some features available only in version 9.1
    This article describes some monitor features that are only available in ControlUp Real-Time DX version 9.1.

    Version 9.1 includes the following PowerShell cmdlets to manage your ControlUp Monitor sites, with no need to use the Real-Time DX Console. From version 9.1, if you use an Independent Sites configuration, use these cmdlets to quickly and efficiently configure your sites.

    The ControlUp.PowerShell.User module contains the PowerShell cmdlets mentioned in this article.

    What's New?

    With these PowerShell cmdlets, you can do the following:

    Prerequisites

    • ControlUp Monitor version 9.1
    • The Add Site, Remove Site, Update Site, and View Site permissions must be granted in the console Security Policy.

    Get-CUSites

    Lists details for all existing sites configured in your organization.

    Syntax

    Get-CUSites

    Get-CUSites Results

     Returns a list of all configured monitor sites in your organization, with the following properties for each site:

    -SiteId <String> [-SiteName <String>] [-Description <String>] [-IsGlobal]


    Add-CUSite

    Creates a new monitor site in your organization. You must specify a site name.

    Syntax

    Add-CUSite -SiteName <String> [-Description <String>] [-IsGlobal]

    Example

    Add-CUSite -SiteName NewSiteName -Description "Test description 1" -IsGlobal

    Parameters

    Parameters
    		Description
    		Required
    -SiteNameName of the site
    		Yes
    -Description
    		Description of siteNo
    -IsGlobal
    		If provided, defines the site as the global site. Only a single site in your organization can be global.
    		No

    Update-CUSite

    Updates the properties of a specific site in your organization. You can modify the site name, description, and global status.

    Syntax

    Update-CUSite -SiteId <String> [-Description <String>] [-IsGlobal] [-SiteName <String>]

    Example

    Update-CUSite -SiteId 67263707-7f3d-4f3a-9874-a2dc638fba2f -Description "New description" -IsGlobal -SiteName "Edited site name"

    Parameters

    Parameters
    		Description
    		Required
    -SiteId
    		ID of the site
    		Yes
    -SiteName
    		Name of the site
    		No
    -Description
    		Description of site
    		No
    -IsGlobal
    		If provided, defines the site as a global site. Only a single site in your organization can be global.
    		No

    Add-CUSite & Update-CUSite Results

    Writes single result object to PowerShell with the following properties:

    • Error. In case of failure, the reason will be displayed.
    • Success. In case of success, the site ID and site name will be displayed.

    Remove-CUSite

    Deletes an existing site from your organization. Note that you can't remove all sites from your organization, at least one must remain.

    Syntax

    Remove-CUSite -SiteId <String>

    Example 

    Remove-CUSite -SiteId 67263707-7f3d-4f3a-9874-a2dc638fba2f

    Parameters

    Parameters
    		Description
    		Required
    -SiteId
    		ID of the site
    		Yes


    Was this article helpful?
    What's Next