1 of 1

Invoke-RASMFA

NAME

Invoke-RASMFA

SYNOPSIS

Invokes a MFA action.

SYNTAX

Invoke-RASMFA -CheckConnection <SwitchParameter> [-AttributeInfoList <List`1>] [-BackupServer <string>] [-HAMode {Parallel | Serial}] [-PasswordEncoding {PAP | CHAP}] [-Port <uint>] [-Retries <uint>] [-Server <string>] [-Timeout <uint>] [<CommonParameters>]

Invoke-RASMFA [-Id] <uint> -Duplicate <SwitchParameter> [<CommonParameters>]

Invoke-RASMFA -ImportVendor <SwitchParameter> -VendorFile <string> [<CommonParameters>]

Invoke-RASMFA [-InputObject] <MFA> -Duplicate <SwitchParameter> [<CommonParameters>]

Invoke-RASMFA [[-SiteId] <uint>] -UserPrincipalName <string> -ValidateADAccess <SwitchParameter> [-ADCustomAttribute <string>] [<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> 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> 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> The type of password encoding to be used.

Possible values: PAP, CHAP

        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

-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

        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

OUTPUTS

EXAMPLES

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

Invoke-RASMFA -Id 1 -Duplicate

Adds a new MFA by duplicating the MFA with ID 1. ---------- EXAMPLE 2 ----------

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

Adds a new MFA by duplicating the MFA with ID 1. ---------- EXAMPLE 3 ----------

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

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

Invoke-RASMFA

NAME

Invoke-RASMFA

SYNOPSIS

Invokes a MFA action.

SYNTAX

Invoke-RASMFA [-Id] <uint> -Duplicate <SwitchParameter> [<CommonParameters>]

Invoke-RASMFA -ImportVendor <SwitchParameter> -VendorFile <string> [<CommonParameters>]

Invoke-RASMFA [-InputObject] <MFA> -Duplicate <SwitchParameter> [<CommonParameters>]

Invoke-RASMFA [[-SiteId] <uint>] -UserPrincipalName <string> -ValidateADAccess <SwitchParameter> [-ADCustomAttribute <string>] [<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> 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> 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> The type of password encoding to be used.

Possible values: PAP, CHAP

        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

-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

        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

OUTPUTS

EXAMPLES

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

Invoke-RASMFA -Id 1 -Duplicate

Adds a new MFA by duplicating the MFA with ID 1. ---------- EXAMPLE 2 ----------

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

Adds a new MFA by duplicating the MFA with ID 1. ---------- EXAMPLE 3 ----------

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

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

Invoke-RASMFA

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS

Invoke-RASMFA

NAME

SYNOPSIS

SYNTAX

DESCRIPTION

PARAMETERS

INPUTS

OUTPUTS

EXAMPLES

RELATED LINKS