Skip Headers
Oracle® Fusion Middleware WebLogic Scripting Tool Command Reference
11g Release 2 (11.1.2)

Part Number E28155-03
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

19 Oracle WebCenter Content Custom WLST Commands

The following sections describe the custom WLST commands for Oracle WebCenter Content. These commands enable you to configure and monitor the WebCenter Content server and the Content Server instance from the command line. Topics include:

For additional information about WebCenter Content and Content Server administration and configuration, see Oracle WebCenter Content System Administrator's Guide for Content Server.

Note:

To use the WebCenter Content custom commands, you must invoke the WLST script from the Oracle Common home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.

Overview of WLST WebCenter Content Command Categories

WLST WebCenter Content commands are divided into the following categories:

Table 19-1 WLST WebCenter Content Command Categories

Command Category Description

Server Configuration Commands

View and manage configuration for the Content Server instance.

E-Mail Configuration Commands

View and manage configuration for Content Server e-mail.

Additional Commands

View status information for the Content Server instance.


WLST WebCenter Content Help

To view the WebCenter Content commands that can be invoked from WLST, enter the following command at the WLST prompt:

help('UCM')

To view help for a specific WebCenter Content command, replace the 'UCM' with the name of the command; for example:

help('getUCMServerPort')

Getter and Setter Methods Implementation

The WLST component for WebCenter Content uses getter and setter methods to handle a situation where multiple applications register their corresponding Mbeans on a managed server, but WLST can talk to only one application.

Getter Method

The getter method is designed to handle zero or one argument.

If you do not provide an argument to an WLST WebCenter Content command, then one of two things occurs:

If there is one argument to an WLST WebCenter Content command, then the following occurs:

Setter Method

The setter method is designed to handle one or two arguments.

Server Configuration Commands

Use the commands in Table 19-2 to configure the Oracle WebCenter Content Server instance.

Table 19-2 WLST Server Configuration Commands

Use this command... To... Use with WLST...

getUCMHttpServerAddress

Display the HTTP Server Address value.

Online

setUCMHttpServerAddress

Set the HTTP Server Address value.

Online

getUCMServerPort

Display the Intradoc Server Port configuration parameter.

Online

setUCMServerPort

Set the Intradoc Server Port configuration parameter.

Online

getUCMIPAddressFilter

Display the IP Address Filter value.

Online

setUCMIPAddressFilter

Set the IP Address Filter value.

Online

getUCMUseSSL

Display the Use SSL value.

Online

setUCMUseSSL

Set the Use SSL value.

Online


getUCMHttpServerAddress

Use with WLST: Online

Description

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

Syntax

getUCMHttpServerAddress()

or

getUCMHttpServerAddress(application_name)

Example

The following command displays the WebCenter Content HTTP server address for the application "Content Server":

getUCCHttpServerAddress('Content Server')
server.mycompany.com

setUCMHttpServerAddress

Use with WLST: Online

Description

Sets the HTTP Server Address value in the config.cfg file. The HTTP Server Address can be of the form abc.xyz.def or an IP address with port number.

The HTTP Server Address is used to formulate full URLs in the Content Server user interface.

Syntax

setUCMHttpServerAddress()

or

setUCMHttpServerAddress(value,application_name)

Example

The following command sets the Oracle WebCenter Content HTTP server address for the application "Content Server":

setUCMHttpServerAddress(server.mycompany.com,'Content Server')

getUCMServerPort

Use with WLST: Online

Description

Gets the Intradoc Server Port configuration parameter from the config.cfg file and displays it.

Syntax

getUCMServerPort()

or

getUCMServerPort(application_name)

Example

The following command displays the Intradoc Server Port value for the application "Content Server":

getUCMServerPort('Content Server')
4442

setUCMServerPort

Use with WLST: Online

Description

Sets the Server Port configuration parameter. The Server Port must be a positive integer between 0 and 65535.

Syntax

setUCMServerPort(value)

or

setUCMServerPort(value,application_name)

Example

The following command sets the Server Port configuration parameter for the application "Content Server":

setUCMServerPort(4442,'Content Server')

getUCMIPAddressFilter

Use with WLST: Online

Description

Gets the IP Address Filter value from the config.cfg file and displays it.

Syntax

getUCMIPAddressFilter()

or

getUCMIPAddressFilter(application_name)

Example

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

getUCMIPAddressFilter('Content Server')
10.131.123.*

setUCMIPAddressFilter

Use with WLST: Online

Description

Sets the WebCenter Content 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.

Syntax

setUCMIPAddressFilter(value)

or

setUCMIPAddressFilter(value,application_name)

Example

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

setUCMIPAddressFilter(10.131.123.*,'Content Server')

getUCMUseSSL

Use with WLST: Online

Description

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

Syntax

getUCMUseSSL()

or

getUCMUseSSL(application_name)

Example

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

getUCMUseSSL('Content Server')
True

setUCMUseSSL

Use with WLST: Online

Description

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

Syntax

setUCMUseSSL(value)

or

setUCMUseSSL(value,application_name)

Example

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

setUCMUseSSL(True,'Content Server')

E-Mail Configuration Commands

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

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

getUCMSysAdminAddress

Display the Admin Address value.

Online

setUCMSysAdminAddress

Set the Admin Address value.

Online


getUCMMailServer

Use with WLST: Online

Description

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

Syntax

getUCMMailServer()

or

getUCMMailServer(application_name)

Example

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

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

setUCMMailServer

Use with WLST: Online

Description

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

Syntax

setUCMMailServer(value)

or

setUCMMailServer(value,application_name)

Example

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

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

getUCMSmtpPort

Use with WLST: Online

Description

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

Syntax

getUCMSmtpPort()

or

getUCMSmtpPort(application_name)

Example

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

getUCMSmtpPort('Content Server')
4055

setUCMSmtpPort

Use with WLST: Online

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)

Syntax

setUCMSmtpPort(value)

or

setUCMSmtpPort(value,application_name)

Example

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

setUCMSmtpPort(4055,'Content Server')

getUCMSysAdminAddress

Use with WLST: Online

Description

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

Syntax

getUCMSysAdminAddress()

or

getUCMSysAdminAddress(application_name)

Example

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

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

setUCMSysAdminAddress

Use with WLST: Online

Description

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

Syntax

setUCMSysAdminAddress(value)

or

setUCMSysAdminAddress(value,application_name)

Example

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

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

Additional Commands

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

Table 19-4 WLST Additional Configuration Commands

Use this command... To... Use with WLST...

getUCMCSVersion

Display the version number.

Online

getUCMServerUptime

Display the uptime value.

Online


getUCMCSVersion

Use with WLST: Online

Description

Gets the version number of the Content Server running instance.

Syntax

getUCMCSVersion()

or

getUCMCSVersion(application_name)

Example

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

getUCMCSVersion('Content Server')
11g R1

getUCMServerUptime

Use with WLST: Online

Description

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

Syntax

getUCMServerUptime()

or

getUCMServerUptime(application_name)

Example

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

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