Get HPOVApplianceTwoFactorAuthentication - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Get-HPOVApplianceTwoFactorAuthentication

Get appliance two-factor configuration.

SYNTAX

Get-HPOVApplianceTwoFactorAuthentication[ [-ApplianceConnection] <Array>] [<CommonParameters>]

Detailed Description

Enabling two-factor authentication allows you to use smart cards � for example, Common Access Cards (CAC), or Personal Identity Verification (PIV) cards � to authenticate within HPE OneView. The client certificate embedded in the smart card is presented to HPE OneView by the library. The client certificate must be signed by a root or intermediate Certificate Authority (CA) that has been previously imported into the HPE OneView appliance. The appliance authenticates the client certificate to validate that the user name specified in the certificate is that of a valid user recognized by the directory server configuration in HPE OneView.

When two-factor authentication is enabled, HPE OneView uses a Microsoft Active Directory service account set up and owned by the user to access an Active Directory entry for the user, rather than using an account associated with the user name received during first time login.

Use this Cmdlet to get two factor authentication state of the connected appliance. Infrastructure administrator role is required.

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? False
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.Security.TwoFactorAuthConfiguration

Appliance two-factor security settings.

Examples

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

Get-HPOVApplianceTwoFactorAuthentication

Get the appliance two-factor authentication configuration.

Related Links


Top

HPE OneView 4.00 Library

Get-HPOVApplianceTwoFactorAuthentication

Get appliance two-factor configuration.

SYNTAX

Get-HPOVApplianceTwoFactorAuthentication[ [-ApplianceConnection] <Array>] [<CommonParameters>]

Detailed Description

Enabling two-factor authentication allows you to use smart cards — for example, Common Access Cards (CAC), or Personal Identity Verification (PIV) cards — to authenticate within HPE OneView. The client certificate embedded in the smart card is presented to HPE OneView by the library. The client certificate must be signed by a root or intermediate Certificate Authority (CA) that has been previously imported into the HPE OneView appliance. The appliance authenticates the client certificate to validate that the user name specified in the certificate is that of a valid user recognized by the directory server configuration in HPE OneView.

When two-factor authentication is enabled, HPE OneView uses a Microsoft Active Directory service account set up and owned by the user to access an Active Directory entry for the user, rather than using an account associated with the user name received during first time login.

Use this Cmdlet to get two factor authentication state of the connected appliance. Infrastructure administrator role is required.

Parameters

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? False
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.Security.TwoFactorAuthConfiguration

Appliance two-factor security settings.

Examples

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

Get-HPOVApplianceTwoFactorAuthentication

Get the appliance two-factor authentication configuration.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️