JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Management and Monitoring APIs     Java CAPS Documentation
search filter icon
search icon

Document Information

Java CAPS Management and Monitoring APIs

Java CAPS Management Client

JavaDocs

Targets

Getting Started Using APIs

To Start Using APIs to Create Applications

Connecting to the Server Through APIs

Connection Type Definition

CAPSManagementClientFactory Definition

The Alert Management API

Support for Databases

AlertConfigurationService

AlertNotificationService

Services -- JavaCAPSManagementAPI

Administration Service

Runtime Management Service

Configuration Service

Deployment Service

Installation Service

Performance Measurement Service

Alert Management Service

Alert Administration Service

Alert Notification Service

Alert Configuration Service

JMS Management Service

Log Management Service

BPEL Management Service

Master Data Management (MDM) Service

Java CAPS Adapters Management Service

Target Option Behavior for the Management Client

Writing Java Code to Access APIs Using Java Code Samples

Setting Up Databases

To Set Up a Database Using Enterprise Manager

To Set Up a Database Using a Scripting Utility

Using Oracle and Other Databases for Alert Persistence

To Set Up an Oracle Database for Alert Persistence

Oracle Script Examples

Setting Up Scripting Engines

Downloading, Installing, and Setting Up A Scripting Environment

Setting Up a Scripting Environment to Invoke Java CAPS Management and Monitoring APIs

To Modify the Environment Variables in env.bat

Using a Scripting Language to Exercise the Java CAPS Management and Monitoring APIs

Exercising the Administration Service

Exercising the Administration Service in Groovy

Exercising the Configuration Service

Exercising the Configuration Service in Groovy

Exercising the Deployment Service

Exercising the Deployment Service in Groovy

Exercising the Installation Service

Exercising the Installation Service in Groovy

Exercising the Runtime Management Service

Exercising the Runtime Management Service in Groovy

Exercising the JMS Management Service

Exercising the JMS Management Service in Groovy

Exercising the BPEL Management Service

Exercising the BPEL Management Service in Groovy

Exercising the HTTP Administration Service

Exercising the HTTP Administration Service in Groovy

Exercising the Notification Service

Exercising the Notification Service in Groovy

JRuby Integrated into NetBeans IDE

To Create a JRuby Project

Services — JavaCAPSManagementAPI

Currently there are ten Java CAPS Management Client API services:

There is also a Target option. It's behavior for the Java CAPS Management Client is also part of Services. Depending upon the values you specify, this option causes the install and deploy commands to behave differently. For details, see Target Option Behavior for the Management Client.


Note - The sample files for the services (for example: AdministrationServiceSample.groovy) and the Target option behavior are zipped, and are included with the Java CAPS 6 delivery.


Administration Service

The Administration Service enables

Table 2 Administration Service Method Names and Descriptions

API Method Name
Description
getComponentInstallationDescriptor
Retrieves the jbi.xml deployment descriptor for the component.
getSharedLibraryInstallationDescriptor
Retrieves the jbi.xml deployment descriptor for the shared library.
getServiceAssemblyDeploymentDescriptor
Retrieves the jbi.xml deployment descriptor for the service assembly.
getServiceUnitDeploymentDescriptor
Retrieves the jbi.xml deployment descriptor for the service unit.
isJBIRuntimeEnabled
Checks to see if the JBI Runtime is enabled.
isServiceEngine
Checks for the ServiceEngine.
isBindingComponent
Checks for the BindingComponent.
getConsumingEndpoints
Retrieves the list of consuming endpoints for a component.
getProvisioningEndpoints
Retrieves the list of provisioning endpoints for a component.
getWSDLDefinition
Retrieves the primary WSDL associated with the specified endpoint.
getWSDLImportedResource
Retrieves the WSDL or XSD associated with the specified endpoint and targetNamespace.
isClassicEnterpirseManagerUp
Checks to see if the Enterprise Manager server for non JBI based components is running.

Runtime Management Service

The Runtime Management Service:

Table 3 Runtime Management Service Method Names and Descriptions

