WildFly CLI Commands for Batch Applications

[chengfang]

WildFly provides CLI (jboss-cli.bat and jboss-cli.sh located under wildfly.install/bin/) to manage server configuration and application. Here are some frequently used CLI commands for batch applications deployed to WildFly.

in a new terminal window, start CLI and connect to a running WildFly server:

jboss-cli.sh --connect

NOTE: The following CLI commands all run inside the CLI sub-shell.

list all applications deployed to WildFly:

ls deployment

deploy batch application:

deploy ~/dev/customer/hello-batch-numbers/target/hello-batch-numbers.war

undeploy a batch application:

undeploy hello-batch-numbers.war

view application resources including batch jobs in application hello-batch-numbers:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet:read-resource

{
    "outcome" => "success",
    "result" => {"job" => {
        "batchlet1" => undefined,
        "numbers" => undefined
    }}
}

view batch processing runtime resources in application hello-batch-numbers:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet:read-resource(include-runtime, recursive)

{
    "outcome" => "success",
    "result" => {
        "job-xml-names" => [
            "batchlet1.xml",
            "numbers.xml"
        ],
        "job" => {
            "batchlet1" => {
                "instance-count" => 0,
                "job-xml-names" => ["batchlet1.xml"],
                "running-executions" => 0,
                "execution" => undefined
            },
            "numbers" => {
                "instance-count" => 0,
                "job-xml-names" => ["numbers.xml"],
                "running-executions" => 0,
                "execution" => undefined
            }
        }
    }
}

start job batchlet1 in application hello-batch-numbers:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet:start-job(job-xml-name=batchlet1)

{
    "outcome" => "success",
    "result" => 1L
}

the above command results in a job execution with id 1; to view its status and metrics:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet/job=batchlet1/execution=1:read-resource(include-runtime, recursive)

{
    "outcome" => "success",
    "result" => {
        "batch-status" => "COMPLETED",
        "create-time" => "2022-03-30T16:42:18.786",
        "end-time" => "2022-03-30T16:42:59.841",
        "exit-status" => "COMPLETED",
        "instance-id" => 1L,
        "last-updated-time" => "2022-03-30T16:42:59.841",
        "start-time" => "2022-03-30T16:42:18.801"
    }
}

start job batchlet1 in application hello-batch-numbers with custom job parameters:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet:start-job(job-xml-name=batchlet1, properties={email=123@example.com, name=foo})

stop a running job execution:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet/job=batchlet1/execution=4:stop-job()

{"outcome" => "success"}

restart a previously stopped or failed job execution id 4, which results a new job execution with id 5:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet/job=batchlet1/execution=4:restart-job()

{
    "outcome" => "success",
    "result" => 5L
}

to view all job execution data for job batchlet1:

/deployment=hello-batch-numbers.war/subsystem=batch-jberet/job=batchlet1:read-resource(recursive, include-runtime)

{
    "outcome" => "success",
    "result" => {
        "instance-count" => 3,
        "job-xml-names" => ["batchlet1.xml"],
        "running-executions" => 0,
        "execution" => {
            "1" => {
                "batch-status" => "COMPLETED",
                "create-time" => "2022-03-30T16:42:18.786",
                "end-time" => "2022-03-30T16:42:59.841",
                "exit-status" => "COMPLETED",
                "instance-id" => 1L,
                "last-updated-time" => "2022-03-30T16:42:59.841",
                "start-time" => "2022-03-30T16:42:18.801"
            },
            "2" => {
                "batch-status" => "COMPLETED",
                "create-time" => "2022-03-30T16:49:45.385",
                "end-time" => "2022-03-30T16:50:26.396",
                "exit-status" => "COMPLETED",
                "instance-id" => 2L,
                "last-updated-time" => "2022-03-30T16:50:26.396",
                "start-time" => "2022-03-30T16:49:45.386"
            },
            "3" => {
                "batch-status" => "COMPLETED",
                "create-time" => "2022-03-30T16:55:27.529",
                "end-time" => "2022-03-30T16:56:08.542",
                "exit-status" => "COMPLETED",
                "instance-id" => 3L,
                "last-updated-time" => "2022-03-30T16:56:08.542",
                "start-time" => "2022-03-30T16:55:27.531"
            }
        }
    }
}