Remove HPOVLdapServer - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Remove-HPOVLdapServer

Remove an existing LDAP Directory Server.

SYNTAX

Remove-HPOVLdapServer [-InputObject] <Object> [-DirectoryServerName] <String> [-Username] <String>[ [-Password] <Object>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]

Remove-HPOVLdapServer [-InputObject] <Object> [-DirectoryServerName] <String>[ [-Credential] <PSCredential>][ [-ApplianceConnection] <Object>] [-WhatIf] <> [-Confirm] <> [<CommonParameters>]

Detailed Description

This Cmdlet will remove an existing LDAP Directory Server resource from an existing LDAP 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

-Confirm <>

Aliases	cf
Required?
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

-DirectoryServerName <String>

Aliases [-Name] Directory server name.

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	Directory
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

-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

-WhatIf <>

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

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 | Remove-HPOVLdapServer -DirectoryServerName servera.domain.com -Username MyAdminName -Password (ConvertTo-SecureString "MyPAssword" -AsPlanText -Force)

Remove the specified LDAP Directory server from "MyDirectory". Will be prompted for confirmation.

HPE OneView 4.00 Library