Oracle Fusion Middleware Online Documentation Library

Oracle® Fusion Middleware

WebLogic Scripting Tool Command Reference

11

g

Release 1 (10.3.5)

E13813-10

April 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.5) E13813-10

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

1

Introduction and Roadmap

1.1 Document Scope and Audience... 1-1 1.2 Guide to This Document... 1-1 1.3 Related Documentation... 1-3 1.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-1 2.2 WebLogic Server WLST Online Command Summary ... 2-6 2.3 WebLogic Server WLST Offline Command Summary... 2-10

3

WLST Command and Variable Reference

3.1 Overview of WLST Command Categories... 3-1 3.2 Browse Commands... 3-2 3.2.1 cd ... 3-2 3.2.2 currentTree... 3-3 3.2.3 prompt... 3-4 3.2.4 pwd ... 3-5 3.3 Control Commands ... 3-5 3.3.1 addTemplate... 3-6 3.3.2 closeDomain ... 3-7 3.3.3 closeTemplate... 3-7 3.3.4 connect... 3-7 3.3.5 createDomain ... 3-11 3.3.6 disconnect ... 3-12 3.3.7 exit... 3-12 3.3.8 readDomain ... 3-13 3.3.9 readTemplate... 3-14 3.3.10 updateDomain ... 3-15 3.3.11 writeDomain... 3-15 3.3.12 writeTemplate ... 3-16

3.4 Customization Commands... 3-17 3.4.1 addHelpCommandGroup ... 3-17 3.4.2 addHelpCommand... 3-18 3.5 Deployment Commands... 3-19 3.5.1 deploy ... 3-20 3.5.2 distributeApplication ... 3-23 3.5.3 getWLDM... 3-24 3.5.4 listApplications ... 3-25 3.5.5 loadApplication ... 3-25 3.5.6 redeploy ... 3-26 3.5.7 startApplication ... 3-27 3.5.8 stopApplication... 3-28 3.5.9 undeploy ... 3-29 3.5.10 updateApplication... 3-30 3.6 Diagnostics Commands ... 3-30 3.6.1 exportDiagnosticData ... 3-31 3.6.2 exportDiagnosticDataFromServer... 3-32 3.6.3 getAvailableCapturedImages ... 3-33 3.6.4 saveDiagnosticImageCaptureFile... 3-34 3.6.5 saveDiagnosticImageCaptureEntryFile... 3-35 3.7 Editing Commands... 3-36 3.7.1 activate... 3-37 3.7.2 assign ... 3-38 3.7.3 cancelEdit ... 3-40 3.7.4 create... 3-41 3.7.5 delete... 3-42 3.7.6 encrypt... 3-43 3.7.7 get... 3-44 3.7.8 getActivationTask... 3-44 3.7.9 invoke ... 3-45 3.7.10 isRestartRequired... 3-46 3.7.11 loadDB ... 3-46 3.7.12 loadProperties ... 3-47 3.7.13 save ... 3-48 3.7.14 set ... 3-48 3.7.15 setOption... 3-49 3.7.16 showChanges ... 3-51 3.7.17 startEdit ... 3-51 3.7.18 stopEdit ... 3-52 3.7.19 unassign ... 3-53 3.7.20 undo ... 3-55 3.7.21 validate ... 3-55 3.8 Information Commands... 3-56 3.8.1 addListener ... 3-57 3.8.2 configToScript ... 3-58 3.8.3 dumpStack ... 3-59

v 3.8.5 find ... 3-60 3.8.6 getConfigManager ... 3-61 3.8.7 getMBean ... 3-61 3.8.8 getMBI ... 3-62 3.8.9 getPath... 3-62 3.8.10 listChildTypes ... 3-63 3.8.11 lookup... 3-63 3.8.12 ls ... 3-64 3.8.13 man ... 3-67 3.8.14 redirect... 3-68 3.8.15 removeListener... 3-68 3.8.16 showListeners... 3-69 3.8.17 startRecording ... 3-69 3.8.18 state ... 3-70 3.8.19 stopRecording ... 3-71 3.8.20 stopRedirect ... 3-71 3.8.21 storeUserConfig ... 3-71 3.8.22 threadDump ... 3-73 3.8.23 viewMBean ... 3-74 3.8.24 writeIniFile... 3-74 3.9 Life Cycle Commands ... 3-75 3.9.1 migrate... 3-75 3.9.2 resume ... 3-76 3.9.3 shutdown ... 3-77 3.9.4 start ... 3-79 3.9.5 startServer ... 3-80 3.9.6 suspend ... 3-81 3.10 Node Manager Commands ... 3-82 3.10.1 nm ... 3-83 3.10.2 nmConnect... 3-83 3.10.3 nmDisconnect... 3-85 3.10.4 nmEnroll... 3-86 3.10.5 nmGenBootStartupProps... 3-87 3.10.6 nmKill ... 3-87 3.10.7 nmLog... 3-88 3.10.8 nmServerLog ... 3-89 3.10.9 nmServerStatus ... 3-89 3.10.10 nmStart ... 3-90 3.10.11 nmVersion... 3-91 3.10.12 startNodeManager... 3-91 3.10.13 stopNodeManager ... 3-92 3.11 Tree Commands ... 3-93 3.11.1 custom ... 3-93 3.11.2 domainConfig... 3-94 3.11.3 domainCustom... 3-95 3.11.4 domainRuntime ... 3-96 3.11.5 edit ... 3-97

3.11.6 jndi ... 3-98 3.11.7 serverConfig ... 3-98 3.11.8 serverRuntime ... 3-99 3.12 WLST Variable Reference ... 3-99

4

Infrastructure Security Custom WLST Commands

4.1 Overview of WSLT Security Commands ... 4-1 4.2 Audit Configuration Commands ... 4-2 4.2.1 getNonJavaEEAuditMBeanName... 4-2 4.2.2 getAuditPolicy ... 4-3 4.2.3 setAuditPolicy ... 4-3 4.2.4 getAuditRepository ... 4-5 4.2.5 setAuditRepository... 4-5 4.2.6 listAuditEvents... 4-6 4.2.7 exportAuditConfig ... 4-7 4.2.8 importAuditConfig... 4-8 4.3 SSL Configuration Commands ... 4-9 4.3.1 addCertificateRequest ... 4-10 4.3.2 addSelfSignedCertificate ... 4-10 4.3.3 changeKeyStorePassword ... 4-11 4.3.4 changeWalletPassword... 4-12 4.3.5 configureSSL ... 4-12 4.3.6 createKeyStore ... 4-13 4.3.7 createWallet ... 4-14 4.3.8 deleteKeyStore ... 4-14 4.3.9 deleteWallet ... 4-15 4.3.10 exportKeyStore ... 4-15 4.3.11 exportKeyStoreObject ... 4-16 4.3.12 exportWallet ... 4-17 4.3.13 exportWalletObject ... 4-17 4.3.14 generateKey ... 4-19 4.3.15 getKeyStoreObject ... 4-19 4.3.16 getSSL ... 4-20 4.3.17 getWalletObject ... 4-21 4.3.18 importKeyStore ... 4-22 4.3.19 importKeyStoreObject... 4-22 4.3.20 importWallet... 4-23 4.3.21 importWalletObject ... 4-24 4.3.22 listKeyStoreObjects... 4-25 4.3.23 listKeyStores ... 4-25 4.3.24 listWalletObjects ... 4-26 4.3.25 listWallets... 4-27 4.3.26 removeKeyStoreObject ... 4-27 4.3.27 removeWalletObject ... 4-28 4.4 Oracle Identity Federation Commands ... 4-29 4.4.1 addConfigListEntryInMap ... 4-31

vii 4.4.3 addConfigPropertyListEntry ... 4-32 4.4.4 addConfigPropertyMapEntry... 4-33 4.4.5 addCustomAuthnEngine... 4-33 4.4.6 addCustomSPEngine ... 4-34 4.4.7 addFederationListEntryInMap ... 4-34 4.4.8 addFederationMapEntryInMap ... 4-35 4.4.9 addFederationPropertyListEntry ... 4-35 4.4.10 addFederationPropertyMapEntry... 4-36 4.4.11 deleteCustomAuthnEngine... 4-36 4.4.12 deleteCustomSPEngine... 4-37 4.4.13 deleteProviderFederation ... 4-37 4.4.14 deleteUserFederation ... 4-38 4.4.15 changeMessageStore ... 4-38 4.4.16 changePeerProviderDescription... 4-38 4.4.17 changeSessionStore... 4-39 4.4.18 createConfigPropertyList ... 4-39 4.4.19 createConfigPropertyListInMap... 4-40 4.4.20 createConfigPropertyMap ... 4-40 4.4.21 createConfigPropertyMapInMap ... 4-40 4.4.22 createFederationPropertyList ... 4-41 4.4.23 createFederationPropertyListInMap... 4-41 4.4.24 createFederationPropertyMap ... 4-42 4.4.25 createFederationPropertyMapInMap ... 4-42 4.4.26 createPeerProviderEntry... 4-42 4.4.27 getConfigListValueInMap... 4-43 4.4.28 getConfigMapEntryInMap... 4-43 4.4.29 getConfigProperty ... 4-44 4.4.30 getConfigPropertyList... 4-44 4.4.31 getConfigPropertyMapEntry ... 4-45 4.4.32 getFederationListValueInMap ... 4-45 4.4.33 getFederationMapEntryInMap... 4-46 4.4.34 getFederationProperty ... 4-46 4.4.35 getFederationPropertyList... 4-46 4.4.36 extractproviderprops... 4-47 4.4.37 setproviderprops... 4-47 4.4.38 getFederationPropertyMapEntry ... 4-48 4.4.39 listCustomAuthnEngines ... 4-48 4.4.40 listCustomSPEngines ... 4-49 4.4.41 loadMetadata... 4-49 4.4.42 oifStatus... 4-49 4.4.43 removeConfigListInMap ... 4-50 4.4.44 removeConfigMapEntryInMap... 4-50 4.4.45 removeConfigMapInMap... 4-51 4.4.46 removeConfigProperty ... 4-51 4.4.47 removeConfigPropertyList... 4-52 4.4.48 removeConfigPropertyMap ... 4-52 4.4.49 removeConfigPropertyMapEntry ... 4-53

