New HPOVLdapDirectory

Library Version 3.10

Library Version 3.00

Library Version 2.00

Library Version 1.20

HPE OneView 3.10 Library

New-HPOVLdapDirectory

Add a new Directory for Authentication

SYNTAX

New-HPOVLdapDirectory [-Name] <String>[ [-AD] <SwitchParameter>] [-BaseDN] <String> [-Servers] <Array> [-Username] <String> [-Password] <SecureString> [-ApplianceConnection] <Object> [<CommonParameters>]

New-HPOVLdapDirectory [-Name] <String>[ [-OpenLDAP] <SwitchParameter>] [-BaseDN] <String> [-OrganizationalUnits] <Array> [-Servers] <Array> [-Username] <String> [-Password] <SecureString> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This cmdlet will create a new Directory for appliance authentication. HPE OneView currently supports either Active Directory or LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer cmdlet is used to assist defining directory servers address, public SSL certificate and LDAP over SSL TCP port.

Parameters

-AD <SwitchParameter>

Using Active Directory, which sets the authProtocol to AD and userNameField to CN

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

-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

-BaseDN <String>

Aliases [-Root, -RootDN]

Directory Base DN (E.g. dc=domian,dc=local)

Aliases	root, rootdn
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Name <String>

Directory name to add. Does not need to match LDAP/AD Directory Name, but should.

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

-OpenLDAP <SwitchParameter>

Aliases [-LDAP]

Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID

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

-OrganizationalUnits <Array>

OpenLDAP OU's to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso

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

-Password <SecureString>

Aliases [-p, -pass] Directory Username password.

Aliases	p, pass
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-Servers <Array>

Array of Directory Servers and their settings. Must include the following:

* Server Name (FQDN or IP)
* Public SSL Certificate
* SSL Port, if not default 636

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

-Username <String>

Aliases [-u, -user] Directory Username to authenticate with.

Aliases	u, user
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 Account Password that will be used to validate the directory

Return Values

System.Management.Automation.PSCustomObject

Configured Authentication Directory

**System.Collections.ArrayList **

Multiple configured Authentication Directories

Examples

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

$ServerA,$ServerB = servera.domain.com,serverb.domain.com | New-HPOVLdapServer
New-HPOVLdapDirectory -name Domain1 -AD -basedn 'dc=domain,dc=com' -servers $ServerA,$ServerB -Username [email protected]

Add a new directory with two directory servers, and be prompted for your directory account password.

Related Links

• Get-HPOVLdap
• Get-HPOVLdapDirectory
• New-HPOVLdapServer
• Add-HPOVLdapServer
• Remove-HPOVLdapServer
• Remove-HPOVLdapDirectory
• Set-HPOVLdapDefaultDirectory
• Enable-HPOVLdapLocalLogin
• Disable-HPOVLdapLocalLogin
• Get-HPOVLdapGroup
• New-HPOVLdapGroup
• Set-HPOVLdapGroupRole
• Remove-HPOVLdapGroup
• Show-HPOVLdapGroups

---

Top

HPE OneView 3.00 Library

New-HPOVLdapDirectory

Add a new Directory for Authentication

SYNTAX

New-HPOVLdapDirectory [-Name] <String>[ [-AD] <SwitchParameter>] [-BaseDN] <String> [-Servers] <Array> [-Username] <String> [-Password] <SecureString> [-ApplianceConnection] <Object> [<CommonParameters>]

New-HPOVLdapDirectory [-Name] <String>[ [-OpenLDAP] <SwitchParameter>] [-BaseDN] <String> [-OrganizationalUnits] <Array> [-Servers] <Array> [-Username] <String> [-Password] <SecureString> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This cmdlet will create a new Directory for appliance authentication. HPE OneView currently supports either Active Directory or LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer cmdlet is used to assist defining directory servers address, public SSL certificate and LDAP over SSL TCP port.

Parameters

-AD <SwitchParameter>

Using Active Directory, which sets the authProtocol to AD and userNameField to CN

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

-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

-BaseDN <String>

Aliases [-Root, -RootDN]

Directory Base DN (E.g. dc=domian,dc=local)

Aliases	root, rootdn
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Name <String>

Directory name to add. Does not need to match LDAP/AD Directory Name, but should.

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

-OpenLDAP <SwitchParameter>

Aliases [-LDAP]

Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID

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

-OrganizationalUnits <Array>

