Task: jbi-list-service-assemblies

Description

This task prints the information about service assemblies.

Example Output

========================================
    List of Service Assemblies
========================================
Name       : ant_test_service_assembly_1
State      : Started
Description: This is an Ant test service asssembly which deploys the service units to ant test engine and binding.

Service units in this service assembly [2]
  Service unit : ant_test_binding_1_su1
    State      : Started
    Deployed on: ant_test_binding1
    Description: This is an su for the ant test binding1

  Service unit : ant_test_engine_1_su2
    State      : Started
    Deployed on: ant_test_engine1
    Description: This is an su for the ant test engine1
----------------------------------------

Parameters

Attribute Description Required
host The machine name where the Domain Administration Server (DAS) is running. The default value is localhost. No
port The HTTP/S port for DAS administration. The default value is 4848. No
secure If set to true, uses SSL/TLS to communicate with the DAS. No
username The authorized DAS administrator user name. Yes
password Specifies a password for user authentication.

If you set a password with both the password attribute and the passwordfile attribute, the password specified in the passwordfile attribute is used for authentication.

If you do not set a password with both the password attribute and the passwordfile attribute, then no password is required.
Yes. Not required if passwordfile is set.
passwordfile Specifies a path to a password property file that is used for user authentication.

The password for user authentication is specified by the "AS_ADMIN_PASSWORD" property in the property file.

If you set a password with both the password attribute and the passwordfile attribute, the password specified in the passwordfile attribute is used for authentication.
No
failOnError Signal task failure to Ant. The default value is "true". No
xmlOutput Property name to save the list output in xml format. If set, the task will not output the formatted text output, but sets the property value with the list output in xml format. No
serviceAssemblyName If supplied, only the named service assembly is reported. If the service assembly doesn't exist, an empty list is reported. No
state Lists the service assemblies that are in the specified state.
Without this parameter, service assemblies with any state will be listed.
Valid states are : "started", "stopped" and "shutdown".
No
componentName Lists the service assemblies that have service units deployed to this component.
Without this parameter, all the service assemblies in the system will be listed.
No
target Specifies where the JBI administration tasks are performed. The default value is 'server'. No

Target Attribute Values

Target Attribute Value Behavior
'server' When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
'domain' When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
<cluster-name> When a <cluster-name> is specified, the task is executed against all instances in the specified cluster.
<instance-name> When a <instance-name> is specified, the task is executed against the specific instance specified.

Examples

<!--
Load JBI task definitions.
Note:  If you use the asant command, you do not need to load the JBI task defininitions
as they are already defined in the default task definitions in the asant environment.
-->
<taskdef resource="com/sun/jbi/ui/ant/antlib.xml" />
<!-- list service assemblies ina the target "domain" -->
<jbi-list-service-assemblies host="localhost" port="7890" target="domain" /> 
<!-- list service assemblies for the engine with name="my_engine_name" -->
<jbi-list-service-assemblies componentName="my_engine_name" />

Copyright 2007, Sun Microsystems, Inc.