Add HPOVLdapServer - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Add-HPOVLdapServer

Add a new LDAP Directory Server.

SYNTAX

Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String> [-Username] <String>[ [-SSLPort] <Int32>][ [-Certificate] <Object>][ [-Password] <Object>][ [-TrustLeafCertificate] <SwitchParameter>] [<CommonParameters>]
Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String>[ [-Credential] <PSCredential>][ [-SSLPort] <Int32>][ [-Certificate] <Object>][ [-TrustLeafCertificate] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Add-HPOVLdapServer[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

This Cmdlet will add a new LDAP Directory Server to an existing authentication directory.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value.

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Certificate <Object>

Aliases [-cert] Directory Server SSL Certificate, either location to Base64 Cert or multi-line string value. If omitted, the CMDLET will attempt to retrieve the Directory Servers Secure LDAP Certiciate.

Aliases cert
Required? false
Position? named
Default value
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

-Hostname <String>

Aliases [-Name] Directory server name or IP Address to add.

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

-InputObject <Object>

The LDAP Directory Object from Get-HPOVLdapDirectory.

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

-Password <Object>

Aliases [-p] Directory User account password in order to validate LDAP configuration. Can be System.String or SecureString object.

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

-SSLPort <Int32>

Aliases [-port] Directory Server"s LDAP SSL Port.

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

-TrustLeafCertificate <SwitchParameter>

When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or, use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority"s certificate.

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

-Username <String>

Aliases [-u] Directory Username to authenticate with in order to validate LDAP configuration.

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

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

Authentication Directory object that will have the LDAP Server added to.

Return Values

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

Updated Authentication Directory.

Examples

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

Get-HPOVLdapDirectory -Name MyDirectory | Add-HPOVLdapServer -Name servera.domain.com -Username MyAdminName -Password (ConvertTo-SecureString "MyPAssword" -AsPlanText -Force)

Add a new LDAP Directory server.

Related Links


Top

HPE OneView 4.00 Library

Add-HPOVLdapServer

Add a new LDAP Directory Server.

SYNTAX

Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String> [-Username] <String>[ [-SSLPort] <Int32>][ [-Certificate] <Object>][ [-Password] <Object>][ [-TrustLeafCertificate] <SwitchParameter>] [<CommonParameters>]
Add-HPOVLdapServer [-InputObject] <Object> [-Hostname] <String>[ [-Credential] <PSCredential>][ [-SSLPort] <Int32>][ [-Certificate] <Object>][ [-TrustLeafCertificate] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Add-HPOVLdapServer[ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

This Cmdlet will add a new LDAP Directory Server to an existing authentication directory.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value.

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? false
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Certificate <Object>

Aliases [-cert] Directory Server SSL Certificate, either location to Base64 Cert or multi-line string value. If omitted, the CMDLET will attempt to retrieve the Directory Servers Secure LDAP Certiciate.

Aliases cert
Required? false
Position? named
Default value
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

-Hostname <String>

Aliases [-Name] Directory server name or IP Address to add.

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

-InputObject <Object>

The LDAP Directory Object from Get-HPOVLdapDirectory.

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

-Password <Object>

Aliases [-p] Directory User account password in order to validate LDAP configuration. Can be System.String or SecureString object.

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

-SSLPort <Int32>

Aliases [-port] Directory Server's LDAP SSL Port.

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

-TrustLeafCertificate <SwitchParameter>

When adding a new LDAP directory server, the certificate may not be trusted. Use this switch to force trust the certificate. Or, use the Add-HPOVApplianceTrustedCertificate to add the enterprise issuing certificate authority's certificate.

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

-Username <String>

Aliases [-u] Directory Username to authenticate with in order to validate LDAP configuration.

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

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

Authentication Directory object that will have the LDAP Server added to.

Return Values

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

Updated Authentication Directory.

Examples

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

Get-HPOVLdapDirectory -Name MyDirectory | Add-HPOVLdapServer -Name servera.domain.com -Username MyAdminName -Password (ConvertTo-SecureString 'MyPAssword' -AsPlanText -Force)

Add a new LDAP Directory server.

Related Links


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