Appendix A. Reference information for getting started with JBoss EAP You can use the arguments, attributes, and default socket binding to help you get started with using JBoss EAP. For example, you can use arguments to set an alternative configuration to a default JBoss EAP standalone server. This helps configure the server to meet your needs. A.1. Server runtime arguments and switches On standalone servers and servers in a managed domain, you can use specific server runtime arguments with an application's startup script. The script can start a server with alternative configurations to those defined in the standalone.xml , domain.xml , and host.xml configuration files. Alternative configurations might include starting the server with an alternative socket bindings set or a secondary configuration. Before you start the server, you can access the available parameters list by issuing the help switch, -h or --help , in your terminal. Table A.1. Descriptions of runtime arguments and switches: Argument or switch Server type Description --admin-only Standalone Sets the server's running type to ADMIN_ONLY . The argument opens administrative interfaces and accepts management requests, but the argument does not start other runtime services or accept user requests. For best performance, use the --start-mode=admin-only argument. --admin-only Domain Sets the host controller's running type to ADMIN_ONLY causing the the host controller to open administrative interfaces and accept management requests, but the host controller does not start servers. For the master host controller for the domain, it accepts incoming connections from slave host controllers. -b=<value>, -b <value> Standalone, Domain Set system property jboss.bind.address , which you can use to configure the bind address for the public interface. The bind address defaults to 127.0.0.1 . See the -b<interface>=<value> entry for setting the bind address for other interfaces. -b<interface>=<value> Standalone, Domain Set system property jboss.bind.address.<interface> to the given value. For example, -bmanagement= IP_ADDRESS . --backup Domain Keep a copy of the persistent domain configuration even if this host is not the domain controller. -c=<config>, -c <config> Standalone Name of the server configuration file to use. The default is standalone.xml . -c=<config>, -c <config> Domain Name of the server configuration file to use. The default is domain.xml . --cached-dc Domain If the host is not the domain controller and cannot contact the domain controller at boot then you must boot by using a locally cached copy of the domain configuration. --debug [<port>] Standalone Activate debug mode with an optional argument to specify the port. Argument only works if the launch script supports the Argument. -D<name>[=<value>] Standalone, Domain Set a system property. --domain-config=<config> Domain Name of the server configuration file to use. Defaults as domain.xml . --git-repo Standalone The location of the Git repository that is used to manage and persist server configuration data. This can be local if you want to store it locally, or the URL to a remote repository. --git-branch Standalone The branch or tag name in the Git repository to use. This argument should name an existing branch or tag name as it will not be created if it does not exist. If you use a tag name, you put the repository in a detached HEAD state, meaning future commits are not attached to any branches. Tag names are read-only and are normally used when you need to replicate a configuration across several nodes. --git-auth Standalone The URL to an Elytron configuration file that contains the credentials the server uses when it connects to a remote Git repository. You can use the argument when your remote Git repository requires authentication. Elytron does not support SSH. Elytron supports only default SSH authentication by using private keys without a password. You cannot use the argument with a local repository. -h, --help Standalone, Domain Display the help message and exit the help index. --host-config=<config> Domain Name of the host configuration file to use. Defaults as host.xml . --interprocess-hc-address=<address> Domain Address on which the host controller can listen for communication from the process controller. --interprocess-hc-port=<port> Domain Port on which the host controller can listen for communication from the process controller. --master-address=<address> Domain Set system property jboss.domain.master.address to the given value. In a default slave host controller configuration, you can use the argument to configure the address of the master host controller. --master-port=<port> Domain Set system property jboss.domain.master.port to the given value. In a default slave host controller configuration, you can use the argument to configure the port used for native management communication by the master host controller. --read-only-server-config=<config> Standalone Name of the server configuration file to use. Argument differs from --server-config and -c in that the argument does not overwrite the original file. --read-only-domain-config=<config> Domain Name of the domain configuration file to use. Argument differs from --domain-config and -c in that the argument does not overwrite the initial file. --read-only-host-config=<config> Domain Name of the host configuration file to use. Argument differs from --host-config in that the argument does not overwrite the initial file. -P=<url>, -P <url>, --properties=<url> Standalone, Domain Load system properties from the given URL. --pc-address=<address> Domain Address on which the process controller listens for communication from processes it controls. --pc-port=<port> Domain Port on which the process controller listens for communication from processes it controls. -S<name>[=<value>] Standalone Set a security property. -secmgr Standalone, Domain Runs the server with a security manager installed. --server-config=<config> Standalone Name of the server configuration file to use. Defaults as standalone.xml . --start-mode=<mode> Standalone Set the start mode of the server. You cannot use the argument cannot with the --admin-only argument. You can use the following entries with the argument: normal : The server starts normally. admin-only : The server only opens in administrative interfaces and accept management requests, but the server does not start other runtime services or accept end user requests. suspend : The server starts in suspended mode, but the server does does not receive service requests until the server resumes. -u=<value>, -u <value> Standalone, Domain Set system property jboss.default.multicast.address , which the server uses in configuring the multicast address in the socket-binding elements in the configuration files. Defaults as 230.0.0.4 . -v, -V, --version Standalone, Domain Display the application server version and exit. Warning JBoss EAP sets its included configuration files to handle the behavior of the switches. For example, -b and -u . If you change your configuration files to no longer use the system property controlled by the switch then adding the system property to the start command does not work. A.2. Add-user arguments You can use arguments with the add-user.sh script or the add-user.bat script to configure how these scrips add new users to a properties file for authentication purposes. Table A.2. Descriptions of add-user arguments Command line argument Description -a Creates a user in the application realm. If you do not create a user in the application realm then the script creates a user in the management realm by default. -dc <value> The domain configuration directory that contains the properties files. If you omit the argument then the script sets EAP_HOME /domain/configuration/ as the default directory. -sc <value> An alternative standalone server configuration directory that contains properties files. If you omit the argument then the script sets EAP_HOME /standalone/configuration/ as the default directory. -up, --user-properties <value> The name of the alternative user properties file. You can set an absolute path for the file or specify a file name by using the argument with an -sc or a -dc argument to set an alternative configuration directory. -g, --group <value> A comma-separated list of groups to assign to a user. -gp, --group-properties <value> The name of the alternative group properties file. You can set an absolute path for the file or specify a file name by using the argument with an -sc or a -dc argument to set an alternative configuration directory. -p, --password <value> The password of the user. -u, --user <value> The name of the user. User names can only contain the following characters, in any number and in any order: Alphanumeric characters (a-z, A-Z, 0-9) Dashes (-), periods (.), commas (,), at sign (@) Backslash (\) Equals (=) -r, --realm <value> The name of the realm used to secure the management interfaces. If omitted, the default is ManagementRealm . -s, --silent Run the add-user script with no output to the console. -e, --enable Enable the user. -d, --disable Disable the user. -cw, --confirm-warning Automatically confirm warning in interactive mode. -h, --help Display usage information for the add-user script. -ds, --display-secret Print the secret value in non-interactive mode. A.3. Interface attributes You can use interface attributes to configure a JBoss EAP interface. Note Attribute names in the table display in the order JBoss EAP lists them in its management model. See the schema definition file located at EAP_HOME /docs/schema/wildfly-config_5_0.xsd to view the elements as they appear in the XML. XML element listings must differ from those displayed in the management model. Table A.3. Descriptions of interface attributes: Interface attribute Description any Specifies that an interface must meet at least one, but not necessarily all, of the selected nested set of criteria. any-address Empty attribute that binds a wildcard address to sockets that use an interface. The attribute has the following configuration options: Attribute uses the IPv6 wildcard address ( :: ) as default. If you set the java.net.preferIPv4Stack system property to true then the socket uses the IPv4 wildcard address ( 0.0.0.0 ). If a socket binds to an IPv6 anylocal address on a dual-stack machine, the socket accepts both IPv6 and IPv4 traffic. If a socket binds to an IPv4 (IPv4-mapped) anylocal address, the socket accepts only IPv4 traffic. inet-address Specifies either an IP address in IPv6 or IPv4 dotted decimal notation or a host name resolved to an IP address. link-local-address Empty attribute that specifies criteria for whether or not an interface includes a link-local address. loopback Empty attribute that specifies criteria for whether or not an interface identifies as a loopback interface. loopback-address A loopback address that might not have been configured on the machine's loopback interface. Attribute differs from inet-address type, as the interface uses the attribute value even if the value contains an NIC without an IP address. multicast Empty attribute that specifies criteria for whether or not an interface supports multicast. name The name of the interface. nic The name of a network interface, such as eth0 , eth1 , or lo ). nic-match A regular expression that matches the names of the network interfaces available on a machine to an acceptable interface. not Attribute that indicates the selection criteria that an interface must not meet. point-to-point Empty attribute that specifies criteria for whether or not an interface identifies as a point-to-point interface. public-address Empty attribute that specifies criteria for whether or not an interface contains a publicly routable address. site-local-address Empty attribute that specifies criteria for whether or not an interface contains a site-local address. subnet-match Specifies a network IP address and the number of bits in the address' network prefix, which is written in slash notation ,such as 192.168.0.0/16 . up Empty attribute that specifies criteria for whether or not an interface locates as up. virtual Empty attribute that specifies criteria for whether or not an interface contains identifies as a virtual interface. A.4. Socket binding attributes You can use socket binding attributes to configure the socket binding for your JBoss EAP server. Specific attributes exist for the following types of socket bindings: Inbound socket bindings Remote outbound socket bindings Local outbound socket bindings Note Attribute names in the table display in the order JBoss EAP lists them in its management model. See the schema definition file located at EAP_HOME /docs/schema/wildfly-config_5_0.xsd to view the elements as they appear in the XML. XML element listings must differ from those displayed in the management model. Table A.4. Descriptions of inbound socket binding, socket-binding, attributes: Attribute Description client-mappings Specifies the client mappings for an inbound socket binding. A client that connects to an inbound socket must use the destination address specified in the mapping. This address matches the outbound interface. By using the client-mapping attribute with an inbound socket binding, you can apply advanced network topologies that use either network address translation or include bindings on multiple network interfaces. You must evaluate each mapping in declared order; that is, the first successful match determines the destination for the mapping. fixed-port Use the attribute to determine if the port value must remain fixed. You can use the attribute even if you applied numeric offsets to the other sockets in the socket group. interface Attribute that sets name of the interface to which the socket binds. You can also use the attribute to set the interface that multicast sockets must listen. If you do not define a declared interface then the attribute uses the default-interface value from the enclosing socket binding group.. multicast-address Multicast address on which the socket receives multicast traffic. If you do not specify a value for the attribute then you do not configure the socket to receive multicast functionality. multicast-port Port on which the socket receives multicast traffic. You must configure the attrbiute if you configured the multicast-address attribute. name You must set a name of the socket. A service requiring access to the socket configuration information cannot use the name to find the socket. port Number of the port to which the socket binds. You must override the attribute value if you configured servers to apply a port-offset to increment or decrement all port values. Table A.5. Descriptions of remote outbound socket binding, remote-destination-outbound-socket-binding, attributes: Attribute Description fixed-source-port Determines whether the port value must remain fixed, even if you applied numeric offsets to the other outbound sockets in a socket group. host The host name or IP address of the remote destination to which an outbound socket connects. port The port number of the remote destination to which an outbound socket connects. source-interface The name of the interface that JBoss EAP uses for the source address of the outbound socket. source-port The port number that JBoss EAP uses as the source port of the outbound socket. Table A.6. Descriptions of local outbound socket binding, local-destination-outbound-socket-binding, attributes: Attribute Description fixed-source-port Determines whether the port value must remain fixed, even if you applied numeric offsets to the other outbound sockets in the socket group. socket-binding-ref The name of the local socket binding that JBoss EAP uses to determine the port for the connecting outbound socket. source-interface The name of the interface that JBoss EAP uses for the source address of the outbound socket. source-port The port number that JBoss EAP uses as the source port of the outbound socket. A.5. Default socket bindings You can set default socket bindings for each socket binding group. The following five types of default socket bindings exist for JBoss EAP: standard-sockets ha-sockets full-sockets full-ha-sockets load-balancer-sockets Table A.7. Descriptions of default standard-sockets socket bindings: Socket Binding Port Description ajp 8009 Apache JServ Protocol. Used for HTTP clustering and load balancing. http 8080 The default port for deployed web applications. https 8443 SSL-encrypted connection between deployed web applications and clients. management-http 9990 Used for HTTP communication with the management layer. management-https 9993 Used for HTTPS communication with the management layer. txn-recovery-environment 4712 The JTA transaction recovery manager. txn-status-manager 4713 The JTA / JTS transaction manager. Table A.8. Descriptions of default ha-sockets socket bindings: Socket Binding Port Multicast Port Description ajp 8009 Apache JServ Protocol. Used for HTTP clustering and load balancing. http 8080 The default port for deployed web applications. https 8443 SSL-encrypted connection between deployed web applications and clients. jgroups-mping 45700 Multicast. Used to discover initial membership in a HA cluster. jgroups-tcp 7600 Unicast peer discovery in HA clusters using TCP. jgroups-udp 55200 45688 Multicast peer discovery in HA clusters using UDP. management-http 9990 Used for HTTP communication with the management layer. management-https 9993 Used for HTTPS communication with the management layer. modcluster 23364 Multicast port for communication between JBoss EAP and the HTTP load balancer. txn-recovery-environment 4712 The JTA transaction recovery manager. txn-status-manager 4713 The JTA / JTS transaction manager. Table A.9. Descriptions of default full-sockets socket bindings: Socket Binding Port Description ajp 8009 Apache JServ Protocol. Used for HTTP clustering and load balancing. http 8080 The default port for deployed web applications. https 8443 SSL-encrypted connection between deployed web applications and clients. iiop 3528 CORBA services for JTS transactions and other ORB-dependent services. iiop-ssl 3529 SSL-encrypted CORBA services. management-http 9990 Used for HTTP communication with the management layer. management-https 9993 Used for HTTPS communication with the management layer. txn-recovery-environment 4712 The JTA transaction recovery manager. txn-status-manager 4713 The JTA / JTS transaction manager. Table A.10. Descriptions of default full-ha-sockets socket bindings: Name Port Multicast Port Description ajp 8009 Apache JServ Protocol. Used for HTTP clustering and load balancing. http 8080 The default port for deployed web applications. https 8443 SSL-encrypted connection between deployed web applications and clients. iiop 3528 CORBA services for JTS transactions and other ORB-dependent services. iiop-ssl 3529 SSL-encrypted CORBA services. jgroups-mping 45700 Multicast. Used to discover initial membership in a HA cluster. jgroups-tcp 7600 Unicast peer discovery in HA clusters using TCP. jgroups-udp 55200 45688 Multicast peer discovery in HA clusters using UDP. management-http 9990 Used for HTTP communication with the management layer. management-https 9993 Used for HTTPS communication with the management layer. modcluster 23364 Multicast port for communication between JBoss EAP and the HTTP load balancer. txn-recovery-environment 4712 The JTA transaction recovery manager. txn-status-manager 4713 The JTA / JTS transaction manager. Table A.11. Descriptions of default load-balancer-sockets socket bindings: Name Port Multicast Port Description http 8080 The default port for deployed web applications. https 8443 SSL-encrypted connection between deployed web applications and clients. management-http 9990 Used for HTTP communication with the management layer. management-https 9993 Used for HTTPS communication with the management layer. mcmp-management 8090 The port for the Mod-Cluster Management Protocol (MCMP) connection to transmit lifecycle events. modcluster 23364 Multicast port for communication between JBoss EAP and the HTTP load balancer. Revised on 2024-06-10 19:32:05 UTC

Commands: