# IBM WebSphere Application Server Plugin Manual

## Preface

This document describes the functionality provided by the IBM WebSphere Application Server (WAS) plugin.

Refer to the XL Deploy Reference Manual for background information on XL Deploy and deployment concepts.

## Overview

The WAS plugin is a XL Deploy plugin that adds capability for managing deployments and resources on an existing WebSphere application server. It offers out-of-the-box support for deploying and undeploying application artifacts, datasources, JMS resources, and other Java EE resources and WAS configurations. See the Features section for more information.

The plugin can be extended to support more deployment options or management of new artifacts and resources on WAS.

## Features

- Deploys and undeploys Java EE application artifacts:
  - Enterprise applications (EAR)
  - Web applications (WAR)
  - Enterprise JavaBeans (EJB JAR)
- Updates global web server plug-in configuration
- Creates, updates, and removes Java EE resources:
  - JMS resources
    - V5 default JMS resources: queues, topics and connection factories
    - WebSphere MQ JMS resources: queues, topics, connection factories and activation specifications
    - SIB JMS resources: queues, topics, connection factories and destinations
    - Custom JMS providers
  - JDBC resources
    - JDBC providers: Oracle, OracleXa or custom
    - Data sources: DB2 (type 2 and 4), Oracle, MsSql and Derby
  - J2C resources
    - Resource adapters, J2C connection factories, J2C activation specification and J2C admin objects
  - Asynchronous beans
    - Timer managers
    - Work managers
  - Schedulers
  - Cache instances
    - Servlet cache instances
  - Mail
    - Mail providers
    - Mail sessions
  - URL
    - URL providers
    - URLs
  - Resource environment
    - Resource environment providers
    - Resource environment entries
- Creates, updates, and removes WAS configuration elements:
  - Shared libraries
  - Virtual hosts
  - Name space bindings
  - Core groups
  - Service Integration Buses
  - WebSphere variables
  - Health policies
  - Service policies
- Configures application server components
  - Session management
  - Application server settings
  - Web container settings
  - EJB container setting
  - Container services
    - Transaction service
    - ORB service
  - Message listener
    - Thread pools
    - Listener ports
  - Java and process management
  - Administration
    - Custom properties
    - Custom services
  - Ports
  - Performance Monitoring Infrastructure (PMI)
  - Logging and tracing
- Discovers WAS topologies: cells, nodes, clusters, server, web servers
- Discovers all Java EE and WAS configuration resources
- Controls the state of cells, nodes, clusters and servers
- Creates clusters and servers from template

## Requirements

- XL Deploy requirements
  - XL Deploy: version 4.5.0+
  - IBM WebSphere Application Server Standard and Network Deployment: 6.1, 7.0, 8.0 and 8.5 (Unix and Windows)
  - Other XL Deploy Plugins: None

## Usage in deployment packages

The plugin works with the standard deployment package (DAR) format. Please see the Packaging Manual for more information about the DAR format and how to compose one.

The following is a sample `deployit-manifest.xml` file that can be used to create a WebSphere-specific deployment package. It contain declarations for an EAR, an Oracle datasource spec, and JMS resources.

    <?xml version="1.0" encoding="UTF-8"?>
    <udm.DeploymentPackage version="1.0-was" application="PetClinic">
        <deployables>
            <jee.Ear name="petClinic-1.0.ear" file="petClinic-1.0.ear">
            </jee.Ear>
            <was.OracleDatasourceSpec name="sampleOracleDatasource">
                <jndiName>jdbc/sampleOracleDatasource</jndiName>
                <jdbcProvider>Oracle JDBC Driver</jdbcProvider>
                <username>{{DATABASE_USERNAME}}</username>
                <password>{{DATABASE_PASSWORD}}</password>
                <datasourceHelperClassname>com.ibm.websphere.rsadapter.Oracle10gDataStoreHelper</datasourceHelperClassname>
            </was.OracleDatasourceSpec>
            <was.SibQueueDestinationSpec name="sampleSibQueueDestination">
                <busName>sampleSIBus</busName>
            </was.SibQueueDestinationSpec>
            <was.SibQueueSpec name="sampleSibQueue">
                <busName>sampleSIBus</busName>
                <description>sample sib queue</description>
            </was.SibQueueSpec>
        </deployables>
    </udm.DeploymentPackage>

## Using the deployables and deployeds

The following table shows the possible containers a deployable can be targeted to and the deployed that will be created as a result.

## Deployable vs. containers table

Deployable | Containers | Deployed
--- | --- | ---
jee.Ear or was.Ear jee.War or was.War jee.EjbJar or was.EjbJar | was.UnmanagedServer was.ManagedServer was.Cluster | was.EarModule was.WarModule was.EjbJarModule
was.SharedLibrarySpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.SharedLibrary
was.VirtualHostSpec | was.UnmanagedServer was.DeploymentManager | was.VirtualHost
was.V5DefaultQueueSpec was.V5DefaultQueueConnectionFactorySpec was.V5DefaultTopicSpec was.V5DefaultTopicConnectionFactorySpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.V5DefaultQueue was.V5DefaultTopic was.V5DefaultQueueConnectionFactory was.V5DefaultTopicConnectionFactory
was.WmqQueueSpec was.WmqQueueConnectionFactorySpec was.WmqTopicSpec was.WmqTopicConnectionFactorySpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.WmqQueue was.WmqQueueConnectionFactory was.WmqTopic was.WmqTopicConnectionFactory
was.SibQueueSpec was.SibQueueConnectionFactorySpec was.SibQueueDestinationSpec was.SibTopicSpec was.SibTopicConnectionFactorySpec was.SibTopicSpaceDestinationSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.SibQueue was.SibQueueConnectionFactory was.SibQueueDestination was.SibTopic was.SibTopicConnectionFactory was.SibTopicSpaceDestination
was.GenericJmsQueueSpec was.GenericJmsTopicSpec was.GenericJmsQueueConnectionFactorySpec was.GenericJmsTopicConnectionFactorySpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.GenericJmsQueue was.GenericJmsTopic was.GenericJmsQueueConnectionFactory was.GenericJmsTopicConnectionFactory
was.J2CResourceAdapterSpec was.J2CAdminObjectSpec was.J2CActivationSpecificationSpec was.J2CConnectionFactorySpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.J2CResourceAdapter was.J2CAdminObject was.J2CActivationification was.J2CConnectionFactory
was.DB2Type2DatasourceSpec was.DB2Type4DatasourceSpec was.OracleDatasourceSpec was.MsSqlDatasourceSpec was.DerbyDatasourceSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.DB2Type2Datasource was.DB2Type4Datasource was.OracleDatasource was.MsSqlDatasource was.DerbyDatasource
was.JaasAliasSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.JaasAlias
was.JdbcProviderSpec was.OracleJdbcProviderSpec was.OracleXaJdbcProviderSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.JdbcProvider was.OracleJdbcProvider was.OracleXaJdbcProvider
was.ListenerPortSpec | was.UnmanagedServer was.ManagedServer | was.ListenerPort
was.ThreadPoolSpec | was.UnmanagedServer was.ManagedServer | was.ThreadPool
was.WorkManagerProviderSpec was.WorkManagerSpec was.TimerManagerSpec was.SchedulerSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.WorkManagerProvider was.WorkManager was.TimerManager was.Scheduler
was.ResourceEnvironmentEntrySpec was.ResourceEnvironmentProviderSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.ResourceEnvironmentEntry was.ResourceEnvironmentProvider
was.ServicePolicySpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.ServicePolicy
was.VariableSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.Variable
was.CustomServiceSpec | was.UnmanagedServer was.ManagedServer | was.CustomService
was.StringNameSpaceBindingSpec was.IndirectNameSpaceBindingSpec was.EjbNameSpaceBindingSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.StringNameSpaceBinding was.IndirectNameSpaceBinding was.EjbNameSpaceBinding
was.ServletCacheInstanceSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.ServletCacheInstance
was.MailProviderSpec was.MailSessionSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.MailProvider was.MailSession
was.URLProviderSpec was.URLSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.URLProvider was.URL
was.HealthPolicySpec was.HealthPolicyMembershipSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.HealthPolicy was.HealthPolicyMembership
was.KeystoreSpec was.SSLConfigSpec | was.UnmanagedServer was.DeploymentManager | was.Keystore was.SSLConfig
was.KeystoreFile | overthere.Host | was.CopiedKeystoreFile
was.SiBusSpec was.SiBusMemberSpec | was.UnmanagedServer was.DeploymentManager | was.SiBus was.SiBusMember
was.ApplicationServerSpec was.ServerPortSpec was.ORBServiceSpec was.TransactionServiceSpec was.EJBContainerSpec was.WebContainerSpec was.PMIServiceSpec was.JavaProcessDefinitionSpec was.LoggingAndTracingSpec was.CoreGroupServiceSpec was.ServerSessionManagerSpec was.TransportChainSpec | was.UnmanagedServer was.ManagedServer | was.ApplicationServer was.ServerPort was.ORBService was.TransactionService was.EJBContainer was.WebContainer was.PMIService was.JavaProcessDefinition was.LoggingAndTracing was.CoreGroupService was.ServerSessionManager was.TransportChain
was.FileSynchronizationServiceSpec | was.NodeAgent | was.FileSynchronizationService
was.CustomPropertiesSpec | was.UnmanagedServer was.ManagedServer was.Cluster was.NodeAgent was.DeploymentManager | was.CustomProperties
was.CoreGroupSpec | was.DeploymentManager | was.CoreGroup

## Deployed actions table

The following table shows the actions taken when creating, modifying, or destroying a deployed.

Deployed | Create | Modify | Destroy
--- | --- | --- | ---
was.DB2Datasource was.DB2Type2Datasource was.DB2Type4Datasource was.OracleDatasource was.MsSqlDatasource was.DerbyDatasource | If username and password properties are specified: Create J2C Authentication data Push authentication data to runtime | If username and password properties are specified: Update J2C Authentication data Push authentication data to runtime | If username and password properties were specified: Destroy J2C Authentication data Push authentication data to runtime
was.EarModule was.WarModule was.EjbJarModule | Deploy application WAS ND only: Synchronize applicable nodes Start application | Stop application Undeploy application WAS ND only: Synchronize applicable nodes Deploy application WAS ND only: Synchronize applicable nodes Start application | Stop application Undeploy application WAS ND only: Synchronize applicable nodes
was.JaasAlias | Create J2C Authentication data Push authentication data to runtime | Update J2C Authentication data Push authentication data to runtime | Destroy J2C Authentication data Push authentication data to runtime
was.SharedLibrary | Create shared library WAS ND only: Synchronize applicable nodes | Destroy shared library WAS ND only: Synchronize applicable nodes Create shared library WAS ND only: Synchronize applicable nodes | Destroy shared library WAS ND only: Synchronize applicable nodes
was.VirtualHost | Create virtual host WAS ND only: Synchronize applicable nodes | Destroy virtual host WAS ND only: Synchronize applicable nodes Create virtual host WAS ND only: Synchronize applicable nodes | Destroy virtual host WAS ND only: Synchronize applicable nodes
was.V5DefaultQueue was.V5DefaultTopic was.V5DefaultQueueConnectionFactory was.V5DefaultTopicConnectionFactory | Create V5 JMS resource WAS ND only: Synchronize applicable nodes | Destroy V5 JMS resource WAS ND only: Synchronize applicable nodes Create V5 JMS resource WAS ND only: Synchronize applicable nodes | Destroy V5 JMS resource WAS ND only: Synchronize applicable nodes
was.WmqQueue was.WmqQueueConnectionFactory was.WmqTopic was.WmqTopicConnectionFactory | Create WebSphere MQ JMS resource WAS ND only: Synchronize applicable nodes | Update WebSphere MQ JMS resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere MQ JMS resource WAS ND only: Synchronize applicable nodes
was.SibQueue was.SibQueueConnectionFactory was.SibQueueDestination was.SibTopic was.SibTopicConnectionFactory was.SibTopicSpaceDestination | Create WebSphere SIB JMS resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere SIB JMS resource WAS ND only: Synchronize applicable nodes Create WebSphere SIB JMS resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere SIB JMS resource WAS ND only: Synchronize applicable nodes
was.GenericJmsQueue was.GenericJmsTopic was.GenericJmsQueueConnectionFactory was.GenericJmsTopicConnectionFactory | Create WebSphere Generic JMS resource WAS ND only: Synchronize applicable nodes | Update WebSphere Generic JMS resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Generic JMS resource WAS ND only: Synchronize applicable nodes
was.J2CResourceAdapter was.J2CAdminObject was.J2CActivationification was.J2CConnectionFactory | Create WebSphere J2C resource (was.J2CResourceAdapter will, additional to target scope, be created on Node scope) WAS ND only: Synchronize applicable nodes | Destroy WebSphere J2C resource WAS ND only: Synchronize applicable nodes Create WebSphere J2C resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere J2C resource WAS ND only: Synchronize applicable nodes
was.JdbcProvider was.OracleJdbcProvider was.OracleXaJdbcProvider | Create WebSphere JDBC provider resource WAS ND only: Synchronize applicable nodes | Update WebSphere JDBC provider resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere JDBC provider resource WAS ND only: Synchronize applicable nodes
was.ListenerPort | Create WebSphere Listener Port resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Listener Port resource WAS ND only: Synchronize applicable nodes Create WebSphere Listener Port resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Listener Port resource WAS ND only: Synchronize applicable nodes
was.ThreadPool | Update WebSphere Thread pool resource WAS ND only: Synchronize applicable nodes | Update WebSphere Thread pool resource WAS ND only: Synchronize applicable nodes |
was.WorkManagerProvider was.WorkManager was.TimerManager was.Scheduler | Create WebSphere Async resource WAS ND only: Synchronize applicable nodes | Update WebSphere Async resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Async resource WAS ND only: Synchronize applicable nodes
was.ResourceEnvironmentEntry was.ResourceEnvironmentProvider | Create WebSphere Environment resource WAS ND only: Synchronize applicable nodes | Update WebSphere Environment resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Environment resource WAS ND only: Synchronize applicable nodes
was.ServicePolicy | Create WebSphere Service Policy resource WAS ND only: Synchronize applicable nodes | Update WebSphere Service Policy resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Service Policy resource WAS ND only: Synchronize applicable nodes
was.Variable | Create WebSphere Variable resource WAS ND only: Synchronize applicable nodes | Update WebSphere Variable resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Variable resource WAS ND only: Synchronize applicable nodes
was.CustomService | Create WebSphere CustomService resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere CustomService resource WAS ND only: Synchronize applicable nodes Create WebSphere CustomService resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere CustomService resource WAS ND only: Synchronize applicable nodes
was.StringNameSpaceBinding was.IndirectNameSpaceBinding was.EjbNameSpaceBinding | Create WebSphere Name Space resource WAS ND only: Synchronize applicable nodes | Update WebSphere Name Space resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Name Space resource WAS ND only: Synchronize applicable nodes
was.ServletCacheInstance | Create WebSphere Servlet Cache resource WAS ND only: Synchronize applicable nodes | Update WebSphere Servlet Cache resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Servlet Cache resource WAS ND only: Synchronize applicable nodes
was.MailProvider was.MailSession | Create WebSphere Mail resource WAS ND only: Synchronize applicable nodes | Update WebSphere Mail resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Mail resource WAS ND only: Synchronize applicable nodes
was.URLProvider was.URL | Create WebSphere URL resource WAS ND only: Synchronize applicable nodes | Update WebSphere URL resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere URL resource WAS ND only: Synchronize applicable nodes
was.HealthPolicy was.HealthPolicyMembership | Create WebSphere Health Policy resource WAS ND only: Synchronize applicable nodes | Update WebSphere Health Policy resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Health Policy resource WAS ND only: Synchronize applicable nodes
was.Keystore was.SSLConfig | Create WebSphere keystore resource WAS ND only: Synchronize applicable nodes | Update WebSphere keystore resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere keystore resource WAS ND only: Synchronize applicable nodes
was.CopiedKeystoreFile | Copy keystore file to overthere.Host | Remove keystore file from overthere.Host Copy keystore file to overthere.Host | Remove keystore file from overthere.Host
was.SiBus was.SiBusMember | Create WebSphere SIBus resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere SIBus resource WAS ND only: Synchronize applicable nodes Create WebSphere SIBus resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere SIBus resource WAS ND only: Synchronize applicable nodes
was.ApplicationServer was.ServerPort was.ORBService was.TransactionService was.EJBContainer was.WebContainer was.PMIService was.JavaProcessDefinition was.LoggingAndTracing was.CoreGroupService was.ServerSessionManager was.TransportChain | Update WebSphere Server component WAS ND only: Synchronize applicable nodes | Update WebSphere Server component WAS ND only: Synchronize applicable nodes |
was.FileSynchronizationService | Update WebSphere File Sync Service resource WAS ND only: Synchronize applicable nodes | Update WebSphere File Sync Service resource WAS ND only: Synchronize applicable nodes |
was.CustomProperties | Create WebSphere Custom Properties resource WAS ND only: Synchronize applicable nodes | Update WebSphere Custom Properties resource WAS ND only: Synchronize applicable nodes | Destroy WebSphere Custom Properties resource WAS ND only: Synchronize applicable nodes
was.CoreGroup | Stop associated application servers Create WebSphere Core Group resource Start associated application servers | Stop associated application servers Update WebSphere Core Group resource Start associated application servers | Stop associated application servers Destroy WebSphere Core Group resource Start associated application servers

## Discovering WAS middleware

The WAS plugin can only discover WebSphere configuration items (CIs) via a Deployment Manager. Discovery via Administrative Agents is not supported.

XL Deploy can scan your environment for as far as possible and create CIs in its repository based on the configurations it encounters during the scan. This process is known as discovery.

The CIs discovered during discovery will help you set up your infrastructure in an easy way. However, they need not be complete: some CIs contain properties that can not be automatically discovered, like passwords. These properties must be entered manually.

Because discovery is part of the XL Deploy plugin suite, the exact discovery functionality available varies depending on the middleware platforms present in your environment.

The following steps comprise discovery:

1. Create a CI representing the starting point for discovery (often a Host CI).
2. Start discovery passing this CI.
3. Store the discovered CIs in the repository.
4. Complete the discovered CIs manually by providing missing needed properties.
5. Add the discovered CIs to an environment.

Note that the last step of discovery is optional. The discovered CIs will be stored under the Infrastructure root node in the repository and may be added to an environment at some later time.

### Create a CI starting point

The first step taken in discovery is to create a starting point to kick off the process from. This starting point consists of a CIs specifying at least the host where discovery should start. Depending on the middleware you are trying to discover, additional parameters may be needed.

Following is an example of how to start discovery for a WebSphere Application Server (WAS). First a CI is created for the host itself, then a CI is created for the deployment manager running on that host. The deployment manager CI will be the starting point for discovery.

        # Create a CI with the required discovery parameters filled in
        wasHost = factory.configurationItem('Infrastructure/rs94asob.k94.corp.com', 'overthere.SshHost', {
                'address': 'was-61',
                'username': 'root',
                'password': 'rootpwd',
                'os': 'UNIX',
                'connectionType': 'SFTP'
            })

        repository.create(wasHost)

        # Now create a WAS deployment manager
        dmManager = factory.configurationItem(wasHost.id + '/wasDM', 'was.DeploymentManager', {
                'host':'Infrastructure/rs94asob.k94.corp.com',
                'version':'WAS_61',
                'wasHome':'/opt/ws/6.1/profiles/dmgr',
                'username':'wsadmin',
                'password':'wsadmin'})

Note 1: Possible values for version are: WAS_61, WAS_70, WAS_80, WAS_85.

Note 2: The final segment of the CI ID (`wasDM` in this example) should match your WebSphere cell name.

### Start discovery passing a CI

After the CI starting point has been created, it can be used to perform discovery. The XL Deploy CLI discovery functionality is synchronous, which means that the CLI will wait until the discovery process finishes.

The process of discovery works exactly like a regular task:

    deployit> taskId = deployit.createDiscoveryTask(dmManager)
    deployit> deployit.startTaskAndWait(taskId)
    deployit> discoveredCIs = deployit.retrieveDiscoveryResults(taskId)

Note there are no single or double quotes around `dmManager`, because it is an object and not a string. The result of this command will be an object containing a list of discovered CIs.

### Store the CIs in the repository

XL Deploy returns a list of discovered middleware CIs. Note that these are not yet persisted. To store them in the repository, use the following code:

        repository.create(discoveredCIs)

### Complete discovered middleware CIs

The easiest way to see the discovered CIs require additional information is by printing them. Any CIs that contain passwords (displayed as '********') will need to be completed. To print the stored CIs, the following code can be used:

        for ci in discoveredCIs: deployit.print(repository.read(ci.id));

Note: You can edit the created CIs in the Repository part of the GUI.

### Adding CIs to environments

Middleware that is used as a deployment target must be grouped together in an environment. Environments are CIs and like all CIs, they can be created from the CLI. The following command can be used for this:

        env = factory.configurationItem('Environments/DiscoveredEnv', 'udm.Environment')

Add the discovered CIs to the environment:

        env.values['members'] = [ci.id for ci in discoveredCIs]

Note that not all of the discovered CIs should necessarily be stored in an environment. For example, in the case of WAS, some nested CIs may be discovered of which only the top-level one must and can be stored.

Store the new environment:

        repository.create(env)

The newly created environment can now be used as a deployment target.

Note: You need a specific permission to store CIs in the database. See the XL Deploy System Administration Manual for more information.

## Use intermediate wsadmin instance to deploy applications

It is possible to use intermediate (proxy) wsadmin instance to deploy applications. This feature depends on wsadmin ability to serve as a proxy to a target host. To use this functionality, you must:

- Define the deployment manager or unmanaged server on a proxy host - this instance will be used as a wsadmin proxy
- Define the hostname property on the previously defined deployment manager or unmanaged server

Note that some functionalities might not work with this setup:

- Control tasks that rely on shell scripts
- Discovery of EAR, war, and EJB modules
- Some CIs that rely on AdminTask commands
- In the repository, CIs will be discovered/deployed under the "proxy" instance of dmgr or unmanaged server, not under the target instance

## Invoking control tasks

Some CIs have control tasks which can accept parameters. Here's an example how to create an application server:

    newServerId='Infrastructure/localhost/vagrantCell01/vagrantNode01/test3'
    newServer = factory.configurationItem(newServerId, 'was.ManagedServer', {'serverType': 'APPLICATION_SERVER', 'tags' : ['scope_jvm'] });
    repository.create(newServer)
    control = deployit.prepareControlTask(newServer, "create")
    control.parameters.values['template'] = 'default'
    taskId = deployit.createControlTask(control)
    deployit.startTaskAndWait(taskId)

## Extending the WAS plugin

The WAS plugin is designed to be extended through XL Deploy's plugin API type system and through the use of custom, user-defined WAS Python scripts.

The WAS plugin associates Create, Modify, Destroy and Inspect operations received from XL Deploy with WAS Python scripts that need to be executed for the specific operation to be performed. The operation specific script is given a Python object representation of the `Deployed` that triggered the operation. The script is then executed using wsadmin.

There also exists an advanced method to extend the WAS plugin, but the implementation of this form of extension needs to be written in the Java programming language and consists of writing so-called `Deployed contributors`, `PlanPreProcessors` and `Contributors`.

Please refer to the Customization Manual for a detailed explanation of the type system and advanced methods of customization of plugins.

### Extending using XML and Python scripts

The easiest way to extend the WAS plugin is by using XML and Python scripts. This method does not require you to write Java code. Extending the behavior of the plugin is done by simply defining the necessary deployables and deployeds for the specific environment. When XL Deploy starts up, it reads a file called `synthetic.xml` from the server class-path (that is, the `ext` directory of the server).

This file contains the type definitions of the deployables and the deployeds, i.e. the information about the types and their properties. In addition to that, it defines which Python scripts should be executed for a particular operation, as mentioned above. The scripts have all the information from the `Deployed` at their disposal to perform their work.

As an example, this is the type definition of a virtual host as it appears in `synthetic.xml`:

    <type type="was.VirtualHost" extends="was.Resource" deployable-type="was.VirtualHostSpec" container-type="was.Cell">
        <generate-deployable type="was.VirtualHostSpec" extends="was.Deployable" />
        <property name="createScript" default="was/virtualhost/create-virtual-host.py" hidden="true" />
        <property name="destroyScript" default="was/virtualhost/destroy-virtual-host.py" hidden="true" />
        <property name="inspectScript" default="was/virtualhost/inspect-virtual-host.py" hidden="true" />
        <property name="aliases" kind="set_of_string" description="Virtual host aliases - enter alias as: hostname:port" />
    </type>

Looking at this type definition more closely, it indicates that a virtual host, the type of which is `was.VirtualHost` will be created on its target infrastructure, called container, with a `container-type` of `was.Cell`. On WAS a virtual host may be created on a cell and that is exactly what this definition means.

The attribute `extends` tells the plugin what resource is extended by this definition. In this case it is a simple basic resource so it extends the type `was.Resource`. Since multiple virtual hosts may be created this way, each with its own set of properties, a specification of what will be deployed is created, a so-called `deployable-type`, and is itself of type `was.VirtualHostSpec`.

Within the type definition, there is the possibility of specifying properties of exactly how the virtual host is to be created. The first property is called `createScript` and specifies the script to be executed by wsadmin for the creation of the virtual host. An extension of this plugin could specify a different creation script. The plugin comes with a default creation script (`createScript`):

create-virtual-host.py

    import re

    pattern = re.compile('^[^:]+:\d{,5}')
    virtualHostParent = AdminConfig.getid('/Cell:%s/' % (deployed.container.cellName))
    attributes = [['name', deployed.name]]
    attributes.append(['aliases', [[['hostname', alias.split(':')[0]], ['port', alias.split(':')[1]]]
                        for alias in deployed.aliases if pattern.match(alias) != None]])
    re.purge()

    print "Creating virtual host %s on target scope %s with attribute(s) %s" % (deployed.name, virtualHostParent, attributes)
    AdminConfig.create('VirtualHost', virtualHostParent, attributes)

This script also shows that `aliases` are also created for the specified virtual host. Aliases may be specified using the property `aliases` and it takes a set of strings. An example of this property is:

    <property name='aliases' kind='set_of_string' value='www.my-domain.com:80,www.proxy-domain.com:8443'/>

When the script executes a predefined variable `deployed` has a reference to the deployed that is being deployed.

The script executed on the host is created by appending a number of library scripts and adding the script from the type last. Per default you will get the following runtime scripts added:

- From the Python plugin: `python/runtime/base.py`
- From the WAS plugin: `was/runtime/base.py`
- From the deployed itself scripts defined in the `libraryScripts` hidden property

In addition to a creation script, a destruction script (`destroyScript`) must also be specified:

destroy-virtual-host.py

    virtualHostContainmentPath = '/Cell:%s/VirtualHost:%s' % (deployed.container.cellName, deployed.name)
    virtualHostId = validateNotEmpty(AdminConfig.getid(virtualHostContainmentPath),
    "Cannot find virtual host with id: %s" % (virtualHostContainmentPath))

    print "Destroying virtual host %s" % (deployed.name)
    AdminConfig.remove(virtualHostId)

Also for the destroy operation a predefined variable `deployed` is available with the deployed being destroyed.

Finally, a modification script (`modifyScript`) may also be specified. If that is not present, the destruction script is invoked to remove the resource with the old settings and then the creation script is invoked to create the resource with the new settings.

The modify script also has access to the `deployed` variable.

#### Inspection

The WAS plugin includes a property called `inspectScript`. When the Domain manager of WAS is known, it is possible for XL Deploy to discover on its own most of the WAS topology automatically. This specific script is called upon by XL Deploy when it is trying, in our example, to discover a virtual host on a WAS cell. This is a simplified script implementation shipped with the WAS plugin:

inspect-virtual-host.py

    virtualhosts = AdminConfig.list('VirtualHost')
    if virtualhosts != "":
        for virtualhost in virtualhosts.splitlines():
            if virtualhost.find('/nodes/') == -1:
                virtualHostName = AdminConfig.showAttribute(virtualhost, 'name')
                virtualHostId = '%s/%s' % (container.id, virtualHostName)
                discovered(virtualHostId, 'was.VirtualHost')
                virtualHostContainmentPath = '/Cell:%s/VirtualHost:%s' % (container.cellName, virtualHostName)
                virtualHostAliases = AdminConfig.getid(virtualHostContainmentPath + '/HostAlias:/').split()
                inspectedProperty(virtualHostId, 'aliases', [
                    AdminConfig.showAttribute(a, 'hostname') + ':' + AdminConfig.showAttribute(a, 'port')
                    for a in virtualHostAliases if a != ""])
                inspectedItem(virtualHostId)

An inspection script generally consists of a number of steps:

- Collect information from WebSphere.
- Indicate to XL Deploy that an object with a certain configuration item ID and a certain type was detected. This is achieved by calling `discovered` with the configuration item ID that the object has to get inside XL Deploy and the type.
- Set the properties on the object. This is done by repeatedly calling `inspectedProperty`. `inspectedProperty` takes three parameters, the ID of the configuration item being discovered, the name of the property and the value. The value should be representable as either a string, or a list of strings.
- When the complete object has been processed this is indicated to XL Deploy by calling `inspectedItem` with the configuration item ID.

The `discovered`, `inspectedProperty` and `inspectedItem` functions are defined in the Python plugin's `python/runtime/base.py`. This file also contains some additional helper functions.

Discovery starts at the Cell level. If you need to inspect other levels of the hierarchy you need to traverse the children of the Cell yourself. For convenience a function `findAllContainers` is defined in the runtime script `runtime/base.py`.

When the discovery script executes two predefined variables are available:

- `prototype` contains a 'prototype' deployed which can be used to get the type of the CI being discovered
- `container` contains the Cell

More information about the process of discovery and how to use it can be found in the Command Line Interface (CLI) Manual.

#### Adding a property

The architecture of the WAS plugin enables the transfer of properties from the deployed (`was.VirtualHost` in this example) to the accompanying Python scripts defined with the properties `createScript` and `destroyScript`. In order for this to be possible, the properties are bound to an object called `deployed` and can be accessed as `deployed.<property-name>`. This can be seen in the creation script, where the property `aliases` is available as `deployed.aliases` and the name of the virtual host as `deployed.name`. Using this convention as many properties as needed by the scripts can be bound to the type definition. Care should be taken that the scripts use the same type as specified in the definition, so if a property defines a `kind=integer`, the script should also treat the value of this property as being of type `integer`.

An example of adding another property is:

    <property name='index-range' kind='integer' value='999' description='maximum index of an array of 1000 items'/>

#### Fixing a property

In the case where it is necessary that a specific property should always contain a fixed predefined value, the attribute `hidden=true` should be used on the definition of the property. This way an end user, who is performing the deployment using the XL Deploy user interface, will not be able to see this property and therefore not have the possibility of modifying it. Usually this is done for the Python scripts which once written are not allowed to be changed by an end-user.

Using the example of the previous section and wanting to fix the maximum range, the example becomes:

    <property name='index-range' kind='integer' value='999' hidden='true' description='maximum index of an array of 1000 items'/>

#### Excluding a property

If you do not want certain properties of a deployable to be exposed to Python scripts, you can use the hidden property `additionalPropertiesNotToExpose` to exclude them. For example:

      <type-modification type="was.WmqQueue">
            <property name="additionalPropertiesNotToExpose" default="jmsProvider,wasType,customProperties" hidden="true" />
      </type-modification>

#### Execution order

A deployment process consists of a series of steps that are executed sequentially. Plugins offer the ability to influence the order of execution of the steps contributed to the deployment process in relation to other contributed steps and operations, not necessarily contributed by the same plugin(s), that are part of the deployment process.

The order of execution allows for the chaining of scripts or operations to create a logical sequence of events. In order to specify the order, properties with the name of `createOrder` and `destroyOrder` may be used with an attribute called `default` to specify the order ordinal. For example, the following `synthetic.xml` snippet says that creation of the virtual host, `default=60`, will happen before any step with a higher order, for example `default=70`, but after any step with a lower order, i.e. lower than `default=60`.

    <type type="was.VirtualHost" extends="was.Resource" deployable-type="was.VirtualHostSpec" container-type="was.Cell">
        <generate-deployable type="was.VirtualHostSpec" extends="was.Deployable" />

        <property name="createScript" default="was/virtualhost/create-virtual-host.py" hidden="true" />
        <property name="createVerb" default="Deploy" hidden="true" />
        <property name="createOrder" kind="integer" default="60" hidden="true" />

        <property name="destroyScript" default="was/virtualhost/destroy-virtual-host.py" hidden="true" />
        <property name="destroyVerb" default="Undeploy" hidden="true" />
        <property name="destroyOrder" kind="integer" default="30" hidden="true" />

        <property name="inspectScript" default="was/virtualhost/inspect-virtual-host.py" hidden="true" />
        <property name="aliases" kind="set_of_string" description="Virtual host aliases - enter alias as: hostname:port" />
    </type>

Notice that the `destroyOrder` has a low order, because when executing a deployment the virtual host should be destroyed before it can be created again.

### Extending the plugin with custom control task

The plugin has the capability to add control tasks to ExtensibleDeployed or PythonManagedContainer. The control task can be specified as a Python script that will be executed using wsadmin on the target host or as an OS shell script that will be run on the target host. The OS shell script is first processed with FreeMarker before being executed.

Creating a Python script control task to test datasources

`synthetic.xml` snippet:

    <type-modification type="was.Datasource">
      <method name="testDatasource" script="was/resources/ds/test-ds.py" language="python"/>
    </type>

`test-ds.py` snippet:

    datasource = AdminConfig.getid("%s/JDBCProvider:%s/DataSource:%s/" %
     (deployed.container.containmentPath, deployed.jdbcProvider, deployed.name))
    if datasource == '':
      print "WARN: No JDBC DataSource '%s' found. Nothing to do" % (deployed.name)
    else:
      print "Testing JDBC DataSource '%s' (config ID '%s')" % (deployed.name, datasource)
      AdminControl.testConnection(datasource)

Creating an OS script control task to start the DeploymentManager

`synthetic.xml` snippet:

    <type-modification type="was.DeploymentManager">
      <method name="start" script="was/container/start-dm" language="os"/>
    </type-modification>

`start-dm.sh snippet` for Unix:

    ${container.wasHome}/bin/startManager.sh

`start-dm.bat` snippet for Windows:

    ${container.wasHome}\bin\startManager.bat

## Migrating from WAS plugin extensions

From version 4.5.0, the functionality of the WAS plugin extensions has been incorporated in the official WAS plugin. Version 4.5.0 of was-plugin-extensions exists for backwards compatibility only. Please port all your CIs to the WAS plugin, since this will be the only supported WAS plugin from now on.

The majority of the CIs can be ported by substituting the `wasx` prefix for `was`.

The following table shows the exceptions to this pattern:

WAS plugin extensions 4.5.0 | WAS plugin 4.5.0
--- | ---
wasx.Variables | Not migrated, use multiple was.Variable
wasx.StringNameSpaceBindings | Not migrated, use multiple was.StringNameSpaceBinding
wasx.ClassLoader | Not migrated
wasx.SystemLoginConfiguration | Not migrated
wasx.CSIv2Configuration | Not migrated
wasx.Interceptor | Not migrated
wasx.WasServerOrbService | was.ORBService
wasx.NodeAgentFileSyncServiceCustomProperty | was.FileSynchronizationService
wasx.SSLConFig | was.SSLConfig
wasx.URLResource | was.URL
wasx.SIBus | was.SiBus
wasx.SIBusMember | was.SiBusMember
wasx.WebsphereMQServer | was.WMQServer
wasx.ResourceReference | Not migrated, use was.EjbRef, was.ResourceEnvRef and was.ResourceRef embedded CIs instead
ServerConfiguration | Extended and split into following CIs: was.ApplicationServer was.EJBContainer was.WebContainer was.TransactionService was.PMIService was.CoreGroupService was.JavaProcessDefinition was.LoggingAndTracing was.ServerSessionManager was.TransportChain, was.HTTPInboundChannel

### Migrated type-modifications

Type-modifications previously present in the extensions plugin will be automatically upgraded to new state according to the following transition table:

Type modification | New state
--- | ---
was.Module | All properties will be migrated to the extended was.Module type. All properties which affect multiple modules (e.g. jspReloadInterval, warClassloaderMode) will keep the same behavior. Property 'webModuleSessionTimeout' is migrated to an embedded SessionManager instance.
was.Datasource - allowExistingJaasAlias | This is the default behavior thus the property is deprecated
was.WmqQueue - useRFH2 | UseRFH2 property replaced by targetClient property. If useRFH2 is 'true', targetClient is set to 'JMS' else 'MQ'
was.WmqQueueConnectionFactory - sslConfiguration | CI property sslConfiguration is migrated to STRING property sslConfigurationName
wasx.UnmanagedWebServer | Migrated to was.UnmanagedWebServer

### Possible breaking changes / different behavior

#### Overwrite behavior

Take notice that existing values of complex properties (i.e. JVM args, Environment vars etc.) will by default be overwritten by values specified in XL Deploy CIs. If the existing values on WebSphere are to be preserved, please remember to include them in XL Deploy CIs prior to deployment.

If a CI property is not explicitly set, XL Deploy will use its default value. If a default value is not defined, an empty value will be sent to the WebSphere Application Server.

On CIs extending `was.ConfigurationResource` this behaviour can be overridden by setting the values of properties `overwriteExistingValues` and `overwriteExistingCustomProperties` to false.

When `overwriteExistingValues` is set to false, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. Please note here that properties with default values still take effect and will be considered as set on the deployed CI!

Property `overwriteExistingCustomProperties` changes the MODIFY behaviour of complex properties (i.e. JVM args, Environment vars etc.) once user has defined at least one entry on the complex property. When set to false, existing entries present on the server will be left as is and new entries will be appended to the existing custom properties. If server already has an entry (property) of the same name, its value will be updated.

#### Container Restart Strategy property implementation at container level

When the `containerRestartStrategy` property is set to STOP_START or RESTART on `was.Module`, this value will take precedence over the value that is set on the WebSphere application servers and clusters.

If the `containerRestartStrategy` property is set to NONE on `was.Module` and is set to STOP_START or RESTART in `was.ManagedServer`, `was.UnmanagedServer`, or `was.Cluster` (that is, on the container level), then the value that is set on the container level will be applied to the respective containers.

## Release notes

### WAS plugin 4.5.3

#### Possible breaking changes / different behavior

Take notice that in this version default property values on CIs extending was.ConfigurationResource (`was.ApplicationServer`, `was.ORBService`, `was.TransactionService`, `was.EJBContainer`, `was.WebContainer`, `was.JavaProcessDefinition`, `was.LoggingAndTracing`, `was.CoreGroupService`, `was.ServerSessionManager`, `was.FileSynchronizationService`) have been removed.

If you have CIs relying on the default values being set, please update the CIs manually with the necessary values!

For reference, the previous default values are available in each of the property descriptions.

On the same CI types, `boolean` kind properties have been replaced with more placeholder friendly `string` properties. If you have type-modifications, please update them accordingly.

#### Improvements

- [DEPL-8041] - Allow specifying overwrite behavior for complex configuration CIs

#### Bug fixes

- [DEPL-6957] - Fixed issue where was.ResourceEnvironmentProviderSpec wouldn't allow referenceables with non-alphanumeric characters
- [DEPL-7007] - Fixed issue where setting empty string for not set properties in WebSphere Queue Connection Factory would fail at runtime
- [DEPL-7222] - Fixed issue where user was unable to specify an empty JAAS mapping alias
- [DEPL-7752] - Fixed issue where AdminTask.rolloutEdition doesn't accept nested brackets in WebSphere 8.5.5.x
- [DEPL-8127] - Fixed issue where an incorrect ripple start procedure would be executed in some circumstances
- [DEPL-8137] - Fixed issue where mapping users and groups to the same role would ignore the group mapping
- [DEPL-8358] - Fixed issue where deployment of was.WmqActivationSpecification fails when the CCDT URL property is defined

### WAS plugin 4.5.2

#### Bug fixes

- [DEPL-7292] - Support deployment of was.J2CResourceAdapter to a cell scope
- [DEPL-7394] - WAS - global webserver plugin not updated for managed web server on update

### WAS plugin 4.5.1

#### New features

- [DEPL-6274] - Added 'wsadmin' step.

#### Bug fixes

- [DEPL-6697] - NodeAgent host property should default to the host of the deployment manager.

### WAS plugin 4.5.0

#### New features

- [DEPL-3284] - Add support for J2CActivation
- [DEPL-4166] - Add support for WmqActivationSpecification
- [DEPL-5661] - Extend discovery to all deployeds of was-plugin
- [DEPL-5802] - Add support for configuring server-specific application settings
- [DEPL-5803] - Add support for configuring session management
- [DEPL-5804] - Add support for configuring Performance Monitoring Infrastructure (PMI)
- [DEPL-5805] - Add support for configuring ports
- [DEPL-5806] - Add support for configuring web container
- [DEPL-5807] - Add support for configuring JVM and process management
- [DEPL-5809] - Add support for configuring EJB container
- [DEPL-5810] - Add support for configuring transaction service
- [DEPL-5812] - Implement DeploymentManager control tasks (start/stop/restart deployment manager and node agents)
- [DEPL-5813] - Add support for UnmanagedWebServer and plugin-cfg generation
- [DEPL-5815] - Implement ManagedServer control tasks (start/stop/restart/create/destroy)
- [DEPL-5816] - Add support for FileSynchronizationService
- [DEPL-5817] - Add support for setting CustomProperties on arbitrary containers
- [DEPL-5826] - Implement Cluster control tasks (start/stop/create)
- [DEPL-5828] - Add support for CoreGroup
- [DEPL-5830] - Add support for EjbNameSpaceBinding
- [DEPL-5831] - Add support for IndirectNameSpaceBinding
- [DEPL-5834] - Add support for ORBService
- [DEPL-5835] - Add support for URLProvider
- [DEPL-5836] - Add support for URLResource
- [DEPL-5837] - Add support for TimerManager
- [DEPL-5838] - Add support for Scheduler
- [DEPL-5839] - Migrate changes to Datasource type
- [DEPL-5850] - Add support for J2CResourceAdapter
- [DEPL-5854] - Add support for J2CAdminObject
- [DEPL-5868] - Add support for configuring core group service
- [DEPL-5894] - Add support for configuring logging and tracing
- [DEPL-5937] - Filter CI, SET_OF_CI and LIST_OF_CI properties by cell (requires XL Deploy 4.0.1+)
- [DEPL-6081] - Support specification of properties on modules inside was.Ear
- [DEPL-6104] - Add support for SIBusMember
- [DEPL-6112] - Add support for SIBWMQServer

#### Improvements

- [DEPL-3821] - Add "hostname" to was.DeploymentManager connection options
- [DEPL-4292] - Document that a "port" value of 0 for a WAS cell will suppress the -port argument
- [DEPL-5029] - Extend was.WmqQueueConnectionFactory
- [DEPL-5162] - Add virtualHostName property (STRING) to was.Module
- [DEPL-5230] - Add webserverNames property (SET_OF_STRING) to was.Module
- [DEPL-5483] - Extend was.Module type
- [DEPL-5485] - Extend was.WmqTopicConnectionFactory
- [DEPL-5820] - WebSphere MQ JMS provider not being detected during discovery

#### Bug fixes

- [DEPL-5401] - ListenerPort does not support deploying to Cluster anymore
- [DEPL-5442] - WAS discovery fails if a proxy server cluster is present
- [DEPL-5519] - ListenerPort fails when deployed to a was.Cluster
- [DEPL-5818] - J2CConnectionFactory discovered as SibQueueConnectionFactory
- [DEPL-5819] - ResourceEnvironmentEntry and ResourceEnvironmentProvider detected at wrong scope during discovery
- [DEPL-5822] - ServletCacheInstance detected at wrong scope during discovery
- [DEPL-5823] - WorkManager detected at wrong scope during discovery
- [DEPL-5825] - Creation of ThreadPool fails if it's not on the server scope
- [DEPL-5909] - MailSession created on first MailProvider found

#### Possible breaking changes / different behavior

This plugin version requires XL Deploy 4.0.1+

Take notice that existing values of complex properties (i.e. JVM args, Environment vars etc.) will by default be overwritten by values specified in XL Deploy CIs. If the existing values on WebSphere are to be preserved, please remember to include them in XL Deploy CIs prior to deployment.

If a CI property is not explicitly set, XL Deploy will use its default value. If a default value is not defined, an empty value will be sent to the WebSphere Application Server.

Type changes

Application resources

The was.Ear, was.War and was.EjbJar CIs have been extended with additional properties to support configuration of class loading, JSP compilation/reloading, security mappings and other.

In order to support configuration of properties on a specific module contained by a was.Ear artifact, new embedded types have been introduced into the hierarchy: was.EmbeddedWebModule and was.EmbeddedEjbModule.

To ensure backwards compatibility with previous versions, all properties (i.e. webServers, virtualHost, sharedLibraries, webClassLoaderMode) are still available on the was.Ear type. When used, those properties will be propagated to all modules inside an Enterprise Application Archive. To override the top-level EAR settings, specify an embedded module CI and set the module specific properties.

Properties configurable on the module level are:

Deployed | Properties
--- | ---
was.EmbeddedWebModule | Properties: contextRoot, startingWeight, virtualHostName, webServerNames, sharedLibraryNames, uri, moduleDisplayName, preCompileJsps, jspClassPath, useFullPackageNames, jdkSourceLevel, disableJspRuntimeCompilation, enableJspClassReloading, jspReloadInterval, classloaderMode Embeddeds: sessionManagers, ejbRefs, resourceRefs, resourceEnvRefs
was.EmbeddedEjbModule | Properties: startingWeight, sharedLibraryNames, uri, moduleDisplayName Embeddeds: ejbRefs, resourceRefs, resourceEnvRefs

For usage scenario, please see the following deployment package:

    <udm.DeploymentPackage version="1.0" application="myapp">
      <deployables>
        <was.Ear name="myapp-ear" file="myapp-ear/myapp-1.0.5.ear">
          <virtualHostName>default_host</virtualHostName>
          <preCompileJsps>true</preCompileJsps>
          <jdkSourceLevel>16</jdkSourceLevel>
          <webModules>
            <was.EmbeddedWebModuleSpec name="myapp-ear/myappWeb.war">
              <contextRoot>/myappWeb</contextRoot>
              <startingWeight>10</startingWeight>
              <classloaderMode>PARENT_LAST</classloaderMode>
              <virtualHostName>proxy_host</virtualHostName>
              <webServerNames>
                <value>webserver-dmz01-zone</value>
              </webServerNames>
              <preCompileJsps>true</preCompileJsps>
              <jdkSourceLevel>15</jdkSourceLevel>
              <sessionManagers>
                <was.SessionManagerSpec name="myapp-ear/myappWeb.war/SessionManager">
                  <TuningParams_invalidationTimeout>60</TuningParams_invalidationTimeout>
                </was.SessionManagerSpec>
              </sessionManagers>
              <ejbRefs>
                <was.EjbRefSpec name="myapp-ear/myappWeb.war/ejbConverter">
                  <resourceRefName>ejb/Converter</resourceRefName>
                  <resourceType>com.xebia.myapp.ejb.Converter</resourceType>
                  <resourceJndiName>ejb/ConverterBean</resourceJndiName>
                </was.EjbRefSpec>
              </ejbRefs>
              <resourceRefs>
                <was.ResourceRefSpec name="myapp-ear/myappWeb.war/jdbcmyappdb">
                  <resourceRefName>jdbc/myapp_db</resourceRefName>
                  <resourceType>javax.sql.DataSource</resourceType>
                  <resourceJndiName>jdbc/myapp_db_xa</resourceJndiName>
                </was.ResourceRefSpec>
              </resourceRefs>
            </was.EmbeddedWebModuleSpec>
          </webModules>
          <ejbModules>
            <was.EmbeddedEjbModuleSpec name="myapp-ear/myappEJB.jar">
              <startingWeight>20</startingWeight>
            </was.EmbeddedEjbModuleSpec>
          </ejbModules>
        </was.Ear>
      </deployables>
    </udm.DeploymentPackage>

Name of the embedded module should correspond to the WAR or EJB module file name. If this is not possible, additional uri and displayName properties can be set. E.g.:

    <was.EmbeddedEjbModuleSpec name="myapp-ear/myapp-ejb">
      <startingWeight>20</startingWeight>
      <uri>myappEJB.jar,META-INF/ejb-jar.xml</uri>
      <moduleDisplayName>myappEJB</moduleDisplayName>
    </was.EmbeddedEjbModuleSpec>

JMS resources

New intermediate virtual types have been introduced into the WMQ ConnectionFactory, Destination and Generic ConnectionFactory CI hierarchy and now corresponds the following:

    was.JmsResource | <- was.JmsConnectionFactory | <- was.WmqConnectionFactory | <- was.WmqQueueConnectionFactory
                    |                             |                             | <- was.WmqTopicConnectionFactory
                    |                             |
                    |                             | <- was.GenericJmsConnectionFactory | <- was.GenericJmsQueueConnectionFactory
                    |                                                                  | <- was.GenericJmsTopicConnectionFactory
                    |
                    | <- was.WmqDestination | <- was.WmqQueue
                                            | <- was.WmqTopic

Enum class changes

Old location | New location
--- | ---
com.xebialabs.deployit.plugin.was.util.TransportType | com.xebialabs.deployit.plugin.was.deployed.jms.mq.TransportType
com.xebialabs.deployit.plugin.was.util.WMQQueueTargetClient | com.xebialabs.deployit.plugin.was.deployed.jms.mq.TargetClient

Script changes

Old location | New location | Comment
--- | --- | ---
was/jms/wmq-connection-factory-lib.py | was/jms/jms-connection-factory-lib.py | Additional to the rename, parts of this script were refactored into: was/jms/generic/generic-connection-factory-lib.py was/jms/wmq/wmq-connection-factory-lib.py Signature of the createConnectionFactory & modifyConnectionFactory function has changed to receive a map of exposed properties as first argument instead of an AdminConfig formatted list.
was/jms/create-wmq-connection-factory.py | was/jms/wmq/create-wmq-connection-factory.py |
was/jms/modify-wmq-connection-factory.py | was/jms/wmq/modify-wmq-connection-factory.py |
was/jms/discover-inspect-wmq-connection-factory.py | was/jms/wmq/discover-inspect-wmq-connection-factory.py |

### WAS plugin 4.0.0

#### New features

#### Improvements

- [DEPL-5484] - Extend was.WmqQueue type

#### Bug fixes

- [DEPL-5445] - was.MailSession, was.MailProvider are destroyed in the wrong order

### WAS plugin 3.9.0

#### New features

- [DEPL-3275] - Add support for generic JMS CIs
- [DEPL-3276] - Additional JDBC providers and data sources
- [DEPL-3277] - Add support for CustomService
- [DEPL-3278] - Add support for ThreadPool
- [DEPL-3279] - Add support for ListenerPort
- [DEPL-3280] - Add support for ServerPort
- [DEPL-3281] - Add support for WorkManager
- [DEPL-3282] - Add support for ResourceEnvironmentEntry
- [DEPL-3283] - Add support for ServletCacheInstance
- [DEPL-3287] - Add support for StringNamespaceBinding
- [DEPL-3288] - Add support for Variable
- [DEPL-4248] - Add support for deploying to dynamic clusters
- [DEPL-4249] - Add support for creating / modifying / setting mode of dynamic cluster via control tasks
- [DEPL-4250] - Add support for discovering dynamic clusters
- [DEPL-4251] - Add support for service policies
- [DEPL-4252] - Add support for deployment of health policies
- [DEPL-4254] - Add support for deploying editioned applications
- [DEPL-4255] - Add support to create / modify dynamic clusters of ODRs via control tasks
- [DEPL-4257] - Add support for discovery of dynamic clusters of ODRs
- [DEPL-4316] - Add support for Resource Environment Providers
- [DEPL-4879] - Add support for MailSession and MailProvider
- [DEPL-5028] - Add support for SiBus
- [DEPL-5032] - Add support for Keystore, CopiedKeystoreFile and SSLConfig

#### Improvements

- [DEPL-3285] - Improve support for JaasAliases, push changes to runtime automatically
- [DEPL-4165] - Improvements to was.WmqQueue
- [DEPL-4167] - Improvements to was.WmqQueueConnectionFactory
- [DEPL-4666] - Add ability to control WAS container and deployeds
- [DEPL-5031] - Add sharedLibraryNames property (LIST_OF_STRING) to was.Module
- [DEPL-5142] - Make JDBC provider and datasource scripts idempotent

#### Bug fixes

- [DEPL-2757] - Topology discovery fails when there are multiple servers defined
- [DEPL-3695] - Discovery says "Inspecting cell ..." twice
- [DEPL-3735] - Connection test fails when deploying an Oracle datasource
- [DEPL-4281] - Incorrect default for WAS cell port in description
- [DEPL-4350] - Start application step fails - hangs in an infinite loop
- [DEPL-4409] - Make stop, start script on was.Module not required
- [DEPL-4609] - Only WAR's should be mapped to web servers, not EJB's
- [DEPL-4910] - JAAS alias script will fail if multiple Security objects exist
- [DEPL-5006] - Discovery fixes for data sources, JDBC Providers, MQ Queue connection factory, MQ Queue
- [DEPL-5221] - Duplicate shared library check is too broad

#### Possible breaking changes / different behavior

The various data source, JDBC provider and JAAS alias scripts were made idempotent. This means they will be more robust against objects already being created. Objects found will be made to look according to what is specified in XL Deploy. If you have local changes to the scripts for these types you will have to verify if your changes are still necessary or work.

A JAAS alias will now be propagated to runtime in an additional step. No server restart needed. This behaviour also applies to data sources were a username and password is specified (and a JAAS alias is created under the hood). As a result the test connection functionality will now work with a newly deployed JAAS alias.

A JAAS alias generated by was.JaasAlias or was.DataSources will now always target Global Security. Previously it would fail if multiple Security objects existed.

Compared to the wasx.ListenerPort type the was.ListenerPort does not support deploying to a Cluster.

#### Known issues

- The DB2 JDBC Provider and data source types do not work on iSeries DB2

### WAS plugin 3.8.3

Re-release of version 3.8.2 to account for some build infrastructure changes. Functionally identical to version 3.8.2.

### WAS plugin 3.8.2

#### Improvements

- [DEPL-3771] - Support existing WAS plugin functionality on WAS 8.5
- [DEPL-4285] - Documentation improvements

#### Bug fixes

- [DEPL-2563] - The startup order of deployed applications is set to -1 if no value is specified
- [DEPL-2737] - Cannot deploy to a WAS cell that has two servers with the same name on different nodes
- [DEPL-3047] - Can create two shared libraries with the same name in the same scope
- [DEPL-3059] - Can create two JDBC providers with the same name in the same scope
- [DEPL-3426] - Success (return code) of starting app on WAS cluster depends only on the last server
- [DEPL-3882] - Create datasource script does not obtain the global security object correctly

### WAS plugin-3.8.1

#### Improvement

- Improved usability of discovery

### WAS plugin-3.8.0

#### Improvements

- In-depth discovery of WebSphere topologies

## CI Reference

### Configuration Item Overview

#### Deployables

#### Deployeds

#### Containers

#### Other Configuration Items

### Configuration Item Details

#### was.AllActivePolicy

Type Hierarchy | was.HAManagerPolicy >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a policy that automatically activates all group members.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | isAlivePeriodSec : INTEGER = 120
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the policy.
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy.
|  | quorumEnabled : BOOLEAN = false
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,type,wasType,deployable,container,customProperties,matchCriteria,servers,preferredServers
|  | Additional Properties Not To Expose
|  | policyFactory : STRING = com.ibm.ws.hamanager.coordinator.policy.impl.AllActivePolicyFactory
|  | The fully qualified name of the Java interface that serves as a factory for a specific type of concrete HAManagerPolicy.
|  | wasType : STRING = AllActivePolicy
|  | WebSphere admin resource type.

#### was.AllActivePolicySpec

Type Hierarchy | was.HAManagerPolicySpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Specifies a policy that automatically activates all group members.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the policy. (string)
|  | isAlivePeriodSec : STRING
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (integer) default(120)
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy. (map_string_string)
|  | quorumEnabled : STRING
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation. (boolean) default(false)

#### was.ApplicationServer

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Server-specific Application Settings.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | applicationClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
|  | Specifies whether there is one class loader for all applications (Single) or a separate class loader for each application (Multiple). Default WAS value is 'SINGLE'.
|  | applicationClassLoadingMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | Specifies the class loading order when the application class loader policy is Single. Default WAS value is 'PARENT_FIRST'.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this Application Server.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = ApplicationServer
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = ApplicationServer
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ApplicationServerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Server-specific Application Settings.

|  | Public Properties
--- | --- | ---
|  | applicationClassLoaderPolicy : STRING
|  | Specifies whether there is one class loader for all applications (Single) or a separate class loader for each application (Multiple). Default WAS value is 'SINGLE'. (enum) values(SINGLE, MULTIPLE)
|  | applicationClassLoadingMode : STRING
|  | Specifies the class loading order when the application class loader policy is Single. Default WAS value is 'PARENT_FIRST'. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this Application Server. (map_string_string)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.BaseCell

Virtual Type
Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, python.PythonManagingContainer, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, was.Cell, udm.Container, overthere.HostContainer

Base class for a Webshpere Cell

|  | Parent
--- | --- | ---
|  | host : CI<overthere.Host>
|  | Host on which the WAS server runs

|  | Public Properties
--- | --- | ---
|  | port : INTEGER
|  | TCP port which is used to login to the WebSphere Administration, defaults to 8880 for SA, 8879 for ND. Value of '0' has special meaning: it'used to suppress passing '-port' argument to wsadmin.
|  | version : ENUM [WAS_61, WAS_70, WAS_80, WAS_85]
|  | Version of WebSphere Application Server.
|  | wasHome : STRING
|  | Path to the WebSphere profile or deployment manager profile, where bin/wsadmin can be found. For example, /opt/ws/6.1/appserver/profiles/AppSrv01
|  | hostname : STRING
|  | Hostname to which wsadmin should attempt to connect.
|  | password : STRING
|  | Password which is used to login to the WebSphere Administration.
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.
|  | username : STRING
|  | Username which is used to login to the WebSphere Administration.

|  | Hidden Properties
--- | --- | ---
|  | deployedsToDiscover : SET_OF_STRING = [was.VirtualHost, was.SharedLibrary]
|  | Deployeds To Discover
|  | inspectScript : STRING = was/container/discover-inspect-topology.py
|  | Inspect script for Cell
|  | configDirName : STRING = config
|  | Config directory name of WebSphere Application Server.
|  | libraryScripts : LIST_OF_STRING = [was/container/discover-inspect-topology-lib.py, was/container/container-lib.py]
|  | List of scripts to appended to runtime script
|  | runWithDaemon : BOOLEAN = true
|  | Set to true to execute commands with the Python daemon
|  | versionInfoNameField : STRING = Name
|  | Translated text of "Name" used to resolve version of WebSphere Application Server running in a non-English language.

#### was.Cluster

Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, was.WasAppContainer, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

A WebSphere cluster managed by a deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | cell : CI<was.DeploymentManager >
|  | Deployment manager that manages this this cluster

|  | Public Properties
--- | --- | ---
|  | checkStartedInterval : INTEGER = 10
|  | Number of seconds to sleep inbetween the checking of cluster started.
|  | checkStoppedInterval : INTEGER = 10
|  | Number of seconds to sleep inbetween the checking of cluster stopped.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | Restart strategy used when deploying. Valid values are: NONE, STOP_START, RESTART. For example, if the STOP_START strategy is used, the container will be stopped before deployment and started after deployment. If the RESTART strategy is used, the deployment will be executed, then container will be restarted using the restart script. If there is no restart script defined, the deployment will be executed, then the container will be stopped and immediately started. Note that it may be preferable to use the containerRestartStrategy property defined on was.Module and its subtypes.
|  | enableRippleStart : BOOLEAN
|  | failOnPartialApplicationStart : BOOLEAN = true
|  | Specify if the deployment should fail when application fails to start on all servers in the cluster.
|  | serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER] = APPLICATION_SERVER
|  | Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER. Default value: APPLICATION_SERVER. Available since: WAS_70
|  | servers : SET_OF_CI<was.ManagedServer >
|  | Servers that are part of this cluster
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.

|  | Hidden Properties
--- | --- | ---
|  | restartOrder : INTEGER = 80
|  | Restart Order
|  | startOrder : INTEGER = 80
|  | Start Order
|  | startScript : STRING = was/container/start-cluster.py
|  | Start Script
|  | stopOrder : INTEGER = 20
|  | Stop Order
|  | stopScript : STRING = was/container/stop-cluster.py
|  | Stop Script

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
create | was.Cluster_create | language = python, script = was/container/create-cluster.py, delegate = pythonControlTask | Creates application server cluster if it doesn't exist. It will use already associated servers as cluster members. Task will use weight property of the associated servers to assign cluster member weight.
start |  | language = python, script = was/container/start-cluster.py | Start cluster.
stop |  | language = python, script = was/container/stop-cluster.py | Stop cluster.

#### was.Cluster_create

Type Hierarchy | udm.Parameters >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem

Generated type for method create.

|  | Public Properties
--- | --- | ---
|  | template : STRING
|  | If set, server template name used to create first cluster member. Could be found by executing 'tid=AdminTask.listServerTemplates('[-serverType APPLICATION_SERVER]')' and 'AdminTask.showTemplateInfo(tid)'.

#### was.ConfigResource

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed JEE AdminConfig resource configuration items .

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ConfigurationResource

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all container configuration CIs.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.CopiedKeystoreFile

Type Hierarchy | generic.CopiedArtifact >> generic.AbstractDeployedArtifact >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | targetDirectory : STRING
|  | Specifies the target directory of the key store file.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|  | targetFile : STRING
|  | Name of the artifact on the generic server.

|  | Hidden Properties
--- | --- | ---
|  | createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|  | Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|  | createOrder : INTEGER = 50
|  | The order of the step in the step list for the create operation.
|  | createVerb : STRING = Create
|  | Create Verb
|  | destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|  | Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|  | destroyOrder : INTEGER = 40
|  | The order of the step in the step list for the destroy operation.
|  | destroyVerb : STRING = Destroy
|  | Destroy Verb
|  | modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|  | Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|  | modifyOrder : INTEGER = 50
|  | The order of the step in the step list for the modify operation.
|  | modifyVerb : STRING = Modify
|  | Modify Verb
|  | noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
|  | Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Modify
|  | Noop Verb
|  | copyDirectlyToTargetPath : BOOLEAN = false
|  | If set to true, files are directly copied to the target directory without first being uploaded to the staging or temporary directory (like versions of XL Deploy prior to 4.0.0)
|  | createTargetDirectory : BOOLEAN = false
|  | Create the target directory on the generic server if it does not exist.
|  | inspectClasspathResources : SET_OF_STRING
|  | Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
|  | inspectScript : STRING
|  | Classpath to the script used to inspect the generic container.
|  | inspectTemplateClasspathResources : SET_OF_STRING
|  | Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
|  | preserveExistingFiles : BOOLEAN = false
|  | If set to true, preserve the existing files on the remote host (do not delete the copied files during the destroy operation).
|  | restartRequired : BOOLEAN = false
|  | The generic container requires a restart for the action performed by this deployed.
|  | restartRequiredForNoop : BOOLEAN = false
|  | The generic container requires a restart for the NOOP action performed by this deployed.
|  | targetDirectoryShared : BOOLEAN = true
|  | Is the target directory shared by others on the generic server. When true, the target directory is not deleted during a destroy operation; only the artifacts copied to it.
|  | targetPathSharedSubDirectories : BOOLEAN = false
|  | If set to true, the sub directories on the target machine are not deleted if files other than that copied by XL Deploy are present. Please note that setting this option to true will cause the removal process to be a slower.

#### was.CoreGroup

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A core group is a grouping of WebSphere(R) Application Server cell processes. A core group can contain stand-alone servers, cluster members, node agents, and the deployment manager.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Children
--- | --- | ---
|  | policies : SET_OF_CI<was.HAManagerPolicy >
|  | Specify policies associated with a core group. Coordinators use these policies to determine on which servers the core group members are activated or deactivated.

|  | Public Properties
--- | --- | ---
|  | Liveness_livenessType : ENUM [DEFAULT_ONLY, PLUGIN_ONLY] = DEFAULT_ONLY
|  | Specify to use default or alternative protocol providers. Depending on your platform, alternate protocol providers might be available.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = STOP_START
|  | Strategy to restart Core Group member servers.
|  | numCoordinators : INTEGER = 1
|  | Specifies the number of active coordinators.
|  | transportMemorySize : INTEGER = 100
|  | The maximum size of dynamically allocated memory, in megabytes, that the transport can hold. The range is from 10 to 2147483647 megabytes, however, this value cannot be larger than the maximum heap size specified for the Java virtual machine. When this limit is reached, congestion control is invoked.
|  | transportType : ENUM [UNICAST, MULTICAST, CHANNEL_FRAMEWORK] = CHANNEL_FRAMEWORK
|  | Specifies the communication protocol within a core group.
|  | Liveness_discoveryPeriod : INTEGER = 60
|  | The time interval, in seconds, at which the discovery protocol runs. Increasing this value might decrease the use of system resources such as CPU. Decreasing this value might improve the detection of core group members.
|  | Liveness_factoryClassName : STRING
|  | The fully qualified class name of the factory that is used to create the protocol providers. This property is valid only with PLUGIN_ONLY protocol providers.
|  | Liveness_heartbeatTimeoutPeriod : INTEGER = 180000
|  | The time interval, in milliseconds, that constitutes a heartbeat timeout. This value must be an integer multiple of the heartbeat transmission period.
|  | Liveness_heartbeatTransmissionPeriod : INTEGER = 30000
|  | The time interval, in milliseconds, at which active failure detection heartbeats are sent. Increasing this value might decrease the use of system resources such as CPU. Decreasing this value might improve the detection of failed core group members.
|  | channelChainName : STRING = DCS
|  | Specifies the transport channel chain to use for the channel framework transport type. Values: 'DCS'(default), 'DCS-Secure'.
|  | coreGroupClusters : SET_OF_CI<was.Cluster >
|  | Specifies the clusters that belong to the core group.
|  | coreGroupServers : SET_OF_CI<was.ManagedServer >
|  | Specifies the servers that belong to the core group.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the core group.
|  | preferredCoordinatorServers : LIST_OF_CI<was.ManagedServer >
|  | The high availability manager uses an ordered list of preferred core group servers when it selects servers to host the coordinators. If the default list is inappropriate, you can change the list such that other servers are selected as coordinators.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = Liveness,coreGroupClusters,coreGroupServers,preferredCoordinatorServers,customProperties,policies
|  | Additional Properties Not To Expose
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/coregroup/create-or-modify-coregroup.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/server/coregroup/destroy-coregroup.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/coregroup/discover-inspect-coregroup.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/coregroup/coregroup-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/coregroup/create-or-modify-coregroup.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = -1
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = -1
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = -1
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.CoreGroupService

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Configure and manage the core group service of this application server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ThreadPool_inactivityTimeout : INTEGER
|  | Specifies the number of milliseconds of inactivity that should elapse before a thread is reclaimed. Default WAS value is '5000'.
|  | ThreadPool_isGrowable : STRING
|  | Specifies whether the number of threads can increase beyond the maximum size configured for the thread pool. Default WAS value is 'true'. values(true, false)
|  | ThreadPool_maximumSize : INTEGER
|  | Specifies the maximum number of threads that are allowed in the pool. Default WAS value is '6'.
|  | ThreadPool_minimumSize : INTEGER
|  | Specifies the minimum number of threads that are allowed in the pool. Default WAS value is '2'.
|  | activateEnabled : STRING
|  | Specifies whether high availability group members can be activated on this server. Default WAS value is 'true'. values(true, false)
|  | coreGroupName : STRING
|  | The name of the core group which contains this server as a member (CoreGroupServer).
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enable : STRING
|  | Specifies whether the core group service, also known as the high availability manager service, is started on this process. This service must be enabled for high availability functions such as routing and failover to work properly. By default, this service is enabled. values(true, false)
|  | isAlivePeriodSec : INTEGER
|  | Specifies how frequently, in seconds, the high availability manager checks the health of the active group members on this server. If a group member has failed, this server is restarted. Default WAS value is '120'.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | transportBufferSize : INTEGER
|  | Buffer size for the underlying Group Communication System stack. Default WAS value is '10'.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = CoreGroupService
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = HAManagerService
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.CoreGroupServiceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Configure and manage the core group service of this application server.

|  | Public Properties
--- | --- | ---
|  | ThreadPool_inactivityTimeout : STRING
|  | Specifies the number of milliseconds of inactivity that should elapse before a thread is reclaimed. Default WAS value is '5000'. (integer)
|  | ThreadPool_isGrowable : STRING
|  | Specifies whether the number of threads can increase beyond the maximum size configured for the thread pool. Default WAS value is 'true'. values(true, false) (string)
|  | ThreadPool_maximumSize : STRING
|  | Specifies the maximum number of threads that are allowed in the pool. Default WAS value is '6'. (integer)
|  | ThreadPool_minimumSize : STRING
|  | Specifies the minimum number of threads that are allowed in the pool. Default WAS value is '2'. (integer)
|  | activateEnabled : STRING
|  | Specifies whether high availability group members can be activated on this server. Default WAS value is 'true'. values(true, false) (string)
|  | coreGroupName : STRING
|  | The name of the core group which contains this server as a member (CoreGroupServer). (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group service. (map_string_string)
|  | enable : STRING
|  | Specifies whether the core group service, also known as the high availability manager service, is started on this process. This service must be enabled for high availability functions such as routing and failover to work properly. By default, this service is enabled. values(true, false) (string)
|  | isAlivePeriodSec : STRING
|  | Specifies how frequently, in seconds, the high availability manager checks the health of the active group members on this server. If a group member has failed, this server is restarted. Default WAS value is '120'. (integer)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | transportBufferSize : STRING
|  | Buffer size for the underlying Group Communication System stack. Default WAS value is '10'. (integer)

#### was.CoreGroupSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

A core group is a grouping of WebSphere(R) Application Server cell processes. A core group can contain stand-alone servers, cluster members, node agents, and the deployment manager.

|  | Children
--- | --- | ---
|  | policies : SET_OF_CI<was.HAManagerPolicySpec >
|  | Specify policies associated with a core group. Coordinators use these policies to determine on which servers the core group members are activated or deactivated.

|  | Public Properties
--- | --- | ---
|  | Liveness_discoveryPeriod : STRING
|  | The time interval, in seconds, at which the discovery protocol runs. Increasing this value might decrease the use of system resources such as CPU. Decreasing this value might improve the detection of core group members. (integer) default(60)
|  | Liveness_factoryClassName : STRING
|  | The fully qualified class name of the factory that is used to create the protocol providers. This property is valid only with PLUGIN_ONLY protocol providers. (string)
|  | Liveness_heartbeatTimeoutPeriod : STRING
|  | The time interval, in milliseconds, that constitutes a heartbeat timeout. This value must be an integer multiple of the heartbeat transmission period. (integer) default(180000)
|  | Liveness_heartbeatTransmissionPeriod : STRING
|  | The time interval, in milliseconds, at which active failure detection heartbeats are sent. Increasing this value might decrease the use of system resources such as CPU. Decreasing this value might improve the detection of failed core group members. (integer) default(30000)
|  | Liveness_livenessType : STRING
|  | Specify to use default or alternative protocol providers. Depending on your platform, alternate protocol providers might be available. (enum) values(DEFAULT_ONLY, PLUGIN_ONLY) default(DEFAULT_ONLY)
|  | channelChainName : STRING
|  | Specifies the transport channel chain to use for the channel framework transport type. Values: 'DCS'(default), 'DCS-Secure'. (string) default(DCS)
|  | containerRestartStrategy : STRING
|  | Strategy to restart Core Group member servers. (enum) values(NONE, STOP_START, RESTART) default(STOP_START)
|  | coreGroupClusters : SET_OF_STRING
|  | Specifies the clusters that belong to the core group.
|  | coreGroupServers : SET_OF_STRING
|  | Specifies the servers that belong to the core group.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the core group. (string)
|  | numCoordinators : STRING
|  | Specifies the number of active coordinators. (integer) default(1)
|  | preferredCoordinatorServers : LIST_OF_STRING
|  | The high availability manager uses an ordered list of preferred core group servers when it selects servers to host the coordinators. If the default list is inappropriate, you can change the list such that other servers are selected as coordinators.
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | transportMemorySize : STRING
|  | The maximum size of dynamically allocated memory, in megabytes, that the transport can hold. The range is from 10 to 2147483647 megabytes, however, this value cannot be larger than the maximum heap size specified for the Java virtual machine. When this limit is reached, congestion control is invoked. (integer) default(100)
|  | transportType : STRING
|  | Specifies the communication protocol within a core group. (enum) values(UNICAST, MULTICAST, CHANNEL_FRAMEWORK) default(CHANNEL_FRAMEWORK)

#### was.CustomProperties

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies custom properties for any WebSphere container.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | properties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for the WebSphere container.
|  | targetAttribute : STRING = properties
|  | Name of the properties attribute on WebSphere container type.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | overwriteExisting : BOOLEAN = true
|  | If set, existing custom properties of the same name will be overwritten. Otherwise, the value will be appended to the existing property value.
|  | removeNotPresent : BOOLEAN = false
|  | If set, custom properties present on the target container, but not specified in this deployed will be removed. Otherwise, properties and their values will be left as is.
|  | targetComponent : STRING =
|  | WebSphere component type to which the properties should be deployed.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/custom/create-or-modify-custom-properties.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/server/custom/destroy-custom-properties.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/custom/discover-inspect-custom-properties.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/custom/custom-properties-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/custom/create-or-modify-custom-properties.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | NOT APPLICABLE
|  | overwriteExistingValues : BOOLEAN = false
|  | NOT APPLICABLE
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.CustomPropertiesSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies custom properties for any WebSphere container.

|  | Public Properties
--- | --- | ---
|  | overwriteExisting : STRING
|  | If set, existing custom properties of the same name will be overwritten. Otherwise, the value will be appended to the existing property value. (boolean) default(true)
|  | properties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for the WebSphere container. (map_string_string)
|  | removeNotPresent : STRING
|  | If set, custom properties present on the target container, but not specified in this deployed will be removed. Otherwise, properties and their values will be left as is. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | targetAttribute : STRING
|  | Name of the properties attribute on WebSphere container type. (string) default(properties)
|  | targetComponent : STRING
|  | WebSphere component type to which the properties should be deployed. (string) default()

#### was.CustomService

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Custom services defines a class that is loaded and initialized whenever the server starts and shuts down.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classname : STRING
|  | Specifies the class name of the service implementation.
|  | classpath : STRING
|  | Specifies the classpath used to locate the classes and JAR files for this service.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of the custom service.
|  | enable : BOOLEAN = false
|  | Specifies whether or not the server attempts to start the specified service when server starts.
|  | externalConfigURL : STRING
|  | Specifies the URL for a custom service configuration file.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name, customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/customservice/create-custom-service.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/customservice/destroy-custom-service.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/customservice/discover-inspect-custom-service.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/customservice/custom-service-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.CustomServiceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Custom services defines a class that is loaded and initialized whenever the server starts and shuts down.

|  | Public Properties
--- | --- | ---
|  | classname : STRING
|  | Specifies the class name of the service implementation. (string)
|  | classpath : STRING
|  | Specifies the classpath used to locate the classes and JAR files for this service. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | description : STRING
|  | Specifies the description of the custom service. (string)
|  | enable : STRING
|  | Specifies whether or not the server attempts to start the specified service when server starts. (boolean) default(false)
|  | externalConfigURL : STRING
|  | Specifies the URL for a custom service configuration file. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.DB2Datasource

Virtual Type
Type Hierarchy | was.Datasource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed DB2 data source configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | databaseName : STRING
|  | This is an actual database name, and its not the locally catalogued database name. The Universal JDBC Driver does not rely on information catalogued in the DB2 database directory.
|  | datasourceHelperClassname : STRING
|  | Specifies the data source helper class.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.DB2Type2Datasource

Type Hierarchy | was.DB2Datasource >> was.Datasource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

DB2 type 2 data source object supplies your application with connections for accessing the database.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | databaseName : STRING
|  | This is an actual database name, and its not the locally catalogued database name. The Universal JDBC Driver does not rely on information catalogued in the DB2 database directory.
|  | datasourceHelperClassname : STRING
|  | Specifies the data source helper class.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/datasource/discover-inspect-db2-type2-datasources.py
|  | Python wsadmin script invoked to discover a JDBC data sources.
|  | driverType : STRING = 2
|  | Driver Type
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.DB2Type2DatasourceSpec

Type Hierarchy | jee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a DB2 type 2 data source. On WebSphere Application Server for Z/OS, driverType 2 uses RRS and supports 2-phase commit processing.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies connection timeout value for a JDBC data source. (integer) default(180)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies Maximum number of connections for a JDBC data source. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies Minimum number of connections for a JDBC data source. (integer) default(1)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | containerManagedPersistence : STRING
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans. (boolean) default(true)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | databaseName : STRING
|  | This is an actual database name, and its not the locally catalogued database name. The Universal JDBC Driver does not rely on information catalogued in the DB2 database directory. (string)
|  | datasourceHelperClassname : STRING
|  | Specifies the data source helper class. (string)
|  | description : STRING
|  | Specifies the description of this data source. (string)
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set. (string)
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source. (string)
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference. (string)
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | testConnection : STRING
|  | If set, the connection to the database is tested. (boolean) default(false)
|  | useJaasAliasForContainerManagedAuthentication : STRING
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource. (boolean)
|  | useJaasAliasForXaRecovery : STRING
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers. (boolean)
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)

#### was.DB2Type4Datasource

Type Hierarchy | was.DB2Datasource >> was.Datasource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

DB2 type 4 data source object supplies your application with connections for accessing the database.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | databaseName : STRING
|  | This is an actual database name, and its not the locally catalogued database name. The Universal JDBC Driver does not rely on information catalogued in the DB2 database directory.
|  | datasourceHelperClassname : STRING
|  | Specifies the data source helper class.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | portNumber : INTEGER = 50000
|  | The TCP/IP port number where the DRDA server resides. If property driverType is set to 4, this property is required.
|  | serverName : STRING
|  | The TCP/IP address or host name for the DRDA server. If property driverType is set to 4, this property is required.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/datasource/discover-inspect-db2-type4-datasources.py
|  | Python wsadmin script invoked to discover a JDBC data sources.
|  | driverType : STRING = 4
|  | Driver Type
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.DB2Type4DatasourceSpec

Type Hierarchy | jee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a DB2 type 4 data source.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies connection timeout value for a JDBC data source. (integer) default(180)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies Maximum number of connections for a JDBC data source. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies Minimum number of connections for a JDBC data source. (integer) default(1)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | containerManagedPersistence : STRING
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans. (boolean) default(true)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | databaseName : STRING
|  | This is an actual database name, and its not the locally catalogued database name. The Universal JDBC Driver does not rely on information catalogued in the DB2 database directory. (string)
|  | datasourceHelperClassname : STRING
|  | Specifies the data source helper class. (string)
|  | description : STRING
|  | Specifies the description of this data source. (string)
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set. (string)
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source. (string)
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference. (string)
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)
|  | portNumber : STRING
|  | The TCP/IP port number where the DRDA server resides. If property driverType is set to 4, this property is required. (integer) default(50000)
|  | serverName : STRING
|  | The TCP/IP address or host name for the DRDA server. If property driverType is set to 4, this property is required. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | testConnection : STRING
|  | If set, the connection to the database is tested. (boolean) default(false)
|  | useJaasAliasForContainerManagedAuthentication : STRING
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource. (boolean)
|  | useJaasAliasForXaRecovery : STRING
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers. (boolean)
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)

#### was.Datasource

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed data source configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | datasourceHelperClassname : STRING
|  | Specifies the data source helper class.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.Deployable

Virtual Type
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Base class for all deployable configutation items.

|  | Public Properties
--- | --- | ---
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.DeploymentManager

Type Hierarchy | was.BaseCell >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, python.PythonManagingContainer, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, was.Cell, udm.Container, overthere.HostContainer

A WebSphere Application Server deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | host : CI<overthere.Host>
|  | Host on which the WAS server runs

|  | Children
--- | --- | ---
|  | clusters : SET_OF_CI<was.Cluster >
|  | WebSphere clusters in the cell
|  | nodeAgents : SET_OF_CI<was.NodeAgent >
|  | WebSphere nodes in the cell

|  | Public Properties
--- | --- | ---
|  | port : INTEGER
|  | TCP port which is used to login to the WebSphere Administration, defaults to 8880 for SA, 8879 for ND. Value of '0' has special meaning: it'used to suppress passing '-port' argument to wsadmin.
|  | version : ENUM [WAS_61, WAS_70, WAS_80, WAS_85]
|  | Version of WebSphere Application Server.
|  | wasHome : STRING
|  | Path to the WebSphere profile or deployment manager profile, where bin/wsadmin can be found. For example, /opt/ws/6.1/appserver/profiles/AppSrv01
|  | hostname : STRING
|  | Hostname to which wsadmin should attempt to connect.
|  | password : STRING
|  | Password which is used to login to the WebSphere Administration.
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.
|  | unmanagedWebServers : LIST_OF_CI<was.UnmanagedWebServer >
|  | List of unmanaged web servers.
|  | updateGlobalPlugin : BOOLEAN
|  | If set, the global web server plugin configuration will be updated. Plugin configuration will be propagated to all unmanaged web servers.
|  | username : STRING
|  | Username which is used to login to the WebSphere Administration.

|  | Hidden Properties
--- | --- | ---
|  | deployedsToDiscover : SET_OF_STRING = [was.VirtualHost, was.SharedLibrary]
|  | Deployeds To Discover
|  | inspectScript : STRING = was/container/discover-inspect-topology.py
|  | Inspect script for Cell
|  | propagateGlobalPluginOrder : INTEGER = 82
|  | Propagate Global Plugin Order
|  | updateGlobalPluginOrder : INTEGER = 81
|  | Update Global Plugin Order
|  | updateGlobalPluginScript : STRING = was/container/generate-global-plugin.py
|  | Update Global Plugin Script
|  | configDirName : STRING = config
|  | Config directory name of WebSphere Application Server.
|  | libraryScripts : LIST_OF_STRING = [was/container/discover-inspect-topology-lib.py, was/container/container-lib.py]
|  | List of scripts to appended to runtime script
|  | runWithDaemon : BOOLEAN = true
|  | Set to true to execute commands with the Python daemon
|  | versionInfoNameField : STRING = Name
|  | Translated text of "Name" used to resolve version of WebSphere Application Server running in a non-English language.

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
restartDmgr | was.DmgrControlTaskParameters | delegate = dmgrRestart | Restart deployment manager and/or node agents.
startDmgr | was.DmgrControlTaskParameters | delegate = dmgrStart | Start deployment manager and/or node agents.
stopDmgr | was.DmgrControlTaskParameters | delegate = dmgrStop | Stop deployment manager and/or node agents.

#### was.DerbyDatasource

Type Hierarchy | was.Datasource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Derby data source object supplies your application with connections for accessing the database.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | databaseName : STRING
|  | Specifies the name of the database to which the datasource connects.
|  | datasourceHelperClassname : STRING = com.ibm.websphere.rsadapter.DerbyDataStoreHelper
|  | Specifies the data store helper class, an interface through which a datasource is triggered by a database to perform functions specific to that database vendor.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/datasource/discover-inspect-derby-datasources.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.DerbyDatasourceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a Derby datasource.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies connection timeout value for a JDBC data source. (integer) default(180)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies Maximum number of connections for a JDBC data source. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies Minimum number of connections for a JDBC data source. (integer) default(1)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | containerManagedPersistence : STRING
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans. (boolean) default(true)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | databaseName : STRING
|  | Specifies the name of the database to which the datasource connects. (string)
|  | datasourceHelperClassname : STRING
|  | Specifies the data store helper class, an interface through which a datasource is triggered by a database to perform functions specific to that database vendor. (string) default(com.ibm.websphere.rsadapter.DerbyDataStoreHelper)
|  | description : STRING
|  | Specifies the description of this data source. (string)
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set. (string)
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source. (string)
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference. (string)
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | testConnection : STRING
|  | If set, the connection to the database is tested. (boolean) default(false)
|  | useJaasAliasForContainerManagedAuthentication : STRING
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource. (boolean)
|  | useJaasAliasForXaRecovery : STRING
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers. (boolean)
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)

#### was.DmgrControlTaskParameters

Type Hierarchy | udm.Parameters >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem

Deploymenta manager control task parameters

|  | Public Properties
--- | --- | ---
|  | target : ENUM [DEPLOYMENT_MANAGER_AND_NODE_AGENTS, DEPLOYMENT_MANAGER, NODE_AGENTS] = DEPLOYMENT_MANAGER_AND_NODE_AGENTS
|  | Target

#### was.DynamicCluster

Type Hierarchy | was.Cluster >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | was.WasAppContainer, udm.Taggable, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

A WebSphere dynamic cluster managed by a WebSphere deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | cell : CI<was.DeploymentManager >
|  | Deployment manager that manages this this cluster

|  | Public Properties
--- | --- | ---
|  | checkStartedInterval : INTEGER = 10
|  | Number of seconds to sleep inbetween the checking of cluster started.
|  | checkStoppedInterval : INTEGER = 10
|  | Number of seconds to sleep inbetween the checking of cluster stopped.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | Restart strategy used when deploying. Valid values are: NONE, STOP_START, RESTART. For example, if the STOP_START strategy is used, the container will be stopped before deployment and started after deployment. If the RESTART strategy is used, the deployment will be executed, then container will be restarted using the restart script. If there is no restart script defined, the deployment will be executed, then the container will be stopped and immediately started. Note that it may be preferable to use the containerRestartStrategy property defined on was.Module and its subtypes.
|  | maxInstances : INTEGER = -1
|  | Choose the Maximum number of instances to have running when the dynamic cluster is activated,The Default is -1(Do not limit the number of instances that can start)
|  | membershipPolicy : STRING = node_nodegroup = 'DefaultNodeGroup'
|  | Specify an expression that is used to define which nodes are used for the dynamic cluster.Ex:node_nodegroup = 'my_node_group'
|  | minInstances : INTEGER = 1
|  | Choose the minimum number of instances to have running when the dynamic cluster is activated,The Default is 1
|  | numVerticalInstances : INTEGER = 0
|  | If the nodes in the dynamic cluster have extra capacity, vertical stacking allows an application to make more effective use of the capacity by starting multiple instances on the same node,The Default is 0
|  | enableRippleStart : BOOLEAN
|  | failOnPartialApplicationStart : BOOLEAN = true
|  | Specify if the deployment should fail when application fails to start on all servers in the cluster.
|  | operationalMode : ENUM [MANUAL, AUTOMATIC, SUPERVISED] = MANUAL
|  | Specifies the level that the dynamic cluster interacts with the dynamic operations environment.
|  | serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER] = APPLICATION_SERVER
|  | Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER. Default value: APPLICATION_SERVER. Available since: WAS_70
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.

|  | Hidden Properties
--- | --- | ---
|  | restartOrder : INTEGER = 80
|  | Restart Order
|  | startOrder : INTEGER = 80
|  | Start Order
|  | startScript : STRING = was/container/start-cluster.py
|  | Start Script
|  | stopOrder : INTEGER = 20
|  | Stop Order
|  | stopScript : STRING = was/container/stop-cluster.py
|  | Stop Script
|  | createPythonScript : STRING = was/container/create-dynamic-cluster.py
|  | Create Python Script
|  | destroyPythonScript : STRING = was/container/destroy-dynamic-cluster.py
|  | Destroy Python Script
|  | modifyPythonScript : STRING = was/container/modify-dynamic-cluster.py
|  | Modify Python Script
|  | servers : SET_OF_CI<was.ManagedServer >
|  | Servers that are part of this cluster

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
create |  |  | This control task is used to create a new DynamicCluster
destroy |  |  | This control task is used to destroy an existing DynamicCluster
modify |  |  | This control task is used to modify the properties of an existing DynamicCluster
start |  | language = python, script = was/container/start-cluster.py | Start cluster.
stop |  | language = python, script = was/container/stop-cluster.py | Stop cluster.

#### was.DynamicOdrCluster

Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

A WebSphere dynamic ODR cluster managed by a WebSphere deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | cell : CI<was.DeploymentManager >
|  | Deployment manager that manages this node agent

|  | Public Properties
--- | --- | ---
|  | maxInstances : INTEGER = -1
|  | Choose the Maximum number of instances to have running when the dynamic ODR cluster is activated.
|  | membershipPolicy : STRING = node_nodegroup = 'DefaultNodeGroup'
|  | Specify an expression that is used to define which nodes are used for the dynamic ODR cluster.Ex:node_nodegroup = 'my_node_group'
|  | minInstances : INTEGER = 1
|  | Choose the minimum number of instances to have running when the dynamic ODR cluster is activated.
|  | numVerticalInstances : INTEGER = 0
|  | If the nodes in the dynamic ODR cluster have extra capacity, vertical stacking allows an application to make more effective use of the capacity by starting multiple instances on the same node.
|  | memberTemplateName : STRING
|  | Select a server template on which to model the servers for the new dynamic cluster,Uses the system default if not set
|  | nodeGroupName : STRING = DefaultNodeGroup
|  | The node group in which to create cluster members. Required for WAS_85
|  | operationalMode : ENUM [MANUAL, AUTOMATIC, SUPERVISED] = MANUAL
|  | Specifies the level that the dynamic cluster interacts with the dynamic operations environment.
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.

|  | Hidden Properties
--- | --- | ---
|  | createPythonScript : STRING = was/container/create-dynamic-odr-cluster.py
|  | Create Python Script
|  | destroyPythonScript : STRING = was/container/destroy-dynamic-cluster.py
|  | Destroy Python Script
|  | modifyPythonScript : STRING = was/container/modify-dynamic-cluster.py
|  | Modify Python Script

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
create |  |  | This control task is used to create a new DynamicOdrCluster
destroy |  |  | This control task is used to destroy an existing DynamicOdrCluster
modify |  |  | This control task is used to modify the properties of an existing DynamicOdrCluster

#### was.EJBContainer

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Configure and manage the EJB container of this application server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | EJBAsync_customWorkManagerJNDIName : STRING
|  | Specifies the JNDI name of a work manager instance to use for asynchronous method invocation. Not supported for: WAS_61, WAS_70.
|  | EJBAsync_futureTimeout : INTEGER
|  | This is the amount of time the server retains the results of each asynchronous method call. If an application doesn't retrieve the results within the specified period of time, the server purges that method call's results to prevent memory leakage. You can specify 0 to never purge the objects, however, this is not recommended. The default value is 86400 seconds (24 hours). Not supported for: WAS_61, WAS_70.
|  | EJBAsync_maxThreads : INTEGER
|  | The number of asynchronous methods that can be running concurrently. You can change this value to balance the system's throughput with the system resources that are used. The default value is 5. Not supported for: WAS_61, WAS_70.
|  | EJBAsync_useCustomDefinedWM : STRING
|  | Specify a more advanced configuration for EJB asynchronous methods by defining a custom work manager instance. Not supported for: WAS_61, WAS_70. Default WAS value is 'false'. values(true, false)
|  | EJBAsync_workReqQFullAction : INTEGER
|  | Specifies the action that is taken by the system when the work request queue is full and additional requests are received. Valid values are 0-Block and 1-Fail. The default value is 0-Block. Not supported for: WAS_61, WAS_70.
|  | EJBAsync_workReqQSize : INTEGER
|  | The maximum number of asynchronous method requests that can be queued while waiting for a thread to become available. The thread pool pulls asynchronous method requests from this queue. The value may be 0 or greater. If you specify 0 or the value is blank, the queue size is managed automatically. Large values can consume significant system resources. The default value is 0, which indicates that the queue size is managed by the runtime environment. The runtime currently uses the larger of 20 and the value of maximum number of threads. Not supported for: WAS_61, WAS_70.
|  | EJBCache_cacheSize : INTEGER
|  | Specifies the number of buckets in the active instance list within the EJB container. Default WAS value is '2053'.
|  | EJBCache_cleanupInterval : INTEGER
|  | Specifies the interval at which the container attempts to remove unused items from the cache in order to reduce the total number of items to the value of the cache size. Default WAS value is '3000'.
|  | EJBTimer_datasourceAlias : STRING
|  | Specifies the alias for the user name and password that are used to access the data source.
|  | EJBTimer_datasourceJNDIName : STRING
|  | Specifies the name of the data source where persistent EJB timers are stored.
|  | EJBTimer_nonPersistentTimerRetryCount : INTEGER
|  | When a non-persistent timer expires, the timeout callback method is called. This setting controls how many times the EJB container attempts to retry the timer. If the transaction for this callback method fails or is rolled back, the EJB container must retry the timer at least once. The default value is -1, which means the EJB container retries infinitely until the timer is successful. Not supported for: WAS_61, WAS_70. Default WAS value is '-1'.
|  | EJBTimer_nonPersistentTimerRetryInterval : INTEGER
|  | When a non-persistent timer expires, the timeout callback method is called. If the transaction for this callback method fails or is rolled back, the container must retry the timer. The first retry attempt occurs immediately, and subsequent retry attempts are delayed by the number of seconds specified. If the value is set to 0, then all retries occur immediately. If you do not specify a value, the default interval is 300 seconds. Not supported for: WAS_61, WAS_70. Default WAS value is '300'.
|  | EJBTimer_numAlarmThreads : INTEGER
|  | Specifies the desired maximum number of threads used for timers. Default WAS value is '1'.
|  | EJBTimer_numNPTimerThreads : INTEGER
|  | Specifies the desired maximum number of threads used for timers. This property is valid only when separate thread pool is created for non-persistent timers. Not supported for: WAS_61, WAS_70. Default WAS value is '1'.
|  | EJBTimer_pollInterval : INTEGER
|  | Specifies the interval, in seconds, in which the scheduler polls the database for expiring EJB timers. Default WAS value is '300'.
|  | EJBTimer_schedulerJNDIName : STRING
|  | Specifies the JNDI name of a scheduler instance to use for managing and persisting EJB timers.
|  | EJBTimer_tablePrefix : STRING
|  | Specifies the prefix string that prefaces the scheduler tables. Multiple independent schedulers can share the same database if each scheduler specifies a different prefix string. Default WAS value is 'EJBTIMER_'.
|  | EJBTimer_uniqueTimerManagerForNP : STRING
|  | Specifies that non-persistent timers do not share a thread pool with persistent timers. Rather, a unique thread pool is created for non-persistent timers only. Not supported for: WAS_61, WAS_70. Default WAS value is 'false'. values(true, false)
|  | defaultDatasourceJNDIName : STRING
|  | Specifies the JNDI name of a data source to use if no data source has been specified during application deployment. This setting is not applicable for EJB 2.x-compliant CMP beans.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enableSFSBFailover : STRING
|  | Specifies that failover is enabled for all stateful session beans installed in this EJB container. Default WAS value is 'false'. values(true, false)
|  | inactivePoolCleanupInterval : INTEGER
|  | Specifies the interval at which the container examines the pools of available bean instances to determine if some instances can be deleted to reduce memory usage. Default WAS value is '30000'.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | passivationDirectory : STRING
|  | Specifies the directory into which the container saves the persistent state of passivated stateful session beans. Default WAS value is '${USER_INSTALL_ROOT}/temp'.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = EJBContainer
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = EJBContainer
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.EJBContainerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Configure and manage the EJB container of this application server.

|  | Public Properties
--- | --- | ---
|  | EJBAsync_customWorkManagerJNDIName : STRING
|  | Specifies the JNDI name of a work manager instance to use for asynchronous method invocation. Not supported for: WAS_61, WAS_70. (string)
|  | EJBAsync_futureTimeout : STRING
|  | This is the amount of time the server retains the results of each asynchronous method call. If an application doesn't retrieve the results within the specified period of time, the server purges that method call's results to prevent memory leakage. You can specify 0 to never purge the objects, however, this is not recommended. The default value is 86400 seconds (24 hours). Not supported for: WAS_61, WAS_70. (integer)
|  | EJBAsync_maxThreads : STRING
|  | The number of asynchronous methods that can be running concurrently. You can change this value to balance the system's throughput with the system resources that are used. The default value is 5. Not supported for: WAS_61, WAS_70. (integer)
|  | EJBAsync_useCustomDefinedWM : STRING
|  | Specify a more advanced configuration for EJB asynchronous methods by defining a custom work manager instance. Not supported for: WAS_61, WAS_70. Default WAS value is 'false'. values(true, false) (string)
|  | EJBAsync_workReqQFullAction : STRING
|  | Specifies the action that is taken by the system when the work request queue is full and additional requests are received. Valid values are 0-Block and 1-Fail. The default value is 0-Block. Not supported for: WAS_61, WAS_70. (integer)
|  | EJBAsync_workReqQSize : STRING
|  | The maximum number of asynchronous method requests that can be queued while waiting for a thread to become available. The thread pool pulls asynchronous method requests from this queue. The value may be 0 or greater. If you specify 0 or the value is blank, the queue size is managed automatically. Large values can consume significant system resources. The default value is 0, which indicates that the queue size is managed by the runtime environment. The runtime currently uses the larger of 20 and the value of maximum number of threads. Not supported for: WAS_61, WAS_70. (integer)
|  | EJBCache_cacheSize : STRING
|  | Specifies the number of buckets in the active instance list within the EJB container. Default WAS value is '2053'. (integer)
|  | EJBCache_cleanupInterval : STRING
|  | Specifies the interval at which the container attempts to remove unused items from the cache in order to reduce the total number of items to the value of the cache size. Default WAS value is '3000'. (integer)
|  | EJBTimer_datasourceAlias : STRING
|  | Specifies the alias for the user name and password that are used to access the data source. (string)
|  | EJBTimer_datasourceJNDIName : STRING
|  | Specifies the name of the data source where persistent EJB timers are stored. (string)
|  | EJBTimer_nonPersistentTimerRetryCount : STRING
|  | When a non-persistent timer expires, the timeout callback method is called. This setting controls how many times the EJB container attempts to retry the timer. If the transaction for this callback method fails or is rolled back, the EJB container must retry the timer at least once. The default value is -1, which means the EJB container retries infinitely until the timer is successful. Not supported for: WAS_61, WAS_70. Default WAS value is '-1'. (integer)
|  | EJBTimer_nonPersistentTimerRetryInterval : STRING
|  | When a non-persistent timer expires, the timeout callback method is called. If the transaction for this callback method fails or is rolled back, the container must retry the timer. The first retry attempt occurs immediately, and subsequent retry attempts are delayed by the number of seconds specified. If the value is set to 0, then all retries occur immediately. If you do not specify a value, the default interval is 300 seconds. Not supported for: WAS_61, WAS_70. Default WAS value is '300'. (integer)
|  | EJBTimer_numAlarmThreads : STRING
|  | Specifies the desired maximum number of threads used for timers. Default WAS value is '1'. (integer)
|  | EJBTimer_numNPTimerThreads : STRING
|  | Specifies the desired maximum number of threads used for timers. This property is valid only when separate thread pool is created for non-persistent timers. Not supported for: WAS_61, WAS_70. Default WAS value is '1'. (integer)
|  | EJBTimer_pollInterval : STRING
|  | Specifies the interval, in seconds, in which the scheduler polls the database for expiring EJB timers. Default WAS value is '300'. (integer)
|  | EJBTimer_schedulerJNDIName : STRING
|  | Specifies the JNDI name of a scheduler instance to use for managing and persisting EJB timers. (string)
|  | EJBTimer_tablePrefix : STRING
|  | Specifies the prefix string that prefaces the scheduler tables. Multiple independent schedulers can share the same database if each scheduler specifies a different prefix string. Default WAS value is 'EJBTIMER_'. (string)
|  | EJBTimer_uniqueTimerManagerForNP : STRING
|  | Specifies that non-persistent timers do not share a thread pool with persistent timers. Rather, a unique thread pool is created for non-persistent timers only. Not supported for: WAS_61, WAS_70. Default WAS value is 'false'. values(true, false) (string)
|  | defaultDatasourceJNDIName : STRING
|  | Specifies the JNDI name of a data source to use if no data source has been specified during application deployment. This setting is not applicable for EJB 2.x-compliant CMP beans. (string)
|  | enableSFSBFailover : STRING
|  | Specifies that failover is enabled for all stateful session beans installed in this EJB container. Default WAS value is 'false'. values(true, false) (string)
|  | inactivePoolCleanupInterval : STRING
|  | Specifies the interval at which the container examines the pools of available bean instances to determine if some instances can be deleted to reduce memory usage. Default WAS value is '30000'. (integer)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | passivationDirectory : STRING
|  | Specifies the directory into which the container saves the persistent state of passivated stateful session beans. Default WAS value is '${USER_INSTALL_ROOT}/temp'. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.Ear

Type Hierarchy | jee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Java EE EAR archive.

|  | Children
--- | --- | ---
|  | ejbModules : SET_OF_CI<was.EmbeddedEjbModuleSpec >
|  | Specify EJB modules contained by this enterprise application.
|  | sessionManagers : SET_OF_CI<was.SessionManagerSpec >
|  | Specify the session manager options for the application and modules.
|  | webModules : SET_OF_CI<was.EmbeddedWebModuleSpec >
|  | Specify Web modules contained by this enterprise application.

|  | Public Properties
--- | --- | ---
|  | additionalInstallFlags : SET_OF_STRING
|  | The additional install flags to be passed to AdminApp.install (set_of_string)
|  | allowDispatchRemoteInclude : STRING
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism. (boolean)
|  | allowServiceRemoteInclude : STRING
|  | Specifies whether an application can service an include request from an application. (boolean)
|  | appEdition : STRING
|  | Edition used by this application. (string)
|  | applyRestartStrategyOnNoop : STRING
|  | When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
|  | asyncRequestDispatchType : STRING
|  | Enables asynchronous dispatching and specifies how to aggregate the content. (enum) values(DISABLED, SERVER_SIDE, CLIENT_SIDE) default(DISABLED)
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|  | classloaderMode : STRING
|  | Specifies whether classes are loaded using the parent class loader before the application class loader. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | containerRestartStrategy : STRING
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container. (enum) values(NONE, STOP_START, RESTART) default(NONE)
|  | createMBeansForResources : STRING
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
|  | disableJspRuntimeCompilation : STRING
|  | Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default). (string) default(No)
|  | drainageInterval : STRING
|  | Drainage interval in seconds. (integer) default(30)
|  | editionDescription : STRING
|  | Edition description used by this application. (string)
|  | enableDistribution : STRING
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution. (boolean) default(true)
|  | enableJspClassReloading : STRING
|  | Specify JSP reloading for Web modules. (boolean) default(true)
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | groupSize : STRING
|  | Specifies num of members in a cluster. (integer) default(1)
|  | isEdition : STRING
|  | Edition used by this application. (boolean) default(false)
|  | jdkSourceLevel : STRING
|  | Specify JDK source level. (string) default(15)
|  | jsfImplementation : STRING
|  | If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239). (string)
|  | jspClassPath : STRING
|  | Specify JSP precompiler classpath. (string) default(jspcp)
|  | jspReloadInterval : STRING
|  | The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set. (integer) default(10)
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT. (string)
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | preCompileJsps : STRING
|  | Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files. (boolean) default(false)
|  | reloadEnabled : STRING
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application. (boolean)
|  | reloadInterval : STRING
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application. (integer)
|  | resetStrategy : STRING
|  | Indicates type of reset strategy. (enum) values(SOFT, HARD) default(SOFT)
|  | restartStrategy : STRING
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start. (enum) values(NONE, STOP, START, STOP_START) default(STOP_START)
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone. (map_string_string)
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping (map_string_string)
|  | rolloutStrategy : STRING
|  | Indicates type of rollout strategy. (enum) values(ATOMIC, GROUPED) default(GROUPED)
|  | runAsRoleMappings : MAP_STRING_STRING
|  | Security role to user, password mapping. Given a role 'myRole' mapped to a user called 'myUser' and a password of 'myPassword'. You will have to enter 2 keys, namely 'myRole_user' and 'myRole_password'. (map_string_string)
|  | scanPlaceholders : BOOLEAN = false
|  | Whether to scan this artifact for placeholders when it is imported
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application. (list_of_string)
|  | startingWeight : STRING
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useFullPackageNames : STRING
|  | Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'. (string) default(Yes)
|  | useMetadataFromBinaries : STRING
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application. (boolean)
|  | virtualHostName : STRING
|  | Virtual host this application should be mapped to. (string)
|  | warClassLoaderPolicy : STRING
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application. (enum) values(SINGLE, MULTIPLE)
|  | warClassloaderMode : STRING
|  | WAR-level class loader mode. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | webServerNames : SET_OF_STRING
|  | Specify the Web servers as targets that serve as routers for requests to this application. (set_of_string)

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

#### was.EarModule

Type Hierarchy | was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, was.ConfigurableModule, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

EAR with values configured for a deployment.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Children
--- | --- | ---
|  | ejbModules : SET_OF_CI<was.EmbeddedEjbModule >
|  | Specify EJB modules contained by this enterprise application.
|  | sessionManagers : SET_OF_CI<was.SessionManager >
|  | Specify the session manager options for the application and modules.
|  | webModules : SET_OF_CI<was.EmbeddedWebModule >
|  | Specify Web modules contained by this enterprise application.

|  | Public Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
|  | The additional install flags to be passed to AdminApp.install
|  | allowDispatchRemoteInclude : BOOLEAN
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
|  | allowServiceRemoteInclude : BOOLEAN
|  | Specifies whether an application can service an include request from an application.
|  | appEdition : STRING
|  | Edition used by this application.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
|  | Enables asynchronous dispatching and specifies how to aggregate the content.
|  | classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | Specifies whether classes are loaded using the parent class loader before the application class loader.
|  | createMBeansForResources : BOOLEAN
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | disableJspRuntimeCompilation : STRING = No
|  | Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default).
|  | drainageInterval : INTEGER = 30
|  | Drainage interval in seconds.
|  | editionDescription : STRING
|  | Edition description used by this application.
|  | enableDistribution : BOOLEAN = true
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
|  | enableJspClassReloading : BOOLEAN = true
|  | Specify JSP reloading for Web modules.
|  | groupSize : INTEGER = 1
|  | Specifies num of members in a cluster.
|  | isEdition : BOOLEAN = false
|  | Edition used by this application.
|  | jdkSourceLevel : STRING = 15
|  | Specify JDK source level.
|  | jsfImplementation : STRING
|  | If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239).
|  | jspClassPath : STRING = jspcp
|  | Specify JSP precompiler classpath.
|  | jspReloadInterval : INTEGER = 10
|  | The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set.
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are or
|  | preCompileJsps : BOOLEAN = false
|  | Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
|  | reloadEnabled : BOOLEAN
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
|  | reloadInterval : INTEGER
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
|  | resetStrategy : ENUM [SOFT, HARD] = SOFT
|  | Indicates type of reset strategy.
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping
|  | rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
|  | Indicates type of rollout strategy.
|  | runAsRoleMappings : MAP_STRING_STRING
|  | Security role to user, password mapping. Given a role 'myRole' mapped to a user called 'myUser' and a password of 'myPassword'. You will have to enter 2 keys, namely 'myRole_user' and 'myRole_password'.
|  | sharedLibraries : SET_OF_CI<was.SharedLibrary >
|  | Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application.
|  | startingWeight : INTEGER = 1
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
|  | useFullPackageNames : STRING = Yes
|  | Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'.
|  | useMetadataFromBinaries : BOOLEAN
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
|  | virtualHost : CI<was.VirtualHost >
|  | Virtual host this application should be mapped to. (DEPRECATED. Prefer using: virtualHostName)
|  | virtualHostName : STRING
|  | Virtual host this application should be mapped to.
|  | warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.
|  | warClassloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | WAR-level class loader mode.
|  | webServerNames : SET_OF_STRING
|  | Specify the Web servers as targets that serve as routers for requests to this application.
|  | webServers : SET_OF_CI<was.ManagedWebServer >
|  | Specify the Web servers as targets that serve as routers for requests to this application. (DEPRECATED. Prefer using: webServerNames)

|  | Hidden Properties
--- | --- | ---
|  | createEditionedOrder : INTEGER = 10
|  | The order in which a create step for Editioned application will be executed(was85nd only).
|  | createOrder : INTEGER = 70
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/application/deploy-application.py
|  | Python wsadmin script invoked to create a Java EE artifact.
|  | createVerb : STRING = Deploy
|  | The word is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 30
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/application/undeploy-application.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Undeploy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/application/discover-inspect-ear-module.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 70
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Update
|  | The word is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | retryAttemptsForAppReadyCheck : INTEGER = 6
|  | Number of retry attempts to check if an application has been distributed before attempting the application start.
|  | rolloutEditionedOrder : INTEGER = 20
|  | The order in which a rollout step will be executed.
|  | rolloutEditionedScript : STRING = was/application/rollout-edition.py
|  | Python wsadmin script invoked to perform rollout.
|  | rolloutEditionedVerb : STRING = Rollout
|  | The word that is used to prefix a step description for the rollout operation.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 90
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 10
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 75
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 35
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 75
|  | The order in which a synchronize after modify step will be executed.
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING = was/application/start-application.py
|  | Python wsadmin script invoked to start running a Java EE artifact.
|  | stopScript : STRING = was/application/stop-application.py
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.EjbJar

Type Hierarchy | jee.EjbJar >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Java EE EJB archive.

|  | Children
--- | --- | ---
|  | ejbModules : SET_OF_CI<was.EmbeddedEjbModuleSpec >
|  | Specify EJB modules contained by this enterprise application.

|  | Public Properties
--- | --- | ---
|  | additionalInstallFlags : SET_OF_STRING
|  | The additional install flags to be passed to AdminApp.install (set_of_string)
|  | allowDispatchRemoteInclude : STRING
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism. (boolean)
|  | allowServiceRemoteInclude : STRING
|  | Specifies whether an application can service an include request from an application. (boolean)
|  | appEdition : STRING
|  | Edition used by this application. (string)
|  | applyRestartStrategyOnNoop : STRING
|  | When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
|  | asyncRequestDispatchType : STRING
|  | Enables asynchronous dispatching and specifies how to aggregate the content. (enum) values(DISABLED, SERVER_SIDE, CLIENT_SIDE) default(DISABLED)
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|  | classloaderMode : STRING
|  | Specifies whether classes are loaded using the parent class loader before the application class loader. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | containerRestartStrategy : STRING
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container. (enum) values(NONE, STOP_START, RESTART) default(NONE)
|  | createMBeansForResources : STRING
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
|  | drainageInterval : STRING
|  | Drainage interval in seconds. (integer) default(30)
|  | editionDescription : STRING
|  | Edition description used by this application. (string)
|  | ejbClasspath : STRING
|  | Specifies the class path of one or more zipped or Java™ archive (JAR) files on which the JAR or EAR file being installed depends. (string)
|  | ejbDbSchema : STRING
|  | Specifies the name of the schema that you want to create. (string)
|  | ejbDbType : STRING
|  | Specifies the name of the database vendor, which is used to determine database column types, mapping information, Table.sql, and other information. (string)
|  | enableDistribution : STRING
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution. (boolean) default(true)
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | groupSize : STRING
|  | Specifies num of members in a cluster. (integer) default(1)
|  | isEdition : STRING
|  | Edition used by this application. (boolean) default(false)
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT. (string)
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | reloadEnabled : STRING
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application. (boolean)
|  | reloadInterval : STRING
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application. (integer)
|  | resetStrategy : STRING
|  | Indicates type of reset strategy. (enum) values(SOFT, HARD) default(SOFT)
|  | restartStrategy : STRING
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start. (enum) values(NONE, STOP, START, STOP_START) default(STOP_START)
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone. (map_string_string)
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping (map_string_string)
|  | rolloutStrategy : STRING
|  | Indicates type of rollout strategy. (enum) values(ATOMIC, GROUPED) default(GROUPED)
|  | runAsRoleMappings : MAP_STRING_STRING
|  | Security role to user, password mapping. Given a role 'myRole' mapped to a user called 'myUser' and a password of 'myPassword'. You will have to enter 2 keys, namely 'myRole_user' and 'myRole_password'. (map_string_string)
|  | scanPlaceholders : BOOLEAN = false
|  | Whether to scan this artifact for placeholders when it is imported
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application. (list_of_string)
|  | startingWeight : STRING
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useMetadataFromBinaries : STRING
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application. (boolean)
|  | warClassLoaderPolicy : STRING
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application. (enum) values(SINGLE, MULTIPLE)

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

#### was.EjbModule

Type Hierarchy | was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, was.ConfigurableModule, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

EJB with values configured for a deployment.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Children
--- | --- | ---
|  | ejbModules : SET_OF_CI<was.EmbeddedEjbModule >
|  | Specify EJB modules contained by this enterprise application.

|  | Public Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
|  | The additional install flags to be passed to AdminApp.install
|  | allowDispatchRemoteInclude : BOOLEAN
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
|  | allowServiceRemoteInclude : BOOLEAN
|  | Specifies whether an application can service an include request from an application.
|  | appEdition : STRING
|  | Edition used by this application.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
|  | Enables asynchronous dispatching and specifies how to aggregate the content.
|  | classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | Specifies whether classes are loaded using the parent class loader before the application class loader.
|  | createMBeansForResources : BOOLEAN
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | drainageInterval : INTEGER = 30
|  | Drainage interval in seconds.
|  | editionDescription : STRING
|  | Edition description used by this application.
|  | ejbClasspath : STRING
|  | Specifies the class path of one or more zipped or Java™ archive (JAR) files on which the JAR or EAR file being installed depends.
|  | ejbDbSchema : STRING
|  | Specifies the name of the schema that you want to create.
|  | ejbDbType : STRING
|  | Specifies the name of the database vendor, which is used to determine database column types, mapping information, Table.sql, and other information.
|  | enableDistribution : BOOLEAN = true
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
|  | groupSize : INTEGER = 1
|  | Specifies num of members in a cluster.
|  | isEdition : BOOLEAN = false
|  | Edition used by this application.
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are or
|  | reloadEnabled : BOOLEAN
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
|  | reloadInterval : INTEGER
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
|  | resetStrategy : ENUM [SOFT, HARD] = SOFT
|  | Indicates type of reset strategy.
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping
|  | rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
|  | Indicates type of rollout strategy.
|  | runAsRoleMappings : MAP_STRING_STRING
|  | Security role to user, password mapping. Given a role 'myRole' mapped to a user called 'myUser' and a password of 'myPassword'. You will have to enter 2 keys, namely 'myRole_user' and 'myRole_password'.
|  | sharedLibraries : SET_OF_CI<was.SharedLibrary >
|  | Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application.
|  | startingWeight : INTEGER = 1
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
|  | useMetadataFromBinaries : BOOLEAN
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
|  | warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.

|  | Hidden Properties
--- | --- | ---
|  | createEditionedOrder : INTEGER = 10
|  | The order in which a create step for Editioned application will be executed(was85nd only).
|  | createOrder : INTEGER = 70
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/application/deploy-application.py
|  | Python wsadmin script invoked to create a Java EE artifact.
|  | createVerb : STRING = Deploy
|  | The word is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 30
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/application/undeploy-application.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Undeploy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/application/discover-inspect-ejb-module.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 70
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Update
|  | The word is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | retryAttemptsForAppReadyCheck : INTEGER = 6
|  | Number of retry attempts to check if an application has been distributed before attempting the application start.
|  | rolloutEditionedOrder : INTEGER = 20
|  | The order in which a rollout step will be executed.
|  | rolloutEditionedScript : STRING = was/application/rollout-edition.py
|  | Python wsadmin script invoked to perform rollout.
|  | rolloutEditionedVerb : STRING = Rollout
|  | The word that is used to prefix a step description for the rollout operation.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 90
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 10
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 75
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 35
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 75
|  | The order in which a synchronize after modify step will be executed.
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING = was/application/start-application.py
|  | Python wsadmin script invoked to start running a Java EE artifact.
|  | stopScript : STRING = was/application/stop-application.py
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.EjbNameSpaceBinding

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a name binding of an enterprise bean home that has already been configured on a server within the cell.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | applicationServerName : STRING
|  | Specifies the name of the cluster or non-clustered server in which the enterprise bean is configured.
|  | ejbJndiName : STRING
|  | Specifies the enterprise bean JNDI name (the name in the bean bindings, not the java:comp name).
|  | nameInNameSpace : STRING
|  | Specifies a name for this binding in the name space. It is a simple or compound name relative to the portion of the name space where this binding is configured.
|  | applicationNodeName : STRING
|  | Specify the location of the enterprise bean by providing the node name. Specify the node name only if the enterprise bean is running on a single server and not server cluster.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = EjbNameSpaceBinding
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.EjbNameSpaceBindingSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a name binding of an enterprise bean home that has already been configured on a server within the cell.

|  | Public Properties
--- | --- | ---
|  | applicationNodeName : STRING
|  | Specify the location of the enterprise bean by providing the node name. Specify the node name only if the enterprise bean is running on a single server and not server cluster. (string)
|  | applicationServerName : STRING
|  | Specifies the name of the cluster or non-clustered server in which the enterprise bean is configured. (string)
|  | ejbJndiName : STRING
|  | Specifies the enterprise bean JNDI name (the name in the bean bindings, not the java:comp name). (string)
|  | nameInNameSpace : STRING
|  | Specifies a name for this binding in the name space. It is a simple or compound name relative to the portion of the name space where this binding is configured. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.EjbRef

Type Hierarchy | was.ResRef >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Allows you to specify JNDI names of EJBs that are bound to ejb-refs.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to.
|  | resourceRefName : STRING
|  | Specify the resource reference name.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | ejbName : STRING = .*
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules.
|  | resourceType : STRING = .*
|  | Specify the type of referenced resource.

#### was.EjbRefSpec

Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Allows you to specify JNDI names of EJBs that are bound to ejb-refs.

|  | Public Properties
--- | --- | ---
|  | ejbName : STRING
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules. (string) default(.*)
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to. (string)
|  | resourceRefName : STRING
|  | Specify the resource reference name. (string)
|  | resourceType : STRING
|  | Specify the type of referenced resource. (string) default(.*)

#### was.EmbeddedEjbModule

Type Hierarchy | was.EmbeddedModule >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, was.ConfigurableModule, udm.ConfigurationItem, udm.EmbeddedDeployed

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Children
--- | --- | ---
|  | ejbRefs : SET_OF_CI<was.EjbRef >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to ejb-refs.
|  | resourceEnvRefs : SET_OF_CI<was.ResourceEnvRef >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs.
|  | resourceRefs : SET_OF_CI<was.ResourceRef >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | moduleDisplayName : STRING
|  | Specify the display name of the target module.
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application.
|  | startingWeight : INTEGER = 1
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
|  | uri : STRING
|  | Specify the target module URI (i.e. EjbModule.jar,META-INF/ejb-jar.xml)

#### was.EmbeddedEjbModuleSpec

Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Description unavailable (deployable)

|  | Children
--- | --- | ---
|  | ejbRefs : SET_OF_CI<was.EjbRefSpec >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to ejb-refs.
|  | resourceEnvRefs : SET_OF_CI<was.ResourceEnvRefSpec >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs.
|  | resourceRefs : SET_OF_CI<was.ResourceRefSpec >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs.

|  | Public Properties
--- | --- | ---
|  | moduleDisplayName : STRING
|  | Specify the display name of the target module. (string)
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application. (list_of_string)
|  | startingWeight : STRING
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
|  | uri : STRING
|  | Specify the target module URI (i.e. EjbModule.jar,META-INF/ejb-jar.xml) (string)

#### was.EmbeddedModule

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, was.ConfigurableModule, udm.ConfigurationItem, udm.EmbeddedDeployed

Base class for EAR embedded Web and EJB module configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

#### was.EmbeddedWebModule

Type Hierarchy | was.EmbeddedModule >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, was.ConfigurableModule, udm.ConfigurationItem, udm.EmbeddedDeployed

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Children
--- | --- | ---
|  | ejbRefs : SET_OF_CI<was.EjbRef >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to ejb-refs.
|  | resourceEnvRefs : SET_OF_CI<was.ResourceEnvRef >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs.
|  | resourceRefs : SET_OF_CI<was.ResourceRef >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs.
|  | sessionManagers : SET_OF_CI<was.SessionManager >
|  | Specify the session manager options for the application and modules.

|  | Public Properties
--- | --- | ---
|  | classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | WAR-level class loader mode.
|  | contextRoot : STRING
|  | Specifies the context root of the Web application (WAR). Context Root is not required if the value is already specified in application.xml.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | disableJspRuntimeCompilation : STRING = No
|  | Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default).
|  | enableJspClassReloading : BOOLEAN = true
|  | Specify JSP reloading for Web modules.
|  | jdkSourceLevel : STRING = 15
|  | Specify JDK source level.
|  | jspClassPath : STRING = jspcp
|  | Specify JSP precompiler classpath.
|  | jspReloadInterval : INTEGER = 10
|  | The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set.
|  | moduleDisplayName : STRING
|  | Specify the display name of the target module.
|  | preCompileJsps : BOOLEAN = false
|  | Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application.
|  | startingWeight : INTEGER = 1
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
|  | uri : STRING
|  | Specify the target module URI (i.e. WebModule.war,WEB-INF/web.xml)
|  | useFullPackageNames : STRING = Yes
|  | Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'.
|  | virtualHostName : STRING
|  | Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts.
|  | webServerNames : SET_OF_STRING
|  | Specify the Web servers as targets that serve as routers for requests to this application.

#### was.EmbeddedWebModuleSpec

Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Description unavailable (deployable)

|  | Children
--- | --- | ---
|  | ejbRefs : SET_OF_CI<was.EjbRefSpec >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to ejb-refs.
|  | resourceEnvRefs : SET_OF_CI<was.ResourceEnvRefSpec >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs.
|  | resourceRefs : SET_OF_CI<was.ResourceRefSpec >
|  | Specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs.
|  | sessionManagers : SET_OF_CI<was.SessionManagerSpec >
|  | Specify the session manager options for the application and modules.

|  | Public Properties
--- | --- | ---
|  | classloaderMode : STRING
|  | WAR-level class loader mode. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | contextRoot : STRING
|  | Specifies the context root of the Web application (WAR). Context Root is not required if the value is already specified in application.xml. (string)
|  | disableJspRuntimeCompilation : STRING
|  | Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default). (string) default(No)
|  | enableJspClassReloading : STRING
|  | Specify JSP reloading for Web modules. (boolean) default(true)
|  | jdkSourceLevel : STRING
|  | Specify JDK source level. (string) default(15)
|  | jspClassPath : STRING
|  | Specify JSP precompiler classpath. (string) default(jspcp)
|  | jspReloadInterval : STRING
|  | The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set. (integer) default(10)
|  | moduleDisplayName : STRING
|  | Specify the display name of the target module. (string)
|  | preCompileJsps : STRING
|  | Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files. (boolean) default(false)
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application. (list_of_string)
|  | startingWeight : STRING
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
|  | uri : STRING
|  | Specify the target module URI (i.e. WebModule.war,WEB-INF/web.xml) (string)
|  | useFullPackageNames : STRING
|  | Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'. (string) default(Yes)
|  | virtualHostName : STRING
|  | Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (string)
|  | webServerNames : SET_OF_STRING
|  | Specify the Web servers as targets that serve as routers for requests to this application. (set_of_string)

#### was.ExtensibleDeployed

Virtual Type
Type Hierarchy | python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all extensible deployed configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ExtensibleDeployedArtifact

Virtual Type
Type Hierarchy | was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Base class for all extensible deployed artifact configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are or

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createEditionedOrder : INTEGER = 10
|  | The order in which a create step for Editioned application will be executed(was85nd only).
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | rolloutEditionedOrder : INTEGER = 20
|  | The order in which a rollout step will be executed.
|  | rolloutEditionedVerb : STRING = Rollout
|  | The word that is used to prefix a step description for the rollout operation.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | rolloutEditionedScript : STRING
|  | Python script invoked to rollout a Java EE artifact.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ExtensibleDeployedResource

Virtual Type
Type Hierarchy | was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all extensible deployed resource configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.FileSynchronizationService

Type Hierarchy | was.NodeConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Service ensures that configuration changes made to the cell repository are propagated to the appropriate node repositories.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | autoSynchEnabled : STRING
|  | Specifies whether to synchronize files automatically after a designated interval. When enabled, the node agent contacts the deployment manager every synchronization interval to attempt to synchronize the node configuration repository with the master repository of the deployment manager. Default WAS value is 'true'. values(true, false)
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enable : STRING
|  | Specifies whether or not the server attempts to start the specified service when the server starts. Default WAS value is 'true'. values(true, false)
|  | exclusions : STRING
|  | Specifies files or patterns to exclude during synchronization of configuration data.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | synchInterval : INTEGER
|  | Specifies the number of minutes that elapse between synchronizations. This value is not used if automatic synchronization is disabled. Default WAS value is '1'.
|  | synchOnServerStartup : STRING
|  | Specifies whether to synchronize configuration files when this node agent starts a server. When enabled, the node agent attempts to synchronize the node configuration with the latest configuration in the master repository before starting an application server. Default WAS value is 'false'. values(true, false)

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = FileSynchronizationService
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Node]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = ConfigSynchronizationService
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.FileSynchronizationServiceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Service ensures that configuration changes made to the cell repository are propagated to the appropriate node repositories.

|  | Public Properties
--- | --- | ---
|  | autoSynchEnabled : STRING
|  | Specifies whether to synchronize files automatically after a designated interval. When enabled, the node agent contacts the deployment manager every synchronization interval to attempt to synchronize the node configuration repository with the master repository of the deployment manager. Default WAS value is 'true'. values(true, false) (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this service. (map_string_string)
|  | enable : STRING
|  | Specifies whether or not the server attempts to start the specified service when the server starts. Default WAS value is 'true'. values(true, false) (string)
|  | exclusions : STRING
|  | Specifies files or patterns to exclude during synchronization of configuration data. (string)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | synchInterval : STRING
|  | Specifies the number of minutes that elapse between synchronizations. This value is not used if automatic synchronization is disabled. Default WAS value is '1'. (integer)
|  | synchOnServerStartup : STRING
|  | Specifies whether to synchronize configuration files when this node agent starts a server. When enabled, the node agent attempts to synchronize the node configuration with the latest configuration in the master repository before starting an application server. Default WAS value is 'false'. values(true, false) (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.GenericJmsConnectionFactory

Virtual Type
Type Hierarchy | was.JmsConnectionFactory >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the connection factory into the name space of the third-party messaging provider.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS).
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | providerType : STRING
|  | Provider Type
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = genericJmsDestinationType,provider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/generic/create-generic-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/generic/destroy-generic-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/generic/discover-inspect-generic-connection-factory.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/generic/generic-connection-factory-lib.py, was/jms/jms-connection-factory-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/generic/modify-generic-connection-factory.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = GenericJMSConnectionFactory
|  | WebSphere config type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.GenericJmsDestination

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space.
|  | jndiName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space.
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS).
|  | category : STRING
|  | A category used to classify or group this queue, for your IBM WebSphere Application Server administrative records.
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the queue, for administrative purposes.
|  | providerType : STRING
|  | Provider Type

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,genericJmsDestinationType,wasType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/generic/create-generic-jms-destination.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/generic/destroy-generic-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/generic/modify-generic-jms-destination.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = GenericJMSDestination
|  | WebSphere config type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.GenericJmsQueue

Type Hierarchy | was.GenericJmsDestination >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a queue (for point-to-point messaging).

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space.
|  | jndiName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space.
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS).
|  | category : STRING
|  | A category used to classify or group this queue, for your IBM WebSphere Application Server administrative records.
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the queue, for administrative purposes.
|  | providerType : STRING
|  | Provider Type

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,genericJmsDestinationType,wasType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/generic/create-generic-jms-destination.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/generic/destroy-generic-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | genericJmsDestinationType : STRING = QUEUE
|  | A JMS queue destination for point-to-point messaging provided by the selected generic JMS provider.
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/generic/modify-generic-jms-destination.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = GenericJMSDestination
|  | WebSphere config type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.GenericJmsQueueConnectionFactory

Type Hierarchy | was.GenericJmsConnectionFactory >> was.JmsConnectionFactory >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the connection factory into the name space of the third-party messaging provider.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS).
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | providerType : STRING
|  | Provider Type
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = genericJmsDestinationType,provider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/generic/create-generic-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/generic/destroy-generic-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/generic/discover-inspect-generic-connection-factory.py
|  | Discover Script
|  | genericJmsDestinationType : STRING = QUEUE
|  | A JMS queue connection factory for point-to-point messaging.
|  | libraryScripts : LIST_OF_STRING = [was/jms/generic/generic-connection-factory-lib.py, was/jms/jms-connection-factory-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/generic/modify-generic-connection-factory.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = GenericJMSConnectionFactory
|  | WebSphere config type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.GenericJmsQueueConnectionFactorySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | ConnectionPool_freePoolDistributionTableSize : STRING
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution. (integer) default(0)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | ConnectionPool_numberOfFreePoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the free pools. (integer) default(0)
|  | ConnectionPool_numberOfSharedPoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the shared pools. (integer) default(0)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_stuckThreshold : STRING
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests. (integer) default(0)
|  | ConnectionPool_stuckTime : STRING
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck. (integer) default(0)
|  | ConnectionPool_stuckTimerTime : STRING
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds. (integer) default(0)
|  | ConnectionPool_surgeCreationInterval : STRING
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value. (integer) default(0)
|  | ConnectionPool_surgeThreshold : STRING
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously. (integer) default(-1)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | SessionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | SessionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | SessionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | SessionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | SessionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(FailingConnectionOnly)
|  | SessionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | SessionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | XAEnabled : STRING
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing. (boolean) default(true)
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate. (string)
|  | authMechanismPreference : STRING
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. (enum) values(BASIC_PASSWORD, KERBEROS) default(BASIC_PASSWORD)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue. (map_string_string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | diagnoseConnectionUsage : STRING
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work. (boolean) default(false)
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the connection factory into the name space of the third-party messaging provider. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | logMissingTransactionContext : STRING
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log. (boolean) default(true)
|  | manageCachedHandles : STRING
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management. (boolean) default(false)
|  | mappingConfigAlias : STRING
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping. (enum) values(None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping) default(DefaultPrincipalMapping)
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS). (string)
|  | providerType : STRING
|  | Provider Type (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery. (string)

#### was.GenericJmsQueueSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a queue (for point-to-point messaging).

|  | Public Properties
--- | --- | ---
|  | category : STRING
|  | A category used to classify or group this queue, for your IBM WebSphere Application Server administrative records. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure. (map_string_string)
|  | description : STRING
|  | A description of the queue, for administrative purposes. (string)
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space. (string)
|  | jndiName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space. (string)
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS). (string)
|  | providerType : STRING
|  | Provider Type (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.GenericJmsTopic

Type Hierarchy | was.GenericJmsDestination >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a topic (for Publish and subscribe messaging) provided by the selected generic JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space.
|  | jndiName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space.
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS).
|  | category : STRING
|  | A category used to classify or group this queue, for your IBM WebSphere Application Server administrative records.
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the queue, for administrative purposes.
|  | providerType : STRING
|  | Provider Type

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,genericJmsDestinationType,wasType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/generic/create-generic-jms-destination.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/generic/destroy-generic-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | genericJmsDestinationType : STRING = TOPIC
|  | A JMS topic destination for publish/subscribe messaging.
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/generic/modify-generic-jms-destination.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = GenericJMSDestination
|  | WebSphere config type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.GenericJmsTopicConnectionFactory

Type Hierarchy | was.GenericJmsConnectionFactory >> was.JmsConnectionFactory >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the connection factory into the name space of the third-party messaging provider.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS).
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | providerType : STRING
|  | Provider Type
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = genericJmsDestinationType,provider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/generic/create-generic-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/generic/destroy-generic-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/generic/discover-inspect-generic-connection-factory.py
|  | Discover Script
|  | genericJmsDestinationType : STRING = TOPIC
|  | A JMS topic connection factory for publish/subscribe messaging.
|  | libraryScripts : LIST_OF_STRING = [was/jms/generic/generic-connection-factory-lib.py, was/jms/jms-connection-factory-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/generic/modify-generic-connection-factory.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = GenericJMSConnectionFactory
|  | WebSphere config type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.GenericJmsTopicConnectionFactorySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | ConnectionPool_freePoolDistributionTableSize : STRING
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution. (integer) default(0)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | ConnectionPool_numberOfFreePoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the free pools. (integer) default(0)
|  | ConnectionPool_numberOfSharedPoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the shared pools. (integer) default(0)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_stuckThreshold : STRING
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests. (integer) default(0)
|  | ConnectionPool_stuckTime : STRING
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck. (integer) default(0)
|  | ConnectionPool_stuckTimerTime : STRING
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds. (integer) default(0)
|  | ConnectionPool_surgeCreationInterval : STRING
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value. (integer) default(0)
|  | ConnectionPool_surgeThreshold : STRING
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously. (integer) default(-1)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | SessionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | SessionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | SessionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | SessionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | SessionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(FailingConnectionOnly)
|  | SessionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | SessionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | XAEnabled : STRING
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing. (boolean) default(true)
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate. (string)
|  | authMechanismPreference : STRING
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. (enum) values(BASIC_PASSWORD, KERBEROS) default(BASIC_PASSWORD)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue. (map_string_string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | diagnoseConnectionUsage : STRING
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work. (boolean) default(false)
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the connection factory into the name space of the third-party messaging provider. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | logMissingTransactionContext : STRING
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log. (boolean) default(true)
|  | manageCachedHandles : STRING
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management. (boolean) default(false)
|  | mappingConfigAlias : STRING
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping. (enum) values(None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping) default(DefaultPrincipalMapping)
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS). (string)
|  | providerType : STRING
|  | Provider Type (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery. (string)

#### was.GenericJmsTopicSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a topic (for Publish and subscribe messaging) provided by the selected generic JMS provider.

|  | Public Properties
--- | --- | ---
|  | category : STRING
|  | A category used to classify or group this queue, for your IBM WebSphere Application Server administrative records. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure. (map_string_string)
|  | description : STRING
|  | A description of the queue, for administrative purposes. (string)
|  | externalJNDIName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space. (string)
|  | jndiName : STRING
|  | The JNDI name that is used to bind the queue into the application server's name space. (string)
|  | provider : STRING
|  | Specifies a JMS provider, which enables asynchronous messaging based on the Java Message Service (JMS). (string)
|  | providerType : STRING
|  | Provider Type (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.HAManagerPolicy

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Base type for all HAManagerPolicy subtypes.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | isAlivePeriodSec : INTEGER = 120
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the policy.
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy.
|  | quorumEnabled : BOOLEAN = false
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,type,wasType,deployable,container,customProperties,matchCriteria,servers,preferredServers
|  | Additional Properties Not To Expose

#### was.HAManagerPolicySpec

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Base type for all HAManagerPolicy subtypes.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the policy. (string)
|  | isAlivePeriodSec : STRING
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (integer) default(120)
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy. (map_string_string)
|  | quorumEnabled : STRING
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation. (boolean) default(false)

#### was.HTTPInboundChannel

Type Hierarchy | was.TransportChannel >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Configure a channel for handling inbound HTTP requests from a remote client.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | maxFieldSize : INTEGER = 32768
|  | Specifies, in bytes, the maximum size for a header that is included in a message.
|  | maxHeaders : INTEGER = 50
|  | Specifies the maximum number of headers that can be included in a message.
|  | persistentTimeout : INTEGER = 30
|  | Specifies the maximum amount of time, in seconds, that the server waits on a socket between client requests. After this timeout is passed, the connection closes.
|  | readTimeout : INTEGER = 60
|  | Specifies the maximum amount of time, in seconds, that the server waits for a read operation on a socket to complete.
|  | writeTimeout : INTEGER = 60
|  | Specifies the maximum amount of time, in seconds, that the server waits for a write operation on a socket to complete.
|  | HttpInboundChannelLogging_AccessLog_filePath : STRING
|  | Specifies the location and name of the NCSA access log. This log contains client access information.
|  | HttpInboundChannelLogging_AccessLog_maximumBackupFiles : INTEGER = 1
|  | Specifies the maximum number of historical files that can be kept.
|  | HttpInboundChannelLogging_AccessLog_maximumSize : INTEGER = 1
|  | Specifies, in megabytes, the maximum size of the NCSA log.
|  | HttpInboundChannelLogging_ErrorLog_filePath : STRING
|  | Specifies the location and name of the Error log. This log contains error and information that can be used to debug error situations.
|  | HttpInboundChannelLogging_ErrorLog_maximumBackupFiles : INTEGER = 1
|  | Specifies the maximum number of historical files that can be kept.
|  | HttpInboundChannelLogging_ErrorLog_maximumSize : INTEGER = 1
|  | Specifies, in megabytes, the maximum size of the Error log file.
|  | HttpInboundChannelLogging_FrcaLog_filePath : STRING
|  | Specifies the location and name of the FRCA log. This log contains client access information.
|  | HttpInboundChannelLogging_FrcaLog_maximumBackupFiles : INTEGER = 1
|  | Specifies the maximum number of historical files that can be kept.
|  | HttpInboundChannelLogging_FrcaLog_maximumSize : INTEGER = 1
|  | Specifies, in megabytes, the maximum size of the FRCA log.
|  | HttpInboundChannelLogging_accessLogFormat : ENUM [COMMON, COMBINED] = COMMON
|  | Specifies the NCSA format that is used when client access information is added to an NCSA log.
|  | HttpInboundChannelLogging_enableAccessLogging : BOOLEAN = false
|  | Specifies whether NCSA access logging is enabled for inbound client requests.
|  | HttpInboundChannelLogging_enableErrorLogging : BOOLEAN = false
|  | Specifies whether error and debug information is collected in an Error log.
|  | HttpInboundChannelLogging_enableFRCALogging : BOOLEAN = false
|  | Specifies whether FRCA logging is enabled for inbound client requests.
|  | HttpInboundChannelLogging_errorLogLevel : ENUM [CRITICAL, ERROR, WARNING, INFO, DEBUG] = CRITICAL
|  | Specifies the type of messages that are added to the Error log.
|  | HttpInboundChannelLogging_frcaLogFormat : ENUM [COMMON, COMBINED] = COMMON
|  | Specifies the FRCA format that is used when client access information is added to an FRCA log.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this transport channel.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | discriminationWeight : INTEGER = 10
|  | Specifies the discrimination weight that is used to determine the order in which the channels obtain access to the incoming connection if the transport channels are shared amongst several transport chains. The transport channel with the lowest discrimination weight has the first opportunity to accept the incoming connection.
|  | enableLogging : BOOLEAN = false
|  | Specifies whether logging of NCSA access information, including FRCA caching information, and error messages is enabled for connections that use this channel.
|  | keepAlive : BOOLEAN = true
|  | Specifies whether persistent connections, also referred to as keep alive connections, rather than connections that close after the request and response exchange, are allowed when sending an outgoing HTTP message.
|  | maxRequestMessageBodySize : INTEGER = -1
|  | Specifies, in bytes, the maximum size for the body of a message. Value -1 indicates unlimited request body buffer size.
|  | maximumPersistentRequests : INTEGER = 100
|  | Specifies the maximum requests that are allowed on a single HTTP connection. 0 or 1 indicates one single request per connection. Value -1 indicates unlimited persistent requests per connection.
|  | useChannelAccessLoggingSettings : BOOLEAN = false
|  | Specifies to use channel-specific instead of global logging service options.
|  | useChannelErrorLoggingSettings : BOOLEAN = false
|  | Specifies to use channel-specific instead of global logging service options.
|  | useChannelFRCALoggingSettings : BOOLEAN = false
|  | Specifies to use channel-specific instead of global logging service options.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,container,type,wasType,customProperties,deployable
|  | Additional Properties Not To Expose
|  | wasType : STRING = HTTPInboundChannel
|  | WebSphere admin resource type.

#### was.HTTPInboundChannelSpec

Type Hierarchy | was.TransportChannelSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Configure a channel for handling inbound HTTP requests from a remote client.

|  | Public Properties
--- | --- | ---
|  | HttpInboundChannelLogging_AccessLog_filePath : STRING
|  | Specifies the location and name of the NCSA access log. This log contains client access information. (string)
|  | HttpInboundChannelLogging_AccessLog_maximumBackupFiles : STRING
|  | Specifies the maximum number of historical files that can be kept. (integer) default(1)
|  | HttpInboundChannelLogging_AccessLog_maximumSize : STRING
|  | Specifies, in megabytes, the maximum size of the NCSA log. (integer) default(1)
|  | HttpInboundChannelLogging_ErrorLog_filePath : STRING
|  | Specifies the location and name of the Error log. This log contains error and information that can be used to debug error situations. (string)
|  | HttpInboundChannelLogging_ErrorLog_maximumBackupFiles : STRING
|  | Specifies the maximum number of historical files that can be kept. (integer) default(1)
|  | HttpInboundChannelLogging_ErrorLog_maximumSize : STRING
|  | Specifies, in megabytes, the maximum size of the Error log file. (integer) default(1)
|  | HttpInboundChannelLogging_FrcaLog_filePath : STRING
|  | Specifies the location and name of the FRCA log. This log contains client access information. (string)
|  | HttpInboundChannelLogging_FrcaLog_maximumBackupFiles : STRING
|  | Specifies the maximum number of historical files that can be kept. (integer) default(1)
|  | HttpInboundChannelLogging_FrcaLog_maximumSize : STRING
|  | Specifies, in megabytes, the maximum size of the FRCA log. (integer) default(1)
|  | HttpInboundChannelLogging_accessLogFormat : STRING
|  | Specifies the NCSA format that is used when client access information is added to an NCSA log. (enum) values(COMMON, COMBINED) default(COMMON)
|  | HttpInboundChannelLogging_enableAccessLogging : STRING
|  | Specifies whether NCSA access logging is enabled for inbound client requests. (boolean) default(false)
|  | HttpInboundChannelLogging_enableErrorLogging : STRING
|  | Specifies whether error and debug information is collected in an Error log. (boolean) default(false)
|  | HttpInboundChannelLogging_enableFRCALogging : STRING
|  | Specifies whether FRCA logging is enabled for inbound client requests. (boolean) default(false)
|  | HttpInboundChannelLogging_errorLogLevel : STRING
|  | Specifies the type of messages that are added to the Error log. (enum) values(CRITICAL, ERROR, WARNING, INFO, DEBUG) default(CRITICAL)
|  | HttpInboundChannelLogging_frcaLogFormat : STRING
|  | Specifies the FRCA format that is used when client access information is added to an FRCA log. (enum) values(COMMON, COMBINED) default(COMMON)
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this transport channel. (map_string_string)
|  | discriminationWeight : STRING
|  | Specifies the discrimination weight that is used to determine the order in which the channels obtain access to the incoming connection if the transport channels are shared amongst several transport chains. The transport channel with the lowest discrimination weight has the first opportunity to accept the incoming connection. (integer) default(10)
|  | enableLogging : STRING
|  | Specifies whether logging of NCSA access information, including FRCA caching information, and error messages is enabled for connections that use this channel. (boolean) default(false)
|  | keepAlive : STRING
|  | Specifies whether persistent connections, also referred to as keep alive connections, rather than connections that close after the request and response exchange, are allowed when sending an outgoing HTTP message. (boolean) default(true)
|  | maxFieldSize : STRING
|  | Specifies, in bytes, the maximum size for a header that is included in a message. (integer) default(32768)
|  | maxHeaders : STRING
|  | Specifies the maximum number of headers that can be included in a message. (integer) default(50)
|  | maxRequestMessageBodySize : STRING
|  | Specifies, in bytes, the maximum size for the body of a message. Value -1 indicates unlimited request body buffer size. (integer) default(-1)
|  | maximumPersistentRequests : STRING
|  | Specifies the maximum requests that are allowed on a single HTTP connection. 0 or 1 indicates one single request per connection. Value -1 indicates unlimited persistent requests per connection. (integer) default(100)
|  | persistentTimeout : STRING
|  | Specifies the maximum amount of time, in seconds, that the server waits on a socket between client requests. After this timeout is passed, the connection closes. (integer) default(30)
|  | readTimeout : STRING
|  | Specifies the maximum amount of time, in seconds, that the server waits for a read operation on a socket to complete. (integer) default(60)
|  | useChannelAccessLoggingSettings : STRING
|  | Specifies to use channel-specific instead of global logging service options. (boolean) default(false)
|  | useChannelErrorLoggingSettings : STRING
|  | Specifies to use channel-specific instead of global logging service options. (boolean) default(false)
|  | useChannelFRCALoggingSettings : STRING
|  | Specifies to use channel-specific instead of global logging service options. (boolean) default(false)
|  | writeTimeout : STRING
|  | Specifies the maximum amount of time, in seconds, that the server waits for a write operation on a socket to complete. (integer) default(60)

#### was.HealthActionHeapDump

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to take heap dumps.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = HEAPDUMP
|  | Action Type

#### was.HealthActionHeapDumpSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to take heap dumps. (deployable)

#### was.HealthActionRestartServer

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to restart a server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = RESTART
|  | Action Type

#### was.HealthActionRestartServerSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to restart a server. (deployable)

#### was.HealthActionSendSnmpTrap

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to generate a SNMP (Simple Network Management Protocol) trap.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = SENDSNMPTRAP
|  | Action Type

#### was.HealthActionSendSnmpTrapSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to generate a SNMP (Simple Network Management Protocol) trap. (deployable)

#### was.HealthActionSetMaintenanceMode

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to put a server into maintenance mode.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = SETMAINTENANCEMODE
|  | Action Type

#### was.HealthActionSetMaintenanceModeBreakAffinity

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to put a server into maintenance mode and break HTTP and SIP request affinity to the server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = SETMAINTENANCEMODE_BREAK
|  | Action Type

#### was.HealthActionSetMaintenanceModeBreakAffinitySpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to put a server into maintenance mode and break HTTP and SIP request affinity to the server. (deployable)

#### was.HealthActionSetMaintenanceModeSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to put a server into maintenance mode. (deployable)

#### was.HealthActionSetMaintenanceModeStop

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Undocumented.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = SETMAINTENANCEMODE_STOP
|  | Action Type

#### was.HealthActionSetMaintenanceModeStopSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Undocumented. (deployable)

#### was.HealthActionThreadDump

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to take thread dumps.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = THREADDUMP
|  | Action Type

#### was.HealthActionThreadDumpSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to take thread dumps. (deployable)

#### was.HealthActionUnsetMaintenanceMode

Type Hierarchy | was.HealthBaseAction >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Health action to take a server out of maintenance mode.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | actionType : STRING = UNSETMAINTENANCEMODE
|  | Action Type

#### was.HealthActionUnsetMaintenanceModeSpec

Type Hierarchy | was.HealthBaseActionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Health action to take a server out of maintenance mode. (deployable)

#### was.HealthBaseAction

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Base Health Action.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

#### was.HealthBaseActionSpec

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Base Health Action.

#### was.HealthBaseCondition

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Base Condition for Health Policy conditions.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose

#### was.HealthBaseConditionSpec

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Base Condition for Health Policy conditions.

#### was.HealthConditionAge

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Tracks the amount of time that the server is running. If the amount of time exceeds the defined threshold, the health actions run.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | ageUnits : ENUM [DAYS, HOURS] = DAYS
|  | Unit DAYS or HOURS.
|  | maxAge : INTEGER = 7
|  | The age to allow the server instance to 'live' prior to corrective action. This value can go from 1 hour to 8760 hours
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = AGE
|  | Condition Type

#### was.HealthConditionAgeSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Tracks the amount of time that the server is running. If the amount of time exceeds the defined threshold, the health actions run. (deployable)

|  | Public Properties
--- | --- | ---
|  | ageUnits : STRING
|  | Unit DAYS or HOURS. (enum) values(DAYS, HOURS) default(DAYS)
|  | maxAge : STRING
|  | The age to allow the server instance to 'live' prior to corrective action. This value can go from 1 hour to 8760 hours (integer) default(7)

#### was.HealthConditionExcessiveMemory

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Tracks the memory usage for a member. When the memory usage exceeds a percentage of the heap size for a specified time, the health actions run.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | memoryUsed : INTEGER = 85
|  | The threshold value for the percentage of the max heap size used for the JVM process.
|  | timeOverThreshold : INTEGER = 5
|  | Time period over which the JVM heap threshold must breach. This value can go from 1 second to 60 minutes.
|  | timeUnits : ENUM [MINUTES, SECONDS] = MINUTES
|  | Unit of time for time over threshold (MINUTES or SECONDS).
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = EXCESSIVE_MEMORY
|  | Condition Type

#### was.HealthConditionExcessiveMemorySpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Tracks the memory usage for a member. When the memory usage exceeds a percentage of the heap size for a specified time, the health actions run. (deployable)

|  | Public Properties
--- | --- | ---
|  | memoryUsed : STRING
|  | The threshold value for the percentage of the max heap size used for the JVM process. (integer) default(85)
|  | timeOverThreshold : STRING
|  | Time period over which the JVM heap threshold must breach. This value can go from 1 second to 60 minutes. (integer) default(5)
|  | timeUnits : STRING
|  | Unit of time for time over threshold (MINUTES or SECONDS). (enum) values(MINUTES, SECONDS) default(MINUTES)

#### was.HealthConditionExcessiveRequestTimeout

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a percentage of HTTP requests that can time out. When the percentage of requests exceeds the defined value, the health actions run.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | timeoutPercent : INTEGER = 30
|  | The threshold value for the percentage of the timed out requests.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = EXCESSIVE_REQUEST_TIMEOUT
|  | Condition Type

#### was.HealthConditionExcessiveRequestTimeoutSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Specifies a percentage of HTTP requests that can time out. When the percentage of requests exceeds the defined value, the health actions run. (deployable)

|  | Public Properties
--- | --- | ---
|  | timeoutPercent : STRING
|  | The threshold value for the percentage of the timed out requests. (integer) default(30)

#### was.HealthConditionExcessiveResponseTime

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Tracks the amount of time that requests take to complete. If the time exceeds the defined response time threshold, the health actions run.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | responseTime : INTEGER = 10
|  | The average time that request can take prior to corrective action. This value go from 1 millisecond to 1 hour.
|  | responseTimeUnits : ENUM [MINUTES, SECONDS, MILLISECONDS] = SECONDS
|  | The average time that request can take prior to corrective action.this value go from 1 millisecond to 1 hour.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = EXCESSIVE_RESPONSE_TIME
|  | Condition Type

#### was.HealthConditionExcessiveResponseTimeSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Tracks the amount of time that requests take to complete. If the time exceeds the defined response time threshold, the health actions run. (deployable)

|  | Public Properties
--- | --- | ---
|  | responseTime : STRING
|  | The average time that request can take prior to corrective action. This value go from 1 millisecond to 1 hour. (integer) default(10)
|  | responseTimeUnits : STRING
|  | The average time that request can take prior to corrective action.this value go from 1 millisecond to 1 hour. (enum) values(MINUTES, SECONDS, MILLISECONDS) default(SECONDS)

#### was.HealthConditionGarbageCollectionPercentage

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Monitors a Java virtual machine (JVM) or set of JVM's to determine whether they spend more than a defined percentage of time in garbage collection during a specified time period.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | garbageCollectionPercent : INTEGER = 10
|  | The threshold value for the percentage of time spent in garbage collection. This value can be between 1 and 99.
|  | samplingPeriod : INTEGER = 2
|  | This value can go from 1 minute to 24 hours. Default value: 2 minutes.
|  | samplingUnits : ENUM [MINUTES, HOURS] = MINUTES
|  | The unit used for samplingPeriod. Default value: MINUTES.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = GC_PERCENTAGE
|  | Condition Type

#### was.HealthConditionGarbageCollectionPercentageSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Monitors a Java virtual machine (JVM) or set of JVM's to determine whether they spend more than a defined percentage of time in garbage collection during a specified time period. (deployable)

|  | Public Properties
--- | --- | ---
|  | garbageCollectionPercent : STRING
|  | The threshold value for the percentage of time spent in garbage collection. This value can be between 1 and 99. (integer) default(10)
|  | samplingPeriod : STRING
|  | This value can go from 1 minute to 24 hours. Default value: 2 minutes. (integer) default(2)
|  | samplingUnits : STRING
|  | The unit used for samplingPeriod. Default value: MINUTES. (enum) values(MINUTES, HOURS) default(MINUTES)

#### was.HealthConditionMemoryLeak

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Tracks consistent downward trends in free memory that is available to a server in the Java heap. When the Java heap approaches the maximum configured size, you can perform either heap dumps or server restarts.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | level : ENUM [FAST, NORMAL, CONSERVATIVE] = NORMAL
|  | The detection level specifies how aggressively to monitor for memory leaks. The value can be FAST, NORMAL or CONSERVATIVE.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = MEMORY_LEAK
|  | Condition Type

#### was.HealthConditionMemoryLeakSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Tracks consistent downward trends in free memory that is available to a server in the Java heap. When the Java heap approaches the maximum configured size, you can perform either heap dumps or server restarts. (deployable)

|  | Public Properties
--- | --- | ---
|  | level : STRING
|  | The detection level specifies how aggressively to monitor for memory leaks. The value can be FAST, NORMAL or CONSERVATIVE. (enum) values(FAST, NORMAL, CONSERVATIVE) default(NORMAL)

#### was.HealthConditionStormDrain

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Tracks requests that have a significantly decreased response time.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | level : ENUM [NORMAL, CONSERVATIVE] = NORMAL
|  | The detection level specifies how aggressively to monitor for storm drain scenarios. (NORMAL or CONSERVATIVE)
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = STORM_DRAIN
|  | Condition Type

#### was.HealthConditionStormDrainSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Tracks requests that have a significantly decreased response time. (deployable)

|  | Public Properties
--- | --- | ---
|  | level : STRING
|  | The detection level specifies how aggressively to monitor for storm drain scenarios. (NORMAL or CONSERVATIVE) (enum) values(NORMAL, CONSERVATIVE) default(NORMAL)

#### was.HealthConditionWorkload

Type Hierarchy | was.HealthBaseCondition >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a number of requests that are serviced before policy members restart to clean out memory and cache data.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | totalRequests : STRING = 20000000
|  | The total number of requests that the server instance serves before corrective action. It must be 1000 <= 9223372036854775807.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = container, conditionType, deployable, id, type
|  | Additional Properties Not To Expose
|  | conditionType : STRING = WORKLOAD
|  | Condition Type

#### was.HealthConditionWorkloadSpec

Type Hierarchy | was.HealthBaseConditionSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Specifies a number of requests that are serviced before policy members restart to clean out memory and cache data. (deployable)

|  | Public Properties
--- | --- | ---
|  | totalRequests : STRING
|  | The total number of requests that the server instance serves before corrective action. It must be 1000 <= 9223372036854775807. (string) default(20000000)

#### was.HealthPolicy

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Health policies define a condition and a set of actions to undertake when the condition is breached.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Children
--- | --- | ---
|  | condition : SET_OF_CI<was.HealthBaseCondition >
|  | The condition for the health policy. Exactly one condition needs to be specified.
|  | healthActions : LIST_OF_CI<was.HealthBaseAction >
|  | The health actions to execute when the condition breaches. At least one needs to be specified.

|  | Public Properties
--- | --- | ---
|  | reactionMode : ENUM [SUPERVISE, AUTOMATIC] = SUPERVISE
|  | The level of user-interaction required when corrective action is needed. The value can be SUPERVISE (default) or AUTOMATIC.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Description

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = healthActions,condition
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/policies/health/create-health-policy.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/policies/health/destroy-health-policy.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/policies/health/discover-inspect-health-policy.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/policies/health/health-policy-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/policies/health/modify-health-policy.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.HealthPolicyMembership

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Marks a container member of a health policy.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | healthPolicyName : STRING
|  | Name of the Health Policy this container is a member of.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 59
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/policies/health/create-health-policy-membership.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 41
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/policies/health/destroy-health-policy-membership.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 46
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/policies/health/discover-inspect-health-policy-membership.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/policies/health/health-policy-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.HealthPolicyMembershipSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Marks a container member of a health policy. (deployable)

|  | Public Properties
--- | --- | ---
|  | healthPolicyName : STRING
|  | Name of the Health Policy this container is a member of. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.HealthPolicySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Health policies define a condition and a set of actions to undertake when the condition is breached. (deployable)

|  | Children
--- | --- | ---
|  | condition : SET_OF_CI<was.HealthBaseConditionSpec >
|  | The condition for the health policy. Exactly one condition needs to be specified.
|  | healthActions : LIST_OF_CI<was.HealthBaseActionSpec >
|  | The health actions to execute when the condition breaches. At least one needs to be specified.

|  | Public Properties
--- | --- | ---
|  | description : STRING
|  | Description (string)
|  | reactionMode : STRING
|  | The level of user-interaction required when corrective action is needed. The value can be SUPERVISE (default) or AUTOMATIC. (enum) values(SUPERVISE, AUTOMATIC) default(SUPERVISE)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.IndirectNameSpaceBinding

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a name binding of an object which can be looked up using JNDI.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | Specifies the name used to look up the target object from the initial context.
|  | nameInNameSpace : STRING
|  | Specifies a name for this binding in the name space. It is a simple or compound name relative to the portion of the name space where this binding is configured.
|  | providerURL : STRING
|  | Specifies the provider URL string needed to obtain a JNDI initial context.
|  | customProperties : MAP_STRING_STRING
|  | Specifies a list of name-value pairs (property settings) for the indirect lookup name binding. The property settings are passed to the javax.naming.InitialContext constructor used to obtain the initial JNDI context required for the indirect lookup.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | initialContextFactory : STRING
|  | Specifies the class name of the initial context factory used to obtain a JNDI initial context. If the field is left blank, the initial context factory com.ibm.websphere.naming.WsnInitialContextFactory is used to obtain the initial JNDI context.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = IndirectLookupNameSpaceBinding
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.IndirectNameSpaceBindingSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a name binding of an object which can be looked up using JNDI.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies a list of name-value pairs (property settings) for the indirect lookup name binding. The property settings are passed to the javax.naming.InitialContext constructor used to obtain the initial JNDI context required for the indirect lookup. (map_string_string)
|  | initialContextFactory : STRING
|  | Specifies the class name of the initial context factory used to obtain a JNDI initial context. If the field is left blank, the initial context factory com.ibm.websphere.naming.WsnInitialContextFactory is used to obtain the initial JNDI context. (string)
|  | jndiName : STRING
|  | Specifies the name used to look up the target object from the initial context. (string)
|  | nameInNameSpace : STRING
|  | Specifies a name for this binding in the name space. It is a simple or compound name relative to the portion of the name space where this binding is configured. (string)
|  | providerURL : STRING
|  | Specifies the provider URL string needed to obtain a JNDI initial context. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.J2CActivationSpecification

Type Hierarchy | was.J2CResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the activation specification definitions for the resource adapter.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env.
|  | messageListenerType : STRING
|  | Specifies the message listener type the activation specification uses. The list of available classes is provided by the resource adapter.
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter.
|  | authenticationAlias : STRING
|  | Specifies the alias used to bind the J2C activation specification to an authentication alias (configured through the security JAAS screens).
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the J2C resource.
|  | destinationJndiName : STRING
|  | Indicates the name of the Java Naming and Directory Interface (JNDI) of corresponding destination.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,customProperties,wasType,standardProvidersToIgnore,additionalProvidersToIgnore
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/ra/create-j2c-activation-spec.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/ra/destroy-j2c-activation-spec.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/ra/discover-inspect-j2c-activation-spec.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/ra/j2c-activation-spec-lib.py, was/resources/ra/j2c-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | standardProvidersToIgnore : STRING = SIB JMS Resource Adapter,WebSphere MQ Resource Adapter,WebSphere Relational Resource Adapter
|  | Standard Providers To Ignore
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = J2CActivationSpec
|  | Was Type
|  | additionalProvidersToIgnore : STRING =
|  | Additional Providers To Ignore
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.J2CActivationSpecificationSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the activation specification definitions for the resource adapter.

|  | Public Properties
--- | --- | ---
|  | authenticationAlias : STRING
|  | Specifies the alias used to bind the J2C activation specification to an authentication alias (configured through the security JAAS screens). (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource. (map_string_string)
|  | description : STRING
|  | An optional description for the J2C resource. (string)
|  | destinationJndiName : STRING
|  | Indicates the name of the Java Naming and Directory Interface (JNDI) of corresponding destination. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env. (string)
|  | messageListenerType : STRING
|  | Specifies the message listener type the activation specification uses. The list of available classes is provided by the resource adapter. (string)
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.J2CAdminObject

Type Hierarchy | was.J2CResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the admin object definitions for the resource adapter.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | adminObjectInterface : STRING
|  | For new objects, the list of available classes is provided by the resource adapter. After you create the administered object, you cannot modify the value.
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env.
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the J2C resource.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,customProperties,wasType,standardProvidersToIgnore,additionalProvidersToIgnore
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/ra/create-j2c-admin-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/ra/destroy-j2c-admin-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/ra/discover-inspect-j2c-admin-object.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/ra/j2c-admin-object-lib.py, was/resources/ra/j2c-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | standardProvidersToIgnore : STRING = SIB JMS Resource Adapter,WebSphere MQ Resource Adapter,WebSphere Relational Resource Adapter
|  | Standard Providers To Ignore
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = J2CAdminObject
|  | Was Type
|  | additionalProvidersToIgnore : STRING =
|  | Additional Providers To Ignore
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.J2CAdminObjectSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the admin object definitions for the resource adapter.

|  | Public Properties
--- | --- | ---
|  | adminObjectInterface : STRING
|  | For new objects, the list of available classes is provided by the resource adapter. After you create the administered object, you cannot modify the value. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource. (map_string_string)
|  | description : STRING
|  | An optional description for the J2C resource. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env. (string)
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.J2CConnectionFactory

Type Hierarchy | was.J2CResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the connection factory definitions for the resource adapter.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env.
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource.
|  | connectionFactoryInterface : STRING
|  | Specifies the fully qualified class name of the connection factory interfaces that are supported by the resource adapter.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the J2C resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping'.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,customProperties,connectionFactoryInterface,standardProvidersToIgnore,additionalProvidersToIgnore
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/ra/create-j2c-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/ra/destroy-j2c-connection-factory.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/ra/discover-inspect-j2c-connection-factory.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/ra/j2c-connection-factory-lib.py, was/resources/ra/j2c-resource-lib.py, was/jms/jms-connection-factory-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | standardProvidersToIgnore : STRING = SIB JMS Resource Adapter,WebSphere MQ Resource Adapter,WebSphere Relational Resource Adapter
|  | Standard Providers To Ignore
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = J2CConnectionFactory
|  | Was Type
|  | additionalProvidersToIgnore : STRING =
|  | Additional Providers To Ignore
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.J2CConnectionFactorySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the connection factory definitions for the resource adapter.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | ConnectionPool_freePoolDistributionTableSize : STRING
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution. (integer) default(0)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | ConnectionPool_numberOfFreePoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the free pools. (integer) default(0)
|  | ConnectionPool_numberOfSharedPoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the shared pools. (integer) default(0)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_stuckThreshold : STRING
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests. (integer) default(0)
|  | ConnectionPool_stuckTime : STRING
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck. (integer) default(0)
|  | ConnectionPool_stuckTimerTime : STRING
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds. (integer) default(0)
|  | ConnectionPool_surgeCreationInterval : STRING
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value. (integer) default(0)
|  | ConnectionPool_surgeThreshold : STRING
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously. (integer) default(-1)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate. (string)
|  | authMechanismPreference : STRING
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. (enum) values(BASIC_PASSWORD, KERBEROS) default(BASIC_PASSWORD)
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource. (string)
|  | connectionFactoryInterface : STRING
|  | Specifies the fully qualified class name of the connection factory interfaces that are supported by the resource adapter. (string)
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource. (map_string_string)
|  | description : STRING
|  | An optional description for the J2C resource. (string)
|  | diagnoseConnectionUsage : STRING
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work. (boolean) default(false)
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env. (string)
|  | logMissingTransactionContext : STRING
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log. (boolean) default(true)
|  | manageCachedHandles : STRING
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management. (boolean) default(false)
|  | mappingConfigAlias : STRING
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping'. (enum) values(None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping) default(DefaultPrincipalMapping)
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery. (string)

#### was.J2CResource

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base type for all WebSphere J2C objects.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | Specifies the JNDI name for the J2C resource, including any naming sub-contexts. To make important resource reference data for the connection factory available to the connection management runtime library, enter the JNDI name as an indirect JNDI name. An indirect JNDI name begins with the prefix of java:comp/env.
|  | provider : STRING
|  | The associated WebSphere J2C Resource Adapter.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the J2C resource.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = standardProvidersToIgnore,additionalProvidersToIgnore
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | standardProvidersToIgnore : STRING = SIB JMS Resource Adapter,WebSphere MQ Resource Adapter,WebSphere Relational Resource Adapter
|  | Standard Providers To Ignore
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | additionalProvidersToIgnore : STRING =
|  | Additional Providers To Ignore
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.J2CResourceAdapter

Type Hierarchy | was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Specifies and installs a stand-alone resource adapter archive (RAR) file.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | nodeName : STRING
|  | Specify the name of the nodes to install the RAR file. When deploying to cell scope, specify a comma-separated list of node names.
|  | archivePath : STRING = ${CONNECTOR_INSTALL_ROOT}
|  | Specifies the path where the RAR file is to be installed. If you do not set the property, the application server extracts the RAR file to the absolute path that is represented by the variable CONNECTOR_INSTALL_ROOT.
|  | classpath : STRING
|  | A list of paths or JAR file names which together form the location for the resource provider classes. Class path entries are separated by using the ENTER key and must not contain path separator characters (such as ';' or ':'). Class paths can contain variable (symbolic) names that can be substituted using a variable map. Check your driver installation notes for specific JAR file names that are required.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this WebSphere J2C Resource Adapter.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the resource adapter.
|  | hACapability : ENUM [RA_NO_HA, RA_ENDPOINT_HA, RA_INSTANCE_HA] = RA_NO_HA
|  | Selection of the checkbox is not recommended without first consulting the product documentation for the resource adapter, because the checkbox requires the resource adapter to support high availability of inbound messaging. Not supported for: WAS_61.
|  | isEnableHASupport : BOOLEAN = false
|  | Enable HA support. The default value is false. Not supported for: WAS_61.
|  | isolatedClassLoader : BOOLEAN = false
|  | If selected, this resource provider will be loaded in its own class loader. This allows different versions of the same resource provider to be loaded in the same JVM. Each version of a provider should be given a unique class path appropriate for that version. NOTE: A provider cannot be isolated when a native library path is specified. Not supported for: WAS_61.
|  | nativepath : STRING
|  | An optional path to any native libraries (*.dll, *.so). Native path entries are separated by using the Enter key and must not contain path separator characters (such as ';' or ':'). Native paths can contain variable (symbolic) names that can be substituted using a variable map.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are or
|  | singleton : BOOLEAN = false
|  | Selection of this checkbox is not recommended without first consulting the product documentation. Checking this box prevents more than one resource adapter JavaBean instance with the same resource adapter implementation class name from existing in the same JVM. This is an extremely restrictive environment. Not supported for: WAS_61.
|  | threadPoolAlias : STRING = Default
|  | Specifies the name of a thread pool that is part of the server configuration for the resource adapter. Set this property only if the resource adapter uses the work manager service. If you input a thread pool name that does not exist in the server configuration, WebSphere(R) Application Server uses the name DEFAULT.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,customProperties,createEditionedOrder,rolloutEditionedOrder,rolloutEditionedVerb,rolloutEditionedScript,placeholders,nodeName
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createEditionedOrder : INTEGER = 10
|  | The order in which a create step for Editioned application will be executed(was85nd only).
|  | createOrder : INTEGER = 57
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/ra/create-j2c-resource-adapter.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 41
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/ra/destroy-j2c-resource-adapter.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/ra/discover-inspect-j2c-resource-adapter.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/ra/j2c-resource-adapter-lib.py, was/resources/ra/j2c-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 57
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/resources/ra/modify-j2c-resource-adapter.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | rolloutEditionedOrder : INTEGER = 20
|  | The order in which a rollout step will be executed.
|  | rolloutEditionedVerb : STRING = Rollout
|  | The word that is used to prefix a step description for the rollout operation.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = J2CResourceAdapter
|  | Was Type
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | rolloutEditionedScript : STRING
|  | Python script invoked to rollout a Java EE artifact.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.J2CResourceAdapterSpec

Type Hierarchy | udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Specifies and installs a stand-alone resource adapter archive (RAR) file.

|  | Public Properties
--- | --- | ---
|  | archivePath : STRING
|  | Specifies the path where the RAR file is to be installed. If you do not set the property, the application server extracts the RAR file to the absolute path that is represented by the variable CONNECTOR_INSTALL_ROOT. (string) default(${CONNECTOR_INSTALL_ROOT})
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|  | classpath : STRING
|  | A list of paths or JAR file names which together form the location for the resource provider classes. Class path entries are separated by using the ENTER key and must not contain path separator characters (such as ';' or ':'). Class paths can contain variable (symbolic) names that can be substituted using a variable map. Check your driver installation notes for specific JAR file names that are required. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this WebSphere J2C Resource Adapter. (map_string_string)
|  | description : STRING
|  | A description of the resource adapter. (string)
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | hACapability : STRING
|  | Selection of the checkbox is not recommended without first consulting the product documentation for the resource adapter, because the checkbox requires the resource adapter to support high availability of inbound messaging. Not supported for: WAS_61. (enum) values(RA_NO_HA, RA_ENDPOINT_HA, RA_INSTANCE_HA) default(RA_NO_HA)
|  | isEnableHASupport : STRING
|  | Enable HA support. The default value is false. Not supported for: WAS_61. (boolean) default(false)
|  | isolatedClassLoader : STRING
|  | If selected, this resource provider will be loaded in its own class loader. This allows different versions of the same resource provider to be loaded in the same JVM. Each version of a provider should be given a unique class path appropriate for that version. NOTE: A provider cannot be isolated when a native library path is specified. Not supported for: WAS_61. (boolean) default(false)
|  | nativepath : STRING
|  | An optional path to any native libraries (*.dll, *.so). Native path entries are separated by using the Enter key and must not contain path separator characters (such as ';' or ':'). Native paths can contain variable (symbolic) names that can be substituted using a variable map. (string)
|  | nodeName : STRING
|  | Specify the name of the nodes to install the RAR file. When deploying to cell scope, specify a comma-separated list of node names. (string)
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | scanPlaceholders : BOOLEAN = false
|  | Whether to scan this artifact for placeholders when it is imported
|  | singleton : STRING
|  | Selection of this checkbox is not recommended without first consulting the product documentation. Checking this box prevents more than one resource adapter JavaBean instance with the same resource adapter implementation class name from existing in the same JVM. This is an extremely restrictive environment. Not supported for: WAS_61. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | threadPoolAlias : STRING
|  | Specifies the name of a thread pool that is part of the server configuration for the resource adapter. Set this property only if the resource adapter uses the work manager service. If you input a thread pool name that does not exist in the server configuration, WebSphere(R) Application Server uses the name DEFAULT. (string) default(Default)

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

#### was.JaasAlias

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a user identity and password for Java(TM) 2 connector security to use. Targets Global Security.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | password : STRING
|  | Specifies the password to use for the target enterprise information system (EIS).
|  | username : STRING
|  | Specifies the Java(TM) 2 Connector(J2C) authentication data userId.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the authentication data entry.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,username,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jaas/create-or-modify-jaas-alias.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 41
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jaas/destroy-jaas-alias.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jaas/discover-jaas-alias.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jaas/create-or-modify-jaas-alias.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.JaasAliasSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a user identity and password for Java(TM) 2 connector security to use. Targets Global Security.

|  | Public Properties
--- | --- | ---
|  | description : STRING
|  | Specifies an optional description for the authentication data entry. (string)
|  | password : STRING
|  | Specifies the password to use for the target enterprise information system (EIS). (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | username : STRING
|  | Specifies the Java(TM) 2 Connector(J2C) authentication data userId. (string)

#### was.JavaProcessDefinition

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Configure and manage the process definition of this application server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | JavaVirtualMachine_bootClasspath : STRING
|  | Specifies bootstrap classes and resources for a JVM. This option is only available for JVMs that support bootstrap classes and resources. You might separate multiple paths by a colon (:) or semicolon (;), depending on operating system of the node. Warning: Any existing values defined on the application server will be overridden by here specified values.
|  | JavaVirtualMachine_classpath : STRING
|  | Specifies the standard class path in which the Java(TM) virtual machine looks for classes. Warning: Any existing values defined on the application server will be overridden by here specified values.
|  | JavaVirtualMachine_customProperties : MAP_STRING_STRING
|  | Specifies Java(TM) system properties that are set in memory for this JVM. Warning: Any existing values defined on the application server will be overridden by here specified values.
|  | JavaVirtualMachine_debugArgs : STRING
|  | Specifies command-line debug arguments to pass to the Java(TM) virtual machine that starts the application server process. You can specify arguments when Debug Mode is enabled. Warning: Any existing values defined on the application server will be overridden by here specified values.
|  | JavaVirtualMachine_debugMode : STRING
|  | Specifies whether to use the JVM debug output. The default is not to enable debug mode support. values(true, false)
|  | JavaVirtualMachine_disableJIT : STRING
|  | Specifies whether or not you want the Just-In-Time (JIT) compiler for the JVM disabled. Default WAS value is 'false'. values(true, false)
|  | JavaVirtualMachine_executableJarFileName : STRING
|  | Specifies a full path name for an executable JAR file that the Java(TM) virtual machine uses.
|  | JavaVirtualMachine_genericJvmArguments : STRING
|  | Specifies additional command line arguments for the JVM. Warning: Any existing values defined on the application server will be overridden by here specified values.
|  | JavaVirtualMachine_hprofArguments : STRING
|  | Specifies command-line profiler arguments to pass to the Java(TM) virtual machine that starts the application server process. You can specify arguments when HProf profiler support is enabled.
|  | JavaVirtualMachine_initialHeapSize : INTEGER
|  | Specifies the initial heap size available to the JVM (in megabytes). Specify 0 to use the default. Default WAS value is '0'.
|  | JavaVirtualMachine_maximumHeapSize : INTEGER
|  | Specifies the maximum heap size available to the JVM (in megabytes). Specify 0 to use the default. Default WAS value is '0'.
|  | JavaVirtualMachine_runHProf : STRING
|  | Specifies whether to use HProf profiler support. To use another profiler, specify the custom settings for the profiler using the HProf Arguments setting. The default is not to enable HProf profiler support. values(true, false)
|  | JavaVirtualMachine_verboseModeClass : STRING
|  | Specifies whether to use verbose debug output for class loading. The default is not to enable verbose class loading. Default WAS value is 'false'. values(true, false)
|  | JavaVirtualMachine_verboseModeGarbageCollection : STRING
|  | Specifies whether to use verbose debug output for garbage collection. The default is not to enable verbose garbage collection. Default WAS value is 'false'. values(true, false)
|  | JavaVirtualMachine_verboseModeJNI : STRING
|  | Specifies whether to use verbose debug output for native method invocation. The default is not to enable verbose JNI. Default WAS value is 'false'. values(true, false)
|  | MonitoringPolicy_autoRestart : STRING
|  | Specifies whether the process should restart automatically if it fails. The default is to restart the process automatically. values(true, false)
|  | MonitoringPolicy_maximumStartupAttempts : INTEGER
|  | Specifies the maximum number of times to attempt to start the application server before giving up. Default WAS value is '3'.
|  | MonitoringPolicy_nodeRestartState : ENUM [STOPPED, RUNNING, PREVIOUS]
|  | Specifies the processing state attained if the autoRestart option is selected. The options are: STOPPED, RUNNING, PREVIOUS. The default is STOPPED.
|  | MonitoringPolicy_pingInterval : INTEGER
|  | Specifies the frequency of communication attempts between the parent process, such as the node agent, and the process it has spawned, such as an application server. Adjust this value based on your requirements for restarting failed servers. Decreasing the value detects failures sooner; increasing the value reduces the frequency of pings, reducing system overhead. Default WAS value is '60'.
|  | MonitoringPolicy_pingTimeout : INTEGER
|  | Specifies the interval after which no response from the monitored process is assumed to indicate that it is faulty. Default WAS value is '300'.
|  | ProcessExecution_processPriority : INTEGER
|  | Specifies the operating system priority for the process. Only root users can change the value specified in this field. Default WAS value is '20'.
|  | ProcessExecution_runAsGroup : STRING
|  | Specifies the group that the process belongs to and under which the process runs.
|  | ProcessExecution_runAsUser : STRING
|  | Specifies the user name under which the process runs.
|  | ProcessExecution_runInProcessGroup : INTEGER
|  | Specifies a process for a specific process group. The value specified in this field can be used for such things as processor partitioning. For example, a system administrator can assign a process group to run on 6 of 12 processors. The default value 0 (zero) indicates that the process is not assigned to any specific group. Default WAS value is '0'.
|  | ProcessExecution_umask : STRING
|  | Specifies the user mask under which the process runs (the file-mode permission mask). Default WAS value is '022'.
|  | customProperties : MAP_STRING_STRING
|  | Specifies settings that are added to the runtime environment for the process. Warning: Any existing values defined on the application server will be overridden by here specified values.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | executableArguments : STRING
|  | Specifies executable commands that run when the process starts.
|  | executableName : STRING
|  | Specifies the executable name of the process.
|  | executableTarget : STRING
|  | Specifies the name of the executable target (a Java(TM) class (containing a main() method, or the name of an executable JAR file), depending on the executable target type. Default WAS value is 'com.ibm.ws.runtime.WsServer'.
|  | executableTargetKind : ENUM [JAVA_CLASS, EXECUTABLE_JAR]
|  | Specifies whether a Java(TM) class name or the name of an executable JAR file will be used as the executable target of this Java(TM) process. Default WAS value is 'JAVA_CLASS'.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | startCommand : STRING
|  | Specifies the command to start the process.
|  | startCommandArgs : STRING
|  | Specifies the arguments for the command to start the process.
|  | stopCommand : STRING
|  | Specifies the command to stop the process. For z/OS, if this field is left blank, the MVS STOP command is used to stop the generic server.
|  | stopCommandArgs : STRING
|  | Specifies the arguments for the stop command.
|  | workingDirectory : STRING
|  | Specifies the file system directory in which the process will run. Default WAS value is '${USER_INSTALL_ROOT}'.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/process/modify-process-def.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = JavaProcessDefinition
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/process/discover-inspect-process-def.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/process/modify-process-def.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = JavaProcessDef
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.JavaProcessDefinitionSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Configure and manage the process definition of this application server.

|  | Public Properties
--- | --- | ---
|  | JavaVirtualMachine_bootClasspath : STRING
|  | Specifies bootstrap classes and resources for a JVM. This option is only available for JVMs that support bootstrap classes and resources. You might separate multiple paths by a colon (:) or semicolon (;), depending on operating system of the node. Warning: Any existing values defined on the application server will be overridden by here specified values. (string)
|  | JavaVirtualMachine_classpath : STRING
|  | Specifies the standard class path in which the Java(TM) virtual machine looks for classes. Warning: Any existing values defined on the application server will be overridden by here specified values. (string)
|  | JavaVirtualMachine_customProperties : MAP_STRING_STRING
|  | Specifies Java(TM) system properties that are set in memory for this JVM. Warning: Any existing values defined on the application server will be overridden by here specified values. (map_string_string)
|  | JavaVirtualMachine_debugArgs : STRING
|  | Specifies command-line debug arguments to pass to the Java(TM) virtual machine that starts the application server process. You can specify arguments when Debug Mode is enabled. Warning: Any existing values defined on the application server will be overridden by here specified values. (string)
|  | JavaVirtualMachine_debugMode : STRING
|  | Specifies whether to use the JVM debug output. The default is not to enable debug mode support. values(true, false) (string)
|  | JavaVirtualMachine_disableJIT : STRING
|  | Specifies whether or not you want the Just-In-Time (JIT) compiler for the JVM disabled. Default WAS value is 'false'. values(true, false) (string)
|  | JavaVirtualMachine_executableJarFileName : STRING
|  | Specifies a full path name for an executable JAR file that the Java(TM) virtual machine uses. (string)
|  | JavaVirtualMachine_genericJvmArguments : STRING
|  | Specifies additional command line arguments for the JVM. Warning: Any existing values defined on the application server will be overridden by here specified values. (string)
|  | JavaVirtualMachine_hprofArguments : STRING
|  | Specifies command-line profiler arguments to pass to the Java(TM) virtual machine that starts the application server process. You can specify arguments when HProf profiler support is enabled. (string)
|  | JavaVirtualMachine_initialHeapSize : STRING
|  | Specifies the initial heap size available to the JVM (in megabytes). Specify 0 to use the default. Default WAS value is '0'. (integer)
|  | JavaVirtualMachine_maximumHeapSize : STRING
|  | Specifies the maximum heap size available to the JVM (in megabytes). Specify 0 to use the default. Default WAS value is '0'. (integer)
|  | JavaVirtualMachine_runHProf : STRING
|  | Specifies whether to use HProf profiler support. To use another profiler, specify the custom settings for the profiler using the HProf Arguments setting. The default is not to enable HProf profiler support. values(true, false) (string)
|  | JavaVirtualMachine_verboseModeClass : STRING
|  | Specifies whether to use verbose debug output for class loading. The default is not to enable verbose class loading. Default WAS value is 'false'. values(true, false) (string)
|  | JavaVirtualMachine_verboseModeGarbageCollection : STRING
|  | Specifies whether to use verbose debug output for garbage collection. The default is not to enable verbose garbage collection. Default WAS value is 'false'. values(true, false) (string)
|  | JavaVirtualMachine_verboseModeJNI : STRING
|  | Specifies whether to use verbose debug output for native method invocation. The default is not to enable verbose JNI. Default WAS value is 'false'. values(true, false) (string)
|  | MonitoringPolicy_autoRestart : STRING
|  | Specifies whether the process should restart automatically if it fails. The default is to restart the process automatically. values(true, false) (string)
|  | MonitoringPolicy_maximumStartupAttempts : STRING
|  | Specifies the maximum number of times to attempt to start the application server before giving up. Default WAS value is '3'. (integer)
|  | MonitoringPolicy_nodeRestartState : STRING
|  | Specifies the processing state attained if the autoRestart option is selected. The options are: STOPPED, RUNNING, PREVIOUS. The default is STOPPED. (enum) values(STOPPED, RUNNING, PREVIOUS)
|  | MonitoringPolicy_pingInterval : STRING
|  | Specifies the frequency of communication attempts between the parent process, such as the node agent, and the process it has spawned, such as an application server. Adjust this value based on your requirements for restarting failed servers. Decreasing the value detects failures sooner; increasing the value reduces the frequency of pings, reducing system overhead. Default WAS value is '60'. (integer)
|  | MonitoringPolicy_pingTimeout : STRING
|  | Specifies the interval after which no response from the monitored process is assumed to indicate that it is faulty. Default WAS value is '300'. (integer)
|  | ProcessExecution_processPriority : STRING
|  | Specifies the operating system priority for the process. Only root users can change the value specified in this field. Default WAS value is '20'. (integer)
|  | ProcessExecution_runAsGroup : STRING
|  | Specifies the group that the process belongs to and under which the process runs. (string)
|  | ProcessExecution_runAsUser : STRING
|  | Specifies the user name under which the process runs. (string)
|  | ProcessExecution_runInProcessGroup : STRING
|  | Specifies a process for a specific process group. The value specified in this field can be used for such things as processor partitioning. For example, a system administrator can assign a process group to run on 6 of 12 processors. The default value 0 (zero) indicates that the process is not assigned to any specific group. Default WAS value is '0'. (integer)
|  | ProcessExecution_umask : STRING
|  | Specifies the user mask under which the process runs (the file-mode permission mask). Default WAS value is '022'. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies settings that are added to the runtime environment for the process. Warning: Any existing values defined on the application server will be overridden by here specified values. (map_string_string)
|  | executableArguments : STRING
|  | Specifies executable commands that run when the process starts. (string)
|  | executableName : STRING
|  | Specifies the executable name of the process. (string)
|  | executableTarget : STRING
|  | Specifies the name of the executable target (a Java(TM) class (containing a main() method, or the name of an executable JAR file), depending on the executable target type. Default WAS value is 'com.ibm.ws.runtime.WsServer'. (string)
|  | executableTargetKind : STRING
|  | Specifies whether a Java(TM) class name or the name of an executable JAR file will be used as the executable target of this Java(TM) process. Default WAS value is 'JAVA_CLASS'. (enum) values(JAVA_CLASS, EXECUTABLE_JAR)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | startCommand : STRING
|  | Specifies the command to start the process. (string)
|  | startCommandArgs : STRING
|  | Specifies the arguments for the command to start the process. (string)
|  | stopCommand : STRING
|  | Specifies the command to stop the process. For z/OS, if this field is left blank, the MVS STOP command is used to stop the generic server. (string)
|  | stopCommandArgs : STRING
|  | Specifies the arguments for the stop command. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | workingDirectory : STRING
|  | Specifies the file system directory in which the process will run. Default WAS value is '${USER_INSTALL_ROOT}'. (string)

#### was.JdbcProvider

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | Specifies a semicolon-separated list of paths or JAR file names that together form the location for the resource provider classes.
|  | implementationClassName : STRING
|  | Specifies the Java class name of the JDBC driver's datasource implementation.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies description for the resource.
|  | isolatedClassLoader : BOOLEAN = false
|  | If selected, this resource provider will be loaded in its own class loader.
|  | nativepath : STRING
|  | Specifies an optional path to any native libraries.
|  | providerType : STRING = User-defined
|  | Specifies a provider type
|  | xa : BOOLEAN
|  | Select XA datasource, if your application requires two-phase commit transactions.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/JdbcProvider/create-or-modify-jdbc-provider.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/JdbcProvider/destroy-jdbc-provider.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/JdbcProvider/discover-inspect-user-jdbc-provider.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/JdbcProvider/jdbc-provider-lib.py, was/JdbcProvider/discover-inspect-jdbc-provider-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 58
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/JdbcProvider/create-or-modify-jdbc-provider.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.JdbcProviderSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | Specifies a semicolon-separated list of paths or JAR file names that together form the location for the resource provider classes. (string)
|  | description : STRING
|  | Specifies description for the resource. (string)
|  | implementationClassName : STRING
|  | Specifies the Java class name of the JDBC driver's datasource implementation. (string)
|  | isolatedClassLoader : STRING
|  | If selected, this resource provider will be loaded in its own class loader. (boolean) default(false)
|  | nativepath : STRING
|  | Specifies an optional path to any native libraries. (string)
|  | providerType : STRING
|  | Specifies a provider type (string) default(User-defined)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | xa : STRING
|  | Select XA datasource, if your application requires two-phase commit transactions. (boolean)

#### was.JmsConnectionFactory

Virtual Type
Type Hierarchy | was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-jms-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/modify-jms-object.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.JmsProvider

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a JMS Provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | A list of paths or JAR file names which together form the location for the JMS provider classes.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this JMS Provider.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the JMS provider.
|  | externalInitialContextFactory : STRING
|  | The Java classname of the initial context factory for the JMS provider. Required for non-default JMS providers.
|  | externalProviderURL : STRING
|  | The JMS provider URL for external JNDI lookups. Required for non-default JMS providers.
|  | nativepath : STRING
|  | An optional path to any native libraries (*.dll, *.so).

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 58
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = JMSProvider
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.JmsProviderSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a JMS Provider.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | A list of paths or JAR file names which together form the location for the JMS provider classes. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this JMS Provider. (map_string_string)
|  | description : STRING
|  | A description of the JMS provider. (string)
|  | externalInitialContextFactory : STRING
|  | The Java classname of the initial context factory for the JMS provider. Required for non-default JMS providers. (string)
|  | externalProviderURL : STRING
|  | The JMS provider URL for external JNDI lookups. Required for non-default JMS providers. (string)
|  | nativepath : STRING
|  | An optional path to any native libraries (*.dll, *.so). (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.JmsResource

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed JMS resource configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-jms-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/modify-jms-object.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.Keystore

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Defines keystore types, including cryptography, Resource Access Control Facility (RACF®), Certificate Management Services (CMS), Java, and all trust store types.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | location : STRING
|  | Specifies the location of the keystore file in the format needed by the keystore type.
|  | password : STRING
|  | Specifies the password used to protect the keystore.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of the keystore.
|  | initializeAtStartup : BOOLEAN = false
|  | Specifies whether the keystore needs to be initialized before it can be used for cryptographic operations.
|  | keyStoreType : STRING
|  | Specifies the implementation for keystore management.
|  | managementScope : STRING
|  | Specifies the scope where this Secure Sockets Layer (SSL) configuration is visible.
|  | readOnly : BOOLEAN = false
|  | Specifies whether the keystore can be written to or not.
|  | useRelativePath : BOOLEAN = true
|  | when true, the path of the File is made relative using ${CONFIG_ROOT} but only when it matches the value of ${CONFIG_ROOT}

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = managementScope,useRelativePath,location,keyStoreType,description
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/security/create-keystore.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/security/destroy-keystore.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/security/discover-inspect-keystore.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/security/security-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/security/modify-keystore.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.KeystoreFile

Type Hierarchy | generic.File >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Description unavailable (deployable)

|  | Public Properties
--- | --- | ---
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | scanPlaceholders : BOOLEAN = true
|  | Whether to scan this artifact for placeholders when it is imported
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | targetDirectory : STRING
|  | Specifies the target directory of the key store file. (string)
|  | targetFile : STRING
|  | Name of the artifact on the generic server. (string)

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

#### was.KeystoreSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Defines keystore types, including cryptography, Resource Access Control Facility (RACF®), Certificate Management Services (CMS), Java, and all trust store types.

|  | Public Properties
--- | --- | ---
|  | description : STRING
|  | Specifies the description of the keystore. (string)
|  | initializeAtStartup : STRING
|  | Specifies whether the keystore needs to be initialized before it can be used for cryptographic operations. (boolean) default(false)
|  | keyStoreType : STRING
|  | Specifies the implementation for keystore management. (string)
|  | location : STRING
|  | Specifies the location of the keystore file in the format needed by the keystore type. (string)
|  | managementScope : STRING
|  | Specifies the scope where this Secure Sockets Layer (SSL) configuration is visible. (string)
|  | password : STRING
|  | Specifies the password used to protect the keystore. (string)
|  | readOnly : STRING
|  | Specifies whether the keystore can be written to or not. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useRelativePath : STRING
|  | when true, the path of the File is made relative using ${CONFIG_ROOT} but only when it matches the value of ${CONFIG_ROOT} (boolean) default(true)

#### was.ListenerPort

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies listener ports upon which message-driven beans listen for messages. Message listener ports must be configured at the server scope.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | connectionFactoryJNDIName : STRING
|  | The JNDI name for the JMS connection factory to be used by the listener port; for example, jms/connFactory1.
|  | destinationJNDIName : STRING
|  | The JNDI name for the destination to be used by the listener port; for example, jms/destn1.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | initialStateStarted : BOOLEAN = true
|  | If unset, The Execution state requested when the server is first started,is 'stopped'.
|  | maxMessages : INTEGER = 1
|  | The maximum number of messages that the listener can process in one transaction, The default is 1.
|  | maxRetries : INTEGER = 0
|  | The maximum number of times that the listener tries to deliver a message to a message-driven bean instance before the listener is stopped, in the range 0 through 2147483647, The default is 0.
|  | maxSessions : INTEGER = 1
|  | The maximum number of concurrent sessions that a listener can have with the JMS server to process messages, The default is 1.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = initialStateStarted,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/create-listenerport.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/server/destroy-listenerport.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-listenerport.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/discover-inspect-containerproperties-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = ListenerPort
|  | WAS config type of ListenerPort.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ListenerPortSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies listener ports upon which message-driven beans listen for messages.

|  | Public Properties
--- | --- | ---
|  | connectionFactoryJNDIName : STRING
|  | The JNDI name for the JMS connection factory to be used by the listener port; for example, jms/connFactory1. (string)
|  | destinationJNDIName : STRING
|  | The JNDI name for the destination to be used by the listener port; for example, jms/destn1. (string)
|  | initialStateStarted : STRING
|  | If unset, The Execution state requested when the server is first started,is 'stopped'. (boolean) default(true)
|  | maxMessages : STRING
|  | The maximum number of messages that the listener can process in one transaction, The default is 1. (integer) default(1)
|  | maxRetries : STRING
|  | The maximum number of times that the listener tries to deliver a message to a message-driven bean instance before the listener is stopped, in the range 0 through 2147483647, The default is 0. (integer) default(0)
|  | maxSessions : STRING
|  | The maximum number of concurrent sessions that a listener can have with the JMS server to process messages, The default is 1. (integer) default(1)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.LoggingAndTracing

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Configure and manage the logging and tracing settings of this application server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ErrorStreamRedirect_baseHour : INTEGER
|  | Start time hour. Default WAS value is '24'.
|  | ErrorStreamRedirect_fileName : STRING
|  | Specifies the name of the System.Err file. Default WAS value is '${SERVER_LOG_ROOT}/SystemErr.log'.
|  | ErrorStreamRedirect_formatWrites : STRING
|  | Specifies should the print statements be formatted. Default WAS value is 'true'. values(true, false)
|  | ErrorStreamRedirect_maxNumberOfBackupFiles : INTEGER
|  | Specifies the number of rotated System.Err log files to keep. Number in range 1 through 200. Default WAS value is '5'.
|  | ErrorStreamRedirect_messageFormatKind : ENUM [BASIC, ADVANCED]
|  | Specifies the format to use to save the System.Err file. Default WAS value is 'BASIC'.
|  | ErrorStreamRedirect_rolloverPeriod : INTEGER
|  | Repeat time period. Default WAS value is '24'.
|  | ErrorStreamRedirect_rolloverSize : INTEGER
|  | Specifies the maximum rollover file size in Megabytes (MB). Default WAS value is '1'.
|  | ErrorStreamRedirect_rolloverType : ENUM [SIZE, TIME]
|  | Specifies the rollover type to use. Default WAS value is 'SIZE'.
|  | ErrorStreamRedirect_suppressStackTrace : STRING
|  | Suppress Stack Traces
|  | ErrorStreamRedirect_suppressWrites : STRING
|  | Suppress Application Print Statements
|  | OutputRedirect_stderrFilename : STRING
|  | Use this field on the Configuration tab to specify the name to use for the stderr file. Default WAS value is '${SERVER_LOG_ROOT}/native_stderr.log'.
|  | OutputRedirect_stdoutFilename : STRING
|  | Use this field on the Configuration tab to specify the name to use for the stdout file. Default WAS value is '${SERVER_LOG_ROOT}/native_stdout.log'.
|  | OutputStreamRedirect_baseHour : INTEGER
|  | Start time hour. Default WAS value is '24'.
|  | OutputStreamRedirect_fileName : STRING
|  | Specifies the name of the System.out file. Default WAS value is '${SERVER_LOG_ROOT}/SystemOut.log'.
|  | OutputStreamRedirect_formatWrites : STRING
|  | Specifies should the print statements be formatted. Default WAS value is 'true'. values(true, false)
|  | OutputStreamRedirect_maxNumberOfBackupFiles : INTEGER
|  | Specifies the number of rotated System.out log files to keep. Number in range 1 through 200. Default WAS value is '5'.
|  | OutputStreamRedirect_messageFormatKind : ENUM [BASIC, ADVANCED]
|  | Specifies the format to use to save the System.out file. Default WAS value is 'BASIC'.
|  | OutputStreamRedirect_rolloverPeriod : INTEGER
|  | Repeat time period. Default WAS value is '24'.
|  | OutputStreamRedirect_rolloverSize : INTEGER
|  | Specifies the maximum rollover file size in Megabytes (MB). Default WAS value is '1'.
|  | OutputStreamRedirect_rolloverType : ENUM [SIZE, TIME]
|  | Specifies the rollover type to use. Default WAS value is 'SIZE'.
|  | OutputStreamRedirect_suppressStackTrace : STRING
|  | Suppress Stack Traces
|  | OutputStreamRedirect_suppressWrites : STRING
|  | Suppress Application Print Statements
|  | RASLoggingService_ServiceLog_enabled : STRING
|  | Select this box to create the IBM Service log file to store diagnostic data. Default WAS value is 'false'. values(true, false)
|  | RASLoggingService_ServiceLog_name : STRING
|  | Specifies the name of the service or activity log for the application server. Default WAS value is '${LOG_ROOT}/activity.log'.
|  | RASLoggingService_ServiceLog_size : INTEGER
|  | Specifies the maximum size of the service log file in megabytes. The default size is 2 megabytes.
|  | RASLoggingService_enableCorrelationId : STRING
|  | Select this box to create a correlation ID. Default WAS value is 'true'. values(true, false)
|  | RASLoggingService_suppressStackTraces : STRING
|  | Supress stack traces. Default WAS value is 'false'. values(true, false)
|  | TraceService_TraceLog_fileName : STRING
|  | Specifies the name of the trace log file. Default WAS value is '${SERVER_LOG_ROOT}/trace.log'.
|  | TraceService_TraceLog_maxNumberOfBackupFiles : INTEGER
|  | Specifies the number of rotated trace log files to keep. Number in range 1 through 200. Default WAS value is '5'.
|  | TraceService_TraceLog_rolloverSize : INTEGER
|  | Specifies the maximum rollover file size in Megabytes (MB). Default WAS value is '200'.
|  | TraceService_enable : STRING
|  | Select this box to create the trace log file to store trace data. Default WAS value is 'true'. values(true, false)
|  | TraceService_memoryBufferSize : INTEGER
|  | Specifies the maximum number of entries in memory in thousands. Default WAS value is '8'.
|  | TraceService_traceFormat : ENUM [BASIC, ADVANCED, LOG_ANALYZER]
|  | Use this field to specify the format of the trace output. Default WAS value is 'BASIC'.
|  | TraceService_traceOutputType : ENUM [MEMORY_BUFFER, SPECIFIED_FILE]
|  | Use these options to specify the type of output for the trace to generate. Default WAS value is 'MEMORY_BUFFER'.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/logging/modify-logging.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = LoggingAndTracing
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/logging/discover-inspect-logging.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/logging/modify-logging.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.LoggingAndTracingSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Configure and manage the logging and tracing settings of this application server.

|  | Public Properties
--- | --- | ---
|  | ErrorStreamRedirect_baseHour : STRING
|  | Start time hour. Default WAS value is '24'. (integer)
|  | ErrorStreamRedirect_fileName : STRING
|  | Specifies the name of the System.Err file. Default WAS value is '${SERVER_LOG_ROOT}/SystemErr.log'. (string)
|  | ErrorStreamRedirect_formatWrites : STRING
|  | Specifies should the print statements be formatted. Default WAS value is 'true'. values(true, false) (string)
|  | ErrorStreamRedirect_maxNumberOfBackupFiles : STRING
|  | Specifies the number of rotated System.Err log files to keep. Number in range 1 through 200. Default WAS value is '5'. (integer)
|  | ErrorStreamRedirect_messageFormatKind : STRING
|  | Specifies the format to use to save the System.Err file. Default WAS value is 'BASIC'. (enum) values(BASIC, ADVANCED)
|  | ErrorStreamRedirect_rolloverPeriod : STRING
|  | Repeat time period. Default WAS value is '24'. (integer)
|  | ErrorStreamRedirect_rolloverSize : STRING
|  | Specifies the maximum rollover file size in Megabytes (MB). Default WAS value is '1'. (integer)
|  | ErrorStreamRedirect_rolloverType : STRING
|  | Specifies the rollover type to use. Default WAS value is 'SIZE'. (enum) values(SIZE, TIME)
|  | ErrorStreamRedirect_suppressStackTrace : STRING
|  | Suppress Stack Traces (string)
|  | ErrorStreamRedirect_suppressWrites : STRING
|  | Suppress Application Print Statements (string)
|  | OutputRedirect_stderrFilename : STRING
|  | Use this field on the Configuration tab to specify the name to use for the stderr file. Default WAS value is '${SERVER_LOG_ROOT}/native_stderr.log'. (string)
|  | OutputRedirect_stdoutFilename : STRING
|  | Use this field on the Configuration tab to specify the name to use for the stdout file. Default WAS value is '${SERVER_LOG_ROOT}/native_stdout.log'. (string)
|  | OutputStreamRedirect_baseHour : STRING
|  | Start time hour. Default WAS value is '24'. (integer)
|  | OutputStreamRedirect_fileName : STRING
|  | Specifies the name of the System.out file. Default WAS value is '${SERVER_LOG_ROOT}/SystemOut.log'. (string)
|  | OutputStreamRedirect_formatWrites : STRING
|  | Specifies should the print statements be formatted. Default WAS value is 'true'. values(true, false) (string)
|  | OutputStreamRedirect_maxNumberOfBackupFiles : STRING
|  | Specifies the number of rotated System.out log files to keep. Number in range 1 through 200. Default WAS value is '5'. (integer)
|  | OutputStreamRedirect_messageFormatKind : STRING
|  | Specifies the format to use to save the System.out file. Default WAS value is 'BASIC'. (enum) values(BASIC, ADVANCED)
|  | OutputStreamRedirect_rolloverPeriod : STRING
|  | Repeat time period. Default WAS value is '24'. (integer)
|  | OutputStreamRedirect_rolloverSize : STRING
|  | Specifies the maximum rollover file size in Megabytes (MB). Default WAS value is '1'. (integer)
|  | OutputStreamRedirect_rolloverType : STRING
|  | Specifies the rollover type to use. Default WAS value is 'SIZE'. (enum) values(SIZE, TIME)
|  | OutputStreamRedirect_suppressStackTrace : STRING
|  | Suppress Stack Traces (string)
|  | OutputStreamRedirect_suppressWrites : STRING
|  | Suppress Application Print Statements (string)
|  | RASLoggingService_ServiceLog_enabled : STRING
|  | Select this box to create the IBM Service log file to store diagnostic data. Default WAS value is 'false'. values(true, false) (string)
|  | RASLoggingService_ServiceLog_name : STRING
|  | Specifies the name of the service or activity log for the application server. Default WAS value is '${LOG_ROOT}/activity.log'. (string)
|  | RASLoggingService_ServiceLog_size : STRING
|  | Specifies the maximum size of the service log file in megabytes. The default size is 2 megabytes. (integer)
|  | RASLoggingService_enableCorrelationId : STRING
|  | Select this box to create a correlation ID. Default WAS value is 'true'. values(true, false) (string)
|  | RASLoggingService_suppressStackTraces : STRING
|  | Supress stack traces. Default WAS value is 'false'. values(true, false) (string)
|  | TraceService_TraceLog_fileName : STRING
|  | Specifies the name of the trace log file. Default WAS value is '${SERVER_LOG_ROOT}/trace.log'. (string)
|  | TraceService_TraceLog_maxNumberOfBackupFiles : STRING
|  | Specifies the number of rotated trace log files to keep. Number in range 1 through 200. Default WAS value is '5'. (integer)
|  | TraceService_TraceLog_rolloverSize : STRING
|  | Specifies the maximum rollover file size in Megabytes (MB). Default WAS value is '200'. (integer)
|  | TraceService_enable : STRING
|  | Select this box to create the trace log file to store trace data. Default WAS value is 'true'. values(true, false) (string)
|  | TraceService_memoryBufferSize : STRING
|  | Specifies the maximum number of entries in memory in thousands. Default WAS value is '8'. (integer)
|  | TraceService_traceFormat : STRING
|  | Use this field to specify the format of the trace output. Default WAS value is 'BASIC'. (enum) values(BASIC, ADVANCED, LOG_ANALYZER)
|  | TraceService_traceOutputType : STRING
|  | Use these options to specify the type of output for the trace to generate. Default WAS value is 'MEMORY_BUFFER'. (enum) values(MEMORY_BUFFER, SPECIFIED_FILE)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.MOfNPolicy

Type Hierarchy | was.OneOfNPolicy >> was.HAManagerPolicy >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a policy that keeps a number of group member active at all times.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | isAlivePeriodSec : INTEGER = 120
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted.
|  | numActive : INTEGER = 1
|  | Specifies the number of group members to activate at startup.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the policy.
|  | failback : BOOLEAN
|  | Specifies whether active group members are moved to the most preferred server at any given time.
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy.
|  | preferredOnly : BOOLEAN
|  | Specifies whether group members are activated only on servers from the list of preferred servers.
|  | preferredServers : SET_OF_CI<was.ManagedServer >
|  | Specifies an ordered list of preferred core group servers for a policy.
|  | quorumEnabled : BOOLEAN = false
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,type,wasType,deployable,container,customProperties,matchCriteria,servers,preferredServers
|  | Additional Properties Not To Expose
|  | policyFactory : STRING = com.ibm.ws.hamanager.coordinator.policy.impl.MOfNPolicyFactory
|  | The fully qualified name of the Java interface that serves as a factory for a specific type of concrete HAManagerPolicy.
|  | wasType : STRING = MOfNPolicy
|  | WebSphere admin resource type.

#### was.MOfNPolicySpec

Type Hierarchy | was.OneOfNPolicySpec >> was.HAManagerPolicySpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Specifies a policy that keeps a number of group member active at all times.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the policy. (string)
|  | failback : STRING
|  | Specifies whether active group members are moved to the most preferred server at any given time. (boolean)
|  | isAlivePeriodSec : STRING
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (integer) default(120)
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy. (map_string_string)
|  | numActive : STRING
|  | Specifies the number of group members to activate at startup. (integer) default(1)
|  | preferredOnly : STRING
|  | Specifies whether group members are activated only on servers from the list of preferred servers. (boolean)
|  | preferredServers : SET_OF_STRING
|  | Specifies an ordered list of preferred core group servers for a policy.
|  | quorumEnabled : STRING
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation. (boolean) default(false)

#### was.MailProvider

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the mail provider that the application server uses.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | Specifies the class path to a Java archive (JAR) file that contains the implementation classes for this mail provider. Entries are ';' separated.
|  | customProperties : MAP_STRING_STRING
|  | Specifies the custom properties of a Java™ Platform, Enterprise Edition (Java EE) resource provider or connection factory.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the resource provider description.
|  | isolatedClassLoader : BOOLEAN = false
|  | Specifies that this mail provider will be loaded in its own class loader.
|  | nativepath : STRING
|  | Specifies the class path to a Java archive (JAR) file that contains the implementation classes for this mail provider. Entries are ';' separated.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = isolatedClassLoader,classpath,customProperties,defaultStoreProtocolProviders,defaultTransportProtocolProviders
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 59
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/mail/create-mailprovider.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 41
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/mail/destroy-mailprovider.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/mail/discover-inspect-mailprovider.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/mail/mail-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/mail/modify-mailprovider.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | defaultStoreProtocolProviders : MAP_STRING_STRING = {com.sun.mail.pop3.POP3Store=pop3, com.sun.mail.pop3.POP3SSLStore=pop3s, com.sun.mail.imap.IMAPStore=imap, com.sun.mail.imap.IMAPSSLStore=imaps}
|  | Default Store Protocol Providers
|  | defaultTransportProtocolProviders : MAP_STRING_STRING = {com.sun.mail.smtp.SMTPTransport=smtp, com.sun.mail.smtp.SMTPSSLTransport=smtps}
|  | Default Transport Protocol Providers
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.MailProviderSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the mail provider that the application server uses.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | Specifies the class path to a Java archive (JAR) file that contains the implementation classes for this mail provider. Entries are ';' separated. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies the custom properties of a Java™ Platform, Enterprise Edition (Java EE) resource provider or connection factory. (map_string_string)
|  | description : STRING
|  | Specifies the resource provider description. (string)
|  | isolatedClassLoader : STRING
|  | Specifies that this mail provider will be loaded in its own class loader. (boolean) default(false)
|  | nativepath : STRING
|  | Specifies the class path to a Java archive (JAR) file that contains the implementation classes for this mail provider. Entries are ';' separated. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.MailSession

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a mail Session.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | Specifies the Java™ Naming and Directory Interface (JNDI) name for the resource, including any naming subcontexts.
|  | mailStoreProtocol : ENUM [imap, imaps, pop3, pop3s] = imap
|  | Specifies the protocol to be used when receiving mail.
|  | mailTransportProtocol : ENUM [smtp, smtps] = smtp
|  | Specifies the transport protocol to use when sending mail.
|  | category : STRING
|  | Specifies an optional collection for classifying or grouping sessions.
|  | customProperties : MAP_STRING_STRING
|  | Specifies the custom properties of a Java™ Platform, Enterprise Edition (Java EE) resource provider or connection factory.
|  | debug : BOOLEAN = false
|  | Toggles debug mode on and off for this mail session.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for your administrative records.
|  | mailFrom : STRING
|  | Specifies the mail originator.
|  | mailStoreHost : STRING
|  | Specifies the mail account host (or 'domain') name.
|  | mailStorePassword : STRING
|  | Specifies the password of the mail account.
|  | mailStoreUser : STRING
|  | Specifies the user ID of the mail account.
|  | mailTransportHost : STRING
|  | Specifies the server to connect to when sending mail.
|  | mailTransportPassword : STRING
|  | Specifies the password to use when the mail transport host requires authentication.
|  | mailTransportUser : STRING
|  | Specifies the user ID to use when the mail transport host requires authentication.
|  | provider : STRING = Built-in Mail Provider
|  | Specifies the mail provider that the application server uses for this mail session.
|  | strict : BOOLEAN = true
|  | Specifies whether the recipient addresses must be parsed in strict compliance with RFC 822, which is a specifications document issued by the Internet Architecture Board.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,customProperties,mailStoreHost,mailStoreUser,mailStorePassword,mailStoreProtocol,mailFrom,mailTransportHost,mailTransportUser,mailTransportPassword,mailTransportProtocol
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/mail/create-mailsession.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/mail/destroy-mailsession.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 46
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/mail/discover-inspect-mailsession.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/mail/mail-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.MailSessionSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a mail Session.

|  | Public Properties
--- | --- | ---
|  | category : STRING
|  | Specifies an optional collection for classifying or grouping sessions. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies the custom properties of a Java™ Platform, Enterprise Edition (Java EE) resource provider or connection factory. (map_string_string)
|  | debug : STRING
|  | Toggles debug mode on and off for this mail session. (boolean) default(false)
|  | description : STRING
|  | Specifies an optional description for your administrative records. (string)
|  | jndiName : STRING
|  | Specifies the Java™ Naming and Directory Interface (JNDI) name for the resource, including any naming subcontexts. (string)
|  | mailFrom : STRING
|  | Specifies the mail originator. (string)
|  | mailStoreHost : STRING
|  | Specifies the mail account host (or 'domain') name. (string)
|  | mailStorePassword : STRING
|  | Specifies the password of the mail account. (string)
|  | mailStoreProtocol : STRING
|  | Specifies the protocol to be used when receiving mail. (enum) values(imap, imaps, pop3, pop3s) default(imap)
|  | mailStoreUser : STRING
|  | Specifies the user ID of the mail account. (string)
|  | mailTransportHost : STRING
|  | Specifies the server to connect to when sending mail. (string)
|  | mailTransportPassword : STRING
|  | Specifies the password to use when the mail transport host requires authentication. (string)
|  | mailTransportProtocol : STRING
|  | Specifies the transport protocol to use when sending mail. (enum) values(smtp, smtps) default(smtp)
|  | mailTransportUser : STRING
|  | Specifies the user ID to use when the mail transport host requires authentication. (string)
|  | provider : STRING
|  | Specifies the mail provider that the application server uses for this mail session. (string) default(Built-in Mail Provider)
|  | strict : STRING
|  | Specifies whether the recipient addresses must be parsed in strict compliance with RFC 822, which is a specifications document issued by the Internet Architecture Board. (boolean) default(true)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ManagedServer

Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, was.WasAppContainer, was.HealthPolicyMembershipContainer, was.Server, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

A WebSphere server managed by a node that is part of a deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | node : CI<was.NodeAgent >
|  | Node on which the server runs

|  | Public Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | Restart strategy used when deploying. Valid values are: NONE,STOP_START,RESTART. For example, if STOP_START strategy is used container will be stopped before deployment and started after the deployment. If RESTART strategy is used deployment will be executed, then container will be restarted using restart script - if there is no restart script defined deployment will be executed than container will be stopped and immediately started. Please note that it's probably better to use property containerRestartStrategy defined on was.Module and it's subtypes.
|  | moduleDestination : STRING
|  | If set, the (custom) target directory for the installed Java EE archive.
|  | serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER]
|  | Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.
|  | weight : INTEGER = 2
|  | The weight to assign to this managed server within a cluster. Default value: 2. Has no meaning if used on a standalone server.

|  | Hidden Properties
--- | --- | ---
|  | restartOrder : INTEGER = 80
|  | Restart Order
|  | startOrder : INTEGER = 80
|  | Start Order
|  | startScript : STRING = was/container/start-server.py
|  | Start Script
|  | stopOrder : INTEGER = 20
|  | Stop Order
|  | stopScript : STRING = was/container/stop-server.py
|  | Stop Script

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
create | was.ManagedServer_create | script = was/container/create-server.py, delegate = pythonControlTask | Creates managed application server if it does not exist.
destroy |  | language = python, script = was/container/destroy-server.py | Destroys managed server. Cluster member server will be removed from cluster automatically.
restart |  | language = python, script = was/container/restart-server.py | Restarts managed server.
start |  | language = python, script = was/container/start-server.py | Starts managed server.
stop |  | language = python, script = was/container/stop-server.py | Stops managed server.

#### was.ManagedServer_create

Type Hierarchy | udm.Parameters >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem

Generated type for method create.

|  | Public Properties
--- | --- | ---
|  | template : STRING
|  | If set, server template name used to create server.

#### was.ManagedWebServer

Interfaces | udm.ConfigurationItem

An HTTP server managed by a node that is part of a deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | node : CI<was.Node>
|  | Node on which the http server runs

|  | Public Properties
--- | --- | ---
|  | host : CI<overthere.Host>
|  | Optionally, the host on which the webserver is running. If set, the plugin configuration file will be copied directly to the 'pluginConfigurationPath' given. Otherwise, WebSphere's node agent will be used.
|  | pluginConfigurationPath : STRING
|  | If 'host' is set, the path to which the generated plugin configuration file should be copied. If 'host' is not set, this value is ignored (e.g. '/opt/IBM/HTTPServer/Plugins/config/webserver1/plugin-cfg.xml')
|  | restartRequired : BOOLEAN
|  | If set, web server will be restarted on deployment or removal of the application that references this managed web server.
|  | updatePlugin : BOOLEAN
|  | If set, the plugin configuration for this web server will be generated and propagated.

|  | Hidden Properties
--- | --- | ---
|  | generatePluginOrder : INTEGER = 83
|  | Generate Plugin Order
|  | generatePluginScript : STRING = was/container/generate-webserver-plugin.py
|  | Generate Plugin Script
|  | propagatePluginOrder : INTEGER = 84
|  | Propagate Plugin Order
|  | propagatePluginScript : STRING = was/container/propagate-webserver-plugin.py
|  | Propagate Plugin Script
|  | startOrder : INTEGER = 85
|  | Start Order
|  | startScript : STRING = was/container/start-webserver.py
|  | Start Script
|  | stopOrder : INTEGER = 15
|  | Stop Order
|  | stopScript : STRING = was/container/stop-webserver.py
|  | Stop Script

#### was.Module

Virtual Type
Type Hierarchy | was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, was.ConfigurableModule, udm.ConfigurationItem, udm.DerivedArtifact

Base class for all deployed JEE module configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
|  | The additional install flags to be passed to AdminApp.install
|  | allowDispatchRemoteInclude : BOOLEAN
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
|  | allowServiceRemoteInclude : BOOLEAN
|  | Specifies whether an application can service an include request from an application.
|  | appEdition : STRING
|  | Edition used by this application.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
|  | Enables asynchronous dispatching and specifies how to aggregate the content.
|  | classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | Specifies whether classes are loaded using the parent class loader before the application class loader.
|  | createMBeansForResources : BOOLEAN
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | drainageInterval : INTEGER = 30
|  | Drainage interval in seconds.
|  | editionDescription : STRING
|  | Edition description used by this application.
|  | enableDistribution : BOOLEAN = true
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
|  | groupSize : INTEGER = 1
|  | Specifies num of members in a cluster.
|  | isEdition : BOOLEAN = false
|  | Edition used by this application.
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are or
|  | reloadEnabled : BOOLEAN
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
|  | reloadInterval : INTEGER
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
|  | resetStrategy : ENUM [SOFT, HARD] = SOFT
|  | Indicates type of reset strategy.
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping
|  | rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
|  | Indicates type of rollout strategy.
|  | sharedLibraries : SET_OF_CI<was.SharedLibrary >
|  | Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application.
|  | startingWeight : INTEGER = 1
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
|  | useMetadataFromBinaries : BOOLEAN
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
|  | warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.

|  | Hidden Properties
--- | --- | ---
|  | createEditionedOrder : INTEGER = 10
|  | The order in which a create step for Editioned application will be executed(was85nd only).
|  | createOrder : INTEGER = 70
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/application/deploy-application.py
|  | Python wsadmin script invoked to create a Java EE artifact.
|  | createVerb : STRING = Deploy
|  | The word is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 30
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/application/undeploy-application.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Undeploy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 70
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Update
|  | The word is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | retryAttemptsForAppReadyCheck : INTEGER = 6
|  | Number of retry attempts to check if an application has been distributed before attempting the application start.
|  | rolloutEditionedOrder : INTEGER = 20
|  | The order in which a rollout step will be executed.
|  | rolloutEditionedScript : STRING = was/application/rollout-edition.py
|  | Python wsadmin script invoked to perform rollout.
|  | rolloutEditionedVerb : STRING = Rollout
|  | The word that is used to prefix a step description for the rollout operation.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 90
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 10
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 75
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 35
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 75
|  | The order in which a synchronize after modify step will be executed.
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING = was/application/start-application.py
|  | Python wsadmin script invoked to start running a Java EE artifact.
|  | stopScript : STRING = was/application/stop-application.py
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.MsSqlDatasource

Type Hierarchy | was.Datasource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

MsSql data source object supplies your application with connections for accessing the database.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | databaseName : STRING
|  | Specifies the name of the database to which the datasource connects.
|  | datasourceHelperClassname : STRING = com.ibm.websphere.rsadapter.MicrosoftSQLServerDataStoreHelper
|  | Specifies the data store helper class, an interface through which a datasource is triggered by a database to perform functions specific to that database vendor.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | portNumber : INTEGER = 1433
|  | Specifies the port number on which the database server listens.
|  | serverName : STRING
|  | Specifies the name of the server to which the datasource connects.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/datasource/discover-inspect-mssql-datasources.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.MsSqlDatasourceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a MsSql datasource.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies connection timeout value for a JDBC data source. (integer) default(180)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies Maximum number of connections for a JDBC data source. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies Minimum number of connections for a JDBC data source. (integer) default(1)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | containerManagedPersistence : STRING
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans. (boolean) default(true)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | databaseName : STRING
|  | Specifies the name of the database to which the datasource connects. (string)
|  | datasourceHelperClassname : STRING
|  | Specifies the data store helper class, an interface through which a datasource is triggered by a database to perform functions specific to that database vendor. (string) default(com.ibm.websphere.rsadapter.MicrosoftSQLServerDataStoreHelper)
|  | description : STRING
|  | Specifies the description of this data source. (string)
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set. (string)
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source. (string)
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference. (string)
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)
|  | portNumber : STRING
|  | Specifies the port number on which the database server listens. (integer) default(1433)
|  | serverName : STRING
|  | Specifies the name of the server to which the datasource connects. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | testConnection : STRING
|  | If set, the connection to the database is tested. (boolean) default(false)
|  | useJaasAliasForContainerManagedAuthentication : STRING
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource. (boolean)
|  | useJaasAliasForXaRecovery : STRING
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers. (boolean)
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)

#### was.NoOpPolicy

Type Hierarchy | was.HAManagerPolicy >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a policy in which no group members are automatically activated.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | isAlivePeriodSec : INTEGER = 120
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the policy.
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy.
|  | quorumEnabled : BOOLEAN = false
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,type,wasType,deployable,container,customProperties,matchCriteria,servers,preferredServers
|  | Additional Properties Not To Expose
|  | policyFactory : STRING = com.ibm.ws.hamanager.coordinator.policy.impl.NOOPPolicyFactory
|  | The fully qualified name of the Java interface that serves as a factory for a specific type of concrete HAManagerPolicy.
|  | wasType : STRING = NoOpPolicy
|  | WebSphere admin resource type.

#### was.NoOpPolicySpec

Type Hierarchy | was.HAManagerPolicySpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Specifies a policy in which no group members are automatically activated.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the policy. (string)
|  | isAlivePeriodSec : STRING
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (integer) default(120)
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy. (map_string_string)
|  | quorumEnabled : STRING
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation. (boolean) default(false)

#### was.NodeAgent

Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, was.Node, udm.Container, overthere.HostContainer

A WebSphere node agent.

|  | Parent
--- | --- | ---
|  | cell : CI<was.DeploymentManager >
|  | Deployment manager that manages this node agent

|  | Children
--- | --- | ---
|  | servers : SET_OF_CI<was.ManagedServer >
|  | WebSphere servers in the node
|  | webServers : SET_OF_CI<was.ManagedWebServer >
|  | WebSphere web servers in the node

|  | Public Properties
--- | --- | ---
|  | host : CI<overthere.Host>
|  | Host on which the NodeAgent server runs. If not defined it will default to the host associated with deployment manager.
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.
|  | wasHome : STRING
|  | Path to the WebSphere profile or deployment manager profile, where bin/wsadmin can be found. For example, /opt/ws/6.1/appserver/profiles/AppSrv01

|  | Hidden Properties
--- | --- | ---
|  | synchronizeScript : STRING = was/base/synchronize-node.py
|  | Synchronize Script

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
startNodeAgent |  | delegate = nodeAgentStart | No description.
stopNodeAgent |  | delegate = nodeAgentStop | No description.

#### was.NodeConfigurationResource

Virtual Type
Type Hierarchy | was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all NodeAgent configuration CIs.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Node]
|  | List of container types on which the resource should be discovered.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ORBService

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies settings for the Object Request Broker service.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | ThreadPool_inactivityTimeout : INTEGER
|  | Specifies the number of milliseconds of inactivity that should elapse before a thread is reclaimed. Default WAS value is '3500'.
|  | ThreadPool_isGrowable : STRING
|  | Specifies whether the number of threads can increase beyond the maximum size configured for the thread pool. Default WAS value is 'true'. values(true, false)
|  | ThreadPool_maximumSize : INTEGER
|  | Specifies the maximum number of threads that are allowed in the pool. Default WAS value is '50'.
|  | ThreadPool_minimumSize : INTEGER
|  | Specifies the minimum number of threads that are allowed in the pool. Default WAS value is '10'.
|  | commTraceEnabled : STRING
|  | Specifies whether tracing of ORB GIOP messages occurs. This setting is ignored if ORB tracing is not enabled. values(true, false)
|  | connectionCacheMaximum : INTEGER
|  | Specifies the largest number of connections that can occupy the connection cache for a service. Default WAS value is '240'.
|  | connectionCacheMinimum : INTEGER
|  | Specifies the smallest number of connections that can occupy the connection cache for a service. Default WAS value is '100'.
|  | customProperties : MAP_STRING_STRING = {com.ibm.CORBA.ConnectionInterceptorName=com.ibm.ISecurityLocalObjectBaseL13Impl.SecurityConnectionInterceptors, com.ibm.CORBA.RasManager=com.ibm.websphere.ras.WsOrbRasManager, com.ibm.CORBA.enableLocateRequest=true, com.ibm.websphere.management.registerServerIORWithLSD=true, com.ibm.ws.orb.transport.WSSSLClientSocketFactoryName=com.ibm.ws.security.orbssl.WSSSLClientSocketFactoryImpl, com.ibm.ws.orb.transport.WSSSLServerSocketFactoryName=com.ibm.ws.security.orbssl.WSSSLServerSocketFactoryImpl, com.ibm.ws.orb.transport.useMultiHome=true}
|  | Specifies additional custom properties that you can configure for this Object Request Broker.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | forceTunnel : ENUM [whenrequired, always, never]
|  | Specifies how the client ORB attempts to use HTTP tunneling. Allowed values are: whenrequired, always, never. Default WAS value is 'never'.
|  | locateRequestTimeout : INTEGER
|  | Specifies the number of seconds the ORB waits before timing out on a LocateRequest message. Default WAS value is '180'.
|  | noLocalCopies : STRING
|  | Specifies whether the ORB is to pass parameters by reference instead of by value. If the parameters are passed by reference, a copy operation is bypassed. Enable this function with caution, because unexpected behavior might occur. Default WAS value is 'false'. values(true, false)
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | requestRetriesCount : INTEGER
|  | Specifies the number of times that the ORB attempts to send a request if a server fails. Retrying sometimes enables recovery from transient network failures. Default WAS value is '1'.
|  | requestRetriesDelay : INTEGER
|  | Specifies the number of milliseconds between request retries. Default WAS value is '0'.
|  | requestTimeout : INTEGER
|  | Specifies the number of seconds that the ORB waits before timing out on a request message. Default WAS value is '180'.
|  | tunnelAgentURL : STRING
|  | Specifies the URL of the servlet used to support HTTP tunneling. This field is only required if the Force tunnel field is set to ALWAYS or WHEN REQUIRED. Otherwise, the ORB ignores the value specified for this field.
|  | useServerThreadPool : STRING
|  | Specifies the settings for the thread pool that is associated with the ORB. service. If true specifies the settings for the server-defined thread pool named 'ORB.thread.pool' (defined as a standalone ThreadPool). Thread pool properties defined on this CI are not automatically applied to thread pool named 'ORB.thread.pool'. If false - specifies settings for a thread pool that is directly associated with the ORB service (and applies properties supplied by this CI). Default WAS value is 'false'.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = ORBService
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | enable : STRING = true
|  | Enable this resource.
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = ObjectRequestBroker
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ORBServiceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies settings for the Object Request Broker service.

|  | Public Properties
--- | --- | ---
|  | ThreadPool_inactivityTimeout : STRING
|  | Specifies the number of milliseconds of inactivity that should elapse before a thread is reclaimed. Default WAS value is '3500'. (integer)
|  | ThreadPool_isGrowable : STRING
|  | Specifies whether the number of threads can increase beyond the maximum size configured for the thread pool. Default WAS value is 'true'. values(true, false) (string)
|  | ThreadPool_maximumSize : STRING
|  | Specifies the maximum number of threads that are allowed in the pool. Default WAS value is '50'. (integer)
|  | ThreadPool_minimumSize : STRING
|  | Specifies the minimum number of threads that are allowed in the pool. Default WAS value is '10'. (integer)
|  | commTraceEnabled : STRING
|  | Specifies whether tracing of ORB GIOP messages occurs. This setting is ignored if ORB tracing is not enabled. values(true, false) (string)
|  | connectionCacheMaximum : STRING
|  | Specifies the largest number of connections that can occupy the connection cache for a service. Default WAS value is '240'. (integer)
|  | connectionCacheMinimum : STRING
|  | Specifies the smallest number of connections that can occupy the connection cache for a service. Default WAS value is '100'. (integer)
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Object Request Broker. (map_string_string)
|  | forceTunnel : STRING
|  | Specifies how the client ORB attempts to use HTTP tunneling. Allowed values are: whenrequired, always, never. Default WAS value is 'never'. (enum) values(whenrequired, always, never)
|  | locateRequestTimeout : STRING
|  | Specifies the number of seconds the ORB waits before timing out on a LocateRequest message. Default WAS value is '180'. (integer)
|  | noLocalCopies : STRING
|  | Specifies whether the ORB is to pass parameters by reference instead of by value. If the parameters are passed by reference, a copy operation is bypassed. Enable this function with caution, because unexpected behavior might occur. Default WAS value is 'false'. values(true, false) (string)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | requestRetriesCount : STRING
|  | Specifies the number of times that the ORB attempts to send a request if a server fails. Retrying sometimes enables recovery from transient network failures. Default WAS value is '1'. (integer)
|  | requestRetriesDelay : STRING
|  | Specifies the number of milliseconds between request retries. Default WAS value is '0'. (integer)
|  | requestTimeout : STRING
|  | Specifies the number of seconds that the ORB waits before timing out on a request message. Default WAS value is '180'. (integer)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | tunnelAgentURL : STRING
|  | Specifies the URL of the servlet used to support HTTP tunneling. This field is only required if the Force tunnel field is set to ALWAYS or WHEN REQUIRED. Otherwise, the ORB ignores the value specified for this field. (string)
|  | useServerThreadPool : STRING
|  | Specifies the settings for the thread pool that is associated with the ORB. service. If true specifies the settings for the server-defined thread pool named 'ORB.thread.pool' (defined as a standalone ThreadPool). Thread pool properties defined on this CI are not automatically applied to thread pool named 'ORB.thread.pool'. If false - specifies settings for a thread pool that is directly associated with the ORB service (and applies properties supplied by this CI). Default WAS value is 'false'. (string)

#### was.OneOfNPolicy

Type Hierarchy | was.HAManagerPolicy >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a policy that keeps one group member active at all times.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | isAlivePeriodSec : INTEGER = 120
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the policy.
|  | failback : BOOLEAN
|  | Specifies whether active group members are moved to the most preferred server at any given time.
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy.
|  | preferredOnly : BOOLEAN
|  | Specifies whether group members are activated only on servers from the list of preferred servers.
|  | preferredServers : SET_OF_CI<was.ManagedServer >
|  | Specifies an ordered list of preferred core group servers for a policy.
|  | quorumEnabled : BOOLEAN = false
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,type,wasType,deployable,container,customProperties,matchCriteria,servers,preferredServers
|  | Additional Properties Not To Expose
|  | policyFactory : STRING = com.ibm.ws.hamanager.coordinator.policy.impl.OneOfNPolicyFactory
|  | The fully qualified name of the Java interface that serves as a factory for a specific type of concrete HAManagerPolicy.
|  | wasType : STRING = OneOfNPolicy
|  | WebSphere admin resource type.

#### was.OneOfNPolicySpec

Type Hierarchy | was.HAManagerPolicySpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Specifies a policy that keeps one group member active at all times.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the policy. (string)
|  | failback : STRING
|  | Specifies whether active group members are moved to the most preferred server at any given time. (boolean)
|  | isAlivePeriodSec : STRING
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (integer) default(120)
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy. (map_string_string)
|  | preferredOnly : STRING
|  | Specifies whether group members are activated only on servers from the list of preferred servers. (boolean)
|  | preferredServers : SET_OF_STRING
|  | Specifies an ordered list of preferred core group servers for a policy.
|  | quorumEnabled : STRING
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation. (boolean) default(false)

#### was.OracleDatasource

Type Hierarchy | was.Datasource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Oracle data source object supplies your application with connections for accessing the database.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | URL : STRING
|  | Specifies the URL of the database from which the datasource obtains connections
|  | datasourceHelperClassname : STRING = com.ibm.websphere.rsadapter.OracleDataStoreHelper
|  | Specifies the data store helper class, an interface through which a datasource is triggered by a database to perform functions specific to that database vendor.
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source.
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source.
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies connection timeout value for a JDBC data source.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies Maximum number of connections for a JDBC data source.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies Minimum number of connections for a JDBC data source.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | containerManagedPersistence : BOOLEAN = true
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this data source.
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set.
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference.
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.
|  | testConnection : BOOLEAN = false
|  | If set, the connection to the database is tested.
|  | useJaasAliasForContainerManagedAuthentication : BOOLEAN
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource.
|  | useJaasAliasForXaRecovery : BOOLEAN
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers.
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,alias,containerManagedPersistence,description,jndiName,createJaasAlias,jdbcProvider,username,password,ConnectionPool,datasourceHelperClassname,customProperties,allowExistingJaasAlias,jaasAliasName,useJaasAliasForXaRecovery,useJaasAliasForContainerManagedAuthentication,mappingConfigAlias,testConnection,testConnectionScript,testConnectionOrder,updateJaasScript,updateJaasOrder
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/datasource/destroy-datasource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/datasource/discover-inspect-ora-datasources.py
|  | Python wsadmin script invoked to discover a JDBC data sources.
|  | libraryScripts : LIST_OF_STRING = [was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/datasource/create-or-modify-datasource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | testConnectionOrder : INTEGER = 102
|  | Test Connection Order
|  | testConnectionScript : STRING = was/datasource/test-datasource-connection.py
|  | Test Connection Script
|  | updateJaasOrder : INTEGER = 101
|  | Update Jaas Order
|  | updateJaasScript : STRING = was/jaas/update-jaas.py
|  | Update Jaas Script
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
testConnection |  | language = python, script = was/datasource/test-datasource-connection.py | No description.

#### was.OracleDatasourceSpec

Type Hierarchy | jee.DataSourceSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for an Oracle datasource.

|  | Public Properties
--- | --- | ---
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies connection timeout value for a JDBC data source. (integer) default(180)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies Maximum number of connections for a JDBC data source. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies Minimum number of connections for a JDBC data source. (integer) default(1)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | URL : STRING
|  | Specifies the URL of the database from which the datasource obtains connections (string)
|  | containerManagedPersistence : STRING
|  | Specifies that the datasource is used for container-managed persistence (CMP) of enterprise beans. (boolean) default(true)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | datasourceHelperClassname : STRING
|  | Specifies the data store helper class, an interface through which a datasource is triggered by a database to perform functions specific to that database vendor. (string) default(com.ibm.websphere.rsadapter.OracleDataStoreHelper)
|  | description : STRING
|  | Specifies the description of this data source. (string)
|  | jaasAliasName : STRING
|  | Specifies an existing JAAS/J2C authentication alias name. When specified username and password must not be set. (string)
|  | jdbcProvider : STRING
|  | Specifies the name of the JDBC Provider for this data source. (string)
|  | jndiName : STRING
|  | Specifies the JNDI name of the data source. (string)
|  | mappingConfigAlias : STRING
|  | Used only in the absence of a loginConfiguration on the component resource reference. (string)
|  | password : STRING
|  | Password to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | testConnection : STRING
|  | If set, the connection to the database is tested. (boolean) default(false)
|  | useJaasAliasForContainerManagedAuthentication : STRING
|  | Specifies the container-managed authentication to the JAAS/J2C authentication data entry for the datasource. (boolean)
|  | useJaasAliasForXaRecovery : STRING
|  | Specifies the Jaas auth data for XA recovery, Should only be set for datasources using XA JDBC providers. (boolean)
|  | username : STRING
|  | Username to create a new JAAS/J2C authentication data with XL Deploy-generated alias name. (string)

#### was.OracleJdbcProvider

Type Hierarchy | was.JdbcProvider >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING = ${ORACLE_JDBC_DRIVER_PATH}/ojdbc6.jar
|  | Specifies a list of paths or JAR file names which together form the location for the resource provider classes.
|  | implementationClassName : STRING = oracle.jdbc.pool.OracleConnectionPoolDataSource
|  | Specifies the Java class name of the JDBC driver's datasource implementation.
|  | providerType : STRING = Oracle JDBC Driver
|  | Specifies a provider type.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING = Oracle JDBC Driver
|  | Specifies description for the resource.
|  | isolatedClassLoader : BOOLEAN = false
|  | If selected, this resource provider will be loaded in its own class loader.
|  | nativepath : STRING
|  | Specifies an optional path to any native libraries.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/JdbcProvider/create-or-modify-jdbc-provider.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/JdbcProvider/destroy-jdbc-provider.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/JdbcProvider/discover-inspect-ora-jdbc-provider.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/JdbcProvider/jdbc-provider-lib.py, was/JdbcProvider/discover-inspect-jdbc-provider-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 58
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/JdbcProvider/create-or-modify-jdbc-provider.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource
|  | xa : BOOLEAN = false
|  | Select XA datasource, if your application requires two-phase commit transactions.

#### was.OracleJdbcProviderSpec

Type Hierarchy | was.JdbcProviderSpec >> was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | Specifies a list of paths or JAR file names which together form the location for the resource provider classes. (string) default(${ORACLE_JDBC_DRIVER_PATH}/ojdbc6.jar)
|  | description : STRING
|  | Specifies description for the resource. (string) default(Oracle JDBC Driver)
|  | implementationClassName : STRING
|  | Specifies the Java class name of the JDBC driver's datasource implementation. (string) default(oracle.jdbc.pool.OracleConnectionPoolDataSource)
|  | isolatedClassLoader : STRING
|  | If selected, this resource provider will be loaded in its own class loader. (boolean) default(false)
|  | nativepath : STRING
|  | Specifies an optional path to any native libraries. (string)
|  | providerType : STRING
|  | Specifies a provider type. (string) default(Oracle JDBC Driver)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | xa : STRING
|  | Select XA datasource, if your application requires two-phase commit transactions. (boolean)

#### was.OracleXaJdbcProvider

Type Hierarchy | was.JdbcProvider >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING = ${ORACLE_JDBC_DRIVER_PATH}/ojdbc6.jar
|  | Specifies a list of paths or JAR file names which together form the location for the resource provider classes.
|  | implementationClassName : STRING = oracle.jdbc.xa.client.OracleXADataSource
|  | Specifies the Java class name of the JDBC driver's datasource implementation.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING = Oracle JDBC Driver (XA)
|  | Specifies description for the resource.
|  | isolatedClassLoader : BOOLEAN = false
|  | If selected, this resource provider will be loaded in its own class loader.
|  | nativepath : STRING
|  | Specifies an optional path to any native libraries.
|  | providerType : STRING = Oracle JDBC Driver (XA)
|  | Specifies a provider type.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/JdbcProvider/create-or-modify-jdbc-provider.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/JdbcProvider/destroy-jdbc-provider.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/JdbcProvider/discover-inspect-ora-xa-jdbc-provider.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/JdbcProvider/jdbc-provider-lib.py, was/JdbcProvider/discover-inspect-jdbc-provider-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 58
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/JdbcProvider/create-or-modify-jdbc-provider.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource
|  | xa : BOOLEAN = true
|  | Select XA datasource, if your application requires two-phase commit transactions.

#### was.OracleXaJdbcProviderSpec

Type Hierarchy | was.JdbcProviderSpec >> was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of an Oracle XA JDBC Driver.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | Specifies a list of paths or JAR file names which together form the location for the resource provider classes. (string) default(${ORACLE_JDBC_DRIVER_PATH}/ojdbc6.jar)
|  | description : STRING
|  | Specifies description for the resource. (string) default(Oracle JDBC Driver (XA))
|  | implementationClassName : STRING
|  | Specifies the Java class name of the JDBC driver's datasource implementation. (string) default(oracle.jdbc.xa.client.OracleXADataSource)
|  | isolatedClassLoader : STRING
|  | If selected, this resource provider will be loaded in its own class loader. (boolean) default(false)
|  | nativepath : STRING
|  | Specifies an optional path to any native libraries. (string)
|  | providerType : STRING
|  | Specifies a provider type. (string) default(Oracle JDBC Driver (XA))
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | xa : STRING
|  | Select XA datasource, if your application requires two-phase commit transactions. (boolean)

#### was.PMIService

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the PMIService configuration for Server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | customModuleMetrics : MAP_STRING_STRING
|  | If 'Monitored statistic set' is 'custom', mapping of PMI module names to comma-separated list of metrics to be measured, e.g. key: 'threadPoolModule', value: '3,1,2,5,4'. Has no effect for other values of 'Monitored statistic set'.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enable : BOOLEAN = true
|  | Specifies whether or not the server attempts to start the specified service when the server starts.
|  | statisticSet : ENUM [none, basic, extended, custom, all] = none
|  | Valid values are 'none', 'basic', 'extended', 'all' and 'custom'
|  | synchronizedUpdate : BOOLEAN
|  | Select to use synchronization for more precise performance monitoring. Balance the need for precision against your performance requirements, because the use of sequential counter updates can decrease performance.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasContainerTypes,customModuleMetrics,wasType,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/pmi/modify-server-pmi.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/server/pmi/destroy-server-pmi.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/pmi/discover-inspect-server-pmi.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/pmi/modify-server-pmi.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = PMIService
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | NOT APPLICABLE
|  | overwriteExistingValues : BOOLEAN = false
|  | NOT APPLICABLE
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.PMIServiceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the PMIService configuration for Server.

|  | Public Properties
--- | --- | ---
|  | customModuleMetrics : MAP_STRING_STRING
|  | If 'Monitored statistic set' is 'custom', mapping of PMI module names to comma-separated list of metrics to be measured, e.g. key: 'threadPoolModule', value: '3,1,2,5,4'. Has no effect for other values of 'Monitored statistic set'. (map_string_string)
|  | enable : STRING
|  | Specifies whether or not the server attempts to start the specified service when the server starts. (boolean) default(true)
|  | statisticSet : STRING
|  | Valid values are 'none', 'basic', 'extended', 'all' and 'custom' (enum) values(none, basic, extended, custom, all) default(none)
|  | synchronizedUpdate : STRING
|  | Select to use synchronization for more precise performance monitoring. Balance the need for precision against your performance requirements, because the use of sequential counter updates can decrease performance. (boolean)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ProxyServerCluster

Type Hierarchy | was.Cluster >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | was.WasAppContainer, udm.Taggable, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

A WebSphere proxy server cluster managed by a WebSphere deployment manager (WAS ND)

|  | Parent
--- | --- | ---
|  | cell : CI<was.DeploymentManager >
|  | Deployment manager that manages this this cluster

|  | Public Properties
--- | --- | ---
|  | checkStartedInterval : INTEGER = 10
|  | Number of seconds to sleep inbetween the checking of cluster started.
|  | checkStoppedInterval : INTEGER = 10
|  | Number of seconds to sleep inbetween the checking of cluster stopped.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | Restart strategy used when deploying. Valid values are: NONE, STOP_START, RESTART. For example, if the STOP_START strategy is used, the container will be stopped before deployment and started after deployment. If the RESTART strategy is used, the deployment will be executed, then container will be restarted using the restart script. If there is no restart script defined, the deployment will be executed, then the container will be stopped and immediately started. Note that it may be preferable to use the containerRestartStrategy property defined on was.Module and its subtypes.
|  | enableRippleStart : BOOLEAN
|  | failOnPartialApplicationStart : BOOLEAN = true
|  | Specify if the deployment should fail when application fails to start on all servers in the cluster.
|  | serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER] = PROXY_SERVER
|  | Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER. Default value: APPLICATION_SERVER. Available since: WAS_70
|  | servers : SET_OF_CI<was.ManagedServer >
|  | Servers that are part of this cluster
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.

|  | Hidden Properties
--- | --- | ---
|  | restartOrder : INTEGER = 80
|  | Restart Order
|  | startOrder : INTEGER = 80
|  | Start Order
|  | startScript : STRING = was/container/start-cluster.py
|  | Start Script
|  | stopOrder : INTEGER = 20
|  | Stop Order
|  | stopScript : STRING = was/container/stop-cluster.py
|  | Stop Script

Control task | Parameter CI | Attributes | Description
--- | --- | --- | ---
create | was.Cluster_create | language = python, script = was/container/create-cluster.py, delegate = pythonControlTask | Creates application server cluster if it doesn't exist. It will use already associated servers as cluster members. Task will use weight property of the associated servers to assign cluster member weight.
start |  | language = python, script = was/container/start-cluster.py | Start cluster.
stop |  | language = python, script = was/container/stop-cluster.py | Stop cluster.

#### was.ResRef

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to.
|  | resourceRefName : STRING
|  | Specify the resource reference name.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | ejbName : STRING = .*
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules.
|  | resourceType : STRING = .*
|  | Specify the type of referenced resource.

#### was.Resource

Virtual Type
Type Hierarchy | was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed JEE resource configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ResourceEnvRef

Type Hierarchy | was.ResRef >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to.
|  | resourceRefName : STRING
|  | Specify the resource reference name.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | ejbName : STRING = .*
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules.
|  | resourceType : STRING = .*
|  | Specify the type of referenced resource.

#### was.ResourceEnvRefSpec

Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs.

|  | Public Properties
--- | --- | ---
|  | ejbName : STRING
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules. (string) default(.*)
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to. (string)
|  | resourceRefName : STRING
|  | Specify the resource reference name. (string)
|  | resourceType : STRING
|  | Specify the type of referenced resource. (string) default(.*)

#### was.ResourceEnvironmentEntry

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Within an application server name space, the data contained in a resource environment entry is converted into an object that represents a physical resource.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | Specifies the JNDI name for the resource, including any naming subcontexts.
|  | provider : STRING
|  | Specifies the resource environment provider
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = provider,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/environment/create-resource-env-entry.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/environment/destroy-resource-env-entry.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/environment/discover-inspect-resource-environment-entry.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/environment/resource-environment-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/resources/environment/modify-resource-envEntry.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ResourceEnvironmentEntrySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Within an application server name space, the data contained in a resource environment entry is converted into an object that represents a physical resource.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure. (map_string_string)
|  | jndiName : STRING
|  | Specifies the JNDI name for the resource, including any naming subcontexts. (string)
|  | provider : STRING
|  | Specifies the resource environment provider (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ResourceEnvironmentProvider

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a resource environment provider, which encapsulates the referenceables that convert resource environment entry data into resource objects.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the Resource adapter
|  | referenceables : SET_OF_STRING
|  | Enter referenceables as: 'FactoryClassname:Classname' - Use this page to configure a new referenceable, which specifies the factory class that converts data in the Java Naming and Directory Interface (JNDI) name space into an object that represents your resource to WebSphere Application Server.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = customProperties,referenceables
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/environment/create-resource-env-provider.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/environment/destroy-resource-env-provider.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/environment/discover-inspect-resource-env-provider.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/environment/resource-environment-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/resources/environment/modify-resource-env-provider.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ResourceEnvironmentProviderSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a resource environment provider, which encapsulates the referenceables that convert resource environment entry data into resource objects.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies custom properties that your enterprise information system (EIS) requires for the resource providers and resource factories that you configure. (map_string_string)
|  | description : STRING
|  | A description of the Resource adapter (string)
|  | referenceables : SET_OF_STRING
|  | Enter referenceables as: 'FactoryClassname:Classname' - Use this page to configure a new referenceable, which specifies the factory class that converts data in the Java Naming and Directory Interface (JNDI) name space into an object that represents your resource to WebSphere Application Server. (set_of_string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ResourceRef

Type Hierarchy | was.ResRef >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to.
|  | resourceRefName : STRING
|  | Specify the resource reference name.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | ejbName : STRING = .*
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules.
|  | loginConfigurationName : STRING =
|  | Specify this option to create a custom login configuration. The client can use JAAS to create a login design.
|  | properties : STRING =
|  | Specify this option to create a custom login configuration. The client can use JAAS to create a login design.
|  | resourceType : STRING = .*
|  | Specify the type of referenced resource.

#### was.ResourceRefSpec

Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs.

|  | Public Properties
--- | --- | ---
|  | ejbName : STRING
|  | Specify EJB bean name to be used for resource references to EJB modules. Property not required for Web modules. (string) default(.*)
|  | loginConfigurationName : STRING
|  | Specify this option to create a custom login configuration. The client can use JAAS to create a login design. (string) default()
|  | properties : STRING
|  | Specify this option to create a custom login configuration. The client can use JAAS to create a login design. (string) default()
|  | resourceJndiName : STRING
|  | Specify the JNDI name of the target resource to map to. (string)
|  | resourceRefName : STRING
|  | Specify the resource reference name. (string)
|  | resourceType : STRING
|  | Specify the type of referenced resource. (string) default(.*)

#### was.SSLConfig

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

The SSL protocol provides secure communications between remote server processes or endpoints.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | clientAuthentication : ENUM [NONE, SUPPORTED, REQUIRED] = NONE
|  | Specifies the whether SSL client authentication should be requested if the SSL connection is used for the server side of the connection.
|  | clientKeyAlias : STRING
|  | Specifies the certificate alias to be used if this configuration is to be used as a client.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enabledCiphers : SET_OF_STRING
|  | Specifies the ciphers that are used during the Secure Sockets Layer (SSL) handshake.
|  | jsseProvider : STRING = IBMJSSE2
|  | Specifies a package that implements a subset of the cryptography aspects for the Java security application programming interface (API).
|  | keyStore : STRING = NodeDefaultKeyStore
|  | Specifies a reference to a specific key store.
|  | managementScope : STRING
|  | Specifies the scope where this SSL configuration is visible.
|  | securityLevel : ENUM [MEDIUM, HIGH, CUSTOM, LOW] = HIGH
|  | Specifies the various cipher suite groups that can be chosen depending upon your security needs.
|  | serverKeyAlias : STRING
|  | Specifies the certificate alias used as the identity for this SSL configuration if one has not been specified elsewhere.
|  | sslProtocol : STRING = SSL_TLS
|  | Specifies the Secure Sockets Layer (SSL) handshake protocol.
|  | trustStore : STRING = NodeDefaultKeyStore
|  | Specifies a reference to a specific trust store used by Java™ Secure Sockets Extension (JSSE).

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = managementScope,enabledCiphers,clientAuthentication,trustStore,keyStore
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 61
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/security/create-ssl-config.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 39
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/security/destroy-ssl-config.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/security/discover-inspect-ssl-config.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/security/security-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/security/modify-ssl-config.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SSLConfigSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

The SSL protocol provides secure communications between remote server processes or endpoints.

|  | Public Properties
--- | --- | ---
|  | clientAuthentication : STRING
|  | Specifies the whether SSL client authentication should be requested if the SSL connection is used for the server side of the connection. (enum) values(NONE, SUPPORTED, REQUIRED) default(NONE)
|  | clientKeyAlias : STRING
|  | Specifies the certificate alias to be used if this configuration is to be used as a client. (string)
|  | enabledCiphers : SET_OF_STRING
|  | Specifies the ciphers that are used during the Secure Sockets Layer (SSL) handshake. (set_of_string)
|  | jsseProvider : STRING
|  | Specifies a package that implements a subset of the cryptography aspects for the Java security application programming interface (API). (string) default(IBMJSSE2)
|  | keyStore : STRING
|  | Specifies a reference to a specific key store. (string) default(NodeDefaultKeyStore)
|  | managementScope : STRING
|  | Specifies the scope where this SSL configuration is visible. (string)
|  | securityLevel : STRING
|  | Specifies the various cipher suite groups that can be chosen depending upon your security needs. (enum) values(MEDIUM, HIGH, CUSTOM, LOW) default(HIGH)
|  | serverKeyAlias : STRING
|  | Specifies the certificate alias used as the identity for this SSL configuration if one has not been specified elsewhere. (string)
|  | sslProtocol : STRING
|  | Specifies the Secure Sockets Layer (SSL) handshake protocol. (string) default(SSL_TLS)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | trustStore : STRING
|  | Specifies a reference to a specific trust store used by Java™ Secure Sockets Extension (JSSE). (string) default(NodeDefaultKeyStore)

#### was.Scheduler

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Schedulers are persistent and transactional timer services that can run business logic.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | datasourceJNDIName : STRING
|  | Specifies the name of the data source where persistent tasks are stored.
|  | jndiName : STRING
|  | The JNDI name for the resource.
|  | pollInterval : INTEGER = 30
|  | Specifies the interval, in seconds, that a scheduler polls the database. The default value is appropriate for most applications.
|  | tablePrefix : STRING
|  | Specifies the string prefix to affix to the scheduler tables. Multiple independent schedulers can share the same database if each scheduler specifies a different prefix string.
|  | workManagerInfoJNDIName : STRING
|  | Specifies the Java(TM) Naming and Directory Interface (JNDI) name of the work manager, which is used to manage the number of tasks that can run concurrently with the scheduler. The work manager can also limit the amount of Java(TM) Platform, Enterprise Edition (Java EE) context that is applied to the task.
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this resource.
|  | datasourceAlias : STRING
|  | Specifies the alias for the user name and password that are used to access the data source.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | useAdminRoles : BOOLEAN
|  | Specifies that when this option and global security are both enabled, the user administration roles are enforced when the scheduler Java(TM) Management Extensions (JMX) commands or APIs are used to create and modify tasks. If this option is not enabled, all users can create and modify tasks.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | provider : STRING = SchedulerProvider
|  | Specifies the Scheduler Provider name.
|  | providerType : STRING = SchedulerProvider
|  | WebSphere admin resource provider type.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = SchedulerConfiguration
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SchedulerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Schedulers are persistent and transactional timer services that can run business logic.

|  | Public Properties
--- | --- | ---
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this resource. (map_string_string)
|  | datasourceAlias : STRING
|  | Specifies the alias for the user name and password that are used to access the data source. (string)
|  | datasourceJNDIName : STRING
|  | Specifies the name of the data source where persistent tasks are stored. (string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | jndiName : STRING
|  | The JNDI name for the resource. (string)
|  | pollInterval : STRING
|  | Specifies the interval, in seconds, that a scheduler polls the database. The default value is appropriate for most applications. (integer) default(30)
|  | tablePrefix : STRING
|  | Specifies the string prefix to affix to the scheduler tables. Multiple independent schedulers can share the same database if each scheduler specifies a different prefix string. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useAdminRoles : STRING
|  | Specifies that when this option and global security are both enabled, the user administration roles are enforced when the scheduler Java(TM) Management Extensions (JMX) commands or APIs are used to create and modify tasks. If this option is not enabled, all users can create and modify tasks. (boolean)
|  | workManagerInfoJNDIName : STRING
|  | Specifies the Java(TM) Naming and Directory Interface (JNDI) name of the work manager, which is used to manage the number of tasks that can run concurrently with the scheduler. The work manager can also limit the amount of Java(TM) Platform, Enterprise Edition (Java EE) context that is applied to the task. (string)

#### was.ServerConfigurationResource

Virtual Type
Type Hierarchy | was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all Server configuration CIs.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ServerPort

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the TCP/IP ports this server uses for connections. Name the CI after the endpoint name you want to modify.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enableRemoval : BOOLEAN = false
|  | Allows removal of server port. This is error prone operation and by default it's not enabled.
|  | host : STRING
|  | Specifies the IP address, the full domain name system (DNS) host name with a domain name suffix, or the short DNS host name that a web client uses to request a web application resource. Web application resources include servlets, JSP, or HTML pages. Host names on the ports can be resolvable names or IP addresses. The server will bind the port to the specific host name or IP address given. That port is accessible through the IP address that resolves from the given host name or IP address. The IP address can be in IPv4 format on all platforms, or in IPv6 format on operating systems on which the server supports IPv6.
|  | port : STRING
|  | Specifies the port configured for the application server to accept web client requests. You must specify a port value in conjunction with the host name. Valid port values are between 0 and 65535. A port value of 0 causes the system to pick an ephemeral port. Port numbers on the application server can be reused only when the host names resolve to unique IP addresses (such as for multiple network address cards) and there is not a port with the same port number and a wildcard '*' host name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasContainerTypes,enableRemoval,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/create-modify-server-port.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/server/destroy-server-port.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-server-port.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/create-modify-server-port.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | NOT APPLICABLE
|  | overwriteExistingValues : BOOLEAN = false
|  | NOT APPLICABLE
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ServerPortSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the TCP/IP ports this server uses for connections.

|  | Public Properties
--- | --- | ---
|  | enableRemoval : STRING
|  | Allows removal of server port. This is error prone operation and by default it's not enabled. (boolean) default(false)
|  | host : STRING
|  | Specifies the IP address, the full domain name system (DNS) host name with a domain name suffix, or the short DNS host name that a web client uses to request a web application resource. Web application resources include servlets, JSP, or HTML pages. Host names on the ports can be resolvable names or IP addresses. The server will bind the port to the specific host name or IP address given. That port is accessible through the IP address that resolves from the given host name or IP address. The IP address can be in IPv4 format on all platforms, or in IPv6 format on operating systems on which the server supports IPv6. (string)
|  | port : STRING
|  | Specifies the port configured for the application server to accept web client requests. You must specify a port value in conjunction with the host name. Valid port values are between 0 and 65535. A port value of 0 causes the system to pick an ephemeral port. Port numbers on the application server can be reused only when the host names resolve to unique IP addresses (such as for multiple network address cards) and there is not a port with the same port number and a wildcard '*' host name. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ServerSessionManager

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | Cookie_domain : STRING
|  | Specifies the value of the domain field of a session tracking cookie. This value dictates to the browser whether to send a cookie to particular servers. For example, if you specify a particular domain, session cookies are only sent to hosts in that domain. The default domain is the server.
|  | Cookie_httpOnly : STRING
|  | Specifies that session cookies include the HTTPOnly field. When checked, browsers that support the HTTPOnly attribute do not allow cookies to be accessed by client-side scripts. For security cookies, see the global security settings for Web SSO. Available since WAS8. Default WAS value is 'true'. values(true, false)
|  | Cookie_maximumAge : INTEGER
|  | Specifies the time to live for a cookie as a user defined value. Specify a value in seconds. When the default value (-1) is used, time to live for a cookie will be determined by the browser session.
|  | Cookie_name : STRING
|  | Specifies a name for the cookie that is used for session management. This name must be unique. The servlet specification requires this name to be JSESSIONID. However, for flexibility, this value is configurable. Default WAS value is 'JSESSIONID'.
|  | Cookie_path : STRING
|  | Specify any string representing a path on the server. A slash (/) indicates root directory. Specify a value to restrict the paths to which the cookie is sent. By restricting paths, you can keep the cookie from being sent to certain URLs on the server. If you specify the root directory, the cookie is sent no matter which path on the given server is accessed. Default WAS value is '/'.
|  | Cookie_secure : STRING
|  | Specifies whether session cookies include the secure field. Enabling this feature restricts the exchange of cookies to HTTPS sessions. Default WAS value is 'false'. values(true, false)
|  | Cookie_useContextRootAsPath : STRING
|  | Sets the cookie path to equal the context root for each application. This setting restricts the cookie from being sent to other applications and results in having different cookies created when accessing multiple applications. Available since WAS8. Default WAS value is 'false'. values(true, false)
|  | DRSSettings_dataReplicationMode : ENUM [BOTH, CLIENT, SERVER]
|  | Specifies the mode used for replication. Select client if sessions need to be replicated. Select server if sessions need to be stored. Select both client and server if sessions need to be replicated and stored. Default WAS value is 'BOTH'.
|  | DRSSettings_messageBrokerDomainName : STRING
|  | Specifies the name of the replication domain in which data is replicated.
|  | SessionDatabasePersistence_datasourceJNDIName : STRING
|  | Specifies the JNDI name of the data source from which the session manager obtains the database connections.
|  | SessionDatabasePersistence_db2RowSize : STRING
|  | Specifies the table space page size configured for the sessions table, if using a DB2(R) database. Values: ROW_SIZE_4KB(default), ROW_SIZE_32KB, ROW_SIZE_16KB, ROW_SIZE_8KB.
|  | SessionDatabasePersistence_password : STRING
|  | Specifies the password required for database access.
|  | SessionDatabasePersistence_tableSpaceName : STRING
|  | Specifies the table space name used for the sessions table.
|  | SessionDatabasePersistence_userId : STRING
|  | Specifies the user ID for database access.
|  | TuningParams_InvalidationSchedule_firstHour : INTEGER
|  | First time of day.
|  | TuningParams_InvalidationSchedule_secondHour : INTEGER
|  | Second time of day.
|  | TuningParams_allowOverflow : STRING
|  | Specifies whether to allow the number of sessions in memory to exceed the value specified for maximum in-memory session count. This feature is valid only in nonpersistent sessions mode. Default WAS value is 'true'. values(true, false)
|  | TuningParams_invalidationTimeout : INTEGER
|  | Specify session timeout in minutes. Default WAS value is '30'.
|  | TuningParams_maxInMemorySessionCount : INTEGER
|  | Specifies the maximum number of sessions to maintain in memory. Default WAS value is '1000'.
|  | TuningParams_scheduleInvalidation : STRING
|  | Specifies when to clean the invalid sessions from external location. Default WAS value is 'false'. values(true, false)
|  | TuningParams_usingMultiRowSchema : STRING
|  | Specifies whether to place each instance of application data in a separate row in the database. Default WAS value is 'false'. values(true, false)
|  | TuningParams_writeContents : ENUM [ALL_SESSION_ATTRIBUTES, ONLY_UPDATED_ATTRIBUTES]
|  | Specifies whether or not only updated attributes should be written to the persistent store or all of the session attributes should be written to the persistent store, whether or not they have changed. If you specify only updated attributes, only the updated attributes are written to the persistent store If you specify all session attributes, all attributes are written to the persistent store. Default WAS value is 'ONLY_UPDATED_ATTRIBUTES'.
|  | TuningParams_writeFrequency : ENUM [TIME_BASED_WRITE, END_OF_SERVLET_SERVICE, MANUAL_UPDATE]
|  | Specifies when the session is written to the persistent store. Default WAS value is 'END_OF_SERVLET_SERVICE'.
|  | TuningParams_writeInterval : INTEGER
|  | Specify a time period in seconds in which a session should be writen to the persistent store. Default WAS value is '120'.
|  | accessSessionOnTimeout : STRING
|  | Allow access on timeout. Default WAS value is 'true'. values(true, false)
|  | allowSerializedSessionAccess : STRING
|  | Allow serial access. Default WAS value is 'false'. values(true, false)
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enable : STRING
|  | Specifies whether or not the server attempts to start the specified service when the server starts. Default WAS value is 'true'. values(true, false)
|  | enableCookies : STRING
|  | Enable cookies. Default WAS value is 'true'. values(true, false)
|  | enableProtocolSwitchRewriting : STRING
|  | Enable protocol switch rewriting. Default WAS value is 'false'. values(true, false)
|  | enableSSLTracking : STRING
|  | Enable SSL ID tracking. Default WAS value is 'false'. values(true, false)
|  | enableSecurityIntegration : STRING
|  | Specifies whether security integration is enabled. When security integration is enabled, the session manager associates the identity of users with their HTTP sessions. Default WAS value is 'false'. values(true, false)
|  | enableUrlRewriting : STRING
|  | Enable URL rewriting. Default WAS value is 'false'. values(true, false)
|  | maxWaitTime : INTEGER
|  | Maximum wait time. Default WAS value is '0'.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | sessionPersistenceMode : ENUM [NONE, DATABASE]
|  | Use this page to specify how session data is saved in a distributed environment. The SIP container uses only memory-to-memory replication for distributed sessions. Default WAS value is 'NONE'.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = SessionManager
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = SessionManager
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ServerSessionManagerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support.

|  | Public Properties
--- | --- | ---
|  | Cookie_domain : STRING
|  | Specifies the value of the domain field of a session tracking cookie. This value dictates to the browser whether to send a cookie to particular servers. For example, if you specify a particular domain, session cookies are only sent to hosts in that domain. The default domain is the server. (string)
|  | Cookie_httpOnly : STRING
|  | Specifies that session cookies include the HTTPOnly field. When checked, browsers that support the HTTPOnly attribute do not allow cookies to be accessed by client-side scripts. For security cookies, see the global security settings for Web SSO. Available since WAS8. Default WAS value is 'true'. values(true, false) (string)
|  | Cookie_maximumAge : STRING
|  | Specifies the time to live for a cookie as a user defined value. Specify a value in seconds. When the default value (-1) is used, time to live for a cookie will be determined by the browser session. (integer)
|  | Cookie_name : STRING
|  | Specifies a name for the cookie that is used for session management. This name must be unique. The servlet specification requires this name to be JSESSIONID. However, for flexibility, this value is configurable. Default WAS value is 'JSESSIONID'. (string)
|  | Cookie_path : STRING
|  | Specify any string representing a path on the server. A slash (/) indicates root directory. Specify a value to restrict the paths to which the cookie is sent. By restricting paths, you can keep the cookie from being sent to certain URLs on the server. If you specify the root directory, the cookie is sent no matter which path on the given server is accessed. Default WAS value is '/'. (string)
|  | Cookie_secure : STRING
|  | Specifies whether session cookies include the secure field. Enabling this feature restricts the exchange of cookies to HTTPS sessions. Default WAS value is 'false'. values(true, false) (string)
|  | Cookie_useContextRootAsPath : STRING
|  | Sets the cookie path to equal the context root for each application. This setting restricts the cookie from being sent to other applications and results in having different cookies created when accessing multiple applications. Available since WAS8. Default WAS value is 'false'. values(true, false) (string)
|  | DRSSettings_dataReplicationMode : STRING
|  | Specifies the mode used for replication. Select client if sessions need to be replicated. Select server if sessions need to be stored. Select both client and server if sessions need to be replicated and stored. Default WAS value is 'BOTH'. (enum) values(BOTH, CLIENT, SERVER)
|  | DRSSettings_messageBrokerDomainName : STRING
|  | Specifies the name of the replication domain in which data is replicated. (string)
|  | SessionDatabasePersistence_datasourceJNDIName : STRING
|  | Specifies the JNDI name of the data source from which the session manager obtains the database connections. (string)
|  | SessionDatabasePersistence_db2RowSize : STRING
|  | Specifies the table space page size configured for the sessions table, if using a DB2(R) database. Values: ROW_SIZE_4KB(default), ROW_SIZE_32KB, ROW_SIZE_16KB, ROW_SIZE_8KB. (string)
|  | SessionDatabasePersistence_password : STRING
|  | Specifies the password required for database access. (string)
|  | SessionDatabasePersistence_tableSpaceName : STRING
|  | Specifies the table space name used for the sessions table. (string)
|  | SessionDatabasePersistence_userId : STRING
|  | Specifies the user ID for database access. (string)
|  | TuningParams_InvalidationSchedule_firstHour : STRING
|  | First time of day. (integer)
|  | TuningParams_InvalidationSchedule_secondHour : STRING
|  | Second time of day. (integer)
|  | TuningParams_allowOverflow : STRING
|  | Specifies whether to allow the number of sessions in memory to exceed the value specified for maximum in-memory session count. This feature is valid only in nonpersistent sessions mode. Default WAS value is 'true'. values(true, false) (string)
|  | TuningParams_invalidationTimeout : STRING
|  | Specify session timeout in minutes. Default WAS value is '30'. (integer)
|  | TuningParams_maxInMemorySessionCount : STRING
|  | Specifies the maximum number of sessions to maintain in memory. Default WAS value is '1000'. (integer)
|  | TuningParams_scheduleInvalidation : STRING
|  | Specifies when to clean the invalid sessions from external location. Default WAS value is 'false'. values(true, false) (string)
|  | TuningParams_usingMultiRowSchema : STRING
|  | Specifies whether to place each instance of application data in a separate row in the database. Default WAS value is 'false'. values(true, false) (string)
|  | TuningParams_writeContents : STRING
|  | Specifies whether or not only updated attributes should be written to the persistent store or all of the session attributes should be written to the persistent store, whether or not they have changed. If you specify only updated attributes, only the updated attributes are written to the persistent store If you specify all session attributes, all attributes are written to the persistent store. Default WAS value is 'ONLY_UPDATED_ATTRIBUTES'. (enum) values(ALL_SESSION_ATTRIBUTES, ONLY_UPDATED_ATTRIBUTES)
|  | TuningParams_writeFrequency : STRING
|  | Specifies when the session is written to the persistent store. Default WAS value is 'END_OF_SERVLET_SERVICE'. (enum) values(TIME_BASED_WRITE, END_OF_SERVLET_SERVICE, MANUAL_UPDATE)
|  | TuningParams_writeInterval : STRING
|  | Specify a time period in seconds in which a session should be writen to the persistent store. Default WAS value is '120'. (integer)
|  | accessSessionOnTimeout : STRING
|  | Allow access on timeout. Default WAS value is 'true'. values(true, false) (string)
|  | allowSerializedSessionAccess : STRING
|  | Allow serial access. Default WAS value is 'false'. values(true, false) (string)
|  | enable : STRING
|  | Specifies whether or not the server attempts to start the specified service when the server starts. Default WAS value is 'true'. values(true, false) (string)
|  | enableCookies : STRING
|  | Enable cookies. Default WAS value is 'true'. values(true, false) (string)
|  | enableProtocolSwitchRewriting : STRING
|  | Enable protocol switch rewriting. Default WAS value is 'false'. values(true, false) (string)
|  | enableSSLTracking : STRING
|  | Enable SSL ID tracking. Default WAS value is 'false'. values(true, false) (string)
|  | enableSecurityIntegration : STRING
|  | Specifies whether security integration is enabled. When security integration is enabled, the session manager associates the identity of users with their HTTP sessions. Default WAS value is 'false'. values(true, false) (string)
|  | enableUrlRewriting : STRING
|  | Enable URL rewriting. Default WAS value is 'false'. values(true, false) (string)
|  | maxWaitTime : STRING
|  | Maximum wait time. Default WAS value is '0'. (integer)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | sessionPersistenceMode : STRING
|  | Use this page to specify how session data is saved in a distributed environment. The SIP container uses only memory-to-memory replication for distributed sessions. Default WAS value is 'NONE'. (enum) values(NONE, DATABASE)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ServicePolicy

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | goalType : ENUM [DISCRETIONARY, AVERAGE_RESPONSE_TIME, PERCENTILE_RESPONSE_TIME] = DISCRETIONARY
|  | Goal Type
|  | GoalAttributes_goalDeltaPercent : INTEGER = 0
|  | Only applicable for Percentile Response Time goals
|  | GoalAttributes_goalDeltaValue : INTEGER = 0
|  | Only applicable for Average Response Time goals
|  | GoalAttributes_goalDeltaValueUnits : ENUM [MILLISECONDS, SECONDS, MINUTES] = MILLISECONDS
|  | Only applicable for Average Response Time goals
|  | GoalAttributes_goalPercent : INTEGER = 90
|  | Only applicable for Percentile Response Time goals
|  | GoalAttributes_goalValue : INTEGER = 1
|  | Only applicable for Percentile or Average Response Time goals
|  | GoalAttributes_goalValueUnits : ENUM [MILLISECONDS, SECONDS] = MILLISECONDS
|  | Only applicable for Percentile or Average Response Time goals
|  | GoalAttributes_importance : ENUM [HIGHEST, VERY_HIGH, HIGH, MEDIUM, LOW, VERY_LOW, LOWEST] = MEDIUM
|  | In WAS 6.1, only applicable for Percentile or Average Response Time goals
|  | GoalAttributes_timePeriodValue : INTEGER = 0
|  | Only applicable for Percentile or Average Response Time goals
|  | GoalAttributes_timePeriodValueUnits : ENUM [MILLISECONDS, SECONDS, MINUTES] = MILLISECONDS
|  | Only applicable for Percentile or Average Response Time goals
|  | GoalAttributes_violationEnabled : BOOLEAN
|  | Only applicable for Percentile or Average Response Time goals
|  | additionalTransactionClasses : SET_OF_STRING
|  | Transaction classes to be added to the Service Policy in addition to the default class
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Description

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = GoalAttributes,goalType,additionalTransactionClasses
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/policies/service/create-service-policy.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/policies/service/destroy-service-policy.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/policies/service/discover-inspect-service-policy.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/policies/service/service-policy-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/policies/service/modify-service-policy.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ServicePolicySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable (deployable)

|  | Public Properties
--- | --- | ---
|  | GoalAttributes_goalDeltaPercent : STRING
|  | Only applicable for Percentile Response Time goals (integer) default(0)
|  | GoalAttributes_goalDeltaValue : STRING
|  | Only applicable for Average Response Time goals (integer) default(0)
|  | GoalAttributes_goalDeltaValueUnits : STRING
|  | Only applicable for Average Response Time goals (enum) values(MILLISECONDS, SECONDS, MINUTES) default(MILLISECONDS)
|  | GoalAttributes_goalPercent : STRING
|  | Only applicable for Percentile Response Time goals (integer) default(90)
|  | GoalAttributes_goalValue : STRING
|  | Only applicable for Percentile or Average Response Time goals (integer) default(1)
|  | GoalAttributes_goalValueUnits : STRING
|  | Only applicable for Percentile or Average Response Time goals (enum) values(MILLISECONDS, SECONDS) default(MILLISECONDS)
|  | GoalAttributes_importance : STRING
|  | In WAS 6.1, only applicable for Percentile or Average Response Time goals (enum) values(HIGHEST, VERY_HIGH, HIGH, MEDIUM, LOW, VERY_LOW, LOWEST) default(MEDIUM)
|  | GoalAttributes_timePeriodValue : STRING
|  | Only applicable for Percentile or Average Response Time goals (integer) default(0)
|  | GoalAttributes_timePeriodValueUnits : STRING
|  | Only applicable for Percentile or Average Response Time goals (enum) values(MILLISECONDS, SECONDS, MINUTES) default(MILLISECONDS)
|  | GoalAttributes_violationEnabled : STRING
|  | Only applicable for Percentile or Average Response Time goals (boolean)
|  | additionalTransactionClasses : SET_OF_STRING
|  | Transaction classes to be added to the Service Policy in addition to the default class (set_of_string)
|  | description : STRING
|  | Description (string)
|  | goalType : STRING
|  | Goal Type (enum) values(DISCRETIONARY, AVERAGE_RESPONSE_TIME, PERCENTILE_RESPONSE_TIME) default(DISCRETIONARY)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.ServletCacheInstance

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A servlet cache instance is a location, in addition to the default shared dynamic cache, where dynamic cache can store, distribute, and share data.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | cacheSize : INTEGER = 2000
|  | Specifies a positive integer for the maximum number of entries the cache holds.
|  | defaultPriority : INTEGER = 1
|  | Specifies the default priority for servlets that can be cached.
|  | jndiName : STRING
|  | Specifies the Java Naming and Directory Interface (JNDI) name for the resource.
|  | DiskCache_algorithm : ENUM [NONE, RANDOM, SIZE] = NONE
|  | Specifies the eviction algorithm that the disk cache will use to evict entries once the high threshold is reached.
|  | DiskCache_highThreshold : INTEGER = 95
|  | Specifies when the eviction policy starts.
|  | DiskCache_lowThreshold : INTEGER = 90
|  | Specifies when the eviction policy ends.
|  | MemoryCache_highThreshold : INTEGER = 95
|  | Specifies when the memory cache eviction policy starts.
|  | MemoryCache_lowThreshold : INTEGER = 80
|  | Specifies when the memory cache eviction policy ends.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies a description for the resource.
|  | diskCacheCleanupFrequency : INTEGER = 0
|  | Specifies a value for the disk cache cleanup frequency,in minutes. If this value is set to 0, the cleanup runs only at midnight.
|  | diskCacheEntrySizeInMB : INTEGER = 0
|  | Specifies a value for the maximum size of an individual cache entry in MB.
|  | diskCachePerformanceLevel : ENUM [HIGH, BALANCED, LOW, CUSTOM] = BALANCED
|  | Specifies the level of performance that is required by the disk cache.
|  | diskCacheSizeInEntries : INTEGER = 0
|  | Specifies a value for the maximum disk cache size in number of entries.
|  | diskCacheSizeInGB : INTEGER = 0
|  | Specifies a value for the maximum disk cache size in GB.
|  | diskOffloadLocation : STRING
|  | Specifies a directory to use for disk offload.
|  | enableDiskOffload : BOOLEAN = false
|  | Specifies that when the cache becomes full, the cache entries are saved to disk.
|  | flushToDiskOnStop : BOOLEAN = false
|  | Specifies if in-memory cached objects are saved to disk when the server is stopped.
|  | maxBufferedCacheIdsPerMetaEntry : INTEGER = 1000
|  | Specifies a value for the maximum number of cache identifiers that are stored for an individual dependency ID or template in the disk cache metadata in memory.
|  | maxBufferedDependencyIds : INTEGER = 10000
|  | Specifies a value for the maximum number of dependency identifier buckets in the disk cache metadata in memory.
|  | maxBufferedTemplates : INTEGER = 100
|  | Specifies a value for the maximum number of template buckets that are in the disk cache metadata in memory.
|  | memoryCacheSizeInMB : INTEGER = 0
|  | Specifies a value for the maximum memory cache size in MB.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = customProperties, diskCacheCleanupFrequency, maxBufferedTemplates, maxBufferedDependencyIds, maxBufferedCacheIdsPerMetaEntry, diskCachePerformanceLevel, diskCacheEntrySizeInMB, diskCacheSizeInEntries, diskCacheSizeInGB, flushToDiskOnStop, diskOffloadLocation, DiskCache, MemoryCache, memoryCacheSizeInMB
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/cache/create-servlet-cache-instance.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/resources/cache/destroy-servlet-cache-instance.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/cache/discover-inspect-servlet-cache-instance.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/cache/servlet-cache-instance-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/resources/cache/modify-servlet-cache-instance.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ServletCacheInstanceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

A servlet cache instance is a location, in addition to the default shared dynamic cache, where dynamic cache can store, distribute, and share data.

|  | Public Properties
--- | --- | ---
|  | DiskCache_algorithm : STRING
|  | Specifies the eviction algorithm that the disk cache will use to evict entries once the high threshold is reached. (enum) values(NONE, RANDOM, SIZE) default(NONE)
|  | DiskCache_highThreshold : STRING
|  | Specifies when the eviction policy starts. (integer) default(95)
|  | DiskCache_lowThreshold : STRING
|  | Specifies when the eviction policy ends. (integer) default(90)
|  | MemoryCache_highThreshold : STRING
|  | Specifies when the memory cache eviction policy starts. (integer) default(95)
|  | MemoryCache_lowThreshold : STRING
|  | Specifies when the memory cache eviction policy ends. (integer) default(80)
|  | cacheSize : STRING
|  | Specifies a positive integer for the maximum number of entries the cache holds. (integer) default(2000)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | defaultPriority : STRING
|  | Specifies the default priority for servlets that can be cached. (integer) default(1)
|  | description : STRING
|  | Specifies a description for the resource. (string)
|  | diskCacheCleanupFrequency : STRING
|  | Specifies a value for the disk cache cleanup frequency,in minutes. If this value is set to 0, the cleanup runs only at midnight. (integer) default(0)
|  | diskCacheEntrySizeInMB : STRING
|  | Specifies a value for the maximum size of an individual cache entry in MB. (integer) default(0)
|  | diskCachePerformanceLevel : STRING
|  | Specifies the level of performance that is required by the disk cache. (enum) values(HIGH, BALANCED, LOW, CUSTOM) default(BALANCED)
|  | diskCacheSizeInEntries : STRING
|  | Specifies a value for the maximum disk cache size in number of entries. (integer) default(0)
|  | diskCacheSizeInGB : STRING
|  | Specifies a value for the maximum disk cache size in GB. (integer) default(0)
|  | diskOffloadLocation : STRING
|  | Specifies a directory to use for disk offload. (string)
|  | enableDiskOffload : STRING
|  | Specifies that when the cache becomes full, the cache entries are saved to disk. (boolean) default(false)
|  | flushToDiskOnStop : STRING
|  | Specifies if in-memory cached objects are saved to disk when the server is stopped. (boolean) default(false)
|  | jndiName : STRING
|  | Specifies the Java Naming and Directory Interface (JNDI) name for the resource. (string)
|  | maxBufferedCacheIdsPerMetaEntry : STRING
|  | Specifies a value for the maximum number of cache identifiers that are stored for an individual dependency ID or template in the disk cache metadata in memory. (integer) default(1000)
|  | maxBufferedDependencyIds : STRING
|  | Specifies a value for the maximum number of dependency identifier buckets in the disk cache metadata in memory. (integer) default(10000)
|  | maxBufferedTemplates : STRING
|  | Specifies a value for the maximum number of template buckets that are in the disk cache metadata in memory. (integer) default(100)
|  | memoryCacheSizeInMB : STRING
|  | Specifies a value for the maximum memory cache size in MB. (integer) default(0)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.SessionManager

Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | Cookie_domain : STRING
|  | Specifies the value of the domain field of a session tracking cookie. This value dictates to the browser whether to send a cookie to particular servers. For example, if you specify a particular domain, session cookies are only sent to hosts in that domain. The default domain is the server.
|  | Cookie_httpOnly : BOOLEAN = true
|  | Specifies that session cookies include the HTTPOnly field. When checked, browsers that support the HTTPOnly attribute do not allow cookies to be accessed by client-side scripts. For security cookies, see the global security settings for Web SSO.
|  | Cookie_maximumAge : INTEGER = -1
|  | Specifies the time to live for a cookie as a user defined value. Specify a value in seconds. When the default value (-1) is used, time to live for a cookie will be determined by the browser session.
|  | Cookie_name : STRING = JSESSIONID
|  | Specifies a name for the cookie that is used for session management. This name must be unique. The servlet specification requires this name to be JSESSIONID. However, for flexibility, this value is configurable.
|  | Cookie_path : STRING = /
|  | Specify any string representing a path on the server. A slash (/) indicates root directory. Specify a value to restrict the paths to which the cookie is sent. By restricting paths, you can keep the cookie from being sent to certain URLs on the server. If you specify the root directory, the cookie is sent no matter which path on the given server is accessed.
|  | Cookie_secure : BOOLEAN
|  | Specifies whether session cookies include the secure field. Enabling this feature restricts the exchange of cookies to HTTPS sessions.
|  | Cookie_useContextRootAsPath : BOOLEAN
|  | Sets the cookie path to equal the context root for each application. This setting restricts the cookie from being sent to other applications and results in having different cookies created when accessing multiple applications.
|  | DRSSettings_dataReplicationMode : ENUM [BOTH, CLIENT, SERVER] = BOTH
|  | Specifies the mode used for replication. Select client if sessions need to be replicated. Select server if sessions need to be stored. Select both client and server if sessions need to be replicated and stored.
|  | DRSSettings_messageBrokerDomainName : STRING
|  | Specifies the name of the replication domain in which data is replicated.
|  | InvalidationSchedule_firstHour : INTEGER
|  | First time of day.
|  | InvalidationSchedule_secondHour : INTEGER
|  | Second time of day.
|  | SessionDatabasePersistence_datasourceJNDIName : STRING
|  | Specifies the JNDI name of the data source from which the session manager obtains the database connections.
|  | SessionDatabasePersistence_db2RowSize : STRING
|  | Specifies the table space page size configured for the sessions table, if using a DB2(R) database. Values: ROW_SIZE_4KB(default), ROW_SIZE_32KB, ROW_SIZE_16KB, ROW_SIZE_8KB.
|  | SessionDatabasePersistence_password : STRING
|  | Specifies the password required for database access.
|  | SessionDatabasePersistence_tableSpaceName : STRING
|  | Specifies the table space name used for the sessions table.
|  | SessionDatabasePersistence_userId : STRING
|  | Specifies the user ID for database access.
|  | TuningParams_allowOverflow : BOOLEAN = true
|  | Specifies whether to allow the number of sessions in memory to exceed the value specified for maximum in-memory session count. This feature is valid only in nonpersistent sessions mode.
|  | TuningParams_invalidationTimeout : INTEGER = 30
|  | Specify session timeout in minutes.
|  | TuningParams_maxInMemorySessionCount : INTEGER = 1000
|  | Specifies the maximum number of sessions to maintain in memory.
|  | TuningParams_scheduleInvalidation : BOOLEAN = false
|  | Specifies when to clean the invalid sessions from external location.
|  | TuningParams_usingMultiRowSchema : BOOLEAN
|  | Specifies whether to place each instance of application data in a separate row in the database.
|  | TuningParams_writeContents : ENUM [ALL_SESSION_ATTRIBUTES, ONLY_UPDATED_ATTRIBUTES] = ONLY_UPDATED_ATTRIBUTES
|  | Specifies whether or not only updated attributes should be written to the persistent store or all of the session attributes should be written to the persistent store, whether or not they have changed. If you specify only updated attributes, only the updated attributes are written to the persistent store If you specify all session attributes, all attributes are written to the persistent store.
|  | TuningParams_writeFrequency : ENUM [TIME_BASED_WRITE, END_OF_SERVLET_SERVICE, MANUAL_UPDATE] = END_OF_SERVLET_SERVICE
|  | Specifies when the session is written to the persistent store.
|  | TuningParams_writeInterval : INTEGER = 120
|  | Specify a time period in seconds in which a session should be writen to the persistent store.
|  | accessSessionOnTimeout : BOOLEAN = true
|  | Allow access on timeout.
|  | allowSerializedSessionAccess : BOOLEAN = false
|  | Allow serial access.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | enableCookies : BOOLEAN = true
|  | Enable cookies.
|  | enableProtocolSwitchRewriting : BOOLEAN = false
|  | Enable protocol switch rewriting
|  | enableSSLTracking : BOOLEAN = false
|  | Enable SSL ID tracking.
|  | enableSecurityIntegration : BOOLEAN = false
|  | Specifies whether security integration is enabled. When security integration is enabled, the session manager associates the identity of users with their HTTP sessions.
|  | enableUrlRewriting : BOOLEAN = false
|  | Enable URL rewriting.
|  | maxWaitTime : INTEGER = 0
|  | Maximum wait time.
|  | sessionPersistenceMode : ENUM [NONE, DATABASE] = NONE
|  | Use this page to specify how session data is saved in a distributed environment. The SIP container uses only memory-to-memory replication for distributed sessions.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,container,name,type,deployable,scope,restrictToModules,Cookie,SessionDatabasePersistence,TuningParams,DRSSettings,InvalidationSchedule
|  | Additional Properties Not To Expose

#### was.SessionManagerSpec

Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support.

|  | Public Properties
--- | --- | ---
|  | Cookie_domain : STRING
|  | Specifies the value of the domain field of a session tracking cookie. This value dictates to the browser whether to send a cookie to particular servers. For example, if you specify a particular domain, session cookies are only sent to hosts in that domain. The default domain is the server. (string)
|  | Cookie_httpOnly : STRING
|  | Specifies that session cookies include the HTTPOnly field. When checked, browsers that support the HTTPOnly attribute do not allow cookies to be accessed by client-side scripts. For security cookies, see the global security settings for Web SSO. (boolean) default(true)
|  | Cookie_maximumAge : STRING
|  | Specifies the time to live for a cookie as a user defined value. Specify a value in seconds. When the default value (-1) is used, time to live for a cookie will be determined by the browser session. (integer) default(-1)
|  | Cookie_name : STRING
|  | Specifies a name for the cookie that is used for session management. This name must be unique. The servlet specification requires this name to be JSESSIONID. However, for flexibility, this value is configurable. (string) default(JSESSIONID)
|  | Cookie_path : STRING
|  | Specify any string representing a path on the server. A slash (/) indicates root directory. Specify a value to restrict the paths to which the cookie is sent. By restricting paths, you can keep the cookie from being sent to certain URLs on the server. If you specify the root directory, the cookie is sent no matter which path on the given server is accessed. (string) default(/)
|  | Cookie_secure : STRING
|  | Specifies whether session cookies include the secure field. Enabling this feature restricts the exchange of cookies to HTTPS sessions. (boolean)
|  | Cookie_useContextRootAsPath : STRING
|  | Sets the cookie path to equal the context root for each application. This setting restricts the cookie from being sent to other applications and results in having different cookies created when accessing multiple applications. (boolean)
|  | DRSSettings_dataReplicationMode : STRING
|  | Specifies the mode used for replication. Select client if sessions need to be replicated. Select server if sessions need to be stored. Select both client and server if sessions need to be replicated and stored. (enum) values(BOTH, CLIENT, SERVER) default(BOTH)
|  | DRSSettings_messageBrokerDomainName : STRING
|  | Specifies the name of the replication domain in which data is replicated. (string)
|  | InvalidationSchedule_firstHour : STRING
|  | First time of day. (integer)
|  | InvalidationSchedule_secondHour : STRING
|  | Second time of day. (integer)
|  | SessionDatabasePersistence_datasourceJNDIName : STRING
|  | Specifies the JNDI name of the data source from which the session manager obtains the database connections. (string)
|  | SessionDatabasePersistence_db2RowSize : STRING
|  | Specifies the table space page size configured for the sessions table, if using a DB2(R) database. Values: ROW_SIZE_4KB(default), ROW_SIZE_32KB, ROW_SIZE_16KB, ROW_SIZE_8KB. (string)
|  | SessionDatabasePersistence_password : STRING
|  | Specifies the password required for database access. (string)
|  | SessionDatabasePersistence_tableSpaceName : STRING
|  | Specifies the table space name used for the sessions table. (string)
|  | SessionDatabasePersistence_userId : STRING
|  | Specifies the user ID for database access. (string)
|  | TuningParams_allowOverflow : STRING
|  | Specifies whether to allow the number of sessions in memory to exceed the value specified for maximum in-memory session count. This feature is valid only in nonpersistent sessions mode. (boolean) default(true)
|  | TuningParams_invalidationTimeout : STRING
|  | Specify session timeout in minutes. (integer) default(30)
|  | TuningParams_maxInMemorySessionCount : STRING
|  | Specifies the maximum number of sessions to maintain in memory. (integer) default(1000)
|  | TuningParams_scheduleInvalidation : STRING
|  | Specifies when to clean the invalid sessions from external location. (boolean) default(false)
|  | TuningParams_usingMultiRowSchema : STRING
|  | Specifies whether to place each instance of application data in a separate row in the database. (boolean)
|  | TuningParams_writeContents : STRING
|  | Specifies whether or not only updated attributes should be written to the persistent store or all of the session attributes should be written to the persistent store, whether or not they have changed. If you specify only updated attributes, only the updated attributes are written to the persistent store If you specify all session attributes, all attributes are written to the persistent store. (enum) values(ALL_SESSION_ATTRIBUTES, ONLY_UPDATED_ATTRIBUTES) default(ONLY_UPDATED_ATTRIBUTES)
|  | TuningParams_writeFrequency : STRING
|  | Specifies when the session is written to the persistent store. (enum) values(TIME_BASED_WRITE, END_OF_SERVLET_SERVICE, MANUAL_UPDATE) default(END_OF_SERVLET_SERVICE)
|  | TuningParams_writeInterval : STRING
|  | Specify a time period in seconds in which a session should be writen to the persistent store. (integer) default(120)
|  | accessSessionOnTimeout : STRING
|  | Allow access on timeout. (boolean) default(true)
|  | allowSerializedSessionAccess : STRING
|  | Allow serial access. (boolean) default(false)
|  | enableCookies : STRING
|  | Enable cookies. (boolean) default(true)
|  | enableProtocolSwitchRewriting : STRING
|  | Enable protocol switch rewriting (boolean) default(false)
|  | enableSSLTracking : STRING
|  | Enable SSL ID tracking. (boolean) default(false)
|  | enableSecurityIntegration : STRING
|  | Specifies whether security integration is enabled. When security integration is enabled, the session manager associates the identity of users with their HTTP sessions. (boolean) default(false)
|  | enableUrlRewriting : STRING
|  | Enable URL rewriting. (boolean) default(false)
|  | maxWaitTime : STRING
|  | Maximum wait time. (integer) default(0)
|  | sessionPersistenceMode : STRING
|  | Use this page to specify how session data is saved in a distributed environment. The SIP container uses only memory-to-memory replication for distributed sessions. (enum) values(NONE, DATABASE) default(NONE)

#### was.SharedLibrary

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Container-wide shared library that can be used by deployed applications.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | classPath : STRING
|  | Classpath that contains the JAR files and directories.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | nativePath : STRING
|  | Optional path to any native libraries (DLL or SO).

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/sharedlibrary/create-shared-library.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/sharedlibrary/destroy-shared-library.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/sharedlibrary/discover-inspect-shared-library.py
|  | Discover Script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SharedLibrarySpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a shared library.

|  | Public Properties
--- | --- | ---
|  | classPath : STRING
|  | Classpath that contains the JAR files and directories. (string)
|  | nativePath : STRING
|  | Optional path to any native libraries (DLL or SO). (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.SiBus

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A service integration bus supports applications using message-based and service-oriented architectures. A bus is a group of interconnected servers and clusters that have been added as members of the bus. Applications connect to a bus at one of the messaging engines associated with its bus members.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | securityGroupCacheTimeout : INTEGER = 120
|  | The length of time, in minutes, that a security group will be cached for. Default 120, maximum 99999.
|  | auditAllowed : BOOLEAN = true
|  | Used to allow or prevent the bus from auditing when the application server auditing support is enabled.
|  | bootstrapPolicy : ENUM [MEMBERS_ONLY, SIBSERVICE_ENABLED, MEMBERS_AND_NOMINATED] = SIBSERVICE_ENABLED
|  | The bootstrap policy value can be set to one of the following SIBSERVICE_ENABLED, MEMBERS_AND_NOMINATED or MEMBERS_ONLY.
|  | busSecurity : BOOLEAN = true
|  | Enables or disables bus security.
|  | configurationReloadEnabled : BOOLEAN = true
|  | Indicate whether configuration files should be dynamically reloaded for this bus.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Description of the Service Integration Bus.
|  | discardOnDelete : BOOLEAN = false
|  | Indicate whether or not any messages left in a queue's data store should be discarded when the queue is deleted.
|  | highMessageThreshold : INTEGER = 50000
|  | The maximum number of messages that any queue on the bus can hold.
|  | interEngineAuthAlias : STRING
|  | Name of the authentication alias used to authorize communication between messaging engines on the bus.
|  | mediationsAuthAlias : STRING
|  | Name of the authentication alias used to authorize mediations to access the bus.
|  | permittedChains : ENUM [SSL_ENABLED, LISTED, ALL] = SSL_ENABLED
|  | Selects which transports are allowed. When set to LISTED transports are enabled by the permittedTransport_* flags. (Values: ALL, SSL_ENABLED, LISTED)
|  | permittedTransport_bootstrapBasicMessaging : BOOLEAN
|  | Flag to enable BootstrapBasicMessaging.
|  | permittedTransport_bootstrapSecureMessaging : BOOLEAN
|  | Flag to enable BootstrapSecureMessaging.
|  | permittedTransport_bootstrapTunneledMessaging : BOOLEAN
|  | Flag to enable BootstrapTunneledMessaging.
|  | permittedTransport_bootstrapTunneledSecureMessaging : BOOLEAN
|  | Flag to enable BootstrapTunneledSecureMessaging.
|  | permittedTransport_inboundBasicMQLink : BOOLEAN
|  | Flag to enable InboundBasicMQLink.
|  | permittedTransport_inboundBasicMessaging : BOOLEAN
|  | Flag to enable InboundBasicMessaging.
|  | permittedTransport_inboundSecureMQLink : BOOLEAN
|  | Flag to enable InboundSecureMQLink.
|  | permittedTransport_inboundSecureMessaging : BOOLEAN
|  | Flag to enable InboundSecureMessaging.
|  | permittedTransport_outboundBasicMQLink : BOOLEAN
|  | Flag to enable OutboundBasicMQLink.
|  | permittedTransport_outboundBasicWMQClient : BOOLEAN
|  | Flag to enable OutboundBasicWMQClient.
|  | permittedTransport_outboundSecureMQLink : BOOLEAN
|  | Flag to enable OutboundSecureMQLink.
|  | permittedTransport_outboundSecureWMQClient : BOOLEAN
|  | Flag to enable OutboundSecureWMQClient.
|  | protocol : STRING
|  | The protocol used to send and receive messages between messaging engines, and between API clients and messaging engines. (BootstrapBasicMessaging, BootstrapSecureMessaging, BootstrapTunneledMessaging, BootstrapTunneledSecureMessaging, OutboundBasicMQLink, OutboundSecureMQLink, OutboundBasicWMQClient, OutboundSecureWMQClient, InboundBasicMessaging, InboundSecureMessaging, InboundBasicMQLink, InboundSecureMQLink)
|  | scriptCompatibility : STRING = 6.1
|  | Set script compatibility to 6 to maintain version 6 command behavior. Default value is 6.1.
|  | useServerIdForMediations : BOOLEAN = false
|  | Configure the bus to use the server identity for calling mediations rather than the mediationsAuthAlias.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,permittedTransport
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 57
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/sib/create-or-modify-sibus.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 46
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/sib/destroy-sibus.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/sib/discover-inspect-sibus.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/sib/sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/sib/create-or-modify-sibus.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SiBusMember

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Bus members are the servers, WebSphere MQ servers and clusters that have been added to the bus.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | bus : STRING
|  | Name of bus to add member to.
|  | Cluster_enableAssistance : BOOLEAN = false
|  | A parameter that specifies whether to enable messaging engine policy assistance.
|  | Cluster_failback : BOOLEAN = false
|  | A parameter that specifies whether the messaging engine in the cluster that has failed over can fail back to a more preferred server in the preferred servers list if that server becomes available again. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected.
|  | Cluster_failover : BOOLEAN = false
|  | A parameter that specifies whether the messaging engine in the cluster can fail over to another server in the cluster if the host server for the messaging engine fails. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected.
|  | Cluster_policyName : ENUM [HA, SCALABILITY, SCALABILITY_HA, CUSTOM]
|  | The type of messaging engine policy to apply to the cluster.
|  | Cluster_preferredServerList : MAP_STRING_STRING
|  | The list of servers, in order of preference, on which the messaging engine in the cluster prefers to run. For each server in the list, specify both the name of the node on which the server runs, and the name of the server. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected. Specify entries with nodeName as key and serverName as value.
|  | Cluster_preferredServersOnly : BOOLEAN = false
|  | A parameter that specifies whether the messaging engine in the cluster can run only on servers in the preferred servers list, or on any server in the cluster. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected.
|  | DataStore_authAlias : STRING
|  | The name of the authentication alias used by the messaging engine to access the data source.
|  | DataStore_createDefaultDatasource : BOOLEAN
|  | A parameter that specifies whether to create a default data source when the messaging engine is created.
|  | DataStore_createTables : BOOLEAN = true
|  | If this option is selected, the messaging engine creates the database tables for the data store automatically. Otherwise, the database administrator must create the database tables manually.
|  | DataStore_datasourceJndiName : STRING
|  | The JNDI name of the data source that the messaging engine uses to access the relational database management system (RDBMS) for the data store.
|  | DataStore_enabled : BOOLEAN = false
|  | Create a data store to use as a message store for the messaging engine. A data store consists of the set of tables that a messaging engine uses to store persistent data in a database.
|  | DataStore_restrictLongDBLock : BOOLEAN = false
|  | If this option is selected, A new messaging engine locking mechanism is applied, where long DB locks are not held. Otherwise, the old locking mechanism is applied where long DB locks are held by messaging engine.
|  | DataStore_schemaName : STRING = IBMWSSIB
|  | The name of the database schema used to contain the tables for the data store.
|  | FileStore_enabled : BOOLEAN = true
|  | Create a file store to use as a message store for the messaging engine. A file store is a type of message store that directly uses files in a file system through the operating system. The alternative is to use a data store.
|  | FileStore_logDirectory : STRING
|  | The name of the log files directory.
|  | FileStore_logSize : INTEGER = 100
|  | Size in megabytes of the log file.
|  | FileStore_maxPermanentStoreSize : INTEGER = 500
|  | The maximum size in megabytes for the permanent store files.
|  | FileStore_maxTemporaryStoreSize : INTEGER = 500
|  | The maximum size in megabytes for the temporary store files.
|  | FileStore_minPermanentStoreSize : INTEGER = 200
|  | The minimum number of megabytes reserved by each of the permanent store files. The permanent store files are never smaller than the log file.
|  | FileStore_minTemporaryStoreSize : INTEGER = 200
|  | The minimum number of megabytes reserved by each of the temporary store files. The temporary store files are never smaller than the log file.
|  | FileStore_permanentStoreDirectory : STRING
|  | The name of the store files directory for permanent data.
|  | FileStore_temporaryStoreDirectory : STRING
|  | The name of the store files directory for temporary data.
|  | FileStore_unlimitedPermanentStoreSize : BOOLEAN = false
|  | Indicates whether the permanent store files are unlimited in size.
|  | FileStore_unlimitedTemporaryStoreSize : BOOLEAN = false
|  | Indicates whether the temporary store files are unlimited in size.
|  | Wmq_channel : STRING = SYSTEM.DEF.SVRCONN
|  | This is the override name of the WebSphere MQ server connection channel that will be used to establish a connection to the WebSphere MQ queue manager or WebSphere MQ queue sharing group, supply with a WebSphere MQ server name, but not node name, server name or cluster name.
|  | Wmq_host : STRING
|  | This is the override host name of the host to which a connection will be established in order to communicate with a WebSphere MQ queue manager or a WebSphere MQ queue sharing group, supply with a WebSphere MQ server name, but not node name, server name or cluster name.
|  | Wmq_port : INTEGER = 1414
|  | This is the override port number monitored by a WebSphere MQ queue manager or WebSphere MQ queue sharing group listener, which is listening for connections, supply with a WebSphere MQ server name, but not node name, server name or cluster name.
|  | Wmq_securityAuthAlias : STRING
|  | The authentication alias that will be supplied when connecting to the WebSphere MQ server, supply with a WebSphere MQ server name, but not node name, server name or cluster name.
|  | Wmq_transportChain : STRING = OutboundBasicWMQClient
|  | Overridden value for the WebSphere MQ server bus member transportChain attribute. Refer to the createSIBWMQServer command for a description of this parameter.
|  | Wmq_trustUserIds : BOOLEAN = true
|  | Overridden value for the WebSphere MQ server bus member trustUserIds attribute. Refer to the createSIBWMQServer command for a description of this parameter
|  | Wmq_virtualQueueManagerName : STRING
|  | The virtual queue manager name of the SIBus that the WebSphere MQ queue manager sees.
|  | cluster : STRING
|  | To specify a cluster bus member, supply cluster name, but not node name, server name or WebSphere MQ server name.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | initialHeapSize : INTEGER
|  | The initial Java virtual machine (JVM) heap size, in megabytes, of the server or of each server in a cluster.
|  | maxHeapSize : INTEGER
|  | The maximum JVM heap size, in megabytes, of the server or of each server in a cluster.
|  | node : STRING
|  | To specify a server bus member, supply node and server name, but not cluster name or WebSphere MQ server name.
|  | server : STRING
|  | To specify a server bus member, supply node and server name, but not cluster name or WebSphere MQ server name.
|  | wmqServer : STRING
|  | To specify a WebSphere MQ server bus member, supply a WebSphere MQ server name, but not node name, server name or cluster name.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,Cluster,DataStore,FileStore,Wmq
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/sib/create-sibus-member.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 44
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/sib/destroy-sibus-member.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 44
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/sib/discover-inspect-sibus-member.py
|  | Discover Script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SiBusMemberSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Bus members are the servers, WebSphere MQ servers and clusters that have been added to the bus.

|  | Public Properties
--- | --- | ---
|  | Cluster_enableAssistance : STRING
|  | A parameter that specifies whether to enable messaging engine policy assistance. (boolean) default(false)
|  | Cluster_failback : STRING
|  | A parameter that specifies whether the messaging engine in the cluster that has failed over can fail back to a more preferred server in the preferred servers list if that server becomes available again. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected. (boolean) default(false)
|  | Cluster_failover : STRING
|  | A parameter that specifies whether the messaging engine in the cluster can fail over to another server in the cluster if the host server for the messaging engine fails. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected. (boolean) default(false)
|  | Cluster_policyName : STRING
|  | The type of messaging engine policy to apply to the cluster. (enum) values(HA, SCALABILITY, SCALABILITY_HA, CUSTOM)
|  | Cluster_preferredServerList : MAP_STRING_STRING
|  | The list of servers, in order of preference, on which the messaging engine in the cluster prefers to run. For each server in the list, specify both the name of the node on which the server runs, and the name of the server. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected. Specify entries with nodeName as key and serverName as value. (map_string_string)
|  | Cluster_preferredServersOnly : STRING
|  | A parameter that specifies whether the messaging engine in the cluster can run only on servers in the preferred servers list, or on any server in the cluster. This option can be used when messaging engine policy assistance is enabled and the 'CUSTOM' policy is selected. (boolean) default(false)
|  | DataStore_authAlias : STRING
|  | The name of the authentication alias used by the messaging engine to access the data source. (string)
|  | DataStore_createDefaultDatasource : STRING
|  | A parameter that specifies whether to create a default data source when the messaging engine is created. (boolean)
|  | DataStore_createTables : STRING
|  | If this option is selected, the messaging engine creates the database tables for the data store automatically. Otherwise, the database administrator must create the database tables manually. (boolean) default(true)
|  | DataStore_datasourceJndiName : STRING
|  | The JNDI name of the data source that the messaging engine uses to access the relational database management system (RDBMS) for the data store. (string)
|  | DataStore_enabled : STRING
|  | Create a data store to use as a message store for the messaging engine. A data store consists of the set of tables that a messaging engine uses to store persistent data in a database. (boolean) default(false)
|  | DataStore_restrictLongDBLock : STRING
|  | If this option is selected, A new messaging engine locking mechanism is applied, where long DB locks are not held. Otherwise, the old locking mechanism is applied where long DB locks are held by messaging engine. (boolean) default(false)
|  | DataStore_schemaName : STRING
|  | The name of the database schema used to contain the tables for the data store. (string) default(IBMWSSIB)
|  | FileStore_enabled : STRING
|  | Create a file store to use as a message store for the messaging engine. A file store is a type of message store that directly uses files in a file system through the operating system. The alternative is to use a data store. (boolean) default(true)
|  | FileStore_logDirectory : STRING
|  | The name of the log files directory. (string)
|  | FileStore_logSize : STRING
|  | Size in megabytes of the log file. (integer) default(100)
|  | FileStore_maxPermanentStoreSize : STRING
|  | The maximum size in megabytes for the permanent store files. (integer) default(500)
|  | FileStore_maxTemporaryStoreSize : STRING
|  | The maximum size in megabytes for the temporary store files. (integer) default(500)
|  | FileStore_minPermanentStoreSize : STRING
|  | The minimum number of megabytes reserved by each of the permanent store files. The permanent store files are never smaller than the log file. (integer) default(200)
|  | FileStore_minTemporaryStoreSize : STRING
|  | The minimum number of megabytes reserved by each of the temporary store files. The temporary store files are never smaller than the log file. (integer) default(200)
|  | FileStore_permanentStoreDirectory : STRING
|  | The name of the store files directory for permanent data. (string)
|  | FileStore_temporaryStoreDirectory : STRING
|  | The name of the store files directory for temporary data. (string)
|  | FileStore_unlimitedPermanentStoreSize : STRING
|  | Indicates whether the permanent store files are unlimited in size. (boolean) default(false)
|  | FileStore_unlimitedTemporaryStoreSize : STRING
|  | Indicates whether the temporary store files are unlimited in size. (boolean) default(false)
|  | Wmq_channel : STRING
|  | This is the override name of the WebSphere MQ server connection channel that will be used to establish a connection to the WebSphere MQ queue manager or WebSphere MQ queue sharing group, supply with a WebSphere MQ server name, but not node name, server name or cluster name. (string) default(SYSTEM.DEF.SVRCONN)
|  | Wmq_host : STRING
|  | This is the override host name of the host to which a connection will be established in order to communicate with a WebSphere MQ queue manager or a WebSphere MQ queue sharing group, supply with a WebSphere MQ server name, but not node name, server name or cluster name. (string)
|  | Wmq_port : STRING
|  | This is the override port number monitored by a WebSphere MQ queue manager or WebSphere MQ queue sharing group listener, which is listening for connections, supply with a WebSphere MQ server name, but not node name, server name or cluster name. (integer) default(1414)
|  | Wmq_securityAuthAlias : STRING
|  | The authentication alias that will be supplied when connecting to the WebSphere MQ server, supply with a WebSphere MQ server name, but not node name, server name or cluster name. (string)
|  | Wmq_transportChain : STRING
|  | Overridden value for the WebSphere MQ server bus member transportChain attribute. Refer to the createSIBWMQServer command for a description of this parameter. (string) default(OutboundBasicWMQClient)
|  | Wmq_trustUserIds : STRING
|  | Overridden value for the WebSphere MQ server bus member trustUserIds attribute. Refer to the createSIBWMQServer command for a description of this parameter (boolean) default(true)
|  | Wmq_virtualQueueManagerName : STRING
|  | The virtual queue manager name of the SIBus that the WebSphere MQ queue manager sees. (string)
|  | bus : STRING
|  | Name of bus to add member to. (string)
|  | cluster : STRING
|  | To specify a cluster bus member, supply cluster name, but not node name, server name or WebSphere MQ server name. (string)
|  | initialHeapSize : STRING
|  | The initial Java virtual machine (JVM) heap size, in megabytes, of the server or of each server in a cluster. (integer)
|  | maxHeapSize : STRING
|  | The maximum JVM heap size, in megabytes, of the server or of each server in a cluster. (integer)
|  | node : STRING
|  | To specify a server bus member, supply node and server name, but not cluster name or WebSphere MQ server name. (string)
|  | server : STRING
|  | To specify a server bus member, supply node and server name, but not cluster name or WebSphere MQ server name. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | wmqServer : STRING
|  | To specify a WebSphere MQ server bus member, supply a WebSphere MQ server name, but not node name, server name or cluster name. (string)

#### was.SiBusSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

A service integration bus supports applications using message-based and service-oriented architectures. A bus is a group of interconnected servers and clusters that have been added as members of the bus. Applications connect to a bus at one of the messaging engines associated with its bus members.

|  | Public Properties
--- | --- | ---
|  | auditAllowed : STRING
|  | Used to allow or prevent the bus from auditing when the application server auditing support is enabled. (boolean) default(true)
|  | bootstrapPolicy : STRING
|  | The bootstrap policy value can be set to one of the following SIBSERVICE_ENABLED, MEMBERS_AND_NOMINATED or MEMBERS_ONLY. (enum) values(MEMBERS_ONLY, SIBSERVICE_ENABLED, MEMBERS_AND_NOMINATED) default(SIBSERVICE_ENABLED)
|  | busSecurity : STRING
|  | Enables or disables bus security. (boolean) default(true)
|  | configurationReloadEnabled : STRING
|  | Indicate whether configuration files should be dynamically reloaded for this bus. (boolean) default(true)
|  | description : STRING
|  | Description of the Service Integration Bus. (string)
|  | discardOnDelete : STRING
|  | Indicate whether or not any messages left in a queue's data store should be discarded when the queue is deleted. (boolean) default(false)
|  | highMessageThreshold : STRING
|  | The maximum number of messages that any queue on the bus can hold. (integer) default(50000)
|  | interEngineAuthAlias : STRING
|  | Name of the authentication alias used to authorize communication between messaging engines on the bus. (string)
|  | mediationsAuthAlias : STRING
|  | Name of the authentication alias used to authorize mediations to access the bus. (string)
|  | permittedChains : STRING
|  | Selects which transports are allowed. When set to LISTED transports are enabled by the permittedTransport_* flags. (Values: ALL, SSL_ENABLED, LISTED) (enum) values(SSL_ENABLED, LISTED, ALL) default(SSL_ENABLED)
|  | permittedTransport_bootstrapBasicMessaging : STRING
|  | Flag to enable BootstrapBasicMessaging. (boolean)
|  | permittedTransport_bootstrapSecureMessaging : STRING
|  | Flag to enable BootstrapSecureMessaging. (boolean)
|  | permittedTransport_bootstrapTunneledMessaging : STRING
|  | Flag to enable BootstrapTunneledMessaging. (boolean)
|  | permittedTransport_bootstrapTunneledSecureMessaging : STRING
|  | Flag to enable BootstrapTunneledSecureMessaging. (boolean)
|  | permittedTransport_inboundBasicMQLink : STRING
|  | Flag to enable InboundBasicMQLink. (boolean)
|  | permittedTransport_inboundBasicMessaging : STRING
|  | Flag to enable InboundBasicMessaging. (boolean)
|  | permittedTransport_inboundSecureMQLink : STRING
|  | Flag to enable InboundSecureMQLink. (boolean)
|  | permittedTransport_inboundSecureMessaging : STRING
|  | Flag to enable InboundSecureMessaging. (boolean)
|  | permittedTransport_outboundBasicMQLink : STRING
|  | Flag to enable OutboundBasicMQLink. (boolean)
|  | permittedTransport_outboundBasicWMQClient : STRING
|  | Flag to enable OutboundBasicWMQClient. (boolean)
|  | permittedTransport_outboundSecureMQLink : STRING
|  | Flag to enable OutboundSecureMQLink. (boolean)
|  | permittedTransport_outboundSecureWMQClient : STRING
|  | Flag to enable OutboundSecureWMQClient. (boolean)
|  | protocol : STRING
|  | The protocol used to send and receive messages between messaging engines, and between API clients and messaging engines. (BootstrapBasicMessaging, BootstrapSecureMessaging, BootstrapTunneledMessaging, BootstrapTunneledSecureMessaging, OutboundBasicMQLink, OutboundSecureMQLink, OutboundBasicWMQClient, OutboundSecureWMQClient, InboundBasicMessaging, InboundSecureMessaging, InboundBasicMQLink, InboundSecureMQLink) (string)
|  | scriptCompatibility : STRING
|  | Set script compatibility to 6 to maintain version 6 command behavior. Default value is 6.1. (string) default(6.1)
|  | securityGroupCacheTimeout : STRING
|  | The length of time, in minutes, that a security group will be cached for. Default 120, maximum 99999. (integer) default(120)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useServerIdForMediations : STRING
|  | Configure the bus to use the server identity for calling mediations rather than the mediationsAuthAlias. (boolean) default(false)

#### was.SibConnectionFactory

Virtual Type
Type Hierarchy | was.SibJndiResource >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = sibType,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-connection-factory.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-connection-factory.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibDestination

Virtual Type
Type Hierarchy | was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed SIB destionation configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,sibType,busName
|  | Properties that are not exposed to any python wsadmin script.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibJndiResource

Virtual Type
Type Hierarchy | was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed SIB JNDI resource configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibQueue

Type Hierarchy | was.SibJndiResource >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

JMS queue is used as a destination for point-to-point messaging. Use JMS queue destination administrative objects to manage JMS queues for the default messaging provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deliveryMode : STRING = Application
|  | The delivery mode for messages. Legal values are 'Application', 'NonPersistent' and 'Persistent'.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | queueName : CI<was.SibQueueDestination >
|  | Name of the underlying SIB queue to which the queue points.
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Description of the SIB JMS queue.
|  | timeToLive : STRING
|  | The time in milliseconds to be used for message expiration.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-queue.py
|  | Python wsadmin script invoked to create a JMS SIB queue.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-queue-or-topic.py
|  | Python wsadmin script invoked to destroy a JMS SIB queue.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-queue.py
|  | Python wsadmin script invoked to inspect a JMS SIB queue.
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = SIBJMSQueue
|  | WAS config type of SIB queue.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibQueueConnectionFactory

Type Hierarchy | was.SibConnectionFactory >> was.SibJndiResource >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

JMS queue connection factory is used to create connections to the associated JMS provider of JMS queues, for point-to-point messaging. Use queue connection factory administrative objects to manage JMS queue connection factories for the default messaging provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = sibType,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-connection-factory.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-connection-factory.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | sibType : STRING = Queue
|  | SIB type of SIB connection factory.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = SIBJMSQueueConnectionFactory
|  | WAS config type of SIB queue connnection factory.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibQueueConnectionFactorySpec

Type Hierarchy | jee.QueueConnectionFactorySpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a SIB queue connection factory.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.SibQueueDestination

Type Hierarchy | was.SibDestination >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Queue for point-to-point messaging.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,sibType,busName
|  | Properties that are not exposed to any python wsadmin script.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 59
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-queue-destination.py
|  | Python wsadmin script invoked to create a JMS SIB queue destination.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 43
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-destination.py
|  | Python wsadmin script invoked to destroy a JMS SIB queue destination.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 44
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-queue-destination.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibQueueDestinationSpec

Type Hierarchy | jee.QueueSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a SIB queue destination.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides. (string)
|  | jndiName : STRING
|  | Name used to lookup this resource in JNDI
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.SibQueueSpec

Type Hierarchy | jee.QueueSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a SIB queue.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides. (string)
|  | deliveryMode : STRING
|  | The delivery mode for messages. Legal values are 'Application', 'NonPersistent' and 'Persistent'. (string) default(Application)
|  | description : STRING
|  | Description of the SIB JMS queue. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | timeToLive : STRING
|  | The time in milliseconds to be used for message expiration. (string)

#### was.SibResource

Virtual Type
Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Base class for all deployed SIB resource configuration items.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | createScript : STRING
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibTopic

Type Hierarchy | was.SibJndiResource >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

JMS topic is used as a destination for publish/subscribe messaging.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | topicName : STRING
|  | Topic to be used inside the topic space (for example, stock/IBM).
|  | topicSpace : CI<was.SibTopicSpaceDestination >
|  | Topic space into which to create the topic.
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-topic.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-queue-or-topic.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-topic.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = SIBJMSTopic
|  | WAS config type of SIB topic.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibTopicConnectionFactory

Type Hierarchy | was.SibConnectionFactory >> was.SibJndiResource >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

JMS topic connection factory is used to create connections to the associated JMS provider of JMS topics, for publish/subscribe messaging. Use topic connection factory administrative objects to manage JMS topic connection factories for the default messaging provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = sibType,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-connection-factory.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-connection-factory.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | sibType : STRING = Topic
|  | SIB type of SIB connection factory.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = SIBJMSTopicConnectionFactory
|  | WAS config type of SIB topic connnection factory.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibTopicConnectionFactorySpec

Type Hierarchy | jee.TopicConnectionFactorySpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a SIB topic connection factory.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.SibTopicSpaceDestination

Type Hierarchy | was.SibDestination >> was.SibResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Topic space is a location for publish/subscribe messaging.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,sibType,busName
|  | Properties that are not exposed to any python wsadmin script.
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 59
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-sib-topic-space-destination.py
|  | Python wsadmin script invoked to create a JMS SIB topic space destination.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 43
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-sib-destination.py
|  | Python wsadmin script invoked to destroy a JMS SIB topic space destination.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 44
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-sib-topic-space-destination.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/discover-inspect-sib-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.SibTopicSpaceDestinationSpec

Type Hierarchy | jee.TopicSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a SIB topic space destination.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides. (string)
|  | jndiName : STRING
|  | Name used to lookup this resource in JNDI
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.SibTopicSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a SIB topic.

|  | Public Properties
--- | --- | ---
|  | busName : STRING
|  | Name of the bus on which the resource resides. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | topicName : STRING
|  | Topic to be used inside the topic space (for example, stock/IBM). (string)

#### was.StaticPolicy

Type Hierarchy | was.HAManagerPolicy >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Specifies a policy that activates group members on all of the servers in the list.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | isAlivePeriodSec : INTEGER = 120
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted.
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.
|  | description : STRING
|  | Specifies an optional description for the policy.
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy.
|  | quorumEnabled : BOOLEAN = false
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation.
|  | servers : SET_OF_CI<was.ManagedServer >
|  | Specifies a list of core group servers for the policy.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,type,wasType,deployable,container,customProperties,matchCriteria,servers,preferredServers
|  | Additional Properties Not To Expose
|  | policyFactory : STRING = com.ibm.ws.hamanager.coordinator.policy.impl.StaticPolicyFactory
|  | The fully qualified name of the Java interface that serves as a factory for a specific type of concrete HAManagerPolicy.
|  | wasType : STRING = StaticPolicy
|  | WebSphere admin resource type.

#### was.StaticPolicySpec

Type Hierarchy | was.HAManagerPolicySpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.ConfigurationItem, udm.EmbeddedDeployable

Specifies a policy that activates group members on all of the servers in the list.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this Core group policy. (map_string_string)
|  | description : STRING
|  | Specifies an optional description for the policy. (string)
|  | isAlivePeriodSec : STRING
|  | Specifies, in seconds, how frequently the high availability manager checks the health of the active group members governed by this policy. If a group member has failed, the server on which the group member resides is restarted. (integer) default(120)
|  | matchCriteria : MAP_STRING_STRING
|  | Specifies name and value pairs that determine which high availability groups are governed by this policy. (map_string_string)
|  | quorumEnabled : STRING
|  | Specifies whether or not quorum checking is enabled for a high availability group governed by this policy. Using quorum is an advanced function and should not be enabled without first consulting the product documentation. (boolean) default(false)
|  | servers : SET_OF_STRING
|  | Specifies a list of core group servers for the policy.

#### was.StringNameSpaceBinding

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a String namespace binding.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | nameInNameSpace : STRING
|  | Specifies a name for this binding in the name space.
|  | value : STRING
|  | Specifies the string to be bound into the name space.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,value
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/env/create-string-namespacebinding.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/env/discover-inspect-string-namespacebinding.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/env/modify-string-namespacebinding.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = StringNameSpaceBinding
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.StringNameSpaceBindingSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification for a String namespace binding.

|  | Public Properties
--- | --- | ---
|  | nameInNameSpace : STRING
|  | Specifies a name for this binding in the name space. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | value : STRING
|  | Specifies the string to be bound into the name space. (string)

#### was.ThreadPool

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A thread pool enables server components to reuse threads instead of creating new threads at run time.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | inactivityTimeout : INTEGER = 3500
|  | Specifies the number of milliseconds of the inactivity that should elapse before a thread is reclaimed.
|  | maximumSize : INTEGER = 50
|  | Specifies the maximum number of threads to allow in the pool
|  | minimumSize : INTEGER = 10
|  | Specifies the minimum number of threads to allow in the pool
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies text description of the thread pool.
|  | isGrowable : BOOLEAN
|  | Specifies whether the number of threads can increase beyond the maximum size configured for the thread pool.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-threadpool.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-threadpool.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/discover-inspect-containerproperties-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-threadpool.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = ThreadPool
|  | WAS config type of ThreadPool.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.ThreadPoolSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

A thread pool enables server components to reuse threads instead of creating new threads at run time.

|  | Public Properties
--- | --- | ---
|  | description : STRING
|  | Specifies text description of the thread pool. (string)
|  | inactivityTimeout : STRING
|  | Specifies the number of milliseconds of the inactivity that should elapse before a thread is reclaimed. (integer) default(3500)
|  | isGrowable : STRING
|  | Specifies whether the number of threads can increase beyond the maximum size configured for the thread pool. (boolean)
|  | maximumSize : STRING
|  | Specifies the maximum number of threads to allow in the pool (integer) default(50)
|  | minimumSize : STRING
|  | Specifies the minimum number of threads to allow in the pool (integer) default(10)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.TimerManager

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Timer manager enables applications to schedule future timer notifications and receive timer notification callbacks to application-specified listeners.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | The JNDI name for the resource.
|  | numAlarmThreads : INTEGER = 2
|  | Specifies the maximum number of threads that are used for timers.
|  | ServiceNames_internationalization : BOOLEAN
|  | Specifies that when this option is selected and the internationalization service is enabled, the internationalization context that exists on the scheduling thread is available on the target thread.
|  | ServiceNames_security : BOOLEAN
|  | Specifies that when this option is selected, the Java(TM) Authentication and Authorization Service (JAAS) subject that exists on the scheduling thread is available on the target thread. If not selected, the thread runs anonymously.
|  | ServiceNames_serviceClass : BOOLEAN
|  | Specifies that when this option is selected, the target thread inherits the WebSphere(R) Application Server for z/OS(R) product transaction workload classification of the scheduling thread. If not selected, the default transaction class or the daemon transaction class settings are used to reclassify the target thread.
|  | ServiceNames_workArea : BOOLEAN
|  | Specifies that when this option is selected, the work area context for every work area partition that exists on the scheduling thread is available on the target thread.
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties,ServiceNames
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/async/create-or-modify-timer-manager.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/async/discover-inspect-timer-manager.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/async/async-lib.py, was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/resources/async/create-or-modify-timer-manager.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | provider : STRING = TimerManagerProvider
|  | Specifies the Timer Manager Provider name.
|  | providerType : STRING = TimerManagerProvider
|  | WebSphere admin resource provider type.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = TimerManagerInfo
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.TimerManagerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Timer manager enables applications to schedule future timer notifications and receive timer notification callbacks to application-specified listeners.

|  | Public Properties
--- | --- | ---
|  | ServiceNames_internationalization : STRING
|  | Specifies that when this option is selected and the internationalization service is enabled, the internationalization context that exists on the scheduling thread is available on the target thread. (boolean)
|  | ServiceNames_security : STRING
|  | Specifies that when this option is selected, the Java(TM) Authentication and Authorization Service (JAAS) subject that exists on the scheduling thread is available on the target thread. If not selected, the thread runs anonymously. (boolean)
|  | ServiceNames_serviceClass : STRING
|  | Specifies that when this option is selected, the target thread inherits the WebSphere(R) Application Server for z/OS(R) product transaction workload classification of the scheduling thread. If not selected, the default transaction class or the daemon transaction class settings are used to reclassify the target thread. (boolean)
|  | ServiceNames_workArea : STRING
|  | Specifies that when this option is selected, the work area context for every work area partition that exists on the scheduling thread is available on the target thread. (boolean)
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this resource. (map_string_string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | jndiName : STRING
|  | The JNDI name for the resource. (string)
|  | numAlarmThreads : STRING
|  | Specifies the maximum number of threads that are used for timers. (integer) default(2)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.TransactionService

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies settings for the transaction service, as well as manage active transaction locks.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | LPSHeuristicCompletion : ENUM [COMMIT, ROLLBACK, MANUAL]
|  | Specifies the direction that is used to complete a transaction that has a heuristic outcome; either the application server commits or rolls back the transaction, or depends on manual completion by the administrator. Default WAS value is 'ROLLBACK'.
|  | WSTransactionSpecificationLevel : ENUM [WSTX_10, WSTX_11, WSTX_12]
|  | Specifies the default specification level for WS-TX. Default WAS value is 'WSTX_10'.
|  | acceptHeuristicHazard : STRING
|  | Specifies whether all applications on this server accept the possibility of a heuristic hazard occurring in a two-phase transaction that contains a one-phase resource. values(true, false)
|  | asyncResponseTimeout : INTEGER
|  | Specifies the amount of time, in seconds, that the server waits for responses to WS-AT protocol messages. Default WAS value is '30'.
|  | clientInactivityTimeout : INTEGER
|  | Specifies the maximum duration, in seconds, between transactional requests from a remote client. Any period of client inactivity that exceeds this timeout results in the transaction being rolled back in this application server. Default WAS value is '60'.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enableFileLocking : STRING
|  | Specifies whether the use of file locks is enabled when opening the transaction service recovery log. Default WAS value is 'true'. values(true, false)
|  | enableLoggingForHeuristicReporting : STRING
|  | Specifies whether the application server logs about-to-commit-one-phase-resource events from transactions that involve both a one-phase commit resource and two-phase commit resources. values(true, false)
|  | enableProtocolSecurity : STRING
|  | Specifies whether the secure exchange of transaction service protocol messages is enabled. Default WAS value is 'true'. values(true, false)
|  | heuristicRetryLimit : INTEGER
|  | Specifies the number of times that the application server retries a completion signal, such as commit or rollback. Retries occur after a transient exception from a resource manager or remote partner, or if the configured asynchronous response timeout expires before all Web Services Atomic Transaction (WS-AT) partners have responded. Default WAS value is '0'.
|  | heuristicRetryWait : INTEGER
|  | Specifies the number of seconds that the application server waits before retrying a completion signal, such as commit or rollback, after a transient exception from a resource manager or remote partner. Default WAS value is '0'.
|  | httpProxyPrefix : STRING
|  | Type the external endpoint URL information that should be used for WS-AtomicTransaction and WS-BusinessActivity service endpoints.This should be in the form http(s)://hostname[:port] where hostname may be the hostname of an HTTP(S) proxy to this server.
|  | httpsProxyPrefix : STRING
|  | Select the external endpoint URL information that should be used for WS-AtomicTransaction and WS-BusinessActivity service endpoints.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | propogatedOrBMTTranLifetimeTimeout : INTEGER
|  | Specifies, in seconds, the upper limit of the transaction timeout for transactions that run in this server. This value should be greater than or equal to the value specified for the total transaction timeout. Default WAS value is '300'.
|  | totalTranLifetimeTimeout : INTEGER
|  | The default maximum time, in seconds, allowed for a transaction that is started on this server before the transaction service initiates timeout completion. Any transaction that does not begin completion processing before this timeout occurs is rolled back. Default WAS value is '120'.
|  | transactionLogDirectory : STRING
|  | Specifies the name of a directory for this server where the transaction service stores log files for recovery.
|  | waitForCommitOutcome : STRING
|  | Indicates whether the Transaction Manager should retry commit requests synchronously (true) or asynchronously (false) following a transient exception from a Resource Manager/remote partner. values(true, false)

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = TransactionService
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | enable : STRING = true
|  | Enable this resource.
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = TransactionService
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.TransactionServiceSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies settings for the transaction service, as well as manage active transaction locks.

|  | Public Properties
--- | --- | ---
|  | LPSHeuristicCompletion : STRING
|  | Specifies the direction that is used to complete a transaction that has a heuristic outcome; either the application server commits or rolls back the transaction, or depends on manual completion by the administrator. Default WAS value is 'ROLLBACK'. (enum) values(COMMIT, ROLLBACK, MANUAL)
|  | WSTransactionSpecificationLevel : STRING
|  | Specifies the default specification level for WS-TX. Default WAS value is 'WSTX_10'. (enum) values(WSTX_10, WSTX_11, WSTX_12)
|  | acceptHeuristicHazard : STRING
|  | Specifies whether all applications on this server accept the possibility of a heuristic hazard occurring in a two-phase transaction that contains a one-phase resource. values(true, false) (string)
|  | asyncResponseTimeout : STRING
|  | Specifies the amount of time, in seconds, that the server waits for responses to WS-AT protocol messages. Default WAS value is '30'. (integer)
|  | clientInactivityTimeout : STRING
|  | Specifies the maximum duration, in seconds, between transactional requests from a remote client. Any period of client inactivity that exceeds this timeout results in the transaction being rolled back in this application server. Default WAS value is '60'. (integer)
|  | enableFileLocking : STRING
|  | Specifies whether the use of file locks is enabled when opening the transaction service recovery log. Default WAS value is 'true'. values(true, false) (string)
|  | enableLoggingForHeuristicReporting : STRING
|  | Specifies whether the application server logs about-to-commit-one-phase-resource events from transactions that involve both a one-phase commit resource and two-phase commit resources. values(true, false) (string)
|  | enableProtocolSecurity : STRING
|  | Specifies whether the secure exchange of transaction service protocol messages is enabled. Default WAS value is 'true'. values(true, false) (string)
|  | heuristicRetryLimit : STRING
|  | Specifies the number of times that the application server retries a completion signal, such as commit or rollback. Retries occur after a transient exception from a resource manager or remote partner, or if the configured asynchronous response timeout expires before all Web Services Atomic Transaction (WS-AT) partners have responded. Default WAS value is '0'. (integer)
|  | heuristicRetryWait : STRING
|  | Specifies the number of seconds that the application server waits before retrying a completion signal, such as commit or rollback, after a transient exception from a resource manager or remote partner. Default WAS value is '0'. (integer)
|  | httpProxyPrefix : STRING
|  | Type the external endpoint URL information that should be used for WS-AtomicTransaction and WS-BusinessActivity service endpoints.This should be in the form http(s)://hostname[:port] where hostname may be the hostname of an HTTP(S) proxy to this server. (string)
|  | httpsProxyPrefix : STRING
|  | Select the external endpoint URL information that should be used for WS-AtomicTransaction and WS-BusinessActivity service endpoints. (string)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | propogatedOrBMTTranLifetimeTimeout : STRING
|  | Specifies, in seconds, the upper limit of the transaction timeout for transactions that run in this server. This value should be greater than or equal to the value specified for the total transaction timeout. Default WAS value is '300'. (integer)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | totalTranLifetimeTimeout : STRING
|  | The default maximum time, in seconds, allowed for a transaction that is started on this server before the transaction service initiates timeout completion. Any transaction that does not begin completion processing before this timeout occurs is rolled back. Default WAS value is '120'. (integer)
|  | transactionLogDirectory : STRING
|  | Specifies the name of a directory for this server where the transaction service stores log files for recovery. (string)
|  | waitForCommitOutcome : STRING
|  | Indicates whether the Transaction Manager should retry commit requests synchronously (true) or asynchronously (false) following a transient exception from a Resource Manager/remote partner. values(true, false) (string)

#### was.TransportChain

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Configure and manage transport chains which represent network protocol stacks that are operating within a client or server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Children
--- | --- | ---
|  | transportChannels : SET_OF_CI<was.TransportChannel >
|  | Specifies the settings for the transport channels that are part of transport chains. A transport chain is equivalent to a network protocol stack. A transport channel represents a single layer in that transport chain. Individual layers can be shared among several transport chains.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | enable : BOOLEAN = true
|  | Specifies whether this protocol stack starts when the server starts.
|  | portName : STRING
|  | Port to which the new transport chain will be bound.
|  | templateName : STRING = WebContainer
|  | Template from which the new transport chain will be created. If no template name is provided, the transport chain will be created based on the specified transport channel names. Usage of both properies 'templateName' and 'transportChannelNames' for creation is not valid.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,container,wasContainerTypes,type,templateName,portName,transportChannels,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 62
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/transport/create-modify-transport-chain.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 38
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/server/transport/destroy-transport-chain.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/transport/discover-inspect-transport-chain.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py, was/server/transport/transport-chain-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 62
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/transport/create-modify-transport-chain.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | NOT APPLICABLE
|  | overwriteExistingValues : BOOLEAN = false
|  | NOT APPLICABLE
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.TransportChainSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Configure and manage transport chains which represent network protocol stacks that are operating within a client or server.

|  | Children
--- | --- | ---
|  | transportChannels : SET_OF_CI<was.TransportChannelSpec >
|  | Specifies the settings for the transport channels that are part of transport chains. A transport chain is equivalent to a network protocol stack. A transport channel represents a single layer in that transport chain. Individual layers can be shared among several transport chains.

|  | Public Properties
--- | --- | ---
|  | enable : STRING
|  | Specifies whether this protocol stack starts when the server starts. (boolean) default(true)
|  | portName : STRING
|  | Port to which the new transport chain will be bound. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | templateName : STRING
|  | Template from which the new transport chain will be created. If no template name is provided, the transport chain will be created based on the specified transport channel names. Usage of both properies 'templateName' and 'transportChannelNames' for creation is not valid. (string) default(WebContainer)

#### was.TransportChannel

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Base class for all transport channel subtypes.

|  | Parent
--- | --- | ---
|  | container : CI<udm.EmbeddedDeployedContainer>
|  | The (embedded) deployed which contains this embedded deployed.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this transport channel.
|  | deployable : CI<udm.EmbeddedDeployable>
|  | The embedded deployable that this embedded deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,container,type,wasType,customProperties,deployable
|  | Additional Properties Not To Expose
|  | wasType : STRING = TransportChannel
|  | WebSphere admin resource type.

#### was.TransportChannelSpec

Virtual Type
Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployable, udm.ConfigurationItem

Base class for all transport channel subtypes.

|  | Public Properties
--- | --- | ---
|  | customProperties : MAP_STRING_STRING
|  | Specifies additional custom properties that you can configure for this transport channel.

#### was.URL

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies uniform resource locators (URLs), which point to electronically accessible resources, such as a directory file on a machine in a network or a document stored in a database.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | The JNDI name for the resource.
|  | provider : STRING = Default URL Provider
|  | Select the provider to support this resource object. Resource providers encapsulate the Java classes that WebSphere Application Server uses to instantiate the resource object.
|  | spec : STRING
|  | Specifies the complete string that comprises a URL.
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | providerType : STRING = URLProvider
|  | WebSphere admin resource provider type.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = URL
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.URLProvider

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the URL providers to access URL resources through different protocols.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | protocol : STRING
|  | Specifies the protocol that is supported by this stream handler. Protocol examples: NNTP, SMTP, and FTP.
|  | streamHandlerClassName : STRING
|  | Specifies the fully qualified name of a user-defined Java class that extends java.net.URLStreamHandler for a particular URL protocol, such as FTP.
|  | classpath : STRING
|  | A list of paths or JAR file names which together form the location for the resource provider classes. Class path entries are separated by using the ENTER key and must not contain path separator characters (such as ';' or ':'). Class paths can contain variable (symbolic) names that can be substituted using a variable map.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the resource adapter.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 59
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 41
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 59
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = URLProvider
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.URLProviderSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies the URL providers to access URL resources through different protocols.

|  | Public Properties
--- | --- | ---
|  | classpath : STRING
|  | A list of paths or JAR file names which together form the location for the resource provider classes. Class path entries are separated by using the ENTER key and must not contain path separator characters (such as ';' or ':'). Class paths can contain variable (symbolic) names that can be substituted using a variable map. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource. (map_string_string)
|  | description : STRING
|  | A description of the resource adapter. (string)
|  | protocol : STRING
|  | Specifies the protocol that is supported by this stream handler. Protocol examples: NNTP, SMTP, and FTP. (string)
|  | streamHandlerClassName : STRING
|  | Specifies the fully qualified name of a user-defined Java class that extends java.net.URLStreamHandler for a particular URL protocol, such as FTP. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.URLSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies uniform resource locators (URLs), which point to electronically accessible resources, such as a directory file on a machine in a network or a document stored in a database.

|  | Public Properties
--- | --- | ---
|  | category : STRING
|  | An optional category string to use when classifying or grouping the resource. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this J2C resource. (map_string_string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | jndiName : STRING
|  | The JNDI name for the resource. (string)
|  | provider : STRING
|  | Select the provider to support this resource object. Resource providers encapsulate the Java classes that WebSphere Application Server uses to instantiate the resource object. (string) default(Default URL Provider)
|  | spec : STRING
|  | Specifies the complete string that comprises a URL. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.UnmanagedServer

Type Hierarchy | was.BaseCell >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces | was.WasAppContainer, udm.Taggable, python.PythonManagingContainer, was.HealthPolicyMembershipContainer, was.Server, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, was.Cell, was.Node, udm.Container, overthere.HostContainer

An unmanaged WebSphere Applicaton Server (WAS Base/SA)

|  | Parent
--- | --- | ---
|  | host : CI<overthere.Host>
|  | Host on which the WAS server runs

|  | Children
--- | --- | ---
|  | webServers : SET_OF_CI<was.ManagedWebServer >
|  | WebSphere web servers in the node

|  | Public Properties
--- | --- | ---
|  | cellName : STRING
|  | Name of the WebSphere cell, e.g. MyCell, WASCell, Cell01
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | Restart strategy used when deploying. Valid values are: NONE,STOP_START,RESTART. For example, if STOP_START strategy is used container will be stopped before deployment and started after the deployment. If RESTART strategy is used deployment will be executed, then container will be restarted using restart script - if there is no restart script defined deployment will be executed than container will be stopped and immediately started. Please note that it's probably better to use property containerRestartStrategy defined on was.Module and it's subtypes.
|  | nodeName : STRING
|  | Name of the WebSphere node
|  | port : INTEGER
|  | TCP port which is used to login to the WebSphere Administration, defaults to 8880 for SA, 8879 for ND. Value of '0' has special meaning: it'used to suppress passing '-port' argument to wsadmin.
|  | version : ENUM [WAS_61, WAS_70, WAS_80, WAS_85]
|  | Version of WebSphere Application Server.
|  | wasHome : STRING
|  | Path to the WebSphere profile or deployment manager profile, where bin/wsadmin can be found. For example, /opt/ws/6.1/appserver/profiles/AppSrv01
|  | hostname : STRING
|  | Hostname to which wsadmin should attempt to connect.
|  | password : STRING
|  | Password which is used to login to the WebSphere Administration.
|  | serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER]
|  | Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER
|  | tags : SET_OF_STRING
|  | If set, only deployables with the same tag will be automatically mapped to this container.
|  | unmanagedWebServers : LIST_OF_CI<was.UnmanagedWebServer >
|  | List of unmanaged web servers.
|  | updateGlobalPlugin : BOOLEAN
|  | If set, the global web server plugin configuration will be updated. The plugin configuration will be propagated to all unmanaged web servers.
|  | username : STRING
|  | Username which is used to login to the WebSphere Administration.

|  | Hidden Properties
--- | --- | ---
|  | deployedsToDiscover : SET_OF_STRING = [was.VirtualHost, was.SharedLibrary]
|  | Deployeds To Discover
|  | inspectScript : STRING = was/container/discover-inspect-topology.py
|  | Inspect script for Cell
|  | propagateGlobalPluginOrder : INTEGER = 82
|  | Propagate Global Plugin Order
|  | updateGlobalPluginOrder : INTEGER = 81
|  | Update Global Plugin Order
|  | updateGlobalPluginScript : STRING = was/container/generate-global-plugin.py
|  | Update Global Plugin Script
|  | configDirName : STRING = config
|  | Config directory name of WebSphere Application Server.
|  | libraryScripts : LIST_OF_STRING = [was/container/discover-inspect-topology-lib.py, was/container/container-lib.py]
|  | List of scripts to appended to runtime script
|  | runWithDaemon : BOOLEAN = true
|  | Set to true to execute commands with the Python daemon
|  | versionInfoNameField : STRING = Name
|  | Translated text of "Name" used to resolve version of WebSphere Application Server running in a non-English language.

#### was.UnmanagedWebServer

Interfaces | udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | host : CI<overthere.Host>
|  | The host on which the unmanaged web server resides.

|  | Public Properties
--- | --- | ---
|  | pluginConfigurationPath : STRING
|  | The directory into which the plugin-cfg.xml should be propagated (e.g. /opt/IBM/HTTPServer/Plugins/config/webserver1/plugin-cfg.xml).

#### was.V5DefaultQueue

Type Hierarchy | was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Queue destinations provided for point-to-point messaging by the internal WebSphere JMS provider. Use WebSphere Queue Destination administrative objects to manage queue destinations for the internal WebSphere JMS provider. NOTE: The queue name must also be added to the list of queue names in the configuration of the JMS server(s) where the queue is to be hosted.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-jms-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere JMS Provider
|  | JMS provider for V5 default queue.
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/modify-jms-object.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = WASQueue
|  | WAS config type of V5 default queue.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.V5DefaultQueueConnectionFactory

Type Hierarchy | was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a topic connection factory, which is used to create connections to the associated JMS provider of JMS queue destinations for point-to-point messaging. Use WebSphere queue connection factory administrative objects to manage queue connection factories for the internal WebSphere JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-jms-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere JMS Provider
|  | JMS provider for V5 default queue connection factory.
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/modify-jms-object.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = WASQueueConnectionFactory
|  | JMS type of V5 default queue connection factory.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.V5DefaultQueueConnectionFactorySpec

Type Hierarchy | jee.QueueConnectionFactorySpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a V5 default queue connection factory.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.V5DefaultQueueSpec

Type Hierarchy | jee.QueueSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a V5 default queue.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.V5DefaultTopic

Type Hierarchy | was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies the topic destinations for publish and subscribe messaging by the internal WebSphere JMS provider. Use WebSphere topic destination administrative objects to manage topic destinations for the internal WebSphere JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | topic : STRING
|  | String value used to identify the topic
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-jms-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere JMS Provider
|  | JMS provider for V5 default topic.
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/modify-jms-object.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = WASTopic
|  | WAS config type of V5 default topic.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.V5DefaultTopicConnectionFactory

Type Hierarchy | was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a topic connection factory, which is used to create connections to the associated JMS provider of JMS topic destinations for publish and subscribe messaging. Use WebSphere topic connection factory administrative objects to manage topic connection factories for the internal WebSphere JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/create-jms-object.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/discover-inspect-jms-objects.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere JMS Provider
|  | JMS provider for V5 default topic connection factory.
|  | libraryScripts : LIST_OF_STRING = [was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/modify-jms-object.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = WASTopicConnectionFactory
|  | WAS config type of V5 default topic connection factory.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.V5DefaultTopicConnectionFactorySpec

Type Hierarchy | jee.TopicConnectionFactorySpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a V5 default topic connection factory.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.V5DefaultTopicSpec

Type Hierarchy | jee.TopicSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a V5 default topic.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | topic : STRING
|  | String value used to identify the topic (string)

#### was.Variable

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Variables specify a level of indirection for some system-defined values

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description about this WebSphere variable
|  | overwrite : BOOLEAN = false
|  | If set, will replace the value of an existing variable of the same name. Otherwise, will fail if a variable of that name is already present.
|  | value : STRING
|  | Specifies the value of the WebSphere variable.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = name,overwrite
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/env/create-variable.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/env/destroy-variable.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/env/discover-inspect-variable.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/env/variable-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/env/modify-variable.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.VariableSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a WebSphere variable

|  | Public Properties
--- | --- | ---
|  | description : STRING
|  | Specifies the description about this WebSphere variable (string)
|  | overwrite : STRING
|  | If set, will replace the value of an existing variable of the same name. Otherwise, will fail if a variable of that name is already present. (boolean) default(false)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | value : STRING
|  | Specifies the value of the WebSphere variable. (string)

#### was.VirtualHost

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Virtual host with a unique set of Web access ports. Such a configuration lets a single host machine resemble multiple host machines. Each virtual host has a logical name and a list of one or more domain name system (DNS) aliases by which it is known.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | aliases : SET_OF_STRING
|  | Virtual host aliases - enter alias as: hostname:port.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.

|  | Hidden Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/virtualhost/create-virtual-host.py
|  | Python wsadmin script invoked to create a virtual host.
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/virtualhost/destroy-virtual-host.py
|  | Python wsadmin script invoked to destroy a virtual host.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 45
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/virtualhost/discover-inspect-virtual-host.py
|  | Python wsadmin script invoked to inspect a virtual host.
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | libraryScripts : LIST_OF_STRING
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.VirtualHostSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a virtual host.

|  | Public Properties
--- | --- | ---
|  | aliases : SET_OF_STRING
|  | Virtual host aliases - enter alias as: hostname:port. (set_of_string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.War

Type Hierarchy | jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Java EE WAR archive.

|  | Children
--- | --- | ---
|  | sessionManagers : SET_OF_CI<was.SessionManagerSpec >
|  | Specify the session manager options for the application and modules.
|  | webModules : SET_OF_CI<was.EmbeddedWebModuleSpec >
|  | Specify Web modules contained by this enterprise application.

|  | Public Properties
--- | --- | ---
|  | additionalInstallFlags : SET_OF_STRING
|  | The additional install flags to be passed to AdminApp.install (set_of_string)
|  | allowDispatchRemoteInclude : STRING
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism. (boolean)
|  | allowServiceRemoteInclude : STRING
|  | Specifies whether an application can service an include request from an application. (boolean)
|  | appEdition : STRING
|  | Edition used by this application. (string)
|  | applyRestartStrategyOnNoop : STRING
|  | When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
|  | asyncRequestDispatchType : STRING
|  | Enables asynchronous dispatching and specifies how to aggregate the content. (enum) values(DISABLED, SERVER_SIDE, CLIENT_SIDE) default(DISABLED)
|  | checksum : STRING
|  | The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|  | classloaderMode : STRING
|  | Specifies whether classes are loaded using the parent class loader before the application class loader. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | containerRestartStrategy : STRING
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container. (enum) values(NONE, STOP_START, RESTART) default(NONE)
|  | contextRoot : STRING
|  | Specifies the context root of the Web application (WAR). (string)
|  | createMBeansForResources : STRING
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
|  | disableJspRuntimeCompilation : STRING
|  | Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default). (string) default(No)
|  | drainageInterval : STRING
|  | Drainage interval in seconds. (integer) default(30)
|  | editionDescription : STRING
|  | Edition description used by this application. (string)
|  | enableDistribution : STRING
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution. (boolean) default(true)
|  | enableJspClassReloading : STRING
|  | Specify JSP reloading for Web modules. (boolean) default(true)
|  | excludeFileNamesRegex : STRING
|  | Regular expression that matches file names that must be excluded from scanning
|  | groupSize : STRING
|  | Specifies num of members in a cluster. (integer) default(1)
|  | isEdition : STRING
|  | Edition used by this application. (boolean) default(false)
|  | jdkSourceLevel : STRING
|  | Specify JDK source level. (string) default(15)
|  | jsfImplementation : STRING
|  | If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239). (string)
|  | jspClassPath : STRING
|  | Specify JSP precompiler classpath. (string) default(jspcp)
|  | jspReloadInterval : STRING
|  | The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set. (integer) default(10)
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT. (string)
|  | placeholders : SET_OF_STRING
|  | Placeholders detected in this artifact
|  | preCompileJsps : STRING
|  | Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files. (boolean) default(false)
|  | reloadEnabled : STRING
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application. (boolean)
|  | reloadInterval : STRING
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application. (integer)
|  | resetStrategy : STRING
|  | Indicates type of reset strategy. (enum) values(SOFT, HARD) default(SOFT)
|  | restartStrategy : STRING
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start. (enum) values(NONE, STOP, START, STOP_START) default(STOP_START)
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone. (map_string_string)
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping (map_string_string)
|  | rolloutStrategy : STRING
|  | Indicates type of rollout strategy. (enum) values(ATOMIC, GROUPED) default(GROUPED)
|  | scanPlaceholders : BOOLEAN = false
|  | Whether to scan this artifact for placeholders when it is imported
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application. (list_of_string)
|  | startingWeight : STRING
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useFullPackageNames : STRING
|  | Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'. (string) default(Yes)
|  | useMetadataFromBinaries : STRING
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application. (boolean)
|  | virtualHostName : STRING
|  | Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (string)
|  | warClassLoaderPolicy : STRING
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application. (enum) values(SINGLE, MULTIPLE)
|  | warClassloaderMode : STRING
|  | WAR-level class loader mode. (enum) values(PARENT_FIRST, PARENT_LAST)
|  | webServerNames : SET_OF_STRING
|  | Specify the Web servers as targets that serve as routers for requests to this application. (set_of_string)

|  | Hidden Properties
--- | --- | ---
|  | textFileNamesRegex : STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|  | Regular expression that matches file names of text files
|  | delimiters : STRING = {{ }}
|  | The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|  | fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
|  | A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

#### was.WarModule

Type Hierarchy | was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Artifact, was.ConfigurableModule, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

WAR with values configured for a deployment.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Children
--- | --- | ---
|  | sessionManagers : SET_OF_CI<was.SessionManager >
|  | Specify the session manager options for the application and modules.
|  | webModules : SET_OF_CI<was.EmbeddedWebModule >
|  | Specify Web modules contained by this enterprise application.

|  | Public Properties
--- | --- | ---
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | contextRoot : STRING
|  | Specifies the context root of the Web application (WAR).
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
|  | The additional install flags to be passed to AdminApp.install
|  | allowDispatchRemoteInclude : BOOLEAN
|  | Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
|  | allowServiceRemoteInclude : BOOLEAN
|  | Specifies whether an application can service an include request from an application.
|  | appEdition : STRING
|  | Edition used by this application.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
|  | Enables asynchronous dispatching and specifies how to aggregate the content.
|  | classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | Specifies whether classes are loaded using the parent class loader before the application class loader.
|  | createMBeansForResources : BOOLEAN
|  | Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | disableJspRuntimeCompilation : STRING = No
|  | Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default).
|  | drainageInterval : INTEGER = 30
|  | Drainage interval in seconds.
|  | editionDescription : STRING
|  | Edition description used by this application.
|  | enableDistribution : BOOLEAN = true
|  | Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
|  | enableJspClassReloading : BOOLEAN = true
|  | Specify JSP reloading for Web modules.
|  | groupSize : INTEGER = 1
|  | Specifies num of members in a cluster.
|  | isEdition : BOOLEAN = false
|  | Edition used by this application.
|  | jdkSourceLevel : STRING = 15
|  | Specify JDK source level.
|  | jsfImplementation : STRING
|  | If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239).
|  | jspClassPath : STRING = jspcp
|  | Specify JSP precompiler classpath.
|  | jspReloadInterval : INTEGER = 10
|  | The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set.
|  | moduleDestination : STRING
|  | Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
|  | placeholders : MAP_STRING_STRING
|  | A Map containing all the placeholders mapped to their values. Special values are or
|  | preCompileJsps : BOOLEAN = false
|  | Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
|  | reloadEnabled : BOOLEAN
|  | Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
|  | reloadInterval : INTEGER
|  | Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
|  | resetStrategy : ENUM [SOFT, HARD] = SOFT
|  | Indicates type of reset strategy.
|  | roleMappings : MAP_STRING_STRING
|  | Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
|  | roleUserMappings : MAP_STRING_STRING
|  | Security role to user mapping
|  | rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
|  | Indicates type of rollout strategy.
|  | sharedLibraries : SET_OF_CI<was.SharedLibrary >
|  | Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
|  | sharedLibraryNames : LIST_OF_STRING
|  | Shared libraries used by this application.
|  | startingWeight : INTEGER = 1
|  | Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
|  | useFullPackageNames : STRING = Yes
|  | Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'.
|  | useMetadataFromBinaries : BOOLEAN
|  | Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
|  | virtualHost : CI<was.VirtualHost >
|  | Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (DEPRECATED. Prefer using: virtualHostName)
|  | virtualHostName : STRING
|  | Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts.
|  | warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
|  | Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.
|  | warClassloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
|  | WAR-level class loader mode.
|  | webServerNames : SET_OF_STRING
|  | Specify the Web servers as targets that serve as routers for requests to this application.
|  | webServers : SET_OF_CI<was.ManagedWebServer >
|  | Specify the Web servers as targets that serve as routers for requests to this application. (DEPRECATED. Prefer using: webServerNames)

|  | Hidden Properties
--- | --- | ---
|  | createEditionedOrder : INTEGER = 10
|  | The order in which a create step for Editioned application will be executed(was85nd only).
|  | createOrder : INTEGER = 70
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/application/deploy-application.py
|  | Python wsadmin script invoked to create a Java EE artifact.
|  | createVerb : STRING = Deploy
|  | The word is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 30
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/application/undeploy-application.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Undeploy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/application/discover-inspect-war-module.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 70
|  | The order in which a modify step will be executed.
|  | modifyVerb : STRING = Update
|  | The word is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | retryAttemptsForAppReadyCheck : INTEGER = 6
|  | Number of retry attempts to check if an application has been distributed before attempting the application start.
|  | rolloutEditionedOrder : INTEGER = 20
|  | The order in which a rollout step will be executed.
|  | rolloutEditionedScript : STRING = was/application/rollout-edition.py
|  | Python wsadmin script invoked to perform rollout.
|  | rolloutEditionedVerb : STRING = Rollout
|  | The word that is used to prefix a step description for the rollout operation.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 90
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 10
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 75
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 35
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 75
|  | The order in which a synchronize after modify step will be executed.
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | modifyScript : STRING
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING = was/application/start-application.py
|  | Python wsadmin script invoked to start running a Java EE artifact.
|  | stopScript : STRING = was/application/stop-application.py
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WebContainer

Type Hierarchy | was.ServerConfigurationResource >> was.ConfigurationResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Configure and manage the EJB container of this application server.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | allowAsyncRequestDispatching : STRING
|  | Allows applications installed on this server to use Asynchronous Request Dispatching. Available since WAS7. Default WAS value is 'false'. values(true, false)
|  | asyncIncludeTimeout : INTEGER
|  | Default timeout in milliseconds for asynchronous includes to complete. Available since WAS7. Default WAS value is '60000'.
|  | asyncRunnableWorkManager : STRING
|  | Specifies which work manager to use via their configured JNDI name. Used only if work manager is selected to start runnable objects. Available since WAS8. Default WAS value is 'wm/default'.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service.
|  | defaultAsyncServletTimeout : INTEGER
|  | Specifies the default timeout in milliseconds for async servlet operations per server. Value of '0' will disable timeout. Available since WAS8. Default WAS value is '30000'.
|  | defaultVirtualHostName : STRING
|  | Specifies the default virtual host for this server. Default WAS value is 'default_host'.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | disablePooling : STRING
|  | Specifies whether servlet request and response pooling is disabled. Default WAS value is 'false'. values(true, false)
|  | enableServletCaching : STRING
|  | Specifies whether servlet caching is enabled. Default WAS value is 'false'. values(true, false)
|  | maximumPercentageExpiredEntries : INTEGER
|  | Maximum percentage of expired response versus total response in one minute before switching to synchronous requests. Available since WAS7. Default WAS value is '15'.
|  | maximumResponseStoreSize : INTEGER
|  | Maximum size of store for client side requests in megabytes. Available since WAS7. Default WAS value is '100'.
|  | numberAsyncTimerThreads : INTEGER
|  | Specifies how many threads are available to handle any async servlet timeout operations per server. Available since WAS8. Default WAS value is '2'.
|  | overwriteExistingCustomProperties : BOOLEAN = false
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties.
|  | overwriteExistingValues : BOOLEAN = false
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is.
|  | sessionAffinityFailoverServer : STRING
|  | When WLM is utilized and a server of a server group is down, WLM normally routes requests with affinity to the down server to another random server within the server group. This field allows an administrator to specify the name of a server within the server group that affinity requests will route to, instead of using random server selection.
|  | sessionAffinityTimeout : INTEGER
|  | When non-zero, WebSphere will be able to switch the HTTP session affinity for requests to a different server instance after the specifed time period has elapsed. In certain situations, this can improve load balancing performance. Default WAS value is '0'.
|  | useAsyncRunnableWorkManager : STRING
|  | If true, will use an Asynchronous Beans Work Manager. It propagates any context configured for the selected work manager. If 'false', will use the same thread pool that the request originated on. It will not propagate any context from the original request. Default is 'true'. Available since WAS8. values(true, false)

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = id,name,wasType,wasContainerTypes,defaultDiscoverName,customProperties,overwriteExistingValues,overwriteExistingCustomProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Configure
|  | The word that is used to prefix a step description for the create operation.
|  | defaultDiscoverName : STRING = WebContainer
|  | Default deployed name to be assigned to the CI when discovered.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/server/discover-inspect-config-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/server/config-resource-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/server/modify-config-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Configure
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasContainerTypes : SET_OF_STRING = [Server]
|  | List of container types on which the resource should be discovered.
|  | wasType : STRING = WebContainer
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | destroyScript : STRING
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WebContainerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Configure and manage the Web container of this application server.

|  | Public Properties
--- | --- | ---
|  | allowAsyncRequestDispatching : STRING
|  | Allows applications installed on this server to use Asynchronous Request Dispatching. Available since WAS7. Default WAS value is 'false'. values(true, false) (string)
|  | asyncIncludeTimeout : STRING
|  | Default timeout in milliseconds for asynchronous includes to complete. Available since WAS7. Default WAS value is '60000'. (integer)
|  | asyncRunnableWorkManager : STRING
|  | Specifies which work manager to use via their configured JNDI name. Used only if work manager is selected to start runnable objects. Available since WAS8. Default WAS value is 'wm/default'. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this service. (map_string_string)
|  | defaultAsyncServletTimeout : STRING
|  | Specifies the default timeout in milliseconds for async servlet operations per server. Value of '0' will disable timeout. Available since WAS8. Default WAS value is '30000'. (integer)
|  | defaultVirtualHostName : STRING
|  | Specifies the default virtual host for this server. Default WAS value is 'default_host'. (string)
|  | disablePooling : STRING
|  | Specifies whether servlet request and response pooling is disabled. Default WAS value is 'false'. values(true, false) (string)
|  | enableServletCaching : STRING
|  | Specifies whether servlet caching is enabled. Default WAS value is 'false'. values(true, false) (string)
|  | maximumPercentageExpiredEntries : STRING
|  | Maximum percentage of expired response versus total response in one minute before switching to synchronous requests. Available since WAS7. Default WAS value is '15'. (integer)
|  | maximumResponseStoreSize : STRING
|  | Maximum size of store for client side requests in megabytes. Available since WAS7. Default WAS value is '100'. (integer)
|  | numberAsyncTimerThreads : STRING
|  | Specifies how many threads are available to handle any async servlet timeout operations per server. Available since WAS8. Default WAS value is '2'. (integer)
|  | overwriteExistingCustomProperties : STRING
|  | When set to true, existing custom properties will be overwritten by the entries specified in the deployed CI. When false, new CI entries will be appended to the existing custom properties. (boolean) default(false)
|  | overwriteExistingValues : STRING
|  | When set to true, all not specified properties of the CI will be reset to WAS default values (or empty lists in case of custom properties). Otherwise, only the provided properties will be set; properties not specified in the deployed CI will be left as-is. (boolean) default(false)
|  | sessionAffinityFailoverServer : STRING
|  | When WLM is utilized and a server of a server group is down, WLM normally routes requests with affinity to the down server to another random server within the server group. This field allows an administrator to specify the name of a server within the server group that affinity requests will route to, instead of using random server selection. (string)
|  | sessionAffinityTimeout : STRING
|  | When non-zero, WebSphere will be able to switch the HTTP session affinity for requests to a different server instance after the specifed time period has elapsed. In certain situations, this can improve load balancing performance. Default WAS value is '0'. (integer)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | useAsyncRunnableWorkManager : STRING
|  | If true, will use an Asynchronous Beans Work Manager. It propagates any context configured for the selected work manager. If 'false', will use the same thread pool that the request originated on. It will not propagate any context from the original request. Default is 'true'. Available since WAS8. values(true, false) (string)

#### was.WmqActivationSpecification

Type Hierarchy | was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a WMQ Activation Specification. Resource valid only with WAS 7.0 and later application servers.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | destinationJndiName : STRING
|  | The JNDI name of a WebSphere MQ messaging provider destination. When an MDB is deployed with this activation specification, it is this destination that messages for the MDB will be consumed from.
|  | jndiName : STRING
|  | The JNDI name for the resource.
|  | authAlias : STRING
|  | Specifies the alias used to bind the J2C activation specification to an authentication alias (configured through the security JAAS screens).
|  | brokerCCDurSubQueue : STRING = SYSTEM.JMS.D.CC.SUBSCRIBER.QUEUE
|  | The name of the queue from which a connection consumer receives durable subscription messages.
|  | brokerCCSubQueue : STRING = SYSTEM.JMS.ND.CC.SUBSCRIBER.QUEUE
|  | The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer.
|  | brokerCtrlQueue : STRING = SYSTEM.BROKER.CONTROL.QUEUE
|  | The broker control queue to use if subscribing to a topic.
|  | brokerQmgr : STRING
|  | The name of the queue manager on which the broker is running.
|  | brokerSubQueue : STRING = SYSTEM.JMS.ND.SUBSCRIBER.QUEUE
|  | The queue to use for obtaining subscription messages if subscribing to a topic.
|  | brokerVersion : INTEGER = 1
|  | The version of the broker being used. Values: '1'(default), '2'.
|  | ccdtQmgrName : STRING
|  | A queue manager name, used to select one or more entries from a client channel definition table.
|  | ccdtUrl : STRING
|  | A URL to a client channel definition table to use, for this activation specification, when contacting WebSphere MQ.
|  | ccsid : STRING = 819
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII).
|  | cleanupInterval : INTEGER = 3600000
|  | The interval between background executions of the publish/subscribe cleanup utility.
|  | cleanupLevel : ENUM [SAFE, NONE, STRONG, FORCE, NONDUR] = SAFE
|  | Cleanup Level for BROKER or MIGRATE Subscription Stores.
|  | clientId : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager.
|  | clonedSubs : STRING = DISABLED
|  | Whether two or more instances of the same durable topic subscriber can run simultaneously. Values: 'DISABLED'(default), 'ENABLED'.
|  | compressHeaders : ENUM [NONE, SYSTEM] = NONE
|  | Determines if message headers are compressed or not.
|  | compressPayload : ENUM [NONE, RLE, ZLIBFAST, ZLIBHIGH] = NONE
|  | The compression algorithm to use to compress message payloads.
|  | connectionNameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_70.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ Activation Spec.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | A description of the activation specification.
|  | destinationType : STRING = javax.jms.Queue
|  | Determines whether the destination is expected to be a queue or a topic type destination. Values: 'javax.jms.Queue', 'javax.jms.Topic'.
|  | failIfQuiescing : BOOLEAN = true
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state.
|  | failureDeliveryCount : INTEGER = 0
|  | The number of sequential delivery failures that are allowed before the endpoint is suspended.
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection.
|  | maxPoolSize : INTEGER = 10
|  | The maximum number of server sessions in the server session pool used by the connection consumer.
|  | messageSelector : STRING
|  | A message selector expression specifying which messages are to be delivered.
|  | msgRetention : ENUM [YES, NO] = YES
|  | Determines whether or not the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means that the messages are disposed of as per their disposition options.
|  | msgSelection : ENUM [CLIENT, BROKER] = CLIENT
|  | Determines where message selection is performed.
|  | poolTimeout : INTEGER = 300000
|  | The period of time, in milliseconds, that an unused server session is held open in the server session pool before being closed due to inactivity.
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager.
|  | qmgrHostname : STRING = localhost
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ.
|  | qmgrName : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages.
|  | qmgrPortNumber : INTEGER = 1414
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only.
|  | qmgrSvrconnChannel : STRING = SYSTEM.DEF.SVRCONN
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ.
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names.
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit.
|  | rescanInterval : INTEGER = 5000
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues.
|  | secExit : STRING
|  | The security exit class name.
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit.
|  | sendExit : STRING
|  | A comma separate list of send exit class names.
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit.
|  | sparseSubs : BOOLEAN
|  | Specifies whether the user anticipates that resource will receive a high proportion messages that match its selection criteria. This information can be used to optimize message delivery.
|  | sslConfiguration : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager.
|  | sslCrl : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ.
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate.
|  | sslResetCount : INTEGER = 0
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session.
|  | sslType : ENUM [CENTRAL, SPECIFIC, NONE] = NONE
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group.
|  | startTimeout : INTEGER = 10000
|  | The period of time, in milliseconds, within which delivery of a message to an MDB must start after the work to deliver the message has been scheduled. If this period of time elapses, the message is rolled back onto the queue.
|  | stateRefreshInt : INTEGER = 60000
|  | The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore parameter has the value QUEUE.
|  | stopEndpointIfDeliveryFails : BOOLEAN = true
|  | Indicates whether the endpoint should be stopped if message delivery fails the number of times specified by the failureDeliveryCount property.
|  | subStore : ENUM [MIGRATE, QUEUE, BROKER] = MIGRATE
|  | Where WebSphere MQ JMS should store persistent data relating to active subscriptions.
|  | subscriptionDurability : STRING = Nondurable
|  | Whether a durable or nondurable subscription is used to deliver messages to an MDB subscribing to the topic. Values: 'Nondurable'(default), 'Durable'.
|  | subscriptionName : STRING
|  | The name of the durable subscription.
|  | wildcardFormat : STRING = Char
|  | Determines which sets of characters are interpreted as topic wildcards. Values: 'Char'(default), 'Topic'.
|  | wmqTransportType : ENUM [BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT] = BINDINGS_THEN_CLIENT
|  | Determines the manner in which a connection will be established to WebSphere MQ.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-activation-spec.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/wmq/destroy-wmq-activation-spec.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-activation-spec.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-activation-spec-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-activation-spec.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqActivationSpecificationSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a WMQ Activation Specification. Resource valid only with WAS 7.0 and later application servers.

|  | Public Properties
--- | --- | ---
|  | authAlias : STRING
|  | Specifies the alias used to bind the J2C activation specification to an authentication alias (configured through the security JAAS screens). (string)
|  | brokerCCDurSubQueue : STRING
|  | The name of the queue from which a connection consumer receives durable subscription messages. (string) default(SYSTEM.JMS.D.CC.SUBSCRIBER.QUEUE)
|  | brokerCCSubQueue : STRING
|  | The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer. (string) default(SYSTEM.JMS.ND.CC.SUBSCRIBER.QUEUE)
|  | brokerCtrlQueue : STRING
|  | The broker control queue to use if subscribing to a topic. (string) default(SYSTEM.BROKER.CONTROL.QUEUE)
|  | brokerQmgr : STRING
|  | The name of the queue manager on which the broker is running. (string)
|  | brokerSubQueue : STRING
|  | The queue to use for obtaining subscription messages if subscribing to a topic. (string) default(SYSTEM.JMS.ND.SUBSCRIBER.QUEUE)
|  | brokerVersion : STRING
|  | The version of the broker being used. Values: '1'(default), '2'. (integer) default(1)
|  | ccdtQmgrName : STRING
|  | A queue manager name, used to select one or more entries from a client channel definition table. (string)
|  | ccdtUrl : STRING
|  | A URL to a client channel definition table to use, for this activation specification, when contacting WebSphere MQ. (string)
|  | ccsid : STRING
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII). (string) default(819)
|  | cleanupInterval : STRING
|  | The interval between background executions of the publish/subscribe cleanup utility. (integer) default(3600000)
|  | cleanupLevel : STRING
|  | Cleanup Level for BROKER or MIGRATE Subscription Stores. (enum) values(SAFE, NONE, STRONG, FORCE, NONDUR) default(SAFE)
|  | clientId : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager. (string)
|  | clonedSubs : STRING
|  | Whether two or more instances of the same durable topic subscriber can run simultaneously. Values: 'DISABLED'(default), 'ENABLED'. (string) default(DISABLED)
|  | compressHeaders : STRING
|  | Determines if message headers are compressed or not. (enum) values(NONE, SYSTEM) default(NONE)
|  | compressPayload : STRING
|  | The compression algorithm to use to compress message payloads. (enum) values(NONE, RLE, ZLIBFAST, ZLIBHIGH) default(NONE)
|  | connectionNameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_70. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ Activation Spec. (map_string_string)
|  | description : STRING
|  | A description of the activation specification. (string)
|  | destinationJndiName : STRING
|  | The JNDI name of a WebSphere MQ messaging provider destination. When an MDB is deployed with this activation specification, it is this destination that messages for the MDB will be consumed from. (string)
|  | destinationType : STRING
|  | Determines whether the destination is expected to be a queue or a topic type destination. Values: 'javax.jms.Queue', 'javax.jms.Topic'. (string) default(javax.jms.Queue)
|  | failIfQuiescing : STRING
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state. (boolean) default(true)
|  | failureDeliveryCount : STRING
|  | The number of sequential delivery failures that are allowed before the endpoint is suspended. (integer) default(0)
|  | jndiName : STRING
|  | The JNDI name for the resource. (string)
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection. (string)
|  | maxPoolSize : STRING
|  | The maximum number of server sessions in the server session pool used by the connection consumer. (integer) default(10)
|  | messageSelector : STRING
|  | A message selector expression specifying which messages are to be delivered. (string)
|  | msgRetention : STRING
|  | Determines whether or not the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means that the messages are disposed of as per their disposition options. (enum) values(YES, NO) default(YES)
|  | msgSelection : STRING
|  | Determines where message selection is performed. (enum) values(CLIENT, BROKER) default(CLIENT)
|  | poolTimeout : STRING
|  | The period of time, in milliseconds, that an unused server session is held open in the server session pool before being closed due to inactivity. (integer) default(300000)
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager. (string)
|  | qmgrHostname : STRING
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ. (string) default(localhost)
|  | qmgrName : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages. (string)
|  | qmgrPortNumber : STRING
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only. (integer) default(1414)
|  | qmgrSvrconnChannel : STRING
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ. (string) default(SYSTEM.DEF.SVRCONN)
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names. (string)
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit. (string)
|  | rescanInterval : STRING
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues. (integer) default(5000)
|  | secExit : STRING
|  | The security exit class name. (string)
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit. (string)
|  | sendExit : STRING
|  | A comma separate list of send exit class names. (string)
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit. (string)
|  | sparseSubs : STRING
|  | Specifies whether the user anticipates that resource will receive a high proportion messages that match its selection criteria. This information can be used to optimize message delivery. (boolean)
|  | sslConfiguration : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager. (string)
|  | sslCrl : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ. (string)
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate. (string)
|  | sslResetCount : STRING
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session. (integer) default(0)
|  | sslType : STRING
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group. (enum) values(CENTRAL, SPECIFIC, NONE) default(NONE)
|  | startTimeout : STRING
|  | The period of time, in milliseconds, within which delivery of a message to an MDB must start after the work to deliver the message has been scheduled. If this period of time elapses, the message is rolled back onto the queue. (integer) default(10000)
|  | stateRefreshInt : STRING
|  | The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore parameter has the value QUEUE. (integer) default(60000)
|  | stopEndpointIfDeliveryFails : STRING
|  | Indicates whether the endpoint should be stopped if message delivery fails the number of times specified by the failureDeliveryCount property. (boolean) default(true)
|  | subStore : STRING
|  | Where WebSphere MQ JMS should store persistent data relating to active subscriptions. (enum) values(MIGRATE, QUEUE, BROKER) default(MIGRATE)
|  | subscriptionDurability : STRING
|  | Whether a durable or nondurable subscription is used to deliver messages to an MDB subscribing to the topic. Values: 'Nondurable'(default), 'Durable'. (string) default(Nondurable)
|  | subscriptionName : STRING
|  | The name of the durable subscription. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | wildcardFormat : STRING
|  | Determines which sets of characters are interpreted as topic wildcards. Values: 'Char'(default), 'Topic'. (string) default(Char)
|  | wmqTransportType : STRING
|  | Determines the manner in which a connection will be established to WebSphere MQ. (enum) values(BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT) default(BINDINGS_THEN_CLIENT)

#### was.WmqConnectionFactory

Virtual Type
Type Hierarchy | was.JmsConnectionFactory >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | CCSID : INTEGER = 819
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII)
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | ccdtUrl : STRING
|  | A Uniform Resource Locator (URL) that identifies the name and location of the file containing the client channel definition table and specifies how the file can be accessed.
|  | channel : STRING
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ.
|  | clientID : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager.
|  | clientReconnectOptions : ENUM [DISABLED, ASDEF, QMGR, RECONNECT] = DISABLED
|  | Specifies whether a client mode connection reconnects automatically or not in the event of a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Not supported for: WAS_61, WAS_70.
|  | clientReconnectTimeout : INTEGER = 1800
|  | The maximum amount of time, in seconds, that a client mode connection will spend attempting to automatically reconnect to a queue manager after a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Whether this parameter is used or not depends on the value of the client reconnect options parameter. Not supported for: WAS_61, WAS_70.
|  | compressHeaders : ENUM [NONE, SYSTEM] = NONE
|  | Determines if message headers are compressed or not. Not supported for: WAS_61.
|  | compressPayload : ENUM [NONE, RLE, ZLIBFAST, ZLIBHIGH] = NONE
|  | The compression algorithm to use to compress message payloads. Not supported for: WAS_61.
|  | connameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_61, WAS_70.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | failIfQuiesce : BOOLEAN = true
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state.
|  | host : STRING
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ.
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | maxBatchSize : INTEGER = 10
|  | The maximum number of messages to remove from a queue before at least one must be delivered to an asynchronous consumer. Not supported for: WAS_61.
|  | pollingInterval : INTEGER = 5000
|  | How long to wait for a message to turn up on the queue currently being polled before moving to another queue when receiving messages asynchronously from multiple queues. This is only applicable in the client container.
|  | port : INTEGER = 0
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only.
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager. Not supported for: WAS_61.
|  | qmgrType : ENUM [QMGR, QSG] = QMGR
|  | Type of queue manager.
|  | queueManager : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages.
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names. Not supported for: WAS_61.
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit. Not supported for: WAS_61.
|  | rescanInterval : INTEGER = 5000
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues.
|  | secExit : STRING
|  | The security exit class name. Not supported for: WAS_61.
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit. Not supported for: WAS_61.
|  | sendExit : STRING
|  | A comma separate list of send exit class names. Not supported for: WAS_61.
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit. Not supported for: WAS_61.
|  | sslCRL : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ.
|  | sslCipherSuite : STRING
|  | The cipher suite to use for SSL connection.
|  | sslConfigurationName : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager. Not supported for: WAS_61.
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate.
|  | sslResetCount : INTEGER = 0
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session. Not supported for: WAS_61.
|  | sslType : ENUM [CENTRAL, SPECIFIC, NONE] = NONE
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group. Not supported for: WAS_61.
|  | tempModel : STRING = SYSTEM.DEFAULT.MODEL.QUEUE
|  | The model queue that is used as a basis for temporary queue creation.
|  | transportType : ENUM [BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT] = BINDINGS
|  | Determines the manner in which a connection will be established to WebSphere MQ.
|  | useConnectionPooling : BOOLEAN = true
|  | Set the use of ConnectionPooling in earlier versions of the WebSphere MQ classes for JMS. This method is retained for compatibility with older MQJMS applications, but, because this Connection Pooling functionality has been removed from version 7, setting this property will have no effect.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-connection-factory.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere MQ JMS Provider
|  | JMS provider for WebSphere MQ queue connection factory.
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-connection-factory-lib.py, was/jms/jms-connection-factory-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-connection-factory.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqDestination

Virtual Type
Type Hierarchy | was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Description unavailable

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | JNDI name for the resource
|  | CCSID : INTEGER = 1208
|  | The character set used to for encoding strings in messages sent to this destination. Default value is 1208 (UTF-8).
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | decimalEncoding : ENUM [Normal, Reversed] = Normal
|  | If native encoding is not enabled, select the type of decimal encoding.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies a description for the resource.
|  | expiry : ENUM [APPLICATION_DEFINED, SPECIFIED, UNLIMITED] = APPLICATION_DEFINED
|  | Indicates whether the expiry timeout for this queue is defined by the application or the Specified expiry property, or whether messages on the queue do not expire.
|  | floatingPointEncoding : ENUM [IEEENormal, IEEEReversed, S390] = IEEENormal
|  | If native encoding is not enabled, select the type of floating point encoding.
|  | integerEncoding : ENUM [Normal, Reversed] = Normal
|  | If native encoding is not enabled, select the type of integer encoding.
|  | messageBody : STRING = UNSPECIFIED
|  | Specifies whether an application processes the RFH version 2 header of a WebSphere MQ message as part of the JMS message body. Values: 'JMS', 'MQ' and 'UNSPECIFIED'(default). Not supported for: WAS_61, WAS_70.
|  | mqmdMessageContext : STRING = DEFAULT
|  | Defines the message context options specified when sending messages to a destination. Values: 'DEFAULT'(default), 'SET_ALL_CONTEXT', 'SET_IDENTITY_CONTEXT'. Not supported for: WAS_61, WAS_70, WAS_80.
|  | mqmdReadEnabled : BOOLEAN = false
|  | Specifies whether an application can read the values of MQMD fields from JMS messages that have been sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80.
|  | mqmdWriteEnabled : BOOLEAN = false
|  | Specifies whether an application can write the values of MQMD fields to JMS messages that will be sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80.
|  | persistence : ENUM [APPLICATION_DEFINED, HIGH, NONPERSISTENT, PERSISTENT, QUEUE_DEFINED] = APPLICATION_DEFINED
|  | Sets the level of persistence used for sending messages to this queue.
|  | priority : ENUM [APPLICATION_DEFINED, SPECIFIED, QUEUE_DEFINED] = APPLICATION_DEFINED
|  | The priority assigned to messages sent to this queue.
|  | readAhead : ENUM [QUEUE_DEFINED, YES, NO] = QUEUE_DEFINED
|  | Determines if messages for non-persistent consumers are sent to the client before the client requests them. Not supported for: WAS_61.
|  | readAheadClose : STRING = DELIVERALL
|  | Determines what happens if a read ahead consumer is closed. Values: 'DELIVERALL'(default) and 'DELIVERCURRENT'. Not supported for: WAS_61.
|  | replyToStyle : STRING = DEFAULT
|  | Specifies how the JMSReplyTo header field in a WebSphere MQ messaging provider message is generated. Values: 'DEFAULT'(default), 'MQMD', 'RFH2'. Not supported for: WAS_61, WAS_70.
|  | sendAsync : ENUM [QUEUE_DEFINED, YES, NO] = QUEUE_DEFINED
|  | Determines whether the queue manager acknowledges receipt of messages sent to it. Not supported for: WAS_61.
|  | specifiedExpiry : INTEGER = 0
|  | If the Expiry timeout property is set to specified, you must type the number of milliseconds (greater than 0) after which messages on this queue expire.
|  | specifiedPriority : INTEGER = 0
|  | If the priority property is set to specified, you must type the message priority for this queue, using the range 0 through 9.
|  | targetClient : ENUM [JMS, MQ] = JMS
|  | Indicates whether the receiving application is JMS-compliant or is a traditional WebSphere MQ application. Values: JMS (default), MQ.
|  | useNativeEncoding : BOOLEAN = true
|  | Use native encodings.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-queue.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-queue.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere MQ JMS Provider
|  | JMS provider for WebSphere MQ queue.
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-object-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-queue.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqQueue

Type Hierarchy | was.WmqDestination >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Queue destinations provided for point-to-point messaging by the WebSphere MQ JMS provider. Use WebSphere MQ queue destination administrative objects to manage queue destinations for the WebSphere MQ JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | baseQueueName : STRING
|  | Name of the queue to which messages are sent.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | CCSID : INTEGER = 1208
|  | The character set used to for encoding strings in messages sent to this destination. Default value is 1208 (UTF-8).
|  | baseQueueManagerName : STRING
|  | The name of the WebSphere MQ queue manager or queue sharing group where the queue resides.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | decimalEncoding : ENUM [Normal, Reversed] = Normal
|  | If native encoding is not enabled, select the type of decimal encoding.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies a description for the resource.
|  | expiry : ENUM [APPLICATION_DEFINED, SPECIFIED, UNLIMITED] = APPLICATION_DEFINED
|  | Indicates whether the expiry timeout for this queue is defined by the application or the Specified expiry property, or whether messages on the queue do not expire.
|  | floatingPointEncoding : ENUM [IEEENormal, IEEEReversed, S390] = IEEENormal
|  | If native encoding is not enabled, select the type of floating point encoding.
|  | integerEncoding : ENUM [Normal, Reversed] = Normal
|  | If native encoding is not enabled, select the type of integer encoding.
|  | messageBody : STRING = UNSPECIFIED
|  | Specifies whether an application processes the RFH version 2 header of a WebSphere MQ message as part of the JMS message body. Values: 'JMS', 'MQ' and 'UNSPECIFIED'(default). Not supported for: WAS_61, WAS_70.
|  | mqmdMessageContext : STRING = DEFAULT
|  | Defines the message context options specified when sending messages to a destination. Values: 'DEFAULT'(default), 'SET_ALL_CONTEXT', 'SET_IDENTITY_CONTEXT'. Not supported for: WAS_61, WAS_70, WAS_80.
|  | mqmdReadEnabled : BOOLEAN = false
|  | Specifies whether an application can read the values of MQMD fields from JMS messages that have been sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80.
|  | mqmdWriteEnabled : BOOLEAN = false
|  | Specifies whether an application can write the values of MQMD fields to JMS messages that will be sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80.
|  | password : STRING
|  | The password, used with the user name property, for authentication when connecting to the queue manager to define the queue destination.
|  | persistence : ENUM [APPLICATION_DEFINED, HIGH, NONPERSISTENT, PERSISTENT, QUEUE_DEFINED] = APPLICATION_DEFINED
|  | Sets the level of persistence used for sending messages to this queue.
|  | priority : ENUM [APPLICATION_DEFINED, SPECIFIED, QUEUE_DEFINED] = APPLICATION_DEFINED
|  | The priority assigned to messages sent to this queue.
|  | queueManagerHost : STRING
|  | The name of the host for the queue manager on which the queue destination is created.
|  | queueManagerPort : INTEGER = 1414
|  | The number of the port used by the queue manager on which this queue is defined.
|  | readAhead : ENUM [QUEUE_DEFINED, YES, NO] = QUEUE_DEFINED
|  | Determines if messages for non-persistent consumers are sent to the client before the client requests them. Not supported for: WAS_61.
|  | readAheadClose : STRING = DELIVERALL
|  | Determines what happens if a read ahead consumer is closed. Values: 'DELIVERALL'(default) and 'DELIVERCURRENT'. Not supported for: WAS_61.
|  | replyToStyle : STRING = DEFAULT
|  | Specifies how the JMSReplyTo header field in a WebSphere MQ messaging provider message is generated. Values: 'DEFAULT'(default), 'MQMD', 'RFH2'. Not supported for: WAS_61, WAS_70.
|  | sendAsync : ENUM [QUEUE_DEFINED, YES, NO] = QUEUE_DEFINED
|  | Determines whether the queue manager acknowledges receipt of messages sent to it. Not supported for: WAS_61.
|  | serverConnectionChannelName : STRING
|  | The name of the channel to use to connect to the queue manager.
|  | specifiedExpiry : INTEGER = 0
|  | If the Expiry timeout property is set to specified, you must type the number of milliseconds (greater than 0) after which messages on this queue expire.
|  | specifiedPriority : INTEGER = 0
|  | If the priority property is set to specified, you must type the message priority for this queue, using the range 0 through 9.
|  | targetClient : ENUM [JMS, MQ] = JMS
|  | Indicates whether the receiving application is JMS-compliant or is a traditional WebSphere MQ application. Values: JMS (default), MQ.
|  | useNativeEncoding : BOOLEAN = true
|  | Use native encodings.
|  | userName : STRING
|  | The user ID used, with the password property, for authentication when connecting to the queue manager to define the queue destination.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-queue.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-queue.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere MQ JMS Provider
|  | JMS provider for WebSphere MQ queue.
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-object-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-queue.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = MQQueue
|  | WAS config type of WebSphere MQ queue.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqQueueConnectionFactory

Type Hierarchy | was.WmqConnectionFactory >> was.JmsConnectionFactory >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Queue connection factory is used to create connections to the associated JMS provider of JMS queue destinations, for point-to-point messaging. Use WebSphere MQ queue connection factory administrative objects to manage queue connection factories for the WebSphere MQ JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | CCSID : INTEGER = 819
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII)
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | ccdtUrl : STRING
|  | A Uniform Resource Locator (URL) that identifies the name and location of the file containing the client channel definition table and specifies how the file can be accessed.
|  | channel : STRING
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ.
|  | clientID : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager.
|  | clientReconnectOptions : ENUM [DISABLED, ASDEF, QMGR, RECONNECT] = DISABLED
|  | Specifies whether a client mode connection reconnects automatically or not in the event of a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Not supported for: WAS_61, WAS_70.
|  | clientReconnectTimeout : INTEGER = 1800
|  | The maximum amount of time, in seconds, that a client mode connection will spend attempting to automatically reconnect to a queue manager after a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Whether this parameter is used or not depends on the value of the client reconnect options parameter. Not supported for: WAS_61, WAS_70.
|  | compressHeaders : ENUM [NONE, SYSTEM] = NONE
|  | Determines if message headers are compressed or not. Not supported for: WAS_61.
|  | compressPayload : ENUM [NONE, RLE, ZLIBFAST, ZLIBHIGH] = NONE
|  | The compression algorithm to use to compress message payloads. Not supported for: WAS_61.
|  | connameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_61, WAS_70.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | failIfQuiesce : BOOLEAN = true
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state.
|  | host : STRING
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ.
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | maxBatchSize : INTEGER = 10
|  | The maximum number of messages to remove from a queue before at least one must be delivered to an asynchronous consumer. Not supported for: WAS_61.
|  | msgRetention : BOOLEAN = true
|  | Determines whether or not the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means that the messages are disposed of as per their disposition options.
|  | pollingInterval : INTEGER = 5000
|  | How long to wait for a message to turn up on the queue currently being polled before moving to another queue when receiving messages asynchronously from multiple queues. This is only applicable in the client container.
|  | port : INTEGER = 0
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only.
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager. Not supported for: WAS_61.
|  | qmgrType : ENUM [QMGR, QSG] = QMGR
|  | Type of queue manager.
|  | queueManager : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages.
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names. Not supported for: WAS_61.
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit. Not supported for: WAS_61.
|  | replyWithRFH2 : STRING = AS_REPLY_DEST
|  | Determines whether, when replying to a message, a RFH version 2 header is included in the reply message. Values: 'AS_REPLY_DEST'(default), 'ALWAYS'. Not supported for: WAS_61.
|  | rescanInterval : INTEGER = 5000
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues.
|  | secExit : STRING
|  | The security exit class name. Not supported for: WAS_61.
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit. Not supported for: WAS_61.
|  | sendExit : STRING
|  | A comma separate list of send exit class names. Not supported for: WAS_61.
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit. Not supported for: WAS_61.
|  | sslCRL : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ.
|  | sslCipherSuite : STRING
|  | The cipher suite to use for SSL connection.
|  | sslConfigurationName : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager. Not supported for: WAS_61.
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate.
|  | sslResetCount : INTEGER = 0
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session. Not supported for: WAS_61.
|  | sslType : ENUM [CENTRAL, SPECIFIC, NONE] = NONE
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group. Not supported for: WAS_61.
|  | tempModel : STRING = SYSTEM.DEFAULT.MODEL.QUEUE
|  | The model queue that is used as a basis for temporary queue creation.
|  | tempQueuePrefix : STRING
|  | Prefix to append to the beginning of the names generated for temporary queues.
|  | transportType : ENUM [BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT] = BINDINGS
|  | Determines the manner in which a connection will be established to WebSphere MQ.
|  | useConnectionPooling : BOOLEAN = true
|  | Set the use of ConnectionPooling in earlier versions of the WebSphere MQ classes for JMS. This method is retained for compatibility with older MQJMS applications, but, because this Connection Pooling functionality has been removed from version 7, setting this property will have no effect.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-connection-factory.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere MQ JMS Provider
|  | JMS provider for WebSphere MQ queue connection factory.
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-connection-factory-lib.py, was/jms/jms-connection-factory-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-connection-factory.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = MQQueueConnectionFactory
|  | WAS config type of WebSphere MQ queue connection factory.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqQueueConnectionFactorySpec

Type Hierarchy | jee.QueueConnectionFactorySpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a WMQ queue connection factory.

|  | Public Properties
--- | --- | ---
|  | CCSID : STRING
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII) (integer) default(819)
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | ConnectionPool_freePoolDistributionTableSize : STRING
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution. (integer) default(0)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | ConnectionPool_numberOfFreePoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the free pools. (integer) default(0)
|  | ConnectionPool_numberOfSharedPoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the shared pools. (integer) default(0)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_stuckThreshold : STRING
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests. (integer) default(0)
|  | ConnectionPool_stuckTime : STRING
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck. (integer) default(0)
|  | ConnectionPool_stuckTimerTime : STRING
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds. (integer) default(0)
|  | ConnectionPool_surgeCreationInterval : STRING
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value. (integer) default(0)
|  | ConnectionPool_surgeThreshold : STRING
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously. (integer) default(-1)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | SessionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | SessionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | SessionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | SessionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | SessionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(FailingConnectionOnly)
|  | SessionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | SessionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | XAEnabled : STRING
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing. (boolean) default(true)
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate. (string)
|  | authMechanismPreference : STRING
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. (enum) values(BASIC_PASSWORD, KERBEROS) default(BASIC_PASSWORD)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | ccdtUrl : STRING
|  | A Uniform Resource Locator (URL) that identifies the name and location of the file containing the client channel definition table and specifies how the file can be accessed. (string)
|  | channel : STRING
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ. (string)
|  | clientID : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager. (string)
|  | clientReconnectOptions : STRING
|  | Specifies whether a client mode connection reconnects automatically or not in the event of a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Not supported for: WAS_61, WAS_70. (enum) values(DISABLED, ASDEF, QMGR, RECONNECT) default(DISABLED)
|  | clientReconnectTimeout : STRING
|  | The maximum amount of time, in seconds, that a client mode connection will spend attempting to automatically reconnect to a queue manager after a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Whether this parameter is used or not depends on the value of the client reconnect options parameter. Not supported for: WAS_61, WAS_70. (integer) default(1800)
|  | compressHeaders : STRING
|  | Determines if message headers are compressed or not. Not supported for: WAS_61. (enum) values(NONE, SYSTEM) default(NONE)
|  | compressPayload : STRING
|  | The compression algorithm to use to compress message payloads. Not supported for: WAS_61. (enum) values(NONE, RLE, ZLIBFAST, ZLIBHIGH) default(NONE)
|  | connameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_61, WAS_70. (string)
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue. (map_string_string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | diagnoseConnectionUsage : STRING
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work. (boolean) default(false)
|  | failIfQuiesce : STRING
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state. (boolean) default(true)
|  | host : STRING
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection. (string)
|  | logMissingTransactionContext : STRING
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log. (boolean) default(true)
|  | manageCachedHandles : STRING
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management. (boolean) default(false)
|  | mappingConfigAlias : STRING
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping. (enum) values(None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping) default(DefaultPrincipalMapping)
|  | maxBatchSize : STRING
|  | The maximum number of messages to remove from a queue before at least one must be delivered to an asynchronous consumer. Not supported for: WAS_61. (integer) default(10)
|  | msgRetention : STRING
|  | Determines whether or not the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means that the messages are disposed of as per their disposition options. (boolean) default(true)
|  | pollingInterval : STRING
|  | How long to wait for a message to turn up on the queue currently being polled before moving to another queue when receiving messages asynchronously from multiple queues. This is only applicable in the client container. (integer) default(5000)
|  | port : STRING
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only. (integer) default(0)
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager. Not supported for: WAS_61. (string)
|  | qmgrType : STRING
|  | Type of queue manager. (enum) values(QMGR, QSG) default(QMGR)
|  | queueManager : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages. (string)
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names. Not supported for: WAS_61. (string)
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit. Not supported for: WAS_61. (string)
|  | replyWithRFH2 : STRING
|  | Determines whether, when replying to a message, a RFH version 2 header is included in the reply message. Values: 'AS_REPLY_DEST'(default), 'ALWAYS'. Not supported for: WAS_61. (string) default(AS_REPLY_DEST)
|  | rescanInterval : STRING
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues. (integer) default(5000)
|  | secExit : STRING
|  | The security exit class name. Not supported for: WAS_61. (string)
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit. Not supported for: WAS_61. (string)
|  | sendExit : STRING
|  | A comma separate list of send exit class names. Not supported for: WAS_61. (string)
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit. Not supported for: WAS_61. (string)
|  | sslCRL : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ. (string)
|  | sslCipherSuite : STRING
|  | The cipher suite to use for SSL connection. (string)
|  | sslConfigurationName : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager. Not supported for: WAS_61. (string)
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate. (string)
|  | sslResetCount : STRING
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session. Not supported for: WAS_61. (integer) default(0)
|  | sslType : STRING
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group. Not supported for: WAS_61. (enum) values(CENTRAL, SPECIFIC, NONE) default(NONE)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | tempModel : STRING
|  | The model queue that is used as a basis for temporary queue creation. (string) default(SYSTEM.DEFAULT.MODEL.QUEUE)
|  | tempQueuePrefix : STRING
|  | Prefix to append to the beginning of the names generated for temporary queues. (string)
|  | transportType : STRING
|  | Determines the manner in which a connection will be established to WebSphere MQ. (enum) values(BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT) default(BINDINGS)
|  | useConnectionPooling : STRING
|  | Set the use of ConnectionPooling in earlier versions of the WebSphere MQ classes for JMS. This method is retained for compatibility with older MQJMS applications, but, because this Connection Pooling functionality has been removed from version 7, setting this property will have no effect. (boolean) default(true)
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery. (string)

#### was.WmqQueueSpec

Type Hierarchy | jee.QueueSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a WMQ queue.

|  | Public Properties
--- | --- | ---
|  | CCSID : STRING
|  | The character set used to for encoding strings in messages sent to this destination. Default value is 1208 (UTF-8). (integer) default(1208)
|  | baseQueueManagerName : STRING
|  | The name of the WebSphere MQ queue manager or queue sharing group where the queue resides. (string)
|  | baseQueueName : STRING
|  | Name of the queue to which messages are sent. (string)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue. (map_string_string)
|  | decimalEncoding : STRING
|  | If native encoding is not enabled, select the type of decimal encoding. (enum) values(Normal, Reversed) default(Normal)
|  | description : STRING
|  | Specifies a description for the resource. (string)
|  | expiry : STRING
|  | Indicates whether the expiry timeout for this queue is defined by the application or the Specified expiry property, or whether messages on the queue do not expire. (enum) values(APPLICATION_DEFINED, SPECIFIED, UNLIMITED) default(APPLICATION_DEFINED)
|  | floatingPointEncoding : STRING
|  | If native encoding is not enabled, select the type of floating point encoding. (enum) values(IEEENormal, IEEEReversed, S390) default(IEEENormal)
|  | integerEncoding : STRING
|  | If native encoding is not enabled, select the type of integer encoding. (enum) values(Normal, Reversed) default(Normal)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | messageBody : STRING
|  | Specifies whether an application processes the RFH version 2 header of a WebSphere MQ message as part of the JMS message body. Values: 'JMS', 'MQ' and 'UNSPECIFIED'(default). Not supported for: WAS_61, WAS_70. (string) default(UNSPECIFIED)
|  | mqmdMessageContext : STRING
|  | Defines the message context options specified when sending messages to a destination. Values: 'DEFAULT'(default), 'SET_ALL_CONTEXT', 'SET_IDENTITY_CONTEXT'. Not supported for: WAS_61, WAS_70, WAS_80. (string) default(DEFAULT)
|  | mqmdReadEnabled : STRING
|  | Specifies whether an application can read the values of MQMD fields from JMS messages that have been sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80. (boolean) default(false)
|  | mqmdWriteEnabled : STRING
|  | Specifies whether an application can write the values of MQMD fields to JMS messages that will be sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80. (boolean) default(false)
|  | password : STRING
|  | The password, used with the user name property, for authentication when connecting to the queue manager to define the queue destination. (string)
|  | persistence : STRING
|  | Sets the level of persistence used for sending messages to this queue. (enum) values(APPLICATION_DEFINED, HIGH, NONPERSISTENT, PERSISTENT, QUEUE_DEFINED) default(APPLICATION_DEFINED)
|  | priority : STRING
|  | The priority assigned to messages sent to this queue. (enum) values(APPLICATION_DEFINED, SPECIFIED, QUEUE_DEFINED) default(APPLICATION_DEFINED)
|  | queueManagerHost : STRING
|  | The name of the host for the queue manager on which the queue destination is created. (string)
|  | queueManagerPort : STRING
|  | The number of the port used by the queue manager on which this queue is defined. (integer) default(1414)
|  | readAhead : STRING
|  | Determines if messages for non-persistent consumers are sent to the client before the client requests them. Not supported for: WAS_61. (enum) values(QUEUE_DEFINED, YES, NO) default(QUEUE_DEFINED)
|  | readAheadClose : STRING
|  | Determines what happens if a read ahead consumer is closed. Values: 'DELIVERALL'(default) and 'DELIVERCURRENT'. Not supported for: WAS_61. (string) default(DELIVERALL)
|  | replyToStyle : STRING
|  | Specifies how the JMSReplyTo header field in a WebSphere MQ messaging provider message is generated. Values: 'DEFAULT'(default), 'MQMD', 'RFH2'. Not supported for: WAS_61, WAS_70. (string) default(DEFAULT)
|  | sendAsync : STRING
|  | Determines whether the queue manager acknowledges receipt of messages sent to it. Not supported for: WAS_61. (enum) values(QUEUE_DEFINED, YES, NO) default(QUEUE_DEFINED)
|  | serverConnectionChannelName : STRING
|  | The name of the channel to use to connect to the queue manager. (string)
|  | specifiedExpiry : STRING
|  | If the Expiry timeout property is set to specified, you must type the number of milliseconds (greater than 0) after which messages on this queue expire. (integer) default(0)
|  | specifiedPriority : STRING
|  | If the priority property is set to specified, you must type the message priority for this queue, using the range 0 through 9. (integer) default(0)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | targetClient : STRING
|  | Indicates whether the receiving application is JMS-compliant or is a traditional WebSphere MQ application. Values: JMS (default), MQ. (enum) values(JMS, MQ) default(JMS)
|  | useNativeEncoding : STRING
|  | Use native encodings. (boolean) default(true)
|  | userName : STRING
|  | The user ID used, with the password property, for authentication when connecting to the queue manager to define the queue destination. (string)

#### was.WmqServer

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A WebSphere MQ server provides a direct client connection between a service integration bus and queues on a WebSphere MQ queue manager or (for WebSphere MQ for z/OS) queue-sharing group.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | channel : STRING = SYSTEM.DEF.SVRCONN
|  | The WebSphere MQ server connection channel, as defined in WebSphere MQ.
|  | host : STRING
|  | WebSphere MQ server host defined by either its symbolic host name or an IP address.
|  | port : INTEGER = 1414
|  | This is the port that will be used when attempting to establish client transport mode connections to WebSphere MQ.
|  | serverName : STRING
|  | The name of the WebSphere MQ queue manager or queue sharing group, as defined in WebSphere MQ.
|  | serverType : ENUM [MQ_QUEUE_MANAGER, MQ_QUEUE_SHARING_GROUP] = MQ_QUEUE_MANAGER
|  | Indicates whether the WebSphere MQ server represents a WebSphere MQ queue manager or a WebSphere MQ queue sharing group.
|  | transportChainName : STRING = OutboundBasicWMQClient
|  | The name of the transport chain to use when communicating with MQ.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the WebSphere MQ server, for administrative purposes.
|  | discoveryAuthAlias : STRING
|  | WebSphere MQ server authentication alias used for WebSphere MQ resource discovery.
|  | discoveryReplyToQueue : STRING = SYSTEM.DEFAULT.MODEL.QUEUE
|  | WebSphere MQ queue name used by the system to obtain messages used in the resource discovery process.
|  | enableAutoResourceDiscovery : BOOLEAN = true
|  | When selected this enables the discovery of WebSphere MQ queue names to assist the administrator.
|  | enableBindingsTransportMode : BOOLEAN = true
|  | When selected, bindings transport mode will be used in preference to client transport mode when establishing connections to the WebSphere MQ server. Otherwise client transport mode will always be used.
|  | messagingAuthAlias : STRING
|  | WebSphere MQ server authentication alias name used when exchanging messages with WebSphere MQ.
|  | trustMessageUserIdentifiers : BOOLEAN = true
|  | If selected user identifiers received as part of WebSphere MQ messages will be used for security purposes within the bus.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 57
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/container/wmq/create-or-modify-wmq-server.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 45
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 44
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/container/wmq/discover-inspect-wmq-server.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py, was/container/wmq/wmq-server-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/container/wmq/create-or-modify-wmq-server.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = SIBMQServer
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqServerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

A WebSphere MQ server provides a direct client connection between a service integration bus and queues on a WebSphere MQ queue manager or (for WebSphere MQ for z/OS) queue-sharing group.

|  | Public Properties
--- | --- | ---
|  | channel : STRING
|  | The WebSphere MQ server connection channel, as defined in WebSphere MQ. (string) default(SYSTEM.DEF.SVRCONN)
|  | description : STRING
|  | An optional description for the WebSphere MQ server, for administrative purposes. (string)
|  | discoveryAuthAlias : STRING
|  | WebSphere MQ server authentication alias used for WebSphere MQ resource discovery. (string)
|  | discoveryReplyToQueue : STRING
|  | WebSphere MQ queue name used by the system to obtain messages used in the resource discovery process. (string) default(SYSTEM.DEFAULT.MODEL.QUEUE)
|  | enableAutoResourceDiscovery : STRING
|  | When selected this enables the discovery of WebSphere MQ queue names to assist the administrator. (boolean) default(true)
|  | enableBindingsTransportMode : STRING
|  | When selected, bindings transport mode will be used in preference to client transport mode when establishing connections to the WebSphere MQ server. Otherwise client transport mode will always be used. (boolean) default(true)
|  | host : STRING
|  | WebSphere MQ server host defined by either its symbolic host name or an IP address. (string)
|  | messagingAuthAlias : STRING
|  | WebSphere MQ server authentication alias name used when exchanging messages with WebSphere MQ. (string)
|  | port : STRING
|  | This is the port that will be used when attempting to establish client transport mode connections to WebSphere MQ. (integer) default(1414)
|  | serverName : STRING
|  | The name of the WebSphere MQ queue manager or queue sharing group, as defined in WebSphere MQ. (string)
|  | serverType : STRING
|  | Indicates whether the WebSphere MQ server represents a WebSphere MQ queue manager or a WebSphere MQ queue sharing group. (enum) values(MQ_QUEUE_MANAGER, MQ_QUEUE_SHARING_GROUP) default(MQ_QUEUE_MANAGER)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | transportChainName : STRING
|  | The name of the transport chain to use when communicating with MQ. (string) default(OutboundBasicWMQClient)
|  | trustMessageUserIdentifiers : STRING
|  | If selected user identifiers received as part of WebSphere MQ messages will be used for security purposes within the bus. (boolean) default(true)

#### was.WmqTopic

Type Hierarchy | was.WmqDestination >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Topic destinations provided for publish and subscribe messaging by the WebSphere MQ JMS provider. Use WebSphere MQ topic destination administrative objects to manage topic destinations for the WebSphere MQ JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | baseTopicName : STRING = BASE.TOPIC.NAME
|  | The name of the WebSphere MQ topic where publications will be received from, or sent to when this destination definition is used.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | multicast : ENUM [DISABLED, NOT_RELIABLE, RELIABLE, ENABLED, AS_CF] = AS_CF
|  | Enable MultiCast transport.
|  | CCSID : INTEGER = 1208
|  | The character set used to for encoding strings in messages sent to this destination. Default value is 1208 (UTF-8).
|  | brokerCCDurSubQueue : STRING
|  | The name of the queue from which a connection consumer receives durable subscription messages.
|  | brokerDurSubQueue : STRING
|  | The name of the broker queue from which durable subscription messages are retrieved.
|  | brokerPubQmgr : STRING
|  | The name of the queue manager on which the broker is running.
|  | brokerPubQueue : STRING
|  | The value to use to override the existing connection setting for the property: Broker publication queue
|  | brokerVersion : STRING = V1
|  | The version of the broker being used. Values: 'V1'(default), 'V2'.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | decimalEncoding : ENUM [Normal, Reversed] = Normal
|  | If native encoding is not enabled, select the type of decimal encoding.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies a description for the resource.
|  | expiry : ENUM [APPLICATION_DEFINED, SPECIFIED, UNLIMITED] = APPLICATION_DEFINED
|  | Indicates whether the expiry timeout for this queue is defined by the application or the Specified expiry property, or whether messages on the queue do not expire.
|  | floatingPointEncoding : ENUM [IEEENormal, IEEEReversed, S390] = IEEENormal
|  | If native encoding is not enabled, select the type of floating point encoding.
|  | integerEncoding : ENUM [Normal, Reversed] = Normal
|  | If native encoding is not enabled, select the type of integer encoding.
|  | messageBody : STRING = UNSPECIFIED
|  | Specifies whether an application processes the RFH version 2 header of a WebSphere MQ message as part of the JMS message body. Values: 'JMS', 'MQ' and 'UNSPECIFIED'(default). Not supported for: WAS_61, WAS_70.
|  | mqmdMessageContext : STRING = DEFAULT
|  | Defines the message context options specified when sending messages to a destination. Values: 'DEFAULT'(default), 'SET_ALL_CONTEXT', 'SET_IDENTITY_CONTEXT'. Not supported for: WAS_61, WAS_70, WAS_80.
|  | mqmdReadEnabled : BOOLEAN = false
|  | Specifies whether an application can read the values of MQMD fields from JMS messages that have been sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80.
|  | mqmdWriteEnabled : BOOLEAN = false
|  | Specifies whether an application can write the values of MQMD fields to JMS messages that will be sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80.
|  | persistence : ENUM [APPLICATION_DEFINED, HIGH, NONPERSISTENT, PERSISTENT, QUEUE_DEFINED] = APPLICATION_DEFINED
|  | Sets the level of persistence used for sending messages to this queue.
|  | priority : ENUM [APPLICATION_DEFINED, SPECIFIED, QUEUE_DEFINED] = APPLICATION_DEFINED
|  | The priority assigned to messages sent to this queue.
|  | readAhead : ENUM [QUEUE_DEFINED, YES, NO] = QUEUE_DEFINED
|  | Determines if messages for non-persistent consumers are sent to the client before the client requests them. Not supported for: WAS_61.
|  | readAheadClose : STRING = DELIVERALL
|  | Determines what happens if a read ahead consumer is closed. Values: 'DELIVERALL'(default) and 'DELIVERCURRENT'. Not supported for: WAS_61.
|  | replyToStyle : STRING = DEFAULT
|  | Specifies how the JMSReplyTo header field in a WebSphere MQ messaging provider message is generated. Values: 'DEFAULT'(default), 'MQMD', 'RFH2'. Not supported for: WAS_61, WAS_70.
|  | sendAsync : ENUM [QUEUE_DEFINED, YES, NO] = QUEUE_DEFINED
|  | Determines whether the queue manager acknowledges receipt of messages sent to it. Not supported for: WAS_61.
|  | specifiedExpiry : INTEGER = 0
|  | If the Expiry timeout property is set to specified, you must type the number of milliseconds (greater than 0) after which messages on this queue expire.
|  | specifiedPriority : INTEGER = 0
|  | If the priority property is set to specified, you must type the message priority for this queue, using the range 0 through 9.
|  | targetClient : ENUM [JMS, MQ] = JMS
|  | Indicates whether the receiving application is JMS-compliant or is a traditional WebSphere MQ application. Values: JMS (default), MQ.
|  | useNativeEncoding : BOOLEAN = true
|  | Use native encodings.
|  | wildcardFormat : ENUM [characterWildcards, topicWildcards] = topicWildcards
|  | Determines which sets of characters are interpreted as topic wildcards.
|  | wmqTopicName : STRING
|  | The name of the WMQ topic.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-queue.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-queue.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere MQ JMS Provider
|  | JMS provider for WebSphere MQ queue.
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-object-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-queue.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = MQTopic
|  | WAS config type of WebSphere MQ topic.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqTopicConnectionFactory

Type Hierarchy | was.WmqConnectionFactory >> was.JmsConnectionFactory >> was.JmsResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Topic connection factory is used to create connections to the associated JMS provider of JMS topic destinations, for publish and subscribe messaging. Use WebSphere MQ topic connection factory administrative objects to manage topic connection factories for the WebSphere MQ JMS provider.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | CCSID : INTEGER = 819
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII)
|  | ConnectionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | ConnectionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | ConnectionPool_freePoolDistributionTableSize : INTEGER = 0
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution.
|  | ConnectionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | ConnectionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | ConnectionPool_numberOfFreePoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the free pools.
|  | ConnectionPool_numberOfSharedPoolPartitions : INTEGER = 0
|  | Specifies the number of partitions that are created in each of the shared pools.
|  | ConnectionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | ConnectionPool_stuckThreshold : INTEGER = 0
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests.
|  | ConnectionPool_stuckTime : INTEGER = 0
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck.
|  | ConnectionPool_stuckTimerTime : INTEGER = 0
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds.
|  | ConnectionPool_surgeCreationInterval : INTEGER = 0
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value.
|  | ConnectionPool_surgeThreshold : INTEGER = -1
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously.
|  | ConnectionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | SessionPool_agedTimeout : INTEGER = 0
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread.
|  | SessionPool_connectionTimeout : INTEGER = 180
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property.
|  | SessionPool_maxConnections : INTEGER = 10
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property.
|  | SessionPool_minConnections : INTEGER = 1
|  | Specifies the minimum number of connections to maintain in the pool.
|  | SessionPool_reapTime : INTEGER = 180
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread.
|  | SessionPool_unusedTimeout : INTEGER = 1800
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread.
|  | jndiName : STRING
|  | JNDI name for the resource
|  | multicast : ENUM [DISABLED, NOT_RELIABLE, RELIABLE, ENABLED, AS_CF] = DISABLED
|  | Enable MultiCast transport.
|  | ConnectionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = EntirePool
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | SessionPool_purgePolicy : ENUM [EntirePool, FailingConnectionOnly] = FailingConnectionOnly
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected.
|  | XAEnabled : BOOLEAN = true
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing.
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate.
|  | authMechanismPreference : ENUM [BASIC_PASSWORD, KERBEROS] = BASIC_PASSWORD
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory.
|  | brokerCCSubQ : STRING = SYSTEM.JMS.ND.CC.SUBSCRIBER.QUEUE
|  | The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer.
|  | brokerControlQueue : STRING = SYSTEM.BROKER.CONTROL.QUEUE
|  | The broker control queue to use if subscribing to a topic.
|  | brokerPubQueue : STRING = SYSTEM.BROKER.DEFAULT.STREAM
|  | The queue to send publication messages to when using queue based brokering.
|  | brokerQueueManager : STRING
|  | The name of the queue manager on which the broker is running.
|  | brokerSubQueue : STRING = SYSTEM.JMS.ND.SUBSCRIBER.QUEUE
|  | The queue to use for obtaining subscription messages if subscribing to a topic.
|  | brokerVersion : ENUM [MA0C, MQSI] = MQSI
|  | The version of the broker being used.
|  | category : STRING
|  | Specifies a category string to classify or group the resource.
|  | ccdtUrl : STRING
|  | A Uniform Resource Locator (URL) that identifies the name and location of the file containing the client channel definition table and specifies how the file can be accessed.
|  | channel : STRING
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ.
|  | clientID : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager.
|  | clientReconnectOptions : ENUM [DISABLED, ASDEF, QMGR, RECONNECT] = DISABLED
|  | Specifies whether a client mode connection reconnects automatically or not in the event of a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Not supported for: WAS_61, WAS_70.
|  | clientReconnectTimeout : INTEGER = 1800
|  | The maximum amount of time, in seconds, that a client mode connection will spend attempting to automatically reconnect to a queue manager after a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Whether this parameter is used or not depends on the value of the client reconnect options parameter. Not supported for: WAS_61, WAS_70.
|  | cloneSupport : BOOLEAN = false
|  | Select this checkbox to enable WebSphere MQ clone support to allow the same durable subscription across topic clones. When true, the clientID field is required.
|  | compressHeaders : ENUM [NONE, SYSTEM] = NONE
|  | Determines if message headers are compressed or not. Not supported for: WAS_61.
|  | compressPayload : ENUM [NONE, RLE, ZLIBFAST, ZLIBHIGH] = NONE
|  | The compression algorithm to use to compress message payloads. Not supported for: WAS_61.
|  | connameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_61, WAS_70.
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | An optional description for the resource.
|  | diagnoseConnectionUsage : BOOLEAN = false
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work.
|  | directAuth : STRING = BASIC
|  | Specifies whether direct Broker authorization is used. Values: 'BASIC'(default), CERTIFICATE.
|  | failIfQuiesce : BOOLEAN = true
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state.
|  | host : STRING
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ.
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection.
|  | logMissingTransactionContext : BOOLEAN = true
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log.
|  | manageCachedHandles : BOOLEAN = false
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management.
|  | mappingConfigAlias : ENUM [None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping] = DefaultPrincipalMapping
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping.
|  | maxBatchSize : INTEGER = 10
|  | The maximum number of messages to remove from a queue before at least one must be delivered to an asynchronous consumer. Not supported for: WAS_61.
|  | msgSelection : ENUM [CLIENT, BROKER] = CLIENT
|  | Determines where message selection is performed.
|  | pollingInterval : INTEGER = 5000
|  | How long to wait for a message to turn up on the queue currently being polled before moving to another queue when receiving messages asynchronously from multiple queues. This is only applicable in the client container.
|  | port : INTEGER = 0
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only.
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager. Not supported for: WAS_61.
|  | proxyHostName : STRING
|  | Web Scale proxy host name.
|  | proxyPort : INTEGER = 0
|  | Web Scale proxy port.
|  | pubSubCleanup : ENUM [SAFE, ASPROP, NONE, STRONG] = SAFE
|  | Cleanup Level for BROKER or MIGRATE Subscription Stores.
|  | pubSubCleanupInterval : INTEGER = 3600000
|  | The interval between background executions of the publish/subscribe cleanup utility.
|  | publishAckInterval : INTEGER = 25
|  | The interval, in number of messages, between publish requests that require acknowledgement from the broker.
|  | qmgrType : ENUM [QMGR, QSG] = QMGR
|  | Type of queue manager.
|  | queueManager : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages.
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names. Not supported for: WAS_61.
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit. Not supported for: WAS_61.
|  | rescanInterval : INTEGER = 5000
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues.
|  | secExit : STRING
|  | The security exit class name. Not supported for: WAS_61.
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit. Not supported for: WAS_61.
|  | sendExit : STRING
|  | A comma separate list of send exit class names. Not supported for: WAS_61.
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit. Not supported for: WAS_61.
|  | sparseSubscriptions : BOOLEAN = false
|  | Specifies whether the user anticipates that resource will receive a high proportion messages that match its selection criteria. This information can be used to optimize message delivery.
|  | sslCRL : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ.
|  | sslCipherSuite : STRING
|  | The cipher suite to use for SSL connection.
|  | sslConfigurationName : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager. Not supported for: WAS_61.
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate.
|  | sslResetCount : INTEGER = 0
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session. Not supported for: WAS_61.
|  | sslType : ENUM [CENTRAL, SPECIFIC, NONE] = NONE
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group. Not supported for: WAS_61.
|  | statRefreshInterval : INTEGER = 60000
|  | The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore parameter has the value QUEUE.
|  | substore : ENUM [MIGRATE, QUEUE, BROKER] = MIGRATE
|  | Where WebSphere MQ JMS should store persistent data relating to active subscriptions.
|  | tempModel : STRING = SYSTEM.DEFAULT.MODEL.QUEUE
|  | The model queue that is used as a basis for temporary queue creation.
|  | tempTopicPrefix : STRING
|  | Prefix to append to the beginning of the names generated for temporary topics
|  | transportType : ENUM [BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT] = BINDINGS
|  | Determines the manner in which a connection will be established to WebSphere MQ.
|  | useConnectionPooling : BOOLEAN = true
|  | Set the use of ConnectionPooling in earlier versions of the WebSphere MQ classes for JMS. This method is retained for compatibility with older MQJMS applications, but, because this Connection Pooling functionality has been removed from version 7, setting this property will have no effect.
|  | wildcardFormat : ENUM [characterWildcards, topicWildcards] = topicWildcards
|  | Determines which sets of characters are interpreted as topic wildcards.
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = jmsProvider,wasType,containerAuthDataAlias,mappingConfigAlias,ConnectionPool,SessionPool,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/jms/wmq/create-wmq-connection-factory.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/jms/destroy-jms-object.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/jms/wmq/discover-inspect-wmq-connection-factory.py
|  | Discover Script
|  | jmsProvider : STRING = WebSphere MQ JMS Provider
|  | JMS provider for WebSphere MQ queue connection factory.
|  | libraryScripts : LIST_OF_STRING = [was/jms/wmq/wmq-connection-factory-lib.py, was/jms/jms-connection-factory-lib.py, was/jms/jms-object-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/jms/wmq/modify-wmq-connection-factory.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = MQTopicConnectionFactory
|  | WAS config type of WebSphere MQ topic connection factory.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WmqTopicConnectionFactorySpec

Type Hierarchy | jee.TopicConnectionFactorySpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a WMQ topic connection factory.

|  | Public Properties
--- | --- | ---
|  | CCSID : STRING
|  | The coded-character-set-ID to be used on connections. Default value is 819 (ISO 8859-1 ASCII) (integer) default(819)
|  | ConnectionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | ConnectionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | ConnectionPool_freePoolDistributionTableSize : STRING
|  | Determines the distribution of hash values in the table that indexes connection usage data. The hash values are used to match connection request credentials with the connections. A free pool distribution table size value that is higher than 1 can increase the efficiency of hash value distribution, to help minimize search collisions within the table. The value of 0 means random distribution. (integer) default(0)
|  | ConnectionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | ConnectionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | ConnectionPool_numberOfFreePoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the free pools. (integer) default(0)
|  | ConnectionPool_numberOfSharedPoolPartitions : STRING
|  | Specifies the number of partitions that are created in each of the shared pools. (integer) default(0)
|  | ConnectionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(EntirePool)
|  | ConnectionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | ConnectionPool_stuckThreshold : STRING
|  | Specifies the maximum number of stuck connections that are allowed to accumulate in a pool before the connection manager rejects new connection requests. (integer) default(0)
|  | ConnectionPool_stuckTime : STRING
|  | If the pool appears to be stuck (you have reached the stuck threshold), a resource exception is given to all new connection requests until the pool is unstuck. The stuck time property is the interval, in seconds, allowed for a single active connection to be in use to the backend resource before it is considered to be stuck. (integer) default(0)
|  | ConnectionPool_stuckTimerTime : STRING
|  | The stuck timer interval determines how often the connection pool checks for stuck connections. A stuck connection is an active connection that is not responding or returning to the connection pool. The default value is 0 seconds. (integer) default(0)
|  | ConnectionPool_surgeCreationInterval : STRING
|  | Specifies the period of time that the connection manager waits between creating connections while the connection manager operates in surge mode. The connection manager enforces the surge creation interval until the number of connections in the pool drops below the surge threshold value. (integer) default(0)
|  | ConnectionPool_surgeThreshold : STRING
|  | Specifies the number of connections that can be created before the connection manager activates surge protection. Surge protection is an operating mode that limits connection creation according to a rate that you set through the surge creation interval property. The goal is to prevent overloading of a data source when too many connections are created simultaneously. (integer) default(-1)
|  | ConnectionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | SessionPool_agedTimeout : STRING
|  | Specifies the interval, in seconds, after which an unused, aged connection is discarded (regardless of recent activity) by the pool maintenance thread. (integer) default(0)
|  | SessionPool_connectionTimeout : STRING
|  | Specifies the number of seconds that a connection request remains active, after which WebSphere Application Server issues a ConnectionWaitTimeout exception. The application server acts on this value only if you set the maximum pool size property. (integer) default(180)
|  | SessionPool_maxConnections : STRING
|  | Specifies the maximum number of connections to maintain in the pool per datasource. If the maximum number of connections is reached for a connection pool and all connections are in use for that connection pool, additional connection requests from that datasource will be denied only after the expiration of the time period specified for the connection timeout property. (integer) default(10)
|  | SessionPool_minConnections : STRING
|  | Specifies the minimum number of connections to maintain in the pool. (integer) default(1)
|  | SessionPool_purgePolicy : STRING
|  | Specifies how to purge connections when a stale connection or fatal connection error is detected. (enum) values(EntirePool, FailingConnectionOnly) default(FailingConnectionOnly)
|  | SessionPool_reapTime : STRING
|  | Specifies the interval, in seconds, between runs of the pool maintenance thread. (integer) default(180)
|  | SessionPool_unusedTimeout : STRING
|  | Specifies the maximum number of seconds that an idle connection can remain in the pool before being discarded by the maintenance thread. (integer) default(1800)
|  | XAEnabled : STRING
|  | Determines if the connection factory will act as a resource which is capable of participation in distributed two phase commit processing. (boolean) default(true)
|  | authDataAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate. (string)
|  | authMechanismPreference : STRING
|  | The value of this attribute specifies which of the defined authentication mechanisms for the corresponding resource adapter applies to this connection factory. (enum) values(BASIC_PASSWORD, KERBEROS) default(BASIC_PASSWORD)
|  | brokerCCSubQ : STRING
|  | The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer. (string) default(SYSTEM.JMS.ND.CC.SUBSCRIBER.QUEUE)
|  | brokerControlQueue : STRING
|  | The broker control queue to use if subscribing to a topic. (string) default(SYSTEM.BROKER.CONTROL.QUEUE)
|  | brokerPubQueue : STRING
|  | The queue to send publication messages to when using queue based brokering. (string) default(SYSTEM.BROKER.DEFAULT.STREAM)
|  | brokerQueueManager : STRING
|  | The name of the queue manager on which the broker is running. (string)
|  | brokerSubQueue : STRING
|  | The queue to use for obtaining subscription messages if subscribing to a topic. (string) default(SYSTEM.JMS.ND.SUBSCRIBER.QUEUE)
|  | brokerVersion : STRING
|  | The version of the broker being used. (enum) values(MA0C, MQSI) default(MQSI)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | ccdtUrl : STRING
|  | A Uniform Resource Locator (URL) that identifies the name and location of the file containing the client channel definition table and specifies how the file can be accessed. (string)
|  | channel : STRING
|  | The name of a WebSphere MQ svrconn channel to use when connecting to WebSphere MQ. (string)
|  | clientID : STRING
|  | The JMS client identifier used for connections to the WebSphere MQ queue manager. (string)
|  | clientReconnectOptions : STRING
|  | Specifies whether a client mode connection reconnects automatically or not in the event of a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Not supported for: WAS_61, WAS_70. (enum) values(DISABLED, ASDEF, QMGR, RECONNECT) default(DISABLED)
|  | clientReconnectTimeout : STRING
|  | The maximum amount of time, in seconds, that a client mode connection will spend attempting to automatically reconnect to a queue manager after a communications or queue manager failure. This parameter is ignored unless the connection factory is being used in a thin or managed client environment. Whether this parameter is used or not depends on the value of the client reconnect options parameter. Not supported for: WAS_61, WAS_70. (integer) default(1800)
|  | cloneSupport : STRING
|  | Select this checkbox to enable WebSphere MQ clone support to allow the same durable subscription across topic clones. When true, the clientID field is required. (boolean) default(false)
|  | compressHeaders : STRING
|  | Determines if message headers are compressed or not. Not supported for: WAS_61. (enum) values(NONE, SYSTEM) default(NONE)
|  | compressPayload : STRING
|  | The compression algorithm to use to compress message payloads. Not supported for: WAS_61. (enum) values(NONE, RLE, ZLIBFAST, ZLIBHIGH) default(NONE)
|  | connameList : STRING
|  | The connection name list to be used when attempting a client mode connection to WebSphere MQ. This must be of the form 'host[(port)][,host(port)]'. For example: 'host1(1234),host2,host3(4321)'. If the port information is not specified it defaults to 1414. Not supported for: WAS_61, WAS_70. (string)
|  | containerAuthDataAlias : STRING
|  | Use this only in the absence of loginconfiguration on the component resource reference. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue. (map_string_string)
|  | description : STRING
|  | An optional description for the resource. (string)
|  | diagnoseConnectionUsage : STRING
|  | Indicates that connection usage patterns should be monitored for potential programming model violations. Note that manageCachedHandles must also be true for the monitoring to work. (boolean) default(false)
|  | directAuth : STRING
|  | Specifies whether direct Broker authorization is used. Values: 'BASIC'(default), CERTIFICATE. (string) default(BASIC)
|  | failIfQuiesce : STRING
|  | Determines the behavior of certain calls to the queue manager when the queue manager is put into quiescing state. (boolean) default(true)
|  | host : STRING
|  | The hostname which will be used when attempting a client mode connection to WebSphere MQ. (string)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | localAddress : STRING
|  | Defines the local address to be used by the outbound client connection. (string)
|  | logMissingTransactionContext : STRING
|  | The J2EE1.3 programming model indicates that connections should always have a transaction context; however, some applications do not correctly have a transaction context associated with them. This setting enables whether the container will log the condition that there is a missing transaction context at the time that the connection is obtained to the activity log. (boolean) default(true)
|  | manageCachedHandles : STRING
|  | Whether cached handles (handles held in inst vars in a bean) should be tracked by the container. Tracking handles can cause large performance overhead if used at runtime; however, for debugging purposes it can be useful to enable handle management. (boolean) default(false)
|  | mappingConfigAlias : STRING
|  | If not set and 'Container-managed authentication alias' is set, will default to 'DefaultPrincipalMapping. (enum) values(None, ClientContainer, WSLogin, WSKRB5Login, DefaultPrincipalMapping, TrustedConnectionMapping, KerberosMapping) default(DefaultPrincipalMapping)
|  | maxBatchSize : STRING
|  | The maximum number of messages to remove from a queue before at least one must be delivered to an asynchronous consumer. Not supported for: WAS_61. (integer) default(10)
|  | msgSelection : STRING
|  | Determines where message selection is performed. (enum) values(CLIENT, BROKER) default(CLIENT)
|  | multicast : STRING
|  | Enable MultiCast transport. (enum) values(DISABLED, NOT_RELIABLE, RELIABLE, ENABLED, AS_CF) default(DISABLED)
|  | pollingInterval : STRING
|  | How long to wait for a message to turn up on the queue currently being polled before moving to another queue when receiving messages asynchronously from multiple queues. This is only applicable in the client container. (integer) default(5000)
|  | port : STRING
|  | The TCP/IP port number used for connection to the WebSphere MQ queue manager, for client connection only. (integer) default(0)
|  | providerVersion : STRING
|  | Determines the minimum version, and capabilities of the queue manager. Not supported for: WAS_61. (string)
|  | proxyHostName : STRING
|  | Web Scale proxy host name. (string)
|  | proxyPort : STRING
|  | Web Scale proxy port. (integer) default(0)
|  | pubSubCleanup : STRING
|  | Cleanup Level for BROKER or MIGRATE Subscription Stores. (enum) values(SAFE, ASPROP, NONE, STRONG) default(SAFE)
|  | pubSubCleanupInterval : STRING
|  | The interval between background executions of the publish/subscribe cleanup utility. (integer) default(3600000)
|  | publishAckInterval : STRING
|  | The interval, in number of messages, between publish requests that require acknowledgement from the broker. (integer) default(25)
|  | qmgrType : STRING
|  | Type of queue manager. (enum) values(QMGR, QSG) default(QMGR)
|  | queueManager : STRING
|  | The WebSphere MQ queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages. (string)
|  | rcvExit : STRING
|  | A comma separated list of receive exit class names. Not supported for: WAS_61. (string)
|  | rcvExitInitData : STRING
|  | Initialization data to pass to the receive exit. Not supported for: WAS_61. (string)
|  | rescanInterval : STRING
|  | The amount of time to examine messages on a queue before checking to see if new messages have arrived at the head of the queue when receiving messages asynchronously from multiple queues. (integer) default(5000)
|  | secExit : STRING
|  | The security exit class name. Not supported for: WAS_61. (string)
|  | secExitInitData : STRING
|  | Initialization data to pass to the security exit. Not supported for: WAS_61. (string)
|  | sendExit : STRING
|  | A comma separate list of send exit class names. Not supported for: WAS_61. (string)
|  | sendExitInitData : STRING
|  | Initialization data to pass to the send exit. Not supported for: WAS_61. (string)
|  | sparseSubscriptions : STRING
|  | Specifies whether the user anticipates that resource will receive a high proportion messages that match its selection criteria. This information can be used to optimize message delivery. (boolean) default(false)
|  | sslCRL : STRING
|  | Specifies a list of LDAP servers which may be used to provide certificate revocation information if this connection factory establishes a SSL based connection to WebSphere MQ. (string)
|  | sslCipherSuite : STRING
|  | The cipher suite to use for SSL connection. (string)
|  | sslConfigurationName : STRING
|  | Names a specific SSL configuration to use when using SSL to secure network connections to the queue manager. Not supported for: WAS_61. (string)
|  | sslPeerName : STRING
|  | Used when establishing an SSL connection to the queue manager. This value is used to match against the distinguished name present in the peers certificate. (string)
|  | sslResetCount : STRING
|  | Used when establishing an SSL connection to the queue manager. This parameter determines how many bytes to transfer before resetting the symmetric encryption key used for the SSL session. Not supported for: WAS_61. (integer) default(0)
|  | sslType : STRING
|  | This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure communications with the WebSphere MQ queue manager or queue sharing group. Not supported for: WAS_61. (enum) values(CENTRAL, SPECIFIC, NONE) default(NONE)
|  | statRefreshInterval : STRING
|  | The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore parameter has the value QUEUE. (integer) default(60000)
|  | substore : STRING
|  | Where WebSphere MQ JMS should store persistent data relating to active subscriptions. (enum) values(MIGRATE, QUEUE, BROKER) default(MIGRATE)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | tempModel : STRING
|  | The model queue that is used as a basis for temporary queue creation. (string) default(SYSTEM.DEFAULT.MODEL.QUEUE)
|  | tempTopicPrefix : STRING
|  | Prefix to append to the beginning of the names generated for temporary topics (string)
|  | transportType : STRING
|  | Determines the manner in which a connection will be established to WebSphere MQ. (enum) values(BINDINGS_THEN_CLIENT, BINDINGS, CLIENT, DIRECTHTTP, DIRECT) default(BINDINGS)
|  | useConnectionPooling : STRING
|  | Set the use of ConnectionPooling in earlier versions of the WebSphere MQ classes for JMS. This method is retained for compatibility with older MQJMS applications, but, because this Connection Pooling functionality has been removed from version 7, setting this property will have no effect. (boolean) default(true)
|  | wildcardFormat : STRING
|  | Determines which sets of characters are interpreted as topic wildcards. (enum) values(characterWildcards, topicWildcards) default(topicWildcards)
|  | xaRecoveryAuthAlias : STRING
|  | Specifies the alias that the connection factory uses to authenticate with the EIS for transaction recovery. (string)

#### was.WmqTopicSpec

Type Hierarchy | jee.TopicSpec >> jee.JndiResourceSpec >> jee.ResourceSpec >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specification of a WMQ topic.

|  | Public Properties
--- | --- | ---
|  | CCSID : STRING
|  | The character set used to for encoding strings in messages sent to this destination. Default value is 1208 (UTF-8). (integer) default(1208)
|  | baseTopicName : STRING
|  | The name of the WebSphere MQ topic where publications will be received from, or sent to when this destination definition is used. (string) default(BASE.TOPIC.NAME)
|  | brokerCCDurSubQueue : STRING
|  | The name of the queue from which a connection consumer receives durable subscription messages. (string)
|  | brokerDurSubQueue : STRING
|  | The name of the broker queue from which durable subscription messages are retrieved. (string)
|  | brokerPubQmgr : STRING
|  | The name of the queue manager on which the broker is running. (string)
|  | brokerPubQueue : STRING
|  | The value to use to override the existing connection setting for the property: Broker publication queue (string)
|  | brokerVersion : STRING
|  | The version of the broker being used. Values: 'V1'(default), 'V2'. (string) default(V1)
|  | category : STRING
|  | Specifies a category string to classify or group the resource. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this WebSphere MQ queue. (map_string_string)
|  | decimalEncoding : STRING
|  | If native encoding is not enabled, select the type of decimal encoding. (enum) values(Normal, Reversed) default(Normal)
|  | description : STRING
|  | Specifies a description for the resource. (string)
|  | expiry : STRING
|  | Indicates whether the expiry timeout for this queue is defined by the application or the Specified expiry property, or whether messages on the queue do not expire. (enum) values(APPLICATION_DEFINED, SPECIFIED, UNLIMITED) default(APPLICATION_DEFINED)
|  | floatingPointEncoding : STRING
|  | If native encoding is not enabled, select the type of floating point encoding. (enum) values(IEEENormal, IEEEReversed, S390) default(IEEENormal)
|  | integerEncoding : STRING
|  | If native encoding is not enabled, select the type of integer encoding. (enum) values(Normal, Reversed) default(Normal)
|  | jndiName : STRING
|  | JNDI name for the resource (string)
|  | messageBody : STRING
|  | Specifies whether an application processes the RFH version 2 header of a WebSphere MQ message as part of the JMS message body. Values: 'JMS', 'MQ' and 'UNSPECIFIED'(default). Not supported for: WAS_61, WAS_70. (string) default(UNSPECIFIED)
|  | mqmdMessageContext : STRING
|  | Defines the message context options specified when sending messages to a destination. Values: 'DEFAULT'(default), 'SET_ALL_CONTEXT', 'SET_IDENTITY_CONTEXT'. Not supported for: WAS_61, WAS_70, WAS_80. (string) default(DEFAULT)
|  | mqmdReadEnabled : STRING
|  | Specifies whether an application can read the values of MQMD fields from JMS messages that have been sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80. (boolean) default(false)
|  | mqmdWriteEnabled : STRING
|  | Specifies whether an application can write the values of MQMD fields to JMS messages that will be sent or received using the WebSphere MQ messaging provider. Not supported for: WAS_61, WAS_70, WAS_80. (boolean) default(false)
|  | multicast : STRING
|  | Enable MultiCast transport. (enum) values(DISABLED, NOT_RELIABLE, RELIABLE, ENABLED, AS_CF) default(AS_CF)
|  | persistence : STRING
|  | Sets the level of persistence used for sending messages to this queue. (enum) values(APPLICATION_DEFINED, HIGH, NONPERSISTENT, PERSISTENT, QUEUE_DEFINED) default(APPLICATION_DEFINED)
|  | priority : STRING
|  | The priority assigned to messages sent to this queue. (enum) values(APPLICATION_DEFINED, SPECIFIED, QUEUE_DEFINED) default(APPLICATION_DEFINED)
|  | readAhead : STRING
|  | Determines if messages for non-persistent consumers are sent to the client before the client requests them. Not supported for: WAS_61. (enum) values(QUEUE_DEFINED, YES, NO) default(QUEUE_DEFINED)
|  | readAheadClose : STRING
|  | Determines what happens if a read ahead consumer is closed. Values: 'DELIVERALL'(default) and 'DELIVERCURRENT'. Not supported for: WAS_61. (string) default(DELIVERALL)
|  | replyToStyle : STRING
|  | Specifies how the JMSReplyTo header field in a WebSphere MQ messaging provider message is generated. Values: 'DEFAULT'(default), 'MQMD', 'RFH2'. Not supported for: WAS_61, WAS_70. (string) default(DEFAULT)
|  | sendAsync : STRING
|  | Determines whether the queue manager acknowledges receipt of messages sent to it. Not supported for: WAS_61. (enum) values(QUEUE_DEFINED, YES, NO) default(QUEUE_DEFINED)
|  | specifiedExpiry : STRING
|  | If the Expiry timeout property is set to specified, you must type the number of milliseconds (greater than 0) after which messages on this queue expire. (integer) default(0)
|  | specifiedPriority : STRING
|  | If the priority property is set to specified, you must type the message priority for this queue, using the range 0 through 9. (integer) default(0)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | targetClient : STRING
|  | Indicates whether the receiving application is JMS-compliant or is a traditional WebSphere MQ application. Values: JMS (default), MQ. (enum) values(JMS, MQ) default(JMS)
|  | useNativeEncoding : STRING
|  | Use native encodings. (boolean) default(true)
|  | wildcardFormat : STRING
|  | Determines which sets of characters are interpreted as topic wildcards. (enum) values(characterWildcards, topicWildcards) default(topicWildcards)
|  | wmqTopicName : STRING
|  | The name of the WMQ topic. (string)

#### was.WorkManager

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

A work manager is a thread pool created for Java Platform, Enterprise Edition (Java EE) applications that use asynchronous beans.

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | jndiName : STRING
|  | Specifies the Java Naming and Directory Interface (JNDI) name used to look up the work manager in the namespace.
|  | maxThreads : INTEGER = 2
|  | Specifies the maximum number of threads available in this work manager. The default value is 2.
|  | minThreads : INTEGER = 0
|  | Specifies the minimum number of threads available in this work manager. The default value is 0.
|  | numAlarmThreads : INTEGER = 2
|  | Specifies the desired maximum number of threads used for alarms. The default value is 2.
|  | provider : STRING = WorkManagerProvider
|  | Specifies the Work Manager Provider name,The Default is 'WorkManagerProvider'.
|  | threadPriority : INTEGER = 5
|  | Specifies the priority of the threads available in this work manager. The default value is 5.
|  | workReqQFullAction : ENUM [Block, Fail] = Block
|  | Specifies the action taken when the thread pool is exhausted, and the work request queue is full,If set to FAIL, the work manager API methods creates an exception instead of blocking.
|  | ServiceNames_applicationProfilingService : BOOLEAN
|  | Specifies that when this option is selected, the application profile service is enabled, and when the application profile service property 5.x compatibility mode is selected, the application profile task that is associated with the scheduling thread is available on the target thread for J2EE 1.3 applications.
|  | ServiceNames_internationalization : BOOLEAN
|  | Specifies that when this option is selected and the internationalization service is enabled, the internationalization context that exists on the scheduling thread is available on the target thread.
|  | ServiceNames_security : BOOLEAN
|  | Specifies that when this option is selected, the Java(TM) Authentication and Authorization Service (JAAS) subject that exists on the scheduling thread is available on the target thread. If not selected, the thread runs anonymously.
|  | ServiceNames_workArea : BOOLEAN
|  | Specifies that when this option is selected, the work area context for every work area partition that exists on the scheduling thread is available on the target thread.
|  | category : STRING
|  | Specifies a string that you can use to classify or group this work manager.
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this resource.
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this work manager for administrative purposes.
|  | isGrowable : BOOLEAN = true
|  | Specifies whether the number of threads in this work manager can be increased.
|  | workReqQSize : INTEGER = 0
|  | Specifies the size of the work request queue. The default is 0 work objects.
|  | workTimeout : INTEGER = 0
|  | Specifies the number of milliseconds to wait before attempting to release a unit of work ,The default is 0 milliseconds.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties,ServiceNames
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 60
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/resources/async/create-or-modify-work-manager.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 40
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/resources/async/discover-inspect-work-manager.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/resources/async/async-lib.py, was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/resources/async/create-or-modify-work-manager.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | providerType : STRING = WorkManagerProvider
|  | WebSphere admin resource provider type.
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = WorkManagerInfo
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WorkManagerProvider

Type Hierarchy | was.ConfigResource >> was.Resource >> was.ExtensibleDeployedResource >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces | udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Specifies a work manager that contains a pool of threads that are bound into the Java(TM) Naming and Directory Interface (JNDI).

|  | Parent
--- | --- | ---
|  | container : CI<udm.Container>
|  | The container on which this deployed runs.

|  | Public Properties
--- | --- | ---
|  | deployable : CI<udm.Deployable>
|  | The deployable that this deployed is derived from.
|  | description : STRING
|  | Specifies the description of this work manager provider for administrative purposes.

|  | Hidden Properties
--- | --- | ---
|  | additionalPropertiesNotToExpose : STRING = wasType,provider,providerType,customProperties
|  | Additional Properties Not To Expose
|  | containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
|  | The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
|  | createOrder : INTEGER = 58
|  | The order in which a create step will be executed.
|  | createScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to deploy a Java EE artifact or create a Java EE resource
|  | createVerb : STRING = Create
|  | The word that is used to prefix a step description for the create operation.
|  | destroyOrder : INTEGER = 42
|  | The order in which a destroy step will be executed.
|  | destroyScript : STRING = was/common/config/destroy-resource.py
|  | Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
|  | destroyVerb : STRING = Destroy
|  | The word that is used to prefix a step description for the destroy operation.
|  | discoverOrder : INTEGER = 50
|  | The order in which a discover step will be executed.
|  | discoverScript : STRING = was/common/config/discover-inspect-resource.py
|  | Discover Script
|  | libraryScripts : LIST_OF_STRING = [was/common/config/admin-config-lib.py]
|  | List of scripts to appended to the the deployeds runtime script
|  | modifyOrder : INTEGER = 60
|  | The order in which a modify step will be executed.
|  | modifyScript : STRING = was/common/config/create-or-modify-resource.py
|  | Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
|  | modifyVerb : STRING = Modify
|  | The word that is used to prefix a step description for the modify operation.
|  | noopOrder : INTEGER = 50
|  | The order of the step in the step list for the noop operation.
|  | noopVerb : STRING = Noop
|  | Noop Verb
|  | restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
|  | The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
|  | standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
|  | Standard properties that are not exposed to any python wsadmin script.
|  | startOrder : INTEGER = 50
|  | The order in which a start step will be executed.
|  | startVerb : STRING = Start
|  | The word that is used to prefix a step description for the start operation.
|  | stopOrder : INTEGER = 50
|  | The order in which a stop step will be executed.
|  | stopVerb : STRING = Stop
|  | The word that is used to prefix a step description for the stop operation.
|  | syncAfterCreateOrder : INTEGER = 65
|  | The order in which a synchronize after create step will be executed.
|  | syncAfterDestroyOrder : INTEGER = 45
|  | The order in which a synchronize after destroy step will be executed.
|  | syncAfterModifyOrder : INTEGER = 65
|  | The order in which a synchronize after modify step will be executed.
|  | wasType : STRING = WorkManagerProvider
|  | WebSphere admin resource type.
|  | applyRestartStrategyOnNoop : BOOLEAN = false
|  | When true, the restart strategy is apply for a NOOP operation
|  | exposeDeployedApplication : BOOLEAN = false
|  | flag to indicate whether the deployed application CI is to be injected to the python script execution context.
|  | noopScript : STRING
|  | Python script invoked for the noop operation.
|  | startScript : STRING
|  | Python script invoked to start a Java EE artifact or Java EE resource
|  | stopScript : STRING
|  | Python script invoked to stop a Java EE artifact or Java EE resource

#### was.WorkManagerProviderSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

Specifies a work manager that contains a pool of threads that are bound into the Java(TM) Naming and Directory Interface (JNDI).

|  | Public Properties
--- | --- | ---
|  | description : STRING
|  | Specifies the description of this work manager provider for administrative purposes. (string)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.

#### was.WorkManagerSpec

Type Hierarchy | was.Deployable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces | udm.Taggable, udm.Deployable, udm.ConfigurationItem

A work manager is a thread pool created for Java Platform, Enterprise Edition (Java EE) applications that use asynchronous beans.

|  | Public Properties
--- | --- | ---
|  | ServiceNames_applicationProfilingService : STRING
|  | Specifies that when this option is selected, the application profile service is enabled, and when the application profile service property 5.x compatibility mode is selected, the application profile task that is associated with the scheduling thread is available on the target thread for J2EE 1.3 applications. (boolean)
|  | ServiceNames_internationalization : STRING
|  | Specifies that when this option is selected and the internationalization service is enabled, the internationalization context that exists on the scheduling thread is available on the target thread. (boolean)
|  | ServiceNames_security : STRING
|  | Specifies that when this option is selected, the Java(TM) Authentication and Authorization Service (JAAS) subject that exists on the scheduling thread is available on the target thread. If not selected, the thread runs anonymously. (boolean)
|  | ServiceNames_workArea : STRING
|  | Specifies that when this option is selected, the work area context for every work area partition that exists on the scheduling thread is available on the target thread. (boolean)
|  | category : STRING
|  | Specifies a string that you can use to classify or group this work manager. (string)
|  | customProperties : MAP_STRING_STRING
|  | Specifies Additional custom properties that you can configure for this resource. (map_string_string)
|  | description : STRING
|  | Specifies the description of this work manager for administrative purposes. (string)
|  | isGrowable : STRING
|  | Specifies whether the number of threads in this work manager can be increased. (boolean) default(true)
|  | jndiName : STRING
|  | Specifies the Java Naming and Directory Interface (JNDI) name used to look up the work manager in the namespace. (string)
|  | maxThreads : STRING
|  | Specifies the maximum number of threads available in this work manager. The default value is 2. (integer) default(2)
|  | minThreads : STRING
|  | Specifies the minimum number of threads available in this work manager. The default value is 0. (integer) default(0)
|  | numAlarmThreads : STRING
|  | Specifies the desired maximum number of threads used for alarms. The default value is 2. (integer) default(2)
|  | provider : STRING
|  | Specifies the Work Manager Provider name,The Default is 'WorkManagerProvider'. (string) default(WorkManagerProvider)
|  | tags : SET_OF_STRING
|  | If set, this deployable will only be mapped automatically to containers with the same tag.
|  | threadPriority : STRING
|  | Specifies the priority of the threads available in this work manager. The default value is 5. (integer) default(5)
|  | workReqQFullAction : STRING
|  | Specifies the action taken when the thread pool is exhausted, and the work request queue is full,If set to FAIL, the work manager API methods creates an exception instead of blocking. (enum) values(Block, Fail) default(Block)
|  | workReqQSize : STRING
|  | Specifies the size of the work request queue. The default is 0 work objects. (integer) default(0)
|  | workTimeout : STRING
|  | Specifies the number of milliseconds to wait before attempting to release a unit of work ,The default is 0 milliseconds. (integer) default(0)

## Step Reference

### wsadmin

#### Description

The `wsadmin` step executes a Python script via python terminal of a was.Cell.

#### Examples

This is an example of a `wsadmin` step that will deploy an application:

    <wsadmin>
        <order>70</order>
        <script>was/application/deploy-application.py</script>
    </wsadmin>

Note: Script `was/application/deploy-application.py` is provided with the `was-plugin`.

This is an example of a `wsadmin` step that will synchronize nodes, which is necessary after an application was deployed:

    <wsadmin>
        <order>80</order>
        <description>Synchronize node</description>
        <script>was/base/synchronize-node.py</script>
        <python-context>
            <nodeName expression="true">deployed.container.node.name</nodeName>
        </python-context>
    </wsadmin>

Note: Script `was/base/synchronize-node.py` is provided with the `was-plugin`.

Same steps created with Script rule:

    context.addStep(steps.wsadmin(
        order = 70,
        script = "was/application/deploy-application.py"
    ))

    context.addStep(steps.wsadmin(
        order = 80,
        script = "was/base/synchronize-node.py",
        python_context = {"nodeName": deployed.container.node.name}
    ))

#### Calculated step parameters

##### Target Cell

The `target-cell` parameter of a step is calculated as follows:

- If the scope is `deployed` and `deployed.container` is of type python.PythonManagingContainer:
  - `deployed.container.managingContainer` is of type was.Cell, the `target-cell` is set to `deployed.container.managingContainer`.
- In other cases, `target-cell` cannot be automatically calculated and must be specified manually.

#### Step Parameters

Note: For information about how values are calcuated, please refer to Calculated step parameters in the Rules Manual.