4.4.50 removeFederationListInMap ... 4-53 4.4.51 removeFederationMapInMap... 4-54 4.4.52 removeFederationMapEntryInMap... 4-54 4.4.53 removeFederationProperty ... 4-54 4.4.54 removeFederationPropertyList... 4-55 4.4.55 removeFederationPropertyMap ... 4-55 4.4.56 removeFederationPropertyMapEntry ... 4-56 4.4.57 removePeerProviderEntry... 4-56 4.4.58 setConfigProperty... 4-56 4.4.59 setCustomAuthnEngine... 4-57 4.4.60 setCustomSPEngine ... 4-57 4.4.61 setFederationProperty... 4-58 4.5 Directory Integration Platform Commands ... 4-59 4.6 Security Commands ... 4-59 4.6.1 createAppRole ... 4-60 4.6.2 deleteAppRole... 4-60 4.6.3 grantAppRole ... 4-61 4.6.4 revokeAppRole ... 4-61 4.6.5 listAppRoles ... 4-62 4.6.6 listAppRolesMembers... 4-62 4.6.7 grantPermission ... 4-63 4.6.8 revokePermission... 4-63 4.6.9 listPermissions... 4-64 4.6.10 deleteAppPolicies ... 4-65 4.6.11 migrateSecurityStore ... 4-65 4.6.12 listCred ... 4-69 4.6.13 updateCred ... 4-69 4.6.14 createCred ... 4-70 4.6.15 deleteCred... 4-70 4.6.16 modifyBootStrapCredential ... 4-71 4.6.17 addBootStrapCredential ... 4-71 4.6.18 reassociateSecurityStore ... 4-72 4.6.19 upgradeSecurityStore... 4-73 4.6.20 createResourceType... 4-74 4.6.21 getResourceType... 4-75 4.6.22 deleteResourceType ... 4-75 4.6.23 listAppStripes... 4-76 4.6.24 createResource... 4-77 4.6.25 deleteResource ... 4-77 4.6.26 listResources ... 4-78 4.6.27 listResourceActions ... 4-78 4.6.28 createEntitlement ... 4-79 4.6.29 getEntitlement ... 4-79 4.6.30 deleteEntitlement ... 4-80 4.6.31 addResourceToEntitlement ... 4-80 4.6.32 revokeResourceFromEntitlement... 4-81

ix 4.6.34 grantEntitlement ... 4-82 4.6.35 revokeEntitlement ... 4-83 4.6.36 listEntitlement ... 4-83 4.6.37 listResourceTypes ... 4-84 4.7 Oracle Access Manager Commands... 4-84 4.7.1 listOAMAuthnProviderParams... 4-87 4.7.2 createOAMIdentityAsserter... 4-87 4.7.3 updateOAMIdentityAsserter ... 4-87 4.7.4 createOAMAuthenticator ... 4-89 4.7.5 deleteOAMAuthnProvider... 4-89 4.7.6 updateOAMAuthenticator ... 4-89 4.7.7 addOAMSSOProvider ... 4-91 4.7.8 displayTopology ... 4-91 4.7.9 displayMetrics ... 4-92 4.7.10 displayOamServer ... 4-92 4.7.11 createOamServer ... 4-93 4.7.12 editOamServer ... 4-93 4.7.13 deleteOamServer ... 4-94 4.7.14 displayOssoAgent... 4-95 4.7.15 editOssoAgent... 4-95 4.7.16 deleteOssoAgent ... 4-96 4.7.17 displayWebgateAgent... 4-97 4.7.18 editWebgateAgent ... 4-97 4.7.19 deleteWebgateAgent ... 4-99 4.7.20 changeLoggerSetting ... 4-99 4.7.21 changeConfigDataEncryptionKey ... 4-100 4.7.22 displayUserIdentityStore... 4-100 4.7.23 editUserIdentityStore ... 4-101 4.7.24 createUserIdentityStore ... 4-102 4.7.25 deleteUserIdentityStore ... 4-103 4.7.26 configRequestCacheType ... 4-104 4.7.27 displayRequestCacheType ... 4-104 4.7.28 exportPolicy... 4-105 4.7.29 importPolicy ... 4-105 4.7.30 importPolicyDelta... 4-106 4.7.31 migratePartnersToProd ... 4-106 4.7.32 exportPartners ... 4-107 4.7.33 importPartners ... 4-107 4.7.34 configureOAAM ... 4-108 4.7.35 registerOIFDAPPartner ... 4-108 4.7.36 enableCoexistMode ... 4-109 4.7.37 disableCoexistMode ... 4-109 4.7.38 editGITOValues ... 4-110 4.7.39 editWebgate11gAgent... 4-111 4.7.40 deleteWebgate11gAgent ... 4-112 4.7.41 displayWebgate11gAgent ... 4-113 4.7.42 displayOAMMetrics ... 4-113

4.7.43 updateOIMHostPort... 4-114 4.7.44 configureOIM ... 4-114 4.7.45 updateOSSOResponseCookieConfig ... 4-115 4.7.46 deleteOSSOResponseCookieConfig... 4-116 4.7.47 displaySimpleModeGlobalPassphrase ... 4-116 4.7.48 exportSelectedPartners ... 4-116 4.7.49 migrateArtifacts ... 4-117 4.7.50 registerThirdPartyTAPPartner ... 4-117 4.8 Oracle Security Token Service... 4-118 4.8.1 getPartner... 4-120 4.8.2 getAllRequesterPartners ... 4-121 4.8.3 getAllRelyingPartyPartners ... 4-121 4.8.4 getAllIssuingAuthorityPartners ... 4-121 4.8.5 isPartnerPresent ... 4-122 4.8.6 createPartner... 4-122 4.8.7 updatePartner... 4-123 4.8.8 deletePartner ... 4-123 4.8.9 getPartnerUsernameTokenUsername ... 4-124 4.8.10 getPartnerUsernameTokenPassword ... 4-124 4.8.11 setPartnerUsernameTokenCredential ... 4-125 4.8.12 deletePartnerUsernameTokenCredential... 4-125 4.8.13 getPartnerSigningCert... 4-126 4.8.14 getPartnerEncryptionCert ... 4-126 4.8.15 setPartnerSigningCert ... 4-127 4.8.16 setPartnerEncryptionCert... 4-127 4.8.17 deletePartnerSigningCert ... 4-128 4.8.18 deletePartnerEncryptionCert ... 4-128 4.8.19 getPartnerAllIdentityAttributes ... 4-128 4.8.20 getPartnerIdentityAttribute ... 4-129 4.8.21 setPartnerIdentityAttribute... 4-129 4.8.22 deletePartnerIdentityAttribute ... 4-130 4.8.23 getAllWSPrefixAndPartnerMappings... 4-131 4.8.24 getWSPrefixAndPartnerMapping ... 4-131 4.8.25 createWSPrefixAndPartnerMapping... 4-131 4.8.26 deleteWSPrefixAndPartnerMapping... 4-132 4.8.27 getAllPartnerProfiles... 4-132 4.8.28 getPartnerProfile ... 4-133 4.8.29 createRequesterPartnerProfile ... 4-133 4.8.30 createRelyingPartyPartnerProfile... 4-135 4.8.31 createIssuingAuthorityPartnerProfile ... 4-136 4.8.32 deletePartnerProfile... 4-137 4.8.33 getAllIssuanceTemplates... 4-137 4.8.34 getIssuanceTemplate ... 4-138 4.8.35 createIssuanceTemplate ... 4-138 4.8.36 deleteIssuanceTemplate... 4-140 4.8.37 getAllValidationTemplates ... 4-140

xi 4.8.39 createWSSValidationTemplate ... 4-141 4.8.40 createWSTrustValidationTemplate... 4-144 4.8.41 deleteValidationTemplate ... 4-146

5

User Messaging Service (UMS) Custom WLST Commands

5.1 UMS WLST Command Group ... 5-1 5.1.1 manageUserMessagingPrefs ... 5-1 5.1.2 deployUserMessagingDriver ... 5-3

6

DMS Custom WLST Commands

6.1 DMS Metric Commands ... 6-1 6.1.1 displayMetricTableNames ... 6-1 6.1.2 displayMetricTables ... 6-3 6.1.3 dumpMetrics ... 6-6 6.1.4 reloadMetricRules... 6-8 6.2 DMS Event Tracing Commands ... 6-8 6.2.1 addDMSEventDestination... 6-9 6.2.2 addDMSEventFilter... 6-10 6.2.3 addDMSEventRoute... 6-13 6.2.4 enableDMSEventTrace... 6-14 6.2.5 listDMSEventConfiguration... 6-15 6.2.6 listDMSEventDestination ... 6-16 6.2.7 listDMSEventFilter ... 6-16 6.2.8 listDMSEventRoutes... 6-17 6.2.9 removeDMSEventDestination ... 6-18 6.2.10 removeDMSEventFilter ... 6-19 6.2.11 removeDMSEventRoute ... 6-19 6.2.12 updateDMSEventDestination ... 6-20 6.2.13 updateDMSEventFilter ... 6-21 6.2.14 updateDMSEventRoute ... 6-22

7

Logging Custom WLST Commands

7.1 Log Configuration Commands ... 7-1 7.1.1 configureLogHandler... 7-2 7.1.2 getLogLevel ... 7-5 7.1.3 listLoggers... 7-6 7.1.4 listLogHandlers... 7-7 7.1.5 setLogLevel... 7-7 7.2 Search and Display Commands... 7-9 7.2.1 displayLogs... 7-9 7.2.2 listLogs ... 7-11 7.3 Selective Tracing Commands... 7-12 7.3.1 configureTracingLoggers... 7-13 7.3.2 listActiveTraces ... 7-13 7.3.3 listTracingLoggers ... 7-14 7.3.4 startTracing... 7-15

7.3.5 stopTracing ... 7-15

8

Metadata Services (MDS) Custom WLST Commands

8.1 Repository Management Commands ... 8-1 8.1.1 createMetadataPartition... 8-2 8.1.2 deleteMetadataPartition ... 8-2 8.1.3 deregisterMetadataDBRepository ... 8-3 8.1.4 registerMetadataDBRepository ... 8-3 8.2 Application Metadata Management Commands... 8-4 8.2.1 deleteMetadata... 8-4 8.2.2 exportMetadata ... 8-6 8.2.3 importMetadata ... 8-9 8.2.4 purgeMetadata ... 8-11 8.3 Sandbox Metadata Management Commands... 8-12 8.3.1 exportSandboxMetadata... 8-12 8.3.2 importSandboxMetadata ... 8-13 8.4 Application Label Management Commands... 8-14 8.4.1 createMetadataLabel ... 8-15 8.4.2 deleteMetadataLabel ... 8-15 8.4.3 listMetadataLabels... 8-16 8.4.4 promoteMetadataLabel... 8-17 8.4.5 purgeMetadataLabels... 8-17 8.5 Application Management Deployment Commands... 8-18 8.5.1 getMDSArchiveConfig... 8-18 8.5.2 importMAR... 8-21

