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? falseSiteId (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? falseId (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? falseInputObject (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? falseNewName (string)
The new name of the target multi-factor authentication .
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDescription (string)
A user-defined multi-factor authentication description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnabled (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? falseInheritDefaultCriteriaSettings (bool)
If true default criteria settings will be inherited.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDeepnet (SwitchParameter)
Deepnet SwitchParameter.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falseActivateEmail (bool)
Whether the activation email is enabled or disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseActivateSMS (bool)
Whether the activation SMS is enabled or disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseApp (string)
A value that represents the application name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAppID (string)
A value that represents the application ID.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAuthMode (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? falseDeepnetAgent (string)
A value that represents the name of Deepnet Agent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDefaultDomain (string)
A value that represents the Default Domain.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSSL (bool)
Whether SSL is allowed or not.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDeepnetServer (string)
The server of the second level authentication provider.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDeepnetPort (uint)
The port number of the second level authentication provider.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTokenType (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? falseRadius (SwitchParameter)
Radius SwitchParameter
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falseRadiusServer (string)
The server of the second level authentication provider.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRadiusPort (uint)
The port number of the second level authentication provider.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePasswordEncoding
(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? falseRetries (uint)
Number of retries.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTimeout (uint)
Connection timeout (in seconds).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDisplayName (string)
RADIUS type name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUsernameOnly (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? falseForwardFirstPwdToAD (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? falseBackupServer (string)
The backup server of the second level authentication provider.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseHAMode (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? falseSecretKey (SecureString)
RADIUS setting. The secret key.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseIgnoreErrors (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? falseSafenet (SwitchParameter)
Safenet SwitchParameter
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falseSafenetAuthMode
(SafeNetAuthMode) SafeNet Authentication Mode
Possible values: MandatoryForAllUsers, CreateTokenForDomainAuthenticatedUsers, UsersWithSafeNetAcc
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseOTPServiceURL (string)
OTP Service URL
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUserRepository (string)
A value representing User Store
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTMSWebApiURL (string)
The URL of the web service
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTOTP (SwitchParameter)
TOTP SwitchParameter
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falseUserEnrollment (UserEnrollment)
Use of Enrollment
Possible values: Allow, AllowUntil, DoNotAllow
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseShowInformationForUnenrolledUsers
(ShowInformationForUnenrolledUsers) Show information for unenrolled users
Possible values: Always, IfEnrollmentIsAllowed, Never
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUntilDateTime (DateTime)
Allow User Enrollment until date/time
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTolerance (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? falseEmailOTP (SwitchParameter)
Email OTP SwitchParameter
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? falseOTPLifespanSec (uint)
The lifespan of the OTP (seconds)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseExternalEmailStorage
(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? falseDefaultEmailContent (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? falseEmailContent (string)
The content of the email. Possible variables: %OTP%, %DURATION%
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDefaultEmailSubject (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? falseEmailSubject (string)
The subject of the email. Possible variables: %OTP%
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDefaultUserMessagePrompt (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? falseUserMessagePrompt (string)
User message prompt
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseADCustomAttribute (string)
AD Custom Attribute
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAllowEnrollExternalEmail (bool)
Allow enrollment of external email
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseOTPLength (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
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
Last updated