Set HPOVLdapDefaultDirectory

Library Version 2.00

Library Version 1.20

HPE OneView 2.00 Library

Set-HPOVLdapDefaultDirectory

Configure Authentication Directory default directory.

SYNTAX

Set-HPOVLdapDefaultDirectory [-Directory] <Object>[ [-DisableLocalLogin] <SwitchParameter>] [-ApplianceConnection] <Object>[ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Use this Cmdlet to set the default Authentication Directory on the appliance. Use Get-HPOVLdapDirectory to pass in the directory to configure as the default. Once the Default Directory is set, the Cmdlet will configure a Registry Key (HKCU:\Software\Hewlett-Packard\HPOneView) called "AuthProvider#{ApplianceConnectionName}". The Library will read this value upon load and use it as the default value for the -AuthDirectory parameter in Connect-HPOVMgmt.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

Aliases	Appliance
Required?	true
Position?	named
Default value	(${Global:ConnectedSessions} \| ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Confirm <SwitchParameter>

Aliases	cf
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Directory <Object>

Provide the Directory Name, URI or Object. If you want to set the Authentication Directory back to Local, specify LOCAL as the name.

Aliases	None
Required?	true
Position?	0
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-DisableLocalLogin <SwitchParameter>

Use to disable appliance local login accounts. You cannot use this parameter if an Authentication Directory is not configured.

Aliases	None
Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	False

-WhatIf <SwitchParameter>

Aliases	wi
Required?	false
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

HPOneView.Appliance.AuthDirectory [System.Management.Automation.PSCustomObject] Authentication Directory retrieved using Get-HPOVLdapDirectory.

Return Values

System.Management.Automation.PSCustomObject Appliance Authentication Directory setting.

Examples

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

PS C:\> Set-HPOVLdapDefaultDirectory "Domain1" # Cmdlet will create: # HKCU:\Software\Hewlett-Packard\HPOneView\AuthProvider#MyAppliance.domain.com REG_SZ, value = "Domain1"

Set 'Domain1' as the default authentication directory for the appliance. Then, the Cmdlet will create the REG_SZ "AuthProvider#MyAppliance.domain.com" with a value of "Domain1".

-------------------------- EXAMPLE 2 --------------------------

PS C:\> Get-HPOVLdapDirectory Domain1 | Set-HPOVLdapDirectory

Get the LDAP Authentication Directory, Domain1, and set it as the default.

-------------------------- EXAMPLE 3 --------------------------

PS C:\> Set-HPOVLdapDirectory Local

Set the default authentication directoy to 'Local'.

HPE OneView 1.20 Library