ControlUp supports a variety of commands to use in Powershell which allows the user to run basic commands freely. Every command in this article contains the synopsis of the command, full description and examples.
Please also review this blog article - Copy you AD OU Structure to ControlUp
These powershell commands must be run from the CU Monitor, and you have to import the modules by first running the following command:
Import-Module "C:\Program Files\Smart-X\ControlUpMonitor\Version X.X.X.X\ControlUp.PowerShell.User.dll"
Add-CUFolder
NAME
Add-CUFolder
SYNOPSIS
Adds a folder to ControlUp real-time Console
SYNTAX
Add-CUFolder -Name <string> [[-ParentPath] <string>] [[-Description] <string>] [-ExcludeFromMonitor <boolean>]
DESCRIPTION
Adds a folder to ControlUp real-time Console. Folder name is specified by the -Name parameter, and its parent location by the -ParentPath parameter. If -ParentPath is not specified, the new folder will be created under the root folder.
Optional parameters - ExcludeFromMonitor determines whether the folder contents will be excluded from connection by ControlUp Monitor services. If this parameter is not specified, its values will be inherited from the parent folder.
PARAMETERS
-Name
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
-ParentPath
| Required | false |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
-Description
| Required | false |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
-ExcludeFromMonitor
| Required | false |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
EXAMPLES
Example 1:
Add-CUFolder -Name “SQL Servers”
Will create a folder named “SQL Servers” under the organization root folder.
Example 2:
Add-CUFolder -Name “Production” -ParentPath “Organization Name\SQL Servers”
Will create a folder named “Production” under the SQL Servers folder.
Example 3:
Add-CUFolder -Name “Test” -ParentPath “Organization Name\SQL Servers” -Description “Test SQL Servers” -ExcludeFromMonitor $True
Will create a folder named “Test” under the SQL Servers folder with the specified description, will instruct ControlUp to exclude this folder from monitor connections.
RELATED LINKS
Remove-CUFolder
REMARKS
The following characters are allowed: letters, numbers, space, dash and underscore.
The following folder names are reserved and cannot be used: “Hypervisors”, “Cloud Connections”, “XenDesktop Sites”.
____________________________________________________________________________
Remove-CUFolder
NAME
Remove-CUFolder
SYNOPSIS
Removes a folder from ControlUp real-time Console
SYNTAX
Remove-CUFolder -FolderPath “\Servers\Foldername” -Force $False
DESCRIPTION
Removes a folder from ControlUp real-time Console. Folder path is specified by the -FolderPath parameter.
Optional parameter - Force ignores any validation questions
PARAMETERS
-FolderPath
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
-Force
| Required | false |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
EXAMPLES
Example 1:
Remove-CUFolder -FolderPath “MyFirstCUFolder” -ParentPath “Organization Name”
Example 2:
Remove-CUFolder -FolderPath “MySecondCUFolder” -ParentPath “Organization Name\XD Folders”
Example 3:
Remove-CUFolder -FolderPath “MyThirsCUFolder” -ParentPath “Organization Name” -Force True
RELATED LINKS
Add-CUFolder
____________________________________________________________________________
Add-CUComputer
NAME
Add-CUComputer
SYNOPSIS
Adds a computer to ControlUp real-time Console
SYNTAX
Add-CUComputer -ADComputerName “PC001” -DomainName "domain.dom" -FolderPath “\Servers\Foldername”
DESCRIPTION
Adds a computer account from Active Directory to ControlUp real-time Console.
ADComputerName describes the computer account name as appears in Active Directory
DomainName describes the domain name from which the computer will be added
FolderPath describes the ControlUp folder path to which the computer will be added
PARAMETERS
-ADComputerName
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
-DomainName
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
-FolderPath
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
EXAMPLES
Example 1:
Add-CUComputer -ADComputerName “PC001” -DomainName “NTNET” -FolderPath “\SQL Servers”
RELATED LINKS
Remove-CUComputer
____________________________________________________________________________
Remove-CUComputer
NAME
Remove-CUComputer
SYNOPSIS
Removes a computer from ControlUp real-time Console
SYNTAX
Remove-CUComputer -Name “PC001.domain.dom”
DESCRIPTION
Removes a computer from ControlUp real-time Console
Name indicates the computer that will be removed from ControlUp real-time Console and can be entered as it appears in ControlUp, as an FQDN or as an IP address
PARAMETERS
-Name
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
EXAMPLES
Example 1:
Remove-CUComputer -Name “John-PC”
Example 2:
Remove-CUComputer -Name “117.34.2.7”
RELATED LINKS
Add-CUComputer
____________________________________________________________________________
Move-CUComputer
NAME
Move-CUComputer
SYNOPSIS
Moves a computer between ControlUp folders
SYNTAX
Move-CUComputer -Name “PC001.domain.dom” -NewFolderPath “\Servers\Foldername”
DESCRIPTION
Moves a computer between ControlUp folders
Name indicates the computer that will be moved from current location to -NewFolderPath which determines the new location in ControlUp real-time Console.
Name can be entered as it appears in ControlUp, as an FQDN or as an IP address
PARAMETERS
-Name
| Required | true |
| Position | Named |
| Accept pipeline input | false |
| Parameter set name | (All) |
| Aliases | None |
| Dynamic | false |
EXAMPLES
Move-CUComputer -Name “John-PC” -NewFolderPath “\Servers\Boston”