Remove HPOVLdapDirectory - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Remove-HPOVLdapDirectory

Remove authentication Directory.

SYNTAX

Remove-HPOVLdapDirectory [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Remove authentication Directory from the appliance. Can provide Directory Name or Object for removal.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

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

-Confirm <SwitchParameter>

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

-Force <SwitchParameter>

Foreably remove the resource from the appliance.

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

-InputObject <Object>

Aliases [-d, -Directory] Configured authentication Directory Name or Object.

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

-WhatIf <SwitchParameter>

Aliases	wi
Required?	false
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

System.Collections.ArrayList

Collection of Directories

System.Management.Automation.PSCustomObject

Single Directory object

Return Values

System.Management.Automation.PSCustomObject

Resource Removed Status

Examples

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

Remove-HPOVLdapDirectory -Directory "My Directory1"

Remove "My Directroy Group1" from the appliance.

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

Get-HPOVLdapDirectory | Remove-HPOVLdapDirectory

Get all Directories and remove them from the default connected appliance.

HPE OneView 4.00 Library