Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

​
Synopsis

Returns configured authentication directory objects (Active Directory or OpenLDAP) from an HPE OneView appliance.

​
Syntax

Get-OVLdapDirectory
    [-Name <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]
Export configuration to file: 
Get-OVLdapDirectory
    -Export <String>
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

​
Description

Get-OVLdapDirectory retrieves the LDAP and Active Directory authentication directory configurations registered on the appliance. These directories are used to authenticate non-local users. Use the returned objects to inspect directory settings, verify server connectivity, or feed them into other cmdlets. The -Export parameter saves the configuration as JSON files to a specified directory, one file per configured directory per appliance connection. Wildcard characters are supported in the Name parameter.

​
Parameters

​
Name
string
The name of the directory configuration to retrieve. Supports wildcard characters (*). When omitted, all configured directories are returned. Aliased as directory and domain.
​
Export
string
A path to an existing directory on the local file system. When specified, the cmdlet saves each directory’s configuration as a JSON file to this location instead of returning objects. Aliased as x.
​
ApplianceConnection
Object
default:"Default connected session"
The appliance connection object or name. Defaults to the default connected session. Accepts an array of connections to query multiple appliances. Aliased as Appliance.

​
Examples

​
List all configured authentication directories

Get-OVLdapDirectory
Returns every authentication directory configured on the default connected appliance.

​
Get a specific directory by name

Get-OVLdapDirectory -Name 'corp.example.com'
Returns the directory configuration for corp.example.com.

​
Use a wildcard to find directories

Get-OVLdapDirectory -Name 'corp*'
Returns all directories whose names begin with corp.

​
Export directory configurations to JSON files

Get-OVLdapDirectory -Export 'C:\Backups\DirectoryConfigs'
Saves each configured directory as a JSON file in C:\Backups\DirectoryConfigs.

​
Output

HPEOneview.Appliance.AuthDirectory Each returned object includes the following key properties:
PropertyTypeDescription
nameStringThe friendly name of the directory configuration.
authProtocolStringAD or LDAP.
baseDNStringThe base distinguished name for directory searches.
directoryServersArrayThe directory server hostnames and ports.
userNamingAttributeStringThe LDAP attribute used as the login name (CN or UID).

Build docs developers (and LLMs) love

Get started for freeTalk to us