Citrix Virtual Apps and Desktops SDK

Remove-UserProfileShare

Removes a nominated network share.

Syntax

Remove-UserProfileShare
      [-Path] <String>
      [<CommonParameters>]
<!--NeedCopy-->

Description

This command might be used as part of a final tear-down procedure for a profile store that is no longer needed.

This command will not delete any folders or data from the server computer, nor will it alter any access permissions on the folder. It will only restore the shared folder into an unshared state.

Examples

EXAMPLE 1

This command will unpublish the network share called “Profiles$” on the computer called “ProfileServer”. The contents of the folder itself will not be affected. Any required deletion of profile store contents must be performed manually by an appropriate administrator of the folder.

C:PS> Remove-UserProfileShare -Path \\ProfileServer\Profiles$
<!--NeedCopy-->

Parameters

-Path

This string specifies the full UNC name of the network share to be removed. Since it is a UNC name, it will naturally specify both the name of the server computer and the name of the share to be removed. Consequently, no additional inputs are required.

Type: String
Position: 1
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Remove-UserProfileShare