ControlUp Powershell Commands

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. 

 

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"

PowerShell_5.0_logo.png

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”

____________________________________________________________________________

 

Get-CUComputer

NAME

Get-CUComputer

SYNOPSIS

Returns a list of managed computers in ControlUp organization.

SYNTAX

Get-CUComputer [-Name] <string> [-Domain] <string>

DESCRIPTION

Returns a list of managed computers in the current ControUp organization, including their fully qualified domain names and their paths in the ControlUp organizational tree.

When executed with no parameters, this cmdlet returns all managed computers in the organization. When a name or a search string is specified for the Name parameter, all computers matching the query string are returned.

PARAMETERS

-Name

Required False
Position Named
Accept pipeline input false
Supported values all strings, arrays, and wildcards
Aliases                   None
Dynamic false  


-Domain

Required False
Position Named
Accept pipeline input false
Supported values all strings, arrays, and wildcards
Aliases                   None
Dynamic false   


EXAMPLES

Use cmdlet without parameters, to display all managed computers in organization.

Get-CUComputer

Name Domain Path

-------- ---------- -------

UKHQFS02 ibm.com UK\HQ\Servers

DEHQDC02 ibm.com DE\HQ\Servers

DEMUDC01 ibm.com DE\MU\Servers

Use Name and Domain parameters to look for specific computer(s) matching strings with wildcards.

Get-CUComputer -Name *FS* -Domain ibm.com

Name Domain Path

-------- ---------- -------

UKHQFS02 ibm.com UK\HQ\Servers                

REMARKS

  1. When cmdlet returns multiple records it should support collection structure.
  2. If user provided explicitly a name and domain of unmanaged computer, then display
  3. Cmdlet output includes following computer properties as columns:
  • Name
  • Domain DNS
  • Folder path in configuration

 

____________________________________________________________________________

 

Get-CUFolder

NAME

Get-CUFolder

SYNOPSIS

Returns a list of folders in ControlUp organization.

SYNTAX

Get-CUFolder [-Path] <string>

DESCRIPTION

Returns folders in the current ControUp organization, including their full path, description and whether the folder is excluded from ControlUp monitor.

When executed with no parameters, this cmdlet returns all existing folders in the organization. When a folder path is specified for the Path parameter, all folders matching the query string are returned.

PARAMETERS

-Path

Required False
Position Named
Accept pipeline input true
Supported values all strings, arrays, and wildcards
Aliases                   None
Dynamic false   

 

EXAMPLES

Use cmdlet without parameters, to display all existing folders in organization.

Get-CUFolder

Path Description Exclude from ControlUp monitor

-------- ---------------- -------------------------------------------

UK\HQ\Servers servers in UK-HQ No

DE\HQ\Servers servers in DE-HQ No

DE\MU\Servers servers in DE-ME Yes

Use Path parameter to look for specific folder(s) matching strings with wildcards.

Get-CUComputer -Path *MU*

Path Description Exclude from ControlUp monitor

-------- ---------------- -------------------------------------------

DE\MU\Servers servers in DE-ME Yes

 

REMARKS

  1. When cmdlet returns multiple records it should support collection structure.
  2. Cmdlet output includes following computer properties as columns:
  • Path
  • Description
  • Exclude from ControlUp monitor



 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request
Powered by Zendesk