Sun N1 Service Provisioning System User's Guide for Sun Java System Web Server Plug-In 1.0

Components

The Sun Java System Web Server 7.0 Plug-In 1.0 provides two stand-alone components that allow you to control Administration Servers and Web Server instances and two Java ES components that allow you to control Java ES Web Administration servers and Java ES Web Server instances.

WebAdminServer Component

The WebAdminServer component provides controls that enable you to stop, start, and restart Administration Servers. The component variables and component procedures available for use with the WebAdminServer component are described below. For instructions to control an Administration Server, see Controlling the Web Server 7.0.

Component Variables

Table 5–1 List of component variables


Variables	Description
`installPath`	Path on the target host to install the state file that contains the name/value pairs for the installation of the Administration Server.
`installId`	A unique install identifier to differentiate Admin Servers.
`adminServerHost`	Host name of the Web Server.
`selectedComponent`	Component(s) to be installed. (svrcore/admincli/scrcore64/devsupport)
`configureAs`	Configure Server as (Server/Node).
`adminName`	Administration Server user name.
`adminPort`	Port to access Administration Server.
`adminSSLPort`	SSL port to access Administration Server.
`nonSSLPortRequired`	Non SSL port to access Administration Server.
`adminUser`	User ID to logon to the Administration Server.
`agentHost`	Host name of the Node.
`agentSSLPort`	SSL port of the Node.
`webInstanceUser`	User ID that the default instance of Web Server uses to run on the system.
`webInstanceHost`	Hostname of the Web instance.
`webInstancePort`	Port to access Web instance.
`docRoot`	Path for the Web Server to store content documents.
`webAutoStart`	The value of this variable determines whether the provisioning server will create a boot script that will start the Administration Server and the Web Server instance upon system boot.
`startOnInstall`	The value of this variable determines whether the provisioning server will start the Administration Server and the Web Server instance when the installation is complete.
`WEB_Media_Directory`	Path to the Web Server 7.0 installation binary on the target server.
`sixtyfourbitInstall`	Identifies 64-bit installation
`webAdminPassword`	Password to access the Administration Server.
`registerAdminAgent`	Specifies whether the Administration Node instance should be registered with the Administration Server instance at the time of installation or later.

Component Procedures

The component provides controls that enable you to stop, start, and restart Administration Servers.

Table 5–2 Components


Components	Description
`install:markOnly`	Use this procedure to update the N1 Service Provisioning System database to include any Administration Servers that you installed manually.
`uninstall:markOnly`	Use this procedure to update the N1 Service Provisioning System database to remove any Administration Servers that you uninstalled manually.
`StartWebAdminServer`	Use this procedure to start an Administration Server.
`RestartWebAdminServer`	Use this procedure to stop and then restart an Administration Server.
`StopWebAdminServer`	Use this procedure to stop an Administration Server.

WebServerInstance Component

The WebServerInstance component provides controls that enable you to stop, start, and restart Web Server instances. The component variables and component procedures available for use with the WebServerInstance component are described below. For instructions explaining how to control a Web Server instance, see Controlling the Web Server 7.0.

Component Variables

Table 5–3 List of Component variables


Variables	Description
`installIdentifier`	A unique ID that is used to link Web Server instance with Web Admin Server.
`installedPath`	Location where the Administration Server is installed.
`adminSSLPort`	SSL port to access the Administration Server.
`adminUser`	User ID to logon to the Administration Server.
`adminPassword`	Password to access the Web Administration Server.
`docRoot`	Path for the Web Server to store content documents.
`httpPort`	Port for the default HTTP Listener.
`serverName`	Server name for the new configuration.
`configName`	Unique name for your new configuration.
`nodeHost`	The node on which the Web Server instance has to be created.
`startOnCreate`	Start Web Server instance on creation.
`InstallPath`	Unique install path, generated automatically and should not be changed.

Component Procedures

Table 5–4 List of component procedures


Component	Description
`Install:markOnly`	Use this procedure to update the N1 Service Provisioning System database to include any server instances that you created manually.
`Uninstall:markonly`	Use this procedure to update the N1 Service Provisioning System database to remove any server instances that you deleted manually.
`StartWebServer`	Use this procedure to start a Web Server instance.
`RestartWebServer`	Use this procedure to stop and then restart a Web Server instance.
`StopWebServer`	Use this procedure to stop a Web Server instance.