wsadmin スクリプトを使用する AdminTask オブジェクトの PropertiesBasedConfiguration コマンド・グループ
スクリプトを使用することによって、システム構成の 一部をプロパティー・ファイルを使用してカスタマイズできます。WebSphere 構成リポジトリー には、さまざまなタイプの構成が保管されます。これらの構成の一部を プロパティー・ファイルを使用してカスタマイズすることができます。WebSphere Common Configuration Model (WCCM) によって 作成された構成や、Java EE アプリケーションとして デプロイされた構成をカスタマイズできます。
WebSphere Common Configuration Model は スクリプト内で AdminConfig コマンドを使用して構成されます。AdminConfig.types() は WCCM の タイプをリストし、AdminConfig.attributes("type") は特定のタイプ の属性をリストします。一般的に、これらのタイプをプロパティー・ファイルを 使用してカスタマイズするほうが、スクリプトを作成して同じ変更を 行うようにするよりも簡単です。実稼働環境では、Java EE アプリケーション は、多くの場合、スクリプト内の AdminApp コマンド によってデプロイされます。開発環境の場合、プロパティー・ファイルを 使用すると、アプリケーションの管理に必要なパラメーター を組み立てる際に構文を理解しやすくなります。アプリケーションのデプロイ で使用される WCCM タイプの集合は、アプリケーション独自のものであることに注意してください。
- SIBus
- ビジネス・レベル・アプリケーション
- 鍵ファイルおよびトラストストア・ファイル
- Web サービス・ポリシー・セット・ファイル
- ファイル・ベースのユーザー・レジストリー
- 『プロパティー・ファイルを使用した特定構成オブジェクトの管理』に 記述されているサンプルを調べます。
- 適用可能なサンプルをコピーしてテキスト・ファイルに貼り付け、必要に応じてそれらのサンプルを 編集し、適切な変数置換とともにそれらのサンプルを環境に適用します。一般的に使用される広範囲な構成をカバーする 多数のサンプルが用意されています。
- サポートされている WCCM タイプの場合、開始点としてそのタイプを既存のセルから
抽出し、抽出したファイルを編集し、それを元の既存セルに
適用することができます。
Cell、Node、Server、または ServerCluster ではない、サポートされている WCCM タイプ の場合、移植可能なファイル・フォーマットを作成するためにオプション -options [[PortablePropertiesFile true]] を 指定して、その特定のタイプを既存のセルから抽出 します。次に、このプロパティー・ファイルを編集し、 それを適切な変数置換とともに別のセルに適用します。 この手法を使用して、よく利用される構成サブセット (リソース 定義や Java 仮想マシン (JVM) 設定など) を、ある環境から別の 環境に移動することができます。

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 | セル | 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 |
フィルター | 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 | 鍵 |
KeyManager | KeyReference | KeySet | KeySetGroup |
KeyStore | KeyStoreFile | LDAPSearchFilter | LDAPUserRegistry |
LTPA | ライブラリー | LibraryRef | ListenerPort |
LocalOSUserRegistry | MOfNPolicy | MQConnectionFactory | MQFAPInboundChannel |
MQFAPOutboundChannel | MQQueue | MQQueueConnectionFactory | MQTopic |
MQTopicConnectionFactory | MailProvider | MailSession | ManagementScope |
MappingModule | MemoryCacheEvictionPolicy | MessageLayer | MessageListener |
MessageListenerService | MessageQOP | MimeEntry | MonitoringPolicy |
NameServer | NoOpPolicy | ノード | ノード・グループ |
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 | セキュリティー | SecurityDomain | SecurityPermission |
SecurityProtocolQOP | サーバー | 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 |
applyConfigProperties
applyConfigProperties コマンドは、特定のプロパティー・ファイル内のプロパティーを、構成に適用します。 特定のプロパティーが存在しない場合、システムは構成に属性または構成データを追加します。 構成にプロパティーが存在する場合、システムはその属性に新しい値を設定します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -propertiesFileName
- 適用するプロパティー・ファイルの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -variablesMapFileName
- 変数マップ・ファイルの名前を指定します。 これは、プロパティー・ファイルの中からシステムが使用する変数の値が含まれているファイルです。(ストリング、オプション)
- -variablesMap
- プロパティー・ファイルで使用する変数の値を指定します。 (プロパティー、オプション)
- -reportFileName
- applyConfigProperties コマンド用の出力が含まれるレポート・ファイルの名前を指定します。(ストリング、オプション)
- -reportFilterMechanism
- レポート・フィルター・メカニズムのタイプを指定します。すべてのレポート情報を表示する場合は、All を指定します。 エラー情報を表示するには Errors を指定します。 エラーおよび変更情報を表示するには Errors_And_Changes を指定します。 (ストリング、オプション)
- -validate
- 変更を適用する前にプロパティー・ファイルを妥当性検査するかどうかを指定します。 デフォルトでは、このコマンドはプロパティー・ファイルを妥当性検査します。妥当性検査を無効にするには false と指定します。(ブール値、オプション)
- -zipFileName
- セルに適用するポリシー・セットが入った圧縮ファイルの名前を指定します。 (ストリング、オプション)
戻り値
このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.applyConfigProperties('-propertiesFileName myPropFile.props -zipFileName myZipFile.zip -validate true')
- Jython リストを使用:
AdminTask.applyConfigProperties(['-propertiesFileName', 'myPropFile.props', '-zipFileName', 'myZipFile.zip', '-validate', 'true'])
対話モードの使用例
- Jython を使用:
AdminTask.applyConfigProperties('-interactive')
createPropertiesFileTemplates
createPropertiesFileTemplates コマンドは、特定のオブジェクト・タイプの作成または削除に使用するテンプレート・プロパティー・ファイルを作成します。 このコマンドは、propertiesFileName パラメーターで指定されたプロパティー・ファイルにテンプレート・プロパティー・ファイルを保管します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -propertiesFileName
- テンプレートを保管するプロパティー・ファイルの名前を指定します。(ストリング、必須)
- -configType
- 作成するテンプレートのリソース・タイプを指定します。(ストリング、必須)
- サーバー・タイプのプロパティー・ファイル・テンプレートを作成する場合は、Server を指定します。
- サーバー・クラスター・タイプのプロパティー・ファイル・テンプレートを作成する場合は、ServerCluster を指定します。
- アプリケーション・タイプのプロパティー・ファイル・テンプレートを作成する場合は、Application を指定します。
- 許可グループ・タイプのプロパティー・ファイル・テンプレートを作成する場合は、AuthorizationGroup を指定します。
オプション・パラメーター
なし戻り値
このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createPropertiesFileTemplates('-propertiesFileName serverTemplate.props -configType Server')
- Jython リストを使用:
AdminTask.createPropertiesFileTemplates(['-propertiesFileName', 'serverTemplate.props', '-configType', 'Server'])
対話モードの使用例
- Jython を使用:
AdminTask.createPropertiesFileTemplates('-interactive')
deleteConfigProperties
deleteConfigProperties コマンドは、プロパティー・ファイルの指定に従って、構成内のプロパティーを削除します。 システムは、プロパティー・ファイル内の各プロパティーに対応する属性または構成データを除去します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -propertiesFileName
- 削除するプロパティー・ファイルの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -variablesMapFileName
- 変数マップ・ファイルの名前を指定します。 これは、プロパティー・ファイルの中からシステムが使用する変数の値が含まれているファイルです。(ストリング、オプション)
- -variablesMap
- プロパティー・ファイルで使用する変数の値を指定します。 (プロパティー、オプション)
- -reportFileName
- コマンドの出力を記述するレポート・ファイルの名前を指定します。(ストリング、オプション)
- -reportFilterMechanism
- レポート・フィルター・メカニズムのタイプを指定します。すべてのレポート情報を表示する場合は、All を指定します。 エラー情報を表示するには Errors を指定します。 エラーおよび変更情報を表示するには Errors_And_Changes を指定します。 (ストリング、オプション)
- -validate
- 変更を適用する前にプロパティー・ファイルを妥当性検査するかどうかを指定します。 デフォルトでは、このコマンドはプロパティー・ファイルを妥当性検査します。妥当性検査を無効にするには false と指定します。(ブール値、オプション)
戻り値
このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteConfigProperties('-propertiesFileName myPropFile.props')
- Jython リストを使用:
AdminTask.deleteConfigProperties(['-propertiesFileName', 'myPropFile.props'])
対話モードの使用例
- Jython を使用:
AdminTask.deleteConfigProperties('-interactive')
extractConfigProperties
extractConfigProperties コマンドは、プロパティー・ファイルの形式で構成データを抽出します。システムは、最もよく使用される構成データおよび属性をエクスポートし、その属性をプロパティーに変換して、データをファイルに保存します。対象のリソースは、ターゲット・オブジェクトまたは configData パラメーターで指定することができます。configData パラメーターを使用して、サーバー、ノード、クラスター、ポリシー・セット、またはアプリケーション・インスタンスを指定します。 構成オブジェクトを指定しないと、このコマンドはプロファイル構成データを抽出します。
ターゲット・オブジェクト
該当の構成オブジェクトのオブジェクト名を、Node=nodeName:Server=serverName というフォーマットで指定します。
必須パラメーター
- -propertiesFileName
- 抽出するプロパティー・ファイルの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -configData
- 構成オブジェクト・インスタンスを、Node=node1 のフォーマットで指定します。 (ストリング、オプション)
- -options
- GENERATETEMPLATE=true などの、追加構成オプションを指定します。 (プロパティー、オプション)
- -filterMechanism
- 構成プロパティーを抽出するためのフィルター情報を指定します。 (ストリング、オプション)
- すべての構成プロパティーを抽出するには、All を指定します。
- サブタイプを含めずに特定のオブジェクトのプロパティーを抽出するには、NO_SUBTYPES を指定します。
- selectedSubTypes パラメーターで指定された特定の構成オブジェクト・サブタイプを抽出するには、SELECTED_SUBTYPES を指定します。 これには、構成オブジェクトに対応する任意のサブタイプ、またはオブジェクト・タイプ階層内にある任意の WCCM タイプを含めることができます。
- -selectedSubTypes
- コマンドがプロパティーを抽出する際に含める、または除外する構成プロパティーを指定します。
このパラメーターは、filterMechanism パラメーターを NO_SUBTYPES または SELECTED_SUBTYPES に設定する場合に指定してください。
以下のストリングは、サブタイプが ApplicationServer および EJBContainer の例です。(ストリング、オプション)
表 2. extractConfigProperties -selectedSubTypes の サブタイプおよび拡張子. オブジェクトのタイプおよびサブタイプのプロパティーを構成できます。 構成オブジェクト・タイプ サブタイプ 拡張子 AdminService なし なし デプロイメント ApplicationName なし ApplicationServer TransactionService、DynamicCache、WebContainer、EJBContainer、 PortletContainer、SIPContainer、WebserverPluginSettings なし AuthorizationGroup なし なし AuthorizationTableExt なし なし セル VirtualHost、DataReplicationDomain、ServerCluster、CoreGroup、 NodeGroup、AuthorizationGroup、AuthorizationTableExt、Security、J2CResourceAdapter、 JDBCProvider、JMSProvider、MailProvider、URLProvider、EventInfrastructureProvider、 ObjectPoolProvider、WorkManagerProvider、TimerManagerProvider、SchedulerProvider、 Node、VariableMap なし CoreGroup なし なし CoreGroupBridgeService なし なし DynamicCache なし なし EJBContainer なし なし EventInfrastructureProvider なし なし EventInfrastructureService なし なし HAManagerService なし なし J2CResourceAdapter なし なし JDBCProvider なし なし JMSProvider なし なし JavaVirtualMachine なし なし ライブラリー なし なし MailProvider なし なし NameServer なし なし ノード Server、J2CResourceAdapter、JDBCProvider、JMSProvider、 MailProvider、URLProvider、EventInfrastructureProvider、ObjectPoolProvider、 WorkManagerProvider、TimerManagerProvider、SchedulerProvider、VariableMap NodeMetadata Extension はノード・メタデータ・プロパティーを抽出します。 ノード・グループ なし なし ObjectPoolProvider なし なし ObjectRequestBroker なし なし PMEServerExtension なし なし PMIModule なし なし PMIService なし なし PortletContainer なし なし SIPContainer なし なし SchedulerProvider なし なし セキュリティー JAASAuthData なし サーバー PMIService、AdminService、CoreGroupBridgeService、TPVService、 ObjectRequestBroker、ApplicationServer、NameServer、J2CResourceAdapter、JDBCProvider、 JMSProvider、MailProvider、URLProvider、EventInfrastructureProvider、ObjectPoolProvider、 WorkManagerProvider、TimerManagerProvider、SchedulerProvider、VariableMap、 EventInfrastructureService、PMEServerExtension、Library、HAManagerService、 PMIModule、Security この拡張子を使用すると、特定のサーバーにデプロイされたアプリケーションがリストされます。 ServerCluster J2CResourceAdapter、JDBCProvider、JMSProvider、MailProvider 、URLProvider、ObjectPoolProvider、WorkManagerProvider、TimerManagerProvider、 SchedulerProvider、VariableMap この拡張子を使用すると、特定のクラスターにデプロイされたアプリケーションがリストされます。 TPVService なし なし TimerManagerProvider なし なし TransactionService なし なし URLProvider なし なし VariableMap なし なし VirtualHost なし なし WebContainer なし なし WebserverPluginSettings なし なし WorkManagerProvider なし なし - -zipFileName
- ポリシー・セットを抽出する圧縮ファイルの名前を指定します。(ストリング、オプション)
戻り値
このコマンドは、システムによって作成されるプロパティー・ファイルの名前を返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.extractConfigProperties('-configData Node=myNode -propertiesFileName myNodeProperties.props -zipFileName myZipFile.zip')
- Jython リストを使用:
AdminTask.extractConfigProperties(['-configData', 'Node=myNode', '-propertiesFileName', 'myNodeProperties.props', '-zipFileName', 'myZipFile.zip'])
対話モードの使用例
- Jython ストリングを使用:
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)
この例では、セル内の virtualHost ごとに <VIRTUALHOSTNAME>.properties ファイルが作成されます。validateConfigProperties
validateConfigProperties コマンドは、プロパティー・ファイル内のプロパティーが有効であり、新規の構成に正常に適用できるかどうかを確認します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -propertiesFileName
- 検証するプロパティー・ファイルの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -variablesMapFileName
- 変数マップ・ファイルの名前を指定します。 これは、プロパティー・ファイルの中からシステムが使用する変数の値が含まれているファイルです。(ストリング、オプション)
- -variablesMap
- プロパティー・ファイルで使用する変数の値を指定します。 (プロパティー、オプション)
- -reportFileName
- applyConfigProperties コマンド用の出力が含まれるレポート・ファイルの名前を指定します。(ストリング、オプション)
- -reportFilterMechanism
- レポート・フィルター・メカニズムのタイプを指定します。すべてのレポート情報を表示する場合は、All を指定します。 エラー情報を表示するには Errors を指定します。 エラーおよび変更情報を表示するには Errors_And_Changes を指定します。 (ストリング、オプション)
- -zipFileName
- セルに適用するポリシー・セットが入った圧縮ファイルの名前を指定します。 (ストリング、オプション)
戻り値
このコマンドは、システムがプロパティー・ファイルまたはポリシー・セットの .zip ファイルを検証する場合に、値 true を返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.validateConfigProperties('-propertiesFileName myNodeProperties.props -zipFileName myZipFile.zip -reportFileName report.txt')
- Jython リストを使用:
AdminTask.validateConfigProperties(['-propertiesFileName', 'myNodeProperties.props', '-zipFileName', 'myZipFile.zip', '-reportFileName', 'report.txt'])
対話モードの使用例
- Jython を使用:
AdminTask.validateConfigProperties('-interactive')