Utilisation du groupe de commandes PropertiesBasedConfiguration de l'objet AdminTask avec les scripts de wsadmin
Vous pouvez utiliser le scriptage pour personnaliser une partie de la configuration système à l'aide de fichiers de propriétés. Le référentiel de configuration WebSphere stocke de nombreux types différents de configuration. Vous pouvez utiliser des fichiers de propriétés pour personnaliser certaines de ces configurations. Vous pouvez personnaliser certaines configurations créées par WebSphere Common Configuration Model (WCCM) ou les configurations déployées en tant qu'applications Java EE.
Pour configurer WebSphere Common Configuration Model, utilisez la commande AdminConfig dans le scriptage. AdminConfig.types() répertorie les types dans WCCM, et AdminConfig.attributes("type") dresse la liste des attributs pour un type spécifique. La personnalisation de ces types à l'aide de fichiers de propriétés est souvent plus aisée que la rédaction d'un script destiné à effectuer les mêmes modifications. Dans un environnement de production, les applications Java EE sont souvent déployées via la commande AdminApp dans le scriptage. Dans un environnement de développement, l'utilisation d'un fichier de propriétés facilite la compréhension de la syntaxe pendant la construction des paramètres nécessaires à la gestion de l'application. Notez que le déploiement de l'application utilise son propre ensemble de types WCCM.
- SIBus
- Applications de niveau métier
- Fichiers de clés et de clés certifiées
- Fichiers de l'ensemble de règles des services Web
- Registre d'utilisateurs basé sur un fichier
- Examinez les exemples documentés dans la section relative à la gestion des objets de configuration spécifiques à l'aide de fichiers de propriétés.
- Copiez et collez les exemples applicables dans un fichier texte, éditez-les si nécessaire et appliquez-les à votre environnement en effectuant les substitutions de variable appropriées. Il existe de nombreux exemples censés couvrir une large gamme de configurations généralement utilisées.
- Pour un type WCCM pris en charge, vous pouvez extraire ce type
d'une cellule existante comme point de départ, modifier le fichier
extrait et l'appliquer à nouveau à la cellule existante.
Pour les types WCCM non pris en charge autres que Cell, Node, Server ou ServerCluster, procédez à l'extraction du type spécifique à partir d'une cellule existante avec l'option -options [[PortablePropertiesFile true]] pour créer un format de fichier portable. Editez ensuite le fichier de propriétés et appliquez-le à une autre cellule en effectuant les substitutions de variable appropriées. Vous pouvez procéder ainsi pour déplacer des sous-ensembles de configurations généralement utilisées, comme des définitions de ressources et des paramètres JVM (Java Virtual Machine) d'un environnement à un autre.