9

Oracle SOA Suite Custom WLST Commands

9.1 Overview of WSLT Command Categories... 9-1 9.2 Deployment Commands... 9-2 9.2.1 sca_deployComposite ... 9-2 9.2.2 sca_undeployComposite... 9-4 9.3 SOA Composite Application Management Commands ... 9-5 9.3.1 sca_startComposite... 9-6 9.3.2 sca_stopComposite ... 9-6 9.3.3 sca_activateComposite... 9-7 9.3.4 sca_retireComposite ... 9-8 9.3.5 sca_assignDefaultComposite ... 9-9 9.3.6 sca_getDefaultCompositeRevision... 9-10 9.3.7 sca_listDeployedComposites ... 9-10 9.4 Configuration Plan Management Commands... 9-11 9.4.1 sca_attachPlan ... 9-11 9.4.2 sca_extractPlan ... 9-12 9.4.3 sca_generatePlan... 9-13 9.4.4 sca_validatePlan... 9-13 9.5 Task Validation Commands ... 9-14

xiii 9.6.1 sca_setProp ... 9-15 9.6.2 sca_compile... 9-16 9.7 SOA Composite Application Packaging Commands ... 9-17 9.7.1 sca_package ... 9-17 9.8 SOA Composite Application Test Commands ... 9-18 9.8.1 sca_test... 9-18 9.9 SOA Composite Application HTTP Client-Based Export and Import Commands ... 9-19 9.9.1 sca_exportComposite ... 9-19 9.9.2 sca_exportUpdates ... 9-20 9.9.3 sca_importUpdates... 9-21 9.9.4 sca_exportSharedData... 9-22 9.9.5 sca_removeSharedData... 9-23 9.10 SOA Composite Application MBean-Based Export and Import Commands ... 9-24 9.10.1 sca_exportCompositeMb ... 9-24 9.10.2 sca_exportUpdatesMb ... 9-25 9.10.3 sca_importUpdatesMb... 9-26 9.10.4 sca_exportSharedDataMb... 9-26 9.11 SOA Composite Application Partition Management Commands... 9-27 9.11.1 sca_createPartition... 9-27 9.11.2 sca_deletePartition... 9-28 9.11.3 sca_startCompositesInPartition... 9-28 9.11.4 sca_stopCompositesInPartition ... 9-29 9.11.5 sca_activateCompositesInPartition ... 9-29 9.11.6 sca_retireCompositesInPartition ... 9-29 9.11.7 sca_listPartitions ... 9-30 9.11.8 sca_listCompositesInPartition ... 9-30

10

Oracle WebCenter Custom WLST Commands

10.1 Oracle WebCenter WLST Command Categories ... 10-2 10.2 General... 10-3 10.2.1 deleteConnection ... 10-3 10.2.2 setWebCenterServiceFrameworkConfig ... 10-4 10.2.3 getWebCenterServiceFrameworkConfig ... 10-5 10.2.4 webcenterErrorOccurred ... 10-6 10.2.5 getWebCenterConnectionTypes... 10-6 10.2.6 cloneWebCenterManagedServer... 10-7 10.3 Analytics... 10-7 10.3.1 createAnalyticsCollectorConnection... 10-8 10.3.2 setAnalyticsCollectorConnection ... 10-10 10.3.3 listAnalyticsCollectorConnections ... 10-11 10.3.4 setDefaultAnalyticsCollectorConnection ... 10-12 10.3.5 listDefaultAnalyticsCollectorConnection ... 10-13 10.3.6 setAnalyticsCollectorConfig ... 10-13 10.3.7 listAnalyticsCollectorConfig ... 10-14 10.3.8 listAnalyticsEventTypes ... 10-15 10.4 Activity Graph... 10-16 10.4.1 exportAGMetadata ... 10-17

10.4.2 importAGMetadata ... 10-18 10.4.3 exportAGProviderConfiguration ... 10-18 10.4.4 deleteAllAGMetadata ... 10-19 10.4.5 deleteAGAction... 10-20 10.4.6 deleteAGNodeClass ... 10-20 10.4.7 deleteAGSimilarityCalculation ... 10-21 10.4.8 deleteAGRankCalculation ... 10-22 10.4.9 deleteAGProviderAssignment ... 10-22 10.4.10 deleteAGQRPPRegistration ... 10-23 10.4.11 deleteAGProviderConfiguration... 10-24 10.4.12 renameAGAction ... 10-24 10.4.13 renameAGNodeClass... 10-25 10.4.14 setAGProperty... 10-26 10.4.15 getAGProperty ... 10-27 10.4.16 setAGPasswordCredential ... 10-28 10.5 Activity Stream... 10-29 10.5.1 archiveASByDate ... 10-29 10.5.2 archiveASByDeletedObjects... 10-30 10.5.3 archiveASByClosedSpaces ... 10-30 10.5.4 archiveASByInactiveSpaces ... 10-31 10.5.5 restoreASByDate... 10-32 10.5.6 truncateASArchive ... 10-33 10.6 Content Repository ... 10-33 10.6.1 createJCRContentServerConnection ... 10-34 10.6.2 setJCRContentServerConnection ... 10-38 10.6.3 listJCRContentServerConnections... 10-40 10.6.4 createJCRPortalConnection ... 10-41 10.6.5 setJCRPortalConnection ... 10-42 10.6.6 listJCRPortalConnections ... 10-43 10.6.7 createJCRFileSystemConnection ... 10-44 10.6.8 setJCRFileSystemConnection ... 10-45 10.6.9 listJCRFileSystemConnections ... 10-46 10.6.10 createJCRSharePointConnection ... 10-47 10.6.11 setJCRSharePointConnection... 10-48 10.6.12 listJCRSharePointConnections... 10-50 10.6.13 listDocumentsSpacesProperties... 10-51 10.6.14 setDocumentsSpacesProperties ... 10-51 10.6.15 deleteDocumentsSpacesProperties ... 10-53 10.7 Discussions and Announcements ... 10-53 10.7.1 createDiscussionForumConnection ... 10-54 10.7.2 setDiscussionForumConnection ... 10-57 10.7.3 setDiscussionForumConnectionProperty ... 10-59 10.7.4 deleteDiscussionForumConnectionProperty ... 10-60 10.7.5 listDiscussionForumConnections ... 10-61 10.7.6 listDefaultDiscussionForumConnection ... 10-62 10.7.7 setDefaultDiscussionForumConnection... 10-63

xv 10.7.9 removeDiscussionForumServiceProperty ... 10-65 10.7.10 listDiscussionForumServiceProperties ... 10-65 10.7.11 setAnnouncementServiceProperty... 10-66 10.7.12 removeAnnouncementServiceProperty ... 10-67 10.7.13 listAnnouncementServiceProperties... 10-68 10.7.14 addDiscussionsServerAdmin... 10-68 10.7.15 syncDiscussionServerPermissions ... 10-69 10.7.16 setDiscussionsServerProperty ... 10-70 10.7.17 getDiscussionsServerProperty ... 10-71 10.7.18 removeDiscussionsServerProperty ... 10-71 10.8 External Applications ... 10-72 10.8.1 createExtAppConnection... 10-73 10.8.2 setExtAppConnection ... 10-74 10.8.3 listExtAppConnections ... 10-75 10.8.4 addExtAppField... 10-77 10.8.5 setExtAppField... 10-78 10.8.6 removeExtAppField ... 10-79 10.8.7 addExtAppCredential ... 10-80 10.8.8 setExtAppCredential ... 10-80 10.8.9 removeExtAppCredential ... 10-81 10.9 Instant Messaging and Presence ... 10-82 10.9.1 createIMPConnection ... 10-83 10.9.2 setIMPConnection ... 10-85 10.9.3 setIMPConnectionProperty ... 10-87 10.9.4 deleteIMPConnectionProperty ... 10-88 10.9.5 listIMPAdapters ... 10-89 10.9.6 listIMPConnections ... 10-90 10.9.7 listDefaultIMPConnection... 10-90 10.9.8 setDefaultIMPConnection ... 10-91 10.9.9 setIMPServiceProperty ... 10-92 10.9.10 removeIMPServiceProperty ... 10-93 10.9.11 listIMPServiceProperties... 10-94 10.9.12 createIMPExtAppConnection ... 10-95 10.10 Mail ... 10-95 10.10.1 createMailConnection ... 10-96 10.10.2 setMailConnection ... 10-98 10.10.3 setMailConnectionProperty ... 10-101 10.10.4 deleteMailConnectionProperty ... 10-102 10.10.5 listMailConnections ... 10-103 10.10.6 listDefaultMailConnection ... 10-103 10.10.7 setDefaultMailConnection... 10-104 10.10.8 setMailServiceProperty ... 10-105 10.10.9 removeMailServiceProperty ... 10-106 10.10.10 listMailServiceProperties ... 10-107 10.10.11 createMailExtApp ... 10-108 10.11 Notifications... 10-109 10.11.1 setNotificationsConfig ... 10-109

