IBM WebSphere Application Server Plugin Reference 7.0.x

    The IBM WebSphere Application Server (WAS) plugin adds capability for managing deployments and resources on an existing WebSphere application server.

    This document provides information that is specific to this version of the WAS plugin. For general information about the plugin, refer to Introduction to the XL Deploy WebSphere Application Server plugin.

    Requirements

    • XL Deploy 5.1.0 or later
    • IBM WebSphere Application Server Standard and Network Deployment 7.0, 8.0, 8.5 or 9.0 (Unix and Microsoft Windows)

    Limitations

    1. Due to presence of a UTF-8 encoding issue in WAS 9.0, the values of non-English characters such as á, Á, é, É, ú, Ý, and so on are not displayed correctly in the WAS console.

    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.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

    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.

    Managed server control task

    was.ManagedServer doesn't have property "template". Instead, this control tasks accepts parameter of type was.ManagedServer_create. One can invoke control tasks from cli using following snippet:

    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)
    

    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.

    Character encoding

    If non-ASCII characters appear garbled on the WebSphere Application Server (WAS) Admin Console, verify that the default shell on the host with the deployment manager is correctly configured for UTF-8 character encoding; that is, a locales package is installed, the UTF-8 locale is generated, and the LC_ALL, LANG, and LANGUAGE environmental variables are configured with the correct value (en_US.UTF-8).

    Release notes

    WAS plugin 7.0.2

    Improvements

    • [DEPL-12515] - This release provides a fix for an issue related to adding a WebSphere cluster member.

    WAS plugin 7.0.1

    Improvements

    • [DEPL-11915] - Ignore empty values in webServerNames property of was.EarModule and was.warModule

    WAS plugin 7.0.0

    • Compatible with XL Deploy 7.0.0.

    WAS plugin 6.0.2

    Bug fixes

    • [DEPL-11229] - WAS plugin prints password when updating/modifying was.Keystore
    • [DEPL-11201] - During deployment of java 6 app, web.xml file is being replaced with ibm-web-ext.xmi even when specifying that in URI configurations

    WAS plugin 6.0.1

    Improvements

    • [DEPL-10692] - Support for Websphere Application Server 9.0

    Bug fixes

    • [DEPL-10244] - For Websphere Edition Applications, undeploy step is generated even if only dictionary value is modified
    • [DEPL-10242] - Sychronization steps are not generated when deploying to a Websphere Dynamic Cluster

    WAS plugin 6.0.0

    Bug fixes

    • [DEPL-10244] - Websphere Edition Applications update logic incorrect

    WAS plugin 5.1.4

    Improvements

    • [DEPL-10039] - Support creation of datasource without specifying Jaas Alias Name or Username/Password

    WAS plugin 5.1.3

    Bug fixes

    • [DEPL-7528] - was.KeystoreSpec location property cannot be used in the Maven plugin
    • [DEPL-8898] - Special characters are corrupted when deploying to WebSphere
    • [DEPL-9945] - was.CustomPropertiesSpec cannot be deployed to was.UnmanagedServer or was.ManagedServer

    WAS plugin 5.1.2

    Bug fixes

    • [DEPL-9227] - Fixed issue that resets the transport type when deploying a WMQ topic connection factory with CCDT URL

    WAS plugin 5.1.1

    Improvements

    • [DEPL-8861] - Make contextRoot an optional property on was.EmbeddedWebModuleSpec

    Bug fixes

    • [DEPL-8614] - Fixed issue that prevented generation of stop and start steps when defining a modify script on was.Module
    • [DEPL-8427] - Fixed issue that prevented the WAS version from being detected when WAS was installed using a language other than English
    • [DEPL-8345] - Fixed issue where discovery did not find a folder called "config" on WAS 7 ND
    • [DEPL-6864] - Fixed an issue that prevented a was.ManagedServer from being restarted unless the containerRestartStrategy was set

    WAS plugin 5.0.3

    Improvements

    • [DEPL-10039] - Support creation of datasource without specifying Jaas Alias Name or Username/Password

    Bug fixes

    • [DEPL-7528] - was.KeystoreSpec location property cannot be used in the Maven plugin

    WAS plugin 5.0.2

    Improvements

    • [DEPL-8861] - Make contextRoot an optional property on was.EmbeddedWebModuleSpec

    Bug fixes

    • [DEPL-8614] - Fixed issue that prevented generation of stop and start steps when defining a modify script on was.Module
    • [DEPL-8427] - Fixed issue that prevented the WAS version from being detected when WAS was installed using a language other than English
    • [DEPL-8345] - Fixed issue where discovery did not find a folder called "config" on WAS 7 ND
    • [DEPL-7043] - Fixed an incorrect error message when an incomplete datasource was deployed to WAS
    • [DEPL-6864] - Fixed an issue that prevented a was.ManagedServer from being restarted unless the containerRestartStrategy was set

    WAS plugin 5.0.1

    Bug fixes

    • [DEPL-6957] - Fixed issue where was.ResourceEnvironmentProviderSpec wouldn't allow referenceables with non-alphanumeric characters
    • [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-8358] - Fixed issue where deployment of was.WmqActivationSpecification fails when the CCDT URL property is defined

    WAS plugin 5.0.0

    Compatible with XL Deploy 5.0.

    As of version 5.0.0, the plugin no longer supports WebSphere Application Server 6.1.

    Bug fixes

    • [DEPL-8137] Cannot map users and groups to the same role in a was.Ear CI

    Changes

    • [DEPL-8106] Remove default values from WAS ConfigResource CIs

    WAS plugin 4.5.4

    Improvements

    • [DEPL-8861] - Make contextRoot an optional property on was.EmbeddedWebModuleSpec

    Bug fixes

    • [DEPL-8427] - Fixed issue that prevented the WAS version from being detected when WAS was installed using a language other than English
    • [DEPL-8345] - Fixed issue where discovery did not find a folder called "config" on WAS 7 ND
    • [DEPL-7043] - Fixed an incorrect error message when an incomplete datasource was deployed to WAS
    • [DEPL-6864] - Fixed an issue that prevented a was.ManagedServer from being restarted unless the containerRestartStrategy was set

    WAS plugin 4.5.3

    Improvements

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

    Bug fixes

    • [DEPL-7007] - Setting empty string for not set property in WebSphere Queue Connection Factory causes problem at runtime

    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

    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

    CI Description
    was.ApplicationServerSpec Server-specific Application Settings
    was.CoreGroupServiceSpec Configure and manage the core group service of this application server
    was.CoreGroupSpec A core group is a grouping of WebSphere(R) Application Server cell processes
    was.CustomPropertiesSpec Specifies custom properties for a WebSphere container except was
    was.CustomServiceSpec Custom services defines a class that is loaded and initialized whenever the server starts and shuts down
    was.DB2Type2DatasourceSpec Specification for a DB2 type 2 data source
    was.DB2Type4DatasourceSpec Specification for a DB2 type 4 data source
    was.Deployable Base class for all deployable configutation items
    was.DerbyDatasourceSpec Specification for a Derby datasource
    was.EJBContainerSpec Configure and manage the EJB container of this application server
    was.Ear Java EE EAR archive
    was.EjbJar Java EE EJB archive
    was.EjbNameSpaceBindingSpec Specifies a name binding of an enterprise bean home that has already been configured on a server within the cell
    was.FileSynchronizationServiceSpec Service ensures that configuration changes made to the cell repository are propagated to the appropriate node repositories
    was.GenericJmsQueueConnectionFactorySpec Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations
    was.GenericJmsQueueSpec Specifies a queue (for point-to-point messaging)
    was.GenericJmsTopicConnectionFactorySpec Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations
    was.GenericJmsTopicSpec Specifies a topic (for Publish and subscribe messaging) provided by the selected generic JMS provider
    was.HealthPolicyMembershipSpec Marks a container member of a health policy
    was.HealthPolicySpec Health policies define a condition and a set of actions to undertake when the condition is breached
    was.IndirectNameSpaceBindingSpec Specifies a name binding of an object which can be looked up using JNDI
    was.J2CActivationSpecificationSpec Specifies the activation specification definitions for the resource adapter
    was.J2CAdminObjectSpec Specifies the admin object definitions for the resource adapter
    was.J2CConnectionFactorySpec Specifies the connection factory definitions for the resource adapter
    was.J2CResourceAdapterSpec Specifies and installs a stand-alone resource adapter archive (RAR) file
    was.JaasAliasSpec Specifies a user identity and password for Java(TM) 2 connector security to use
    was.JavaProcessDefinitionSpec Configure and manage the process definition of this application server
    was.JdbcProviderSpec Description unavailable (deployable)
    was.JmsProviderSpec Specification for a JMS Provider
    was.KeystoreFile Description unavailable (deployable)
    was.KeystoreSpec Defines keystore types, including cryptography, Resource Access Control Facility (RACF®), Certificate Management Services (CMS), Java, and all trust store types
    was.ListenerPortSpec Specifies listener ports upon which message-driven beans listen for messages
    was.LoggingAndTracingSpec Configure and manage the logging and tracing settings of this application server
    was.MailProviderSpec Specifies the mail provider that the application server uses
    was.MailSessionSpec Specifies a mail Session
    was.MsSqlDatasourceSpec Specification for a MsSql datasource
    was.ORBServiceSpec Specifies settings for the Object Request Broker service
    was.OracleDatasourceSpec Specification for an Oracle datasource
    was.OracleJdbcProviderSpec Description unavailable (deployable)
    was.OracleXaJdbcProviderSpec Specification of an Oracle XA JDBC Driver
    was.PMIServiceSpec Specifies the PMIService configuration for Server
    was.ResourceEnvironmentEntrySpec Within an application server name space, the data contained in a resource environment entry is converted into an object that represents a physical resource
    was.ResourceEnvironmentProviderSpec Specifies a resource environment provider, which encapsulates the referenceables that convert resource environment entry data into resource objects
    was.SSLConfigSpec The SSL protocol provides secure communications between remote server processes or endpoints
    was.SchedulerSpec Schedulers are persistent and transactional timer services that can run business logic
    was.ServerPortSpec Specifies the TCP/IP ports this server uses for connections
    was.ServerSessionManagerSpec Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support
    was.ServicePolicySpec Description unavailable (deployable)
    was.ServletCacheInstanceSpec A servlet cache instance is a location, in addition to the default shared dynamic cache, where dynamic cache can store, distribute, and share data
    was.SharedLibrarySpec Specification of a shared library
    was.SiBusMemberSpec Bus members are the servers, WebSphere MQ servers and clusters that have been added to the bus
    was.SiBusSpec A service integration bus supports applications using message-based and service-oriented architectures
    was.SibQueueConnectionFactorySpec Specification of a SIB queue connection factory
    was.SibQueueDestinationSpec Specification of a SIB queue destination
    was.SibQueueSpec Specification of a SIB queue
    was.SibTopicConnectionFactorySpec Specification of a SIB topic connection factory
    was.SibTopicSpaceDestinationSpec Specification of a SIB topic space destination
    was.SibTopicSpec Specification of a SIB topic
    was.StringNameSpaceBindingSpec Specification for a String namespace binding
    was.ThreadPoolSpec A thread pool enables server components to reuse threads instead of creating new threads at run time
    was.TimerManagerSpec Timer manager enables applications to schedule future timer notifications and receive timer notification callbacks to application-specified listeners
    was.TransactionServiceSpec Specifies settings for the transaction service, as well as manage active transaction locks
    was.TransportChainSpec Configure and manage transport chains which represent network protocol stacks that are operating within a client or server
    was.URLProviderSpec Specifies the URL providers to access URL resources through different protocols
    was.URLSpec 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
    was.V5DefaultQueueConnectionFactorySpec Specification of a V5 default queue connection factory
    was.V5DefaultQueueSpec Specification of a V5 default queue
    was.V5DefaultTopicConnectionFactorySpec Specification of a V5 default topic connection factory
    was.V5DefaultTopicSpec Specification of a V5 default topic
    was.VariableSpec Specification of a WebSphere variable
    was.VirtualHostSpec Specification of a virtual host
    was.War Java EE WAR archive
    was.WebContainerSpec Configure and manage the Web container of this application server
    was.WmqActivationSpecificationSpec Specification of a WMQ Activation Specification
    was.WmqQueueConnectionFactorySpec Specification of a WMQ queue connection factory
    was.WmqQueueSpec Specification of a WMQ queue
    was.WmqServerSpec 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
    was.WmqTopicConnectionFactorySpec Specification of a WMQ topic connection factory
    was.WmqTopicSpec Specification of a WMQ topic
    was.WorkManagerProviderSpec Specifies a work manager that contains a pool of threads that are bound into the Java(TM) Naming and Directory Interface (JNDI)
    was.WorkManagerSpec A work manager is a thread pool created for Java Platform, Enterprise Edition (Java EE) applications that use asynchronous beans

    Deployeds

    CI Description
    was.ApplicationServer Server-specific Application Settings
    was.ConfigResource Base class for all deployed JEE AdminConfig resource configuration items
    was.ConfigurationResource Base class for all container configuration CIs
    was.CopiedKeystoreFile Description unavailable
    was.CoreGroup A core group is a grouping of WebSphere(R) Application Server cell processes
    was.CoreGroupService Configure and manage the core group service of this application server
    was.CustomProperties Specifies custom properties for a WebSphere container except was
    was.CustomService Custom services defines a class that is loaded and initialized whenever the server starts and shuts down
    was.DB2Datasource Base class for all deployed DB2 data source configuration items
    was.DB2Type2Datasource DB2 type 2 data source object supplies your application with connections for accessing the database
    was.DB2Type4Datasource DB2 type 4 data source object supplies your application with connections for accessing the database
    was.Datasource Base class for all deployed data source configuration items
    was.DerbyDatasource Derby data source object supplies your application with connections for accessing the database
    was.EJBContainer Configure and manage the EJB container of this application server
    was.EarModule EAR with values configured for a deployment
    was.EjbModule EJB with values configured for a deployment
    was.EjbNameSpaceBinding Specifies a name binding of an enterprise bean home that has already been configured on a server within the cell
    was.ExtensibleDeployed Base class for all extensible deployed configuration items
    was.ExtensibleDeployedArtifact Base class for all extensible deployed artifact configuration items
    was.ExtensibleDeployedResource Base class for all extensible deployed resource configuration items
    was.FileSynchronizationService Service ensures that configuration changes made to the cell repository are propagated to the appropriate node repositories
    was.GenericJmsConnectionFactory Description unavailable
    was.GenericJmsDestination Description unavailable
    was.GenericJmsQueue Specifies a queue (for point-to-point messaging)
    was.GenericJmsQueueConnectionFactory Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations
    was.GenericJmsTopic Specifies a topic (for Publish and subscribe messaging) provided by the selected generic JMS provider
    was.GenericJmsTopicConnectionFactory Specifies a JMS connection factory that is used to create connections to the associated JMS provider for JMS destinations
    was.HealthPolicy Health policies define a condition and a set of actions to undertake when the condition is breached
    was.HealthPolicyMembership Marks a container member of a health policy
    was.IndirectNameSpaceBinding Specifies a name binding of an object which can be looked up using JNDI
    was.J2CActivationSpecification Specifies the activation specification definitions for the resource adapter
    was.J2CAdminObject Specifies the admin object definitions for the resource adapter
    was.J2CConnectionFactory Specifies the connection factory definitions for the resource adapter
    was.J2CResource Base type for all WebSphere J2C objects
    was.J2CResourceAdapter Specifies and installs a stand-alone resource adapter archive (RAR) file
    was.JaasAlias Specifies a user identity and password for Java(TM) 2 connector security to use
    was.JavaProcessDefinition Configure and manage the process definition of this application server
    was.JdbcProvider Description unavailable
    was.JmsConnectionFactory Description unavailable
    was.JmsProvider Specifies a JMS Provider
    was.JmsResource Base class for all deployed JMS resource configuration items
    was.Keystore Defines keystore types, including cryptography, Resource Access Control Facility (RACF®), Certificate Management Services (CMS), Java, and all trust store types
    was.ListenerPort Specifies listener ports upon which message-driven beans listen for messages
    was.LoggingAndTracing Configure and manage the logging and tracing settings of this application server
    was.MailProvider Specifies the mail provider that the application server uses
    was.MailSession Specifies a mail Session
    was.Module Base class for all deployed JEE module configuration items
    was.MsSqlDatasource MsSql data source object supplies your application with connections for accessing the database
    was.NodeConfigurationResource Base class for all NodeAgent configuration CIs
    was.ORBService Specifies settings for the Object Request Broker service
    was.OracleDatasource Oracle data source object supplies your application with connections for accessing the database
    was.OracleJdbcProvider Description unavailable
    was.OracleXaJdbcProvider Description unavailable
    was.PMIService Specifies the PMIService configuration for Server
    was.Resource Base class for all deployed JEE resource configuration items
    was.ResourceEnvironmentEntry Within an application server name space, the data contained in a resource environment entry is converted into an object that represents a physical resource
    was.ResourceEnvironmentProvider Specifies a resource environment provider, which encapsulates the referenceables that convert resource environment entry data into resource objects
    was.SSLConfig The SSL protocol provides secure communications between remote server processes or endpoints
    was.Scheduler Schedulers are persistent and transactional timer services that can run business logic
    was.ServerConfigurationResource Base class for all Server configuration CIs
    was.ServerPort Specifies the TCP/IP ports this server uses for connections
    was.ServerSessionManager Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support
    was.ServicePolicy Description unavailable
    was.ServletCacheInstance A servlet cache instance is a location, in addition to the default shared dynamic cache, where dynamic cache can store, distribute, and share data
    was.SharedLibrary Container-wide shared library that can be used by deployed applications
    was.SiBus A service integration bus supports applications using message-based and service-oriented architectures
    was.SiBusMember Bus members are the servers, WebSphere MQ servers and clusters that have been added to the bus
    was.SibConnectionFactory Description unavailable
    was.SibDestination Base class for all deployed SIB destionation configuration items
    was.SibJndiResource Base class for all deployed SIB JNDI resource configuration items
    was.SibQueue JMS queue is used as a destination for point-to-point messaging
    was.SibQueueConnectionFactory JMS queue connection factory is used to create connections to the associated JMS provider of JMS queues, for point-to-point messaging
    was.SibQueueDestination Queue for point-to-point messaging
    was.SibResource Base class for all deployed SIB resource configuration items
    was.SibTopic JMS topic is used as a destination for publish/subscribe messaging
    was.SibTopicConnectionFactory JMS topic connection factory is used to create connections to the associated JMS provider of JMS topics, for publish/subscribe messaging
    was.SibTopicSpaceDestination Topic space is a location for publish/subscribe messaging
    was.StringNameSpaceBinding Specifies a String namespace binding
    was.ThreadPool A thread pool enables server components to reuse threads instead of creating new threads at run time
    was.TimerManager Timer manager enables applications to schedule future timer notifications and receive timer notification callbacks to application-specified listeners
    was.TransactionService Specifies settings for the transaction service, as well as manage active transaction locks
    was.TransportChain Configure and manage transport chains which represent network protocol stacks that are operating within a client or server
    was.URL 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
    was.URLProvider Specifies the URL providers to access URL resources through different protocols
    was.V5DefaultQueue Queue destinations provided for point-to-point messaging by the internal WebSphere JMS provider
    was.V5DefaultQueueConnectionFactory 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
    was.V5DefaultTopic Specifies the topic destinations for publish and subscribe messaging by the internal WebSphere JMS provider
    was.V5DefaultTopicConnectionFactory 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
    was.Variable Variables specify a level of indirection for some system-defined values
    was.VirtualHost Virtual host with a unique set of Web access ports
    was.WarModule WAR with values configured for a deployment
    was.WebContainer Configure and manage the EJB container of this application server
    was.WmqActivationSpecification Specifies a WMQ Activation Specification
    was.WmqConnectionFactory Description unavailable
    was.WmqDestination Description unavailable
    was.WmqQueue Queue destinations provided for point-to-point messaging by the WebSphere MQ JMS provider
    was.WmqQueueConnectionFactory Queue connection factory is used to create connections to the associated JMS provider of JMS queue destinations, for point-to-point messaging
    was.WmqServer 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
    was.WmqTopic Topic destinations provided for publish and subscribe messaging by the WebSphere MQ JMS provider
    was.WmqTopicConnectionFactory Topic connection factory is used to create connections to the associated JMS provider of JMS topic destinations, for publish and subscribe messaging
    was.WorkManager A work manager is a thread pool created for Java Platform, Enterprise Edition (Java EE) applications that use asynchronous beans
    was.WorkManagerProvider Specifies a work manager that contains a pool of threads that are bound into the Java(TM) Naming and Directory Interface (JNDI)

    Containers

    CI Description
    was.BaseCell Base class for a Webshpere Cell
    was.Cluster A WebSphere cluster managed by a deployment manager (WAS ND)
    was.DeploymentManager A WebSphere Application Server deployment manager (WAS ND)
    was.DynamicCluster A WebSphere dynamic cluster managed by a WebSphere deployment manager (WAS ND)
    was.DynamicOdrCluster A WebSphere dynamic ODR cluster managed by a WebSphere deployment manager (WAS ND)
    was.ManagedServer A WebSphere server managed by a node that is part of a deployment manager (WAS ND)
    was.NodeAgent A WebSphere node agent
    was.ProxyServerCluster A WebSphere proxy server cluster managed by a WebSphere deployment manager (WAS ND)
    was.UnmanagedServer An unmanaged WebSphere Applicaton Server (WAS Base/SA)

    Other Configuration Items

    CI Description
    was.AllActivePolicy Specifies a policy that automatically activates all group members
    was.AllActivePolicySpec Specifies a policy that automatically activates all group members
    was.Cluster_create Generated type for method create
    was.DmgrControlTaskParameters Deploymenta manager control task parameters
    was.EjbRef Allows you to specify JNDI names of EJBs that are bound to ejb-refs
    was.EjbRefSpec Allows you to specify JNDI names of EJBs that are bound to ejb-refs
    was.EmbeddedEjbModule Description unavailable
    was.EmbeddedEjbModuleSpec Description unavailable (deployable)
    was.EmbeddedModule Base class for EAR embedded Web and EJB module configuration items
    was.EmbeddedWebModule Description unavailable
    was.EmbeddedWebModuleSpec Description unavailable (deployable)
    was.HAManagerPolicy Base type for all HAManagerPolicy subtypes
    was.HAManagerPolicySpec Base type for all HAManagerPolicy subtypes
    was.HTTPInboundChannel Configure a channel for handling inbound HTTP requests from a remote client
    was.HTTPInboundChannelSpec Configure a channel for handling inbound HTTP requests from a remote client
    was.HealthActionHeapDump Health action to take heap dumps
    was.HealthActionHeapDumpSpec Health action to take heap dumps
    was.HealthActionRestartServer Health action to restart a server
    was.HealthActionRestartServerSpec Health action to restart a server
    was.HealthActionSendSnmpTrap Health action to generate a SNMP (Simple Network Management Protocol) trap
    was.HealthActionSendSnmpTrapSpec Health action to generate a SNMP (Simple Network Management Protocol) trap
    was.HealthActionSetMaintenanceMode Health action to put a server into maintenance mode
    was.HealthActionSetMaintenanceModeBreakAffinity Health action to put a server into maintenance mode and break HTTP and SIP request affinity to the server
    was.HealthActionSetMaintenanceModeBreakAffinitySpec Health action to put a server into maintenance mode and break HTTP and SIP request affinity to the server
    was.HealthActionSetMaintenanceModeSpec Health action to put a server into maintenance mode
    was.HealthActionSetMaintenanceModeStop Undocumented
    was.HealthActionSetMaintenanceModeStopSpec Undocumented
    was.HealthActionThreadDump Health action to take thread dumps
    was.HealthActionThreadDumpSpec Health action to take thread dumps
    was.HealthActionUnsetMaintenanceMode Health action to take a server out of maintenance mode
    was.HealthActionUnsetMaintenanceModeSpec Health action to take a server out of maintenance mode
    was.HealthBaseAction Base Health Action
    was.HealthBaseActionSpec Base Health Action
    was.HealthBaseCondition Base Condition for Health Policy conditions
    was.HealthBaseConditionSpec Base Condition for Health Policy conditions
    was.HealthConditionAge Tracks the amount of time that the server is running
    was.HealthConditionAgeSpec Tracks the amount of time that the server is running
    was.HealthConditionExcessiveMemory Tracks the memory usage for a member
    was.HealthConditionExcessiveMemorySpec Tracks the memory usage for a member
    was.HealthConditionExcessiveRequestTimeout Specifies a percentage of HTTP requests that can time out
    was.HealthConditionExcessiveRequestTimeoutSpec Specifies a percentage of HTTP requests that can time out
    was.HealthConditionExcessiveResponseTime Tracks the amount of time that requests take to complete
    was.HealthConditionExcessiveResponseTimeSpec Tracks the amount of time that requests take to complete
    was.HealthConditionGarbageCollectionPercentage 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
    was.HealthConditionGarbageCollectionPercentageSpec 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
    was.HealthConditionMemoryLeak Tracks consistent downward trends in free memory that is available to a server in the Java heap
    was.HealthConditionMemoryLeakSpec Tracks consistent downward trends in free memory that is available to a server in the Java heap
    was.HealthConditionStormDrain Tracks requests that have a significantly decreased response time
    was.HealthConditionStormDrainSpec Tracks requests that have a significantly decreased response time
    was.HealthConditionWorkload Specifies a number of requests that are serviced before policy members restart to clean out memory and cache data
    was.HealthConditionWorkloadSpec Specifies a number of requests that are serviced before policy members restart to clean out memory and cache data
    was.MOfNPolicy Specifies a policy that keeps a number of group member active at all times
    was.MOfNPolicySpec Specifies a policy that keeps a number of group member active at all times
    was.ManagedServer_create Generated type for method create
    was.ManagedWebServer An HTTP server managed by a node that is part of a deployment manager (WAS ND)
    was.NoOpPolicy Specifies a policy in which no group members are automatically activated
    was.NoOpPolicySpec Specifies a policy in which no group members are automatically activated
    was.OneOfNPolicy Specifies a policy that keeps one group member active at all times
    was.OneOfNPolicySpec Specifies a policy that keeps one group member active at all times
    was.ResRef Description unavailable
    was.ResourceEnvRef Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs
    was.ResourceEnvRefSpec Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-env-refs
    was.ResourceRef Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs
    was.ResourceRefSpec Allows you to specify JNDI names of resources defined in WebSphere Application Server configuration that are bound to resource-refs
    was.SessionManager Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support
    was.SessionManagerSpec Session manager properties to control the behavior of Hypertext Transfer Protocol (HTTP) session support
    was.StaticPolicy Specifies a policy that activates group members on all of the servers in the list
    was.StaticPolicySpec Specifies a policy that activates group members on all of the servers in the list
    was.TransportChannel Base class for all transport channel subtypes
    was.TransportChannelSpec Base class for all transport channel subtypes
    was.UnmanagedWebServer Description unavailable

    Configuration Item Details

    was.AllActivePolicy

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

    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.EmbeddedDeployable, udm.ConfigurationItem

    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/common/config/set-encoding.py, was/server/config-resource-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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 was.WasContainer, python.PythonManagedContainer, was.HealthPolicyMembershipContainer, python.PythonManagingContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, was.WasCustomPropertyContainer, udm.Taggable, was.Cell

    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, WAS_90]
    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 was.WasContainer, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, was.WasAppContainer

    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

    delegate = pythonControlTask, language = python, script = was/container/create-cluster.py

    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/set-encoding.py, was/common/config/admin-config-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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/common/config/set-encoding.py, was/server/config-resource-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    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/common/config/set-encoding.py, was/server/coregroup/coregroup-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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/common/config/set-encoding.py, was/server/config-resource-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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 a WebSphere container except was.Cluster.

    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/common/config/set-encoding.py, was/server/custom/custom-properties-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    Specifies custom properties for a WebSphere container except was.Cluster.

    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/common/config/set-encoding.py, was/customservice/custom-service-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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/common/config/set-encoding.py, was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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/common/config/set-encoding.py, was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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/common/config/set-encoding.py, was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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/common/config/set-encoding.py, was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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 was.WasContainer, python.PythonManagedContainer, was.HealthPolicyMembershipContainer, python.PythonManagingContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, was.WasCustomPropertyContainer, udm.Taggable, was.Cell

    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  = 0
    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, WAS_90]
    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/common/config/set-encoding.py, was/datasource/datasource-lib.py, was/datasource/discover-inspect-datasource-lib.py, was/jaas/jaas-alias-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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.WasContainer, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable, was.WasAppContainer

    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 was.WasContainer, was.HealthPolicyMembershipContainer, python.PythonManagedContainer, udm.Container, udm.ConfigurationItem, overthere.HostContainer, udm.Taggable

    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/common/config/set-encoding.py, was/server/config-resource-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, udm.FileArtifact

    Java EE EAR archive. Note that the application name in the application.xml file must match the name of the EAR file exactly, or WebSphere will not be able to start the application.

    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)
     
     
    enableWorkaroundForJavaEE4inWAS7 : STRING
    Specify JSP reloading workaround for J2EE4 for Websphere 7. (boolean) default(false)
     
     
    excludeFileNamesRegex : STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    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.DerivedArtifact, udm.EmbeddedDeployedContainer, was.ConfigurableModule, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    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.
     
     
    enableWorkaroundForJavaEE4inWAS7 : BOOLEAN  = false
    Specify JSP reloading workaround for J2EE4 for Websphere 7.
     
     
    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/common/config/set-encoding.py, was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.
     
     
    syncAfterCreateEditionedOrder : INTEGER  = 11
    The order in which a synchronize after create step for Editioned application will be executed.
     
     
    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.SourceArtifact, udm.Artifact, udm.ConfigurationItem, udm.Taggable, udm.ArchiveArtifact, udm.DeployableArtifact, udm.Deployable, 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
     
     
    fileUri : STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    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.DerivedArtifact, udm.EmbeddedDeployedContainer, was.ConfigurableModule, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    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/common/config/set-encoding.py, was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.
     
     
    syncAfterCreateEditionedOrder : INTEGER  = 11
    The order in which a synchronize after create step for Editioned application will be executed.
     
     
    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/set-encoding.py, was/common/config/admin-config-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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.EmbeddedDeployed, udm.ConfigurationItem

    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, udm.EmbeddedDeployed, was.ConfigurableModule, udm.ConfigurationItem

    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, udm.EmbeddedDeployed, was.ConfigurableModule, udm.ConfigurationItem

    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, udm.EmbeddedDeployed, was.ConfigurableModule, udm.ConfigurationItem

    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.
     
     
    enableWorkaroundForJavaEE4inWAS7 : BOOLEAN  = false
    Specify JSP reloading workaround for J2EE4 for Websphere 7.
     
     
    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)
     
     
    enableWorkaroundForJavaEE4inWAS7 : STRING
    Specify JSP reloading workaround for J2EE4 for Websphere 7. (boolean) default(false)
     
     
    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, provisioners, ordinal, boundConfigurationItems
    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 be appended to the deployed's 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.DerivedArtifact, udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem

    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, provisioners, ordinal, boundConfigurationItems
    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.
     
     
    syncAfterCreateEditionedOrder : INTEGER  = 11
    The order in which a synchronize after create step for Editioned application will be executed.
     
     
    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 be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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 be appended to the deployed's 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/common/config/set-encoding.py, was/server/config-resource-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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.ConfigurationItem, udm.Taggable, udm.Deployable

    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/common/config/set-encoding.py, 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 be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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/common/config/set-encoding.py, was/jms/jms-object-lib.py]
    List of scripts to be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
    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  =