LibTmux.Get-TmuxServer
LibTmux\Get-TmuxServer Inspect an existing tmux daemon's identity and version.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxServerCommand.cs
- Get-TmuxServer [-Server] <Lib
Tmux > [<Common.Server Parameters >] -
Description#
Read the selected endpoint and return a native
Serverwith its daemon generation and DaemonVersion. An absent daemon produces no output. Inspection never starts a daemon and leaves the input handle unchanged.Sessions, windows and panes remain uncaptured. Pipe the inspected server to
Get-TmuxSnapshotto acquire those relationships and retain the inspected version forGet-TmuxQueryPlan.Notes
Tmux.ServerInspectionFailedretains the native exception and target. Inspection of an absent endpoint is successful and emits no object; other failures use the error stream. UseErrorActionStop to stop the pipeline on those failures.Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
-
LibTmux.Server: Native endpoint handle. - Outputs
-
LibTmux.Server
Examples#
Example 1 Inspect the existing daemon identified by
$SocketPath. View sourceTerminal window LibTmux\New-TmuxServer -SocketPath $SocketPath | LibTmux\Get-TmuxServer- Parameters
-
-
The server endpoint to inspect.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
Common parameters 12
PowerShell supplies these parameters. See common parameter behavior for their effects.
-
-Verbose(System.Management ) #.Automation .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
LibTmux.Server: Inspected daemon, when present.