10.11.2 getNotificationsConfig... 10-110 10.12 Personal Events ... 10-111 10.12.1 createPersonalEventConnection... 10-111 10.12.2 setPersonalEventConnection ... 10-113 10.12.3 listPersonalEventConnections ... 10-114 10.13 Personalization ... 10-115 10.13.1 createWCPSCMISConnection ... 10-116 10.13.2 createWCPSActivityGraphConnection ... 10-117 10.13.3 createWCPSPeopleConnection ... 10-118 10.13.4 createWCPSCustomConnection ... 10-119 10.13.5 listWCPSCMISConnection ... 10-120 10.13.6 listWCPSActivityGraphConnection... 10-121 10.13.7 listWCPSPeopleConnection ... 10-122 10.13.8 listWCPSCustomConnection ... 10-123 10.13.9 deleteWCPSCMISConnection... 10-124 10.13.10 deleteWCPSActivityGraphConnection ... 10-124 10.13.11 deleteWCPSPeopleConnection ... 10-125 10.13.12 deleteWCPSCustomConnection ... 10-125 10.13.13 setWCPSConnectionProperty ... 10-126 10.14 Portlet Producers... 10-127 10.14.1 registerWSRPProducer ... 10-128 10.14.2 setWSRPProducer... 10-132 10.14.3 listWSRPProducers... 10-136 10.14.4 deregisterWSRPProducer ... 10-137 10.14.5 listWSRPProducerRegistrationProperties ... 10-138 10.14.6 listWSRPProducerUserCategories ... 10-139 10.14.7 mapWSRPProducerUserCategory ... 10-140 10.14.8 registerPDKJavaProducer... 10-140 10.14.9 setPDKJavaProducer ... 10-142 10.14.10 deregisterPDKJavaProducer ... 10-144 10.14.11 listPDKJavaProducers ... 10-145 10.14.12 registerPageletProducer... 10-146 10.14.13 setPageletProducer ... 10-147 10.14.14 listPageletProducers ... 10-147 10.14.15 deregisterPageletProducer ... 10-149 10.14.16 refreshProducer ... 10-149 10.14.17 registerOOTBProducers... 10-150 10.14.18 deregisterOOTBProducers ... 10-151 10.14.19 registerSampleProducers... 10-152 10.14.20 deregisterSampleProducers ... 10-152 10.15 RSS News Feeds ... 10-153 10.15.1 getRssProxyConfig ... 10-153 10.15.2 setRssProxyConfig... 10-154 10.15.3 unsetRssProxyConfig ... 10-155 10.16 Search - Oracle SES Search... 10-155 10.16.1 createSESConnection... 10-156

xvii 10.16.3 listSESConnections ... 10-158 10.16.4 setSearchSESConfig ... 10-158 10.16.5 listSearchSESConfig... 10-159 10.16.6 createFederationTrustedEntity ... 10-160 10.17 Search - Oracle SES Search Crawlers ... 10-161 10.17.1 createSpacesCrawler ... 10-162 10.17.2 createDocumentsCrawler ... 10-164 10.17.3 createDiscussionsCrawler ... 10-167 10.17.4 listSpacesCrawler... 10-169 10.17.5 listDocumentsCrawler ... 10-170 10.17.6 listDiscussionsCrawler... 10-171 10.17.7 startSpacesCrawler ... 10-172 10.17.8 startDocumentsCrawler... 10-173 10.17.9 startDiscussionsCrawler ... 10-173 10.17.10 stopSpacesCrawler ... 10-174 10.17.11 stopDocumentsCrawler ... 10-175 10.17.12 stopDiscussionsCrawler ... 10-176 10.17.13 deleteSpacesCrawler ... 10-176 10.17.14 deleteDocumentsCrawler ... 10-177 10.17.15 deleteDiscussionsCrawler ... 10-178 10.18 Search - WebCenter Search... 10-179 10.18.1 setSearchConfig... 10-179 10.18.2 listSearchConfig ... 10-180 10.18.3 setSpacesCrawlProperties ... 10-181 10.18.4 getSpacesCrawlProperties... 10-182 10.19 Worklists ... 10-183 10.19.1 createBPELConnection... 10-183 10.19.2 setBPELConnection ... 10-185 10.19.3 listBPELConnections ... 10-187 10.19.4 addWorklistConnection... 10-188 10.19.5 removeWorklistConnection ... 10-189 10.19.6 listWorklistConnections... 10-189 10.20 WebCenter Spaces... 10-191 10.20.1 getSpacesWorkflowConnectionName... 10-191 10.20.2 setSpacesWorkflowConnectionName ... 10-191 10.20.3 refreshGroupSpaceCache ... 10-192 10.21 WebCenter Identity Store ... 10-194 10.21.1 setWebCenterIdStoreSearchConfig... 10-194 10.21.2 listWebCenterIdStoreSearchConfig ... 10-195 10.22 WebCenter Import and Export ... 10-196 10.22.1 exportWebCenterApplication ... 10-197 10.22.2 importWebCenterApplication ... 10-198 10.22.3 exportGroupSpaces ... 10-198 10.22.4 exportGroupSpaceTemplates... 10-199 10.22.5 importGroupSpaces... 10-200 10.22.6 exportWebCenterResource... 10-201 10.22.7 importWebCenterResource ... 10-202

10.22.8 exportPortletClientMetadata ... 10-203 10.22.9 importPortletClientMetadata... 10-204 10.22.10 importWebCenterTranslations ... 10-205 10.22.11 setSpaceState... 10-205 10.22.12 showProducerImportFailures ... 10-206 10.22.13 retryAllFailedProducerImports ... 10-206 10.23 WebCenter Upgrade... 10-207 10.23.1 upgradeWebCenterDomain ... 10-207 10.23.2 upgradeWebCenterPermissions ... 10-208 10.23.3 upgradeWebCenterApplication ... 10-208

11

Application Development Framework (ADF) Custom WLST Commands

11.1 Overview of WLST Command Categories... 11-1 11.2 ADF-Specific WLST Commands... 11-1 11.2.1 adf_createFileUrlConnection ... 11-2 11.2.2 adf_createHttpUrlConnection ... 11-2 11.2.3 adf_setURLConnectionAttributes ... 11-3 11.2.4 adf_listUrlConnection ... 11-3 11.2.5 getADFMArchiveConfig ... 11-3

12

Portal Custom WLST Commands

12.1 Database Access Descriptor Commands ... 12-1 12.1.1 listDads... 12-2 12.1.2 createPortalDad... 12-2 12.1.3 updatePortalDad... 12-3 12.1.4 deletePortalDad ... 12-4 12.2 Configuration Commands... 12-4 12.2.1 configurePortalCache... 12-5 12.2.2 configurePortalPageEngine... 12-5 12.2.3 listPortalWebcacheConfigAttributes ... 12-7 12.2.4 listPortalSiteConfigAttributes... 12-7 12.2.5 listPortalOIDConfigAttributes... 12-8 12.2.6 setPortalWebcacheConfig... 12-8 12.2.7 setPortalOIDConfig ... 12-9 12.2.8 setPortalMidtierConfig ... 12-9

13

Java Required Files Custom WLST Commands

13.1 Java Required Files Commands... 13-1 13.1.1 applyJRF... 13-2 13.1.2 cloneDeployments ... 13-2

14

Web Services Custom WLST Commands

14.1 Overview of Web Services WLST Commands ... 14-1 14.1.1 Specifying Application and Composite Names ... 14-2 14.1.2 Web Services WLST Command Categories ... 14-3

xix 14.2.1 listWebServices ... 14-4 14.2.2 listWebServicePorts ... 14-6 14.2.3 listWebServiceConfiguration ... 14-7 14.2.4 setWebServiceConfiguration ... 14-8 14.2.5 listWebServiceClients... 14-9 14.2.6 listWebServiceClientPorts ... 14-11 14.2.7 listWebServiceClientStubProperties ... 14-12 14.2.8 setWebServiceClientStubProperty ... 14-13 14.2.9 setWebServiceClientStubProperties... 14-14 14.3 Policy Management Commands... 14-16 14.3.1 listAvailableWebServicePolicies... 14-17 14.3.2 listWebServicePolicies... 14-18 14.3.3 attachWebServicePolicy... 14-19 14.3.4 attachWebServicePolicies ... 14-20 14.3.5 enableWebServicePolicy ... 14-22 14.3.6 enableWebServicePolicies ... 14-23 14.3.7 detachWebServicePolicy... 14-25 14.3.8 detachWebServicePolicies ... 14-26 14.3.9 listWebServiceClientPolicies ... 14-27 14.3.10 attachWebServiceClientPolicy ... 14-28 14.3.11 attachWebServiceClientPolicies... 14-30 14.3.12 enableWebServiceClientPolicy ... 14-31 14.3.13 enableWebServiceClientPolicies... 14-33 14.3.14 detachWebServiceClientPolicy ... 14-34 14.3.15 detachWebServiceClientPolicies ... 14-35 14.3.16 setWebServicePolicyOverride... 14-37 14.4 Policy Set Management Commands ... 14-38 14.4.1 beginRepositorySession ... 14-39 14.4.2 commitRepositorySession ... 14-39 14.4.3 describeRepositorySession ... 14-40 14.4.4 abortRepositorySession... 14-40 14.4.5 createPolicySet... 14-40 14.4.6 listPolicySets ... 14-41 14.4.7 clonePolicySet... 14-42 14.4.8 displayPolicySet ... 14-43 14.4.9 modifyPolicySet ... 14-43 14.4.10 enablePolicySet ... 14-44 14.4.11 enablePolicySetPolicy... 14-44 14.4.12 setPolicySetDescription ... 14-45 14.4.13 validatePolicySet... 14-46 14.4.14 deletePolicySet ... 14-46 14.4.15 attachPolicySet ... 14-47 14.4.16 attachPolicySetPolicy ... 14-47 14.4.17 detachPolicySetPolicy ... 14-48 14.4.18 migrateAttachments ... 14-48 14.5 Oracle WSM Repository Management Commands... 14-49 14.5.1 upgradeWSMPolicyRepository ... 14-50

14.5.2 resetWSMPolicyRepository... 14-50 14.5.3 exportRepository ... 14-51 14.5.4 importRepository... 14-52 14.6 Deployment Descriptor Migration Commands ... 14-53 14.6.1 exportJRFWSApplicationPDD... 14-54 14.6.2 importJRFWSApplicationPDD ... 14-54 14.6.3 savePddToAllAppInstancesInDomain... 14-55

15

Diagnostic Framework Custom WLST Commands

15.1 Incident Commands ... 15-1 15.1.1 createIncident ... 15-2 15.1.2 getIncidentFile... 15-2 15.1.3 listADRHomes ... 15-3 15.1.4 listIncidents... 15-4 15.1.5 listProblems ... 15-4 15.1.6 showIncident ... 15-5 15.2 Diagnostic Dump Commands... 15-5 15.2.1 describeDump ... 15-6 15.2.2 executeDump... 15-6 15.2.3 listDumps... 15-7

16

Information Rights Management Custom WLST Commands

16.1 Overview of WLST IRM Commands ... 16-1 16.2 General Server Commands... 16-2 16.2.1 addIRMRefreshPeriod ... 16-2 16.2.2 getIRMRefreshPeriod... 16-3 16.2.3 getIRMRefreshPeriods ... 16-3 16.2.4 removeIRMRefreshPeriod ... 16-4 16.2.5 updateIRMRefreshPeriod... 16-4 16.2.6 addIRMSyncWindow... 16-5 16.2.7 getIRMSyncWindow ... 16-5 16.2.8 getIRMSyncWindows ... 16-5 16.2.9 removeIRMSyncWindow ... 16-6 16.2.10 updateIRMSyncWindow ... 16-6 16.2.11 getIRMCryptoSchema... 16-7 16.2.12 setIRMCryptoSchema ... 16-7 16.2.13 getIRMDeviceCount... 16-7 16.2.14 setIRMDeviceCount ... 16-8 16.2.15 getIRMJournalCleanUp ... 16-8 16.2.16 setIRMJournalCleanUp... 16-8 16.2.17 getIRMLicenseStateCleanUp ... 16-9 16.2.18 setIRMLicenseStateCleanUp ... 16-9 16.2.19 getIRMPrivacyURL ... 16-10 16.2.20 setIRMPrivacyURL ... 16-10 16.2.21 getIRMKeyStore ... 16-11

xxi 16.3.1 setIRMExportFolder ... 16-12 16.3.2 getIRMExportFolder... 16-12 16.3.3 setIRMImportFolder... 16-12 16.3.4 getIRMImportFolder ... 16-13 16.4 Test Content Commands ... 16-13 16.4.1 addIRMTestContent ... 16-13 16.4.2 getIRMTestContent ... 16-14 16.4.3 getIRMTestContents ... 16-15 16.4.4 removeIRMTestContent... 16-15 16.4.5 updateIRMTestContent ... 16-16 16.5 Languages Support Commands ... 16-16 16.5.1 addIRMTranslation ... 16-17 16.5.2 getIRMDefaultTranslation ... 16-17 16.5.3 getIRMTranslations ... 16-18 16.5.4 removeIRMTranslation ... 16-18 16.5.5 setIRMTranslations ... 16-18 16.6 Oracle IRM Desktop Installers Commands... 16-19 16.6.1 addIRMDownload... 16-19 16.6.2 getIRMDownload ... 16-20 16.6.3 getIRMDownloads... 16-20 16.6.4 removeIRMDownload ... 16-21 16.6.5 updateIRMDownload ... 16-21

17

Imaging and Process Management Custom WLST Commands

17.1 Overview of Oracle I/PM WLST Command Categories ... 17-1 17.2 Diagnostic Commands ... 17-1 17.2.1 clearIPMWorkflowFaults ... 17-2 17.2.2 listIPMWorkflowFaults... 17-2 17.2.3 repairIPMWorkflowFaults ... 17-3 17.2.4 sumIPMWorkflowFaults ... 17-3 17.2.5 resetIpmDMSMetrics ... 17-4 17.3 Oracle I/PM Configuration Commands ... 17-4 17.3.1 createIPMConnection... 17-5 17.3.2 getIPMConfig ... 17-5 17.3.3 grantIPMCredAccess... 17-6 17.3.4 importIPMApplication... 17-6 17.3.5 importIPMInput... 17-8 17.3.6 importIPMSearch... 17-9 17.3.7 listIPMConfig ... 17-11 17.3.8 listIPMExportFile ... 17-11 17.3.9 refreshIPMSecurity... 17-11 17.3.10 setIPMConfig... 17-12 17.3.11 submitIPMToWorkflow... 17-12

18

Oracle Business Process Management Custom WLST Commands

18.1.1 create_public_share ... 18-1 18.1.2 delete_public_share ... 18-2 18.1.3 export_public_share ... 18-3 18.1.4 export_template ... 18-3 18.1.5 publish_template ... 18-4 18.1.6 unlock_public_share... 18-4

19

Universal Content Management Custom WLST Commands

19.1 Overview of WLST UCM Command Categories ... 19-1 19.2 WLST UCM Help ... 19-2 19.3 Getter and Setter Methods Implementation ... 19-2 19.4 Server Configuration Commands... 19-2 19.4.1 getUCMHttpServerAddress ... 19-3 19.4.2 setUCMHttpServerAddress ... 19-3 19.4.3 getUCMServerPort ... 19-4 19.4.4 setUCMServerPort... 19-4 19.4.5 getUCMIPAddressFilter ... 19-4 19.4.6 setUCMIPAddressFilter... 19-5 19.4.7 getUCMUseSSL... 19-5 19.4.8 setUCMUseSSL ... 19-6 19.5 E-Mail Configuration Commands ... 19-6 19.5.1 getUCMMailServer... 19-6 19.5.2 setUCMMailServer ... 19-7 19.5.3 getUCMSmtpPort ... 19-7 19.5.4 setUCMSmtpPort... 19-7 19.5.5 getUCMSysAdminAddress... 19-8 19.5.6 setUCMSysAdminAddress ... 19-8 19.6 Additional Commands... 19-9 19.6.1 getUCMCSVersion ... 19-9 19.6.2 getUCMServerUptime ... 19-9

xxiii

Preface

This preface describes the document accessibility features and conversions used in this guide—WebLogic Scripting Tool Command Reference.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our

documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading

technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an

otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or

organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/support/contact.html or visit http://www.oracle.com/accessibility/support.html if you are hearing impaired.

Conventions

The following text conventions are used in this document: Convention Meaning

boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1

Introduction and Roadmap 1-1

1

Introduction and Roadmap

This section describes the contents and organization of this guide—WebLogic Scripting Tool Command Reference.

■ Section 1.1, "Document Scope and Audience" ■ Section 1.2, "Guide to This Document" ■ Section 1.3, "Related Documentation"

■ Section 1.4, "New and Changed WLST Features in This Release"

1.1 Document Scope and Audience

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.

This document is written for WebLogic Server administrators and operators who deploy Java EE applications using the Java Platform, Enterprise Edition (Java EE) from Oracle. It is assumed that readers are familiar with Web technologies and the operating system and platform where WebLogic Server is installed.

1.2 Guide to This Document

This document is organized as follows:

■ This chapter, "Introduction and Roadmap," introduces the organization of this guide and lists related documentation.

■ Chapter 2, "WebLogic Server WLST Online and Offline Command Reference," summarizes WebLogic Server WLST commands alphabetically and by

online/offline usage.

■ Chapter 3, "WLST Command and Variable Reference," provides detailed descriptions for each of the WebLogic Server WLST commands and variables. ■ Chapter 4, "Infrastructure Security Custom WLST Commands," provides detailed

descriptions for each of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Infrastructure Security components.

Note: Custom WLST commands for a given Oracle Fusion

Middleware component are available for use only if the component is installed in the ORACLE_HOME directory.

Guide to This Document

■ Chapter 5, "User Messaging Service (UMS) Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware User Messaging Service (UMS) component.

■ Chapter 6, "DMS Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion

Middleware Dynamic Monitoring Service (DMS) component.

■ Chapter 7, "Logging Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Logging component.

■ Chapter 8, "Metadata Services (MDS) Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Metadata Services (MDS) component.

■ Chapter 9, "Oracle SOA Suite Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware SOA component.

■ Chapter 10, "Oracle WebCenter Custom WLST Commands," provides detailed descriptions for each of the custom WLST commands that can be used to manage the Oracle Fusion Middleware WebCenter component.

■ Chapter 11, "Application Development Framework (ADF) Custom WLST

Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware ADF component.

■ Chapter 12, "Portal Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Portals component.

■ Chapter 13, "Java Required Files Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware JRF component.

■ Chapter 14, "Web Services Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Web Services component.

■ Chapter 15, "Diagnostic Framework Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Diagnostic Framework component.

■ Chapter 16, "Information Rights Management Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Fusion Middleware Information Rights Management

component.

■ Chapter 17, "Imaging and Process Management Custom WLST Commands," provides detailed descriptions of the custom WLST commands that can be used to manage the Oracle Imaging and Process Management component.

■ Chapter 18, "Oracle Business Process Management Custom WLST Commands," provides detailed descriptions of the custom WLST commands for Oracle Business Process Management.

■ Chapter 19, "Universal Content Management Custom WLST Commands," provides detailed descriptions of the custom WLST commands for Oracle Universal Content Management.

New and Changed WLST Features in This Release

Introduction and Roadmap 1-3

1.3 Related Documentation

For information about how to use the WebLogic Scripting Tool, refer to Oracle WebLogic Scripting Tool.

WLST is one of several interfaces for managing and monitoring WebLogic Server. For information about the other management interfaces, see:

■ "Using Ant Tasks to Configure and Use a WebLogic Server Domain" in Developing Applications for Oracle WebLogic Server, describes using WebLogic Ant tasks for starting and stopping WebLogic Server instances and configuring WebLogic domains.

■ "Deployment Tools" in Deploying Applications to Oracle WebLogic Server describes several tools that WebLogic Server provides for deploying applications and stand-alone modules.

■ Administration Console Online Help describes a Web-based graphical user interface for managing and monitoring WebLogic domains.

■ Creating WebLogic Domains Using the Configuration Wizard describes using a graphical user interface to create a WebLogic domain or extend an existing one. ■ Creating Templates and Domains Using the Pack and Unpack Commands describes

commands that recreate existing WebLogic domains quickly and easily. ■ Developing Custom Management Utilities With JMX for Oracle WebLogic Server

describes using Java Management Extensions (JMX) APIs to monitor and modify WebLogic Server resources.

■ SNMP Management Guide for Oracle WebLogic Server describes using Simple Network Management Protocol (SNMP) to monitor WebLogic domains. ■ Oracle Fusion Middleware Administrator's Guide describes how to manage Oracle

Fusion Middleware, including how to start and stop Oracle Fusion Middleware, how to configure and reconfigure components, and how to back up and recover.

1.4 New and Changed WLST Features in This Release

For a comprehensive listing of the new WebLogic Server features introduced in this release, see What's New in Oracle WebLogic Server.

2

WebLogic Server WLST Online and Offline Command Reference 2-1

2

WebLogic Server WLST Online and Offline

Command Reference

The following sections summarize the WebLogic Server WLST commands, as follows: ■ Section 2.1, "WebLogic Server WLST Command Summary, Alphabetically By

Command"

■ Section 2.2, "WebLogic Server WLST Online Command Summary" ■ Section 2.3, "WebLogic Server WLST Offline Command Summary"

For information about custom WLST commands for Fusion Middleware (FMW) components, refer to the appropriate chapter in this document. For information on how to run FMW custom commands, see "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.

2.1 WebLogic Server WLST Command Summary, Alphabetically By

Command

The following tables summarizes each of the WebLogic Server WLST commands, alphabetically by command. This table does not include custom WLST commands for FMW components. For a list of custom commands for a given FMW component, refer to the appropriate chapter in this document.

