Public/Write-Attribute.ps1
|
function Write-Attribute { <# .SYNOPSIS Write attribute .DESCRIPTION Add an attibute to a specified resource on a JBoss instance .PARAMETER Path The path parameter corresponds to the path to the JBoss batch client. .PARAMETER Controller The controller parameter corresponds to the host to connect to. .PARAMETER Credentials The optional credentials parameter correspond to the credentials of the account to use to connect to JBoss. .PARAMETER Resource The resource parameter corresponds to the path to the resource. .PARAMETER Attribute The attribute parameter corresponds to the name of the attribute. .PARAMETER Value The value parameter corresponds to the value of the attribute to write. .INPUTS System.String. You can pipe the resource name, attribute name, and attribute value to Write-Attribute. .OUTPUTS System.String. Write-Attribute returns the raw output from the JBoss client. .NOTES File name: Write-Attribute.ps1 Author: Florian Carrier Creation date: 21/01/2020 Last modified: 21/01/2020 .LINK Invoke-JBossClient .LINK Read-Attribute .LINK Remove-Attribute #> [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 = $false, HelpMessage = "User credentials" )] [ValidateNotNUllOrEmpty ()] [System.Management.Automation.PSCredential] $Credentials, [Parameter ( Position = 4, Mandatory = $false, HelpMessage = "Path to the resource", ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [ValidateNotNull ()] [String] $Resource = '', [Parameter ( Position = 5, Mandatory = $true, HelpMessage = "Name of the attribute", ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [ValidateNotNUllOrEmpty ()] [Alias ("Name")] [String] $Attribute, [Parameter ( Position = 6, Mandatory = $true, HelpMessage = "Value of the attribute", ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [ValidateNotNUllOrEmpty ()] [String] $Value ) Begin { # Get global preference variables Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState } Process { # Define command $Command = "$($Resource):write-attribute(name=$Attribute,value=$Value)" # Execute command if ($PSBoundParameters.ContainsKey('Credentials')) { Invoke-JBossClient -Path $Path -Controller $Controller -Command $Command -Credentials $Credentials } else { Invoke-JBossClient -Path $Path -Controller $Controller -Command $Command } } } |