rhq-agent:exec-cli-script

Full name:

org.rhq.maven.plugins:rhq-agent-plugin-plugin:1.0:exec-cli-script

Description:

Execute a CLI script.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
rhqCliDirectory File - The CLI directory (where to install the RHQ CLI).
Default value is: ${project.build.directory}/rhq-cli.
rhqVersion String - Version of the RHQ CLI.
scriptFile File - The script file to execute.

Optional Parameters

Name Type Since Description
args List - List of CLI arguments.
argsStyle String - Indicates the style or format of arguments passed to the script.
Default value is: indexed.
failOnError boolean - Whether to fail the build if an error occurs while uploading.
Default value is: true.
host String - Remote RHQ server host. Required if login is set to true.
login boolean - Whether to login to a remote RHQ server.
Default value is: false.
password String - Authentication password. Required if login is set to true.
port int - Remote RHQ server port.
Default value is: 7080.
skipExecCliScript boolean - Whether to skip the execution of this mojo.
Default value is: false.
username String - Authentication user name. Required if login is set to true.

Parameter Details

args:

List of CLI arguments.
  • Type: java.util.List
  • Required: No

argsStyle:

Indicates the style or format of arguments passed to the script.
  • Type: java.lang.String
  • Required: No
  • Default: indexed

failOnError:

Whether to fail the build if an error occurs while uploading.
  • Type: boolean
  • Required: No
  • Default: true

host:

Remote RHQ server host. Required if login is set to true.
  • Type: java.lang.String
  • Required: No

login:

Whether to login to a remote RHQ server.
  • Type: boolean
  • Required: No
  • Default: false

password:

Authentication password. Required if login is set to true.
  • Type: java.lang.String
  • Required: No

port:

Remote RHQ server port.
  • Type: int
  • Required: No
  • Default: 7080

rhqCliDirectory:

The CLI directory (where to install the RHQ CLI).
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/rhq-cli

rhqVersion:

Version of the RHQ CLI.
  • Type: java.lang.String
  • Required: Yes

scriptFile:

The script file to execute.
  • Type: java.io.File
  • Required: Yes

skipExecCliScript:

Whether to skip the execution of this mojo.
  • Type: boolean
  • Required: No
  • Default: false

username:

Authentication user name. Required if login is set to true.
  • Type: java.lang.String
  • Required: No