NAME
        artemis address - Address tools group (create|delete|update|show)
        (example ./artemis address create)

SYNOPSIS
        artemis address
        artemis address create [--password <password>] [--user <user>]
                [--url <brokerURL>] [--verbose] [--name <name>] [--multicast] [--silent]
                [--no-multicast] [--clientID <clientID>] [--protocol <protocol>]
                [--anycast] [--no-anycast]
        artemis address delete [--password <password>] [--user <user>]
                [--url <brokerURL>] [--verbose] [--name <name>] [--multicast] [--silent]
                [--no-multicast] [--clientID <clientID>] [--protocol <protocol>]
                [--anycast] [--no-anycast]
        artemis address show [--user <user>] [--name <name>] [--multicast]
                [--silent] [--no-multicast] [--clientID <clientID>]
                [--protocol <protocol>] [--anycast] [--no-anycast]
                [--password <password>] [--url <brokerURL>] [--verbose] [--bindings]
        artemis address update [--password <password>] [--user <user>]
                [--url <brokerURL>] [--verbose] [--name <name>] [--multicast] [--silent]
                [--no-multicast] [--clientID <clientID>] [--protocol <protocol>]
                [--anycast] [--no-anycast]

COMMANDS
        With no arguments, Display help information

        create
            create an address

            With --password option, Password used to connect

            With --user option, User used to connect

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --name option, The name of this address

            With --multicast option, It will determine this address as multicast

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --no-multicast option, It will determine this address as
            multicast

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --anycast option, It will determine this address as anycast

            With --no-anycast option, It will determine this address as anycast

        delete
            delete an address

            With --password option, Password used to connect

            With --user option, User used to connect

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --name option, The name of this address

            With --multicast option, It will determine this address as multicast

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --no-multicast option, It will determine this address as
            multicast

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --anycast option, It will determine this address as anycast

            With --no-anycast option, It will determine this address as anycast

        update
            update an address

            With --password option, Password used to connect

            With --user option, User used to connect

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --name option, The name of this address

            With --multicast option, It will determine this address as multicast

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --no-multicast option, It will determine this address as
            multicast

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --anycast option, It will determine this address as anycast

            With --no-anycast option, It will determine this address as anycast

        show
            Get the selected address

            With --user option, User used to connect

            With --name option, The name of this address

            With --multicast option, It will determine this address as multicast

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --no-multicast option, It will determine this address as
            multicast

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --anycast option, It will determine this address as anycast

            With --no-anycast option, It will determine this address as anycast

            With --password option, Password used to connect

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --bindings option, Shows the bindings for this address


NAME
        artemis browser - It will browse messages on an instance

SYNOPSIS
        artemis browser [--clientID <clientID>] [--destination <destination>]
                [--filter <filter>] [--message-count <messageCount>]
                [--password <password>] [--protocol <protocol>]
                [--serializer <serializer>] [--silent] [--sleep <sleep>]
                [--threads <threads>] [--txt-size <txBatchSize>] [--url <brokerURL>]
                [--user <user>] [--verbose]

