Visit Azul.com Support

Create-Service

Table of Contents
Need help?
Schedule a consultation with an Azul performance expert.
Contact Us

configures the starting of a DAS or a Payara Server instance on an unattended boot

Synopsis

 
asadmin [asadmin-options] create-service [--help]
[--name service-name]
[--serviceproperties service-properties]
[--dry-run={false|true}] [--force={false|true}]
[--system-type system-type]
[--serviceuser service-user]
[--domaindir domain-dir]
[--nodedir node-dir] [--node node]
[domain-or-instance-name]

Description

The create-service subcommand configures the starting of a domain administration server (DAS) or a Payara Server instance on an unattended boot on Windows, Linux, and Oracle Solaris systems.

If no operand is specified and the domains directory contains only one domain, the subcommand configures the starting of the DAS for the default domain. If no operand is specified and the domains directory contains multiple domains, an error occurs.

If the operand specifies an instance, the create-service subcommand does not contact the domain administration server (DAS) to determine the node on which the instance resides.

To determine the node on which the instance resides, the subcommand searches the directory that contains the node directories. If multiple node directories exist, the node must be specified as an option of the subcommand.

The subcommand contains internal logic to determine whether the supplied operand is a DAS or an instance.

This subcommand is supported in local mode only.

Behavior of create-service on Windows Systems

