Oracle® Fusion MiddlewareWebLogic Scripting Tool Command Reference

11g Release 1 (10.3.4)

E13813-08

January 2011

This document describes all of the commands that are available to use with the WebLogic Scripting Tool (WLST). This document includes WLST commands for WebLogic Server, as well as custom WLST commands that can be used to manage installed Oracle Fusion Middleware components.

Oracle Fusion Middleware WebLogic Scripting Tool Command Reference, 11g Release 1 (10.3.4)

E13813-08

Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

iii

Contents

Preface ............................................................................................................................................................. xxiii

Documentation Accessibility ................................................................................................................. xxiiiConventions ............................................................................................................................................. xxiii

1 Introduction and Roadmap

1.1 Document Scope and Audience................................................................................................ 1-11.2 Guide to This Document............................................................................................................ 1-11.3 Related Documentation.............................................................................................................. 1-31.4 New and Changed WLST Features in This Release............................................................... 1-3

2 WebLogic Server WLST Online and Offline Command Reference

2.1 WebLogic Server WLST Command Summary, Alphabetically By Command.................. 2-12.2 WebLogic Server WLST Online Command Summary.......................................................... 2-62.3 WebLogic Server WLST Offline Command Summary....................................................... 2-10

3 WLST Command and Variable Reference

3.1 Overview of WLST Command Categories.............................................................................. 3-13.2 Browse Commands..................................................................................................................... 3-23.2.1 cd ............................................................................................................................................ 3-23.2.2 currentTree............................................................................................................................ 3-33.2.3 prompt................................................................................................................................... 3-43.2.4 pwd ........................................................................................................................................ 3-53.3 Control Commands .................................................................................................................... 3-53.3.1 addTemplate......................................................................................................................... 3-63.3.2 closeDomain ......................................................................................................................... 3-73.3.3 closeTemplate....................................................................................................................... 3-73.3.4 connect................................................................................................................................... 3-73.3.5 createDomain .................................................................................................................... 3-113.3.6 disconnect .......................................................................................................................... 3-123.3.7 exit....................................................................................................................................... 3-123.3.8 readDomain ....................................................................................................................... 3-133.3.9 readTemplate..................................................................................................................... 3-143.3.10 updateDomain .................................................................................................................. 3-153.3.11 writeDomain...................................................................................................................... 3-153.3.12 writeTemplate ................................................................................................................... 3-16

iv

3.4 Customization Commands..................................................................................................... 3-173.4.1 addHelpCommandGroup ............................................................................................... 3-173.4.2 addHelpCommand........................................................................................................... 3-183.5 Deployment Commands......................................................................................................... 3-193.5.1 deploy................................................................................................................................. 3-203.5.2 distributeApplication ....................................................................................................... 3-233.5.3 getWLDM........................................................................................................................... 3-243.5.4 listApplications ................................................................................................................. 3-253.5.5 loadApplication ................................................................................................................ 3-253.5.6 redeploy ............................................................................................................................. 3-263.5.7 startApplication ................................................................................................................ 3-273.5.8 stopApplication................................................................................................................. 3-283.5.9 undeploy ............................................................................................................................ 3-293.5.10 updateApplication............................................................................................................ 3-303.6 Diagnostics Commands .......................................................................................................... 3-303.6.1 exportDiagnosticData ...................................................................................................... 3-313.6.2 exportDiagnosticDataFromServer.................................................................................. 3-323.6.3 getAvailableCapturedImages ......................................................................................... 3-333.6.4 saveDiagnosticImageCaptureFile................................................................................... 3-343.6.5 saveDiagnosticImageCaptureEntryFile......................................................................... 3-353.7 Editing Commands.................................................................................................................. 3-363.7.1 activate................................................................................................................................ 3-373.7.2 assign .................................................................................................................................. 3-383.7.3 cancelEdit ........................................................................................................................... 3-403.7.4 create................................................................................................................................... 3-413.7.5 delete................................................................................................................................... 3-423.7.6 encrypt................................................................................................................................ 3-433.7.7 get........................................................................................................................................ 3-443.7.8 getActivationTask............................................................................................................. 3-443.7.9 invoke ................................................................................................................................. 3-453.7.10 isRestartRequired.............................................................................................................. 3-463.7.11 loadDB................................................................................................................................ 3-463.7.12 loadProperties ................................................................................................................... 3-473.7.13 save ..................................................................................................................................... 3-483.7.14 set ........................................................................................................................................ 3-483.7.15 setOption............................................................................................................................ 3-493.7.16 showChanges .................................................................................................................... 3-513.7.17 startEdit .............................................................................................................................. 3-513.7.18 stopEdit .............................................................................................................................. 3-523.7.19 unassign ............................................................................................................................. 3-533.7.20 undo.................................................................................................................................... 3-553.7.21 validate ............................................................................................................................... 3-553.8 Information Commands.......................................................................................................... 3-563.8.1 addListener ........................................................................................................................ 3-573.8.2 configToScript ................................................................................................................... 3-583.8.3 dumpStack ......................................................................................................................... 3-593.8.4 dumpVariables.................................................................................................................. 3-59

v

3.8.5 find ...................................................................................................................................... 3-603.8.6 getConfigManager............................................................................................................ 3-613.8.7 getMBean ........................................................................................................................... 3-613.8.8 getMBI ................................................................................................................................ 3-623.8.9 getPath................................................................................................................................ 3-623.8.10 listChildTypes ................................................................................................................... 3-633.8.11 lookup................................................................................................................................. 3-633.8.12 ls .......................................................................................................................................... 3-643.8.13 man ..................................................................................................................................... 3-673.8.14 redirect................................................................................................................................ 3-683.8.15 removeListener.................................................................................................................. 3-683.8.16 showListeners.................................................................................................................... 3-693.8.17 startRecording ................................................................................................................... 3-693.8.18 state ..................................................................................................................................... 3-703.8.19 stopRecording ................................................................................................................... 3-713.8.20 stopRedirect ....................................................................................................................... 3-713.8.21 storeUserConfig ................................................................................................................ 3-713.8.22 threadDump ...................................................................................................................... 3-733.8.23 viewMBean ........................................................................................................................ 3-743.8.24 writeIniFile......................................................................................................................... 3-743.9 Life Cycle Commands ............................................................................................................. 3-753.9.1 migrate................................................................................................................................ 3-753.9.2 resume ................................................................................................................................ 3-763.9.3 shutdown ........................................................................................................................... 3-773.9.4 start ..................................................................................................................................... 3-793.9.5 startServer .......................................................................................................................... 3-803.9.6 suspend .............................................................................................................................. 3-813.10 Node Manager Commands .................................................................................................... 3-823.10.1 nm ....................................................................................................................................... 3-833.10.2 nmConnect......................................................................................................................... 3-833.10.3 nmDisconnect.................................................................................................................... 3-853.10.4 nmEnroll............................................................................................................................. 3-863.10.5 nmGenBootStartupProps................................................................................................. 3-873.10.6 nmKill ................................................................................................................................. 3-873.10.7 nmLog................................................................................................................................. 3-883.10.8 nmServerLog ..................................................................................................................... 3-893.10.9 nmServerStatus ................................................................................................................. 3-893.10.10 nmStart ............................................................................................................................... 3-903.10.11 nmVersion.......................................................................................................................... 3-913.10.12 startNodeManager............................................................................................................ 3-913.10.13 stopNodeManager ............................................................................................................ 3-923.11 Tree Commands ....................................................................................................................... 3-933.11.1 custom ................................................................................................................................ 3-933.11.2 domainConfig.................................................................................................................... 3-943.11.3 domainCustom.................................................................................................................. 3-953.11.4 domainRuntime ................................................................................................................ 3-963.11.5 edit ...................................................................................................................................... 3-97

vi

3.11.6 jndi ...................................................................................................................................... 3-983.11.7 serverConfig ...................................................................................................................... 3-983.11.8 serverRuntime ................................................................................................................... 3-993.12 WLST Variable Reference ....................................................................................................... 3-99

4 Infrastructure Security Custom WLST Commands

4.1 Overview of WSLT Security Commands ................................................................................ 4-14.2 Audit Configuration Commands ............................................................................................. 4-24.2.1 getNonJavaEEAuditMBeanName..................................................................................... 4-24.2.2 getAuditPolicy ..................................................................................................................... 4-34.2.3 setAuditPolicy ...................................................................................................................... 4-34.2.4 getAuditRepository ............................................................................................................. 4-54.2.5 setAuditRepository.............................................................................................................. 4-54.2.6 listAuditEvents..................................................................................................................... 4-64.2.7 exportAuditConfig .............................................................................................................. 4-74.2.8 importAuditConfig.............................................................................................................. 4-84.3 SSL Configuration Commands ................................................................................................. 4-94.3.1 addCertificateRequest ...................................................................................................... 4-104.3.2 addSelfSignedCertificate ................................................................................................ 4-104.3.3 changeKeyStorePassword .............................................................................................. 4-114.3.4 changeWalletPassword.................................................................................................... 4-114.3.5 configureSSL ..................................................................................................................... 4-124.3.6 createKeyStore .................................................................................................................. 4-134.3.7 createWallet ...................................................................................................................... 4-134.3.8 deleteKeyStore ................................................................................................................. 4-144.3.9 deleteWallet ...................................................................................................................... 4-144.3.10 exportKeyStore ................................................................................................................. 4-154.3.11 exportKeyStoreObject ..................................................................................................... 4-164.3.12 exportWallet ...................................................................................................................... 4-174.3.13 exportWalletObject .......................................................................................................... 4-174.3.14 generateKey ...................................................................................................................... 4-184.3.15 getKeyStoreObject ........................................................................................................... 4-194.3.16 getSSL ................................................................................................................................. 4-204.3.17 getWalletObject ................................................................................................................. 4-204.3.18 importKeyStore ................................................................................................................. 4-214.3.19 importKeyStoreObject...................................................................................................... 4-224.3.20 importWallet...................................................................................................................... 4-234.3.21 importWalletObject .......................................................................................................... 4-244.3.22 listKeyStoreObjects........................................................................................................... 4-244.3.23 listKeyStores ...................................................................................................................... 4-254.3.24 listWalletObjects ............................................................................................................... 4-264.3.25 listWallets........................................................................................................................... 4-264.3.26 removeKeyStoreObject .................................................................................................... 4-274.3.27 removeWalletObject ......................................................................................................... 4-284.4 Oracle Identity Federation Commands ................................................................................ 4-294.4.1 addConfigListEntryInMap.............................................................................................. 4-314.4.2 addConfigMapEntryInMap ............................................................................................ 4-31

vii

4.4.3 addConfigPropertyListEntry .......................................................................................... 4-324.4.4 addConfigPropertyMapEntry......................................................................................... 4-324.4.5 addCustomAuthnEngine................................................................................................. 4-334.4.6 addCustomSPEngine ....................................................................................................... 4-334.4.7 addFederationListEntryInMap....................................................................................... 4-344.4.8 addFederationMapEntryInMap ..................................................................................... 4-354.4.9 addFederationPropertyListEntry ................................................................................... 4-354.4.10 addFederationPropertyMapEntry.................................................................................. 4-364.4.11 deleteCustomAuthnEngine............................................................................................. 4-364.4.12 deleteCustomSPEngine.................................................................................................... 4-374.4.13 deleteProviderFederation ................................................................................................ 4-374.4.14 deleteUserFederation ....................................................................................................... 4-374.4.15 changeMessageStore ........................................................................................................ 4-384.4.16 changePeerProviderDescription..................................................................................... 4-384.4.17 changeSessionStore........................................................................................................... 4-394.4.18 createConfigPropertyList ................................................................................................ 4-394.4.19 createConfigPropertyListInMap..................................................................................... 4-394.4.20 createConfigPropertyMap............................................................................................... 4-404.4.21 createConfigPropertyMapInMap ................................................................................... 4-404.4.22 createFederationPropertyList ......................................................................................... 4-414.4.23 createFederationPropertyListInMap.............................................................................. 4-414.4.24 createFederationPropertyMap........................................................................................ 4-414.4.25 createFederationPropertyMapInMap ............................................................................ 4-424.4.26 createPeerProviderEntry.................................................................................................. 4-424.4.27 getConfigListValueInMap............................................................................................... 4-434.4.28 getConfigMapEntryInMap.............................................................................................. 4-434.4.29 getConfigProperty ............................................................................................................ 4-444.4.30 getConfigPropertyList...................................................................................................... 4-444.4.31 getConfigPropertyMapEntry .......................................................................................... 4-454.4.32 getFederationListValueInMap........................................................................................ 4-454.4.33 getFederationMapEntryInMap....................................................................................... 4-454.4.34 getFederationProperty ..................................................................................................... 4-464.4.35 getFederationPropertyList............................................................................................... 4-464.4.36 extractproviderprops........................................................................................................ 4-474.4.37 setproviderprops............................................................................................................... 4-474.4.38 getFederationPropertyMapEntry ................................................................................... 4-484.4.39 listCustomAuthnEngines ................................................................................................ 4-484.4.40 listCustomSPEngines ....................................................................................................... 4-484.4.41 loadMetadata..................................................................................................................... 4-494.4.42 oifStatus.............................................................................................................................. 4-494.4.43 removeConfigListInMap ................................................................................................. 4-504.4.44 removeConfigMapEntryInMap...................................................................................... 4-504.4.45 removeConfigMapInMap................................................................................................ 4-514.4.46 removeConfigProperty .................................................................................................... 4-514.4.47 removeConfigPropertyList.............................................................................................. 4-524.4.48 removeConfigPropertyMap ............................................................................................ 4-524.4.49 removeConfigPropertyMapEntry .................................................................................. 4-53

viii

4.4.50 removeFederationListInMap .......................................................................................... 4-534.4.51 removeFederationMapInMap......................................................................................... 4-534.4.52 removeFederationMapEntryInMap............................................................................... 4-544.4.53 removeFederationProperty ............................................................................................. 4-544.4.54 removeFederationPropertyList....................................................................................... 4-554.4.55 removeFederationPropertyMap ..................................................................................... 4-554.4.56 removeFederationPropertyMapEntry ........................................................................... 4-564.4.57 removePeerProviderEntry............................................................................................... 4-564.4.58 setConfigProperty............................................................................................................. 4-564.4.59 setCustomAuthnEngine................................................................................................... 4-574.4.60 setCustomSPEngine ......................................................................................................... 4-574.4.61 setFederationProperty...................................................................................................... 4-584.5 Directory Integration Platform Commands......................................................................... 4-584.6 Security Commands ................................................................................................................ 4-594.6.1 createAppRole ................................................................................................................... 4-604.6.2 deleteAppRole................................................................................................................... 4-604.6.3 grantAppRole .................................................................................................................... 4-614.6.4 revokeAppRole ................................................................................................................. 4-614.6.5 listAppRoles ...................................................................................................................... 4-624.6.6 listAppRolesMembers...................................................................................................... 4-624.6.7 grantPermission ................................................................................................................ 4-634.6.8 revokePermission.............................................................................................................. 4-634.6.9 listPermissions................................................................................................................... 4-644.6.10 deleteAppPolicies ............................................................................................................. 4-654.6.11 migrateSecurityStore ........................................................................................................ 4-654.6.12 listCred ............................................................................................................................... 4-694.6.13 updateCred ........................................................................................................................ 4-694.6.14 createCred .......................................................................................................................... 4-704.6.15 deleteCred.......................................................................................................................... 4-704.6.16 modifyBootStrapCredential ............................................................................................ 4-714.6.17 addBootStrapCredential .................................................................................................. 4-714.6.18 reassociateSecurityStore .................................................................................................. 4-724.6.19 upgradeSecurityStore....................................................................................................... 4-734.6.20 createResourceType.......................................................................................................... 4-744.6.21 getResourceType............................................................................................................... 4-754.6.22 deleteResourceType ......................................................................................................... 4-754.6.23 listAppStripes.................................................................................................................... 4-764.6.24 createResource................................................................................................................... 4-774.6.25 deleteResource .................................................................................................................. 4-774.6.26 listResources ...................................................................................................................... 4-784.6.27 listResourceActions .......................................................................................................... 4-784.6.28 createEntitlement .............................................................................................................. 4-794.6.29 getEntitlement ................................................................................................................... 4-794.6.30 deleteEntitlement.............................................................................................................. 4-804.6.31 addResourceToEntitlement............................................................................................. 4-804.6.32 revokeResourceFromEntitlement................................................................................... 4-814.6.33 listEntitlements.................................................................................................................. 4-81