OpenLDAP OU's to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso

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

-Password <SecureString>

Aliases [-p, -pass] Directory Username password.

Aliases	p, pass
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-Servers <Array>

Array of Directory Servers and their settings. Must include the following:

• Server Name (FQDN or IP)
• Public SSL Certificate
• SSL Port, if not default 636

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

-Username <String>

Aliases [-u, -user] Directory Username to authenticate with.

Aliases	u, user
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 Account Password that will be used to validate the directory

Return Values

System.Management.Automation.PSCustomObject

Configured Authentication Directory

**System.Collections.ArrayList **

Multiple configured Authentication Directories

Examples

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

PS C:\> $ServerA,$ServerB = servera.domain.com,serverb.domain.com | New-HPOVLdapServer
PS C:\> New-HPOVLdapDirectory -name Domain1 -AD -basedn 'dc=domain,dc=com' -servers $ServerA,$ServerB -Username [email protected]

Add a new directory with two directory servers, and be prompted for your directory account password.

Related Links

• Get-HPOVLdap
• Get-HPOVLdapDirectory
• New-HPOVLdapServer
• Add-HPOVLdapServer
• Remove-HPOVLdapServer
• Remove-HPOVLdapDirectory
• Set-HPOVLdapDefaultDirectory
• Enable-HPOVLdapLocalLogin
• Disable-HPOVLdapLocalLogin
• Get-HPOVLdapGroup
• New-HPOVLdapGroup
• Set-HPOVLdapGroupRole
• Remove-HPOVLdapGroup
• Show-HPOVLdapGroups

---

Top

HPE OneView 2.00 Library

New-HPOVLdapDirectory

Add a new Directory for Authentication

SYNTAX

New-HPOVLdapDirectory [-Name] <String> [-BaseDN] <String> [-Servers] <Array> [-Username] <String> [-Password] <Object>[ [-AD] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]

