Skip to content

Remove GAUserProperty

Spencer Varney edited this page Dec 9, 2016 · 2 revisions

This Cmdlet has been depreciated and discontinued as of v0.9.8

Remove-GAUserProperty

SYNOPSIS

SYNTAX

ClearOneProperty

Remove-GAUserProperty [-GShellObject <GShellUserObject>] [[-PropertyType] <GAUserPropertyType>]
 [[-Index] <Int32>] [-Force] [[-UserName] <String>] [-Domain <String>] [-WhatIf] [-Confirm]

ClearOneType

Remove-GAUserProperty [-GShellObject <GShellUserObject>] [[-PropertyType] <GAUserPropertyType>] [-ClearType]
 [-Force] [[-UserName] <String>] [-Domain <String>] [-WhatIf] [-Confirm]

ClearAll

Remove-GAUserProperty [-GShellObject <GShellUserObject>] [-ClearAll] [-Force] [[-UserName] <String>]
 [-Domain <String>] [-WhatIf] [-Confirm]

DESCRIPTION

{{Fill in the Description}}

EXAMPLES

Example 1

PS C:\>  {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-GShellObject

The GShellUserObject to act upon. For example, the result of Get-GAUser

Type: GShellUserObject
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PropertyType

Possible values: address, email, externalid, im, organization, phone, relation

Type: GAUserPropertyType
Parameter Sets: ClearOneProperty, ClearOneType
Aliases: Type
Accepted values: address, email, externalid, im, organization, phone, relation

Required: False
Position: 3
Default value: Address
Accept pipeline input: False
Accept wildcard characters: False

-Index

The 0-based index number of the item you want to remove for the given Property Type. (The first item in the list is an index of 0.)

Type: Int32
Parameter Sets: ClearOneProperty
Aliases: 

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ClearType

Clear the entire selected property type for the given user.

Type: SwitchParameter
Parameter Sets: ClearOneType
Aliases: 

Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ClearAll

Clear all property types for the given user.

Type: SwitchParameter
Parameter Sets: ClearAll
Aliases: 

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Force

Force the action to complete without a prompt to continue.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-UserName

Help Text

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

gShell.Cmdlets.Directory.GShellUserObject

System.String

OUTPUTS

NOTES

RELATED LINKS

Clone this wiki locally