API Method Name
Description
isTargetUp
Checks to see if the target (server, cluster) is up or down.
listServiceEngines
Lists the service engines.
listBindingComponents
Lists the binding components.
listSharedLibraries
Lists the shared libraries.
listServiceAssemblies
Lists the service assemblies.
showServiceEngine
Shows the service engine conforming to various options.
showBindingComponent
Shows the binding component conforming to various options.
showSharedLibrary
Shows the shared library conforming to various options.
showServiceAssembly
Shows the service assembly conforming to various options.
listComponents
Retrieves a list of components.
getState
Retrieves the state of the runtime component (such as UP/DOWN/UNKNOWN/etc.).
getProperties
Retrieves a list of the component's properties.
startComponent
Starts the component.
stopComponent
Stops the component.
restartComponent
Restarts the component.
shutdownComponent
Shuts down the component.
startServiceAssembly
Starts service assembly.
stopServiceAssembly
Stops the service assembly.
shutdownServiceAssembly
Shuts down the service assembly.
listCompositeApplications
Retrieves a list of composite applications.
getRuntimeComponentProperties
Obtains a list of the runtime unit's properties.
getRuntimeComponentStatus
Obtains the state of the runtime component, that is, UP/DOWN/UNKNOWN/etc.
startRuntimeComponent
Starts the runtime component.
restartRuntimeComponent
Restarts the runtime component.
stopRuntimecomponent
Stops the runtime component.
listTargets
Returns all deployable targets in this domain. All groups and all servers (servers that are not part of any groups).
listLifecycleModules
Lists the lifecycle modules.
listExtensionModules
Lists the extension modules.
listSystemConnectors
Lists the system connectors modules.
listAppclientModules
Returns all deployed modules of specified type and on specified target.
listConnectorModules
Returns an array of deployed connectors.
listEjbModules
Returns all deployed modules of specified type and on specified target.
listWebModules
Returns all deployed modules of specified type and on specified target.
listJavaEEApplications
Returns a list of deployed JavaEE Applications. These are the applications that are deployed to a domain, and are registered under.
enableJavaEEApplication
Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled.
enableAppclientModule
Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled.
enableConnectorModule
Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled.
enableEjbModule
Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled.
enableWebModule
Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled.
disableJavaEEApplication
Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled.
disableAppclientModule
Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled.
disableConnectorModule
Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled.
disableEjbModule
Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled.
disableWebModule
Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled.
isJavaEEComponentEnabled
Returns the status of the application as in configuration. If the specified target is null/blank/"domain", only the enabled flag of the actual application is used. Otherwise, the enabled flag of the application reference is used to determine the enabled status.

Configuration Service

The Configuration Service enables you:

Table 4 Configuration Service Method Names and Descriptions

API Method Name
Description
getRuntimeLoggerLevels
Retrieves all the runtime loggers and their levels.
getRuntimeLoggerLevel
Looks up the level of one runtime logger.
setRuntimeLoggerLevel
Sets the log level for a given runtime logger.
getComponentLoggerLevels
Retrieves the component custom loggers and their levels.
setComponentLoggerLevel
Sets the component log level for a given custom logger
getComponentExtensionMBeanObjectNames
Retrieves the extension MBean object names.
getComponentConfiguration
Retrieves the component configuration.
setComponentConfiguration
Sets the component configuration.
getRuntimeConfigurationMetaData
Returns the runtime configuration metadata associated with the specified property. The metadata contain name-value pairs like default, descriptionID, descriptorType, displayName, displayNameId, isStatic, name, resourceBundleName, tooltip, tooltipId, and so on.
setRuntimeConfiguration
Sets the runtime configuration.
getRuntimeConfiguration
Retrieves the runtime configuration.
getDefaultRuntimeConfiguration
Retrieves the default runtime configuration.
isServerRestartRequired
Checks if the server needs to be restarted to apply the changes made to some of the configuration parameters.

Deployment Service

The Deployment Service enables you to deploy and undeploy:

Table 5 Deployment Service Method Names and Descriptions

API Method Name
Description
deployServiceAssembly
Deploys the service assembly.
deployServiceAssemblyFromDomain
Deploys the service assembly from the domain target.
undeployServiceAssembly
Undeploys the service assembly.
deployJavaEEComponent
Deploys a component to the given array of targets which can be domains, clusters, or standalone instances. Since there are restrictions around how clusters and standalone instances share deployments, the component bits are deployed only to the first target in the list and then application references are created for the rest of the targets in the array specified.
undeployJavaEEComponent
Undeploys a component to the given array of targets which can be domains, clusters, or standalone instances. Since there are restrictions around how clusters and standalone instances share deployments, the application references are removed for all the targets except for the first one in the array. After this, the component bits are undeployed from the first target in the array.

