All pages
Powered by GitBook
1 of 1

Loading...

Set-RASMFA

NAME

Set-RASMFA

SYNOPSIS

Modifies a multi-factor authentication.

SYNTAX

Set-RASMFA [-] <uint> - <SwitchParameter> [- <bool>] [- <bool>] [- <string>] [- <string>] [- {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [- <string>] [- <uint>] [- <string>] [- <string>] [- <string>] [- <bool>] [- <bool>] [- <string>] [- <bool>] [- {MobileID | QuickID}] [<>]

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 [-] <uint> - <SwitchParameter> [- <string>] [- <string>] [- <string>] [- <bool>] [- <bool>] [- {Parallel | Serial}] [- <string[]>

Set-RASMFA [-] <> [- <bool>] [- <bool>] [- <string>] [- <string>] [- {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [- <SwitchParameter>] [- <string>] [- <uint>] [- <string>] [- <string>] [- <string>] [- <bool>] [- <bool>] [- <string>] [- <bool>] [- {MobileID | QuickID}] [<>]

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 [-] <> [- <string>] [- <string>] [- <string>] [- <bool>] [- {Parallel | Serial}] [- <string[]>] [- <bool>] [-

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 [-] <> [- <string>] [- <string>] [- <bool>] [- <bool>] [- <string>] [- <uint>] [- <SwitchParameter>] [- <DateTime>] [- {Allow | AllowUntil | DoNotAllow}] [<>] Set-RASMFA [-] <string> [[-] <uint>] - <SwitchParameter> [- <bool>] [- <bool>

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 [-] <string> [[-] <uint>] - <SwitchParameter> [- <string>] [- <string>] [- <string>] [- <bool>] [- <bool>] [- {Parallel | Serial}] [-

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.

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

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

-InputObject <> The multi factor authentication to modify. To obtain an object of type MFA, use the Get-RASMFA cmdlet.

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

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

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

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

-Deepnet <SwitchParameter> Deepnet SwitchParameter.

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

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

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

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

-AuthMode <> Authentication mode which defines the type of user for which a token will be created. Possible values: MandatoryForAllUsers, CreateTokenForDomainAuthenticatedUsers, UsersWithDeepnetAcc

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

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

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

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

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

-TokenType <> Token Type (Flash ID, Mobile ID, Grid ID, or Quick ID). Possible values: MobileID, QuickID

-Radius <SwitchParameter> Radius SwitchParameter

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

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

-PasswordEncoding <> The type of password encoding to be used. Possible values: PAP, CHAP

-Retries <uint> Number of retries.

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

-DisplayName <string> RADIUS type name.

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

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

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

-HAMode <> The type of high availability mode to be used. Possible values: Parallel, Serial

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

-IgnoreErrors <string[]> Specifies the list of Ignored Errors. This is a DuoRadius only setting.

-Safenet <SwitchParameter> Safenet SwitchParameter

-SafenetAuthMode <> SafeNet Authentication Mode Possible values: MandatoryForAllUsers, CreateTokenForDomainAuthenticatedUsers, UsersWithSafeNetAcc

-OTPServiceURL <string> OTP Service URL

-UserRepository <string> A value representing User Store

-TMSWebApiURL <string> The URL of the web service

-TOTP <SwitchParameter> TOTP SwitchParameter

-UserEnrollment <> Use of Enrollment Possible values: Allow, AllowUntil, DoNotAllow

-ShowInformationForUnenrolledUsers <ShowInformationForUnenrolledUsers> Show information for unenrolled users Possible values: Always, IfEnrollmentIsAllowed, Never

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

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

<CommonParameters>

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.

] [-
<bool>] [-
<string>] [-
{PAP | CHAP}] [-
<uint>] [-
<string>] [-
<uint>] [-
<SecureString>] [-
<uint>] [-
<bool>] [<
>] Set-RASMFA [-
] <uint> -
<SwitchParameter> [-
<string>] [-
<bool>] [-
<bool>] [-
<string>] [-
<string>] [-
{MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-
<string>] [-
<string>] [<
>] Set-RASMFA [-
] <uint> -
<SwitchParameter> [-
<string>] [-
<string>] [-
<bool>] [-
<bool>] [-
<string>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-
<uint>] [-
<DateTime>] [-
{Allow | AllowUntil | DoNotAllow}] [<
>]
<string>] [-
{PAP | CHAP}] [-
<SwitchParameter>] [-
<uint>] [-
<string>] [-
<uint>] [-
<SecureString>] [-
<uint>] [-
<bool>] [<
>] Set-RASMFA [-
] <
> [-
<string>] [-
<bool>] [-
<bool>] [-
<string>] [-
<string>] [-
<SwitchParameter>] [-
{MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-
<string>] [-
<string>] [<
>]
] [-
<string>] [-
<string>] [-
{MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [-
<string>] [-
<uint>] [-
<string>] [-
<string>] [-
<string>] [-
<bool>] [-
<bool>] [-
<string>] [-
<bool>] [-
{MobileID | QuickID}] [<
>]
<string[]>
] [-
<bool>] [-
<string>] [-
{PAP | CHAP}] [-
<uint>] [-
<string>] [-
<uint>] [-
<SecureString>] [-
<uint>] [-
<bool>] [<
>] Set-RASMFA [-
] <string> [[-
] <uint>] -
<SwitchParameter> [-
<string>] [-
<bool>] [-
<bool>] [-
<string>] [-
<string>] [-
{MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-
<string>] [-
<string>] [<
>] Set-RASMFA [-
] <string> [[-
] <uint>] -
<SwitchParameter> [-
<string>] [-
<string>] [-
<bool>] [-
<bool>] [-
<string>] [-ShowInformationForUnenrolledUsers {Always | IfEnrollmentIsAllowed | Never}] [-
<uint>] [-
<DateTime>] [-
{Allow | AllowUntil | DoNotAllow}] [<
>]
Id
Deepnet
ActivateEmail
ActivateSMS
App
AppID
AuthMode
DeepnetAgent
DeepnetPort
DeepnetServer
DefaultDomain
Description
Enabled
InheritDefaultCriteriaSettings
NewName
SSL
TokenType
CommonParameters
Id
Radius
BackupServer
Description
DisplayName
Enabled
ForwardFirstPwdToAD
HAMode
IgnoreErrors
InputObject
MFA
ActivateEmail
ActivateSMS
App
AppID
AuthMode
Deepnet
DeepnetAgent
DeepnetPort
DeepnetServer
DefaultDomain
Description
Enabled
InheritDefaultCriteriaSettings
NewName
SSL
TokenType
CommonParameters
InputObject
MFA
BackupServer
Description
DisplayName
Enabled
HAMode
IgnoreErrors
InheritDefaultCriteriaSettings
InputObject
MFA
Description
DisplayName
Enabled
InheritDefaultCriteriaSettings
NewName
Tolerance
TOTP
UntilDateTime
UserEnrollment
CommonParameters
Name
SiteId
Deepnet
ActivateEmail
ActivateSMS
Name
SiteId
Radius
BackupServer
Description
DisplayName
Enabled
ForwardFirstPwdToAD
HAMode
IgnoreErrors
MFA
DeepnetAuthMode
TokenType
PasswordEncoding
HAMode
SafeNetAuthMode
UserEnrollment
MFA
InheritDefaultCriteriaSettings
NewName
PasswordEncoding
RadiusPort
RadiusServer
Retries
SecretKey
Timeout
UsernameOnly
CommonParameters
Id
Safenet
Description
Enabled
InheritDefaultCriteriaSettings
NewName
OTPServiceURL
SafenetAuthMode
TMSWebApiURL
UserRepository
CommonParameters
Id
TOTP
Description
DisplayName
Enabled
InheritDefaultCriteriaSettings
NewName
Tolerance
UntilDateTime
UserEnrollment
CommonParameters
NewName
PasswordEncoding
Radius
RadiusPort
RadiusServer
Retries
SecretKey
Timeout
UsernameOnly
CommonParameters
InputObject
MFA
Description
Enabled
InheritDefaultCriteriaSettings
NewName
OTPServiceURL
Safenet
SafenetAuthMode
TMSWebApiURL
UserRepository
CommonParameters
App
AppID
AuthMode
DeepnetAgent
DeepnetPort
DeepnetServer
DefaultDomain
Description
Enabled
InheritDefaultCriteriaSettings
NewName
SSL
TokenType
CommonParameters
InheritDefaultCriteriaSettings
NewName
PasswordEncoding
RadiusPort
RadiusServer
Retries
SecretKey
Timeout
UsernameOnly
CommonParameters
Name
SiteId
Safenet
Description
Enabled
InheritDefaultCriteriaSettings
NewName
OTPServiceURL
SafenetAuthMode
TMSWebApiURL
UserRepository
CommonParameters
Name
SiteId
TOTP
Description
DisplayName
Enabled
InheritDefaultCriteriaSettings
NewName
Tolerance
UntilDateTime
UserEnrollment
CommonParameters
        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters .