Skip to content

Get-OVLdapGroup

Syntax

Get-OVLdapGroup
    [-Name <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Get-OVLdapGroup
    [-Export <String>]
    [-ApplianceConnection <Object>]
    [<CommonParameters>]

Description

You can configure HPE OneView to use an external enterprise directory service for user authentication. HPE OneView supports the following enterprise directory services:

  • Active Directory
  • OpenLDAP

When you use a directory service, directory users are granted HPE OneView permissions using their group membership in the directory. After defining a directory service, use the User and Groups screen to define permissions for directory groups. Directory groups are assigned one or more HPE OneView permissions. A directory user is assigned the HPE OneView permissions that represent the union of the permissions for all the directory groups that the user is a member of. Only after permissions are defined for directory groups, directory users are authenticated into the appliance.

This Cmdlet will display the configured directory groups on the appliance, and display their assigned role(s).

Info

Minimum required privileges: Read-only

Examples

Example 1

Get-OVLdapGroup

Name                              Directory                               Roles
----                              ---------                               -----
My Directory Group1               domain1                                 {Storage administrator}
My Directory Group2               domain1                                 {Network administrator}

Get list of configured Directory Groups.

Example 2

Get-OVLdapGroup -Name "My Directory Group1"

Name                              Directory                               Roles
----                              ---------                               -----
My Directory Group1               domain1                                 {Storage administrator}

Display "My Directroy Group1" and the assigned roles.

Example 3

Get-OVLdapGroup -export C:\dir\directorygroups.json

Export configured Directory Groups to c:\dir\directorygroups.json

Parameters

-Name <String>

Configured Directory Group Name. If omitted, all configured Directory Groups will be displayed.

Aliases group, GroupName
Required? False
Position? Named
Default value
Accept pipeline input? false
Accept wildcard characters? False

-Export <String>

Export JSON content to file

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

-ApplianceConnection <Object>

Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).

Aliases Appliance
Required? False
Position? Named
Default value (${Global:ConnectedSessions} | ? Default)
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

Configured Directory Group role mapping

Multiple configured Directory Group role mappings