Installation Service

The Installation Service enables you to:

Table 6 Installation Service Method Names and Descriptions

API Method Name
Description
installComponent
Installs the component (service engine, binding component).
uninstallComponent
Uninstalls the component (service engine, binding component).
installSharedLibrary
Installs the shared library.
uninstallSharedLibrary
Uninstalls the shared library.
installComponentFromDomain
Installs the component (service engine, binding component) from the domain target.
installSharedLibraryFromDomain
Installs the shared library from domain target.
upgradeComponent
Upgrades the component (service engine, binding component). Upgrades a component in a way that actually involves the component. During the upgrade processing, the component's implementation of the new upgrade SPI is invoked to give the component the opportunity to perform any special processing necessary to complete the upgrade. Components which do not provide an implementation of the upgrade SPI can still be updated using the updateComponent API. Also, in the upgrade implementation, changes in the component's installation descriptor are allowed, with the exception of the component name (for obvious reasons). This allows new shared library dependencies, changes to the class names of the component's SPI implementations, and changes to the component's class loading preferences (class path and class loading order). These changes are allowed regardless of whether or not the component provides an implementation of the new upgrade SPI.

Performance Measurement Service

The Performance Measurement Service attempts to address performance characterization for developers and administrators.

Table 7 Performance Measurement Service Method Names and Descriptions

API Method Name
Description
clearPeformaceInstrumentationMeasurement
Resets the performance measurements on the endpoint.
getPerformanceInstrumentationEnabled
Retrieves the performance measurement enabling flag.
getPerformanceInstrumentationMeasurement
Retrieves the performance measurement data for the specified endpoint.
getPerformanceMeasurementCategories
Retrieves the performance statistics categories. Each item in the array is the key to the composite performance data, which also indicates the type of measurement, such as normalization.
setPerformanceInstrumentationEnabled
Sets the performance measurement enabling flag.
getFrameworkStatisticsAsTabularData
This method is used to provide JBIFramework statistics in the given target. Data is displayed in tabular format.
getFrameworkStatistics
This method is used to provide JBIFramework statistics in the given target.
getComponentStatistics
This method is used to provide statistics for the given component in the given target.
getComponentStatisticsAsTabularData
This method is used to provide statistics for the given component in the given target. Data is displayed in tabular format.
getEndpointStatisticsAsTabularData
This method is used to provide statistic information about the given endpoint in the given target. Data is displayed in tabular format.
getEndpointStatistics
This method is used to provide statistic information about the given endpoint in the given target.
getNMRStatisticsAsTabularData
This method is used to provide statistics about the message service in the given target. Data is displayed in tabular format.
getNMRStatistics
This method is used to provide statistics about the message service in the given target.
getServiceAssemblyStatisticsAsTabularData
This method is used to provide statistics about a Service Assembly in the given target. Data is displayed in tabular format.
getServiceAssemblyStatistics
This method is used to provide statistics about a Service Assembly in the given target.
enableMessageExchangeMonitoring
This method is used to enable monitoring of timing information about message exchanges.
disableMessageExchangeMonitoring
This method is used to disable monitoring of timing information about message exchanges.

Alert Management Service

Table 8 Alert Management Service Method Names and Descriptions

API Method Name
Description
getAlertAdministrationService
Creates and returns Alert Administration Service.
getAlertConfigurationService
Creates and returns Alert Configuration Service.
getAlertNotificationService
Creates and returns Alert Notification Service.

Alert Administration Service

Table 9 Alert Administration Service Method Names and Descriptions

