Remove-XenCallerProperty

Last published : Nov 12, 2026
Removes values from fields of a Caller object.
Related information
Caller cmdlets

Syntax

Remove-XenCallerProperty [-Caller] <Caller> [-PassThru] [-Group <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenCallerProperty [-Ref] <XenRef[Caller]> [-PassThru] [-Group <string>]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenCallerProperty [-Uuid] <guid> [-PassThru] [-Group <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-XenCallerProperty [-Name] <string> [-PassThru] [-Group <string>] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Removes values from the collection-valued fields of a Caller. Each optional parameter listed below corresponds to a field that can be removed from.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress. Available only for those fields whose underlying operation supports asynchronous invocation.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Caller

The Caller object to operate on.
Attribute Value
Type Caller
Required True
Position 0
Accepts pipeline input True (ByValue)

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-Group

Remove a caller from a group
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Name

The name of the Caller to operate on.
Attribute Value
Type string
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases name_label

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The Caller object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Caller]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the Caller to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

Inputs

  • Caller
  • XenRef[Caller]
  • guid
  • string

Outputs

  • Caller
  • Task

Examples

Example 1: Remove a group

PS> Remove-XenCallerProperty -Group "value" -Name "Demo Caller"
Remove a caller from a group

Example 2: Remove a group piped from the getter

PS> Get-XenCaller -Name "Demo Caller" | Remove-XenCallerProperty -Group "value"
Remove a caller from a group The object is piped in, which is the usual way once you already have it.

Example 3: Remove a group by uuid

PS> Remove-XenCallerProperty -Group "value" -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Remove a caller from a group -Uuid is the way to be sure of exactly one object.