ix

4.6.34 grantEntitlement ............................................................................................................... 4-824.6.35 revokeEntitlement ............................................................................................................ 4-834.6.36 listEntitlement ................................................................................................................... 4-834.6.37 listResourceTypes ............................................................................................................. 4-844.7 Oracle Access Manager Commands...................................................................................... 4-844.7.1 listOAMAuthnProviderParams...................................................................................... 4-864.7.2 createOAMIdentityAsserter............................................................................................ 4-874.7.3 updateOAMIdentityAsserter .......................................................................................... 4-874.7.4 createOAMAuthenticator ................................................................................................ 4-884.7.5 deleteOAMAuthnProvider.............................................................................................. 4-894.7.6 updateOAMAuthenticator .............................................................................................. 4-894.7.7 addOAMSSOProvider ..................................................................................................... 4-904.7.8 displayTopology ............................................................................................................... 4-914.7.9 displayMetrics ................................................................................................................... 4-924.7.10 displayOamServer ........................................................................................................... 4-924.7.11 createOamServer .............................................................................................................. 4-924.7.12 editOamServer ................................................................................................................. 4-934.7.13 deleteOamServer .............................................................................................................. 4-944.7.14 displayOssoAgent............................................................................................................. 4-954.7.15 editOssoAgent................................................................................................................... 4-954.7.16 deleteOssoAgent ............................................................................................................... 4-964.7.17 displayWebgateAgent...................................................................................................... 4-974.7.18 editWebgateAgent ......................................................................................................... 4-974.7.19 deleteWebgateAgent ........................................................................................................ 4-994.7.20 changeLoggerSetting ....................................................................................................... 4-994.7.21 changeConfigDataEncryptionKey ............................................................................... 4-1004.7.22 displayUserIdentityStore............................................................................................... 4-1004.7.23 editUserIdentityStore ..................................................................................................... 4-1014.7.24 createUserIdentityStore ................................................................................................. 4-1024.7.25 deleteUserIdentityStore ................................................................................................. 4-1034.7.26 configRequestCacheType .............................................................................................. 4-1044.7.27 displayRequestCacheType ............................................................................................ 4-1044.7.28 exportPolicy..................................................................................................................... 4-1054.7.29 importPolicy .................................................................................................................... 4-1054.7.30 importPolicyDelta........................................................................................................... 4-1064.7.31 migratePartnersToProd ................................................................................................. 4-1064.7.32 exportPartners ................................................................................................................. 4-1074.7.33 importPartners ................................................................................................................ 4-1074.7.34 configureOAAM ............................................................................................................. 4-1084.7.35 registerOIFDAPPartner ................................................................................................. 4-1084.7.36 enableCoexistMode ........................................................................................................ 4-1094.7.37 disableCoexistMode ....................................................................................................... 4-1094.7.38 editGITOValues .............................................................................................................. 4-1104.7.39 editWebgate11gAgent.................................................................................................... 4-1114.7.40 deleteWebgate11gAgent ................................................................................................ 4-1124.7.41 displayWebgate11gAgent ............................................................................................. 4-1134.7.42 displayOAMMetrics ....................................................................................................... 4-113

x

4.7.43 updateOIMHostPort....................................................................................................... 4-1144.7.44 configureOIM .................................................................................................................. 4-1144.7.45 updateOSSOResponseCookieConfig........................................................................... 4-1154.7.46 deleteOSSOResponseCookieConfig............................................................................. 4-116

5 Oracle WebCenter Custom WLST Commands

