Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also
create-domain [--user user] [--passwordfile passwordfile] [(--adminport port_number | --portbase portbase)] [(--profile developer | cluster ] --template domain_template)] [--domaindir domain_directory/domains] [--instanceport port_number] [--savemasterpassword=false] [--domainproperties (name=value)[:name=value]* ] [--savelogin=false] [--terse=false] [--echo=false] [--interactive=true] domain_name
Use the create-domain command to create an administrative domain. Sun GlassFish Communication Server domains are configured for SIP.
This command creates the configuration of a domain. A domain is an administrative namespace. Every domain has a configuration, which is stored in a set of files. Any number of domains each of which has a distinct administrative identity can be created in a given installation of Communications Server. A domain can exist independent of other domains. Any user who has access to the asadmin script on a given system can create a domain and store its configuration in a folder of choice. By default, the domain configuration is created in the default directory for domains. You can override this location to store the configuration elsewhere.
A domain, in addition to being an administrative boundary, is also a fully compliant Java EE Server. This means that you can deploy your Java EE Applications to the domain and run them when the domain is started. A domain provides all the necessary environment and services that are essential to run the applications.
A domain can be managed by tools such as the Administration GUI or asadmin.
You choose an appropriate profile for the domain, depending on the applications that you want to run on your new domain. You can choose the developer or cluster for the domain you create.
This command is supported in local mode only.
The username of the adminstrator of the domain.
Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.
Setting to true will echo the command line statement on the standard output. Default is false.
If set to true (default), only the required password options are prompted.
The directory where the domain is to be created. If specified, the path must be accessible in the filesystem. If not specified, the domain is created in the default domain directory.
The profile of the domain. A usage profile depicts how a particular domain is going to be used. It determines how the templates for various files are customized. Currently, only the customization for domain.xml template is supported.
Valid values for this option are: developer and cluster. The default value for this option is set to developer if you have installed the product without clustering capabilities.
Profile names are case-sensitive. Use all profile names in lower case only.
The file name of a domain.xml template used to create the domain. This allows domains of different types to be created. This also allows you to define your own template.
The HTTP/S port for administration. This is the port to which you should point your browser (example, http://localhost:<this-port>) to manage the domain. This option is mandatory unless you specify a value for the --portbase option.
The file containing the domain Communications Server password associated with the administrative instance. The create-domain command reads values for AS_ADMIN_PASSWORD and the AS_ADMIN_MASTERPASSWORD from this file. The password is defined in the following form: AS_ADMIN_PASSWORD=password, where password is the actual administrator password for the domain. This file can contain many other passwords required by the asadmin commands. In adherence to Communications Server security policy, asadmin does not accept clear text passwords on the command line.
If AS_ADMIN_PASSWORD or AS_ADMIN_MASTERPASSWORD are not in the passwordfile, create-domain command prompts for admin password and master password.
Indicates that any output data must be very concise, typically avoiding human-friendly sentences and favoring well-formatted data for consumption by a script. Default is false.
As noted above, the domain provides services so that applications can run when deployed. This (HTTP) port specifies where the web application context roots are available for a Web browser to connect to. This port is a positive integer and must be available at the time of creation of the domain.
Setting this option to true allows the masterpassword to be written to the file system. A master password is really a password for the secure key store. A domain is designed to keep its own certificate (created at the time of domain creation) in a safe place in the configuration location. This certificate is called domain's SSL server certificate. When the domain is contacted by a Web browser over a secure channel (HTTPS), this certificate is presented by the domain. The master password is supposed to protect this store (a file) that contains this certificate. This file is called keystore.jks and is created in the config directory of the domain created. If however, this option is chosen, the master password is saved on the disk in domain's configuration location. The master password is stored in a file called master-password, which is a Java JCEKS type keystore. The only advantage of using this option is in case of unattended system boots, where at the time of start-domain, the master password is not prompted for, because it will be extracted from this file.
It is best to create a masterpassword when creating a domain, because masterpassword is used by the start-domain command. For security purposes, the default setting should be false, because saving the masterpassword on the disk is an insecure practice, unless file system permissions are properly set. If masterpassword is saved, then start-domain will not prompt for it. Masterpassword gives an extra level of security to the environment.
Setting the optional name/value pairs overrides the default values for the properties of the domain to be created. The list must be separated by the “:” character. The following properties are available:
sip.port: Specifies the SIP port. Valid values are 1 to 65535. This property is available only to users of Sun GlassFish Communications Server.
sips.port: Specifies the secure SIP port. Valid values are 1 to 65535. This property is available only to users of Sun GlassFish Communications Server.
jms.port: Specifies the port number for JMS. Valid value is 7676.
domain.jmxPort: Specifies the port on which the JMX connector is initialized. The valid values are 1-65535.
orb.listener.port: Specifies the ORB listener port for IIOP connections on which orb-listener-1 listens .
http.ssl.port: Specifies the port number for http-listener-2. Valid values are 1 to 65535. On UNIX, to create sockets that listen on ports 1–1024, you need superuser privileges.
orb.ssl.port: Specifies the ORB listener port for IIOP connections on which the IIOP listener called SSL listens.
orb.mutualauth.port: Specifies the ORB listener port for IIOP connections on which the IIOP listener called SSL_MUTUALAUTH listens.
Determines the number with which the port assignment should start. A domain uses a certain number of ports that are statically assigned. The portbase value determines where the assignment should start. Choose this value judiciously. The values for the ports are calculated as follows: SIP port: portbase + 60, SIPS port: portbase + 61, Admin port: portbase + 48, HTTP listener port: portbase + 80, IIOP listener port: portbase + 37, JMX port: portbase + 86. See the output of this command for a complete list of occupied ports, when --portbase option is specified.
The --portbase option cannot be used with the --adminport or the --instanceport option.
Saves the admin user name and password if you set this option to true. The default value is false. The username and password are stored in the .asadminpass file in user's home directory. A domain can only be created locally and hence while using the above option, the host name saved in .asadminpass will always be localhost. If the user has specified default admin port while creating the domain, there is no need to specify --user, --passwordfile, --host, or --port on any of the subsequent asadmin remote commands. These values will be automatically obtained.
When the same user creates multiple domains having same admin port number on the same or different machines (where the home directory is NFS mounted), the command is not going to prompt whether the password should be overwritten. It will always be overwritten.
The following command creates sampleDomain domain with developer profile.
asadmin> create-domain --adminport 5006 --profile developer --adminuser admin domain3 Please enter the admin user name>admin Please enter the admin password> Please enter the admin password again> Please enter the master password [Enter to accept the default]:> Please enter the master password again [Enter to accept the default]:> Using port 5005 for Admin. Default port 8080 for HTTP Instance is in use. Using 51871 Default port 7676 for JMS is in use. Using 51872 Default port 3700 for IIOP is in use. Using 51873 Default port 8181 for HTTP_SSL is in use. Using 51874 Default port 3820 for IIOP_SSL is in use. Using 51875 Default port 3920 for IIOP_MUTUALAUTH is in use. Using 51876 Default port 8686 for JMX_ADMIN is in use. Using 51877 Domain being created with profile:developer,as specified on command line or environment Default port 5060 for SIP Instance is in use. Using 51878 Default port 5061 for SIP_SSL is in use. Using 51879 ------ Using Profile [developer] to create the domain ------ XML processing for profile: Base document [/home/SUNWappserver/lib/install/templates/default-domain.xml.template]. Profile name [developer]. Processing property [domain.xml.style-sheets]. Overriding token SIP_PORT Processing token name: [SIP_PORT], value: [51878]. Overriding token SIP_SSL_PORT Processing token name: [SIP_SSL_PORT], value: [51879]. Security Store uses: JKS Domain sampleDomain created. |
The following command creates domain2 domain with cluster profile.
asadmin>create-domain --adminport 4647 --profile cluster domain2 Please enter the admin user name>admin Please enter the admin password> Please enter the admin password again> Please enter the master password [Enter to accept the default]:> Please enter the master password again [Enter to accept the default]:> Using port 4647 for Admin. Using default port 8080 for HTTP Instance. Default port 7676 for JMS is in use. Using 51256 Default port 3700 for IIOP is in use. Using 51257 Using default port 8181 for HTTP_SSL. Default port 3820 for IIOP_SSL is in use. Using 51258 Default port 3920 for IIOP_MUTUALAUTH is in use. Using 51259 Using default port 8686 for JMX_ADMIN. Domain being created with profile:cluster, as specified on command line or environment. Default port 5060 for SIP Instance is in use. Using 51260 Default port 5061 for SIP_SSL is in use. Using 51261 ------ Using Profile [cluster] to create the domain ------ XML processing for profile: Base document [/home/SUNWappserver/lib/install/templates/default-domain.xml.template]. Profile name [cluster]. Processing property [domain.xml.style-sheets]. Overriding token SIP_PORT Processing token name: [SIP_PORT], value: [51260]. Overriding token SIP_SSL_PORT Processing token name: [SIP_SSL_PORT], value: [51261]. Security Store uses: JKS Domain domain2 created. |
Name | Synopsis | Description | Options | Operands | Examples | Exit Status | See Also