Contents x
    Add-CUUser: Create New VDI App Users
      • Print
      • Dark
        Light
      • PDF
      Contents

      Add-CUUser: Create New VDI App Users

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Introduction

        Using the Add-CUUsercmdlet, you can add new VDI App users by creating a shadow user account in our backend. Note that this cmdlet does not create a user account for the Real-Time DX Console login. For more information see the troubleshooting section below.

        Prerequisites

        • ControlUp version 8.8 or higher

        Syntax

        Add-CUUser [-Upn] <String> [-Email] <String> [-SamAccountName] <String> [-UserDnsDomain] <String> [-FirstName] <String> [-LastName] <String> [<CommonParameters>]

        Input Parameters

        All input parameters below are mandatory and formatted as Strings

        Parameter NameDescription
        UpnUser Principal Name. The UPN consists of two parts: the user account name (usually the user's email address) and the domain name in which the user account is located
        EmailEmail address of the new user
        SamAccountNameSecurity Account Manager Account Name. It is a logon name used in Active Directory to uniquely identify a user account within a domain
        UserDnsDomainDomain Name of the new user
        FirstNameFirst name of the user
        LastNameLast name of the user

        How to Add a User

        1. Import the ControlUp.PowerShell.User module into your PowerShell session

          $pathtomodule = (Get-ChildItem "C:\Program Files\Smart-X\ControlUpMonitor\*ControlUp.PowerShell.User.dll" -Recurse | Sort-Object LastWriteTime -Descending)[0]
Import-Module $pathtomodule

        2. Run the command and add the user. Note that we use a dummy user in this example. Make sure that the email address

          Add-CUUser -Upn johndoe@contoso.com -Email johndoe@contoso.com -SamAccountName jdoe -UserDnsDomain contoso.com -FirstName John -LastName Doe

          image.png

        3. If LDAP is configured and the user is assigned the Use Web Application permission, you can now connect to the VDI App with this user
          image.png

        Troubleshooting

        The user you create with the Add-CUUsercmdlet is not automatically allowed to log into the Real-Time DX Console. This error message appears when the user tries to log in:
        image.png

        To create an email address for a user in the ControlUp organization, the organization owner or any user with Login Access Manager privileges must use the Login Setup wizard, which can be found in the Home ribbon of the console.
        image.png

        After the email is added, the user will be able to access and log into the ControlUp organization.
        image.png

        Was this article helpful?
        What's Next