Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-5018

Add more details about using JBoss CLI in non-interactive mode (CLI guide)

XMLWordPrintable

      We should add a new topic to the CLI guide covering the usage of JBoss CLI in non-interactive mode.

      References:
      - https://developer.jboss.org/wiki/CLINon-interactiveMode - note that old name for jboss-cli script (jboss-admin) is used in document

      https://access.stage.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/version-7.0/configuration-guide/

      -----------

      There are few ways how to interact with JBoss CLI.
      - Interactive
      - Non-interactive
      - Programmatic (out-of-scope for this Jira, will come into play soon )

      1) Interactive mode
      1a) command line

      • [standalone@host:port /], [domain@host:port /], [standalone@embedded /], [domain@embedded /] ... this one is classic

      1b) gui

      • run the jboss-cli script with --gui option (JBEAP-4834 - CLI gui should be used primarily for building commands (CLI guide))
      • use JBoss EAP CLI tab in jconsole (JBEAP-3319 - appclient, jdr and jconsole scripts are not described in documentation)

      Nothing extra is needed for this one since the most of examples in docs use interactive mode.

      2) Non-interactive
      2a) command

      • --command=command_or_operation

      2b) commands

      • --commands=command_or_operation1,command_or_operation2...=command_or_operation1,command_or_operation2...

      2c) file

      • --file=file_path

      Non-interactive mode is quite powerful tool which should be given some spotlight in docs as well.

      Note that:
      - https://issues.jboss.org/browse/JBEAP-2529 - [GSS] CLI Does Not Log History With "--file" and "--command(s)" Args

      I'll add more details in form of comments not to overload description part that much.

              Unassigned Unassigned
              pkremens@redhat.com Petr Kremensky (Inactive)
              Marek Kopecky Marek Kopecky
              Marek Kopecky Marek Kopecky
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: