Getting Help Information

You can get help information of the adapteradmin utility or a specific command by using the Help command.

On a command line, open the Adapter Administration console and enter the following command to get help information about the adapteradmin utility:

adapteradmin help

The following help information is displayed: 
USAGE
        adapterAdmin [options] command <args>
OPTIONS
        -b,--batch                         Read a series of commands from stdin
        -config <file>                     Use given file for server instance configuration
        -D <property=value>                Use value for given property
        -f <file[,<file>]>                 Read a series of commands from a comma separated list of files
        -l,--login <arg>                   Login id to use for the command session
        -logconfig <file>                  Use given file for logback configuration
        -x,--xtrace                        Echo the command to execute
COMMANDS
        cd
                Set the entity scope of commands, e.g. select a Domain or an AppSpace within a Domain.
        create
                Creates entities, e.g. domain, appspace, adapternode, etc.
        delete
                Deletes entities, e.g. domain, appspace, adapternode, archive.
        deploy
                Deploys an Adapter application into an AppSpace
        exit
                End the current session
        help
                Displays usage information about available commands
        registeragent
                Registers an AdapterAgent to a Domain and/or AppSpace
        registerteaagent
                Registers Adapter TEA Agent with TEA Server
        shell:cat
                Displays the content of a file or URL.
        shell:clear
                Clears the console buffer.
        shell:date
                Display the current time in the given FORMAT
        shell:each
                Execute a closure on a list of arguments.
        shell:echo
                Echoes or prints arguments to STDOUT.
        shell:exec
                Executes system processes.
        shell:grep
                Prints lines matching the given pattern.
        shell:head
                Displays the first lines of a file.
        shell:history
                Prints command history.
        shell:if
                If/Then/Else block.
        shell:more
                File pager.
        shell:printf
                Formats and prints arguments.
        shell:sleep
                Sleeps for a bit then wakes up.
        shell:sort
                Writes sorted concatenation of all files to standard output.
        shell:tac
                Captures the STDIN and returns it as a string. Optionally writes
                 the content to a file.
        shell:tail
                Displays the last lines of a file.
        show
                Display information about entities, e.g. machine, agent, domain, 
                adapternodes, adapterinstances, etc.
        start
                Start entities, e.g appspace, adapternodes, etc.
        stop
                Stop entities, e.g appspace, adapternodes, etc.
        undeploy
                Undeploys an application
        upload
                Uploads an ear file into the domain.

Getting Help Information of a Command

To get help information of a command, enter help followed by the command name. For example, to get help information of the create command, enter the following command in the Adapter Administration console:

help create

The following help information is displayed: 
 DESCRIPTION
        *:create

        Creates entities, e.g. domain, appspace, adapternode, etc.

SYNTAX
        *:create [options] entity name

ARGUMENTS
        entity
                Type of entity [ domain | appspace | adapternode]
        name
                Name of entity [domain | appspace | adapternode ]

OPTIONS
        -v, -version
                Version of AdapterFramework, Applicable when entity is an AppSpace
        --help
                Display this help message
        -minNodes, -minNodes
                Minimum number of AdapterNode to be running, out of N 
                AdapterNodes, before AppSpace is considered Impaired,
                applicable when entity is an AppSpace.
        -agent, -agent
                Agent name, Applicable when entity is an AppSpace or AdapterNode
        -home, -domainHome
                Fully qualified file path to the folder where all the files
                related to this domain are managed, applicable when the 
                entity is a domain.
        -descr, -description
                Description of entity
        -r, -lax
                Return success when entity already exists
                (defaults to false)
        -l, -login
                Login name  of AdapterNodes, Applicable when entity is an
                 AdapterNode
                (defaults to admin)
        -a, -appspace
                AppSpace name, Applicable when entity is an AdapterNode
        -d, -domain
                Domain name