Skip to content

Get HPOVLdap

Jump to bottom
Chris Lynch edited this page Dec 10, 2020 · 43 revisions

Library Version 4.20

Library Version 4.10

Library Version 4.00

HPE OneView 4.10 Library

Get-HPOVLdap

List Global Authentication Directory settings.

SYNTAX

Get-HPOVLdap[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVLdap[ [-Export] <SwitchParameter>] [-Save] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

This cmdlet will display the global authentication directory settings configured on the appliance. It will show if local logins are enabled, default authentication directory name, and configured authentication directory names.

Parameters

-ApplianceConnection <Object>

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? false
Accept wildcard characters?    False

-Export <SwitchParameter>

Aliases [-x] Export the configured directories to individual files.

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

-Save <String>

Aliases [-location] Directory where the exported configured directories will be saved to. A filename of "{appliance_name}_globalSettings.json" will be created.

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

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.AuthGlobalDirectoryConfiguration [System.Management.Automation.PSCustomObject]

Global Authentication Settings object

Examples

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

Get-HPOVLdap
Allow Local Login Default Directory Configured Directories
----------------- ----------------- ----------------------
True              domain1           {domain1, domain2}
True              domain2           {domain1, domain2}

View the Global Authentication Directory configuration for all connected appliances.

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

Get-HPOVLdap -export -save c:\directory

Export the Global Authentication Directory configuration settings.

Related Links

HPE OneView 4.00 Library

Get-HPOVLdap

List Global Authentication Directory settings.

SYNTAX

Get-HPOVLdap[ [-ApplianceConnection] <Object>] [<CommonParameters>]
Get-HPOVLdap[ [-Export] <SwitchParameter>] [-Save] <String>[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

This cmdlet will display the global authentication directory settings configured on the appliance. It will show if local logins are enabled, default authentication directory name, and configured authentication directory names.

Parameters

-ApplianceConnection <Object>

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? false
Accept wildcard characters?    False

-Export <SwitchParameter>

Aliases [-x] Export the configured directories to individual files.

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

-Save <String>

Aliases [-location] Directory where the exported configured directories will be saved to. A filename of '{appliance_name}_globalSettings.json' will be created.

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

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.AuthGlobalDirectoryConfiguration [System.Management.Automation.PSCustomObject]

Global Authentication Settings object

Examples

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

Get-HPOVLdap
Allow Local Login Default Directory Configured Directories
----------------- ----------------- ----------------------
True              domain1           {domain1, domain2}
True              domain2           {domain1, domain2}

View the Global Authentication Directory configuration for all connected appliances.

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

Get-HPOVLdap -export -save c:\directory

Export the Global Authentication Directory configuration settings.

Related Links

Wiki Table of Contents

Clone this wiki locally