Get-CUCredentials: Retrieve Shared ControlUp Credentials
- Print
- DarkLight
- PDF
Get-CUCredentials: Retrieve Shared ControlUp Credentials
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
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.
Syntax
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 Get-CUSites cmdlet to retrieve the ID for a specific site | 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"
Was this article helpful?