Oracle® Beehive Administrator's Reference Guide Release 1 (1.5) Part Number E14837-02 |
|
|
View PDF |
This module contains the following topics:
This section contains the following topics:
Table 4-1, "Component Management beectl Commands" lists beectl
commands you are likely to use when managing Oracle Beehive components.
Note:
For complete descriptions and syntax for thesebeectl
commands, see Chapter 2, "Oracle Beehive Command Line Utility".Table 4-1 Component Management beectl Commands
Command | Description |
---|---|
Lists the components in the configuration repository |
|
Lists available connection pools in the system |
|
Fetches the value of the given property name for the given component ID. If property name is not specified then all the properties are listed |
|
Lists all ports in use (by the current Oracle Beehive server), including which component and property is using the port, and the protocol in use by that port |
|
Changes the port through which a service communicates. You must specify the protocol. If your port change affects a privileged port, you must take the additional steps in "Modifying Oracle Beehive Ports using Privileged Port Numbers" when using this command |
|
Lists the metadata about all the properties of a component |
|
Updates the value(s) for the named property for the component identified by |
|
Updates the sensitive property of the object identified by the |
|
Lists collected statistical information about the functioning of a given type of component |
|
Clears the value of specified property in the configuration object identified by specified ID |
This section describes beectl
commands that are used for managing component parameters.
This section contains the following topics:
Many Oracle Beehive components have lists of associated properties which are not directly exposed in an beectl
command. Instead, you can set them by using the following common commands.
A subset of components are services. Each of the Oracle Beehive services has a system defined alias. The system defined alias is a unique name that you can use with most commands to identify a service for the purposes of configuration. All of the system defined aliases for Oracle Beehive services begin with an underscore character (_
). For example, the E-Mail Service has a system defined alias of _EmailService
.
In some cases, you may see a property which is itself used to contain properties (sub-properties). You can use the beectl list_properties
command with the alias of the service or the name of the component and the name of such a property, with a colon character between them, to list the sub-properties.
For example, the E-mail Service has a property called "SMTPProperties". You can list its properties by using the beectl list_properties
command:
beectl> list_properties --component _EmailService:SMTPProperties
You can review the names of all Oracle Beehive components by using the beectl list_components
command:
beectl> list_components
All of the Oracle Beehive components are listed.
For each service, prepend an underscore to the Component Type to get the service system alias. For example, the Component Type "EmailService" has a system alias of _EmailService
.
Notes:
The list_properties
command works on any Oracle Beehive system object. The --component
value is case-insensitive, and will take as valid any identifier of a system object, any system object alias, or any user-defined alias.
User-defined aliases are modifiable properties of any system object, with the property name of Alias
. Generally in Oracle Beehive documentation the system defined alias or component ID is used in examples, but you may always substitute a user defined alias in the --component
of a beectl
command
To set a property using beectl
, use the following procedure:
Use the beectl list_properties
command to get the list of all properties for the component you want to configure. Each property is listed by name, along with its current value:
beectl> list_properties --component _EmailService:SMTPProperties
In this example, the name of the E-Mail Service SMTP component is entered, with the E-mail Service system alias, to get properties for the SMTP Server component.
Use the beectl modify_property
or delete_property
commands to make the desired change to the property you specify:
beectl> modify_property --component _EmailService:SMTPProperties --name <property_name> --value <new value>
In this example, the value of an SMTP Server property is modified to a new value.
Caution:
If you are changing any port number to a privileged port (a port number below 1024) on a UNIX or Linux installation, you must first perform a special procedure, and then change the port. First follow the special procedure in "Modifying Oracle Beehive Ports using Privileged Port Numbers", and then follow the procedure below to change the port.Whenever you change a property in Oracle Beehive, you are making an alteration to the proposed configuration. You must activate a proposed configuration before changes you have made are actually applied to the running Oracle Beehive deployment. When you are done making configuration changes, activate the proposed configuration using the beectl activate_configuration
command:
beectl> activate_configuration
This command saves your proposed configuration, performs a background validation of the configuration, and then activates it.
Notes:
You can also append the --activate_configuration
option to any beectl
command, causing the system to perform these steps automatically on command completion
You can review information about various proposed and applied system configurations by using the beectl list_configuration_versions
command
If you modify any of the properties in Table 4-2, "Properties Requiring beectl modify_local_configuration_files when changed" , you must also run the beectl modify_local_configuration_files
command.
In the following cases, you must also restart a service, component, or the entire deployment, using the beectl restart
command:
Changing the database connection pool requires a full restart of Oracle Beehive (bug 6335906)
Changing the Instant Message Service's XmppPort
or XmppSslPort
properties requires that you restart the affected component
Changing the DeliveryPoolSize
parameter of the Message Delivery Service requires you to restart all affected Message Delivery Service instances
See also:
For a reference on using thebeectl
command-line interface, see Chapter 2, "Oracle Beehive Command Line Utility."Table 4-2 Properties Requiring beectl modify_local_configuration_files when changed
Component | Property |
---|---|
SsoType SsoLogoutUrl UseJazn WnaEnabled WnaKeytab WnaPrincipal OssoConfigFile AuthStoreType SsoType LoginAttempts LockoutTime UseSecureCookie WsSecuritySamlEnabled WsSecuritySigKeyAlias WsSecuritySigKeyPwd WsSecurityExpiry |
|
LogBaseDir WalletDir WalletPassword KeystoreFile KeyStoreFilePassword |
|
TaskAdministratorPassword |
|
ControlPort (CtrlPort) Status StartJavaExecutionArguments StopJavaExecutionArguments |
|
ConnectDescriptor XaServiceNames OnsNodeConfiguration |
|
UserName Password |
|
ConnectionProperties MaxConnections MinConnections InitialConnections MaxStatementsLimit ConnectTimeout InactivityTimeout TimeToLiveTimeout AbandonedConnectionTimeout PropertyCheckInterval ConnectionWaitTimeout LowerThresholdLimit |
|
HttpSslListenPort HttpListenPort OsUser OsGroup Timeout ServerAdmin MaxClients ServerRoot DocRootLimitExcept KeepAliveTimeout SSLLogLevel LogLevel Status |
|
HttpServerSslEnabled SslTerminatedByLoadBalancer |
|
LdapServerHostName LdapServerPort LdapServerSslPort SslEnabled LdapServerUser LdapServerPassword UserSearchBase GroupSearchBase UserObjectClass GroupObjectClass PrimaryAuthenticationAttribute DirectoryType |
|
AdminPassword Status AjpPortMaxValue AjpPortMinValue RmiPortMaxValue RmiPortMinValue RmisPortMaxValue RmisPortMinValue JmsPortMaxValue JmsPortMinValue JGroupPortMaxValue JgroupPortMinValue StartJavaExecutionArguments StopJavaExecutionArguments |
|
AjpsEnabled AdminPassword OrmisEnabled |
|
RequestPort RemotePort LocalPort |
|
NotificationServerSslEnabled Opmns |
|
PrimaryHostName SipListenerIPAddress |
|
SipPortMaxValue SipPortMinValue SipEnabled |
|
LanguagePack ClusteringEnabled SsoKeyAlias |
|
HttpPort HttpSslPort ServerName |
You may export the entire system model configuration data into an XML file for any given configuration version with the beectl export_configuration_data
command.
You may provide your Oracle support representative the output from this command. This will help your representative investigate any problems with your Oracle Beehive deployment faster. You may also use the output of from this command to compare the configuration between different Oracle Beehive deployments, such as between a test and a production deployment.
Note:
For security reasons, secure values do not appear in the output of thebeectl export_configuration_data
command.You have the option of configuring various Oracle Beehive components to use privileged ports (ports below 1024) on UNIX and Linux based deployments. For example, the standard port for the IMAP service is port 143.
Any time you modify a port, and the new port number is a privileged port, you must perform the following procedure. Perform this procedure first, and then make the port change. You must perform this procedure when you change from a non-privileged port to a privileged port, and when you change from one privileged port to another privileged port.
If you have previously performed this procedure, you can skip to step 4:
From the command line, navigate to the following file:
$ORACLE_HOME/beehive/bin/hasbind
Using the sudo
command, set the owner of the file to root, and modify the permsissions on the file:
sudo chown root hasbind sudo chmod a+sx hasbind
The file should have the following permissions (the file date and group will be different):
-rws--s--x 1 root g900 31395 Jun 18 14:01 hasbind
Then create a file /etc/cap.ora
. It must be owned by root and should be read-only for everybody except root:
-rw----r-- 1 root root 34 Jun 18 14:05 /etc/cap.ora
Edit the /etc/cap.ora
file, so that it contains a single line, like the following:
cat /etc/cap.ora +user <user>: bind port 25,143
Replace <user>
with the software owner (the user used to install Oracle Beehive). List each privileged port you will configure an Oracle Beehive service to use, separated by commas. If you are changing from one privileged port to another privileged port, you can delete the port number that will become unused, to release it.
You may now configure Oracle Beehive components to use the privileged ports you have designated in the cap.ora
file. Follow the procedure for changing ports as normal.
This module describes the properties for the following components:
Table 4-3 Components
The following properties are common to all components:
Table 4-4 Common Properties
The following properties are common to all ServiceInstances:
Table 4-5 Common Properties for ServiceInstances
This section lists the properties for each Oracle Beehive component. If a component has only common properties, the table of properties is omitted. Refer to "Common Properties", and "Common Properties for ServiceInstances", for details about common properties.
The tables listing properties for components have the following columns:
Name: The property name
Data Type: One of the following types:
Integer: A whole number
Int: A whole number
String: Alphanumeric characters
Boolean: True or false, used to enable or disable a feature
Long: A whole number (allows larger values than Int or Integer)
Structural Property: A special type, usually unique to the component, that can contain a string in a specified format
SecureString: Alphanumeric characters, stored as an encrypted value
File: A logical path to a file or directory
List: A comma-delimited list of text values
Map: A set of key:value pairs
Level: Used for setting log levels; accepts one of a listed set of keywords
<Component>.<Property> Legal Values (): A unique property which accepts one from a list of legal values. For example: AuthenticationService.AuthStoreType (Legal values: db, ldap)
CollabID: An Oracle Beehive CollabID
Default Value: If the property is seeded with a default value during installation of Oracle Beehive, that value is listed
Accepted Values: If the range or set of values is constrained (beyond that allowed by its type), the constraint is shown
Mutable: Mutable properties can change over time from one version of the configuration to the next. When Mutable is set to No, the value can only be changed when it belongs to a new configuration object created in the proposed configuration. Once the proposed configuration is activated, all immutable properties will never change again.
Read Only: You can only use the beectl modify_property
command to change the value of properties with Read Only set to No. You cannot use this command to modify properties with Read Only set to Yes.
Internal Oracle Beehive code can still modify Read Only properties.
Description: A brief description of the property's function
No other properties exist for AccessControlService .
The following properties are available for AlarmService :
Table 4-6 AlarmServiceProperties
The following properties are available for ApplicationImage :
Table 4-7 ApplicationImageProperties
The following properties are available for AuditService :
The following properties are available for AuthenticationService :
Table 4-9 AuthenticationServiceProperties
No other properties exist for BeeCentralService .
No other properties exist for BeehiveControlService .
The following properties are available for BeehiveInstance :
Table 4-10 BeehiveInstanceProperties
No other properties exist for BeehiveJ2eeApplication .
No other properties exist for BeekeeperService .
The following properties are available for BpelCluster :
Table 4-11 BpelClusterProperties
The following properties are available for BpelProcessManager :
The following properties are available for Bti :
Table 4-13 BtiProperties
The following properties are available for BtiClientWorker :
Table 4-14 BtiClientWorkerProperties
The following properties are available for BtiComponent :
The following properties are available for BtiGlobal :
Table 4-16 BtiGlobalProperties
The following properties are available for BtiRedirector :
The following properties are available for BtiServerWorker :
Table 4-18 BtiServerWorkerProperties
The following properties are available for CalDAVService :
Table 4-19 CalDAVServiceProperties
The following properties are available for ClientManagementService :
Table 4-20 ClientManagementServiceProperties
The following properties are available for CoexistenceService :
Table 4-21 CoexistenceServiceProperties
The following properties are available for CoexistenceService.ContactProperties :
Table 4-22 CoexistenceService.ContactPropertiesProperties
The following properties are available for CoexistenceService.ContainerSpecificProperties :
Table 4-23 CoexistenceService.ContainerSpecificPropertiesProperties
The following properties are available for CoexistenceService.ExchangeProperties :
Table 4-24 CoexistenceService.ExchangePropertiesProperties
The following properties are available for CoexistenceService.FreeBusyProperties :
Table 4-25 CoexistenceService.FreeBusyPropertiesProperties
The following properties are available for CoexistenceService.MeetingProperties :
Table 4-26 CoexistenceService.MeetingPropertiesProperties
The following properties are available for CoexistenceService.MessageProperties :
Table 4-27 CoexistenceService.MessagePropertiesProperties
The following properties are available for CoexistenceService.TaskProperties :
Table 4-28 CoexistenceService.TaskPropertiesProperties
The following properties are available for ConferenceService :
Table 4-29 ConferenceServiceProperties
No other properties exist for ConferenceSessionService .
The following properties are available for Database :
Table 4-30 DatabaseProperties
The following properties are available for Database.AccessSchema :
Table 4-31 Database.AccessSchemaProperties
The following properties are available for Database.ConnectionPool :
Table 4-32 Database.ConnectionPoolProperties
The following properties are available for DeviceManagementService :
Table 4-33 DeviceManagementServiceProperties
The following properties are available for DeviceManagementService.BlockedDevice :
Table 4-34 DeviceManagementService.BlockedDeviceProperties
The following properties are available for DiagnosabilitySettings :
Table 4-35 DiagnosabilitySettingsProperties
The following properties are available for DiagnosabilitySettings.ContextProperties :
Table 4-36 DiagnosabilitySettings.ContextPropertiesProperties
The following properties are available for DiagnosabilitySettings.ErrorCodeProperties :
Table 4-37 DiagnosabilitySettings.ErrorCodePropertiesProperties
No other properties exist for DiscussionsService .
The following properties are available for EmailService :
Table 4-38 EmailServiceProperties
The following properties are available for EmailService.CSIProperties :
Table 4-39 EmailService.CSIPropertiesProperties
The following properties are available for EmailService.EndpointProperties :
The following properties are available for EmailService.IMAPProperties :
Table 4-41 EmailService.IMAPPropertiesProperties
The following properties are available for EmailService.PersistenceProperties :
Table 4-42 EmailService.PersistencePropertiesProperties
The following properties are available for EmailService.SMTPProperties :
Table 4-43 EmailService.SMTPPropertiesProperties
The following properties are available for EmailService.SMTPProperties.VMSProperties :
Table 4-44 EmailService.SMTPProperties.VMSPropertiesProperties
The following properties are available for EmailService.TransportProperties :
Table 4-45 EmailService.TransportPropertiesProperties
The following properties are available for Enterprise :
Table 4-46 EnterpriseProperties
The following properties are available for EventService :
Table 4-47 EventServiceProperties
The following properties are available for ExternalBpelProcessManager :
Table 4-48 ExternalBpelProcessManagerProperties
The following properties are available for ExternalJ2eeApplication :
Table 4-49 ExternalJ2eeApplicationProperties
The following properties are available for FaxMessageService :
The following properties are available for FtpService :
Table 4-51 FtpServiceProperties
The following properties are available for HttpServer :
Table 4-52 HttpServerProperties
The following properties are available for HttpServerCluster :
Table 4-53 HttpServerClusterProperties
The following properties are available for IdMap :
Table 4-54 IdMapProperties
The following properties are available for IdentityProviderService :
Table 4-55 IdentityProviderServiceProperties
The following properties are available for ImService :
Table 4-56 ImServiceProperties
The following properties are available for JavaExecutionArguments :
Table 4-57 JavaExecutionArgumentsProperties
The following properties are available for JcrServletService :
Table 4-58 JcrServletServiceProperties
The following properties are available for LdapServer :
Table 4-59 LdapServerProperties
The following properties are available for LoggingConfigurable.LoggingProperties :
Table 4-60 LoggingConfigurable.LoggingPropertiesProperties
The following properties are available for ManagedBpelProcessManager :
The following properties are available for ManagedOc4j :
Table 4-62 ManagedOc4jProperties
The following properties are available for ManagedOc4jCluster :
Table 4-63 ManagedOc4jClusterProperties
The following properties are available for ManagementService :
Table 4-64 ManagementServiceProperties
The following properties are available for ManagementService.SystemDataCollectorProperties :
Table 4-65 ManagementService.SystemDataCollectorPropertiesProperties
The following properties are available for MobileDmService :
Table 4-66 MobileDmServiceProperties
The following properties are available for NamedSystemObject :
The following properties are available for NotificationDeliveryService :
Table 4-68 NotificationDeliveryServiceProperties
The following properties are available for NotificationDeliveryService.SmsSettings :
Table 4-69 NotificationDeliveryService.SmsSettingsProperties
The following properties are available for NotificationDeliveryService.WebProxySettings :
Table 4-70 NotificationDeliveryService.WebProxySettingsProperties
The following properties are available for NotificationDeliveryService.XmsSettings :
Table 4-71 NotificationDeliveryService.XmsSettingsProperties
No other properties exist for ObjectEventPublisherService .
The following properties are available for Oc4j :
Table 4-72 Oc4jProperties
The following properties are available for OmaService :
Table 4-73 OmaServiceProperties
The following properties are available for OmsResourceAdapter :
Table 4-74 OmsResourceAdapterProperties
The following properties are available for OmsResourceAdapterInstance :
The following properties are available for Opmn :
Table 4-76 OpmnProperties
The following properties are available for OpmnCluster :
Table 4-77 OpmnClusterProperties
The following properties are available for OwcStreamingService :
Table 4-78 OwcStreamingServiceProperties
No other properties exist for PlatformService .
No other properties exist for PlatformWebService .
No other properties exist for PolicyService .
The following properties are available for PresenceService :
Table 4-79 PresenceServiceProperties
The following properties are available for PushMailService :
Table 4-80 PushMailServiceProperties
The following properties are available for PushService :
Table 4-81 PushServiceProperties
The following properties are available for RecordsManagementService :
Table 4-82 RecordsManagementServiceProperties
The following properties are available for ResourceAdapter :
Table 4-83 ResourceAdapterProperties
The following properties are available for ResourceAdapterImage :
Table 4-84 ResourceAdapterImageProperties
The following properties are available for ResourceAdapterInstance :
The following properties are available for ResourceDirectoryService :
Table 4-86 ResourceDirectoryServiceProperties
The following properties are available for SAMLIdentity :
Table 4-87 SAMLIdentityProperties
The following properties are available for SearchService :
Table 4-88 SearchServiceProperties
The following properties are available for Server :
Table 4-89 ServerProperties
No other properties exist for Service .
The following properties are available for SesEndptService :
Table 4-90 SesEndptServiceProperties
The following properties are available for SipContainer :
Table 4-91 SipContainerProperties
The following properties are available for SipGateway :
Table 4-92 SipGatewayProperties
The following properties are available for SipGatewayCluster :
The following properties are available for Site :
Table 4-94 SiteProperties
The following properties are available for SmppDeliveryService :
Table 4-95 SmppDeliveryServiceProperties
No other properties exist for SubscriptionActionService .
The following properties are available for SubscriptionService :
Table 4-96 SubscriptionServiceProperties
The following properties are available for TCPCommBasedScanEngine :
Table 4-97 TCPCommBasedScanEngineProperties
The following properties are available for TCPCommBasedScanEngineCluster :
Table 4-98 TCPCommBasedScanEngineClusterProperties
The following properties are available for TimeManagementService :
Table 4-99 TimeManagementServiceProperties
No other properties exist for TimeManagementService.PurgedItemsCleanupProperties .
No other properties exist for TimeManagementService.ResourceCleanupProperties .
No other properties exist for TimeZoneService .
The following properties are available for TranscodingService :
The following properties are available for UnmanagedBeehiveInstance :
Table 4-101 UnmanagedBeehiveInstanceProperties
The following properties are available for UnmanagedOc4j :
Table 4-102 UnmanagedOc4jProperties
The following properties are available for Urm :
Table 4-103 UrmProperties
The following properties are available for UserDirectoryService :
Table 4-104 UserDirectoryServiceProperties
The following properties are available for UserDirectoryService.AttributeMap :
The following properties are available for UserDirectoryService.ConfigurationParameters :
Table 4-106 UserDirectoryService.ConfigurationParametersProperties
No other properties exist for UserDirectoryService.ConfigurationParameters.Attribute .
The following properties are available for UserDirectoryService.CustomAttribute :
Table 4-107 UserDirectoryService.CustomAttributeProperties
The following properties are available for UserDirectoryService.DirectoryAttributeMap :
Table 4-108 UserDirectoryService.DirectoryAttributeMapProperties
The following properties are available for UserDirectoryService.DirectoryProfile :
Table 4-109 UserDirectoryService.DirectoryProfileProperties
The following properties are available for UserDirectoryService.FieldMap :
Table 4-110 UserDirectoryService.FieldMapProperties
The following properties are available for UserDirectoryService.FieldMap.SourceTargetValueMapping :
Table 4-111 UserDirectoryService.FieldMap.SourceTargetValueMappingProperties
The following properties are available for UserDirectoryService.GroupTypeMapEntry :
Table 4-112 UserDirectoryService.GroupTypeMapEntryProperties
The following properties are available for UserDirectoryService.LdapDirectoryProfile :
Table 4-113 UserDirectoryService.LdapDirectoryProfileProperties
The following properties are available for UserDirectoryService.MembershipMapEntry :
Table 4-114 UserDirectoryService.MembershipMapEntryProperties
The following properties are available for UserDirectoryService.ScopeMapEntry :
Table 4-115 UserDirectoryService.ScopeMapEntryProperties
The following properties are available for UserDirectoryService.UserTypeMapEntry :
Table 4-116 UserDirectoryService.UserTypeMapEntryProperties
The following properties are available for VirtualServer :
Table 4-117 VirtualServerProperties
The following properties are available for VirusScanConfigurable :
Table 4-118 VirusScanConfigurableProperties
The following properties are available for VirusScanEngine :
Table 4-119 VirusScanEngineProperties
The following properties are available for VirusScanEngineCluster :
Table 4-120 VirusScanEngineClusterProperties
The following properties are available for VoiceMessageService :
Table 4-121 VoiceMessageServiceProperties
The following properties are available for VoiceMessageService.EnterpriseProperties :
Table 4-122 VoiceMessageService.EnterprisePropertiesProperties
The following properties are available for VoiceMessageService.FacilityProperties :
Table 4-123 VoiceMessageService.FacilityPropertiesProperties
No other properties exist for VoiceServletService .
The following properties are available for WebdavService :
Table 4-124 WebdavServiceProperties
The following properties are available for WikiService :
The following properties are available for WorkflowService :
The following properties are available for WorkspacesService :
Table 4-127 WorkspacesServiceProperties
The following properties are available for XmppService :
Table 4-128 XmppServiceProperties
No other properties exist for ZimbraConnectorService .
No other properties exist for ZimbraUIService .