Public/Invoke-JBossClient.ps1
|
function Invoke-JBossClient { <# .SYNOPSIS Call JBoss client .DESCRIPTION Execute a specified command using the JBoss client .PARAMETER Path The path parameter corresponds to the path to the JBoss client. .PARAMETER Controller The controller parameter corresponds to the hostname and port of the JBoss host. .PARAMETER Command The command parameter corresponds to the command to execeute. .PARAMETER Credentials The optional credentials parameter correspond to the credentials of the account to use to connect to JBoss. .PARAMETER Redirect The redirect parameter is a flag to enable the redirection of errors to the standard output stream. .NOTES File name: Invoke-JBossClient.ps1 Author: Florian Carrier Creation date: 21/10/2019 Last modified: 06/12/2019 #> [CmdletBinding ( SupportsShouldProcess = $true )] Param ( [Parameter ( Position = 1, Mandatory = $true, HelpMessage = "Path to the JBoss client" )] [ValidateNotNUllOrEmpty ()] [String] $Path, [Parameter ( Position = 2, Mandatory = $true, HelpMessage = "Controller" )] # TODO validate format [ValidateNotNUllOrEmpty ()] [String] $Controller, [Parameter ( Position = 3, Mandatory = $true, HelpMessage = "Command to execute" )] [ValidateNotNUllOrEmpty ()] [String] $Command, [Parameter ( Position = 4, Mandatory = $false, HelpMessage = "User credentials" )] [ValidateNotNUllOrEmpty ()] [System.Management.Automation.PSCredential] $Credentials, [Parameter ( HelpMessage = "Force switch" )] [Switch] $Force, [Parameter ( HelpMessage = "Switch to redirect error stream" )] [Switch] $Redirect ) Begin { # Get global preference variables Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState } Process { # Check credentials if ($PSBoundParameters.ContainsKey("Credentials")) { # Construct JBoss client command with credential $JBossCliCmd = Write-JBossClientCmd -Path $Path -Controller $Controller -Command $Command -Credentials $Credentials -Redirect:$Redirect -Force:$Force } else { # Construct JBoss client command for local use $JBossCliCmd = Write-JBossClientCmd -Path $Path -Controller $Controller -Command $Command -Redirect:$Redirect -Force:$Force } # Execute command $JBossCliLog = Invoke-Expression -Command $JBossCliCmd | Out-String Write-Log -Type "DEBUG" -Object $JBossCliLog # Return log return $JBossCliLog } } |