Remove HPOVUser - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Remove-HPOVUser

Remove a user account.

SYNTAX

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

Detailed Description

Remove a specific local user account from the management appliance

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

-InputObject <Object>

The user account object to be removed.

Aliases u, user, UserName, Name
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

<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.User [System.Management.Automation.PSCustomObject]

HPE OneView User Account object created on an appliance

Return Values

System.Collections.Hashtable

Success message if user was deleted

Examples

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

Get-HPOVUser Sally | Remove-HPOVUser

Retrieve "Sally" user account using Get-HPOVUser, then pipe it to Remove-HPOVUser.

Related Links


Top

HPE OneView 4.00 Library

Remove-HPOVUser

Remove a user account.

SYNTAX

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

Detailed Description

Remove a specific local user account from the management appliance

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

-InputObject <Object>

The user account object to be removed.

Aliases u, user, UserName, Name
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

<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.User [System.Management.Automation.PSCustomObject]

HPE OneView User Account object created on an appliance

Return Values

System.Collections.Hashtable

Success message if user was deleted

Examples

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

Get-HPOVUser Sally | Remove-HPOVUser

Retrieve 'Sally' user account using Get-HPOVUser, then pipe it to Remove-HPOVUser.

Related Links


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