Invoke-XenMessage

Last published : Nov 12, 2026
Invokes an operation on a Message object.
Related information
Message cmdlets

Syntax

Invoke-XenMessage [-Message] <Message> -XenAction {DestroyMany | DestroyAll} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenMessage [-Ref] <XenRef[Message]> -XenAction {DestroyMany | DestroyAll}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenMessage [-Uuid] <guid> -XenAction {DestroyMany | DestroyAll} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on a Message object. Use the -XenAction parameter to select which operation to perform.
DestroyMany
DestroyAll

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
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

-Confirm

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

-Filters

Optional filters identifying messages to destroy: before (RFC3339 DateTime, destroy messages dated before this timestamp), after (RFC3339 DateTime, destroy messages dated after this timestamp), and priority (int, only destroy messages with this priority). All provided conditions must be met (logical AND). If no filters are provided, all messages are destroyed. If no timezone is specified in a timestamp, UTC is assumed. Accepted when -XenAction is DestroyAll.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-Message

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

-Messages

Messages to destroy. Accepted when -XenAction is DestroyMany.
Attribute Value
Type List[XenRef[Message]]
Required False
Position Named
Accepts pipeline input False

-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 Message object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Message]
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 Message 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

-XenAction

Selects which action to use.
Attribute Value
Type XenMessageAction
Required True
Position Named
Accepts pipeline input False
Accepted values DestroyMany, DestroyAll

Inputs

  • Message
  • XenRef[Message]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the DestroyMany operation

PS> Get-XenMessage -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenMessage -XenAction DestroyMany
Invokes the DestroyMany operation on a Message.

Example 2: Run the DestroyMany operation by uuid

PS> Invoke-XenMessage -XenAction DestroyMany -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the DestroyMany operation on a Message. -Uuid is the way to be sure of exactly one object.

Example 3: Run DestroyMany asynchronously

PS> Invoke-XenMessage -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction DestroyMany -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.