5.1 Oracle WebCenter WLST Command Categories ................................................................... 5-25.2 General.......................................................................................................................................... 5-35.2.1 deleteConnection ................................................................................................................. 5-35.2.2 setWebCenterServiceFrameworkConfig .......................................................................... 5-45.2.3 getWebCenterServiceFrameworkConfig ......................................................................... 5-55.2.4 webcenterErrorOccurred .................................................................................................... 5-65.2.5 getWebCenterConnectionTypes........................................................................................ 5-65.2.6 cloneWebCenterManagedServer....................................................................................... 5-75.3 Analytics....................................................................................................................................... 5-75.3.1 createAnalyticsCollectorConnection................................................................................. 5-85.3.2 setAnalyticsCollectorConnection ................................................................................... 5-105.3.3 listAnalyticsCollectorConnections ................................................................................. 5-115.3.4 setDefaultAnalyticsCollectorConnection...................................................................... 5-125.3.5 listDefaultAnalyticsCollectorConnection ..................................................................... 5-135.3.6 setAnalyticsCollectorConfig ........................................................................................... 5-135.3.7 listAnalyticsCollectorConfig ........................................................................................... 5-145.3.8 listAnalyticsEventTypes .................................................................................................. 5-155.4 Activity Graph.......................................................................................................................... 5-165.4.1 exportAGMetadata........................................................................................................... 5-175.4.2 importAGMetadata .......................................................................................................... 5-185.4.3 exportAGProviderConfiguration ................................................................................... 5-185.4.4 deleteAllAGMetadata ...................................................................................................... 5-195.4.5 deleteAGAction................................................................................................................. 5-205.4.6 deleteAGNodeClass ........................................................................................................ 5-205.4.7 deleteAGSimilarityCalculation ...................................................................................... 5-215.4.8 deleteAGRankCalculation .............................................................................................. 5-225.4.9 deleteAGProviderAssignment ....................................................................................... 5-225.4.10 deleteAGQRPPRegistration ............................................................................................ 5-235.4.11 deleteAGProviderConfiguration.................................................................................... 5-245.4.12 renameAGAction .............................................................................................................. 5-245.4.13 renameAGNodeClass....................................................................................................... 5-255.4.14 setAGProperty................................................................................................................... 5-265.4.15 getAGProperty .................................................................................................................. 5-275.4.16 setAGPasswordCredential .............................................................................................. 5-285.5 Activity Stream......................................................................................................................... 5-295.5.1 archiveASByDate .............................................................................................................. 5-295.5.2 archiveASByDeletedObjects............................................................................................ 5-305.5.3 archiveASByClosedSpaces .............................................................................................. 5-305.5.4 archiveASByInactiveSpaces ............................................................................................ 5-315.5.5 restoreASByDate............................................................................................................... 5-325.5.6 truncateASArchive ........................................................................................................... 5-33

xi

5.6 Content Repository ................................................................................................................. 5-335.6.1 createJCRContentServerConnection ............................................................................. 5-345.6.2 setJCRContentServerConnection ................................................................................... 5-385.6.3 listJCRContentServerConnections ................................................................................. 5-405.6.4 createJCRPortalConnection ............................................................................................ 5-415.6.5 setJCRPortalConnection .................................................................................................. 5-425.6.6 listJCRPortalConnections ............................................................................................... 5-435.6.7 createJCRFileSystemConnection ................................................................................... 5-445.6.8 setJCRFileSystemConnection.......................................................................................... 5-455.6.9 listJCRFileSystemConnections ....................................................................................... 5-465.6.10 listDocumentsSpacesProperties...................................................................................... 5-475.6.11 setDocumentsSpacesProperties ...................................................................................... 5-485.6.12 deleteDocumentsSpacesProperties ................................................................................ 5-495.7 Discussions and Announcements ......................................................................................... 5-505.7.1 createDiscussionForumConnection .............................................................................. 5-515.7.2 setDiscussionForumConnection .................................................................................... 5-535.7.3 setDiscussionForumConnectionProperty .................................................................... 5-565.7.4 deleteDiscussionForumConnectionProperty ............................................................... 5-575.7.5 listDiscussionForumConnections .................................................................................. 5-585.7.6 listDefaultDiscussionForumConnection ....................................................................... 5-595.7.7 setDefaultDiscussionForumConnection........................................................................ 5-605.7.8 setDiscussionForumServiceProperty............................................................................. 5-605.7.9 removeDiscussionForumServiceProperty .................................................................... 5-625.7.10 listDiscussionForumServiceProperties .......................................................................... 5-625.7.11 setAnnouncementServiceProperty................................................................................. 5-635.7.12 removeAnnouncementServiceProperty ........................................................................ 5-645.7.13 listAnnouncementServiceProperties.............................................................................. 5-655.7.14 addDiscussionsServerAdmin.......................................................................................... 5-655.7.15 syncDiscussionServerPermissions ................................................................................. 5-665.7.16 setDiscussionsServerProperty ........................................................................................ 5-675.7.17 getDiscussionsServerProperty ........................................................................................ 5-675.7.18 removeDiscussionsServerProperty ................................................................................ 5-685.8 External Applications .............................................................................................................. 5-695.8.1 createExtAppConnection................................................................................................. 5-695.8.2 setExtAppConnection ...................................................................................................... 5-705.8.3 listExtAppConnections .................................................................................................... 5-715.8.4 addExtAppField................................................................................................................ 5-735.8.5 setExtAppField.................................................................................................................. 5-745.8.6 removeExtAppField ......................................................................................................... 5-755.8.7 addExtAppCredential ...................................................................................................... 5-765.8.8 setExtAppCredential ........................................................................................................ 5-775.8.9 removeExtAppCredential ............................................................................................... 5-785.9 Instant Messaging and Presence ........................................................................................... 5-795.9.1 createIMPConnection ...................................................................................................... 5-795.9.2 setIMPConnection ........................................................................................................... 5-815.9.3 setIMPConnectionProperty ............................................................................................ 5-835.9.4 deleteIMPConnectionProperty ...................................................................................... 5-85

