Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Developer's Guide

- Previous: Reusable Subelements
- Next: component

## server

Specifies an Application Server instance. Allows a single task to act on multiple server instances. The `server` attributes override corresponding attributes in the parent task; therefore, the parent task attributes function as default values.

### Subelements

none

### Attributes

The following table describes attributes for the `server` element.

Table 3–17 `server` Attributes

Attribute | Default | Description
--- | --- | ---
`user` | `admin` | (optional) The username used when logging into the application server administration instance.
`password` | none | (optional) Deprecated, use `passwordfile` instead. The password used when logging into the application server administration instance.
`passwordfile` | none | (optional) File containing passwords. The password from this file is retrieved for communication with the application server administration instance. If both `password` and `passwordfile` are specified, `passwordfile` takes precedence.
`host` | `localhost` | (optional) Target server. When targeting a remote server, use the fully qualified hostname.
`port` | `4849` | (optional) The administration port on the target server.
`instance` | name of default instance | (optional) Target application server instance.
`domain` |  | (applies to sun-appserv-update only) The domain in which the application has been previously deployed.
`instanceport` | none | (applies to sun-appserv-instance only) Deprecated.
`nodeagent` | none | (applies to sun-appserv-instance only, required if `action` is `create`, otherwise ignored) The name of the node agent on which the instance is being created.
`debug` | `false` | (applies to sun-appserv-instance only, optional) Deprecated. If `action` is set to `start`, specifies whether the server starts in debug mode. This attribute is ignored for other values of `action`. If `true`, the instance generates additional debugging output throughout its lifetime.
`upload` | `true` | (applies to sun-appserv-deploy only, optional) If `true`, the component is transferred to the server for deployment. If the component is being deployed on the local machine, set upload to `false` to reduce deployment time.
`virtualservers` | default virtual server only | (applies to sun-appserv-deploy only, optional) A comma-separated list of virtual servers to be deployment targets. This attribute applies only to application (`.ear`) or web (`.war`) components and is ignored for other component types.

### Examples

You can control multiple servers using a single task. In this example, two servers are started, each using a different password. Only the second server is started in debug mode.

    <sun-appserv-instance action="start">
    <server host="greg.sun.com" passwordfile="${password.greg}"/>
    <server host="joe.sun.com" passwordfile="${password.joe}"
    	 debug="true"/>
    </sun-appserv-instance>

You can create instances on multiple servers using a single task. This example creates a new instance named `qa` on two different servers. Both servers use the same password.

    <sun-appserv-instance action="create" instanceport="8080"
    	 instance="qa" passwordfile="${passwordfile}>
    <server host="greg.sun.com"/>
    <server host="joe.sun.com"/>
    </sun-appserv-instance>

These instances can also be removed from their respective servers:

    <sun-appserv-instance action="delete" instance="qa"
    	 passwordfile="${passwordfile}>
    <server host="greg.sun.com"/>
    <server host="joe.sun.com"/>
    </sun-appserv-instance>

You can specify different instance names and instance ports using attributes of the nested `server` element:

    <sun-appserv-instance action="create" passwordfile="${passwordfile}>
    <server host="greg.sun.com" instanceport="8080" instance="qa"/>
    <server host="joe.sun.com" instanceport="9090"
    	instance="integration-test"/>
    </sun-appserv-instance>

You can deploy multiple components to multiple servers (see the component nested element. This example deploys each component to two Application Server instances running on remote servers. Both servers use the same password.

    <sun-appserv-deploy passwordfile="${passwordfile}"
      asinstalldir="/opt/s1as8" >
    <server host="greg.sun.com"/>
    <server host="joe.sun.com"/>
    <component file="${assemble}/simpleapp.ear"/>
    <component file="${assemble}/simpleservlet.war"
    	 contextroot="test"/>
    <component file="${assemble}/simplebean.jar"/>
    </sun-appserv-deploy>

You can also undeploy multiple components from multiple servers. This example shows the same three components being removed from two different instances. Both servers use the same password.

    <sun-appserv-undeploy passwordfile="${passwordfile}">
    <server host="greg.sun.com"/>
    <server host="joe.sun.com"/>
    <component file="${assemble}/simpleapp.ear"/>
    <component file="${assemble}/simpleservlet.war"/>
    <component name="simplebean" />
    </sun-appserv-undeploy>

You can enable or disable components on multiple servers. This example shows the same three components being enabled on two different instances. Both servers use the same password.

    <sun-appserv-component action="enable" passwordfile="${passwordfile}">
    <server host="greg.sun.com"/>
    <server host="joe.sun.com"/>
    <component file="${assemble}/simpleapp.ear"/>
    <component file="${assemble}/simpleservlet.war"/>
    <component name="simplebean" />
    </sun-appserv-component>

- Previous: Reusable Subelements
- Next: component

- © 2010, Oracle Corporation and/or its affiliates