Show HPOVLdapGroups - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Show-HPOVLdapGroups

List Directory Groups from the configured LDAP Directory.

SYNTAX

Show-HPOVLdapGroups [-Directory] <Object> [-UserName] <String> [-Password] <SecureString> [-GroupName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Show-HPOVLdapGroups [-Directory] <Object>[ [-Credential] <PSCredential>] [-GroupName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This cmdlet will display the available Authentication Directory security groups. The displayed Directory Groups can then be used to define new Directory Group Role assignment on the appliance with the New-HPOVLdapGroup cmdlet.

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? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Credential <PSCredential>

Use this parameter if you want to provide a PSCredential object instead.

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

-Directory <Object>

Aliases [-d, -domain, -AuthProvider]

The configured LDAP Directory object on the appliance.

Aliases d, domain, AuthProvider
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-GroupName <String>

Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.

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

-Password <SecureString>

Aliases [-p]

User account password

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

-UserName <String>

Aliases [-u]

Username to authenticate with

Aliases u
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

System.Security.SecureString

Directory User Account password

Return Values

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

Authentication Directory Group

System.Collections.ArrayList<HPOneView.Appliance.AuthDirectoryGroup>

Array of Authentication Directory Groups found

Examples

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

Show-HPOVLdapGroups -u "Sarah Peterson" -d Domain1

Get list of Directory Groups from Domain1 and prompt for password.

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

$password = convertto-SecureString -asplaintext "password123890" -force $Directory = Get-HPOVLdapDirectory "Domain99" Show-HPOVLdapGroups -u "Sarah Peterson" -p $password -d $Directory

Automate list of Directory Groups from Domain99 with the provided password.

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

$password = convertto-SecureString -asplaintext "password123890" -force $Directory = Get-HPOVLdapDirectory "Domain99" Show-HPOVLdapGroups -u "Sarah Peterson" -p $password -d $Directory -GroupName "Admins"

Automate list of Directory Groups from Domain99 with the provided password, searching for group names that contain "Admins".

Related Links


Top

HPE OneView 4.00 Library

Show-HPOVLdapGroups

List Directory Groups from the configured LDAP Directory.

SYNTAX

Show-HPOVLdapGroups [-Directory] <Object> [-UserName] <String> [-Password] <SecureString> [-GroupName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]
Show-HPOVLdapGroups [-Directory] <Object>[ [-Credential] <PSCredential>] [-GroupName] <String> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This cmdlet will display the available Authentication Directory security groups. The displayed Directory Groups can then be used to define new Directory Group Role assignment on the appliance with the New-HPOVLdapGroup cmdlet.

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? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Credential <PSCredential>

Use this parameter if you want to provide a PSCredential object instead.

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

-Directory <Object>

Aliases [-d, -domain, -AuthProvider]

The configured LDAP Directory object on the appliance.

Aliases d, domain, AuthProvider
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-GroupName <String>

Provide the name of the Directory Group to search for. If omitted, all found Directory Groups will be returned.

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

-Password <SecureString>

Aliases [-p]

User account password

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

-UserName <String>

Aliases [-u]

Username to authenticate with

Aliases u
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

System.Security.SecureString

Directory User Account password

Return Values

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

Authentication Directory Group

System.Collections.ArrayList<HPOneView.Appliance.AuthDirectoryGroup>

Array of Authentication Directory Groups found

Examples

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

Show-HPOVLdapGroups -u 'Sarah Peterson' -d Domain1

Get list of Directory Groups from Domain1 and prompt for password.

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

$password = convertto-SecureString -asplaintext "password123890" -force $Directory = Get-HPOVLdapDirectory 'Domain99' Show-HPOVLdapGroups -u 'Sarah Peterson' -p $password -d $Directory

Automate list of Directory Groups from Domain99 with the provided password.

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

$password = convertto-SecureString -asplaintext "password123890" -force $Directory = Get-HPOVLdapDirectory 'Domain99' Show-HPOVLdapGroups -u 'Sarah Peterson' -p $password -d $Directory -GroupName 'Admins'

Automate list of Directory Groups from Domain99 with the provided password, searching for group names that contain 'Admins'.

Related Links


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