xii

5.9.5 listIMPAdapters ............................................................................................................... 5-865.9.6 listIMPConnections ......................................................................................................... 5-865.9.7 listDefaultIMPConnection............................................................................................... 5-875.9.8 setDefaultIMPConnection ............................................................................................... 5-885.9.9 setIMPServiceProperty .................................................................................................... 5-885.9.10 removeIMPServiceProperty ............................................................................................ 5-905.9.11 listIMPServiceProperties.................................................................................................. 5-905.9.12 createIMPExtAppConnection ......................................................................................... 5-915.10 Mail ........................................................................................................................................... 5-925.10.1 createMailConnection ...................................................................................................... 5-935.10.2 setMailConnection ........................................................................................................... 5-945.10.3 setMailConnectionProperty ........................................................................................... 5-975.10.4 deleteMailConnectionProperty ...................................................................................... 5-995.10.5 listMailConnections ......................................................................................................... 5-995.10.6 listDefaultMailConnection ............................................................................................ 5-1005.10.7 setDefaultMailConnection............................................................................................. 5-1015.10.8 setMailServiceProperty.................................................................................................. 5-1025.10.9 removeMailServiceProperty ......................................................................................... 5-1035.10.10 listMailServiceProperties ............................................................................................... 5-1045.10.11 createMailExtApp........................................................................................................... 5-1055.11 Notifications............................................................................................................................ 5-1055.11.1 setNotificationsConfig ................................................................................................... 5-1065.11.2 getNotificationsConfig................................................................................................... 5-1075.12 Personal Events ...................................................................................................................... 5-1085.12.1 createPersonalEventConnection................................................................................... 5-1085.12.2 setPersonalEventConnection ........................................................................................ 5-1105.12.3 listPersonalEventConnections ...................................................................................... 5-1115.13 Personalization ....................................................................................................................... 5-1125.13.1 createWCPSCMISConnection ....................................................................................... 5-1125.13.2 createWCPSActivityGraphConnection ....................................................................... 5-1145.13.3 createWCPSPeopleConnection ..................................................................................... 5-1155.13.4 createWCPSCustomConnection ................................................................................... 5-1165.13.5 listWCPSCMISConnection ............................................................................................ 5-1165.13.6 listWCPSActivityGraphConnection............................................................................. 5-1175.13.7 listWCPSPeopleConnection .......................................................................................... 5-1185.13.8 listWCPSCustomConnection ........................................................................................ 5-1195.13.9 deleteWCPSCMISConnection....................................................................................... 5-1205.13.10 deleteWCPSActivityGraphConnection ....................................................................... 5-1215.13.11 deleteWCPSPeopleConnection..................................................................................... 5-1215.13.12 deleteWCPSCustomConnection................................................................................... 5-1225.13.13 setWCPSConnectionProperty ....................................................................................... 5-1235.14 Portlet Producers.................................................................................................................... 5-1245.14.1 registerWSRPProducer ................................................................................................. 5-1255.14.2 setWSRPProducer........................................................................................................... 5-1295.14.3 listWSRPProducers......................................................................................................... 5-1335.14.4 deregisterWSRPProducer ............................................................................................. 5-1345.14.5 listWSRPProducerRegistrationProperties .................................................................. 5-135

xiii

5.14.6 listWSRPProducerUserCategories ............................................................................... 5-1365.14.7 mapWSRPProducerUserCategory ............................................................................... 5-1375.14.8 registerPDKJavaProducer.............................................................................................. 5-1375.14.9 setPDKJavaProducer ...................................................................................................... 5-1395.14.10 deregisterPDKJavaProducer ......................................................................................... 5-1415.14.11 listPDKJavaProducers .................................................................................................... 5-1425.14.12 registerPageletProducer................................................................................................. 5-1435.14.13 setPageletProducer ......................................................................................................... 5-1445.14.14 listPageletProducers ....................................................................................................... 5-1445.14.15 deregisterPageletProducer ............................................................................................ 5-1465.14.16 refreshProducer .............................................................................................................. 5-1465.14.17 registerOOTBProducers................................................................................................. 5-1475.14.18 deregisterOOTBProducers ............................................................................................ 5-1485.14.19 registerSampleProducers............................................................................................... 5-1495.14.20 deregisterSampleProducers .......................................................................................... 5-1495.15 RSS News Feeds ..................................................................................................................... 5-1505.15.1 getRssProxyConfig ......................................................................................................... 5-1505.15.2 setRssProxyConfig.......................................................................................................... 5-1515.15.3 unsetRssProxyConfig ..................................................................................................... 5-1525.16 Search - Oracle SES Search.................................................................................................... 5-1525.16.1 createSESConnection...................................................................................................... 5-1535.16.2 setSESConnection ........................................................................................................... 5-1545.16.3 listSESConnections ......................................................................................................... 5-1555.16.4 setSearchSESConfig ........................................................................................................ 5-1555.16.5 listSearchSESConfig........................................................................................................ 5-1565.16.6 createFederationTrustedEntity ..................................................................................... 5-1575.17 Search - Oracle SES Search Crawlers .................................................................................. 5-1585.17.1 createSpacesCrawler ...................................................................................................... 5-1595.17.2 createDocumentsCrawler .............................................................................................. 5-1615.17.3 createDiscussionsCrawler ............................................................................................. 5-1645.17.4 listSpacesCrawler............................................................................................................ 5-1665.17.5 listDocumentsCrawler ................................................................................................... 5-1675.17.6 listDiscussionsCrawler................................................................................................... 5-1685.17.7 startSpacesCrawler ......................................................................................................... 5-1695.17.8 startDocumentsCrawler................................................................................................. 5-1705.17.9 startDiscussionsCrawler ................................................................................................ 5-1705.17.10 stopSpacesCrawler ......................................................................................................... 5-1715.17.11 stopDocumentsCrawler ................................................................................................. 5-1725.17.12 stopDiscussionsCrawler ................................................................................................ 5-1735.17.13 deleteSpacesCrawler ...................................................................................................... 5-1735.17.14 deleteDocumentsCrawler .............................................................................................. 5-1745.17.15 deleteDiscussionsCrawler ............................................................................................. 5-1755.18 Search - WebCenter Search................................................................................................... 5-1765.18.1 setSearchConfig............................................................................................................... 5-1765.18.2 listSearchConfig .............................................................................................................. 5-1775.18.3 setSpacesCrawlProperties ............................................................................................. 5-1785.18.4 getSpacesCrawlProperties............................................................................................. 5-179

