Get-CUCredentials - Retrieve all ControlUp Credentials
    • Dark
      Light
    • PDF

    Get-CUCredentials - Retrieve all ControlUp Credentials

    • Dark
      Light
    • PDF

    Article Summary

    To get all shared credentials from your Credentials Store, you can use the Get-CUCredentials cmdlet. This cmdlet does not retrieve any local / non-shared credentials as they can be used for Monitor credentials. In this article, we briefly describe how to use it.

    Syntax

    Get-CUCredentials [[-User] <string>] [[-Domain] <string>] [[-Site] <string>]  [<CommonParameters>]
    

    Input Parameters

    PropertyDescriptionType
    UserUser nameString
    DomainDomain nameString
    SiteThe name of the site. You can not use the Site ID hereString

    Output

    PropertyDescriptionType
    KeyUnique 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
    IsSSHDefines if this is a credential used for connecting to Linux machinesBoolean
    IsCloudDefines if this is a cloud connection credentialsBoolean
    DisplayNameDisplay Name as shown as in the connection settingsString
    FriendlyNameFriendly Name that is used to identify the user credentials easier by other users.String
    AccountDomain user (if user name) or the clientID used for cloud connectionsString
    SiteIdUse the Get-CUSites cmdlet to retrieve the ID for a specific siteString
    IsAssociatedWithDeletedSiteDefines if the user credential is associated to a Deleted SiteBoolean
    UserNameUser NameString
    UserDomainDomain nameString
    SiteNameSite name to which this user is assignedString

    Example 1 - Retrieve all users from a specific domain

    Get-CUCredentials -Domain "controlup.demo"
    

    Was this article helpful?