Skip to main content
SnapCenter 5.0 cmdlets

Set-SmMultiFactorAuthentication

Contributors
PDFs

To Enable or disable the MFA feature or to configure the MFA for the SnapCenter GUI, Rest API, PowerShell and sccli.

Syntax

Set-SmMultiFactorAuthentication [-IsGuiMFAEnabled]  <>  [-IsRestApiMFAEnabled ]  <>  [-IsCliMFAEnabled ]  <>  [-Path]  <>  [-Path]  <>  [-IsGuiMFAEnabled]  <>  [-IsRestApiMFAEnabled ]  <>  [-IsCliMFAEnabled ]  <>

Detailed Description

To enable or disable the MFA feature or to configure the MFA for the SnapCenter GUI, Rest API, PowerShell and sccli.

Parameters

Name Description Required? Pipeline Input Default Value

IsGuiMFAEnabled

Specifies the SnapCenter Server to enable or disable MFA for the SnapCenter GUI.

false

false

IsRestApiMFAEnabled

Specifies the SnapCenter Server to enable or disable MFA for the SnapCenter Rest API.

false

false

IsCliMFAEnabled

Specifies the SnapCenter Server to enable or disable MFA for the SnapCenter PowerShell and sccli.

false

false

Path

Configure the MFA for the SnapCenter Server login with specified AD FS metadata file path.

false

false

Examples

Example 1: Enabling MultiFactorAuthentication for GUI, Rest API, PowerShell and sccli

 Set-SmMultiFactorAuthentication -IsGuiMFAEnabled $true -IsRestApiMFAEnabled    $true -IsCliMFAEnabled   $true -Path C:\ADFS_metadata\FederationMetadata.xml

This example syntax enables MFA for SnapCenter GUI, Rest API, PowerShell and sccli configured with specified AD FS metadata file path.

IsGuiMFAEnabled = True

ADFSConfigFilePath = C:\\ADFS_metadata\\FederationMetadata.xml

SCConfigFilePath = c:\ProgramData\NetApp\SnapCenter\Package Repository\SnapCenterMFAMetadata.xml

IsRestApiMFAEnabled = True

IsCliMFAEnabled = True

ADFSHostName = adfs19.ad19domain.com

Example 2: Disabling MultiFactorAuthentication for SnapCenter GUI

 Set-SmMultiFactorAuthentication -IsGuiMFAEnabled $false

This example syntax disables MFA for SnapCenter GUI.

IsGuiMFAEnabled = False

ADFSConfigFilePath = null

SCConfigFilePath = null

IsRestApiMFAEnabled = False

IsCliMFAEnabled = False

ADFSHostName = null

Example 3: Enabling MultiFactorAuthentication for Rest API PowerShell and sccli

 Set-SmMultiFactorAuthentication -IsRestApiMFAEnabled    $true -IsCliMFAEnabled   $true -Path C:\ADFS_metadata\FederationMetadata.xml

This example syntax enables MFA for SnapCenter Rest API, PowerShell and sccli configured with specified AD FS metadata file path.

IsGuiMFAEnabled = False

ADFSConfigFilePath = C:\\ADFS_metadata\\FederationMetadata.xml

SCConfigFilePath = null

IsRestApiMFAEnabled = True

IsCliMFAEnabled = True

ADFSHostName = adfs19.ad19domain.com

Example 4: Enabling MultiFactorAuthentication only for PowerShell and sccli

 Set-SmMultiFactorAuthentication -IsCliMFAEnabled   $true -Path C:\ADFS_metadata\FederationMetadata.xml

This example syntax enables MFA for SnapCenter PowerShell and sccli configured with specified AD FS metadata file path.

IsGuiMFAEnabled = False

ADFSConfigFilePath = C:\\ADFS_metadata\\FederationMetadata.xml

SCConfigFilePath = null

IsRestApiMFAEnabled = False

IsCliMFAEnabled = True

ADFSHostName = adfs19.ad19domain.com

Example 5: Disabling MultiFactorAuthentication for GUI, Rest API, PowerShell and sccli

 Set-SmMultiFactorAuthentication -IsGuiMFAEnabled $False -IsRestApiMFAEnabled   $False  -IsCliMFAEnabled   $False

This example syntax disables MFA for SnapCenter GUI, Rest API, PowerShell and sccli.

IsGuiMFAEnabled = False

ADFSConfigFilePath = null

SCConfigFilePath = null

IsRestApiMFAEnabled = False

IsCliMFAEnabled = False

ADFSHostName = null

Example 6: Disabling MultiFactorAuthentication for Only for Rest API

 Set-SmMultiFactorAuthentication -IsRestApiMFAEnabled   $False

This example syntax disables MFA only for SnapCenter Rest API.

IsGuiMFAEnabled = True

ADFSConfigFilePath = C:\\ADFS_metadata\\FederationMetadata.xml

SCConfigFilePath = null

IsRestApiMFAEnabled = False

IsCliMFAEnabled = True

ADFSHostName = adfs19.ad19domain.com

Example 7: Update MultiFactorAuthentication configuration

 Set-SmMultiFactorAuthentication -Path C:\data\FederationMetadata.xml

This example syntax updates MFA configuration for SnapCenter configured with specified AD FS metadata file path.

IsGuiMFAEnabled = True

ADFSConfigFilePath = C:\\data\\FederationMetadata.xml

SCConfigFilePath = null

IsRestApiMFAEnabled = False

IsCliMFAEnabled = False

ADFSHostName = adfs19.ad19domain.com