New-RASAdminAccount

NAME

New-RASAdminAccount

SYNOPSIS

Adds a Parallels RAS administrator account to the farm.

SYNTAX

New-RASAdminAccount [-Name] <string> [-Email <string>] [-Enabled <bool>] [-Mobile <string>] [-Notify {None | Email}] [-Permissions {PowerAdmin | RootAdmin | CustomAdmin}] [<CommonParameters>]

New-RASAdminAccount [-SID] <string> [-Email <string>] [-Enabled <bool>] [-Mobile <string>] [-Notify {None | Email}] [-Permissions {PowerAdmin | RootAdmin | CustomAdmin}] [<CommonParameters>]

DESCRIPTION

Adds a RAS administrator account to the farm.

PARAMETERS

-Name <string> The name of a user or group to add to the farm as an administrator.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SID <string> The SID of a user or group to add to the farm as an administrator.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Email <string> The user email address.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Mobile <string> The user mobile phone number.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Enables or disables this administrator in the farm.

        Required?                    false

        Position?                    named

        Default value                True

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Notify <AdminNotify> Set the "Receive system notifications via" option. Possible values are: "None", "Email".

Possible values: None, Email

        Required?                    false

        Position?                    named

        Default value                Email

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Permissions <PermissionType> Specifies the type of permission to use.

Possible values: PowerAdmin, RootAdmin, CustomAdmin

        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 documentation. 

INPUTS

-none-

OUTPUTS

AdminAccount

EXAMPLES

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

New-RASAdminAccount "Jane"

Adds user Jane to the farm as an administrator.

Since no additional options are specified, the default settings and permissions will be used. ---------- EXAMPLE 2 ----------

New-RASAdminAccount -Name "Jane" -AdminNotification None -FullPermissions $false

Adds user Jane to the farm as an administrator.

Modifies the "Receive system notification" option to "None".

Disables the "Full Permissions" option, which means that permissions can be set individually (all are enabled by default).

Last updated

© 2024 Parallels International GmbH. All rights reserved.