Invoke-XenHostCrashdump

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

Syntax

Invoke-XenHostCrashdump [-HostCrashdump] <Host_crashdump> -XenAction {Upload} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenHostCrashdump [-Ref] <XenRef[Host_crashdump]> -XenAction {Upload} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenHostCrashdump [-Uuid] <guid> -XenAction {Upload} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Invokes an operation on a HostCrashdump object. Use the -XenAction parameter to select which operation to perform.
Upload: Upload the specified host crash dump to a specified URL.

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

-HostCrashdump

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

-Options

Extra configuration operations. Accepted when -XenAction is Upload.
Attribute Value
Type hashtable
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 HostCrashdump object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Host_crashdump]
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

-Url

The URL to upload to. Accepted when -XenAction is Upload.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-Uuid

The UUID of the HostCrashdump 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 XenHostCrashdumpAction
Required True
Position Named
Accepts pipeline input False
Accepted values Upload

Inputs

  • Host_crashdump
  • XenRef[Host_crashdump]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the Upload operation

PS> Get-XenHostCrashdump -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenHostCrashdump -XenAction Upload
Invokes the Upload operation on a HostCrashdump.

Example 2: Run the Upload operation by uuid

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

Example 3: Run Upload asynchronously

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