On Windows systems, this subcommand must be run as the OS-level administrator user and requires the Microsoft .NET Framework (http://www.microsoft.com/net/), otherwise, the subcommand fails.

It creates a Windows service to represent the DAS or instance. The service is created in the disabled state. After this subcommand creates the service, you must use the Windows Services Manager or the Windows Services Wrapper to start, stop, uninstall, or install the service.

The subcommand creates the following Windows Services Wrapper files for the service in the domain-dir\bin directory or the instance-dir\bin directory:

  • Configuration file: service-nameService.xml

  • Executable file: service-nameService.exe

Behavior of create-service on Linux Systems

On Linux systems, the create-service subcommand first detects System-V or SystemD init systems.

On systems using System-V, it creates an initialization script /etc/init.d/payara_domain-or-instance-name and installs a link to this script in the /etc/rc?.d directories. After this subcommand creates the script, you must use this script to start, stop, or restart the domain or instance.

On systems using SystemD, the subcommand creates a configuration file payara_domainname.service in /etc/systemd/system. It is recommended to specify non-root user to run payara (parameter --serviceuser). It is possible to further configure the service via --serviceproperties.

On Linux systems, this subcommand must be run as the OS-level root user, because it writes to system directories.

Behavior of create-service on Oracle Solaris Systems

On Oracle Solaris systems, the create-service subcommand creates a Service Management Facility (SMF) service to represent the DAS or instance. The service is created in the disabled state. After this subcommand creates the service, you must use SMF commands to start, enable, disable, delete, or stop the service. For more information about SMF, see the following documentation for the Oracle Solaris operating system:

On Oracle Solaris systems, this subcommand must be run as the OS-level user with superuser privileges. The configuration file for the DAS or instance must be stored in a directory to which the superuser has access and cannot be stored on a network file system. The service that is created is controlled by the OS-level user who owns the directory where the configuration of the DAS or instance resides.

On Oracle Solaris systems, the manifest file is created in the following directory by default:

 
/var/svc/manifest/application/GlassFish/domain-or-instance-name_domain-or-instance-root-dir

To run this subcommand, you must have solaris.smf.* authorization. For information about how to grant authorizations to users, see the useradd and usermod man pages.

To run these commands as non-root user, the system administrator must be contacted so that the relevant authorizations are granted. You must also ensure that the following conditions are met:

  • Oracle Solaris 10 administration commands such as svccfg, svcs, and auths are available through the PATH statement, so that these commands can be executed. A simple test to do so is to run the command which svccfg in the shell.

  • You must have write permission for the path /var/svc/manifest/application/GlassFish. Usually, the superuser has write permission to this path.

If you delete a service that you created by using the create-service subcommand, you must delete the directory that contains the manifest file and the entire contents of the directory. Otherwise, an attempt to re-create the service by using the create-service subcommand fails.

The Oracle Solaris command svccfg does not delete this directory.

Options

asadmin-options: Options for the asadmin utility. For information about these options, see the asadmin help page.

--help: -?: Displays the help text for the subcommand.

--name: (Windows and Oracle Solaris systems only) The name of the service that you will use when administering the service through Oracle Solaris SMF commands or the service management features of the Windows operating system. The default is the name of the domain or instance that is specified as the operand of this subcommand.

--serviceproperties: Specifies a colon(:)-separated list of various properties that are specific to the service.

+ To customize the display name of the service in the Windows Service list, set the DISPLAY_NAME property to the required name.

+ For Oracle Solaris 10 systems, if you specify net_privaddr, the service’s processes will be able to bind to the privileged ports (<1024) on the platform. You can bind to ports< 1024 only if the owner of the service is superuser, otherwise, this is not allowed.

+ On Linux systems using SystemD these properties are stored as Environment entries, accessible via Microprofile property in the applications.

--dry-run: -n: Previews your attempt to create a service. Indicates issues and the outcome that will occur if you run the command without using the --dry-run option. Nothing is actually configured. Default is false.

--force: Specifies whether the service is created even if validation of the service fails.

+ Possible values are as follows:

+ true;; The service is created even if validation of the service fails. false;; The service is not created (default).

--system-type: If specified, system-type must be one of systemd, systemv, solaris or windows, which determine the type of init scripts to create.

+ If not specified, the command performs auto-detection of init system.

--serviceuser: (Linux systems only) The user that is to run the Payara Server software when the service is started. The default is the user that is running the subcommand. Specify this option if the Payara Server is to be run by a user other than the root user.

--domaindir: The absolute path of the directory on the disk that contains the configuration of the domain. If this option is specified, the operand must specify a domain.

--nodedir: Specifies the directory that contains the instance’s node directory. The instance’s files are stored in the instance’s node directory.

+ The default is as-install/nodes. If this option is specified, the operand must specify an instance.

--node: Specifies the node on which the instance resides. This option may be omitted only if the directory that the --nodedir option specifies contains only one node directory. Otherwise, this option is required. If this option is specified, the operand must specify an instance.

Operands

domain-or-instance-name: The name of the domain or instance to configure. If no operand is specified, the default domain is used.

Examples

Example 1 Creating a Service on a Windows System

This example creates a service for the default domain on a system that is running Windows.

 
asadmin create-service
The Windows Service was created successfully.  It is ready to be started.  Here are the details:
ID of the service: domain1
Display Name of the service:domain1 Payara Server
Server Directory: C:\payara7\glassfish\domains\domain1
Configuration file for Windows Services Wrapper: C:\payara7\glassfish\domains\domain1\bin\domain1Service.xml
The service can be controlled using the Windows Services Manager or you can use the
Windows Services Wrapper instead:
Start Command:  C:\payara7\glassfish\domains\domain1\bin\domain1Service.exe  start
Stop Command:   C:\payara7\glassfish\domains\domain1\bin\domain1Service.exe  stop
Restart Command:  C:\payara7\glassfish\domains\domain1\bin\domain1Service.exe  restart
Uninstall Command:  C:\payara7\glassfish\domains\domain1\bin\domain1Service.exe  uninstall
Install Command:  C:\payara7\glassfish\domains\domain1\bin\domain1Service.exe  install
Status Command: C:\payara7\glassfish\domains\domain1\bin\domain1Service.exe status
You can also verify that the service is installed (or not) with sc query state= all
windows.services.uninstall.good=Found the Windows Service and successfully uninstalled it.
For your convenience this message has also been saved to this file: C:\payara7\glassfish\domains\domain1\PlatformServices.log
Command create-service executed successfully.

Example 2 Creating a Service on a Linux System using SystemD

This example creates a service for the default domain on a system that is running Linux and SystemD. It is necessary to inform SystemD about the new script by running systemctl daemon-reload. Then it is possible to start the service.

 
asadmin> create-service --service-user payaraadmin

The SystemD Service was created successfully. Here are the details:
Name of the service:domain1
Type of the service:Domain
Configuration location of the service:/etc/systemd/system/payara_domain1.service
User account that will run the service: payaraadmin
You have created the service but you need to start it yourself.  Here are the most
typical Linux commands of interest:

* systemctl daemon-reload
* systemctl start payara_domain1.service
* systemctl stop payara_domain1.service
* systemctl restart payara_domain1.service

For your convenience this message has also been saved to this file:
/opt/payara/glassfish/domains/domain1/PlatformServices.log

Command create-service executed successfully.

Example 3 Creating a Service on a Linux System using SystemV

This example creates a service for the default domain on a system that is running Linux and SystemV.

 
asadmin> create-service

Found the Linux Service and successfully uninstalled it.
The Service was created successfully. Here are the details:
Name of the service:domain1
Type of the service:Domain
Configuration location of the service:/etc/init.d/payara_domain1
User account that will run the service: root
You have created the service but you need to start it yourself.
Here are the most typical Linux commands of interest:

* /etc/init.d/payara_domain1 start
* /etc/init.d/payara_domain1 stop
* /etc/init.d/payara_domain1 restart

For your convenience this message has also been saved to this file:
/opt/payara/glassfish/domains/domain1/PlatformServices.log

Command create-service executed successfully.

Example 4 Creating a Service on an Oracle Solaris System

This example creates a service for the default domain on a system that is running Oracle Solaris.

 
asadmin> create-service

The Service was created successfully. Here are the details:
Name of the service:application/GlassFish/domain1
Type of the service:Domain
Configuration location of the service:/opt/payara/glassfish/domains
Manifest file location on the system:/var/svc/manifest/application
/GlassFish/domain1_opt_payara_glassfish_domains/Domain-service-smf.xml.
You have created the service but you need to start it yourself.
Here are the most typical Solaris commands of interest:
* /usr/bin/svcs -a | grep domain1 // status
* /usr/sbin/svcadm enable domain1 // start
* /usr/sbin/svcadm disable domain1 // stop
* /usr/sbin/svccfg delete domain1 // uninstall

Command create-service executed successfully.

Exit Status

0: subcommand executed successfully 1: error in executing the subcommand

See Also