Remove-ConfigZoneScope
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Remove the specified zone(s) from the given scope(s).
Syntax
Remove-ConfigZoneScope
[-Scope] <String[]>
-ZoneUid <Guid[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ConfigZoneScope
[-Scope] <String[]>
-InputObject <Zone[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Remove-ConfigZoneScope
[-Scope] <String[]>
-ZoneName <String[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Remove-ConfigZoneScope cmdlet is used to remove one or more zone objects from the given scope(s).
To remove a zone from a scope you need permission to change the scopes of the zone.
If the zone is not in a specified scope, that scope will be silently ignored.
The zones may be specified using the unique identifier, name, or as a powershell object.
Examples
EXAMPLE 1
Removes a single zone from the 'Finance' scope.
Remove-ConfigZoneScope Finance -ZoneUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
EXAMPLE 2
Removes a single zone from multiple scopes.
Remove-ConfigZoneScope Finance,Marketing -ZoneUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
EXAMPLE 3
Removes all visible zone objects from the 'Finance' scope.
Get-ConfigZone | Remove-ConfigZoneScope Finance
EXAMPLE 4
Removes zone objects with a name starting with an 'A' from the 'Finance' scope.
Remove-ConfigZoneScope Finance -ZoneName A*
Parameters
-InputObject
The zone objects to be removed.
| Type: | Zone[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-ZoneUid
The unique identifier for the zones to be removed.
| Type: | Guid[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-ZoneName
The name of the zones to be removed.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | True |
-Scope
Specifies the scopes to remove the objects from.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
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.
Notes
If the command fails, the following errors can be returned.
Error Codes
UnknownObject
One of the specified objects was not found.
ScopeNotFound
One of the specified scopes was not found.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied
You do not have permission to execute this command with the specified objects or scopes.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs
on the controller or the Citrix Virtual Apps and Desktops logs.