# Invoke-RASMFA

## NAME

Invoke-RASMFA

## SYNOPSIS

Invokes a MFA action.

## SYNTAX

**Invoke-RASMFA** -[CheckConnection](#checkconnection-string)\*\* *(SwitchParameter)* \[-[AttributeInfoList](#AttributeInfoList) *(List\`1)*] \[[BackupServer](#backupserver-string) *(string)*] \[[EnforceMessageAuthenticator](#enforcemessageauthenticator-string) *(bool)*] \[-[HAMode](#HAMode) {Parallel | Serial}] \[-[PasswordEncoding](#PasswordEncoding) {PAP | CHAP | PAP\_UTF8 | CHAP\_UTF8}] \[[Port](#port-string) *(uint)*] \[[Retries](#retries-string) *(uint)*] \[[Server](#server-string) *(string)*] \[[Timeout](#timeout-string) *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Invoke-RASMFA** \[[Id](#id-string)] *(uint)*\*\* -[Duplicate](#duplicate-string) *(SwitchParameter)* \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Invoke-RASMFA** -[ImportVendor](#importvendor-string)\*\* *(SwitchParameter)* -[VendorFile](#vendorfile-string) *(string)* \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Invoke-RASMFA** \[-[InputObject](#inputobject)]\*\* *(*[*MFA*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfa)*)* -[Duplicate](#duplicate-string) *(SwitchParameter)* \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Invoke-RASMFA** \[\[-[SiteId](#siteid-string)]\*\* *(uint)*] -[UserPrincipalName](#userprincipalname-string) *(string)* -[ValidateADAccess](#validateadaccess-string) *(SwitchParameter)* \[[ADCustomAttribute](#adcustomattribute-string) *(string)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

## DESCRIPTION

Invokes a MFA action.

## PARAMETERS

## Id (uint)

The ID of the MFA to invoke the action on. To obtain the ID, use the Get-RASMFA cmdlet.

```
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## InputObject ([MFA](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfa))

The MFA object to invoke the action on.

```
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
```

## Duplicate (SwitchParameter)

Specifies to duplicate the MFA provider.

```
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## CheckConnection (SwitchParameter)

Specifies to duplicate the MFA provider.

```
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## ValidateADAccess (SwitchParameter)

Specifies to duplicate the MFA provider.

```
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## ImportVendor (SwitchParameter)

Specifies to duplicate the MFA provider.

```
        Required?                    true

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Server (string)

The server of the second level authentication provider.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## BackupServer (string)

The backup server of the second level authentication provider.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Port (uint)

The port number of the second level authentication provider.

```
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## HAMode ([HAMode](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/hamode))

The type of high availability mode to be used.

Possible values: Parallel, Serial

```
        Required?                    false

        Position?                    named

        Default value                Parallel

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Timeout (uint)

Connection timeout (in seconds).

```
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Retries (uint)

Number of retries.

```
        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## PasswordEncoding

([PasswordEncoding](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/passwordencoding)) The type of password encoding to be used.

Possible values: PAP, CHAP, PAP\_UTF8, CHAP\_UTF8

```
        Required?                    false

        Position?                    named

        Default value                PAP

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## AttributeInfoList (List\`1)

List of the RADIUS attribute information.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## EnforceMessageAuthenticator (bool)

Specifies whether to enforce message authenticator from radius server or not.

```
        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## SiteId (uint)

Site ID from which to Validate the MFA AD Access.

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

```
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## ADCustomAttribute (string)

AD Custom Attribute

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## UserPrincipalName (string)

The User Principal Name

```
        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## VendorFile (string)

Vendor Details file name.

```
        Required?                    true

        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

[MFA](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfa)

## OUTPUTS

[MFADeepnet](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfadeepnet)

[MFAEmailOTP](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfaemailotp)

[MFARadius](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfaradius)

[MFASafenet](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfasafenet)

[MFATOTP](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/mfatotp)

## EXAMPLES

**---------- EXAMPLE 1 ----------**

Invoke-RASMFA -Id 1 -Duplicate

Adds a new MFA by duplicating the MFA with ID 1.\
\&#xNAN;**---------- EXAMPLE 2 ----------**

Invoke-RASMFA -ValidateADAccess -SiteId 1 -ADCustomAttribute "customasd" -UserPrincipalName "<test@prls.dev>"

Adds a new MFA by duplicating the MFA with ID 1.\
\&#xNAN;**---------- EXAMPLE 3 ----------**

Invoke-RASMFA -CheckConnection -Server 1.1.1.1 -BackupServer 2.2.2.2 -Port 80 -HAMode Parallel -Timeout 1 -Retries 1 -PasswordEncoding CHAP -EnforceMessageAuthenticator $true

Adds a new MFA by duplicating the MFA with ID 1.

## RELATED LINKS

* [Get-RASMFA](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-rasmfa)
* [New-RASMFA](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/new-rasmfa)
* [Set-RASMFA](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/set-rasmfa)
* [Remove-RASMFA](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-rasmfa)