xiv

5.19 Worklists ................................................................................................................................. 5-1805.19.1 createBPELConnection................................................................................................... 5-1805.19.2 setBPELConnection ........................................................................................................ 5-1825.19.3 listBPELConnections ...................................................................................................... 5-1845.19.4 addWorklistConnection................................................................................................. 5-1855.19.5 removeWorklistConnection .......................................................................................... 5-1865.19.6 listWorklistConnections................................................................................................. 5-1865.20 WebCenter Spaces Workflows............................................................................................. 5-1885.20.1 getSpacesWorkflowConnectionName......................................................................... 5-1885.20.2 setSpacesWorkflowConnectionName ......................................................................... 5-1895.21 WebCenter Identity Store ..................................................................................................... 5-1895.21.1 setWebCenterIdStoreSearchConfig.............................................................................. 5-1895.21.2 listWebCenterIdStoreSearchConfig ............................................................................. 5-1915.22 WebCenter Import and Export ............................................................................................ 5-1915.22.1 exportWebCenterApplication ...................................................................................... 5-1925.22.2 importWebCenterApplication ..................................................................................... 5-1935.22.3 exportGroupSpaces ........................................................................................................ 5-1945.22.4 exportGroupSpaceTemplates........................................................................................ 5-1955.22.5 importGroupSpaces........................................................................................................ 5-1965.22.6 exportWebCenterResource............................................................................................ 5-1975.22.7 importWebCenterResource ........................................................................................... 5-1985.22.8 exportPortletClientMetadata ........................................................................................ 5-1995.22.9 importPortletClientMetadata........................................................................................ 5-2005.22.10 importWebCenterTranslations ..................................................................................... 5-2005.22.11 setSpaceState.................................................................................................................... 5-2015.22.12 showProducerImportFailures ....................................................................................... 5-2025.22.13 retryAllFailedProducerImports .................................................................................... 5-2025.23 WebCenter Upgrade.............................................................................................................. 5-2035.23.1 upgradeWebCenterDomain .......................................................................................... 5-2035.23.2 upgradeWebCenterPermissions................................................................................... 5-2045.23.3 upgradeWebCenterApplication ................................................................................... 5-204

6 User Messaging Service (UMS) Custom WLST Commands

6.1 UMS WLST Command Group .................................................................................................. 6-16.1.1 manageUserMessagingPrefs .............................................................................................. 6-16.1.2 deployUserMessagingDriver ............................................................................................. 6-3

7 DMS Custom WLST Commands

7.1 DMS Metric Commands ............................................................................................................ 7-17.1.1 displayMetricTableNames ................................................................................................. 7-17.1.2 displayMetricTables ............................................................................................................ 7-37.1.3 dumpMetrics ........................................................................................................................ 7-67.1.4 reloadMetricRules................................................................................................................ 7-87.2 DMS Event Tracing Commands ............................................................................................... 7-87.2.1 addDMSEventDestination.................................................................................................. 7-97.2.2 addDMSEventFilter.......................................................................................................... 7-107.2.3 addDMSEventRoute......................................................................................................... 7-13

xv

7.2.4 enableDMSEventTrace..................................................................................................... 7-147.2.5 listDMSEventConfiguration............................................................................................ 7-157.2.6 listDMSEventDestination ................................................................................................ 7-167.2.7 listDMSEventFilter ........................................................................................................... 7-167.2.8 listDMSEventRoutes......................................................................................................... 7-177.2.9 removeDMSEventDestination ........................................................................................ 7-187.2.10 removeDMSEventFilter ................................................................................................... 7-197.2.11 removeDMSEventRoute .................................................................................................. 7-197.2.12 updateDMSEventDestination ......................................................................................... 7-207.2.13 updateDMSEventFilter .................................................................................................... 7-217.2.14 updateDMSEventRoute ................................................................................................... 7-22

