set vpn remote-access two-factor-authentication

Description

Configure two-factor authentication for VPN Remote Access.

See show vpn remote-access two-factor-authentication.

Syntax

set vpn remote-access two-factor-authentication [ use-sms <use-sms> [ sms-provider <sms-provider> ] [ sms-dynamicid-url <sms-dynamicid-url> ] [ sms-provider-username <sms-provider-username> ] [ sms-provider-password <sms-provider-password> ] [ sms-api-id <sms-api-id> ] [ sms-message<sms-message> ] [ one-time-password-length <one-time-password-length> ] [ one-time-password-expiration <one-time-password-expiration> ] [ one-time-password-retries <one-time-password-retries> ] [ default-country-code <default-country-code> ]

Parameters

Parameter

Description

default-country-code

The default country code for phone numbers that do not include a country code.

Type: A number with no fractional part (integer).

one-time-password-expiration

The amount of time users have to enter the one time password before it expires (in minutes).

A number with no fractional part (integer)

one-time-password-length

Number of characters used in the one time password.

Type: A number with no fractional part (integer).

one-time-password-retries

The number of times users can attempt to enter the one time password before the entire authentication process restarts.

A number with no fractional part (integer)

sms-api-id

The API ID required by the SMS provider.

A string of alphanumeric characters without space between them:

  • a-z (lower-case letters)

  • A-Z (upper-case letters)

  • 0-9 (digits)

sms-dynamicid-url

The DynamicID URL when sending SMS message using a user defined SMS provider.

Type: urlDynamicId

sms-message

The SMS message that will be sent to the user.

Type: String

sms-provider

Indicates which provider will send the SMS messages.

Options: check-point, external

sms-provider-password

The password required by the SMS provider.

Type: extendedPassword

sms-provider-username

The username required by the SMS provider

A string that contains up to 64 characters without spaces, of this set:

  • a-z (lower-case letters)

  • A-Z (upper-case letters)

  • 0-9 (digits)

  • '.' (period)

  • '-' (minus)

  • '@' (at)

use-email

Indicates whether sending email messages is enabled Type: Boolean (true/false)

use-sms

Indicates whether sending SMS messages is enabled.

Type: Boolean (true/false)

Example

set vpn remote-access two-factor-authentication use-sms true sms-provider check-point sms-dynamicid-url urlDynamicId sms-provider-username admin sms-provider-password extendedPassword sms-api-id 123SmsAPI456 sms-message "Hello" one-time-password-length 8 one-time-password-expiration 5 one-time-password-retries 3 default-country-code 8