Show-OVLdapGroups
Syntax
Show-OVLdapGroups
[-Directory] <Object>
[-UserName] <String>
[-Password] <System.Security.SecureString>
[-GroupName] <String>
[-ApplianceConnection] <Object>
[<CommonParameters>]
Show-OVLdapGroups
[-Directory] <Object>
[-Credential <PSCredential>]
[-GroupName] <String>
[-ApplianceConnection] <Object>
[<CommonParameters>]
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-OVLdapGroup Cmdlet.
Examples
Example 1
Get list of Directory Groups from Domain1 and prompt for password.
Example 2
$password = ConvertTo-SecureString -asplaintext "password123890" -force
$Directory = Get-OVLdapDirectory "Domain99"
Show-OVLdapGroups -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-OVLdapDirectory "Domain99"
Show-OVLdapGroups -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".
Parameters
-UserName <String>
Username to authenticate with
| Aliases | u |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Password <System.Security.SecureString>
User account password
| Aliases | p |
|---|---|
| Required? | True |
| Position? | Named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Directory <Object>
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 |
-ApplianceConnection <Object>
Specify one or more [HPEOneView.Appliance.Connection] object(s) or Name property value(s).
| 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 |
<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
Directory User Account password
Return Values
Authentication Directory Group
Array of Authentication Directory Groups found