New-HPOVLdapDirectory [-Name] <String> [-BaseDN] <String> [-UserAttribute] <String> [-OrganizationalUnits] <Array> [-Servers] <Array> [-Username] <String> [-Password] <Object>[ [-OpenLDAP] <SwitchParameter>] [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This Cmdlet will create a new Directory for appliance authentication. HPE OneView currently supports either Active Directory or LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer Cmdlet is used to assist defining directory servers address, public SSL certificate and LDAP over SSL TCP port.

Parameters

-AD <SwitchParameter>

Using Active Directory, which sets the authProtocol to AD and userNameField to CN

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

-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

-BaseDN <String>

Aliases [-Root, -RootDN]

Directory Base DN (E.g. dc=domian,dc=local)

Aliases	root, rootdn
Required?	true
Position?	2
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-Name <String>

Directory name to add. Does not need to match LDAP/AD Directory Name, but should.

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

-OpenLDAP <SwitchParameter>

Aliases [-LDAP]

Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID

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

-OrganizationalUnits <Array>

OpenLDAP OU's to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso

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

-Password <Object>

Aliases [-p, -pass] Directory Username password in either String or SecureString format.

Aliases	p, pass
Required?	true
Position?	7
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-Servers <Array>

Array of Directory Servers and their settings. Must include the following:

• Server Name (FQDN or IP)
• Public SSL Certificate
• SSL Port, if not default 636

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

-UserAttribute <String>

Deprecated parameter. Attribute is now controlled via either the -OpenLDAP and -AD parameter switches.

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

-Username <String>

Aliases [-u, -user] Directory Username to authenticate with.

Aliases	u, user
Required?	true
Position?	6
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 Account Password that will be used to validate the directory.

Return Values

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

Configured Authentication Directory

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

Multiple configured Authentication Directories

Examples

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

PS C:\> $ServerA,$ServerB = servera.domain.com,serverb.domain.com | New-HPOVLdapServer
PS C:\> New-HPOVLdapDirectory -name Domain1 -AD -basedn 'dc=domain,dc=com' -servers $ServerA,$ServerB -Username [email protected]

Add a new directory with two directory servers, and be prompted for your directory account password.

Related Links

• Get-HPOVLdap
• Get-HPOVLdapDirectory
• New-HPOVLdapServer
• Remove-HPOVLdapDirectory
• Set-HPOVLdapDefaultDirectory
• Enable-HPOVLdapLocalLogin
• Disable-HPOVLdapLocalLogin
• Get-HPOVLdapGroup
• New-HPOVLdapGroup
• Set-HPOVLdapGroupRole
• Remove-HPOVLdapGroup
• Show-HPOVLdapGroups

---

Top

HPE OneView 1.20 Library

New-HPOVLdapDirectory

Add a new Directory for Authentication

SYNTAX

New-HPOVLdapDirectory [-Name] <Name> [-AD] <AD> [-RootDN] <RootDN> [-SearchContext] <SearchContext> [-Servers] <Servers> [-Username] <Username> [-Password] <Password> [<CommonParameters>]

New-HPOVLdapDirectory [-Name] <Name> [-LDAP] <LDAP> [-RootDN] <RootDN> [-SearchContext] <SearchContext> [-Servers] <Servers> [-Username] <Username> [-Password] <Password> [<CommonParameters>]

Detailed Description

This cmdlet will create a new Directory for appliance authentication. HP OneView currently supports either Active Directory or LDAP (e.g. OpenLDAP) for user authentication. The New-HPOVLdapServer cmdlet is used to assist defining directory servers address, public SSL certificate and LDAP over SSL TCP port.

Parameters

-Name <Name>

Directory name to add. Does not need to match LDAP/AD Directory Name, but should.

Aliases	None.
Required?	true
Position?	1
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-AD <AD>

Using Active Directory, which sets the authProtocol to AD and userNameField to CN

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

-LDAP <LDAP>

Using LDAP (i.e. OpenLDAP), which sets the authProtocol to LDAP and userNameField to UID

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

-RootDN <RootDN>

Aliases [-root] Directory Base DN (E.g. dc=domian,dc=local)

Aliases	None.
Required?	true
Position?	3
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-SearchContext <SearchContext>

Search context to begin search for Directory Group and User Account authentication. E.g. ou=admins,ou=contoso

Starting with HP OneView 1.01, up to 4 search contexts can be specified seperated with the + (plus) character. E.g. ou=admins,ou=contoso+ou=admingroups,ou=contoso

Aliases	None.
Required?	true
Position?	4
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-Servers <Servers>

Array of Directory Servers and their settings. Must include the following:

• Server Name (FQDN or IP) • Public SSL Certificate • SSL Port, if not default 636

Aliases	None.
Required?	true
Position?	5
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-Username <Username>

Aliases [-u, -user] Directory Username to authenticate with.

Aliases	None.
Required?	true
Position?	6
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-Password <Password>

Aliases [-p, -pass] Directory Username password.

Aliases	None.
Required?	true
Position?	7
Default value
Accept pipeline input?	true (ByValue)
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 Account Password that will be used to validate the directory.

Return Values

System.String

System.String

Examples

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

PS C:\> $ServerA = New-HPOVLdapServer -Name servera.domain.com -Certificate C:\dir\servera.cer
PS C:\> $ServerB = New-HPOVLdapServer -Name serverb.domain.com -Certificate C:\dir\serverb.cer
PS C:\> New-HPOVLdapDirectory -name Domain1 -AD -rootdn 'dc=domain,dc=com' -SearchContext 'ou=admins,ou=contoso' -servers @($ServerA,$ServerB)

Add a new directory with two directory servers.

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

PS C:\> $ServerA = New-HPOVLdapServer -Name servera.domain.com -Certificate C:\dir\servera.cer
PS C:\> $ServerB = New-HPOVLdapServer -Name serverb.domain.com -Certificate C:\dir\serverb.cer
PS C:\> $password = ConvertTo-SecureString -asplaintext "password123890" -force
PS C:\> New-HPOVLdapDirectory -name Domain1 -AD -rootdn 'dc=domain,dc=com' -SearchContext 'ou=admins,ou=contoso+ou=groups,ou=contoso' -servers @($ServerA,$ServerB) -user Domain\Administrator -password $password

Create and validate a new Directory with multiple Search Contexts.

Related Links

• Get-HPOVLdap
• Get-HPOVLdapDirectory
• New-HPOVLdapServer
• Remove-HPOVLdapDirectory
• Set-HPOVLdapDefaultDirectory
• Enable-HPOVLdapLocalLogin
• Disable-HPOVLdapLocalLogin
• Get-HPOVLdapGroup
• New-HPOVLdapGroup
• Set-HPOVLdapGroupRole
• Remove-HPOVLdapGroup
• Show-HPOVLdapGroups

---

Top