OPTIONS
        --clientID <clientID>
            ClientID to be associated with connection

        --destination <destination>
            Destination to be used. It can be prefixed with queue:// or topic://
            or fqqn:// (Default: queue://TEST)

        --filter <filter>
            filter to be used with the consumer

        --message-count <messageCount>
            Number of messages to act on (Default: 1000)

        --password <password>
            Password used to connect

        --protocol <protocol>
            Protocol used. Valid values are amqp or core. Default=core.

        --serializer <serializer>
            Override the default serializer with a custom implementation

        --silent
            It will disable all the inputs, and it would make a best guess for
            any required input

        --sleep <sleep>
            Time wait between each message

        --threads <threads>
            Number of Threads to be used (Default: 1)

        --txt-size <txBatchSize>
            TX Batch Size

        --url <brokerURL>
            URL towards the broker. (default: tcp://localhost:61616)

        --user <user>
            User used to connect

        --verbose
            Adds more information on the execution


NAME
        artemis consumer - It will consume messages from an instance

SYNOPSIS
        artemis consumer [--break-on-null] [--clientID <clientID>]
                [--data <file>] [--destination <destination>] [--durable]
                [--filter <filter>] [--message-count <messageCount>]
                [--password <password>] [--protocol <protocol>]
                [--receive-timeout <receiveTimeout>] [--serializer <serializer>]
                [--silent] [--sleep <sleep>] [--threads <threads>]
                [--txt-size <txBatchSize>] [--url <brokerURL>] [--user <user>]
                [--verbose]

OPTIONS
        --break-on-null
            It will break on null messages

        --clientID <clientID>
            ClientID to be associated with connection

        --data <file>
            serialize the messages to the specified file as they are consumed

        --destination <destination>
            Destination to be used. It can be prefixed with queue:// or topic://
            or fqqn:// (Default: queue://TEST)

        --durable
            It will use durable subscription in case of client

        --filter <filter>
            filter to be used with the consumer

        --message-count <messageCount>
            Number of messages to act on (Default: 1000)

        --password <password>
            Password used to connect

        --protocol <protocol>
            Protocol used. Valid values are amqp or core. Default=core.

        --receive-timeout <receiveTimeout>
            Time used on receive(timeout)

        --serializer <serializer>
            Override the default serializer with a custom implementation

        --silent
            It will disable all the inputs, and it would make a best guess for
            any required input

        --sleep <sleep>
            Time wait between each message

        --threads <threads>
            Number of Threads to be used (Default: 1)

        --txt-size <txBatchSize>
            TX Batch Size

        --url <brokerURL>
            URL towards the broker. (default: tcp://localhost:61616)

        --user <user>
            User used to connect

        --verbose
            Adds more information on the execution



NAME
        artemis create - creates a new broker instance

SYNOPSIS
        artemis create [--addresses <addresses>] [--aio] [--allow-anonymous]
                [--autocreate] [--blocking] [--cluster-password <clusterPassword>]
                [--cluster-user <clusterUser>] [--clustered] [--data <data>]
                [--default-port <defaultPort>] [--disable-persistence]
                [--encoding <encoding>] [--etc <etc>] [--failover-on-shutdown] [--force]
                [--global-max-size <globalMaxSize>] [--home <home>] [--host <host>]
                [--http-host <httpHost>] [--http-port <httpPort>]
                [--java-options <javaOptions>] [--jdbc]
                [--jdbc-bindings-table-name <jdbcBindings>]
                [--jdbc-connection-url <jdbcURL>]
                [--jdbc-driver-class-name <jdbcClassName>]
                [--jdbc-large-message-table-name <jdbcLargeMessages>]
                [--jdbc-lock-expiration <jdbcLockExpiration>]
                [--jdbc-lock-renew-period <jdbcLockRenewPeriod>]
                [--jdbc-message-table-name <jdbcMessages>]
                [--jdbc-network-timeout <jdbcNetworkTimeout>]
                [--jdbc-node-manager-table-name <jdbcNodeManager>]
                [--jdbc-page-store-table-name <jdbcPageStore>] [--mapped]
                [--max-hops <maxHops>] [--message-load-balancing <messageLoadBalancing>]
                [--name <name>] [--nio] [--no-amqp-acceptor] [--no-autocreate]
                [--no-autotune] [--no-fsync] [--no-hornetq-acceptor]
                [--no-mqtt-acceptor] [--no-stomp-acceptor] [--no-web] [--paging]
                [--password <password>] [--ping <ping>] [--port-offset <portOffset>]
                [--queues <queues>] [--replicated] [--require-login] [--role <role>]
                [--shared-store] [--silent] [--slave] [--ssl-key <sslKey>]
                [--ssl-key-password <sslKeyPassword>] [--ssl-trust <sslTrust>]
                [--ssl-trust-password <sslTrustPassword>] [--use-client-auth]
                [--user <user>] [--verbose] [--] <directory>

OPTIONS
        --addresses <addresses>
            Comma separated list of addresses

        --aio
            Sets the journal as asyncio.

        --allow-anonymous
            Enables anonymous configuration on security, opposite of
            --require-login (Default: input)

        --autocreate
            Auto create addresses. (default: true)

        --blocking
            Block producers when address becomes full, opposite of --paging
            (Default: false)

        --cluster-password <clusterPassword>
            The cluster password to use for clustering. (Default: input)

        --cluster-user <clusterUser>
            The cluster user to use for clustering. (Default: input)

        --clustered
            Enable clustering

        --data <data>
            Directory where ActiveMQ data are stored. Paths can be absolute or
            relative to artemis.instance directory ('data' by default)

        --default-port <defaultPort>
            The port number to use for the main 'artemis' acceptor (Default:
            61616)

        --disable-persistence
            Disable message persistence to the journal

        --encoding <encoding>
            The encoding that text files should use

        --etc <etc>
            Directory where ActiveMQ configuration is located. Paths can be
            absolute or relative to artemis.instance directory ('etc' by
            default)

        --failover-on-shutdown
            Valid for shared store: will shutdown trigger a failover? (Default:
            false)

        --force
            Overwrite configuration at destination directory

        --global-max-size <globalMaxSize>
            Maximum amount of memory which message data may consume (Default:
            Undefined, half of the system's memory)

        --home <home>
            Directory where ActiveMQ Artemis is installed

        --host <host>
            The host name of the broker (Default: 0.0.0.0 or input if clustered)

        --http-host <httpHost>
            The host name to use for embedded web server (Default: localhost)

        --http-port <httpPort>
            The port number to use for embedded web server (Default: 8161)

        --java-options <javaOptions>
            Extra java options to be passed to the profile

        --jdbc
            It will activate jdbc

        --jdbc-bindings-table-name <jdbcBindings>
            Name of the jdbc bindigns table

        --jdbc-connection-url <jdbcURL>
            The connection used for the database

        --jdbc-driver-class-name <jdbcClassName>
            JDBC driver classname

        --jdbc-large-message-table-name <jdbcLargeMessages>
            Name of the large messages table

        --jdbc-lock-expiration <jdbcLockExpiration>
            Lock expiration

        --jdbc-lock-renew-period <jdbcLockRenewPeriod>
            Lock Renew Period

        --jdbc-message-table-name <jdbcMessages>
            Name of the jdbc messages table

        --jdbc-network-timeout <jdbcNetworkTimeout>
            Network timeout

        --jdbc-node-manager-table-name <jdbcNodeManager>
            Name of the jdbc node manager table

        --jdbc-page-store-table-name <jdbcPageStore>
            Name of the page store messages table

        --mapped
            Sets the journal as mapped.

        --max-hops <maxHops>
            Number of hops on the cluster configuration

        --message-load-balancing <messageLoadBalancing>
            Load balancing policy on cluster. [ON_DEMAND (default) | STRICT |
            OFF]

        --name <name>
            The name of the broker (Default: same as host)

        --nio
            Sets the journal as nio.

        --no-amqp-acceptor
            Disable the AMQP specific acceptor.

        --no-autocreate
            Disable Auto create addresses.

        --no-autotune
            Disable auto tuning on the journal.

        --no-fsync
            Disable usage of fdatasync (channel.force(false) from java nio) on
            the journal

        --no-hornetq-acceptor
            Disable the HornetQ specific acceptor.

        --no-mqtt-acceptor
            Disable the MQTT specific acceptor.

        --no-stomp-acceptor
            Disable the STOMP specific acceptor.

        --no-web
            Remove the web-server definition from bootstrap.xml

        --paging
            Page messages to disk when address becomes full, opposite of
            --blocking (Default: true)

        --password <password>
            The user's password (Default: input)

        --ping <ping>
            A comma separated string to be passed on to the broker config as
            network-check-list. The broker will shutdown when all these
            addresses are unreachable.

        --port-offset <portOffset>
            Off sets the ports of every acceptor

        --queues <queues>
            Comma separated list of queues.

        --replicated
            Enable broker replication

        --require-login
            This will configure security to require user / password, opposite of
            --allow-anonymous

        --role <role>
            The name for the role created (Default: amq)

        --shared-store
            Enable broker shared store

        --silent
            It will disable all the inputs, and it would make a best guess for
            any required input

        --slave
            Valid for shared store or replication: this is a slave server?

        --ssl-key <sslKey>
            The key store path for embedded web server

        --ssl-key-password <sslKeyPassword>
            The key store password

        --ssl-trust <sslTrust>
            The trust store path in case of client authentication

        --ssl-trust-password <sslTrustPassword>
            The trust store password

        --use-client-auth
            If the embedded server requires client authentication

        --user <user>
            The username (Default: input)

        --verbose
            Adds more information on the execution

        --
            This option can be used to separate command-line options from the
            list of argument, (useful when arguments might be mistaken for
            command-line options

        <directory>
            The instance directory to hold the broker's configuration and data.
            Path must be writable.


NAME
        artemis data - data tools group (print) (example ./artemis data print)

SYNOPSIS
        artemis data
        artemis data print [--jdbc-node-manager-table-name <jdbcNodeManager>]
                [--bindings <binding>] [--jdbc-message-table-name <jdbcMessages>]
                [--jdbc-page-store-table-name <jdbcPageStore>]
                [--jdbc-driver-class-name <jdbcClassName>] [--broker <brokerConfig>]
                [--f] [--large-messages <largeMessges>]
                [--jdbc-bindings-table-name <jdbcBindings>]
                [--jdbc-large-message-table-name <jdbcLargeMessages>]
                [--paging <paging>] [--verbose] [--jdbc] [--safe] [--output <output>]
                [--jdbc-connection-url <jdbcURL>] [--journal <journal>]

COMMANDS
        With no arguments, Display help information

        print
            Print data records information (WARNING: don't use while a
            production server is running)

            With --jdbc-node-manager-table-name option, Name of the jdbc node
            manager table

            With --bindings option, The folder used for bindings (default from
            broker.xml)

            With --jdbc-message-table-name option, Name of the jdbc messages
            table

            With --jdbc-page-store-table-name option, Name of the page store
            messages table

            With --jdbc-driver-class-name option, JDBC driver classname

            With --broker option, This would override the broker configuration
            from the bootstrap

            With --f option, This will allow certain tools like print-data to be
            performed ignoring any running servers. WARNING: Changing data
            concurrently with a running broker may damage your data. Be careful
            with this option.

            With --large-messages option, The folder used for large-messages
            (default from broker.xml)

            With --jdbc-bindings-table-name option, Name of the jdbc bindigns
            table

            With --jdbc-large-message-table-name option, Name of the large
            messages table

            With --paging option, The folder used for paging (default from
            broker.xml)

            With --verbose option, Adds more information on the execution

            With --jdbc option, It will activate jdbc

            With --safe option, It will print your data structure without
            showing your data

            With --output option, Output name for the file

            With --jdbc-connection-url option, The connection used for the
            database

            With --journal option, The folder used for messages journal (default
            from broker.xml)


NAME
        artemis mask - mask a password and print it out

SYNOPSIS
        artemis mask [--hash] [--key <key>] [--] <password>

OPTIONS
        --hash
            whether to use hash (one-way), default false

        --key <key>
            the key (Blowfish) to mask a password

        --
            This option can be used to separate command-line options from the
            list of argument, (useful when arguments might be mistaken for
            command-line options

        <password>
            The password to be masked


NAME
        artemis migrate1x - Migrates the configuration of a 1.x Artemis Broker

SYNOPSIS
        artemis migrate1x [--verbose] [--] <directory>

OPTIONS
        --verbose
            Adds more information on the execution

        --
            This option can be used to separate command-line options from the
            list of argument, (useful when arguments might be mistaken for
            command-line options

        <directory>
            The instance directory to hold the broker's configuration and data.
            Path must be writable.


NAME
        artemis producer - It will send messages to an instance

SYNOPSIS
        artemis producer [--clientID <clientID>] [--data <fileName>]
                [--destination <destination>] [--group <msgGroupID>]
                [--message <message>] [--message-count <messageCount>]
                [--message-size <messageSize>] [--msgttl <msgTTL>] [--non-persistent]
                [--object-size <objectSize>] [--password <password>]
                [--protocol <protocol>] [--serializer <serializer>] [--silent]
                [--sleep <sleep>] [--text-size <textMessageSize>] [--threads <threads>]
                [--txt-size <txBatchSize>] [--url <brokerURL>] [--user <user>]
                [--verbose]

OPTIONS
        --clientID <clientID>
            ClientID to be associated with connection

        --data <fileName>
            Messages will be read form the specified file, other message options
            will be ignored.

        --destination <destination>
            Destination to be used. It can be prefixed with queue:// or topic://
            or fqqn:// (Default: queue://TEST)

        --group <msgGroupID>
            Message Group to be used

        --message <message>
            Content of each textMessage (The producer will use text message on
            this case)

        --message-count <messageCount>
            Number of messages to act on (Default: 1000)

        --message-size <messageSize>
            Size of each byteMessage (The producer will use byte message on this
            case)

        --msgttl <msgTTL>
            TTL for each message

        --non-persistent
            It will send messages non persistently

        --object-size <objectSize>
            Size of each ObjectMessage (The producer will use object message on
            this case)

        --password <password>
            Password used to connect

        --protocol <protocol>
            Protocol used. Valid values are amqp or core. Default=core.

        --serializer <serializer>
            Override the default serializer with a custom implementation

        --silent
            It will disable all the inputs, and it would make a best guess for
            any required input

        --sleep <sleep>
            Time wait between each message

        --text-size <textMessageSize>
            Size of each textMessage (The producer will use text message on this
            case)

        --threads <threads>
            Number of Threads to be used (Default: 1)

        --txt-size <txBatchSize>
            TX Batch Size

        --url <brokerURL>
            URL towards the broker. (default: tcp://localhost:61616)

        --user <user>
            User used to connect

        --verbose
            Adds more information on the execution


NAME
        artemis queue - Queue tools group (create|delete|update|stat) (example
        ./artemis queue create)

SYNOPSIS
        artemis queue
        artemis queue create [--durable] [--address <address>] [--user <user>]
                [--anycast] [--multicast] [--preserve-on-no-consumers] [--silent]
                [--auto-create-address] [--purge-on-no-consumers]
                [--clientID <clientID>] [--protocol <protocol>] [--password <password>]
                [--no-durable] [--url <brokerURL>] [--verbose] [--filter <filter>]
                [--max-consumers <maxConsumers>] [--name <name>]
        artemis queue delete [--password <password>] [--user <user>]
                [--url <brokerURL>] [--verbose] [--removeConsumers] [--silent]
                [--clientID <clientID>] [--protocol <protocol>] [--name <name>]
                [--autoDeleteAddress]
        artemis queue stat [--queueName <queueName>] [--password <password>]
                [--user <user>] [--operation <operationName>] [--url <brokerURL>]
                [--verbose] [--value <value>] [--field <fieldName>]
                [--maxRows <maxRows>] [--silent] [--clientID <clientID>]
                [--protocol <protocol>]
        artemis queue update [--durable] [--address <address>] [--user <user>]
                [--anycast] [--multicast] [--preserve-on-no-consumers] [--silent]
                [--auto-create-address] [--purge-on-no-consumers]
                [--clientID <clientID>] [--protocol <protocol>] [--password <password>]
                [--no-durable] [--url <brokerURL>] [--verbose] [--filter <filter>]
                [--max-consumers <maxConsumers>] [--name <name>]

COMMANDS
        With no arguments, Display help information

        create
            create a queue or topic

            With --durable option, whether the queue is durable or not (default
            input)

            With --address option, address of the queue (default queue's name)

            With --user option, User used to connect

            With --anycast option, It will determine this queue as anycast
            (default input)

            With --multicast option, It will determine this queue as multicast
            (default input)

            With --preserve-on-no-consumers option, whether to preserve the
            contents of this queue when its last consumer disconnects (default
            input)

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --auto-create-address option, Auto create the address (if it
            doesn't exist) with default values (default input)

            With --purge-on-no-consumers option, whether to delete the contents
            of this queue when its last consumer disconnects (default input)

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --password option, Password used to connect

            With --no-durable option, whether the queue is durable or not
            (default input)

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --filter option, queue's filter string (default null)

            With --max-consumers option, Maximum number of consumers allowed on
            this queue at any one time (default no limit)

            With --name option, queue name

        delete
            delete a queue

            With --password option, Password used to connect

            With --user option, User used to connect

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --removeConsumers option, whether deleting destination with
            consumers or not (default false)

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --name option, queue name

            With --autoDeleteAddress option, delete the address if this it's
            last last queue

        update
            update a core queue

            With --durable option, whether the queue is durable or not (default
            input)

            With --address option, address of the queue (default queue's name)

            With --user option, User used to connect

            With --anycast option, It will determine this queue as anycast
            (default input)

            With --multicast option, It will determine this queue as multicast
            (default input)

            With --preserve-on-no-consumers option, whether to preserve the
            contents of this queue when its last consumer disconnects (default
            input)

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --auto-create-address option, Auto create the address (if it
            doesn't exist) with default values (default input)

            With --purge-on-no-consumers option, whether to delete the contents
            of this queue when its last consumer disconnects (default input)

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.

            With --password option, Password used to connect

            With --no-durable option, whether the queue is durable or not
            (default input)

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --filter option, queue's filter string (default null)

            With --max-consumers option, Maximum number of consumers allowed on
            this queue at any one time (default no limit)

            With --name option, queue name

        stat
            prints out basic stats associated with queues. Output includes
            CONSUMER_COUNT (number of consumers), MESSAGE_COUNT (current message
            count on the queue, including scheduled, paged and in-delivery
            messages), MESSAGES_ADDED (messages added to the queue),
            DELIVERING_COUNT (messages broker is currently delivering to
            consumer(s)), MESSAGES_ACKED (messages acknowledged from the
            consumer(s)). Queues can be filtered using EITHER '--queueName X'
            where X is contained in the queue name OR using a full filter
            '--field NAME --operation EQUALS --value X'.

            With --queueName option, display queue stats for queue(s) with names
            containing this string.

            With --password option, Password used to connect

            With --user option, User used to connect

            With --operation option, operation to use in filter. Possible values
            CONTAINS, EQUALS, GREATER_THAN, LESS_THAN.

            With --url option, URL towards the broker. (default:
            tcp://localhost:61616)

            With --verbose option, Adds more information on the execution

            With --value option, value to use in the filter.

            With --field option, field to use in filter. Possible values NAME,
            ADDRESS, MESSAGE_COUNT, MESSAGES_ADDED, DELIVERING_COUNT,
            MESSAGES_ACKED.

            With --maxRows option, max number of queues displayed. Default is
            50.

            With --silent option, It will disable all the inputs, and it would
            make a best guess for any required input

            With --clientID option, ClientID to be associated with connection

            With --protocol option, Protocol used. Valid values are amqp or
            core. Default=core.