Add-RASMFAUsers

NAME

Add-RASMFAUsers

SYNOPSIS

Import MFA TOTP/EmailOTP users from a CSV file.

SYNTAX

Add-RASMFAUsers -FilePath <string> [-MFAId <uint>] [-SiteId <uint>] [-Type {GAuthTOTP | TOTP | MicrosoftTOTP | EmailOTP}] [<CommonParameters>]

DESCRIPTION

Import MFA TOTP/EmailOTP users from a CSV file.

PARAMETERS

-FilePath <string> File path to CSV containing user and secret.

Must be in the format "user,secret".

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID in where the users will be imported.

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

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MFAId <uint> The ID of the MFA Provider to be modified.

In case of TOTP Provider, the ID will always be 0. Default: 0.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Type <MFAUsersType> The MFA Provider Type to be modified.

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

Possible values: GAuthTOTP, TOTP, MicrosoftTOTP, EmailOTP

        Required?                    false

        Position?                    named

        Default value                TOTP

        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

-none-

EXAMPLES

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

Add-RASMFAUsers -FilePath "users.csv" -Type TOTP

Imports MFA TOTP users from file. Operation is done on licensing site. ---------- EXAMPLE 2 ----------

Add-RASMFAUsers -FilePath "users.csv" -Type EmailOTP -MFAId 1

Imports MFA EmailOTP users from file in MFA with Id 1. ---------- EXAMPLE 3 ----------

Add-RASMFAUsers -FilePath "users.csv" -SiteId 2 -Type TOTP

Imports MFA TOTP users from file. Operation is done on site 2.

Last updated

© 2024 Parallels International GmbH. All rights reserved.