Note: You can list a summary of all online and offline commands from the command-line using the following commands, respectively: help("online")

help("offline")

Table 2–1 WebLogic Server WLST Command Summary

This command... Enables you to...

Use with WLST...

activate Activate changes saved during the current editing session but not yet deployed.

Online

addHelpCommand Adds new command help for a command to an existing command group. Once added to the group, the command (along with a brief description) is displayed in the command list for the group when you enter the

help('commandGroup') command.

Online or Offline

WebLogic Server WLST Command Summary, Alphabetically By Command

addHelpCommandGro up

Adds a new help command group to those shown by the WLST help() command.

Online or Offline

addListener Add a JMX listener to the specified MBean. Online

addTemplate Extend the current WebLogic domain using an application or service extension template.

Offline

assign Assign resources to one or more destinations. Offline

cancelEdit Cancel an edit session, release the edit lock, and discard all unsaved changes. This operation can be called by any user with administrator privileges, even if the user did not start the edit session.

Online

cd Navigate the hierarchy of configuration or runtime beans. Online or Offline

closeDomain Close the current WebLogic domain. Offline

closeTemplate Close the current domain template. Offline

configToScript Convert an existing server configuration (config

directory) to an executable WLST script.

Online or Offline

connect Connect WLST to a WebLogic Server instance. Online

or Offline

create Create a configuration bean of the specified type for the current bean.

Online or Offline

currentTree Return the current location in the hierarchy. Online

custom Navigate to the root of custom MBeans that are registered in the Runtime MBean Server.

Online

delete Delete an instance of a configuration bean of the specified type for the current configuration bean.

Online or Offline

deploy Deploy an application to a WebLogic Server instance. Online

disconnect Disconnect WLST from a WebLogic Server instance. Online

distributeApplication Copy the deployment bundle to the specified targets. Online

domainConfig Navigate to the last MBean to which you navigated in the domain configuration hierarchy or to the root of the hierarchy, DomainMBean.

Online

domainCustom Navigate to the tree of custom MBeans that are registered in the Domain Runtime MBean Server.

Online

domainRuntime Navigate to the last MBean to which you navigated in the domain runtime hierarchy or to the root of the hierarchy,

DomainRuntimeMBean.

Online

dumpStack Display stack trace from the last exception that occurred while performing a WLST action, and reset the stack trace.

Online or Offline

Table 2–1 (Cont.) WebLogic Server WLST Command Summary

This command... Enables you to...

Use with WLST...

WebLogic Server WLST Command Summary, Alphabetically By Command

WebLogic Server WLST Online and Offline Command Reference 2-3

dumpVariables Display all variables used by WLST, including their name and value.

Online or Offline

edit Navigate to the last MBean to which you navigated in the configuration edit MBean hierarchy or to the root of the hierarchy, DomainMBean.

Online

encrypt Encrypt the specified string. Online

exit Exit WLST from the user session and close the scripting shell.

Online or Offline

exportDiagnosticData Execute a query against the specified log file. Offline

exportDiagnosticDataF romServer

Executes a query on the server side and retrieves the exported WebLogic Diagnostic Framework (WLDF) data.

Online

find Find MBeans and attributes in the current hierarchy. Online

get Return the value of the specified attribute. Online or Offline

getActivationTask Return the latest ActivationTask MBean on which a user can get status.

Online

getAvailableCapturedI mages

Returns a list of the previously captured diagnostic images. Online

getConfigManager Return the latest ConfigurationManagerBean MBean which manages the change process.

Online

getMBean Return the MBean by browsing to the specified path. Online

getMBI Return the MBeanInfo for the specified MBeanType or the

cmo variable.

Online

getPath Return the MBean path for the specified MBean instance. Online

getWLDM Return the WebLogic DeploymentManager object. Online

invoke Invoke a management operation on the current configuration bean.

Online

isRestartRequired Determine whether a server restart is required. Online

jndi Navigates to the JNDI tree for the server to which WLST is currently connected.

Online

listApplications List all applications that are currently deployed in the domain.

Online

listChildTypes List all the children MBeans that can be created or deleted for the cmo.

Online

loadApplication Load an application and deployment plan into memory. Online or Offline

loadDB Load SQL files into a database. Offline

loadProperties Load property values from a file. Online

and Offline

lookup Look up the specified MBean. Online

Table 2–1 (Cont.) WebLogic Server WLST Command Summary

This command... Enables you to...

Use with WLST...

WebLogic Server WLST Command Summary, Alphabetically By Command

ls List all child beans and/or attributes for the current configuration or runtime bean.

Online or Offline

man Display help from MBeanInfo for the current MBean or its specified attribute.

Online

migrate Migrate services to a target server within a cluster. Online

nm Determine whether WLST is connected to Node Manager. Online

nmConnect Connect WLST to Node Manager to establish a session. Online or Offline

nmDisconnect Disconnect WLST from a Node Manager session. Online or Offline

nmEnroll Enroll the machine on which WLST is currently running. Online

nmGenBootStartupPro ps

Generates the Node Manager property files,

boot.properties and startup.properties, for the specified server.

Online

nmKill Kill the specified server instance that was started with Node Manager.

Online or Offline

nmLog Return the Node Manager log. Online

or Offline

nmServerLog Return the server output log of the server that was started with Node Manager.

Online or Offline

nmServerStatus Return the status of the server that was started with Node Manager.

Online or Offline

nmStart Start a server in the current domain using Node Manager. Online or Offline

nmVersion Return the Node Manager server version. Online

or Offline

prompt Toggle the display of path information at the prompt. Online or Offline

pwd Display the current location in the configuration or runtime bean hierarchy.

Online or Offline

readDomain Open an existing WebLogic domain for updating. Offline

readTemplate Open an existing domain template for WebLogic domain creation.

Offline

redeploy Reload classes and redeploy a previously deployed application.

Online

Table 2–1 (Cont.) WebLogic Server WLST Command Summary

This command... Enables you to...

Use with WLST...

WebLogic Server WLST Command Summary, Alphabetically By Command

WebLogic Server WLST Online and Offline Command Reference 2-5

redirect Redirect WLST output to the specified filename. Online or Offline

removeListener Remove a listener that was previously defined. Online

resume Resume a server instance that is suspended or in ADMIN

state.

Online

save Save the edits that have been made but have not yet been saved.

Online

saveDiagnosticImageC aptureFile

Downloads the specified diagnostic image capture. Online

saveDiagnosticImageC aptureEntryFile

Downloads a specific entry from the diagnostic image capture.

Online

serverRuntime Navigate to the last MBean to which you navigated in the runtime MBean hierarchy or to the root of the hierarchy,

ServerRuntimeMBean.

Online

set Set the specified attribute value for the current configuration bean.

Online or Offline

setOption Set options related to a WebLogic domain creation or update

Offline

showChanges Show the changes made by the current user during the current edit session.

Online

showListeners Show all listeners that are currently defined. Online

shutdown Gracefully shut down a running server instance or cluster. Online

start Start a Managed Server instance or a cluster using Node Manager.

Online

startApplication Start an application, making it available to users. Online

startEdit Start a configuration edit session on behalf of the currently connected user.

Online

startNodeManager Start Node Manager at default port (5556). Online or Offline

startRecording Record all user interactions with WLST; useful for capturing commands to replay.

Online or Offline

startServer Start the Administration Server. Online

or Offline

state Returns a map of servers or clusters and their state using Node Manager.

Online

stopApplication Stop an application, making it un available to users. Online

stopEdit Stop the current edit session, release the edit lock, and discard unsaved changes.

Online

stopNodeManager Stop Node Manager. Online

or Offline

Table 2–1 (Cont.) WebLogic Server WLST Command Summary

This command... Enables you to...

Use with WLST...

WebLogic Server WLST Online Command Summary

2.2 WebLogic Server WLST Online Command Summary

The following table summarizes the WebLogic Server WLST online commands, alphabetically by command. This table does not include custom WLST commands for FMW components. For a list of custom commands for a given FMW component, refer to the appropriate chapter in this document.

stopRecording Stop recording WLST commands. Online

or Offline

stopRedirect Stop the redirection of WLST output to a file. Online or Offline

storeUserConfig Create a user configuration file and an associated key file. Online

suspend Suspend a running server. Online

threadDump Display a thread dump for the specified server. Online or Offline

undeploy Undeploy an application from the specified servers. Online

updateApplication Update an application configuration using a new deployment plan.

Online

updateDomain Update and save the current domain. Offline

unassign Unassign applications or services from one or more destinations.

Offline

undo Revert all unsaved or unactivated edits. Online

validate Validate the changes that have been made but have not yet been saved.

Online

viewMBean Display information about an MBean, such as the attribute names and values, and operations.

Online

writeDomain Write the domain configuration information to the specified directory.

Offline

writeIniFile Convert WLST definitions and method declarations to a Python (.py) file.

Online or Offline

writeTemplate Writes the domain configuration information to the specified domain template.

Offline

Table 2–2 WebLogic Server WLST Online Command Summary

This command... Enables you to...

activate Activate changes saved during the current editing session but not yet deployed.

addHelpCommand Adds new command help for a command to an existing

command group. Once added to the group, the command (along with a brief description) is displayed in the command list for the group when you enter the help('commandGroup')

command.

Table 2–1 (Cont.) WebLogic Server WLST Command Summary

This command... Enables you to...

Use with WLST...

WebLogic Server WLST Online Command Summary

WebLogic Server WLST Online and Offline Command Reference 2-7

addHelpCommandGroup Adds a new help command group to those shown by the WLST

help() command, and specifies the resource bundle in which the help information is defined for the group.

addListener Add a JMX listener to the specified MBean.

cancelEdit Cancel an edit session, release the edit lock, and discard all unsaved changes. This operation can be called by any user with administrator privileges, even if the user did not start the edit session.

cd Navigate the hierarchy of configuration or runtime beans.

configToScript Convert an existing server configuration (config directory) to an executable WLST script.

connect Connect WLST to a WebLogic Server instance.

create Create a configuration bean of the specified type for the current bean.

currentTree Return the current tree location.

custom Navigate to the root of custom MBeans that are registered in the Runtime MBean Server.

delete Delete an instance of a configuration bean of the specified type for the current configuration bean.

deploy Deploy an application to a WebLogic Server instance.

disconnect Disconnect WLST from a WebLogic Server instance.

distributeApplication Copy the deployment bundle to the specified targets.