API Method Name
Description
getAlerts
Retrieves all alerts.
getAlertFieldNames
Retrieves a list of AlertInstance database fieldNames.
update
Updates the field's value based on criteria.
delete
Deletes the alert object from persistence storage.
observe
Sets the list of AlertInstance's observationState to observed.
resolved
Sets AlertInstance's observationState to resolved based on a criteria.
reset
Sets the list of AlertInstance's observationState to its initial state, which is unobserved.
UpdateComment
Updates the comment field of the alert.
resetAll
Sets the observationState to its initial state for all the table entries.
resolveAll
Sets Alert observationState to resolved state for all the table entries.
observeAll
Sets Alert observationState to observed state for all the table entries.

Alert Notification Service

Table 10 Alert Notification Service Method Names and Descriptions

API Method Name
Description
subscribe
Requests the event management system to get an event that satisfies the filter provided. The method will validate the call-back object for the call-back method name and parameter (see below for more information). This method enables the caller to register multiple times with different filtering, target, and call-back parameters.
unsubscribe
Requests the event management system to stop forwarding events to this client based on the subscription the caller made using the subscribe method. Once all the callers unsubscribe all the IDs, any events that are waiting to be delivered to this client are discarded.
getSubscriptionInformation
Utility method that returns the parameters the client used to subscribe for alerts for the given subscription ID.

Alert Configuration Service

Table 11 Alert Configuration Service Method Names and Descriptions

API Method Name
Descriptions
enableAlertsPersistence
Enables alerts persistence in the alerts database. Enabling provides reliable alerts delivery in case of delivery channel failure or application server restart.
disableAlertsPersistence
Disables alerts persistence in the alerts database.
isAlertsPersistenceEnabled
Returns the last setting of the alert persistence enabling operation. True if enabled, otherwise false.
isAlertsJournalEnabled
Returns the last setting of the alert journal enabling operation. True if enabled, otherwise false.
setPersistenceDataSourceJndiName
Sets the JNDI name of the data source database to be used for persistence. If not provided at least once the persistence will be disabled even if enableAlertsPersistence is set to true.
getPersistenceDataSourceJndiName
Returns the last set JNDI name for the alert persistence data source.
setPersistenceDataBaseType
Sets the database type to be used for persistence. Derby is the assumed default database. If a different database is used, this method should be called prior to enabling the persistence.
getPersistenceDataBaseType
The return value represents the last set DB type.
setPersistedAlertsMaxAge
Sets the maximum time a persisted alert is stored in the alert database before it is deleted as part of the removal policy.
getPersistedAlertsMaxAge
Returns the last setting for the allowed persisted alert age. A value of 0 current time could cause all persisted alerts to be deleted. When a negative value is used this policy element is ignored.
setPersistedAlertsMaxCount
Sets the maximum number of alerts allowed to be persisted before an alert is deleted as part of the removal policy in effect. If persistence is on and the count set to zero, it negates journaling being on.
getPersistedAlertsMaxCount
Returns the last setting for the maximum of alerts allowed to be persisted. A value of 0 means no alerts are persisted.
setPersistedAlertsLevel
The priority based alert level that is part of the removal policy. The priorities are as follows (from low to high): INFO, WARNING, MINOR, MAJOR, CRITICAL, and FATAL. All alerts from the provided level and below will be candidates for removal.
getPersistedAlertsLevel
The returned value represents the last setting for the level of alerts that are allowed to be removed from persistence for each target.
setPersistedAlertsRemovelPolicy
Sets the effective policy for the removal of persisted alerts.
getPersistedAlertsRemovalPolicy
Returns the return value representing an array of the last setting the policy used when persisted alerts are to be removed. An empty array means no policy is enforced.
enablePersistedAlertsPolicyExecution
Enables or disables the ability to use the removal policy.
isPersistedAlertsPolicyExecutionEnabled
The returned value represents the last setting that enables/disables the persisted alerts removal policy.
setPersistedAlertsRemovelPolicyExecInterval
Sets how often the persisted alerts removal policy is executed.
getPersistedAlertsRemovelPolicyExecInterval
Returns the returned value representing The last interval setting of the persisted alerts removal policy is executed.
setInMemoryAlertsCacheMaxSize
Sets the maximum number of alerts that can be cached in memory prior to being delivered to the registered listeners.
getInMemoryAlertsCacheMaxSize
Returns the returned value representing the last setting of the maximum size of memory in the alerts cache.
setAlertTableName
Sets the persisted alerts table name.
getPersistedAlertsCount
Returns the total number of alerts currently persisted. This value is volatile and could change.
enableAlertsPersistence
This API enables the caller to set all the parameters defined in the other APIs in this interface. All the settings are applied prior to enabling the persistence.