AccessPointGroup | ActivationSpec | ActivationSpecTemplateProps | ActivitySessionService |
---|---|---|---|
AdminObject | AdminObjectTemplateProps | AdminServerAuthentication | AdminService |
AllActivePolicy | AllAuthenticatedUserExt | AllAuthenticatedUsersInTrustedRealmsExt | ApplicationProfileService |
ApplicationServer | Audit | AuditEventFactory | AuditNotificationMonitor |
AuditPolicy | AuditServiceProvider | AuditSpecification | AuthenticationMechanism |
AuthenticationTarget | AuthorizationConfig | GroupeAutorisations | AuthorizationGroupMember |
AuthorizationProvider | AuthorizationTableExt | AuthorizationTableImpl | BackupCluster |
BridgeInterface | CACertificate | CAClient | CMPConnectorFactory |
CacheProvider | Cellule | 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 |
Filtre | 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 | Bibliothèque | LibraryRef | ListenerPort |
LocalOSUserRegistry | MOfNPolicy | MQConnectionFactory | MQFAPInboundChannel |
MQFAPOutboundChannel | MQQueue | MQQueueConnectionFactory | MQTopic |
MQTopicConnectionFactory | MailProvider | MailSession | ManagementScope |
MappingModule | MemoryCacheEvictionPolicy | MessageLayer | MessageListener |
MessageListenerService | MessageQOP | MimeEntry | MonitoringPolicy |
NameServer | NoOpPolicy | Noeud | Groupe de noeuds |
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 | Serveur | Cluster de serveurs | 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
La commande applyConfigProperties applique à la configuration des propriétés contenues dans un fichier de propriétés déterminé. Si une propriété spécifique est absente, le système ajoute des attributs ou des données de configuration à la configuration. Si les propriétés existent dans la configuration, le système définit les nouvelles valeurs des attributs.
Objet cible
Aucune.
Paramètres obligatoires
- -propertiesFileName
- Indique le nom du fichier de propriétés à appliquer. (Chaîne, obligatoire)
Paramètres facultatifs
- -variablesMapFileName
- Indique le nom du fichier de mappe de variables. Ce fichier contient des valeurs pour les variables que le système utilise à partir du fichier de propriétés. (Chaîne, facultatif)
- -variablesMap
- Indique les valeurs des variables à utiliser avec le fichier de propriétés. (Propriétés, facultatif)
- -reportFileName
- Indique le nom d'un fichier de rapport contenant la sortie de la commande applyConfigProperties. (Chaîne, facultatif)
- -reportFilterMechanism
- Indique le type de mécanisme de filtrage des rapports. Indiquez Tout pour afficher toutes les informations des rapports. Indiquez Erreurs pour afficher les informations relatives aux erreurs. Indiquez Erreurs_Et_Modif pour afficher les informations relatives aux erreurs et aux modifications. (Chaîne, facultatif)
- -validate
- Indique si le fichier de propriétés doit ou non être validé avant d'appliquer les modifications. Par défaut, la commande valide le fichier de propriétés. Indiquez false pour désactiver la validation. (Booléen, facultatif)
- -zipFileName
- Indique le nom du fichier compressé qui contient l'ensemble de règles que vous souhaitez appliquer à la cellule. (Chaîne, facultatif)
Valeur renvoyée
La commande ne renvoie pas de sortie.
Syntaxe d'un exemple de mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.applyConfigProperties('-propertiesFileName myPropFile.props -zipFileName myZipFile.zip -validate true')
- Avec une liste Jython :
AdminTask.applyConfigProperties(['-propertiesFileName', 'myPropFile.props', '-zipFileName', 'myZipFile.zip', '-validate', 'true'])
Syntaxe d'un exemple de mode interactif
- Avec Jython :
AdminTask.applyConfigProperties('-interactive')
createPropertiesFileTemplates
La commande createPropertiesFileTemplates crée un modèle de fichier de propriétés à utiliser pour créer ou supprimer des types d'objet spécifiques. La commande stocke le modèle de fichier de propriétés dans le fichier de propriétés indiqué par le paramètre propertiesFileName.
Objet cible
Aucune.
Paramètres obligatoires
- -propertiesFileName
- Indique le nom du fichier de propriétés dans lequel le modèle est stocké. (Chaîne, obligatoire)
- -configType
- Indique le type de ressources du modèle à créer. (Chaîne, obligatoire)
- Indiquez Server (serveur) pour créer un modèle de fichier de propriétés de type serveur.
- Indiquez ServerCluster (cluster de serveurs) pour créer un modèle de fichier de propriétés de type cluster de serveurs.
- Indiquez Application pour créer un modèle de fichier de propriétés de type application.
- Indiquez AuthorizationGroup (groupe d'autorisations) pour créer un modèle de fichier de propriétés de type groupe d'autorisations.
Paramètres facultatifs
AucunValeur renvoyée
La commande ne renvoie pas de sortie.
Syntaxe d'un exemple de mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.createPropertiesFileTemplates('-propertiesFileName ModèleServeur.props -configType Server')
- Avec une liste Jython :
AdminTask.createPropertiesFileTemplates(['-propertiesFileName', 'ModèleServeur.props', '-configType', 'Serveur'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.createPropertiesFileTemplates('-interactive')
deleteConfigProperties
La commande deleteConfigProperties supprime de la configuration des propriétés désignées dans un fichier de propriétés. Le système supprime les attributs ou les données de configuration correspondant à chaque propriété indiquée dans le fichier de propriétés.
Objet cible
Aucune.
Paramètres obligatoires
- -propertiesFileName
- Indique le nom du fichier de propriétés à supprimer. (Chaîne, obligatoire)
Paramètres facultatifs
- -variablesMapFileName
- Indique le nom du fichier de mappe de variables. Ce fichier contient des valeurs pour les variables que le système utilise à partir du fichier de propriétés. (Chaîne, facultatif)
- -variablesMap
- Indique les valeurs des variables à utiliser avec le fichier de propriétés. (Propriétés, facultatif)
- -reportFileName
- Indique le nom d'un fichier de rapport qui contient la sortie de la commande. (Chaîne, facultatif)
- -reportFilterMechanism
- Indique le type de mécanisme de filtrage des rapports. Indiquez Tout pour afficher toutes les informations des rapports. Indiquez Erreurs pour afficher les informations relatives aux erreurs. Indiquez Erreurs_Et_Modif pour afficher les informations relatives aux erreurs et aux modifications. (Chaîne, facultatif)
- -validate
- Indique si le fichier de propriétés doit ou non être validé avant d'appliquer les modifications. Par défaut, la commande valide le fichier de propriétés. Indiquez false pour désactiver la validation. (Booléen, facultatif)
Valeur renvoyée
La commande ne renvoie pas de sortie.
Syntaxe d'un exemple de mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.deleteConfigProperties('-propertiesFileName MonFichierProp.props')
- Avec une liste Jython :
AdminTask.deleteConfigProperties(['-propertiesFileName', 'MonFichierProp.props'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.deleteConfigProperties('-interactive')
extractConfigProperties
La commande extractConfigProperties extrait les données de configuration sous la forme d'un fichier de propriétés. Le système exporte les données et les attributs de configuration les plus couramment utilisés, convertit les attributs en propriétés, puis sauvegarde les données dans un fichier. Vous pouvez indiquer la ressource d'intérêt avec l'objet cible ou le paramètre configData. Le paramètre configData permet d'indiquer un serveur, un noeud, un cluster, un ensemble de règles ou une instance d'application. Si aucun objet de configuration n'est indiqué, la commande extrait les données de configuration du profil.
Objet cible
Indique le nom d'objet de l'objet de configuration qui vous intéresse, au format : Node=NomNoeud:Server=NomServeur
Paramètres obligatoires
- -propertiesFileName
- Indique le nom du fichier de propriétés à extraire. (Chaîne, obligatoire)
Paramètres facultatifs
- -configData
- Indique l'instance d'objet de configuration selon le format Node=node1. (Chaîne, facultatif)
- -options
- Indique les options de configuration supplémentaires, telles que GENERATETEMPLATE=true. (Propriétés, facultatif)
- -filterMechanism
- Indique les informations de filtrage pour l'extraction des propriétés de configuration. (Chaîne, facultatif)
- Indiquez Tout pour extraire toutes les propriétés de configuration.
- Indiquez NO_SUBTYPES pour extraire les propriétés de l'objet donné sans inclure les sous-types.
- Indiquez SELECTED_SUBTYPES pour extraire des sous-types d'objet de configuration spécifiques précisés avec le paramètre selectedSubTypes. Il peut s'agir de tout sous-type d'un objet de configuration ou de tout type WCCM existant dans la hiérarchie des types d'objets.
- -selectedSubTypes
- Indique les propriétés de configuration à inclure ou exclure lorsque
la commande extrait les propriétés. Indiquez ce paramètre si
vous définissez le paramètre filterMechanism
avec la valeur NO_SUBTYPES ou
SELECTED_SUBTYPES.
Les chaînes
suivantes sont des exemples de sous-types : ApplicationServer, EJBContainer. (Chaîne, facultatif)
Tableau 2. Sous-types et extensions de extractConfigProperties -selectedSubTypes. Vous pouvez configurer les propriétés des types et des sous-types d'objet. Type d'objet de configuration Sous-types Extensions AdminService Aucun Aucun Déploiement ApplicationName Aucun ApplicationServer TransactionService, DynamicCache, WebContainer, EJBContainer, PortletContainer, SIPContainer, WebserverPluginSettings Aucun GroupeAutorisations Aucun Aucun AuthorizationTableExt Aucun Aucun Cellule VirtualHost, DataReplicationDomain, ServerCluster, CoreGroup, NodeGroup, AuthorizationGroup, AuthorizationTableExt, Security, J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, EventInfrastructureProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, Node, VariableMap Aucun CoreGroup Aucun Aucun CoreGroupBridgeService Aucun Aucun DynamicCache Aucun Aucun EJBContainer Aucun Aucun EventInfrastructureProvider Aucun Aucun EventInfrastructureService Aucun Aucun HAManagerService Aucun Aucun J2CResourceAdapter Aucun Aucun JDBCProvider Aucun Aucun JMSProvider Aucun Aucun JavaVirtualMachine Aucun Aucun Bibliothèque Aucun Aucun MailProvider Aucun Aucun NameServer Aucun Aucun Noeud Server, J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, EventInfrastructureProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, VariableMap L'extension NodeMetadata Extension extrait les propriétés Metadata du noeud. Groupe de noeuds Aucun Aucun ObjectPoolProvider Aucun Aucun ObjectRequestBroker Aucun Aucun PMEServerExtension Aucun Aucun PMIModule Aucun Aucun PMIService Aucun Aucun PortletContainer Aucun Aucun SIPContainer Aucun Aucun SchedulerProvider Aucun Aucun Security JAASAuthData Aucun Serveur PMIService, AdminService, CoreGroupBridgeService, TPVService, ObjectRequestBroker, ApplicationServer, NameServer, J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, EventInfrastructureProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, VariableMap, EventInfrastructureService, PMEServerExtension, Library, HAManagerService, PMIModule, Security L'extension recense les applications déployées pour un serveur spécifique. Cluster de serveurs J2CResourceAdapter, JDBCProvider, JMSProvider, MailProvider, URLProvider, ObjectPoolProvider, WorkManagerProvider, TimerManagerProvider, SchedulerProvider, VariableMap L'extension recense les applications déployées pour un cluster spécifique. TPVService Aucun Aucun TimerManagerProvider Aucun Aucun TransactionService Aucun Aucun URLProvider Aucun Aucun VariableMap Aucun Aucun VirtualHost Aucun Aucun WebContainer Aucun Aucun WebserverPluginSettings Aucun Aucun WorkManagerProvider Aucun Aucun - -zipFileName
- Indique le nom du fichier compressé dans lequel vous voulez extraire les ensembles de règles. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie le nom du fichier de propriétés que le système crée.
Syntaxe d'un exemple de mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.extractConfigProperties('-configData Node=myNode -propertiesFileName myNodeProperties.props -zipFileName myZipFile.zip')
- Avec une liste Jython :
AdminTask.extractConfigProperties(['-configData', 'Node=myNode', '-propertiesFileName', 'myNodeProperties.props', '-zipFileName', 'myZipFile.zip'])
Syntaxe d'un exemple de mode interactif
- A l'aide de
la chaîne 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)
Cet exemple permet de générer
un fichier <VIRTUALHOSTNAME>.properties pour chaque virtualHost
dans la cellule.validateConfigProperties
La commande validateConfigProperties vérifie que les propriétés du fichier de propriétés sont valides et peuvent être correctement appliquées à la nouvelle configuration.
Objet cible
Aucune.
Paramètres obligatoires
- -propertiesFileName
- Indique le nom du fichier de propriétés à valider. (Chaîne, obligatoire)
Paramètres facultatifs
- -variablesMapFileName
- Indique le nom du fichier de mappe de variables. Ce fichier contient des valeurs pour les variables que le système utilise à partir du fichier de propriétés. (Chaîne, facultatif)
- -variablesMap
- Indique les valeurs des variables à utiliser avec le fichier de propriétés. (Propriétés, facultatif)
- -reportFileName
- Indique le nom d'un fichier de rapport contenant la sortie de la commande applyConfigProperties. (Chaîne, facultatif)
- -reportFilterMechanism
- Indique le type de mécanisme de filtrage des rapports. Indiquez Tout pour afficher toutes les informations des rapports. Indiquez Erreurs pour afficher les informations relatives aux erreurs. Indiquez Erreurs_Et_Modif pour afficher les informations relatives aux erreurs et aux modifications. (Chaîne, facultatif)
- -zipFileName
- Indique le nom du fichier compressé qui contient l'ensemble de règles que vous souhaitez appliquer à la cellule. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie la valeur true si le système valide le fichier de propriétés ou le fichier .zip de l'ensemble de règles.
Syntaxe d'un exemple de mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.validateConfigProperties('-propertiesFileName myNodeProperties.props -zipFileName myZipFile.zip -reportFileName report.txt')
- Avec une liste Jython :
AdminTask.validateConfigProperties(['-propertiesFileName', 'myNodeProperties.props', '-zipFileName', 'myZipFile.zip', '-reportFileName', 'report.txt'])
Syntaxe d'un exemple de mode interactif
- En langage Jython :
AdminTask.validateConfigProperties('-interactive')