Set-RASMFA

NAME

Set-RASMFA

SYNOPSIS

Modifies a multi-factor authentication.

SYNTAX

Set-RASMFA [-Id] <uint> -Deepnet <SwitchParameter> [-ActivateEmail <bool>] [-ActivateSMS <bool>] [-App <string>] [-AppID <string>] [-AuthMode {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [-DeepnetAgent <string>] [-DeepnetPort <uint>] [-DeepnetServer <string>] [-DefaultDomain <string>] [-Description <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-SSL <bool>] [-TokenType {MobileID | QuickID}] [<CommonParameters>]

Set-RASMFA [-Id] <uint> -EmailOTP <SwitchParameter> [-ADCustomAttribute <string>] [-AllowEnrollExternalEmail <bool>] [-DefaultEmailContent <SwitchParameter>] [-DefaultEmailSubject <SwitchParameter>] [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-EmailContent <string>] [-EmailSubject <string>] [-Enabled <bool>] [-ExternalEmailStorage {RASDatabase | ADMail | ADCustom}] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-OTPLength <uint>] [-OTPLifespanSec <uint>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-UntilDateTime <DateTime>] [-UserEnrollment {Allow | AllowUntil | DoNotAllow}] [-UserMessagePrompt <string>] [<CommonParameters>]

Set-RASMFA [-Id] <uint> -Radius <SwitchParameter> [-BackupServer <string>] [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-Enabled <bool>] [-ForwardFirstPwdToAD <bool>] [-HAMode {Parallel | Serial}] [-IgnoreErrors <string[]>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-PasswordEncoding {PAP | CHAP}] [-RadiusPort <uint>] [-RadiusServer <string>] [-Retries <uint>] [-SecretKey <SecureString>] [-Timeout <uint>] [-UserMessagePrompt <string>] [-UsernameOnly <bool>] [<CommonParameters>]

Set-RASMFA [-Id] <uint> -Safenet <SwitchParameter> [-Description <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-OTPServiceURL <string>] [-SafenetAuthMode {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-TMSWebApiURL <string>] [-UserRepository <string>] [<CommonParameters>]

Set-RASMFA [-Id] <uint> -TOTP <SwitchParameter> [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-Tolerance <uint>] [-UntilDateTime <DateTime>] [-UserEnrollment {Allow | AllowUntil | DoNotAllow}] [-UserMessagePrompt <string>] [<CommonParameters>]

Set-RASMFA [-InputObject] <MFA> [-ActivateEmail <bool>] [-ActivateSMS <bool>] [-App <string>] [-AppID <string>] [-AuthMode {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [-Deepnet <SwitchParameter>] [-DeepnetAgent <string>] [-DeepnetPort <uint>] [-DeepnetServer <string>] [-DefaultDomain <string>] [-Description <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-SSL <bool>] [-TokenType {MobileID | QuickID}] [<CommonParameters>]

Set-RASMFA [-InputObject] <MFA> [-ADCustomAttribute <string>] [-AllowEnrollExternalEmail <bool>] [-DefaultEmailContent <SwitchParameter>] [-DefaultEmailSubject <SwitchParameter>] [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-EmailContent <string>] [-EmailOTP <SwitchParameter>] [-EmailSubject <string>] [-Enabled <bool>] [-ExternalEmailStorage {RASDatabase | ADMail | ADCustom}] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-OTPLength <uint>] [-OTPLifespanSec <uint>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-UntilDateTime <DateTime>] [-UserEnrollment {Allow | AllowUntil | DoNotAllow}] [-UserMessagePrompt <string>] [<CommonParameters>]

Set-RASMFA [-InputObject] <MFA> [-BackupServer <string>] [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-Enabled <bool>] [-HAMode {Parallel | Serial}] [-IgnoreErrors <string[]>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-PasswordEncoding {PAP | CHAP}] [-Radius <SwitchParameter>] [-RadiusPort <uint>] [-RadiusServer <string>] [-Retries <uint>] [-SecretKey <SecureString>] [-Timeout <uint>] [-UserMessagePrompt <string>] [-UsernameOnly <bool>] [<CommonParameters>]

Set-RASMFA [-InputObject] <MFA> [-Description <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-OTPServiceURL <string>] [-Safenet <SwitchParameter>] [-SafenetAuthMode {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-TMSWebApiURL <string>] [-UserRepository <string>] [<CommonParameters>]

Set-RASMFA [-InputObject] <MFA> [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-Tolerance <uint>] [-TOTP <SwitchParameter>] [-UntilDateTime <DateTime>] [-UserEnrollment {Allow | AllowUntil | DoNotAllow}] [-UserMessagePrompt <string>] [<CommonParameters>]

Set-RASMFA [-Name] <string> [[-SiteId] <uint>] -Deepnet <SwitchParameter> [-ActivateEmail <bool>] [-ActivateSMS <bool>] [-App <string>] [-AppID <string>] [-AuthMode {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [-DeepnetAgent <string>] [-DeepnetPort <uint>] [-DeepnetServer <string>] [-DefaultDomain <string>] [-Description <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-SSL <bool>] [-TokenType {MobileID | QuickID}] [<CommonParameters>]

Set-RASMFA -EmailOTP <SwitchParameter> [-ADCustomAttribute <string>] [-AllowEnrollExternalEmail <bool>] [-DefaultEmailContent <SwitchParameter>] [-DefaultEmailSubject <SwitchParameter>] [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-EmailContent <string>] [-EmailSubject <string>] [-Enabled <bool>] [-ExternalEmailStorage {RASDatabase | ADMail | ADCustom}] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-OTPLength <uint>] [-OTPLifespanSec <uint>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-UntilDateTime <DateTime>] [-UserEnrollment {Allow | AllowUntil | DoNotAllow}] [-UserMessagePrompt <string>] [<CommonParameters>]

Set-RASMFA [-Name] <string> [[-SiteId] <uint>] -Radius <SwitchParameter> [-BackupServer <string>] [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-Enabled <bool>] [-ForwardFirstPwdToAD <bool>] [-HAMode {Parallel | Serial}] [-IgnoreErrors <string[]>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-PasswordEncoding {PAP | CHAP}] [-RadiusPort <uint>] [-RadiusServer <string>] [-Retries <uint>] [-SecretKey <SecureString>] [-Timeout <uint>] [-UserMessagePrompt <string>] [-UsernameOnly <bool>] [<CommonParameters>]

Set-RASMFA [-Name] <string> [[-SiteId] <uint>] -Safenet <SwitchParameter> [-Description <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-OTPServiceURL <string>] [-SafenetAuthMode {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-TMSWebApiURL <string>] [-UserRepository <string>] [<CommonParameters>]

Set-RASMFA [-Name] <string> [[-SiteId] <uint>] -TOTP <SwitchParameter> [-DefaultUserMessagePrompt <SwitchParameter>] [-Description <string>] [-DisplayName <string>] [-Enabled <bool>] [-InheritDefaultCriteriaSettings <bool>] [-NewName <string>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-Tolerance <uint>] [-UntilDateTime <DateTime>] [-UserEnrollment {Allow | AllowUntil | DoNotAllow}] [-UserMessagePrompt <string>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a multi-factor authentication.

PARAMETERS

-Name <string> The name of the target multi-factor authentication .

This must be the actual multi-factor authentication name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in which to modify the specified multi-factor authentication .

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of the multi-factor authentication to modify. To obtain the ID, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <MFA> The multi factor authentication to modify.

To obtain an object of type MFA, use the Get-RASMFA cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-NewName <string> The new name of the target multi-factor authentication .

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> A user-defined multi-factor authentication description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Enable or disable the specified multi-factor authentication in a site.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InheritDefaultCriteriaSettings <bool> If true default criteria settings will be inherited.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Deepnet <SwitchParameter> Deepnet SwitchParameter.

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ActivateEmail <bool> Whether the activation email is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ActivateSMS <bool> Whether the activation SMS is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-App <string> A value that represents the application name.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AppID <string> A value that represents the application ID.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AuthMode <DeepnetAuthMode> Authentication mode which defines the type of user for which a token will be created.

Possible values: MandatoryForAllUsers, CreateTokenForDomainAuthenticatedUsers, UsersWithDeepnetAcc

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DeepnetAgent <string> A value that represents the name of Deepnet Agent.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefaultDomain <string> A value that represents the Default Domain.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SSL <bool> Whether SSL is allowed or not.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DeepnetServer <string> The server of the second level authentication provider.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DeepnetPort <uint> The port number of the second level authentication provider.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TokenType <TokenType> Token Type (Flash ID, Mobile ID, Grid ID, or Quick ID).

Possible values: MobileID, QuickID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Radius <SwitchParameter> Radius SwitchParameter

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RadiusServer <string> The server of the second level authentication provider.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RadiusPort <uint> The port number of the second level authentication provider.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PasswordEncoding <PasswordEncoding> The type of password encoding to be used.

Possible values: PAP, CHAP

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Retries <uint> Number of retries.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Timeout <uint> Connection timeout (in seconds).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DisplayName <string> RADIUS type name.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UsernameOnly <bool> Specifies if forwarding of only the Username to RADIUS Server is enabled or not.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ForwardFirstPwdToAD <bool> Specifies if forwarding of first password to Windows authentication provider is enabled or not.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-BackupServer <string> The backup server of the second level authentication provider.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-HAMode <HAMode> The type of high availability mode to be used.

Possible values: Parallel, Serial

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SecretKey <SecureString> RADIUS setting. The secret key.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-IgnoreErrors <string[]> Specifies the list of Ignored Errors.

This is a DuoRadius only setting.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Safenet <SwitchParameter> Safenet SwitchParameter

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SafenetAuthMode <SafeNetAuthMode> SafeNet Authentication Mode

Possible values: MandatoryForAllUsers, CreateTokenForDomainAuthenticatedUsers, UsersWithSafeNetAcc

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OTPServiceURL <string> OTP Service URL

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UserRepository <string> A value representing User Store

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TMSWebApiURL <string> The URL of the web service

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TOTP <SwitchParameter> TOTP SwitchParameter

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UserEnrollment <UserEnrollment> Use of Enrollment

Possible values: Allow, AllowUntil, DoNotAllow

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ShowInformationForUnenrolledUsers <ShowInformationForUnenrolledUsers> Show information for unenrolled users

Possible values: Always, IfEnrollmentIsAllowed, Never

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UntilDateTime <DateTime> Allow User Enrollment until date/time

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Tolerance <uint> TOTP tolerance in seconds. Accepted values are 0 (None), 30, 60, 90 and 120

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EmailOTP <SwitchParameter> Email OTP SwitchParameter

        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OTPLifespanSec <uint> The lifespan of the OTP (seconds)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ExternalEmailStorage <ExternalEmailStorage> The storage where the external email is stored

Possible values: RASDatabase, ADMail, ADCustom

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefaultEmailContent <SwitchParameter> If this parameter is included, the email body content will be replaced with the default body content.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EmailContent <string> The content of the email. Possible variables: %OTP%, %DURATION%

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefaultEmailSubject <SwitchParameter> If this parameter is included, the email subject will be replaced with the default subject.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EmailSubject <string> The subject of the email. Possible variables: %OTP%

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefaultUserMessagePrompt <SwitchParameter> If this parameter is included, the message prompt will be replaced with the default message prompt.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UserMessagePrompt <string> User message prompt

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ADCustomAttribute <string> AD Custom Attribute

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowEnrollExternalEmail <bool> Allow enrollment of external email

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-OTPLength <uint> The length of the OTP generated

        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

MFA

OUTPUTS

-none-

EXAMPLES

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

Set-RASMFA "MFA" -Deepnet -Enabled $False

Disables the multi-factor authentication specified by name and by type. ---------- EXAMPLE 2 ----------

Set-RASMFA -Id 10 -Enabled $False

Disables the multi-factor authentication specified by ID.

RELATED LINKS

PreviousSet-RASMailboxSettingsNextSet-RASMFARadiusAuto

Last updated

© 2024 Parallels International GmbH. All rights reserved.