8 Logging Custom WLST Commands

8.1 Log Configuration Commands ................................................................................................. 8-18.1.1 configureLogHandler.......................................................................................................... 8-28.1.2 getLogLevel .......................................................................................................................... 8-38.1.3 listLoggers............................................................................................................................. 8-48.1.4 listLogHandlers.................................................................................................................... 8-58.1.5 setLogLevel........................................................................................................................... 8-68.2 Search and Display Commands................................................................................................ 8-78.2.1 displayLogs........................................................................................................................... 8-78.2.2 listLogs ............................................................................................................................... 8-10

9 Metadata Services (MDS) Custom WLST Commands

9.1 Repository Management Commands ...................................................................................... 9-19.1.1 createMetadataPartition...................................................................................................... 9-29.1.2 deleteMetadataPartition ..................................................................................................... 9-29.1.3 deregisterMetadataDBRepository..................................................................................... 9-39.1.4 registerMetadataDBRepository ......................................................................................... 9-39.2 Application Metadata Management Commands................................................................... 9-49.2.1 deleteMetadata..................................................................................................................... 9-49.2.2 exportMetadata .................................................................................................................... 9-69.2.3 importMetadata ................................................................................................................... 9-99.2.4 purgeMetadata .................................................................................................................. 9-119.3 Sandbox Metadata Management Commands ..................................................................... 9-129.3.1 exportSandboxMetadata.................................................................................................. 9-129.3.2 importSandboxMetadata ................................................................................................. 9-139.4 Application Label Management Commands....................................................................... 9-149.4.1 createMetadataLabel ........................................................................................................ 9-149.4.2 deleteMetadataLabel ........................................................................................................ 9-159.4.3 listMetadataLabels............................................................................................................ 9-169.4.4 promoteMetadataLabel.................................................................................................... 9-169.4.5 purgeMetadataLabels....................................................................................................... 9-179.5 Application Management Deployment Commands........................................................... 9-189.5.1 getMDSArchiveConfig..................................................................................................... 9-189.5.2 importMAR........................................................................................................................ 9-20

xvi

10 Oracle SOA Suite Custom WLST Commands

10.1 Overview of WSLT Command Categories........................................................................... 10-110.2 Deployment Commands......................................................................................................... 10-210.2.1 sca_deployComposite ...................................................................................................... 10-210.2.2 sca_undeployComposite.................................................................................................. 10-410.3 SOA Composite Application Management Commands .................................................... 10-510.3.1 sca_startComposite........................................................................................................... 10-610.3.2 sca_stopComposite ........................................................................................................... 10-610.3.3 sca_activateComposite..................................................................................................... 10-710.3.4 sca_retireComposite ......................................................................................................... 10-810.3.5 sca_assignDefaultComposite .......................................................................................... 10-910.3.6 sca_getDefaultCompositeRevision............................................................................... 10-1010.3.7 sca_listDeployedComposites ........................................................................................ 10-1010.4 Configuration Plan Management Commands................................................................... 10-1110.4.1 sca_attachPlan ................................................................................................................. 10-1110.4.2 sca_extractPlan................................................................................................................ 10-1210.4.3 sca_generatePlan............................................................................................................. 10-1310.4.4 sca_validatePlan.............................................................................................................. 10-1310.5 Task Validation Commands................................................................................................. 10-1410.5.1 sca_validateTask ............................................................................................................. 10-1410.6 SOA Composite Application Compilation Commands ................................................... 10-1510.6.1 sca_setProp ...................................................................................................................... 10-1510.6.2 sca_compile...................................................................................................................... 10-1610.7 SOA Composite Application Packaging Commands ....................................................... 10-1710.7.1 sca_package ..................................................................................................................... 10-1710.8 SOA Composite Application Test Commands .................................................................. 10-1810.8.1 sca_test.............................................................................................................................. 10-1810.9 SOA Composite Application HTTP Client-Based Export and Import Commands ..... 10-1910.9.1 sca_exportComposite ..................................................................................................... 10-1910.9.2 sca_exportUpdates ......................................................................................................... 10-2010.9.3 sca_importUpdates......................................................................................................... 10-2110.9.4 sca_exportSharedData.................................................................................................... 10-2210.9.5 sca_removeSharedData.................................................................................................. 10-2310.10 SOA Composite Application MBean-Based Export and Import Commands............... 10-2410.10.1 sca_exportCompositeMb ............................................................................................... 10-2410.10.2 sca_exportUpdatesMb ................................................................................................... 10-2510.10.3 sca_importUpdatesMb................................................................................................... 10-2610.10.4 sca_exportSharedDataMb.............................................................................................. 10-2610.11 SOA Composite Application Partition Management Commands.................................. 10-2710.11.1 sca_createPartition.......................................................................................................... 10-2710.11.2 sca_deletePartition.......................................................................................................... 10-2810.11.3 sca_startCompositesInPartition.................................................................................... 10-2810.11.4 sca_stopCompositesInPartition .................................................................................... 10-2910.11.5 sca_activateCompositesInPartition .............................................................................. 10-2910.11.6 sca_retireCompositesInPartition .................................................................................. 10-2910.11.7 sca_listPartitions ............................................................................................................. 10-3010.11.8 sca_listCompositesInPartition ...................