ControlTier > elements
 
 
PDF -icon
PDF

Docs-Generate

Command Reference

Description

creates directories required for jboss operation

Auto-provisions the jboss instance using the reference instance identified by ${opts.jbossDefaultInstance}.

Note
NOTE: exception is if ${opts.basedir} and ${opts.jbossDefaultInstance} are the same directory, where auto provisioning does not occur.

Also generates run.conf which contains java runtime configuration.

Usage

ctl -t JBossServer -o <objectname> -c Docs-Generate [-basedir <>] [-install_root <>] [-java_home <>] [-javaopts <>] [-jboss_version <>] [-jbossDefaultInstance <default>] [-jvm_max_perm_size <>] [-jvm_maxheap <>] [-jvm_minheap <>] [-jvm_perm_size <>] [-overwrite <false>] [-port_config <>] [-timezone <>]

Options

Option Description Type Default
basedir base directory of the jboss instance

Defaults to the value of the jboss_basedir attribute setting .

string ${entity.attribute.jboss_basedir}
install_root the JBoss Installation root, i.e. $JBOSS_HOME

Defaults to the value of the jboss_install_root attribute setting.

string ${entity.attribute.jboss_install_root}
java_home JAVA_HOME

JBoss JAVA_HOME which defaults to the java_home attribute setting value

string ${entity.attribute.java_home}
javaopts the java options

Arbitrary JAVA_OPTS passed to the jboss runtime, defaults to the javaOpts attribute setting value.

string ${entity.attribute.javaOpts}
jboss_version version of the jboss server package

Defaults to the value of the jboss_version attribute setting and is used to validate versioned templates embedded within this module. See JBossZip regarding the jboss_version attribute.

string ${entity.attribute.jboss_version}
jbossDefaultInstance specifies the jboss reference instance to copy from, if not specified the default server is assumed within the JBOSS_HOME/server directory

jboss default reference instance defaults to the jbossDefaultInstance attribute setting value

 string default / ${entity.attribute.jbossDefaultInstance}
jvm_max_perm_size jre max_perm_size setting

JBoss java max perm size setting, defaults to the jvm_max_perm_size attribute setting value

string ${entity.attribute.jvm_max_perm_size}
jvm_maxheap JAVA_HOME

JBoss java maximum heap setting, defaults to the jvm_maxheap attribute setting value

string ${entity.attribute.jvm_maxheap}
jvm_minheap jre minheap setting

JBoss java minimum heap setting, defaults to the jvm_minheap attribute setting value

string ${entity.attribute.jvm_minheap}
jvm_perm_size jre perm_size setting

JBoss java perm size setting, defaults to the jvm_perm_size attribute setting value

string ${entity.attribute.jvm_perm_size}
overwrite overwrite the configuration if true

Typically the first time jboss instance is provisioned, one time copying is executed prior to template expansion. The one time copying can be overridden since the default for this option is set to false. If true, it would be the equivalent of re-provisioning the jboss server instance.

string false
port_config jboss binding port configuration

identifies the port configuration from the port_config attribute setting value used in the JBoss Service Bindings configuration.

string ${entity.attribute.port_config}
timezone the time zone

JBoss timezone passed in at java/jboss startup, defaults to the timezone attribute setting value.

string ${entity.attribute.timezone}