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

- Previous: Subelements
- Next: Examples

### Attributes

The following table describes attributes for the `sun-appserv-instance` task.

Table 3–10 `sun-appserv-instance` Attributes

Attribute | Default | Description
--- | --- | ---
`action` | none | The control command for the target application server. Valid values are `start`, `stop`, `restart`, `create`, and `delete`. A `restart` sends the `stop` command followed by the `start` command. The `restart` command is not supported on Windows.
`debug` | `false` | (optional) Deprecated. If `action` is set to `start` or `restart`, 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. This attribute is inherited by nested `server` elements.
`instanceport` | none | (optional) Deprecated.
`nodeagent` | none | (required if `action` is `create`, otherwise ignored) The name of the node agent on which the instance is being created.
`cluster` | none | (optional, applicable only if `action` is `create`) The clustered instance to be created. The server’s configuration is inherited from the named cluster. The `config` and `cluster` attributes are mutually exclusive. If both are omitted, a stand-alone server instance is created.
`config` | none | (optional, applicable only if `action` is `create`) The configuration for the new stand-alone instance. The configuration must exist and must not be `default-config` (the cluster configuration template) or an already referenced stand-alone configuration (including the administration server configuration `server-config`). The `config` and `cluster` attributes are mutually exclusive. If both are omitted, a stand-alone server instance is created.
`property` | none | (optional, applicable only if `action` is `create`) Defines system properties for the server instance. These properties override port settings in the server instance’s configuration. The following properties are defined: `http-listener-1-port`, `http-listener-2-port`, `orb-listener-1-port`, `SSL-port`, `SSL_MUTUALAUTH-port`, `JMX_SYSTEM_CONNECTOR_port`. System properties can be changed after instance creation using the system property commands. For details, see the Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Reference Manual.
`user` | `admin` | (optional) The username used when logging into the application server administration instance. This attribute is inherited by nested `server` elements.
`password` | none | (optional) Deprecated, use `passwordfile` instead. The password used when logging into the application server administration instance. This attribute is inherited by nested `server` elements.
`passwordfile` | none | (optional) File containing passwords. The password from this file is retrieved for communication with the application server administration instance. This attribute is inherited by nested `server` elements. If both `password` and `passwordfile` are specified, `passwordfile` takes precedence.
`host` | `localhost` | (optional) Target server. If it is a remote server, use the fully qualified hostname. This attribute is inherited by nested `server` elements.
`port` | `4849` | (optional) The administration port on the target server. This attribute is inherited by nested `server` elements.
`instance` | name of default instance | (optional) Target application server instance. This attribute is inherited by nested `server` elements.
`asinstalldir` | see description | (optional) The installation directory for the local Application Server installation, which is used to find the administrative classes. If not specified, the command checks to see if the `asinstalldir` parameter has been set. Otherwise, administrative classes must be in the system classpath.
`sunonehome` | see description | (optional) Deprecated. Use `asinstalldir` instead.

- Previous: Subelements
- Next: Examples

- © 2010, Oracle Corporation and/or its affiliates