To get all shared credentials from your Credentials Store, you can use the Get-CUCredentials cmdlet. This cmdlet does not retrieve any local or non-shared credentials as they can be used for ControlUp Monitor credentials.
The ControlUp.PowerShell.User module contains the PowerShell cmdlet mentioned in this article.
To load the module, open an elevated PowerShell session as administrator and run the following commands:
$pathToUserModule = (Get-ChildItem "C:\Program Files\Smart-X\ControlUpMonitor\*ControlUp.PowerShell.User.dll" -Recurse | Sort-Object LastWriteTime -Descending)[0]
Import-Module $pathToUserModuleSyntax
Get-CUCredentials [[-User] <string>] [[-Domain] <string>] [[-Site] <string>] [<CommonParameters>]
Input Parameters
Property | Description | Type |
|---|---|---|
User | User name | String |
Domain | Domain name | String |
Site | The name of the site. You can not use the Site ID here | String |
Output
Property | Description | Type |
|---|---|---|
Key | Unique ID of this credential. If you run an action with PowerShell using the Invoke-CUAction cmdlet and the action you run requires a user credential as a input parameter, you will need this key parameter. Find an example here. | String |
IsSSH | Defines if this is a credential used for connecting to Linux machines | Boolean |
IsCloud | Defines if this is a cloud connection credentials | Boolean |
DisplayName | Display Name as shown as in the connection settings | String |
FriendlyName | Friendly Name that is used to identify the user credentials easier by other users. | String |
Account | Domain user (if user name) or the clientID used for cloud connections | String |
SiteId | Use the | String |
IsAssociatedWithDeletedSite | Defines if the user credential is associated to a Deleted Site | Boolean |
UserName | User Name | String |
UserDomain | Domain name | String |
SiteName | Site name to which this user is assigned | String |
Example 1 - Retrieve all users from a specific domain
Get-CUCredentials -Domain "controlup.demo"