JMS Management Service

Table 12 JMS Management Service Method Names and Descriptions

API Method Name
Description
getServerProperties
Returns the server properties.
isServerReady
Checks if the message server is ready.
getXids
Returns a list of transactions on the message server.
rollbackXid
Rolls back a specified transaction on the message server.
getTopicProperties
Retrieves the specified topic properties.
getTopics
Retrieves the list of topics on the message server.
getTopicsWithHeaders
Returns a list of topics with header properties on the message server.
getTemporaryTopics
Retrieves a list of temporary topics.
createTopic
Creates a new specified topic with the specified name on the message server.
deleteTopic
Deletes a specified topic on the message server.
getTopicMessage
Returns a message body of a specified message of a specified topic.
getTopicMsgProperties
Returns the specified topic message properties.
getTopicMsgPropertiesList
Returns a list of messages with the properties for the given start message index.
getSubscribers
Returns a list of subscribers for a specified topic.
changeTopicTextMessage
Changes the content of a specified text message of a specified topic.
changeTopicBytesMessage
Changes the content of a specified bytes message of a specified topic.
deleteTopicMessage
Deletes a specified message from a specified topic.
getTopicMessageType
Returns the message type of a specified message from a specified topic.
suspendTopic
Suspends a specified topic.
resumeTopic
Resumes the suspended topic.
submitNewMessage
Submits a new message to a specified topic or queue on the message server.
createTopicDurableSubscriber
Creates a new specified topic durable subscriber for a specified topic on the message server.
unsubscribeDurableSubscriber
Unsubscribes a specified durable subscription on the message server.
republishTopicMessage
Resends a specified journalled message to a specified queue on the message server.
getTopicStatistics
Returns the statistics of a specified topic on the message server.
getQeueueProperties
Retrieves the queue properties.
getQueues
Retrieves the list of queues on the message server.
getQueuesWithHeaders
Returns a list of queues with header properties on the message server.
getTemporaryQueues
Retrieves the list of temporary queues.
createQueue
Creates a new queue with the specified name on the message server.
deleteQueue
Deletes a specified queue on the message server.
getQueueMsgProperties
Returns the specified topic message properties.
getQueueMsgPropertiesList
Returns a list of messages with its properties for the given start message index.
getQueueMessage
Returns a message body of a specified message of a queue.
getReceivers
Returns a list of receivers for a specified queue.
changeQueueTextMessage
Changes the content of a specified text message of a queue.
changeQueueBytesMessage
Changes the content of a specified bytes message of a specified queue.
deleteQueueMessage
Deletes a specified message from a specified queue.
getQueueMessageType
Returns the message type of a specified message of the queue.
suspendQueue
Suspends a specified queue.
resumeQueue
Resumes the suspended queue.
resendQueueMessage
Republishes a specified journalled message to a specified topic on the message server.
getQueueStatistics
Returns the statistics of a specified queue on the message server.

Log Management Service

Table 13 Log Management Service Method Names and Descriptions

API Method Name
Description
getLogString
Reads the page, filter, and search log. Returns only the lines prepared as a single String without any other metadata.
getLog
Reads, filters, and searches a page of lines from the log; the lines are returned in a Map.
getLogAsString
Logs, filters, and searches a page of lines from the log; the lines are prepared as one string.
listLoggerNames
Lists the names of loggers registered with the target.
listLoggerObjectNames
List the names of loggers registered with the target.
isLoggerRegistered
Asks if the logger instance is registered with the target server instance.
registerLogger
Registers a logger instance with the target server instance.
unregisterLogger
Unregisters a logger instance with the target server instance.
setLogFile
Set the logger file name.
getLogFile
Obtains the logger file name.

BPEL Management Service

The BPEL Management Service supports two types of API method names:


Note - These APIs are in addition to the APIs exposed for BPEL from the configuration service.


Table 14 BPEL Management Service API Method Names and Descriptions (non-JBI Based Components)

