Remove-XenConsole
Deletes a Console object.
Syntax
Remove-XenConsole [-Console] <Console> [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenConsole [-Ref] <XenRef[Console]> [-PassThru] [-BestEffort]
[-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Remove-XenConsole [-Uuid] <guid> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
[-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Description
Deletes the specified Console object.
Console: A console.
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 |
-Console
The Console object to operate on.
| Attribute | Value |
|---|---|
| Type | Console |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-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 Console object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Console] |
| 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 Console 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
-
Console -
XenRef[Console] -
guid
Outputs
-
Task -
void
Examples
Example 1: Delete a Console piped from the getter
PS> Get-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Remove-XenConsole
Deletes a Console. The object is piped in, which is the usual way once you already have it.
Example 2: Delete a Console by uuid
PS> Remove-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Deletes a Console. -Uuid is the way to be sure of exactly one object.
Example 3: See what would be deleted
PS> Get-XenConsole -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Remove-XenConsole -WhatIf
Reports the Console that would be deleted without deleting anything. Every cmdlet that changes the server takes -WhatIf and -Confirm.
Related links
-
Class: Console
-
Using the XenServer PowerShell module