domainConfig Navigate to the last MBean to which you navigated in the domain configuration hierarchy or to the root of the hierarchy,

DomainMBean.

domainCustom Navigate to the tree of custom MBeans that are registered in the Domain Runtime MBean Server.

domainRuntime Navigate to the last MBean to which you navigated in the domain runtime hierarchy or to the root of the hierarchy,

DomainRuntimeMBean.

dumpStack Display stack trace from the last exception that occurred, and reset the trace.

dumpVariables Display all variables used by WLST, including their name and value.

edit Navigate to the last MBean to which you navigated in the configuration edit MBean hierarchy or to the root of the hierarchy, DomainMBean.

encrypt Encrypt the specified string.

exit Exit WLST from the interactive session and close the scripting shell.

exportDiagnosticDataFromS erver

Execute a query on the server side and retrieves the exported WebLogic Diagnostic Framework (WLDF) data.

find Find MBeans and attributes in the current hierarchy.

get Return the value of the specified attribute.

getActivationTask Return the latest ActivationTask MBean on which a user can get status.

Table 2–2 (Cont.) WebLogic Server WLST Online Command Summary

WebLogic Server WLST Online Command Summary

getAvailableCapturedImage s

Returns a list of the previously captured diagnostic images.

getConfigManager Return the latest ConfigurationManagerBean MBean which manages the change process.

getMBean Return the MBean by browsing to the specified path.

getMBI Return the MBeanInfo for the specified MBeanType or the cmo

variable.

getPath Return the MBean path for the specified MBean instance.

getWLDM Return the WebLogic DeploymentManager object.

invoke Invoke a management operation on the current configuration bean.

isRestartRequired Determine whether a server restart is required.

jndi Navigates to the JNDI tree for the server to which WLST is currently connected.

listApplications List all applications that are currently deployed in the domain.

listChildTypes List all the children MBeans that can be created or deleted for the cmo.

loadApplication Load an application and deployment plan into memory.

loadProperties Load property values from a file.

lookup Look up the specified MBean.

ls List all child beans and/or attributes for the current configuration or runtime bean.

man Display help from MBeanInfo for the current MBean or its specified attribute.

migrate Migrate services to a target server within a cluster.

nm Determine whether WLST is connected to Node Manager.

nmConnect Connect WLST to Node Manager to establish a session.

nmDisconnect Disconnect WLST from a Node Manager session.

nmEnroll Enroll the machine on which WLST is currently running.

nmGenBootStartupProps Generates the Node Manager property files,

boot.properties and startup.properties, for the specified server.

nmKill Kill the specified server instance that was started with Node Manager.

nmLog Return the Node Manager log.

nmServerLog Return the server output log of the server that was started with Node Manager.

nmServerStatus Return the status of the server that was started with Node Manager.

nmStart Start a server in the current domain using Node Manager.

nmVersion Return the Node Manager server version.

prompt Toggle the display of path information at the prompt.

Table 2–2 (Cont.) WebLogic Server WLST Online Command Summary

WebLogic Server WLST Online Command Summary

WebLogic Server WLST Online and Offline Command Reference 2-9

pwd Display the current location in the configuration or runtime bean hierarchy.

redeploy Reload classes and redeploy a previously deployed application.

redirect Redirect WLST output to the specified filename.

removeListener Remove a listener that was previously defined.

resume Resume a server instance that is suspended or in ADMIN state.

save Save the edits that have been made but have not yet been saved.

saveDiagnosticImageCaptur eFile

Downloads the specified diagnostic image capture.

saveDiagnosticImageCaptur eEntryFile

Downloads a specific entry from the diagnostic image capture.

serverConfig Navigate to the last MBean to which you navigated in the configuration MBean hierarchy or to the root of the hierarchy,

DomainMBean.

serverRuntime Navigate to the last MBean to which you navigated in the runtime MBean hierarchy or to the root of the hierarchy,

ServerRuntimeMBean.

set Set the specified attribute value for the current configuration bean.

showChanges Show the changes made by the current user during the current edit session.

showListeners Show all listeners that are currently defined.

shutdown Gracefully shut down a running server instance or cluster.

start Start a Managed Server instance or a cluster using Node Manager.

startApplication Start an application, making it available to users.

startEdit Start a configuration edit session on behalf of the currently connected user.

startNodeManager Start Node Manager at default port (5556).

startRecording Record all user interactions with WLST; useful for capturing commands to replay.

startServer Start the Administration Server.

state Returns a map of servers or clusters and their state using Node Manager

stopApplication Stop an application, making it un available to users.

stopEdit Stop the current edit session, release the edit lock, and discard unsaved changes.

stopNodeManager Stop Node Manager.

stopRedirect Stop the redirection of WLST output to a file.

storeUserConfig Create a user configuration file and an associated key file.

suspend Suspend a running server.

threadDump Display a thread dump for the specified server.

undeploy Undeploy an application from the specified servers.

Table 2–2 (Cont.) WebLogic Server WLST Online Command Summary

WebLogic Server WLST Offline Command Summary

2.3 WebLogic Server WLST Offline Command Summary

The following table summarizes the WebLogic Server WLST offline commands, alphabetically by command.

undo Revert all unsaved or unactivated edits.

updateApplication Update an application configuration using a new deployment plan.

validate Validate the changes that have been made but have not yet been saved.

viewMBean Display information about an MBean, such as the attribute names and values, and operations.

writeIniFile Convert WLST definitions and method declarations to a Python (.py) file.

Table 2–3 WebLogic Server WLST Offline Command Summary

This command... Enables you to...

addHelpCommand Adds new command help for a command to an existing command group. Once added to the group, the command (along with a brief description) is displayed in the command list for the group when you enter the help('commandGroup') command.

addHelpCommandGroup Adds a new help command group to those shown by the WLST

help() command, and specifies the resource bundle in which the help information is defined for the group.

addTemplate Extend the current domain using an application or service extension template.

assign Assign resources to one or more destinations.

cd Navigate the hierarchy of configuration or runtime beans.

closeDomain Close the current domain.

closeTemplate Close the current domain template.

configToScript Convert an existing server configuration (config directory) to an executable WLST script.

connect Connect WLST to a WebLogic Server instance.

create Create a configuration bean of the specified type for the current bean.

delete Delete an instance of a configuration bean of the specified type for the current configuration bean.

dumpStack Display stack trace from the last exception that occurred while performing a WLST action, and reset the stack trace.

dumpVariables Display all variables used by WLST, including their name and value.

exit Exit WLST from the interactive session and close the scripting shell.

exportDiagnosticData Execute a query against the specified log file.

get Return the value of the specified attribute.

Table 2–2 (Cont.) WebLogic Server WLST Online Command Summary

WebLogic Server WLST Offline Command Summary

WebLogic Server WLST Online and Offline Command Reference 2-11

loadApplication Load an application and deployment plan into memory.

loadDB Load SQL files into a database.

loadProperties Load property values from a file.

ls List all child beans and/or attributes for the current configuration or runtime bean.

nmConnect Connect WLST to Node Manager to establish a session.

prompt Toggle the display of path information at the prompt.

pwd Display the current location in the configuration or runtime bean hierarchy.

readDomain Open an existing WebLogic domain for updating.

readTemplate Open an existing domain template for domain creation.

redirect Redirect WLST output to the specified filename.

set Set the specified attribute value for the current configuration bean.

setOption Set options related to a WebLogic domain creation or update.

startNodeManager Start Node Manager at default port (5556).

startRecording Record all user interactions with WLST; useful for capturing commands to replay.

startServer Start the Administration Server.

stopNodeManager Stop Node Manager.

stopRedirect Stop the redirection of WLST output to a file.

threadDump Display a thread dump for the specified server.

unassign Unassign applications or services from one or more destinations.

updateDomain Update and save the current domain.

writeDomain Write the domain configuration information to the specified directory.

writeIniFile Convert WLST definitions and method declarations to a Python (.py) file.

writeTemplate Writes the domain configuration information to the specified domain template.

Table 2–3 (Cont.) WebLogic Server WLST Offline Command Summary

3

WLST Command and Variable Reference 3-1

3

WLST Command and Variable Reference

The following sections describe the WLST commands and variables in detail. Topics include:

■ Section 3.1, "Overview of WLST Command Categories" ■ Section 3.2, "Browse Commands"

■ Section 3.3, "Control Commands" ■ Section 3.4, "Customization Commands" ■ Section 3.5, "Deployment Commands" ■ Section 3.6, "Diagnostics Commands" ■ Section 3.7, "Editing Commands" ■ Section 3.8, "Information Commands" ■ Section 3.9, "Life Cycle Commands" ■ Section 3.10, "Node Manager Commands" ■ Section 3.11, "Tree Commands"

■ Section 3.12, "WLST Variable Reference"

3.1 Overview of WLST Command Categories

WLST commands are divided into the following categories.

Note: It is recommended that you review "Syntax for WLST Commands" in Oracle WebLogic Scripting Tool for command syntax requirements.

Table 3–1 WLST Command Categories

Command Category Description

Section 3.2, "Browse Commands"

Navigate the hierarchy of configuration or runtime beans and control the prompt display.

Section 3.3, "Control Commands"

■ Connect to or disconnect from a server.

■ Create and configure a WebLogic domain or domain

template.

Browse Commands

3.2 Browse Commands

Use the WLST browse commands, listed in Table 3–2, to navigate the hierarchy of configuration or runtime beans and control the prompt display.

3.2.1 cd

Command Category: Browse Commands Use with WLST: Online or Offline

3.2.1.1 Description

Navigates the hierarchy of configuration or runtime beans. This command uses a model that is similar to navigating a file system in a Windows or UNIX command

Section 3.4, "Customization Commands"

Add the command group help and command help that is displayed by the WLST help() and help('commandGroup')

commands.

Section 3.5, "Deployment Commands"

■ Deploy, undeploy, and redeploy applications and standalone

modules to a WebLogic Server instance.

■ Update an existing deployment plan.

■ Interrogate the WebLogic Deployment Manager object. ■ Start and stop a deployed application.

Section 3.6, "Diagnostics Commands"

Export diagnostic data.

Section 3.7, "Editing Commands"

Interrogate and edit configuration beans.

Section 3.8, "Information Commands"

Interrogate WebLogic domains, servers, and variables, and provide configuration bean, runtime bean, and WLST-related information.

Section 3.9, "Life Cycle Commands"

Manage the life cycle of a server instance.