API Method Name
Description
getBPELInstances
Obtains BPEL instances given optional BPEL process QName and/or an optional BPStatus or an optional instance ID. If instanceId is present, the BPEL process QName and BPStatus are ignored. The maximum instances to return is 1000, user specifies a lower number for maxRecords to limit the number of the instances returned. If the BPInstanceQueryResult.overflow is true, it indicates the number of qualifying instances is larger than 1000, no instances are returned in the result list, user should specify a maxRecords (<= 1000) and sortColumn and order.
getBPELInstanceActivityStatus
Obtains the list of ActivityStatus of a BPEL instance.
getBPELProcessIds
Obtains the list of BPEL process QName as String within a service unit.
getBPELInstanceFault
Obtains the fault detail of a faulted BPEL instance.
getInvokerInstance
Obtains the list of an invoker (parent) BPEL instance(s) that invoked a specific bpel instance
getInvokeeInstance
Obtains the list of invokee (sub) BPEL instance(s) that a specific BPEL instance invoked.
isMonitoringEnabled
Asks if Monitoring is enabled.
isPersistenceEnabled
Asks if Persistence is enabled.
resumeInstance
Resumes a Business Process Instance for a given Business Process Instance.
terminateInstance
Terminates a Business Process Instance for a given Business Process Instance
suspendInstance
Suspends a Business Process Instance for a given Business Process Instance
getBPELInstanceFault
Obtains the fault detail of a faulted BPEL instance.
suspendAllInstance
Suspends all instances of a BPEL process.
resumeAllInstance
Resumes all instances of a BPEL process.
terminateAllInstance
Terminates all instances of a BPEL process.
changeVariableValue
Changes the BPEL variable value. Note that, only the leaf node can be changed.
getVariableValue
Obtains the BPEL variable value. The content of the BPEL variable is returned.
listBPELVaraibles
Obtains the BPEL variable information for a BPEL instance.

Table 15 BPEL Management Service API Method Names and Descriptions (JBI Based Components)

API Method Name
Description
setBusinessProcessInstanceVariableValue
Sets the value for the property using XPath on a Part given a business process instance, container, part, the XPath expression, and value.

Master Data Management (MDM) Service

This API service provides the capability to integrate and manage data and applications in a complex and distributed enterprise business environment, including the following data management products:

Table 16 Master Index Management (MDM) Service API Method Names and Descriptions

API Method Name
Description
listApplicationNames
Returns a list of MDM Applications that are currently deployed.
getApplicationStatus
Returns the status of MDM Applications.
getDatabaseStatus
Returns the status of the Database connection.
getWebModuleStatus
Returns the status of the MDM Web Application Module.

Java CAPS Adapters Management Service

Table 17 Java CAPS Adapters Management Service API Method Names and Descriptions

API Method Name
Description
start
Starts the component; the semantics of this operation is left to the implementation.
restart
Restarts the component; the semantics of this operation is left to the implementation.
stop
Stops the component; the semantics of this operation is left to the implementation.
getStatus
Returns the status.
getProperties
Returns the properties.
isStartable
Determines whether a "start" button would be presented to the user.
isRestartable
Determines whether a "restart" button would be presented to the user.
isStoppable
Determines whether a "stop" button would be presented to the user.
getType
Returns the type of the adapter—monitored component.
getConfiguration
Returns the adapter—monitored component's configuration.
getState
Returns the state of the adapter—monitored component.
getTargetState
Returns the target state of the adapter—monitored component. This is the state that the adapter component is or was changing to. This status may be different from that returned by getState().
getRAConfiguration
Returns the adapter's metadata details.

Target Option Behavior for the Management Client

The --target option causes the install and deploy commands to behave differently. Depending upon the option value specified, these differences can be radical.


Note - Two of the target option names are constant: “server” and “domain.” They represent an instance of an operator and are replaceable with a name specific to the current template.


Table 18 Target Option Value and Behavior

Option Value
Behavior
server
The command is executed against the embedded domain administration server (DAS) instance.
domain
When the target option is the literal string domain, the component is executed against the domain itself, but not to any instances or clusters running on the domain. This option value is only applicable for install or deploy commands.
cluster name
When a cluster name is specified, the command is executed against all instances in the specified cluster.
instance name
When an instance name is specified, the command is executed against the specific instance specified.