You can use scripting to customize part of your system configuration using properties files. The WebSphere configuration repository stores many different types of configurations. You can use properties files to customize some of these configurations. You can customize some configurations that are created by the WebSphere Common Configuration Model (WCCM) or configurations that are deployed as Java EE applications.
The WebSphere Common Configuration Model is configured using the AdminConfig command in scripting. AdminConfig.types() lists the types in WCCM, and AdminConfig.attributes("type") lists the attributes for a specific type. Customizing these types using properties files is often easier than writing a script to make the same changes. In a production environment, Java EE applications are often deployed through the AdminApp command in scripting. For a development environment, the use of a properties file offers an easier to understand syntax when constructing the parameters needed to manage the application. Note that application deployment uses its own set of WCCM types.
For supported WCCM types that are not Cell, Node, Server, or ServerCluster, extract the specific type from an existing cell with the option -options [[PortablePropertiesFile true]] to create a portable file format. Then, edit the properties file and apply it to a different cell with appropriate variable substitutions. You might use this approach to move commonly used configuration subsets such as resource definitions and Java virtual machine (JVM) settings from one environment to another.
AccessPointGroup | ActivationSpec | ActivationSpecTemplateProps | ActivitySessionService |
---|---|---|---|
AdminObject | AdminObjectTemplateProps | AdminServerAuthentication | AdminService |
AllActivePolicy | AllAuthenticatedUserExt | AllAuthenticatedUsersInTrustedRealmsExt | ApplicationProfileService |
ApplicationServer | Audit | AuditEventFactory | AuditNotificationMonitor |
AuditPolicy | AuditServiceProvider | AuditSpecification | AuthenticationMechanism |
AuthenticationTarget | AuthorizationConfig | AuthorizationGroup | AuthorizationGroupMember |
AuthorizationProvider | AuthorizationTableExt | AuthorizationTableImpl | BackupCluster |
BridgeInterface | CACertificate | CAClient | CMPConnectorFactory |
CacheProvider | Cell | Certificate | Chain |
Classloader | ClusterMember | CommonSecureInterop | CompensationService |
ConfigSynchronizationService | ConnectionDefTemplateProps | ConnectionDefinition | ConnectionPool |
ConnectionTest | Connector | Cookie | CoreGroup |
CoreGroupAccessPoint | CoreGroupBridgeService | CoreGroupBridgeSettings | CoreGroupServer |
CryptoHardwareToken | CustomAuthMechanism | CustomService | CustomUserRegistry |
DCSInboundChannel | DPClonableDeviceSettings | DPClonableDeviceSettingsVersion | DPDevice |
DPDomain | DPDomainVersion | DPFirmware | DPFirmwareVersion |
DPManagedSet | DPManager | DRSConnectionPool | DRSPartition |
DRSSerialization | DRSSettings | DataPowerMgrInboundChannel | DataReplication |
DataReplicationDomain | DataSource | DebugService | DiagnosticProviderService |
DigestAuthentication | DiskCacheCustomPerformanceSettings | DiskCacheEvictionPolicy | DistributionQueue |
DynamicCache | EJBCache | EJBContainer | EJBTimer |
EndPoint | EventGroupProfile | EventGroupProfileList | EventInfrastructureProvider |
EventInfrastructureService | EventServerProfile | EveryoneExt | ExtensionMBean |
ExtensionMBeanProvider | ExternalCacheGroup | ExternalCacheGroupMember | FileTransferService |
Filter | GenericChannelFactory | GenericInboundChannel | GenericJMSConnectionFactory |
GenericJMSDestination | GenericOutboundChannel | HAManagerService | HTTPConnector |
HTTPInboundChannel | HTTPOutboundChannel | HTTPTransport | HTTPTunnelInboundChannel |
HTTPTunnelOutboundChannel | HostAlias | I18NService | IIOPSecurityProtocol |
IIOPTransport | IconType | IdentityAssertionLayer | IdentityAssertionQOP |
IdentityAssertionTypeAssociation | InvalidationSchedule | J2CActivationSpec | J2CAdminObject |
J2CResourceAdapter | J2EEResourcePropertySet | JAASAuthData | JAASConfiguration |
JAASConfigurationEntry | JAASLoginModule | JDBCProvider | JFAPFactory |
JFAPInboundChannel | JFAPOutboundChannel | JMSProvider | JMSTransport |
JavaProcessDef | JavaVirtualMachine | KRB | Key |
KeyManager | KeyReference | KeySet | KeySetGroup |
KeyStore | KeyStoreFile | LDAPSearchFilter | LDAPUserRegistry |
LTPA | Library | LibraryRef | ListenerPort |
LocalOSUserRegistry | MOfNPolicy | MQConnectionFactory | MQFAPInboundChannel |
MQFAPOutboundChannel | MQQueue | MQQueueConnectionFactory | MQTopic |
MQTopicConnectionFactory | MailProvider | MailSession | ManagementScope |
MappingModule | MemoryCacheEvictionPolicy | MessageLayer | MessageListener |
MessageListenerService | MessageQOP | MimeEntry | MonitoringPolicy |
NameServer | NoOpPolicy | Node | NodeGroup |
ORBInboundChannel | ObjectCacheInstance | ObjectPool | ObjectPoolManagerInfo |
ObjectPoolProvider | ObjectPoolService | ObjectRequestBroker | OneOfNPolicy |
OutboundResourceAdapter | OutputRedirect | PME51ServerExtension | PMEServerExtension |
PMIModule | PMIService | PMRClusterExtension | PeerAccessPoint |
PeerCoreGroup | PluginConfigService | PluginProperties | PluginServerClusterProperties |
PortletContainer | PreferredServerPolicy | PrimaryAdminExt | ProcessExecution |
ProtocolProvider | ProxyInboundChannel | RASLoggingService | RMIConnector |
RMQChannelFactory | RMQOutboundChannel | RSAToken | Referenceable |
RepositoryService | ResourceAdapter | ResourceEnvironmentProvider | RoleAssignmentExt |
SecurityRoleExt | ServerEntry | ServerExt | ServerIndex |
SIPContainer | SIPContainerInboundChannel | SIPInboundChannel | SIPOutboundChannel |
SIPProxyInboundChannel | SOAPConnector | SPNEGO | SSLConfig |
SSLConfigGroup | SSLInboundChannel | SSLOutboundChannel | SWAMAuthentication |
SchedulerConfiguration | SchedulerProvider | SchedulerService | SecureAssociationService |
SecureSocketLayer | Security | SecurityDomain | SecurityPermission |
SecurityProtocolQOP | Server | ServerCluster | ServerIdentity |
ServiceLog | ServletCacheInstance | SessionBeanConfig | SessionDatabasePersistence |
SessionManager | SingleSignon | StartupBeansService | StateManageable |
StatefulSessionBeanConfig | StaticPolicy | StatisticsProvider | StreamRedirect |
StringNameSpaceBinding | SystemMessageServer | TAInterceptor | TCPFactory |
TCPInboundChannel | TCPOutboundChannel | TPVService | TaskProvider |
ThreadPool | TimerManagerInfo | TimerManagerProvider | TraceLog |
TraceService | TransactionService | TransportChannelFactory | TransportChannelService |
TransportLayer | TransportQOP | TrustAssociation | TrustManager |
TrustedAuthenticationRealm | TuningParams | TunnelAccessPointGroup | TunnelPeerAccessPoint |
TunnelTemplate | UDPInboundChannel | UDPOutboundChannel | URL |
URLProvider | UserExt | VariableMap | VirtualHost |
WAS40ConnectionPool | WAS40DataSource | WASQueue | WASQueueConnectionFactory |
WASTopic | WASTopicConnectionFactory | WIMUserRegistry | WLMCoreGroupBridgePlugin |
WSNotification | WSSchedule | WebContainer | WebContainerInboundChannel |
WebModuleConfig | WebModuleDeployment | WebServer | WebserverPluginSettings |
WeightAdvisor | WorkAreaPartition | WorkAreaPartitionService | WorkAreaService |
WorkManagerInfo | WorkManagerProvider | WorkManagerService |
The applyConfigProperties command applies properties in a specific properties file to the configuration. The system adds attributes or configuration data to the configuration if a specific properties do not exist. If the properties exist in the configuration, the system sets the new values for the attributes.
Target object
None.
Required parameters
Optional parameters
Return value
The command does not return output.
Batch mode example usage
AdminTask.applyConfigProperties('-propertiesFileName myPropFile.props -zipFileName myZipFile.zip
-validate true')
AdminTask.applyConfigProperties(['-propertiesFileName', 'myPropFile.props', '-zipFileName',
'myZipFile.zip', '-validate', 'true'])
Interactive mode example usage
AdminTask.applyConfigProperties('-interactive')
The createPropertiesFileTemplates command creates template properties files to use to create or delete specific object types. The command stores the template properties file in the properties file specified by the propertiesFileName parameter.
Target object
None.
Required parameters
Optional parameters
NoneReturn value
The command does not return output.
Batch mode example usage
AdminTask.createPropertiesFileTemplates('-propertiesFileName serverTemplate.props -configType Server')
AdminTask.createPropertiesFileTemplates(['-propertiesFileName', 'serverTemplate.props',
'-configType', 'Server'])
Interactive mode example usage
AdminTask.createPropertiesFileTemplates('-interactive')
The deleteConfigProperties command deletes properties in your configuration as designated in a properties file. The system removes the attributes or configuration data that corresponds to each property in the properties file.
Target object
None.
Required parameters
Optional parameters
Return value
The command does not return output.
Batch mode example usage
AdminTask.deleteConfigProperties('-propertiesFileName myPropFile.props')
AdminTask.deleteConfigProperties(['-propertiesFileName', 'myPropFile.props'])
Interactive mode example usage
AdminTask.deleteConfigProperties('-interactive')
The extractConfigProperties command extracts configuration data in the form of a properties file. The system exports the most commonly used configuration data and attributes, converts the attributes to properties, and saves the data to a file. You can specify the resource of interest with the target object or the configData parameter. Use the configData parameter to specify a server, node, cluster, policy set, or application instance. If no configuration object is specified, the command extracts the profile configuration data.
Target object
Specify the object name of the configuration object of interest in the format: Node=nodeName:Server=serverName
Required parameters
Optional parameters
Configuration object type | Subtypes | Extensions |
---|---|---|
AdminService | None | None |
Deployment | ApplicationName | None |
ApplicationServer | TransactionService, DynamicCache, WebContainer, EJBContainer, PortletContainer, SIPContainer, WebserverPluginSettings | None |
AuthorizationGroup | None | None |
AuthorizationTableExt | None | None |
Cell | VirtualHost, DataReplicationDomain, ServerCluster, CoreGroup, NodeGroup, AuthorizationGroup, AuthorizationTableExt, Security, J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, EventInfrastructureProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, Node, VariableMap | None |
CoreGroup | None | None |
CoreGroupBridgeService | None | None |
DynamicCache | None | None |
EJBContainer | None | None |
EventInfrastructureProvider | None | None |
EventInfrastructureService | None | None |
HAManagerService | None | None |
J2CResourceAdapter | None | None |
JDBCProvider | None | None |
JMSProvider | None | None |
JavaVirtualMachine | None | None |
Library | None | None |
MailProvider | None | None |
NameServer | None | None |
Node | Server, J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, EventInfrastructureProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, VariableMap | The NodeMetadata Extension extracts node Metadata properties. |
NodeGroup | None | None |
ObjectPoolProvider | None | None |
ObjectRequestBroker | None | None |
PMEServerExtension | None | None |
PMIModule | None | None |
PMIService | None | None |
PortletContainer | None | None |
SIPContainer | None | None |
SchedulerProvider | None | None |
Security | JAASAuthData |
None |
Server | PMIService, AdminService, CoreGroupBridgeService, TPVService, ObjectRequestBroker, ApplicationServer, NameServer, J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, EventInfrastructureProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, VariableMap, EventInfrastructureService, PMEServerExtension, Library, HAManagerService, PMIModule, Security | The extension lists deployed applications for a specific server. |
ServerCluster | J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, VariableMap | The extension lists deployed applications for a specific cluster. |
TPVService | None | None |
TimerManagerProvider | None | None |
TransactionService | None | None |
URLProvider | None | None |
VariableMap | None | None |
VirtualHost | None | None |
WebContainer | None | None |
WebserverPluginSettings | None | None |
WorkManagerProvider | None | None |
Return value
The command returns the name of the properties file that the system creates.
Batch mode example usage
AdminTask.extractConfigProperties('-configData Node=myNode -propertiesFileName myNodeProperties.props
-zipFileName myZipFile.zip')
AdminTask.extractConfigProperties(['-configData', 'Node=myNode', '-propertiesFileName',
'myNodeProperties.props', '-zipFileName', 'myZipFile.zip'])
Interactive mode example usage
AdminTask.extractConfigProperties('-interactive')
for vhost in AdminConfig.list( 'VirtualHost' ).splitlines() :
name = AdminConfig.showAttribute( vhost, 'name' )
parms = '[-propertiesFileName ' + name + '.properties -configData VirtualHost=' + name + '
-options [[PortablePropertiesFile true]] ]'
AdminTask.extractConfigProperties(parms)
This example
produces a <VIRTUALHOSTNAME>.properties file for each virtualHost
in the cell.The validateConfigProperties command verifies that the properties in the properties file are valid and can be successfully applied to the new configuration.
Target object
None.
Required parameters
Optional parameters
Return value
The command returns a value of true if the system validates the properties file or policy set .zip file.
Batch mode example usage
AdminTask.validateConfigProperties('-propertiesFileName myNodeProperties.props -zipFileName
myZipFile.zip -reportFileName report.txt')
AdminTask.validateConfigProperties(['-propertiesFileName', 'myNodeProperties.props', '-zipFileName',
'myZipFile.zip', '-reportFileName', 'report.txt'])
Interactive mode example usage
AdminTask.validateConfigProperties('-interactive')