< Back

New-AMUser

Sat Jan 11, 2020 3:08 am

NAME New-AMUser



SYNOPSIS

Creates a new AutoMate Enterprise user.





SYNTAX

New-AMUser [-Name] <String> -Password <SecureString> [-Notes <String>] [-Folder <Object>] [-Connection <Object>]

[-WhatIf] [-Confirm] [<CommonParameters>]



New-AMUser [-Name] <String> -UseActiveDirectory [-Notes <String>] [-Folder <Object>] [-Connection <Object>]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

New-AMUser creates a new user object.





PARAMETERS

-Name <String>

The name/username of the new object.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <SecureString>

The password for the user.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UseActiveDirectory [<SwitchParameter>]

Authenticate against Active Directory. If not specified, Automate authentication is used.



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Notes <String>

The new notes to set on the object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Folder <Object>

The folder to place the object in.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The server to create the object on.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\># Create new user that authenticates against Active Directory



New-AMUser -Name John -UseActiveDirectory









-------------------------- EXAMPLE 2 --------------------------



PS C:\\># Create new user that authenticates against Automate (prompts for password)



New-AMUser -Name John -Password (Read-Host -Prompt "Enter password" -AsSecureString)











RELATED LINKS

https://github.com/AutomatePS/AutomatePS