Section 3.10, "Node Manager Commands"

Start, shut down, restart, and monitor WebLogic Server instances using Node Manager.

Section 3.11, "Tree Commands"

Navigate among MBean hierarchies.

Table 3–2 Browse Commands for WLST Configuration

Use this command... To...

Use with WLST...

cd Navigate the hierarchy of configuration or runtime beans.

Online or Offline

currentTree Return the current location in the hierarchy. Online

prompt Toggle the display of path information at the prompt. Online or Offline

pwd Display the current location in the hierarchy. Online or Offline

Table 3–1 (Cont.) WLST Command Categories

Browse Commands

WLST Command and Variable Reference 3-3 above the current directory. To get back to the root bean after navigating to a bean that is deep in the hierarchy, enter cd('/').

You can navigate to beans in the current hierarchy and to any child or instance. The cd command returns a stub of the configuration or runtime bean instance, if one exists. If you navigate to a type, this command returns a stub of the configuration or runtime bean instance from which you navigated. In the event of an error, the command returns a WLSTException.

3.2.1.2 Syntax

cd(mbeanName)

3.2.1.3 Examples

The following example navigates the hierarchy of configuration beans. The first command navigates to the Servers configuration bean type, the second, to the

myserver configuration bean instance, and the last back up two levels to the original directory location.

wls:/mydomain/serverConfig> cd('Servers')

wls:/mydomain/serverConfig/Servers> cd('myserver')

wls:/mydomain/serverConfig/Servers/myserver> cd('../..')

wls:/mydomain/serverConfig>

3.2.2 currentTree

Command Category: Browse Commands Use with WLST: Online

3.2.2.1 Description

Returns the current location in the hierarchy. This command enables you to store the current location in the hierarchy and easily return to it after browsing. In the event of an error, the command returns a WLSTException.

3.2.2.2 Syntax

currentTree()

3.2.2.3 Example

The following example stores the current location in the hierarchy in myTree and uses it to navigate back to the Edit MBean hierarchy from the runtime MBean hierarchy on an Administration Server instance.

wls:/mydomain/edit> myTree=currentTree()

wls:/mydomain/edit> serverRuntime()

Note: The cmo variable is initialized to the root of all domain

configuration beans when you first connect WLST to a server instance. It reflects the parent configuration bean type until you navigate to an instance. For more information about the cmo variable, see "Changing the Current Management Object" in Oracle WebLogic Scripting Tool.

Argument Definition

Browse Commands

Location changed to serverRuntime tree. This is a read-only tree with ServerRuntimeMBean as the root.

For more help, use help('serverRuntime') wls:/mydomain/serverRuntime> myTree()

wls:/mydomain/edit>

3.2.3 prompt

Command Category: Browse Commands Use with WLST: Online or Offline

3.2.3.1 Description

Toggles the display of path information at the prompt, when entered without an argument. This command is useful when the prompt becomes too long due to the length of the path.

You can also explicitly specify on or off as an argument to the command. When you specify off, WLST hides the WLST prompt and defaults to the Jython prompt. By default, the WLST prompt displays the configuration or runtime navigation path information.

When you disable the prompt details, to determine your current location in the hierarchy, you can use the pwd command, as described in Section 3.2.4, "pwd". In the event of an error, the command returns a WLSTException.

3.2.3.2 Syntax

prompt(myPrompt)

3.2.3.3 Examples

The following example hides and then redisplays the path information at the prompt. wls:/mydomain/serverConfig/Servers/myserver> prompt()

wls:/> prompt()

wls:/mydomain/serverConfig/Servers/myserver>

The following example hides the prompt and defaults to the Jython prompt (since the command is run using WLST online), changes the Jython prompt, and then redisplays the WLST prompt. This example also demonstrates the use of the pwd command. Argument Definition

myPrompt Optional. Hides or displays WLST prompt. Valid values include off or on.

■ The off argument hides the WLST prompt.

If you run prompt('off'), when using WLST online, the prompt defaults to the Jython prompt. You can create a new prompt using Jython syntax. For more information about programming using Jython, see http://www.jython.org. In this case, if you subsequently enter the prompt command without arguments, WLST displays the WLST command prompt without the path information. To redisplay the path information, enter prompt() again, or enter prompt('on').

■ The on argument displays the default WLST prompt, including the path

or

getUCMIPAddressFilter(application_name)

19.4.5.3 Example

The following command displays the IP address filter value for the application "Oracle Content Server":

getUCMIPAddressFilter('Oracle Content Server') 10.131.123.*

19.4.6 setUCMIPAddressFilter

Use with WLST: Online

19.4.6.1 Description

Sets the Oracle UCM IP Address Filter value, which must be of "*.*.*.*" format or IPV6 Format. The value must be taken from a list of IP Addresses allowed to communicate with the Content Server instance through the Intradoc Server Port.

19.4.6.2 Syntax

setUCMIPAddressFilter(value) or

setUCMIPAddressFilter(value,application_name)

19.4.6.3 Example

The following command sets the value for the Oracle UCM IP address filter for the application "Oracle Content Server":

setUCMIPAddressFilter(10.131.123.*,'Oracle Content Server')

19.4.7 getUCMUseSSL

Use with WLST: Online

19.4.7.1 Description

Gets the Use SSL value from the config.cfg file and displays it. The value can be True or False.

19.4.7.2 Syntax

getUCMUseSSL() or

getUCMUseSSL(application_name)

19.4.7.3 Example

The following command displays the Use SSL value for the application "Oracle Content Server":

getUCMUseSSL('Oracle Content Server') True

E-Mail Configuration Commands

19.4.8 setUCMUseSSL

Use with WLST: Online

19.4.8.1 Description

Sets the Use SSL value in the config.cfg file. The value can be True or False.

19.4.8.2 Syntax

setUCMUseSSL(value) or

setUCMUseSSL(value,application_name)

19.4.8.3 Example

The following command sets the Use SSL value for the application "Oracle Content Server":

setUCMUseSSL(True,'Oracle Content Server')

19.5 E-Mail Configuration Commands

Use the commands in Table 19–3 to configure e-mail for the Oracle UCM Oracle Content Server instance.

19.5.1 getUCMMailServer

Use with WLST: Online

19.5.1.1 Description

Gets the Mail Server value from the config.cfg file and displays it.

19.5.1.2 Syntax

getUCMMailServer() or

getUCMMailServer(application_name) Table 19–3 WLST E-Mail Configuration Commands Use this command... To...

Use with WLST...

getUCMMailServer Display the Mail Server value. Online

setUCMMailServer Set the Mail Server value. Online

getUCMSmtpPort Display the SMTP Port value. Online

setUCMSmtpPort Set the SMTP Port value. Online

getUCMSysAdminAddr ess

Display the Admin Address value. Online

setUCMSysAdminAddr ess

19.5.1.3 Example

The following command displays the Mail Server value for the application "Oracle Content Server":

getUCMMailServer('Oracle Content Server') mymailserver.mycompany.com

19.5.2 setUCMMailServer

Use with WLST: Online

19.5.2.1 Description

Sets the Mail Server value in the config.cfg file. The Mail Server value is the name of the mail server that the Oracle Content Server instance uses to send SMTP based e-mail.

19.5.2.2 Syntax

setUCMMailServer(value) or

setUCMMailServer(value,application_name)

19.5.2.3 Example

The following command sets the value for the Mail Server for the application "Oracle Content Server":

setUCMMailServer(mymailserver.mycompany.com,'Oracle Content Server')

19.5.3 getUCMSmtpPort

Use with WLST: Online

19.5.3.1 Description

Gets the SMTP Port value in the config.cfg file and displays it.

19.5.3.2 Syntax

getUCMSmtpPort() or

getUCMSmtpPort(application_name)

19.5.3.3 Example

The following command displays the SMTP port value for the application "Oracle Content Server":

getUCMSmtpPort('Oracle Content Server') 4055

19.5.4 setUCMSmtpPort

E-Mail Configuration Commands

19.5.4.1 Description

Sets the SMTP Port value in the config.cfg file. The SMTP Port must be a positive integer between 1 and 65535. To reset the port to null, enter None for the value: setUCMSmtpPort(None)

19.5.4.2 Syntax

setUCMSmtpPort(value) or

setUCMSmtpPort(value,application_name)

19.5.4.3 Example

The following command sets the SMTP port value for the application "Oracle Content Server":

setUCMSmtpPort(4055,'Oracle Content Server')

19.5.5 getUCMSysAdminAddress

Use with WLST: Online

19.5.5.1 Description

Gets the Admin Address value from the config.cfg file and displays it. The value can be of the form abc@xyz.def.

19.5.5.2 Syntax

getUCMSysAdminAddress() or

getUCMSysAdminAddress(application_name)

19.5.5.3 Example

The following command displays the Admin Address value for the application "Oracle Content Server":

getUCMSysAdminAddress('Oracle Content Server') mymail@mycompany.com

19.5.6 setUCMSysAdminAddress

Use with WLST: Online

19.5.6.1 Description

Sets the Admin Address value in the config.cfg file. The Admin Address can be of the form abc@xyz.def.

19.5.6.2 Syntax

setUCMSysAdminAddress(value) or

19.5.6.3 Example

The following command sets the Admin Address value for the application "Oracle Content Server":

setUCMSysAdminAddress(mymail@mycompany.com,'Oracle Content Server')

19.6 Additional Commands

Use the commands in Table 19–4 to configure additional settings to monitor the Oracle UCM Oracle Content Server instance.

19.6.1 getUCMCSVersion

Use with WLST: Online

19.6.1.1 Description

Gets the version number of the Oracle Content Server running instance.

19.6.1.2 Syntax

getUCMCSVersion() or

getUCMCSVersion(application_name)

19.6.1.3 Example

The following command displays the version number of the active instance of the application "Oracle Content Server":

getUCMCSVersion('Oracle Content Server') 11g R1

19.6.2 getUCMServerUptime

Use with WLST: Online

19.6.2.1 Description

Gets the amount of time the Oracle Content Server instance has been up.

19.6.2.2 Syntax

getUCMServerUptime() or

getUCMServerUptime(application_name) Table 19–4 WLST Additional Configuration Commands Use this command... To...

Use with WLST...

getUCMCSVersion Display the version number. Online

Additional Commands

19.6.2.3 Example

The following command displays the amount of time the application "Oracle Content Server" has been up:

getUCMServerUptime('Oracle Content Server') 00H:01 Min:12 Sec:255 MilliSeconds