Set-2FASetting

NAME

Set-2FASetting

SYNOPSIS

Modifies various setting of second level authentication.

SYNTAX

Set-2FASetting [-ActivateEmail <bool>] [-ActivateSMS <bool>] [-App <string>] [-AppID <string>] [-DeepnetAgent <string>] [-DeepnetAuthMode <DeepnetAuthMode> {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithDeepnetAcc}] [-DeepnetType <DeepnetType> {DualShield | Deepnet}] [-DefaultDomain <string>] [-EnableSSL <bool>] [-ExcludeClientGWIPs <bool>] [-ExcludeClientIPs <bool>] [-ExcludeClientMAC <bool>] [-ExcludeUserGroup <bool>] [-Port <uint>] [-Provider <ProviderType> {None | Deepnet | SafeNet | Radius | AzureRadius | DuoRadius | FortiRadius | TekRadius | GAuthTOTP}] [-ReplicateSettings <bool>] [-Server <string>] [-SiteId <uint>] [-TokenType <TokenType> {FlashID | MobileID | GridID | QuickID}] [-UntilDateTime <DateTime>] [-UserEnrollment <UserEnrollment> {Allow | AllowUntil | DoNotAllow}] [<CommonParameters>]

Set-2FASetting [-ExcludeClientGWIPs <bool>] [-ExcludeClientIPs <bool>] [-ExcludeClientMAC <bool>] [-ExcludeUserGroup <bool>] [-OTPServiceURL <string>] [-Provider <ProviderType> {None | Deepnet | SafeNet | Radius | AzureRadius | DuoRadius | FortiRadius | TekRadius | GAuthTOTP}] [-ReplicateSettings <bool>] [-SafeNetAuthMode <SafeNetAuthMode> {MandatoryForAllUsers | CreateTokenForDomainAuthenticatedUsers | UsersWithSafeNetAcc}] [-SiteId <uint>] [-TMSWebApiURL <string>] [-UntilDateTime <DateTime>] [-UserEnrollment <UserEnrollment> {Allow | AllowUntil | DoNotAllow}] [-UserRepository <string>] [<CommonParameters>]

Set-2FASetting [-ExcludeClientGWIPs <bool>] [-ExcludeClientIPs <bool>] [-ExcludeClientMAC <bool>] [-ExcludeUserGroup <bool>] [-ForwardFirstPwdToAD <bool>] [-PasswordEncoding <PasswordEncoding> {PAP | CHAP}] [-Port <uint>] [-Provider <ProviderType> {None | Deepnet | SafeNet | Radius | AzureRadius | DuoRadius | FortiRadius | TekRadius | GAuthTOTP}] [-ReplicateSettings <bool>] [-Retries <uint>] [-SecretKey <string>] [-Server <string>] [-SiteId <uint>] [-Timeout <uint>] [-TypeName <string>] [-UntilDateTime <DateTime>] [-UserEnrollment <UserEnrollment> {Allow | AllowUntil | DoNotAllow}] [-UsernameOnly <bool>] [<CommonParameters>]

Set-2FASetting [-ExcludeClientGWIPs <bool>] [-ExcludeClientIPs <bool>] [-ExcludeClientMAC <bool>] [-ExcludeUserGroup <bool>] [-Provider <ProviderType> {None | Deepnet | SafeNet | Radius | AzureRadius | DuoRadius | FortiRadius | TekRadius | GAuthTOTP}] [-ReplicateSettings <bool>] [-SiteId <uint>] [-TOTPType <string>] [-UntilDateTime <DateTime>] [-UserEnrollment <UserEnrollment> {Allow | AllowUntil | DoNotAllow}] [<CommonParameters>]

DESCRIPTION

Modifies Deepnet, SafeNet, and Radius settings. Enables and disables IP, MAC, and Gateway filters.

PARAMETERS


-Provider <ProviderType>
Changes the provider type used by second level authentication.

Possible values: None, Deepnet, SafeNet, Radius, AzureRadius, DuoRadius, FortiRadius, TekRadius, GAuthTOTP

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
The site ID to which the 2FA settings refer.

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ExcludeClientIPs <bool>
Whether to enable or disable the IP filter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ExcludeClientMAC <bool>
Whether to enable or disable the MAC address filter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ExcludeClientGWIPs <bool>
Whether to enable or disable the Gateway IP filter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ExcludeUserGroup <bool>
Whether to enable or disable the User/Group filter.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ActivateEmail <bool>
Deepnet setting. Enables or disables the activation Email.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ActivateSMS <bool>
Deepnet setting. Enables or disables the activation SMS.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

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

Possible values: MandatoryForAllUsers, CreateTokenForDomainAuthenticatedUsers, UsersWithSafeNetAcc

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-DeepnetType <DeepnetType>
Deepnet setting. Represents the Deepnet type.

Possible values: DualShield, Deepnet

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableSSL <bool>
Deepnet setting. Enables or disables SSL.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Server <string>
Deepnet/Radius setting. The server of the second level authentication provider.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-OTPServiceURL <string>
Safenet setting. The server of the second level authentication provider.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Port <uint>
Deepnet/Radius setting. 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.

Possible values: FlashID, MobileID, GridID, QuickID

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UserRepository <string>
Safenet setting. A value representing User Store.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TMSWebApiURL <string>
Safenet setting. The URL of the web service.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PasswordEncoding <PasswordEncoding>
Radius setting. 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>
Radius setting. Number of retries.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SecretKey <string>
Radius setting. The secret key.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Timeout <uint>
Radius setting. Connection timeout.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TypeName <string>
Radius setting. Radius type name.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UsernameOnly <bool>
Radius setting. Enables or disables forwarding of only the Username to Radius Server.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ForwardFirstPwdToAD <bool>
Radius setting. Enables or disables forwarding of first password to Windows authentication provider.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TOTPType <string>
TOTP setting. Sets the authentication method type name.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UserEnrollment <UserEnrollment>
TOTP setting. The state of user enrollment.

Possible values: Allow, AllowUntil, DoNotAllow

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UntilDateTime <DateTime>
TOTP setting. The allow user enrollment until date/time.

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ReplicateSettings <bool>
Enables or disables replication of settings to other sites.

        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

TwoFactorAuthSetting

EXAMPLES


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

Set-2FASetting -ProviderType Deepnet

Modifies the second level provider type to Deepnet.

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

Set-2FASetting -ProviderType Deepnet -DeepnetType DualShield -ActivateEmail $true

Modifies the provider type to Deepnet and changes the Deepnet type to be DualShield. Enables email activation.

RELATED LINKS