| Oracle® Beehive Administrator's Reference Guide Release 2 (2.0.1.8) Part Number E16649-04 |
|
|
PDF · Mobi · ePub |
| Oracle® Beehive Administrator's Reference Guide Release 2 (2.0.1.8) Part Number E16649-04 |
|
|
PDF · Mobi · ePub |
This module contains instructions on the usage and syntax for all commands shipped with the Oracle Beehive beectl utility. The utility is installed in the $ORACLE_HOME/beehive/bin directory.
The Oracle Beehive beectl utility is always used in conjunction with a qualifying command. This module contains instructions about each command, and its available options. When running a beectl command, the following syntax should be used:
beectl command --option <argument>
Where command represents the beectl command, --option represents an available option(s) to use with the command, and <argument> represents a valid argument passed with an option.
Using beectl Commands in Shell Mode Without Authentication
The beectl commands can also be used in shell mode. To invoke the shell, run the beectl utility without any qualifying commands. The following shell prompt will be returned on the command-line:
beectl>
Once this prompt appears on the command-line, there is no need to specify beectl when using a command.
Note:
The beectl shell expires if inactive for more than 30 minutes.Using beectl Commands in Shell Mode with Authentication
Many beectl commands require authentication using the --authuser and --authpassword options. To invoke the beectl shell with authenticated user credentials, use the following command in the beectl shell mode:
beectl> login --authuser <authuser> --authpassword <authpassword> -obfuscated
Where <authuser> represents the user with which to authenticate, and <authpassword> represents the obfuscated user password. For information about obfuscating a password, see the obfuscate command.
Execution Permissions of beectl
The following applies only to Linux and UNIX-based operating systems.
Operating system users with the same primary membership as the owner of the Oracle Beehive application tier file system may call beectl commands. The following are the exceptions to this:
If the root user does not own the files of the Oracle Beehive application tier, root may not call any beectl commands.
Commands that change the structure of the Oracle Beehive application tier (such as adding or deleting OC4J instances, services, and service instances; cloning; and synchronizing system configuration information in the Oracle Beehive application tier's configuration files) and perform process control commands (such as starting and stopping components) cannot be called by any user other than the owner of the Oracle Beehive application tier file system.
The following tables list new and removed commands in the Oracle Beehive 2.0.1.x patch releases, compared to Oracle Beehive 2.0.
Table 2-1 New beectl Commands in Oracle Beehive 2.0.1.1
| Utility | Function |
|---|---|
|
Lists the workspaces to which the latest version of the given workspace template needs to be applied to make the workspaces conform to the latest version of the template. |
|
|
Lists the workspace templates that have been applied to this workspace. For each applied template it indicates whether this workspace is a template evolution target. |
Table 2-2 New beectl Commands in Oracle Beehive 2.0.1.3
| Utility | Function |
|---|---|
|
It validates midtier for various conditions. For example, it reports the issues of database connectivity with each individual rac node. |
|
|
Recover the search index for entities of the specified types, in the specified Scope, and which were last modified between the specified dates. |
|
|
Lists the Operation Statuses. |
|
|
Exports workspace contents into an external directory. |
|
|
Imports contents of an external directory into a new team workspace. |
Table 2-3 Removed beectl Commands in Oracle Beehive 2.0.1.3
| Utility | Function |
|---|---|
|
modify_search |
Create system model objects for Search and configure them. |
|
modify_search_engine |
Starts or stops the search crawl process for a specific source type. |
|
list_search_recovery_status |
Lists the status and reports on how many containers need to be recovered. |
|
add_search_recovery_container |
Adds/updates the recovery_id for the specified container. |
Table 2-4 New beectl Commands in Oracle Beehive 2.0.1.4
| Utility | Function |
|---|---|
|
Recover search failures. If scope is not specified, recover search failures from all scopes. |
The following tables list all the available beectl commands.
Table 2-6 Category: access control
| Utility | Function |
|---|---|
|
Creates an AssignedRole entity. |
|
|
Adds an Access Control Entry (ACE) to an entity's Local Access Control List (LACL). |
|
|
Creates a RoleDefinition entity. |
|
|
Creates a Sensitivity entity. |
|
|
Adds an Access Control Entry (ACE) to a Sensitivity entity's Sensitivity ACL (SACL). |
|
|
Deletes an AssignedRole entity. |
|
|
Deletes an Access Control Entry (ACE) from the Local Access Control List (LACL) of an entity. |
|
|
Deletes a RoleDefinition entity. |
|
|
Deletes a Sensitivity entity. |
|
|
Deletes an Access Control Entry (ACE) from the Sensitivity Access Control List (SACL) of a Sensitivity entity. |
|
|
Lists the AccessControlFields of an entity. |
|
|
Lists available access type names and identifiers. |
|
|
Lists AssignedRole entities. |
|
|
Lists the Local Access Control List (LACL) of an entity. |
|
|
Lists available Privilege names. |
|
|
Lists RoleDefinition entities. |
|
|
Lists Sensitivity entities. |
|
|
Lists the Sensitivity Access Control List (SACL) of a Sensitivity. |
|
|
Modifies the AccessControlFields of an existing entity. |
|
|
Modifies an existing AssignedRole entity. |
|
|
Replaces an Access Control Entry (ACE) in the Local Access Control List (LACL) of an entity. |
|
|
Modifies an existing RoleDefinition entity. |
|
|
Modifies an existing Sensitivity entity. |
|
|
Replaces an Access Control Entry (ACE) in the Sensitivity Access Control List (SACL) of a Sensitivity entity. |
| Utility | Function |
|---|---|
|
Creates an audit policy from the XML file information |
|
|
Creates an audit trail from the search result generated using the XML file |
|
|
Deletes an existing audit |
|
|
Deletes an existing audit trail |
|
|
Exports an existing audit trail by the given identifier |
|
|
Lists audit policies and prints policy information |
|
|
Lists audit trails and prints trail information |
|
|
Modifies an existing audit policy |
|
|
Modifies an existing audit trail |
Table 2-8 Category: client application
| Utility | Function |
|---|---|
|
Adds an auto attendant or copies an existing one under a new name. When copying any prompts will also be copied. |
|
|
Creates a client application configuration object from a supplied input file. The resulting object will be used for client application provisioning. |
|
|
Provisions client applications to a community. |
|
|
Creates a voice facility by associating phone rules with an already created group. The command may be run multiple times and each new execution will append new rules to existing rules for a given group collabid. |
|
|
Deletes an auto attendant by name. |
|
|
Deletes a prompt. |
|
|
Deletes a client application. |
|
|
Deletes the client application configuration with the given identifier. |
|
|
Deletes a client application patchset. |
|
|
De-provisions client applications from a community. |
|
|
Deletes a client application version. |
|
|
Removes specific rules or all rules for a given group collabid. To remove specific rules, then the list the rules to remove in the parameter options. To remove all rules only specify the collabid |
|
|
Exports a client application configuration to a local file. |
|
|
Prints the Auto Attendant Markup Language for an auto attendant. |
|
|
Lists all prompts that have been uploaded for an attendant. |
|
|
Lists all attendants in the system. |
|
|
Lists the client application configurations. |
|
|
Lists the modules for a given client application patchset. |
|
|
Lists the patchsets for a given client application version. |
|
|
Lists all the versions for a given client application. |
|
|
Lists all the client applications. |
|
|
Lists the client applications usage report. The command displays the number of devices that have installed a client application. |
|
|
The list command shows all of the facilities, their collab ids and phone number matching rules. The command accepts three optional parameters to help refine the search, if no parameters are specified, then all facilities are presented. |
|
|
Update an existing attendant with a new markup file or rename it. |
|
|
Upload a prompt to the database. |
|
|
Uploads client application binaries to the repository. Either a binary file path or path to a directory containing binary files should be specified. |
| Utility | Function |
|---|---|
|
Top level clone command that clones a mid-tier. |
|
|
Creates a new oc4j instance by cloning the given oc4j instance. |
|
|
Upgrades the midtier by cloning. |
|
|
Prepares the existing oracle home for cloning. |
|
|
Top level clone command that clones a mid-tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details. |
|
|
Lists the set of system model properties required for ias cloning scripts. |
Table 2-10 Category: coexistence
| Utility | Function |
|---|---|
|
Creates a new coexisting remote system. |
|
|
Deletes the coexistence profile of user. |
|
|
Deletes a coexisting remote system. WARNING: This command will purge the coexisting remote system and clean all related data. |
|
|
Import data from the coexisting remote system for a given user. |
|
|
Lists all coexistence connectors for a coexisting remote system. |
|
|
Lists the profile of coexisting users. |
|
|
Reports the status of the coexisting containers and coexistence profiles. |
|
|
Lists all coexisting remote systems. |
|
|
Create or modify the coexistence profile of a user. |
|
|
Modifies a coexisting remote system. |
Table 2-11 Category: configuration
| Utility | Function |
|---|---|
|
Saves proposed configuration and activate it. |
|
|
Creates a blocked device. The system object identifier of the resulting object needs to be added to the 'DeviceManagementService' system object, using modify_property command, to block this device from accessing Beehive Mobile Services. |
|
|
Creates a new coexisting remote system. |
|
|
Creates configuration for a Beehive installation in the DMZ that is, outside the firewall. |
|
|
Recovers the search index for Entities of the specified types, in the specified Scope, and which were last modified between the specified dates. |
|
|
Configures an agent for a URM instance. |
|
|
Adds a new virus scan engine to the collection of engines configured for the Site. If this is the first scan engine being added, this command will create a new collection for the Site and add the virus scan engine to it. |
|
|
Appends the specified value to the existing value of the named property. If the named property value is cleared before executing this command, then after executing this command it will contain the new value. |
|
|
Clears proposed configuration of the Beehive system object model |
|
|
Top level clone command that clones a mid-tier. |
|
|
Creates a new oc4j instance by cloning the given oc4j instance. |
|
|
Upgrades the midtier by cloning. |
|
|
Prepares the existing oracle home for cloning. |
|
|
Top level clone command that clones a mid-tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details. |
|
|
Deletes a coexisting remote system. WARNING: This command will purge the coexisting remote system and clean all related data. |
|
|
Removes configuration for a Beehive installation in the DMZ that is, outside the firewall. |
|
|
Deletes the specified oc4j. |
|
|
Clears the value of specified property in the configuration object identified by specified id. |
|
|
Deletes the specified beehive home from central configuration repository. |
|
|
Deletes specified virus scan engine from the collection of engines configured for the Site. If this is the last scan engine being deleted, this command will also delete the virus scan engine collection and update the Site to remove the virus scan engine collection from it. Either the scan_engine option or the hostname and port options will need to be specified. |
|
|
Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options. |
|
|
Exports configuration data for given configuration version. |
|
|
Displays bootstrap configuration for local midtier. |
|
|
Lists the set of system model properties required for ias cloning scripts. |
|
|
Lists components in the configuration repository. |
|
|
Lists all available configuration versions and activation time information |
|
|
Lists available connection pools in the system. |
|
|
Lists the available deployment templates in central configuration repository |
|
|
Displays summarized informations for the resources in language pack. The search criteria can include a combination of string contained in the resource name, locale of the resource, type of resource (built-in or custom). Note that only resources matching ALL (as compared to ANY) specified search criteria are displayed. |
|
|
Lists the patch information for given archives. |
|
|
Lists various available ports. |
|
|
Prints property value of a component given a component identifier and property name. If property name is not specified then all the properties will be listed. |
|
|
Lists the metadata about all the properties of a system model object. |
|
|
Lists the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR. |
|
|
Modifies a coexisting remote system. |
|
|
Modifies the connection pool configuration. |
|
|
Modifies given database configuration. |
|
|
This command applies the specified template(s) to the local BeehiveInstance. Execute beectl list_deployment_templates command to view the available templates. |
|
|
Modifies the configuration repository for hostname of the system and updates required configuration files. |
|
|
This command updates configuration files local to current midtier with activated changes to centralized configuration. It can restart one or more components on current midtier if needed to make the changes take effect. Some updates to local configuration files require this command to restart all midtier components. |
|
|
Modifies oc4j administrator password in central configuration. |
|
|
Add, append or removes the patch information from the given archives. |
|
|
Modifies various ports. |
|
|
Modifies the value(s) of a named property of the component identified by --component. Multiple values can be set for one property. |
|
|
This command updates the sensitive property of the system model object identified by the --component. |
|
|
update urm urls |
|
|
Modifies the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR. |
|
|
Recover search failures. If scope is not specified, Recover search failures from all scopes. |
|
|
Loads language pack resources into the system. |
|
|
Validates the configuration for given component id or for the whole system model tree. |
|
|
It validates midtier for various conditions. For example, it reports the issues of database connectivity with each individual rac node. |
|
|
Validates the given site key. |
|
|
Tests the connectivity to the virus scan engine running at the specified host and port. |
| Utility | Function |
|---|---|
|
Creates a reference in Beehive to a directory on the filesystem. |
|
|
Adds a remote repository. |
|
|
Adds a remote repository share. |
|
|
Removes a filesystem reference from Beehive. |
|
|
Deletes a remote repository. |
|
|
Deletes a remote share. |
|
|
Imports documents into Beehive from files on the server without copying the file content. Data on the server files will be treated as read-only; should an imported document be edited in Beehive, a copy of the content will be made at that time. |
|
|
Lists the filesystem path, read-only status, and identifier of all available filesystem references. |
|
|
Lists remote repositories. |
|
|
Lists seeded remote repository definitions. |
|
|
Lists remote shares. |
|
|
Modifies the name and/or the description of a Remote Repository. |
|
|
Modifies the name and/or the description of a Remote Share. |
| Utility | Function |
|---|---|
|
Creates a blocked device. The system object identifier of the resulting object needs to be added to the 'DeviceManagementService' system object, using modify_property command, to block this device from accessing Beehive Mobile Services. |
|
|
Creates a device command for a given device. |
|
|
Deletes the device with the given identifier. |
|
|
Deletes the device profile or device profiles. The command can delete the device profile with the given identifier or with the given device profile name or delete the device profiles specified from the given file containing names of the device profiles. The command can also optionally delete all the device types associated with this device profile. |
|
|
Deletes the device type with the given identifier. |
|
|
Downloads the logs for a device. This command can either download all log files for a device or all log files for a given application on the device or a particular log file. |
|
|
Downloads SyncML messages. |
|
|
Downloads SyncML messages. |
|
|
Lists the client applications usage report. The command displays the number of devices that have installed a client application. |
|
|
Lists the device commands for a given device. The list can be further filtered by specifying the status of the device command. |
|
|
Lists the device logs for a given device. |
|
|
Lists all the device profiles. |
|
|
Lists all the device types. |
|
|
Lists the devices either belonging to a user or with the specified device status. |
|
|
Modifies the device with the given identifier. |
|
|
Uploads the provider file for Apple Push Notification Service. |
|
|
Uploads device profiles to the repository. An XML file or a directory containing XML files can be used as the source for the device profiles. The file can also contain device types and device profile schema. |
Table 2-14 Category: expertise
| Utility | Function |
|---|---|
|
The add_expertise_user_scope command adds new expertise user scope. The expertise user scope information is supplied in a XML file. |
|
|
The delete_expertise_user_scope command deletes expertise user scope. The expertise user scope CollabId/BODN is supplied with --expertise_user_scope option. |
|
|
Displays the status of all expertise background jobs. |
|
|
The list_expertise_profiling_configuration command lists the profiling configuration. |
|
|
The list_expertise_profiling_enabled_entities command lists all the entities for whom expertise profiling is enabled. |
|
|
The list_expertise_profiling_status command lists the expertise profiling status of the user specified. The profiling status information comprises Enability, Bootstrap, Searchability statuses. |
|
|
The list_expertise_relationship_blacklist_emails command lists all the email addresses that have been blacklisted for expertise relationship profiling. |
|
|
Lists the stop phrases for expertise service. |
|
|
The list_expertise_user_scopes command lists all expertise user scope or detailed version of supplied expertise user scope CollabId/BODN with --expertise_user_scope option. |
|
|
Modifies the expertise background jobs. |
|
|
The modify_expertise_entity_searchability command controls whether the specified entity will be searchable or not. |
|
|
The modify_expertise_profiling_configuration command modifies the expertise profiling configuration. The profiling configuration information is supplied in an XML file. |
|
|
The modify_expertise_stop_phrases command modifies (add/remove) stop phrases for Expertise service. The phrases are supplied in a XML file |
|
|
The modify_expertise_user_scope command modifies expertise user scope. The expertise user scope information is supplied in a XML file. |
Table 2-15 Category: language packs
| Utility | Function |
|---|---|
|
Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options. |
|
|
Displays summarized informations for the resources in language pack. The search criteria can include a combination of string contained in the resource name, locale of the resource, type of resource (built-in or custom). Note that only resources matching ALL (as compared to ANY) specified search criteria are displayed. |
|
|
Loads language pack resources into the system. |
Table 2-16 Category: messaging
| Utility | Function |
|---|---|
|
Add an email endpoint |
|
|
Moves an email message to a target folder or removes it outright |
|
|
This command is used to delete an xmpp chat room by name (if it exists, else it is a NOOP) specified by the --roomname option. Room-names are case insensitive. This command can also be used to delete those xmpp chat rooms which have not been accessed for a period of days specified by the --olderthan option. |
|
|
Export all email data to a file |
|
|
Import email data from a file created by export command into a given folder |
|
|
List the email messages in a transport queue |
|
|
List the email transport queues information |
|
|
Used to list all currently existing XMPP chat rooms. |
|
|
Modifies Email service' SMTP or IMAP port number |
|
|
Enables or disables Email asynchronous queue processing |
|
|
Modifies existing instant message preferences of a user. |
|
|
Sends Instant Message to all online users. |
Table 2-17 Category: organizations
| Utility | Function |
|---|---|
|
Creates an organization in the given scope |
|
|
Deletes an existing organization, and sub-organizations and workspaces under it (with --force_cascade option). And/or purges deleted organization manually (with --purge option). Use list_deleted_organizations to get the CENs of deleted organizations. |
|
|
Lists deleted organizations |
|
|
Lists all enterprises and prints names and identifiers |
|
|
Lists organizations in the given scope |
|
|
Modifies an existing enterprise |
|
|
Modifies an existing organization |
| Utility | Function |
|---|---|
|
Creates an event subscription using data in an XML file. |
|
|
Creates a policy using data in an XML file. |
|
|
Creates a policy schema using data in an XML file. |
|
|
Creates a policy template using data in an XML file. |
|
|
Deletes an event subscription from the Oracle Beehive repository. |
|
|
Purge actions that have not completed successfully. |
|
|
Deletes a policy. |
|
|
Deletes a policy action. |
|
|
Deletes a policy schema. |
|
|
Deletes a policy template. |
|
|
Exports policy data into an XML file. |
|
|
Lists all business object events. |
|
|
Lists all business object events. |
|
|
List actions that have not completed successfully. |
|
|
Lists policies in an specific container. Details returned include policy names and identifiers. |
|
|
Lists all policy actions. |
|
|
Lists policy schemas in the current enterprise. Details returned include policy schema names and identifiers. |
|
|
Lists policy templates in a specified container. Details returned include policy template names and identifiers. |
|
|
Retry actions that have not completed successfully. |
|
|
Modifies an existing policy using data in an XML file. |
|
|
Modifies an existing policy schema using data in an XML file. |
|
|
Modifies an existing policy template using data in an XML file. |
|
|
Evaluates or executes a policy based on an event payload file. |
Table 2-19 Category: process control
| Utility | Function |
|---|---|
|
Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components. |
|
|
Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components. |
|
|
Displays the status of all managed components. |
|
|
Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components. |
Table 2-20 Category: real time
| Utility | Function |
|---|---|
|
Creates conference artifact under workspace |
|
|
Creates conference-template artifact under workspace |
|
|
Deletes conference artifact under workspace |
|
|
Deletes conference template artifact under workspace |
|
|
Lists conference-template artifacts under workspace |
|
|
Lists conference artifacts under workspace |
|
|
Lists conference artifacts under workspace |
| Utility | Function |
|---|---|
|
Adds a record or non-record. |
|
|
Deletes a record or non-record. |
|
|
Lists the file plan. |
Table 2-22 Category: resources
| Utility | Function |
|---|---|
|
Creates a new resource. |
|
|
Deletes a resource. |
|
|
Lists resources. |
|
|
This command set the given category as resource root classification. |
|
|
Modifies an existing resource. |
| Utility | Function |
|---|---|
|
This command registers a trusted identity. There are two types of trusted identities: WSSEC and SES. Default type is WSSEC. For WSSEC type, please make sure that the service has a valid certificate registered in the wallet and the correct associated key alias is passed into this command. This command also creates the principal(s) associated with this trusted identity in the Beehive system. On the other hand, for SES type, this command stores the given trusted identity name and password information. |
|
|
This command unregisters a trusted identity. If the type of identity is not specified, it is defaulted to WSSEC. |
|
|
This command lists the trusted identities. The type has to be specified. For type SES, it lists the names of the trusted entities. |
|
|
This command modifies the details of the trusted identity. At least one of the options new_service_name or new_key_alias need to be specified for this modification if the type is WSSEC. If the type of identity is not specified, it is defaulted to WSSEC. |
Table 2-24 Category: subscription
| Utility | Function |
|---|---|
|
Creates a user subscription from a pre-defined rule in a subscription template. |
|
|
List user subscriptions |
|
|
Enables or disables an existing subscription |
Table 2-25 Category: templates
| Utility | Function |
|---|---|
|
Modifies a specified notification template for the Notification service. |
Table 2-26 Category: timemanagement
| Utility | Function |
|---|---|
|
Add a remote iSchedule Server configuration. |
|
|
Modify access permissions for grantee (user or group) on the specified calendar. |
|
|
Reset the access permissions of a tasklist to their out-of-box defaults. |
|
|
Delete a remote iSchedule Server configuration. |
|
|
Export invitations and assignments from a calendar and/or tasklist to an iCalendar file. |
|
|
Import an iCalendar file to an existing calendar and/or tasklist. If an iCalendarObject has a UID that already exists in the destination calendar and/or tasklist it will be re-created. VCALENDAR components can have many VEVENT and VTODO sub-components with different UIDs but sub-components of the same UID must be consecutive. A VCALENDAR component imported with a METHOD:X-ORACLE-DELETE or METHOD:CANCEL will cause all sub-components to be deleted. |
|
|
List the directly enrolled and directly unenrolled members of the specified team workspace calendar. |
|
|
List the access control permissions of a user, resource or workspace's calendar. When multiple calendars match the selection criteria for the user, resource or workspace, the default calendar will be used. |
|
|
Lists the existing calendars of a user, resource or workspace. |
|
|
List remote iSchedule Server configurations. |
|
|
List the access control permissions of a user, resource or workspace's tasklist. When multiple tasklists match the selection criteria for the user, resource or workspace, the default tasklist will be used. |
|
|
Lists existing tasklists of a user, resource or workspace. |
|
|
Modify various attributes of the selected calendar. |
|
|
Modify the enrollment list of the specified team workspace calendar. |
|
|
Modify access permissions for grantee (user or group) on the specified calendar. |
|
|
Modify a remote iSchedule Server configuration. |
|
|
Modify various attributes of the selected tasklist. |
|
|
Modify access permissions for grantee (user or group) on the specified tasklist. |
Table 2-27 Category: timezones
| Utility | Function |
|---|---|
|
Imports time zone definitions to the database. |
|
|
Lists time zones in the database. |
|
|
Modify a time zone. |
| Utility | Function |
|---|---|
|
The add_custom_user_property command adds custom user properties. |
|
|
The add_directory_profile command adds a new directory profile. |
|
|
The add_external_contact command adds new external contact. |
|
|
The add_feed_configuration command adds new feed configurations. |
|
|
The add_group command adds new groups. The group information is supplied in an XML file. |
|
|
The add_preference_profile command adds a new preference profile and associates it with a consumer. There can be only one preference profile for a consumer. |
|
|
The add_preference_property command adds a new preference property to a preference set. |
|
|
The add_preference_set command adds a preference set to a preference profile. |
|
|
The add_user command adds new users. The user information is supplied either on command line or in an XML file. |
|
|
Deletes the coexistence profile of user. |
|
|
The delete_custom_user_property command deletes a custom property. If there are multiple custom properties with same name, then only the first occurrence of the attribute with specified name is deleted. Any values of the property being deleted will also be deleted. |
|
|
The delete_directory_profile command deletes a directory profile. |
|
|
The delete_feed_configuration command deletes feed configuration. |
|
|
The delete_group command deletes a group with an option to purge. |
|
|
The delete_preference_profile command deletes a preference profile. |
|
|
The delete_preference_property command deletes a preference property from a preference set. |
|
|
The delete_preference_set command deletes a preference set. |
|
|
The delete_user command deletes a user with an option to purge. |
|
|
The download_ldap_group_data command downloads groups information for an external directory into an XML file. The generated XML file can be used with add_group command to create the groups. |
|
|
The download_ldap_user_data command downloads user information for an external directory into an XML file. The generated XML file can be used with add_users command to create the users. |
|
|
Lists the profile of coexisting users. |
|
|
The list_custom_user_properties command lists all custom properties of users. |
|
|
The list_directory_profiles command lists directory profiles in an XML file. |
|
|
The list_external_contacts command lists contacts that match specified search criteria. If search criteria are not specified, then all contacts are listed. It also lists the details of the contact(s) whose identifier is specified. |
|
|
The list_feed_configurations command lists the feed configurations in the given scope. |
|
|
The list_groups command lists groups that match specified search criteria. If search criteria are not specified, then all groups are listed. |
|
|
Lists the last change-log number processed by beehive for specified profile. |
|
|
The list_max_address_count command lists the maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL and OTHER. This command also lists the system defined maximum limit, which cannot be exceeded. |
|
|
The list_preference_profiles command lists preference profiles for a consumer. |
|
|
The list_preference_properties command lists all effective preference properties of a preference set. |
|
|
The list_preference_sets command lists all preference sets for a preference profile. |
|
|
The list_users command lists users that match specified search criteria. If search criteria are not specified, then all users are listed. |
|
|
Create or modify the coexistence profile of a user. |
|
|
Modifies the directory entry and locator for a given directory entry. This command can be used to convert a directory user to an external directory user and vice versa. |
|
|
The modify_directory_profile command modifies an existing directory profile. Modification to the profile name cannot be done. |
|
|
The modify_external_contact command modifies existing external contact. |
|
|
The modify_feed_configuration command modifies existing feed configurations. |
|
|
The modify_group command modifies a group. The group information is supplied in an XML file. |
|
|
Modifies the changelog number of a profile. |
|
|
The modify_max_address_count command modifies maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL & OTHER. The maximum count specified in this command must be less than the system defined maximum limit, which can be determined by running list_max_address_count command. |
|
|
The modify_preference_set command modifies the preference set by setting the extends from attribute. |
|
|
The modify_user command modifies exisiting users. |
|
|
e> <s the directory entry in ldap with corresponding entry in beehive. The directory entry can be of type user, group or external person. The command provides an option to correct any data inconsistencies by applying necessary changes in beehive. The state of the profile specified in this command can either be ENABLE or DISABLE. |
Table 2-29 Category: utilities
| Utility | Function |
|---|---|
|
Deletes virus scan results from the system that match the specified criteria. Option scandate cannot be specified with options scandate_from or scandate_to. |
|
|
Search for occurrences of error codes |
|
|
Search log files stored on host machines. |
|
|
With an option of refreshing the repository first, query the repository to get relevant log records from log files stored on host machines. |
|
|
Lists all probe information in beehive. |
|
|
Lists all the metadata about given command. |
|
|
Lists the command names based on the given criteria. |
|
|
List all error code definitions in beehive. |
|
|
List the Operation Statuses |
|
|
Search the ocs_clone_registry table based on the specified options and display the matched clone records. |
|
|
Search the ocs_schema_registry table based on the specified options and display the matched schema records. |
|
|
Lists the statistics for a given type or component or for the entire site. |
|
|
Prints the supported entity types which can be used in business object distinguished naming pattern instead of system generated identifier and their description. |
|
|
Lists the virus scan results that match the specified criteria. Only a count of the matches found will be displayed if the option to list only the counts is specified. Option count_only cannot be specified with options maximum_results or display_columns. Option scandate cannot be specified with options scandate_from or scandate_to. |
|
|
Obfuscates the prompted string. |
|
|
This command shows the version information of the Beehive products. |
Table 2-30 Category: workspace
| Utility | Function |
|---|---|
|
Creates a category at the enterprise scope |
|
|
Applies a category on a given entity |
|
|
Creates a category configuration on the given scope or heterogenous folder. |
|
|
Creates a team workspace from a template |
|
|
Transforms the given team workspace to conform to the given team workspace template |
|
|
Applies the latest snapshot of the given team workspace template to all the team workspaces to which the template was applied earlier |
|
|
Creates a version configuration on the given scope or heterogenous folder. |
|
|
Deletes a category and all category applications. |
|
|
Removes a category from an entity |
|
|
Deletes a given category configuration. |
|
|
Deletes a given version configuration. |
|
|
Generates a team workspace template from the given team workspace |
|
|
Downloads workspace template XML schema to a file |
|
|
Exports workspace contents into an external directory. |
|
|
Imports contents of an external directory into a new team workspace. |
|
|
Lists the workspace templates that have been applied to this workspace. For each applied template it indicates whether this workspace is a template evolution target. |
|
|
Lists the categories in the enterprise.If the recurse option is used then sub-categories are also listed. |
|
|
Prints information about a category given a category identifier |
|
|
List all the categories (and associated attributes) applied to a specific entity. Lists the application of a specific category to the entity if the [category] parameter is provided. |
|
|
Lists the category configuration on the given scope or heterogenous folder. |
|
|
Lists deleted workspaces |
|
|
Lists the workspaces to which the latest version of the given workspace template needs to be applied to make the workspaces conform to the latest version of the template |
|
|
Lists the version configuration on the given scope or heterogenous folder. |
|
|
Lists all workspace templates |
|
|
Lists workspaces in an organization or enterprise |
|
|
Modifies an existing category |
|
|
Updates a given category configuration. |
|
|
Modifies an existing personal workspace |
|
|
Modifies an existing team workspace |
|
|
Updates a given version configuration. |
|
|
Modifies an existing workspace template |
The beectl command options can be broken down into two types: common options, and command specific options. This section describes common options that can be used with any beectl command.
The following is a complete list of common options for all beectl commands:
Specify the output format type. Valid options are multiline, xml, table, and tiled. The default format is multiline.
Specify the separator to use when formatting an output type of tiled with the --format option. Any character may be used as a separator. The default separator is "|".
Specify display format of the entity. Valid entity format options are name, id, and name_and_id. Default format is name.
Specify the time zone to use if any date and time information is returned by the command. To determine a time zone ID, use the list_timezones command.
Allow the command to be executed without prompting for any confirmation. This option applies only to remove and delete commands.
Print the version information of a beectl command. This option does not require an argument.
Print a usage message.
Specify the logging level. Valid arguments for this option are: FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, ERROR, INTERNAL_ERROR, NOTIFICATION, and TRACE. If no log level is specified, the default, INFO, will be used. This option cannot be used while in shell mode or batch mode. Specify the option when invoking either mode.
Specify the full path to the log directory. The default value is ORACLE_HOME/beehive/logs/beectl/. This option cannot be used while in shell mode or batch mode. Specify the option when invoking either mode.
Specify the full path and file name of a batch file. Commands and options can be specified in a file and passed with this option for batch processing.
Force Oracle Beehive to continue with the next command when using the --batchfile option. The next command will be executed regardless of the exit code of the previous command.
Commands that deal with updating the system object model make use of this option to determine if they need to save their modification to the configuration system.
If specified, the cell values in the tabular format output of a command will not be wrapped.
If specified, the columns of the tabular format output of a command will not be staggered.
Specify customized column format string. For example, 10%10%20%. This option is applicable only to commands that have tabular output. If not specified or an incorrect value is specified, it will be ignored, and the maximum content length for each column will be used to set column width.
Modify the default terminal width. By default, the terminal width is 80 characters.
Specify this option when all passwords passed with the command are obfuscated.
Specify the user name for beectl commands requiring authentication.
Specify the user password for the user specified with the --authuser option. The argument for this option must be obfuscated using the --obfuscated if passed on the command line.
Note:
Option arguments should not start with a hyphen (
-). If an option argument needs to start with hyphen, use one of the following options:
Use the <option name> = <option value> format; this is the preferred way to specify option values starting with hyphens.
Prefix the option value with string ESCAPE:.
Prefix the option value with an escaped backslash (\\). This is the least preferred way. This may not work in some operating systems; it does not work in Microsoft Windows.
Option values should not contain the any special characters (such as *, $, and %). If an option value contains a special character, then enclose the option value in double quotes (").
System model objects in the system model can be uniquely identified with the following mechanisms:
A unique identifier assigned to each system model object at the time of creation. The system object identifier is read-only and it cannot be changed. For example, 8ae5c0e8-02c8-429e-9773-186e6a79997b.
A unique, built-in alias is assigned to certain system model objects at the time of creation. Built-in alias names are read-only and it cannot be changed. For example, _CURRENT_SITE refers to the current site system model object and _CURRENT_ENTERPRISE refers to the current enterprise system model object.
You can assign a unique user defined name to each system model object. Oracle Beehive ensures that all user defined aliases are unique. The user defined alias are mutable and can be modified at any point of time. For example, oracle_smtp_service can refer to an SMTP service system model object.
Encoded System Object Identifier
To refer to a system model objects that lies deep in the system model hierarchy, use the following syntax:
<unique ID>[:<property name>][:<property name>][:<property name>]
<unique ID> is a system object identifier, built-in alias, or user defined alias of a system model object, and <property name> is a valid property name of the preceding model object. The type of property should be a system model object.
For example, the following command list the properties of the logging properties of the database of the current site:
beectl list_properties --component _CURRENT_SITE:Database:LoggingProperties
The following are the available methods to provide secure values, such as passwords, to a command:
Only provide the option (without providing the secure value). The beectl tool will prompt you for the secure value. Some commands may ask you to reconfirm the secure value.
Obfuscate the secure value with the obfuscate command. Use the obfuscated value for the option that requires the secured value along with the common option --obfuscated.
To provide secure values in clear text, run commands in beectl shell mode.
The following options allow you to control the display of tabular output:
Specify that content wrapping will not be applied to cell values.
Specify that columns will not be staggered. By default, columns will not be staggered if there are three or less columns.
Specify the column widths (in chars) for each column. This value will be ignored if number of columns given in this option do not match the number of columns in the resultant table. The following is an example of this option:
beectl list_property_metadata --type ManagementService --full_report --column_format 10%10%10%10%10% -----------+------------+------------+------------+----------------------------- Property n | Property T | Metadata | Short desc | Long descr ame | ype | | ription | iption -----------+------------+------------+------------+----------------------------- AutoSyncSa | int | Not ReadOn | [Short des | [Long desc veListener | | ly-Mutable | cription k | ription ke SleepInter | | -Mandatory | ey not set | y not set. valInSecon | | | .] | ] ds | | | | -----------+------------+------------+------------+----------------------------- ...
You may not specify this option with --no_stagger or --no_wrap.
Specify the terminal width of the terminal in which you are running the beectl tool. Specify this option if you have resized your terminal to more than 80 character widths and you want the command output to fit the entire width of your terminal. The Default (minimum) value for terminal width is 80.
If an option requires a boolean value (either true or false), and you specify the option without specifying a value, the command assumes a value of true for the option.
Saves proposed configuration and activate it.
beectl activate_configuration
This command has no options
beectl activate_configuration
Creates an AssignedRole entity.
beectl add_assigned_role [--scope <unique identifier of the Scope>] --name <name of AssignedRole> [--description <description>] --assigned_scope <assigned_unique identifier of the Scope> --role_definition <unique identifier of the RoleDefinition> [[--accessor <unique identifier of an Accessor>]...]
Specify the unique identifier of the Scope in which the AssignedRole should be created.
Specify the name of the AssignedRole.
Specify a description for the AssignedRole.
Specify the unique identifier of an assigned Scope for the AssignedRole.
Specify the unique identifier of an assigned RoleDefinition for the AssignedRole.
Specify the unique identifier of an Accessor to add to the AssignedRole. This option can be specified more than once.
beectl add_assigned_role --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole --assigned_scope wksp=MyWorkspace,enpr=MyEnterprise --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise
Adds an auto attendant or copies an existing one under a new name. When copying any prompts will also be copied.
beectl add_attendant { --file <AAML file> | --name <new name> --copy_from <existing attendant> }
An auto-attendant markup language file describing the attendant to be added. When specified, name and copy_from must be specified.
Name to be given to copied attendant. When specified, copy_from must also be specified and file must not be specified
Name of attedant to copy. When specified, copy_from must also be specified and file must not be specified
beectl add_attendant --file example.aaml
beectl add_attendant --name copiedAttendant --copy_from someAttendant
Creates an audit policy from the XML file information
beectl add_audit_policy --file <Full path of the input file>
Full path name of the input XML file
beectl add_audit_policy --file /tmp/policy_ex.xml
Creates an audit trail from the search result generated using the XML file
beectl add_audit_trail --file <Full path of the input file>
Full path name of the input XML file
beectl add_audit_trail --file /tmp/trail_ex.xml
Creates a blocked device. The system object identifier of the resulting object needs to be added to the 'DeviceManagementService' system object, using modify_property command, to block this device from accessing Beehive Mobile Services.
beectl add_blocked_device --device <deviceid> [--description <description>]
Specify the local device identifier.
Describe why the device is being blocked.
beectl add_blocked_device --device 981214
Creates a category at the enterprise scope
beectl add_category --file <Full path of the category XML file>
Full path name of the XML file. The file must contain the properly formatted data to create the category
beectl add_category --file /tmp/category.xml
Applies a category on a given entity
beectl add_category_application --category <Identifier of the category to be applied> -- entity <Identifier of the entity to which the category needs to be applied>
Specify the identifier of the category.
Specify the identifier of an Oracle Beehive entity to which the category needs to be applied.
beectl add_category_application --category catg=MyCategory,enpr=MyEnterprise --entity adoc=MyDocument,fldr=MyFolder,wksp=MyWorkspace,enpr=MyEnterprise
Creates a category configuration on the given scope or heterogenous folder.
beectl add_category_configuration --container <Configuration scope or heterogenous folder> --file <Full path of the configuration XML file>
Scope or heterogenous folder on which the category configuration should be defined.
Full path of the category configuration XML file. The file must contain properly formatted data.
beectl add_category_configuration --container orgn=MyOrganization,enpr=MyEnterprise --file /tmp/configuration.xml
Creates a client application configuration object from a supplied input file. The resulting object will be used for client application provisioning.
beectl add_client_application_configuration --file <path to the XML file>
Specify the full path and name of the XML input file. The file should contain information about how to create a client application configuration.
beectl add_client_application_configuration --file /tmp/app-config.xml
Provisions client applications to a community.
beectl add_client_application_provisioning --community <community identifier> {--configuration <client application configuration identifier>... | --all | --application <Identifier of the client application> | --application_version <Identifier of the client application version>}
Specify the identifier of the community.
Specify the identifier of the client application configuration. This option can be specified more than once.
Specify this option to provision the latest binaries (latest version and latest patchset) of all client applications to this community.
Specify this option to provision the specified application to this community. This would make the latest binaries (latest version and latest patchset) to be available to the members of the provisioned community.
Specify this option to provision the specified version to this community. This would make the latest patchset in the specified version to be available to the members of the provisioned community.
beectl add_client_application_provisioning --community enpr=myEnterprise --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434 --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
beectl add_client_application_provisioning --community enpr=myEnterprise --all
beectl add_client_application_provisioning --community enpr=myEnterprise --application 21EC:0AE5:capn:406E6CD925A8F087E040578C921636E5000000000979
beectl add_client_application_provisioning --community enpr=myEnterprise --application_version 21EC:0AE5:capv:406E6CD925A8F087E040578C921636E5000000000979
Creates a new coexisting remote system.
beectl add_coexistence_system --name <name> --product_name <product_name> {--url <url>|--host_name <host_name> --port <port_number> {--use_http|--use_https}} --partnership_key [--timezone_alias_namespace <timezone_alias_namespace>]
Specify the name of the coexisting remote system.
Specify the product name of the coexisting remote system. Supported product are EXCHANGE and DOMINO.
Specify the URL of the coexisting remote system.
Specify that "HTTP" MUST be used for the coexisting remote system.
Specify that "HTTPS" MUST be used for the coexisting remote system.
Specify the host name of the coexisting remote system.
Specify the port number used by the coexisting remote system.
Specify the partnership key of the coexisting remote system.
Specify the timezone alias namespace used by the coexisting remote system.
beectl add_coexistence_system --name ex-101 --product_name exchange --url https://example.com:7777 --partnership_key
beectl add_coexistence_system --name do-202 --product_name domino --use_https --host_name example.com --port 7777 --partnership_key
Creates conference artifact under workspace
beectl add_conference --parent <Workspace identifier> --name <Conference name> --template <Conference identifier>
Workspace identifier
Conference name
Conference identifier
beectl add_conference --parent wksp=MyWorkspace,enpr=MyEnterprise --name MyConference --template owct=MyTemplate,wksp=MyWorkspace,enpr=MyEnterprise
Creates conference-template artifact under workspace
beectl add_conference_template --parent <Workspace identifier> --name <Conference name> --model <Conference or conference template identifier> --settings-xml-file <Conference settings XML file>
Workspace identifier
Conference name
Conference identifier
Conference settings XML file
beectl add_conference_template --parent wksp=MyWorkspace,enpr=MyEnterprise --name Template_from_template --model owct=MyTemplate,wksp=MyWorkspace,enpr=MyEnterprise
beectl add_conference_template --parent wksp=MyWorkspace,enpr=MyEnterprise --name Template_from_xmlfile --settings-xml-file /tmp/default_settings.xml sample settings file: <settings> <roles> <role> <name>Guests</name> <accessors> <accessor_id>2FD3:6B7D:user:42B3D7467840404AA8ABF34BAE421CC5000000000000</accessor_id> </accessors> <properties> <property> <name>chat.can_enable</name> <value> <permission>GRANTED</permission> </value> </property> </properties> </role> </roles> </settings>
The add_custom_user_property command adds custom user properties.
beectl add_custom_user_property --name <property_name> --type <property_type> [ --description <description> ]
Name of the custom property
Type of the property. Supported types are BOOLEAN, COLLABID, DATETIME, DOUBLE, STRING.
Description of the custom property.
beectl add_custom_user_property --name employeenumber --type DOUBLE
Creates a device command for a given device.
beectl add_device_command --device <identifier of the device> --action <device command action>
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
Specify the action of the device command. The following are the valid command actions: UPLOADLOG UPLOADCONFIG CHECKUPDATE WIPEOUT .
beectl add_device_command --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --action CHECKUPDATE
The add_directory_profile command adds a new directory profile.
beectl add_directory_profile --file <filename> [ --no_validate ]
XML file containing directory profile.
Skips the validation of profile against the directory server.
beectl add_directory_profile --file MyDirectoryProfile.xml
beectl add_directory_profile --file MyDirectoryProfile.xml --no_validate
Creates configuration for a Beehive installation in the DMZ that is, outside the firewall.
beectl add_dmz_home_instance --hostname <hostname> --bti_unique_id <unique id for BTI on this oracle home> --no_of_client_workers <number of client workers> [--oracle_home <oracle home path>] [--opmn_request_port <OPMN request port>] [--opmn_remote_port <OPMN remote port>] [--bti_server_port <BTI server port>] [--instance_name <instance name>]
Host name of the machine.
oracle home path.
The site-wide unique identifier of BTI installed on the DMZ host. Please specify the value which is present in the oracle_home/beehive/conf/bti.properties file on the DMZ host.
This is the number of MX processes in the DMZ midtier. The value of this parameter should be the value of "NumberOfClientWorkers" in $OH/beehive/conf/bti.properties in DMZ midtier.
OPMN request port
OPMN remote port
The server port.
instance name of DMZ midtier
beectl add_dmz_home_instance --hostname dmzhost.example.com --bti_unique_id 813130873 --no_of_client_workers 4
Add an email endpoint
beectl add_email_endpoint --ep_name <endpoint name> --ep_protocol <IMAP|SMTP> --type <MX|MXS|TCP|BUS> --ep_address <port number|bus address>
The email endpoint name
The email protocol (SMTP|IMAP)
The email endpoint type (MX|MXS|TCP|BUS)
The endpoint address (port number|bus address)
beectl add_email_endpoint --ep_name IMAP SSL Endpoint --ep_protocol IMAP --type MXS --ep_address 5993
Creates an event subscription using data in an XML file.
beectl add_event_subscription --file <full path to the event subscription xml file>
Specify the absolute path of the XML file that contains data to create the event subscription.
beectl add_event_subscription --file /private/xml/MyEventSubscription.xml
The add_expertise_user_scope command adds new expertise user scope. The expertise user scope information is supplied in a XML file.
beectl add_expertise_user_scope --file <filename>
Filename of the XML file containing name, description, include_list and exclude_list.
beectl add_expertise_user_scope --file MyUserScope.xml
The add_external_contact command adds new external contact.
beectl add_external_contact --family_name <[locale:]family name> [ --family_name <[locale:]family name> ... ] [ --scope <identifier of contacts parent> ] [ --given_name <[locale:]given name> ... ] [ --display_name <[locale:]display name> ... ] [ --middle_name <[locale:]middle name> ... ] [ --job_title <[locale:]job title> ... ] [ --prefix <[locale:]prefix> ... ] [ --suffix <[locale:]suffix> ... ] [ --nick_name <[locale:]nick name> ... ] [ --office_location <office location of the contact> ] [ --company <company of the contact> ] [ --profession <profession of the contact> ] [ --timezone <timezone of the contact> ] [ --locale <locale of the contact> ] [ --department <department of the contact> ] [ --organization <organization identifier> ... ] [ --property <name(assistant|certificate|notes)=value=description> ... ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ]
Family name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Identifier of the enterprise under which this contact will be created.
Given name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Display name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Middle name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Job title of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Prefix of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Suffix of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Nick name of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Office location of the contact.
Company of the contact.
Profession of the contact.
Timezone of the contact. list_timezones lists the valid timezones
Locale details of the contact. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Department of the contact.
Identifiers of the organizations the contact belongs to.
Details of the property in the format name=value=description. Supported names are certificate, assistant and notes. Note, no equals to symbol(=) should be present in the name or value or description.
Address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Primary address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
beectl add_external_contact --family_name Contact1FamilyName --scope enpr=example
beectl add_external_contact --family_name Contact1FamilyName --given_name Contact1GivenName --display_name "Contact1 GivenName" --organization orgn=contact1orgn,enpr=contact1enpr
beectl add_external_contact --family_name Contact1FamilyName --scope enpr=example --address BUSINESS_1:mailto:contact1@example.com --address BUSINESS_2:fax:121345222
beectl add_external_contact --family_name Contact1FamilyName --scope enpr=example --property prop1:prop1Value
The add_feed_configuration command adds new feed configurations.
beectl add_feed_configuration { --name <name > --scope <scope identifier> --feedtype <feed type > --title <title > --description <description > [--image <image >] [--language <language >] [--copyright <copyright>] [--webmaster <webmaster>] }
Name of the feed configuration.
Scope in which the feed configuration will be created
Feed type of the feed configuration. Permitted values are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.
Title associated the feed configuration
Description associated the feed configuration
Image associated with this feed configuration
Language associated with the feed configuration
Copyright associated with the feed configuration
Webmaster associated with the feed configuration
beectl add_feed_configuration --name FeedConfigName --scope enpr=example --feedtype RECENT --title MyFeedConfiguration --description This is my feed configuration.
beectl add_feed_configuration --name MyWorkspaces --scope enpr=example --feedtype RECENT --title WorkspaceFeedConfiguration --description This is a recent workpsace feed. --image WorkspaceLogo.gif --language en
Creates a reference in Beehive to a directory on the filesystem.
beectl add_filesystem_reference --name <Filesystem reference name> --filesystem_path <Server path> --read_only <true or false>
Name to give to this filesystem reference.
Fully-qualified path on the filesystem to which this reference should point.
Whether the referenced filesystem directory should be treated as read-only by Beehive.
beectl add_filesystem_reference --name MyFilesystemReference --filesystem_path /usr/local/bin --read_only true
The add_group command adds new groups. The group information is supplied in an XML file.
beectl add_group --file <filename> [ --ldapbootstrap ]
Filename of the XML file containing group definition.
LDAP bootstrap flag. If this flag is specified, then uds groups will be created with directory locator and directory id. This is relevant only when --file option is used.
beectl add_group --file MyGroup.xml
beectl add_group --file MyGroup.xml --ldapbootstrap
Add a remote iSchedule Server configuration.
beectl add_ischedule_server --name <name> --domain_regexp <regexp> --outgoing_url <remote_url> [--outgoing_auth_id <auth_id>] [--outgoing_auth_key <auth_key>] [--incoming_auth_id <auth_id>] [--incoming_auth_key <auth_key>] [--incoming_allow_ip_regexp <regexp>] [--incoming_allow_host_regexp <regexp>]
Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.
Regular expression that must match the remote user's email address.
Address of the remote iSchedule server.
Authentication ID that must be used when connecting to the remote server.
Key that must be used when connecting to the remote server.
Authentication ID that the remote server must use when connecting to the Oracle Beehive server.
Key that the remote server must use when connecting to the Oracle Beehive server.
IP Addresses connecting to the Oracle Beehive server must match this regular expression
Host names connecting to the Oracle Beehive server must match this regular expression
beectl add_ischedule_server --name remoteserver --domain_regexp ".*@example.com" --outgoing_url http://remoteserver@example.com/ischedule
Adds an Access Control Entry (ACE) to an entity's Local Access Control List (LACL).
beectl add_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
Specify the unique identifier of the entity to which the ACE will be added.
Specify the Accessor to whom the access types will apply.
Specify the access types string for the Accessor.
beectl add_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D
Creates an organization in the given scope
beectl add_organization --name <Organization name> --scope <Identifier of enterprise or organization>
Name of the organization
Identifier of the parent scope (enterprise or organization)
beectl add_organization --name Sample_organization --scope enpr=test_org
Creates a policy using data in an XML file.
beectl add_policy --file <full path to the policy xml file>
Specify the absolute path of the XML file that contains the policy data.
beectl add_policy --file /private/xml/MyPolicy.xml
Creates a policy schema using data in an XML file.
beectl add_policy_schema --file <full path to the policy schema xml file>
Specify the absolute path of the XML file that contains the policy schema data.
beectl add_policy_schema --file /private/xml/MyPolicySchema.xml
Creates a policy template using data in an XML file.
beectl add_policy_template --file <full path to the policy template xml file>
Specify the absolute path of the XML file that contains the policy template data.
beectl add_policy_template --file /private/xml/MyPolicyTemplate.xml
The add_preference_profile command adds a new preference profile and associates it with a consumer. There can be only one preference profile for a consumer.
beectl add_preference_profile --consumer <identifier> --name <profile-name> [ --description <description> ]
Identifier of the consumer
Name of the preference profile to be created.
Description of preference profile.
beectl add_preference_profile --consumer user=user1 --name MyProfile
The add_preference_property command adds a new preference property to a preference set.
Supported types are :
IDENTIFIABLE
IDENTIFIABLE_LIST
STRING
STRING_LIST
INTEGER
INTEGER_LIST
BOOLEAN
BOOLEAN_LIST
DATE
DATE_LIST
URI
URI_LIST
FLOAT
FLOAT_LIST
beectl add_preference_property --set <identifier> --name <property-name> --type <string | date | ... | identifiable> [ --value <property-value> ] [ --file <file-name> ] [ --final ]
Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.
Name of the preference property.
Type of preference property.
Value of preference property.
File name for business hours type preference property.
Whether the preference property be overriden in extended property.
beectl add_preference_property --set prfs=set1,user=user1 --name MyProperty --type integer --value 100 --final
beectl add_preference_property --set prfs=set1,user=user1 --name MyProperty --type integer_list --value 100 --value 200 --value 300 --final
The add_preference_set command adds a preference set to a preference profile.
beectl add_preference_set --parent <preference-profile-identifier> --name <preference-set-name> [ --extends <preference-set-identifier> ]
Identifier of the preference profile to which the preference set is added.
Name of the preference set.
Identifier of the preference set from which the new preference set is extended.
beectl add_preference_set --parent prfp=MyProfile,user=user1 --name MyPreferenceSet
Adds a record or non-record.
beectl add_record --artifact <identifier of the artifact to be filed as a record or non-record> { --retention_category <identifier of the URM retention category> | --record_folder <identifier of the URM record folder> } [ --no_retention <boolean specifying a record or non-record> ]
identifier of the artifact to be filed as a record or non-record
identifier of the URM retention category
identifier of the URM record folder
boolean specifying a record or non-record
beectl add_record --artifact myArtifact --retention_category myRetentionCategory --no_retention
Adds a remote repository.
beectl add_remote_repository --file <Pathname to the remote repository file.>
Pathname to the remote repository file.
beectl add_remote_repository --file myRemoteRepositoryFile
Adds a remote repository share.
beectl add_remote_share --file <Pathname to the remote share file.>
Pathname to the remote share file.
beectl add_remote_share --file myRemoteShareFile
Creates a new resource.
beectl add_resource --name <name> --email_address <email address> --resource_type <type> [--scope <organization>] [--capacity <capacity>] [--identifier <identifier>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>] [--timezone <timezone name>] [--location <location>] [--add_approver <approverid>] [--description <description>] [--booking_info <booking info>] [--booking_characteristics <[O]pen>|<[F]CFS>] [--custom_processing <[T]rue>|<[F]alse>] [--accessible_by <everyone | nobody | groupid | userid> ] beectl add_resource --external --name <name> --email_address <email address> --resource_type <type> [--scope <organization>] [--capacity <capacity>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>] [--timezone <timezone name>] [--location <location>] [--booking_info <booking info>] [--description <description>]
Define the unique name of the resource.
Deprecated option. Use --scope instead.
Specify the type of the resource. Specify "E", "Equipment", "O", "Other", "R" or "Room", case insensitive.
Deprecated option. Use --resource_type instead.
Specify the BUSINESS_1 e-mail address of the resource.
Specify the BUSINESS_1 phone number of the resource.
Specify the BUSINESS_1 web site of the resource.
Specify the BUSINESS_1 postal address of the resource. The required format is: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country>. All fields are optional but at least one field must appear in a valid address of this type. For example, orapostal:l1=1, Main Street is a valid address. The ? character must not be encoded when used as a separator; it must be encoded in all other cases. For example orapostal:l1=1?l2=Which Street%3F?code=12345 is a valid address; but orapostal:l1=1?l2=Which Street??code=12345 is not a valid address because the question mark appearing as part of the address "Which Street?" is not encoded.
Specify the identifier of the resource. The identifier can be used as an alternative to the name: such as a room or serial number.
Specify the capacity of the resource.
Create the resource as an external resource. If this option is not specified, a BookableResource will be created.
Resource approver to add.
Specify resource default calendar booking characteristic. Specify [O] for Open or [F] for First Come First Serve, case insensitive.
Specify resource booking information. It must be a xHTML string.
Specify the description of the resource. It must be a xHTML string.
Specify the timezone of the resource.
Specify the location description of the resource. It must be a xHTML string.
Specify the enterprise or organization under which this resource will be created. Will default to the current enterprise.
Specify if this resource requires custom processing. Specify "T", "True", "F" or "False", case insensitive.
Specify who can access this resource. It must be one of "everyone", "nobody", a group id or finally a user id, case insensitive. Use "everyone" to reset the accessibility to the default for the resource.
beectl add_resource --name "Resource1" --email_address resource1@example.com --resource_type "room" --identifier "us:OP200:20P74" --capacity 8 --timezone "America/Los_Angeles"
Creates a RoleDefinition entity.
beectl add_role_definition [--scope <unique identifier of the Scope>] --name <name of RoleDefinition> [--description <description>] [[--privilege <privilege name>]...] [--access_types <access types string>] [--always_enabled <boolean value>]
Specify the unique identifier of the Scope in which the RoleDefinition should be created.
Specify the name of the RoleDefinition.
Specify a description for the RoleDefinition.
G">Workspace name</optich will be granted by the RoleDefinition. This option can be specified more than once.
Specify the access types string for the RoleDefinition.
Specify this option to mark the RoleDefinition as always enabled.
beectl add_role_definition --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition
Recovers the search index for Entities of the specified types, in the specified Scope, and which were last modified between the specified dates.
beectl add_search_recovery_scope --scope <Recover the search index for this scope.> [--entity_type <Recover search index for this entities of this type.>] [--start_date <Recover search index for entities modified on or after this date. If not specified, 30 days before the present will be used as the start date.>] [--end_date <Recover search index for entities modified before or on this date. If not specified, the present will be used as the end date.>]
Recover the search index for this scope.
Recover search index for this entities of this type.
Recover search index for entities modified on or after this date. If not specified, 30 days before the present will be used as the start date.
Recover search index for entities modified before or on this date. If not specified, the present will be used as the end date.
beectl add_search_recovery_scope --scope 1CF3:35AF:orgn:6828B43CD3944E06A5CD425F0225CF2500000000004C --entity_type adoc --entity_type emsg --start_date 2008-07-10T00:00:00 --end_date 2010-04-21T00:00:00
Creates a Sensitivity entity.
beectl add_sensitivity --workspace <unique identifier of the Workspace> --name <name of Sensitivity> [--description <description>] [--sensitivity_only <boolean value>] [--delegatable <boolean value>]
Specify the unique identifier of the Workspace in which the Sensitivity should be created.
Specify the name of the Sensitivity.
Specify a description for the Sensitivity.
Specify the SensitivityOnly option for the Sensitivity.
Specify the Delegatable option for the Sensitivity.
beectl add_sensitivity --workspace wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity
Adds an Access Control Entry (ACE) to a Sensitivity entity's Sensitivity ACL (SACL).
beectl add_sensitivity_ace --sensitivity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
Specify the unique identifier of the Sensitivity to which the ACE will be added.
Specify the unique identifier of an Accessor to whom the access types will apply.
Specify the access types string for the Accessor.
beectl add_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D
Creates a team workspace from a template
beectl add_team_workspace --name <Workspace name> --scope <Identifier of enterprise or organization> [--template <Workspace template identifier>] [--file <Full path of the input file>] [--email_address <Team workspace email address>] [--description <Description>][--participation_mode <Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED>] [--directory_listed <TRUE|FALSE. Default value is FALSE>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --soft_quota <Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--public_access_role <Role definition identifier for public access>]
Workspace name
Identifier of enterprise or organization
Workspace template identifier
Full path of the input file
Team workspace email address
Description
Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED
TRUE|FALSE. Default value is FALSE
Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Role definition identifier for public access. If not specified, the team workspace to create is not for public access
beectl add_team_workspace --scope enpr=test_enterprise --name My_Team_worksapce --hard_quota UNLIMITED --soft_quota 100
beectl add_team_workspace --scope orgn=test_org,enpr=test_enterprise --template wstp=test_team_ws_template,enpr=test_enterprise --file /tmp/input.xml --hard_quota 1000 --soft_quota 100 --email_address teamworkspace@company.com
Transforms the given team workspace to conform to the given team workspace template
beectl add_team_workspace_template_application --template <Workspace template identifier> --workspace <Workspace identifier> --file <Full path of the template file>
Workspace template identifier
Workspace identifier
Full path of the input file
beectl add_team_workspace_template_application --template wstp=test_team_ws_template,enpr=test_enterprise --workspace wksp=test_team_ws,enpr=test_enterprise --file /tmp/template_variable_values.xml
Applies the latest snapshot of the given team workspace template to all the team workspaces to which the template was applied earlier
beectl add_team_workspace_template_evolution --template <Workspace template identifier> --limit <Maximum number of workspaces to upgrade> --file <Full path of the template file>
Workspace template identifier
Maximum number of workspaces to upgrade
Full path of the input file
beectl add_team_workspace_template_evolution --template wstp=test_team_ws_template,enpr=test_enterprise --limit 100 --file /tmp/template_variable_values_and_update_options.xml
This command registers a trusted identity. There are two types of trusted identities: WSSEC and SES. Default type is WSSEC. For WSSEC type, please make sure that the service has a valid certificate registered in the wallet and the correct associated key alias is passed into this command. This command also creates the principal(s) associated with this trusted identity in the Beehive system. On the other hand, for SES type, this command stores the given trusted identity name and password information.
beectl add_trusted_identity [--type WSSEC --is_service <boolean> [--key_alias <Key Alias>] --service_name <Trusted Identity Name>] [--type S2S --password <Trusted Identity Password> --service_name <Trusted Identity Name>] [--type SES --name <Trusted Entity Name> --password <Trusted Entity Password>]
The alias of the service which is used to register the certificate in the wallet. This option is mandatory if registering a web service, i.e. if is_service is true and type is WSSEC. For all other cases, this is not a mandatory option.
Boolean value, true if this is a service. This option is mandatory if type is WSSEC.
String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
String value representing the name of the SES trusted entity.
Secure string value representing the password of the SES trusted entity.
Configures an agent for a URM instance.
beectl add_urm --rm_admin_name <RM Admin Name for the URM instance.> --rm_admin_password <RM Admin Pass for the URM instance.> --urm_url <The URL for the URM instance.> --rm_email_admin <Email Id of the RM administrator.> [ --disposition_loader_interval <The Disposition Loader Interval for the URM instance.> ] [ --disposition_processor_interval <The Disposition Processor Interval for the URM instance.> ] [ --agent_name <The Agent Name for the URM instance.> ]
RM Admin Name for the URM instance.
RM Admin Pass for the URM instance.
The URL for the URM instance.
The Disposition Loader Interval for the URM instance.
--disposition_processor_interval
The Disposition Processor Interval for the URM instance.
The Agent Name for the URM instance.
Email Id of the RM administrator.
beectl add_urm --rm_admin_name myRmAdminName --rm_admin_password myRmAdminObfuscatedPassword --urm_url myUrmUrl --disposition_loader_interval myDispositionLoaderInterval --disposition_processor_interval myDispositionProcessorInterval --agent_name myAgentName --rm_email_admin 2312:2525:user:25252AB25215515155
The add_user command adds new users. The user information is supplied either on command line or in an XML file.
beectl add_user { --family_name <[locale:]family name> [ --family_name <[locale:]family name> ... ] --scope <identifier of users parent> --login_id <login_id> --login_password <password> [ --given_name <[locale:]given name> ... ] [ --display_name <[locale:]display name> ... ] [ --middle_name <[locale:]middle name> ... ] [ --job_title <[locale:]job title> ... ] [ --prefix <[locale:]prefix> ... ] [ --suffix <[locale:]suffix> ... ] [ --nick_name <[locale:]nick name> ... ] [ --office_location <office location of the user> ] [ --company <company of the user> ] [ --profession <profession of the user> ] [ --timezone <timezone of the user> ] [ --locale <locale of the user> ] [ --department <department of the user> ] [ --assistant <assistant identifier> ] [ --manager <manager identifier> ] [ --organization <organization identifier> ... ] [ --voice_principal <voice devicenumber> ] [ --voice_pin <pin> ] [ --property <name=value=description> ... ] [ --protocol_principal <protocol principal> ] [ --protocol_password <protocol password> ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ] [ --external_inbox <true|false> ] [ --extended_enterprise_user <true|false> ] | --file <filename> }
Family name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Identifier of the enterprise or organization under which this user will be created.
Given name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Display name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Middle name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Job title of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Prefix of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Suffix of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Nick name of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Office location of the user.
Company of the user.
Profession of the user.
Timezone of the user. list_timezones lists the valid timezones
Locale details of the user. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Department of the user.
Identifier of the assistant.
Identifier of the manager.
Identifiers of the organizations the user belongs to.
Details of the property in the format name=value=description. Any custom property can be used. Note, no equals to symbol(=) should be present in the name or value or description.
Address of the user in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Primary address of the user in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
The login credentials of the user.
Login password.
Voice principal of the user.
Pin number for the voice device.
Protocol principal of the user.
Protocol password.
Name of the file, which contains user information in XML format.
Boolean if user's inbox is external or not.
Boolean if user is an external user or not.
beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --obfuscated
beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --given_name User1GivenName --display_name "User1 Name" --organization orgn=beehive1,enpr=oracle1 --obfuscated
beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --address BUSINESS_1:mailto:example@example.com --address BUSINESS_2:fax:121345222 --obfuscated
beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --property notes=xxx --obfuscated
beectl add_user --family_name User1FamilyName --login_id user@example.com --login_password hioquery731419== --scope enpr=example --extended_enterprise_user true --obfuscated
beectl add_user --file Users.xml
Creates a user subscription from a pre-defined rule in a subscription template.
beectl add_user_subscription --source_entity_class <sourceEntityClass of template> --rule <rule name> --attach <identifier of attached entity> --subscriber <identifier of subscriber>
Specify the name of the source entity Class that is defined in subscription template.
"multiline"> <message fined rule or the rule statement. The format of rule statement is: RULE_STATEMENT:CONDITION:attribute1=value1,attribute2=value2, ...attribute=value,ACTION:attribute1=value1,attribute2=value2, ...attribute=value
Specify the Identifier of the entity to which the subscription is attached.
Specify the identifier of the subscriber who owns the subscription.
Specify the name of the subscription to be created.
beectl add_user_subscription --source_entity_class Invitation --attach 5457:7954:clnd:5B5DB5E3F6652295E040578C92165D03000000006740 --subscriber user=user1 --rule NOTIFY_ON_ANY_UPDATED_INVITATION
beectl add_user_subscription --source_entity_class Message --attach 5457:7954:wspr:5B5DB5E3F6652295E040578C92165D03000000000456 --subscriber user=user1 --name MyServerSideRule_1 --rule RULE_STATEMENT:CONDITION:created_any_from_contains=beehive,created_any_subject_contains=build,ACTION:move_to=5457:7954:afrh:5B5DB5E3F6652295E040578C92165D03000000000440,forward_to=test.user@oracle.com
Creates a version configuration on the given scope or heterogenous folder.
beectl add_version_configuration --container <Configuration scope or heterogenous folder> --file <Full path of the configuration XML file>
Scope or heterogenous folder on which the version configuration should be defined.
Full path of the version configuration XML file. The file must contain properly formatted data.
beectl add_version_configuration --container orgn=MyOrganization,enpr=MyEnterprise --file /tmp/configuration.xml
Adds a new virus scan engine to the collection of engines configured for the Site. If this is the first scan engine being added, this command will create a new collection for the Site and add the virus scan engine to it.
beectl add_virus_scan_engine [ --hostname <scanengine_hostname> ] [ --port <scanengine_port> ] [ --validate_connection <true/false> ]
Name of the host where the virus scan engine is installed. Default is localhost.
Port number used by the virus scan engine for communication with its clients. Default is 1344.
Indicates if the connection to the virus scan engine needs to be validated.
<beectl add_virus_scan_engine --hostname scanenginehost.example.com --port 1344 --validate_connection true>
Creates a voice facility by associating phone rules with an already created group. The command may be run multiple times and each new execution will append new rules to existing rules for a given group collabid.
beectl add_voice_facility --group_collabid <collabid> [--include <phone rules>] [--exclude <phone rules>]
The collabid of the group to associate with the given phone number rules.
The collection of phone number rules to describe what phone numbers to include in the given facility. The rules are delimited by pipes.
The collection of phone number rules to describe what phone numbers to EXCLUDE in the given facility. The rules are delimited by pipes.
beectl add_voice_facility --group_collabid grup=GroupName,enpr=MyEnterprise --include 1312???????|1713??????? --exclude 13129??????|17139??????
Appends the specified value to the existing value of the named property. If the named property value is cleared before executing this command, then after executing this command it will contain the new value.
Note :- Option value should not start with hyphen(-). If an option value starts with hyphen, use any one of the following syntaxes. 1. Use <option-name>=<option value> format. This is the preferred way to specify the option values starting with hypens. 2. Prepend the option value with string "ESCAPE:". 3. Prepend the option value with backslash "\\". This is the least preferred way. This may not work in some platforms, esp in windows platforms it will not work.
beectl append_value --component <system object identifier or alias> --name <name> --value <value>...
component id.
Name of the property.
Value of the property.
The command execution below would modify the log level for code in module oracle.ocs.commandline to FINEST and code in module oracle.ocs.management to FINE. These new settings are appended to existing list of package names in the ModuleLogLevel property of the LoggingProperties config object in current site. If the ModuleLogLevel property was cleared before executing this command, then it will contain the new values now.
beectl append_value --component _CURRENT_SITE:LoggingProperties --name "ModuleLogLevel" --value "oracle.ocs.commandline:FINEST" --value "oracle.ocs.management:FINE"
Modify access permissions for grantee (user or group) on the specified calendar.
beectl clear_calendar_permissions { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--user <userid> | --group <groupid>]
Specify the unique identifier of a calendar.
Specify the unique identifier of a user, resource or workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
Specify the unique identifier of the user (grantee).
Specify the unique identifier of the group (grantee).
beectl clear_calendar_permissions --calendarowner user1@example.com --user user=user2
Clears proposed configuration of the Beehive system object model
beectl clear_proposed_configuration
This command has no options
beectl clear_proposed_configuration
Reset the access permissions of a tasklist to their out-of-box defaults.
beectl clear_tasklist_permissions { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--user <userid> | --group <groupid>]
Specify the unique identifier of a tasklist.
Specify the unique identifier of a user, resource or team workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
Specify the unique identifier of the target user.
Specify the unique identifier of the target group.
beectl clear_tasklist_permissions --tasklistowner user1@example.com --user user=user2
Top level clone command that clones a mid-tier.
beectl clone_midtier --ias_instance_name <ias instance name > --host_name <host name> --db_schema_password <db schema password> [--oui_inv_ptr_loc <oui data>] [--oracle_home_name <oracle home name>] [--do_not_start_at_end] --site_key <Site key> [--ignore_validation_warnings]
Ias instance name with out appending host name. For example "myinstance"
Fully qualified host name of the new midtier.
Beehive database schema password.
Oracle inventory pointer location file. Location of Oracle inventory is present in this file. If not specified, a platform default value (/etc/oraInst.loc on Linux) is checked. If the platform default value does not exists, then Oracle Inventory is created in user's home directory.
Oracle home name. The default value is the value for --ias_instance_name option.
If specified, beehive components will not be started at the end.
Site key value.
If specified, commands using validation framework will ignore the warnings and continue.
beectl clone_midtier --ias_instance_name MyIASInstance --host_name machine1.example.com --db_schema_password dbbeehiveschemapassword --site_key <Site key>
If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.
Creates a new oc4j instance by cloning the given oc4j instance.
Most of properties of the newly created oc4j instance is similar to that of the source oc4j instance.
All the service instance present in the source oc4j instance system model is deployed into the newly cloned oc4j instance.
Further, after deploying all the service instances, newly cloned oc4j instance is bouned once.
Only Beehive oc4j instances should be cloned using this command. Non Beehive oc4j instances can't be cloned using this command
Beehive Management oc4j instance should not be cloned. This command will error out when management oc4j instance is cloned.
When a template is associated with the Beehive instance, then target oc4j name can't be specified and disable_sizing option should be specified.
beectl clone_oc4j_instance [--source_oc4j_instance_id <source oc4j instance system model id> | --source_oc4j_instance_name <source oc4j instance name>] [--target_oc4j_instance_name <target oc4j instance name>] [--disable_sizing] [--cold_mode]
Source oc4j instance system model id.
Source oc4j instance name.
Target oc4j instance name.
Disable sizing.
Clone the target oc4j instance in cold mode. Target oc4j instance will be started only at the end of flow.
beectl clone_oc4j_instance --source_oc4j_instance_name BEEAPP --target_oc4j_instance_name BEEAPP_CLONE
beectl clone_oc4j_instance --source_oc4j_instance_name BEEAPP --disable_sizing
Upgrades the midtier by cloning.
beectl clone_patching ([--old_oracle_home <old oracle home>] |[--local_beehive_instance_id <local beehive instance id > --db_schema_password <schema password > --site_key <Site key > ])[--oui_inv_ptr_loc <oui data >] [--start_at_end] [--ignore_validation_warnings]
Specify the old oracle home.
Local beehive instance system object id.
Password to connect to config database.
Site key value.
Oracle inventory pointer location file. Location of Oracle inventory is present in this file. If not specified, a platform default value (/etc/oraInst.loc on Linux) is checked. If the platform default value does not exists, then Oracle Inventory is created in user's home directory.
If specified, beehive components will be started at the end.
If specified, commands using validation framework will ignore the warnings and continue.
beectl clone_patching local_beehive_instance_iddb_schema_password instance1.machibe-b.example.com local_beehive_instance_idsite_key <secure value> local_beehive_instance_id{5} <secure value>
If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.
Prepares the existing oracle home for cloning.
beectl clone_preparation --file <output file name> [--ignore_validation_warnings]
Fully qualified name of the file which will store the list of files to be cloned. This files has to be outside the oracle home.
If specified, commands using validation framework will ignore the warnings and continue.
beectl clone_preparation --file /tmp/clone-list.txt
If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.
Top level clone command that clones a mid-tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details.
beectl clone_site --ias_instance_name <ias instance name > --host_name <host name> --db_schema_password <db schema password> --db_connect_string <db connect String> [--oui_inv_ptr_loc <oui data>] [--db_schema_name <db schema name>] [(--db_rac_node_information <XA Service name>) ...] [(--db_xa_service_name <rac node information>) ...] [--retain_rac_node_information] [--oracle_home_name <oracle home name>] [--do_not_start_at_end] [--site_name <New site name>] --site_key <Site key> [--ignore_validation_warnings]
Ias instance name with out appending host name. For example "myinstance"
Fully qualified host name of the new midtier.
Beehive database connect string.
Beehive database schema password.
Beehive database schema name.
Beehive database RAC node information. It should be of the format hostname:port. For eg sample.com:1521
Beehive database XA service name.
Retains the old rac node and ons information. By default old rac node information is removed.
Oracle home name. The default value is the value provided for --ias_instance_name option.
Oracle inventory pointer location file. Location of Oracle inventory is present in this file. If not specified, a platform default value (/etc/oraInst.loc on Linux) is checked. If the platform default value does not exists, then Oracle Inventory is created in user's home directory.
If specified, beehive components will not be started at the end.
New site name
Site key value.
If specified, commands using validation framework will ignore the warnings and continue.
beectl clone_site --ias_instance_name MyIASInstance --host_name machine1.example.com --db_schema_password dbbeehiveschemapassword --db_connect_string "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=machine2.example.com)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=oracle))" --db_schema_name MySchema --retain_rac_node_information --site_key <site key>
If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.
Deletes an AssignedRole entity.
beectl delete_assigned_role --assigned_role <unique identifier of the AssignedRole>
Specify the unique identifier of the AssignedRole to be deleted.
beectl delete_assigned_role --assigned_role acar=MyAssignedRole,wksp=MyWorkspace,enpr=MyEnterprise
Deletes an auto attendant by name.
beectl delete_attendant --name <name of attendant>
Name of the attendant to delete.
beectl delete_attendant --name my_attendant
Deletes a prompt.
beectl delete_attendant_prompt --name <attendant name> --type <prompt type> --language <prompt language>
Name of the attendant to which the prompt belongs.
The type of the prompt. Can be one of language, menu, greeting, extension-prompt, extension-nomatch, option1, option2, option3, option4, option4, option5, option6, option7, option8, option9, noinput, noinput-term, nomatch, nomatch-term.
The language of the prompt.
beectl delete_attendant_prompt --name myAttendant --type greeting --language en_US
beectl delete_attendant_prompt --name myAttendant --type language
Deletes an existing audit
beectl delete_audit_policy --policy <Audit policy identifier>
Audit policy identifier
beectl delete_audit_policy --policy plcy=MyAuditPolicy
Deletes an existing audit trail
beectl delete_audit_trail --trail <Audit trail identifier>
Audit trail identifier
beectl delete_audit_trail --trail autr=MyAuditTrail
Deletes a category and all category applications.
beectl delete_category --category <Identifier of the category to be deleted>
Specify the identifier of the category.
beectl delete_category --category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent
Removes a category from an entity
beectl delete_category_application --category <Identifier of the category to be removed> --entity <Identifier of the entity from which the category needs to be removed>
Specify the identifier of the category to be removed.
Specify the identifier of an Oracle Beehive entity from which the category needs to be removed.
beectl delete_category_application --category catg=MyCategory,enpr=MyEnterprise --entity adoc=MyDocument,fldr=MyFolder,wksp=MyWorkspace,enpr=MyEnterprise
Deletes a given category configuration.
beectl delete_category_configuration --configuration <Configuration identifier>
Category configuration to be deleted.
beectl delete_category_configuration --configuration 9941:2345:ctcf:58D193D162CE4ED89FF66AB4E55745B6345464545453
Deletes a client application.
beectl delete_client_application --application <identifier of the client application>
Specify the identifier of the client application. Use list_client_applications command to determine the identifier of the client application.
beectl delete_client_application --application 1234:5678:capn:2E0329B0705F0E40E040578C92160957000000000434
Deletes the client application configuration with the given identifier.
beectl delete_client_application_configuration --configuration <identifier of the client application configuration>
Specify the identifier of the client application configuration.
beectl delete_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
Deletes a client application patchset.
beectl delete_client_application_patchset --patchset <identifier of the client application patchset>
Specify the identifier of the client application patchset. Use list_client_application_patchsets command to determine the identifier of a client application patchset.
beectl delete_client_application_patchset --patchset 1234:5678:capp:2E0329B0705F0E40E040578C92160957000000000434
De-provisions client applications from a community.
beectl delete_client_application_provisioning --community <community identifier> {--configuration <client application configuration identifier>... | --all}
Specify the identifier of the community.
Specify the identifier of the client application configuration. This option can be specified more than once.
Specify this option to deprovision any client applications provisioned earlier. The users belonging to this community would get the applications provisioned at the parent community level.
beectl delete_client_application_provisioning --community enpr=myEnterprise --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434 --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
beectl delete_client_application_provisioning --community enpr=myEnterprise --all
Deletes a client application version.
beectl delete_client_application_version --application_version <identifier of the client application version>
Specify the identifier of the client application version. Use list_client_application_versions command to determine the identifier of a client application version.
beectl delete_client_application_version --application_version 1234:5678:capv:2E0329B0705F0E40E040578C92160957000000000434
Deletes the coexistence profile of user.
beectl delete_coexistence_profile {--user <user_identifier>|--email <user_email>|--file <file_name>}
Specify the identifier of the user.
Specify the email address of the user.
Specify the xml input file. File encoding MUST be UTF-8.
beectl delete_coexistence_profile --user user=userid
beectl delete_coexistence_profile --file users.xml
Deletes a coexisting remote system. WARNING: This command will purge the coexisting remote system and clean all related data.
beectl delete_coexistence_system --select_by_name <connector_name>
Specify the name of the coexisting remote system.
beectl delete_coexistence_system --select_by_name ex-101
Deletes conference artifact under workspace
beectl delete_conference --conference_id <Conference identifier>
Conference identifier
beectl delete_conference --conference_id owch=MyConference,wksp=MyWorkspace,enpr=MyEnterprise
Deletes conference template artifact under workspace
beectl delete_conference_template --template_id <Conference identifier>
Conference identifier
beectl delete_conference_template --template_id owct=MyTemplate,wksp=MyWorkspace,enpr=MyEnterprise
The delete_custom_user_property command deletes a custom property. If there are multiple custom properties with same name, then only the first occurrence of the attribute with specified name is deleted. Any values of the property being deleted will also be deleted.
beectl delete_custom_user_property --name <name>
Property name. Example: employeenumber.
beectl delete_custom_user_property --name employeenumber
Deletes the device with the given identifier.
beectl delete_device --device <identifier of the device>
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
beectl delete_device --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434
Deletes the device profile or device profiles. The command can delete the device profile with the given identifier or with the given device profile name or delete the device profiles specified from the given file containing names of the device profiles. The command can also optionally delete all the device types associated with this device profile.
beectl delete_device_profile {--profile <identifier of the device profile>|--profile_name <name of the device profile>|--file <file containing device profiles>} [--delete_device_types]
Identifier of the device profile.
Name of the device profile.
File containing the names of the device profiles. Specify the full path and file name.
Deletes all the device types associated with this device profile.
beectl delete_device_profile --profile 1234:5678:devp:2E0329B0705F0E40E040578C92160957000000000434
beectl delete_device_profile --profile 1234:5678:devp:2E0329B0705F0E40E040578C92160957000000000434 --delete_device_types
beectl delete_device_profile --profile_name "Device Profile Name" --delete_device_types
beectl delete_device_profile --file /tmp/deleted_profiles.txt --delete_device_types
Deletes the device type with the given identifier.
beectl delete_device_type --type <identifier of the device type>
Identifier of the device type.
beectl delete_device_type --type 1234:5678:devt:2E0329B0705F0E40E040578C92160957000000000434
The delete_directory_profile command deletes a directory profile.
Changelog number for the directory profile is not deleted from beehive, unless the activate_configuration option is used. To delete the changelog number from beehive, run this command by specifying the common option activate_configuration with value as true.
The command deletes a directory profile if no users or groups are associated with the profile in beehive.
beectl delete_directory_profile --profile <profile-name>
Profile name to be deleted.
beectl delete_directory_profile --profile MyDirectoryProfile
Removes configuration for a Beehive installation in the DMZ that is, outside the firewall.
beectl delete_dmz_home_instance --id <dmz beehive instance id>
Identifier for DMZ beehive instance.
beectl delete_dmz_home_instance --id dmz_on_server1
Moves an email message to a target folder or removes it outright
beectl delete_email_message --internet_message_id <The Message-ID header in the MIME source of the message> [--email_address <The email address of the admin user account that the deleted message should be moved to>] [--folder <The folder name of the admin user account that the deleted message should be moved to>]
The Message-ID header in the MIME source of the message
The email address of the admin user account that the deleted message should be moved to
The folder name of the admin user account that the deleted message should be moved to
beectl delete_email_message --internet_message_id 200602221113.k1MBDZDr020197@rgminet03.oracle.com --email_address user1@example.com --folder Recalled
Deletes an event subscription from the Oracle Beehive repository.
beectl delete_event_subscription --subscription <identifier of the event subscription to be deleted>
Specify the identifier of the event subscription to be deleted.
beectl delete_event_subscription --subscription 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453
The delete_expertise_user_scope command deletes expertise user scope. The expertise user scope CollabId/BODN is supplied with --expertise_user_scope option.
beectl delete_expertise_user_scope --expertise_user_scope <BODN or CollabId>
CollabId or BODN format of the expertise user scope to be deleted.
beectl delete_expertise_user_scope --expertise_user_scope exus=ExpertiseUserScopeName,enpr=Oracle
beectl delete_expertise_user_scope --expertise_user_scope 416E:25BF:exus:6A9CBED7822AA32EE040578C5C8453AB000000018705
Purge actions that have not completed successfully.
beectl delete_failed_action_events --bucket <Partition number> --sequence <Sequence number>
Partition number
Sequence number
beectl delete_failed_action_events --bucket MyBucketNumber --sequence MySequenceNumber
The delete_feed_configuration command deletes feed configuration.
beectl delete_feed_configuration { --feed_configuration <feed configuration> | --scope <scope identifier> --feedtype <feed type > }
Collabid of the feed configuration to be modified
Scope in which the feed configuration will be created
Feed type of the feed configuration. Permitted values are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.
beectl delete_feed_configuration --scope enpr=example --feedtype RECENT
beectl delete_feed_configuration --feed_configuration 6790:39AC:afrf:52921E226193384EE040578C5C84269C0000000ABB75
Removes a filesystem reference from Beehive.
beectl delete_filesystem_reference --filesystem_reference_id <Identifier of the filesystem reference>
Identifier of the filesystem reference to delete.
beectl delete_filesystem_reference --filesystem_reference_id fsref=MyFilesystemReference,enpr=MyEnterprise
The delete_group command deletes a group with an option to purge.
beectl delete_group { --group <group_identifier> | --email <group_email> } [ --purge ]
Identifier of the group.
EmailID of the group.
Purges the group after deletion.
beectl delete_group --group grup=MyGroup,enpr=Example
beectl delete_group --group grup=MyGroup,enpr=Example --purge
Delete a remote iSchedule Server configuration.
beectl delete_ischedule_server --name <name>
Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.
beectl delete_ischedule_server --name remoteserver
Deletes an Access Control Entry (ACE) from the Local Access Control List (LACL) of an entity.
beectl delete_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor>
Specify the unique identifier of the entity from which the ACE will be deleted.
Specify the unique identifier of the accessor to whom the access types were applied.
beectl delete_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser
Deletes the specified oc4j.
The command can delete an oc4j only if there are other oc4j instances of the same type. For example any of the oc4j instances BEEAPP, BEEAPP_1, BEEAPP_2 can be deleted however the last remaining oc4j instance of a type cannot be deleted otherwise the active deployment template is violated.
This command can be executed to delete either a local oc4j or a beekeeper home.
beectl delete_oc4j_instance --component <system object id of oc4j>
Deletes the specified oc4j.
beectl delete_oc4j_instance --component 946189a0-bd98-4033-b342-7d51087ccc81
Deletes an existing organization, and sub-organizations and workspaces under it (with --force_cascade option). And/or purges deleted organization manually (with --purge option). Use list_deleted_organizations to get the CENs of deleted organizations.
beectl delete_organization --organization <Organization identifier> [--purge] [--force_cascade]
Organization identifier
Purge deleted organization manually
Force deleting sub-organizations and workspaces under this workspace
beectl delete_organization --organization orgn=test_org,enpr=test_enterprise
Deletes a policy.
beectl delete_policy --policy <identifier of the policy to be deleted>
Specify the identifier of the policy to be deleted. Use the list_policies command to obtain the policy identifier.
beectl delete_policy --policy plcy=MyPolicy,enpr=MyEnterprise
Deletes a policy action.
beectl delete_policy_action --action_name <name of action to be deleted>
Specify the name of the policy action to be deleted.
beectl delete_policy_action --action_name MyActionName
Deletes a policy schema.
beectl delete_policy_schema --policy_schema <identifier of the policy schema to be deleted>
Specify the identifier of the policy schema to be deleted.
beectl delete_policy_schema --policy_schema plsh=PolicySchemaName
Deletes a policy template.
beectl delete_policy_template --policy_template <identifier of the policy template to be deleted>
Specify the identifier of the policy template to be deleted.
beectl delete_policy_template --policy_template plct=PolicyTemplateName,enpr=oracle
The delete_preference_profile command deletes a preference profile.
beectl delete_preference_profile --profile <Preference profile identifier>
Identifier of the preference profile to be deleted.
beectl delete_preference_profile --profile prfp=MyProfile,user=user1
The delete_preference_property command deletes a preference property from a preference set.
beectl delete_preference_property --set <set-identifier> --name <property-name>
Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.
Name of the preference property.
beectl delete_preference_property --set prfs=set1,user=user1 --name MyProperty
The delete_preference_set command deletes a preference set.
beectl delete_preference_set --set <set-identifier>
Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.
beectl delete_preference_set --set prfs=set1,user=user1
Clears the value of specified property in the configuration object identified by specified id.
beectl delete_property --component <system object identifier or alias> --name <property name>
Identifier of a configuration object. The list_components command can be used to lookup the identifier
The property to be cleared.
The command execution shown below would clear the value of Alias property of the current site.
beectl delete_property --component _CURRENT_SITE --name Alias
"user-info">Command:non-record.
beectl delete_record --artifact <identifier of the artifact to be deleted as a record/non-record>
identifier of the artifact to be deleted as a record/non-record
beectl delete_record --artifact myArtifact
Deletes the specified beehive home from central configuration repository.
This command is a safeguard that will allow a beehive instance to be removed from the repository when no other uninstall options are available.
The command can only delete a remote home instance, ie, not the instance the command is being run from.
The command only cleans up the central configuration repository. It neither cleans up the disk/file system for the deleted beehive instance nor updates the oracle inventory on the remote host.
This command can be executed to delete either a non-local beehive home or a beekeeper home. To delete a dmz home please execute the command delete_dmz_home_instance
beectl delete_remote_home_instance --component <system object id of remote home>
Deletes the specified beehive home from central configuration repository.
beectl delete_remote_home_instance --component 946189a0-bd98-4033-b342-7d51087ccc81
Deletes a remote repository.
beectl delete_remote_repository --scope <Remote Repository Container.> --name <Remote Repository Name.>
Remote Repository Container.
Remote Repository Name.
beectl delete_remote_repository --scope myRemoteRepositoryScope --name myRemoteRepositoryName
Deletes a remote share.
beectl delete_remote_share --scope <Remote Share Container.> --name <Remote Share Name.>
Remote Share Container.
Remote Share Name.
beectl delete_remote_share --scope myRemoteShareScope --name myRemoteShareName
Deletes a resource.
beectl delete_resources {--resource <resourceid> | --select_by_name <name>} [--external]
Specify the identifier of the resource. Use list_resources command to obtain the identifier of the resource.
Specify the name criteria of the resource.
Delete an external resource. If this option is not specified, bookable resources will be deleted.
beectl delete_resources --resource 395A:346B:bkrs:2C5F7E98E076D382E040578CA60B0D0E000000062327
Deletes a RoleDefinition entity.
beectl delete_role_definition --role_definition <unique identifier of the RoleDefinition>
Specify the unique identifier of the RoleDefinition to be deleted.
beectl delete_role_definition --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise
Deletes a Sensitivity entity.
beectl delete_sensitivity --sensitivity <unique identifier of the Sensitivity>
Specify the unique identifier of the Sensitivity to be deleted.
beectl delete_sensitivity --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise
Deletes an Access Control Entry (ACE) from the Sensitivity Access Control List (SACL) of a Sensitivity entity.
beectl delete_sensitivity_ace --sensitivity <unique identifier of the Sensitivity> --accessor <unique identifier of the Accessor>
Specify the unique identifier of the Sensitivity from which the ACE will be deleted.
Specify the unique identifier of the accessor to whom the access types were applied.
beectl delete_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser
This command unregisters a trusted identity. If the type of identity is not specified, it is defaulted to WSSEC.
beectl delete_trusted_identity [--type WSSEC --service_name <Trusted Identity Name>] [--type S2S --service_name <Trusted Identity Name>] [--type SES --name <Trusted Entity Name>]
String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
String value representing the name of the SES trusted entity.
The delete_user command deletes a user with an option to purge.
beectl delete_user { --user <user_identifier> | --email <user_email> } [ --purge ]
Identifier of the user. When purging an already deleted user, the user must be specified in id format. The value in id format can be determined by running list_users command as: list_users --attribute_name STATUS --attribute_type ATTRIBUTE --attribute_value DELETED --entity_format id.
EmailID of the user.
Purges the user after deletion.
beectl delete_user --user user=user1
beectl delete_user --user user=user1 --purge
Deletes a given version configuration.
beectl delete_version_configuration --configuration <Configuration identifier>
Version configuration to be deleted.
beectl delete_version_configuration --configuration 9941:2345:avcg:58D193D162CE4ED89FF66AB4E55745B6345464545453
Deletes specified virus scan engine from the collection of engines configured for the Site. If this is the last scan engine being deleted, this command will also delete the virus scan engine collection and update the Site to remove the virus scan engine collection from it. Either the scan_engine option or the hostname and port options will need to be specified.
beectl delete_virus_scan_engine { --scan_engine <scanengine_systemid> | { --hostname <scanengine_hostname> --port <scanengine_port> }}
Identifier of the scan engine to be deleted.
Name of the host where the virus scan engine is installed.
Port number used by the virus scan engine for communication with its clients.
<beectl delete_virus_scan_engine --scan_engine 12345>
<beectl delete_virus_scan_engine --hostname scanenginehost.example.com --port 1344>
Deletes virus scan results from the system that match the specified criteria. Option scandate cannot be specified with options scandate_from or scandate_to.
beectl delete_virus_scan_results [ [ --scandate <scandate> ] | [ --scandate_from <scandate_from> ] [ --scandate_to <scandate_to> ] ] [ --virus_name <virus_name> ] [ --virus_id <virus_id> ] [ --entity_type <entity_type> ] [ --obsolete_only <true/false> ]
Value specified will be used to do an exact match with the scan date attribute of the scan results.
Value specified will be used as the lower inclusive bound for matching with the scan date.
Value specified will be used as the upper inclusive bound for matching with the scan date.
Value specified will be used to do an exact match with the virus name attribute of the scan results.
Value specified will be used to do an exact match with the virus id attribute of the scan results.
Value specified will be used to pick up only the scan results for the entered entity type.
This option returns matches found for the specified criteria only for those entities that are obsolete, i.e. these entities no longer exists in the system.
<beectl delete_virus_scan_results --scandate_from 2008-07-10T00:00:00 --scandate_to 2008-07-10T23:59:59>
Removes specific rules or all rules for a given group collabid. To remove specific rules, then the list the rules to remove in the parameter options. To remove all rules only specify the collabid
beectl delete_voice_facility --group_collabid <group_collabid> [--include <phone rules>] [--exclude <phone rules>]
The collabid of the Group to have all of its rules deleted.
The collection of inclusion phone number rules to remove from the given facility. The rules are delimited by pipes.
The collection of exclusion phone number rules to remove from the given facility. The rules are delimited by pipes.
beectl delete_voice_facility --group_collabid grup=GroupName,enpr=MyEnterprise --include 1312???????|1713??????? --exclude 13129??????|17139??????
This command is used to delete an xmpp chat room by name (if it exists, else it is a NOOP) specified by the --roomname option. Room-names are case insensitive. This command can also be used to delete those xmpp chat rooms which have not been accessed for a period of days specified by the --olderthan option.
beectl delete_xmpp_chat_rooms [--olderthan|--roomname] <Number of days/Room Name>
Number of days/Room Name
Number of days/Room Name
beectl delete_xmpp_chat_rooms --olderthan 60 OR beectl delete_xmpp_chat_rooms --roomname "Oracle Beehive Rocks"
Downloads the logs for a device. This command can either download all log files for a device or all log files for a given application on the device or a particular log file.
beectl download_device_logs --dest_dir <destination directory> {--device_log <identifier of the device log> | --device <identifier of the device> {--all|--application_name <name of the application> [--log_file_name <name of the log file>]}}
Specify the full path of the destination directory. The directory must already exist.
Specify the identifier of the device log. Use list_device_logs command to determine the identifier of the device log.
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
Specify this option to download all the log files for this device.
Application Name
Log File Name
beectl download_device_logs --dest_dir /tmp --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --application_name MobileMail --log_file_name log.txt
Generates a team workspace template from the given team workspace
beectl download_generated_team_workspace_template --workspace <Workspace identifier> --file <Full path of the template file>
Workspace identifier
Full path of the input file
beectl download_generated_team_workspace_template --workspace wksp=test_team_ws,enpr=test_enterprise --file /tmp/template_attributes_and_selective_generation_options.xml
Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options.
beectl download_language_pack [ --full ] [ --only_built_in ] [ --only_custom ] [ --include_class_files ] [ --destination_file <dest_file> ] [ --destination_directory <dest_dir> ] [ --base_name <base_name> ] [ --locale <locale> ]
include everything; other options are silently ignored.
include built-in xliff file versions.
include custom xliff file versions.
include jar of internal classes used by runtime.
output destination file; directory extension should be provided, zip/jar recommended; the file must not exist.
output destination directory; may exist; must not be used with --dest-file.
include xliff with this base name; may be repeated; if omitted all base names are implicitly included.
include this locale for all base names; if omitted all locales are implicitly included.
beectl download_language_pack --full --destination_directory "/tmp" --base_name "oracle.beehive.core.util" --locale "en_us"
The download_ldap_group_data command downloads groups information for an external directory into an XML file. The generated XML file can be used with add_group command to create the groups.
beectl download_ldap_group_data --file <filename> --profile <profile-name>
Name of the file to be created with group information in xml format.
Name of the directory profile.
beectl download_ldap_group_data --file Groups.xml --profile MyDirectoryProfile
The download_ldap_user_data command downloads user information for an external directory into an XML file. The generated XML file can be used with add_users command to create the users.
beectl download_ldap_user_data --file <filename> --profile <profile-name>
Name of the file to be created with user information in xml format.
Name of the directory profile.
beectl download_ldap_user_data --file Users.xml --profile MyDirectoryProfile
Downloads SyncML messages.
beectl download_syncml_messages --directory <directory> --date <yyyy-MM-DD> [ --id <id> | --user_id <user_id>]
Specify the full path of the output destination directory. The directory must exist within the same server environment used by the Management Service.
Specify the date of data to download. Use the YYYY-MM-DD format.
Specify the server side synchronization session ID of data to download.
Specify the server side synchronization session ID of data to download.
beectl download_syncml_messages --directory /syncml_messages --date 2006-10-12 --id 105
Downloads SyncML messages.
beectl download_syncml_sessions --file <file> --date <yyyy-MM-DD> [ --id <id> | --user_id <user_id>]
Specify output destination file. The file will be created within the same server environment used by the Management Service.
Specify the date of data to download. Use the YYYY-MM-DD format.
Specify the server side synchronization session ID of data to download.
Specify the server side synchronization session ID of data to download.
beectl download_syncml_sessions --file /syncml_sessions.log --date 2006-10-12 --id 105
Downloads workspace template XML schema to a file
beectl download_workspace_template_schema [--file <Full path of the output file>]
Full path of the output file
beectl download_workspace_template_schema --file /tmp/schema.xsd
Exports an existing audit trail by the given identifier
beectl export_audit_trail --trail <Audit trail identifier> --file <Full path of the output file>
Audit trail identifier
Full path name of the export file
beectl export_audit_trail --trail autr=MyAuditTrail --file /tmp/trail.xml
Exports a client application configuration to a local file.
beectl export_client_application_configuration --configuration <client application configuration identifier> --file <destination file>
Specify the identifier of the client application configuration.
Specify the full path and file name. Oracle recommends using a .xml extension. If the file already exists, it will be overwritten.
beectl export_client_application_configuration --configuration 1234:5678:capc:1234567890123456789012 --file /tmp/client-app-config.xml
Exports configuration data for given configuration version.
beectl export_configuration_data --file <output dir> [--configuration_version <required version>] [--verbose] [--no_null_values] [--no_large_values] [--no_binary_values] [--validate_output] [--only_custom_values]
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
Xml output file in which data will be dumped.
If specified, all metadata information about the property will be printed.
If specified, null or empty values will not be printed.
If specified, large string data will not be printed.
If specified, binary data will not be printed.
If specified, properties which do not have same value as their initial/default values,will be printed.
Validates the generated output file.
beectl export_configuration_data --verbose --no_large_values --no_binary_values --no_null_values --validate_output
It transforms the generated xml into html output file avaialable at the same location as of the xml.
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
Export all email data to a file
beectl export_email_data --user_name <user name> --file <file name>
The authentication ID of the user to be exported/imported.
The file name of the file that holds the exported email data.
beectl export_email_data --user_name user1 --file user1.dat
Search for occurrences of error codes
beectl export_errorcodes [--start <DATE_TIME>] [--end <DATE_TIME>] [--errorcode <STRING> ... |--exclude_errorcode <STRING> ... ] [--severity <string>] [--text <string>] [--max_results <INTEGER>] [--display_exception_stack] [--attribute <key>:<value> ... ] [--display_columns <STRING_LIST>] [--from_logs] beectl export_errorcodes --get_count_service_by_ec <STRING> beectl export_errorcodes --get_count_ec_by_service <STRING>
Start of time range
End time range
Specific error codes to query for
Specific error codes to not search for
Minimum severity to restrict to
Text in Exception stack or metadata parameters to search for
Maximum number of results to return
Should the Exception stack be printed
Comma separated list of columns to be displayed. Valid values are [service, messageid, displayname, severity, cause, effect, action, timestamp, exception_stack, ecid, service_inst_id, ctx_map]
Execution Context ID
System object identifier or alias of either Service Instance or Oc4j.
Service instance ID to get error code counts from, or all to aggregate over all service instances.
Error code to get counts from, or all to aggregate over all error codes.
Query the logs instead of the database.
Search for one of the following attributes: bee_compid, bee_compname, bee_vthreadid, bee_principalid, bee_logonrecid.
beectl export_errorcodes --start 2007-10-10T06:00:00 --end 2007-10-10T08:00:00 --errorcode BEEU-10364
Search for all instances of BEEU-10364 between 6AM and 8AM on October 10, 2007.
beectl export_errorcodes --start 2007-10-10T06:00:00 --severity WARNING --text 'QuotaException' --exclude_errorcode BEES-37968
Search for all all error codes reported since 6AM on October 10, 2007
with severity at least warning and 'QuotaException' in any parameters passed to the error codes except for BEES-37968.
beectl export_errorcodes --errorcode BEES-38216 --display_columns timestamp,cause,action,exception_stack
Search for all instances of error code BEES-38216, and display the timestamp, cause, action, and exception stack.
beectl export_errorcodes --get_count_service_by_ec b94885f7-2876-4d95-90aa-76a060875ac6
Get counts of error code occurrences in service instance b94885f7-2876-4d95-90aa-76a060875ac6, by error code.
beectl export_errorcodes --get_count_ec_by_service BEEU-00822
Get counts of error code occurrences of type BEEU-00822, by service.
Search log files stored on host machines.
beectl export_filesystem_logs --search_string <string> [--maximum_results <int>] [--file_name_filter <string>] [--host_name_filter <string>] [--beehive_home_filter <string>] [--output_target <string>] [--output_format <string>] [--display_source <true|false>] [--display_original_copy <true|false>] [--columns <string_list>] [--log_analysis <true|false>] [--report_time_range <string>] [--report_message_type <string>] [--analysis_field <string_list>] [--get_latest <true|false>] [--local_search <true|false>] [--log_root <string>] [--order_by <string>] [--sort <string>] [--search_string_file_name <string>] [--display_ignored_summary_only <true|false>]
A search string is composed of a single or a combination of search conditions. A search condition has a field name (e.g. user_id='janedoe'), an operation type (e.g. op='contains') and condition oprands (!, &&, ||). The brackets "()" are used to group search conditions together. Valid search field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MSG_LEVEL | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | SUPPL_ATTRS | SUPPL_ATTR.NAME | SUPPL_ATTR.VALUE | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | EXEC_CONTEXT_SEQ | ERROR_UNIQUE_ID | ERROR_SEQ | MSG_TEXT | MSG_ARGS | NAME | VALUE | DETAIL_PATH | SUPPL_DETAIL | TSTZ_ORIGINATING | TSTZ_NORMALIZED | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_COMPNAME | BEE_PRINCIPALID | BEE_LOGONRECID | BEE_VTHREADID | ATTRIBUTE_VALUE_TO_PRINCIPAL_ID | LOGIN_ID_TO_PRINCIPAL_ID>. Valid operation types are: <EQUALS | CONTAINS | STARTS_WITH | EQUALS_IGNORE_CASE | CONTAINS_IGNORE_CASE | STARTS_WITH_IGNORE_CASE | MATCHES | MATCHES_IGNORE_CASE>. Note: The search string must be enclosed in a pair of double-quotes and \ must be used to escape ! operand. Time stamp query condition can contain two values separated by a comma. Query fields ATTRIBUTE_VALUE_TO_PRINCIPAL_ID and LOGIN_ID_TO_PRINCIPAL_ID are special cases. Field ATTRIBUTE_VALUE_TO_PRINCIPAL_ID works with four operation types: <equals | contains | beginsWith | endsWith> and the search operation is always case-insensitive. But the operation type is not applicable to field LOGIN_ID_TO_PRINCIPAL_ID and any operation type specified for it will be ignored. Those fields are used to match corresponding BEE_PRINCIPAL_ID. Then the matched BEE_PRINCIPAL_ID will be used for the subsequent search with operation type <EQUALS_IGNORE_CASE> only.
Maximum number of returned records. It tops out at 1,000, if the output_target is screen, otherwise there is no limit.
A file name filter is used to speed up searches. Use a comma to separate multiple values and a prefix # to specify excluding. Note: the prefix # is applied to all the values following it.
A host name filter is used to speed up searches. Use a comma to separate multiple values and a prefix # to specify excluding. Note: the prefix # is applied to all the values following it.
A beehive home filter is used to speed up searches. Use a comma to separate multiple values and a prefix # to specify excluding. Note: the prefix # is applied to all the values following it.
Specify if direct the output to the screen or to a file.
Specify output format. Supported formats are ODL-Text and XML.
Default to false. Specify if display the name of the log file source for the returned record.
Default to false. Specify if display the original copy for the returned record.
Default is to display all the log record fields. Restrict to display only specified fields. Valid field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | SUPPL_ATTRS | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | MSG_TEXT | MSG_ARGS | DETAIL_PATH | SUPPL_DETAIL | TSTZ_ORIGINATING | TSTZ_NORMALIZED | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>. Note: field TSTZ_ORIGINATING will always be displayed.
Default to false. Specify if choose to do the log analysis.
Specify the desired time range for log analysis report. Only apply when option log_analysis is true.
Specify the desired message type of the unique message count for log analysis report. Only apply when option log_analysis is true.
Specify the desired unique count analysis field. Valid field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_GROUP | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | MSG_TEXT | DETAIL_PATH | SUPPL_DETAIL | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_COMPNAME | BEE_PRINCIPALID | BEE_LOGONRECID | BEE_VTHREADID>
Default to false. Specify if choose to get the latest log record.
Valid order-by column names are: <TSTZ_ORIGINATING | TSTZ_NORMALIZED | ORG_ID | COMPONENT_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | HOST_ID | HOST_NWADDR | MODULE_ID | PROCESS_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | THREAD_ID | INSTANCE_ID | MSG_TEXT | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>.
The query result set can be sorted in ascending or descending order.
Default to false. Specify if choose to search log files on the local machine only. Only work when the log_root option is also specified.
Specify the log file root for local_search option.
Specify the search string file name, a convenient way to enter multiple search strings. The format is one string per line. Valid only when the log_analysis option is true.
--display_ignored_summary_only
_PRINCIPAL_ID and LOGIN_IDif choose to display ignored summary only. Valid only when the log_analysis option is true.
beectl export_filesystem_logs --search_string "((user_id='janedoe'||user_id='johndoe')&&\!component_id='j2ee')&&(msg_text='esb_console' op='contains')"
beectl export_filesystem_logs --search_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00,2007-05-31T17:08:15.639-07:00')"
beectl export_filesystem_logs --search_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00')" --maximum_results 10
beectl export_filesystem_logs --search_string "(user_id='janedoe'&&module_id='security.oc4j')" --file_name_filter beeapp/log.txt,beemgmt --host_name_filter #some-host-name,some-other-host-name --beehive_home_filter /root/dir/product/1.0.6.1.0/beehive_119 --output_target /tmp/temp.log --output_format xml --maximum_results 16
beectl export_filesystem_logs --log_analysis --report_time_range 2880 --local_search --log_root log_root/some_log_directory
Export invitations and assignments from a calendar and/or tasklist to an iCalendar file.
beectl export_icalendar --file <file> [--overwrite] [--charset <charset>] { --do_as <unique_identifier> | --do_as_address <uri> | --do_as_authuser <authuser> } [{ --calendar <unique_identifier> | --nocalendar }] [{ --tasklist <unique_identifier> | --notasklist }] [--filter_uid <icalendar_uid>] [--filter_organizer <uri>] [--filter_timerange_start <date-time>] [--filter_timerange_end <date-time>] [--removeicalname <canonical_ical_name>] [--authuser <authuser> --authpassword <password>] [--obfuscated]
Specify the full path and name of the iCalendar file to export.
Specify this option to overwrite the iCalendar export file if it already exists.
Specify the charset that is to be used in the iCalendar file that is being exported (http://www.iana.org/assignments/character-sets).
Specify the unique identifier of the user or resource performing the action.
Specify the Uniform Resource Identifie (URI) of the user or resource performing the action.
Specify the login name of the user performing the action.
Specify the unique identifier of the source calendar, the default calendar of the "do_as" entity will be used if nothing is specified.
Specify the unique identifier of the source tasklist, the default tasklist of the "do_as" entity will be used if nothing is specified.
Specify a iCalendar UID. This will filter the export to include only invitations and assignments matching the iCalendar UID.
Specify an organizer URI. This will filter the export to include only invitations and assignments matching the organizer.
Specify a start date. This will filter the export to include only invitations and assignments after the specified date.
Specify an end date. This will filter the export to include only invitations and assignments before the specified date.
Do not export from a calendar (VEVENT components will not be exported).
Do not export from a tasklist (VTODO components will not be exported).
Remove canonical ical names such as VCALENDAR.VEVENT.VALARM, VCALENDAR.VEVENT.ORGANIZER.
beectl export_icalendar --file file.ics --do_as_address user@example.com --filter_timerange_start 2007-01-01T01:01:01Z --filter_timerange_end 2007-02-01T01:01:01Z
With an option of refreshing the repository first, query the repository to get relevant log records from log files stored on host machines.
beectl export_logs {{ --query_string <string> [ --refresh_repository <true> ]} | --refresh_repository <true> } [--order_by <string>] [--sort <string>] [--columns <string_list>] [--output_target <string>] [--output_format <string>] [--display_source <true|false>] [--maximum_results <int>]
Mandatory if option "refresh_repository" is not specified. A query string is composed of a single or a combination of query conditions. A query condition has a field name (e.g. user_id='janedoe'), an operation type (e.g. op='contains') and condition oprands (!, &&, ||). The brackets "()" are used to group query conditions together. Valid query field names are: <TSTZ_ORIGINATING | TSTZ_NORMALIZED | ORG_ID | COMPONENT_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MSG_LEVEL | HOST_ID | HOST_NWADDR | MODULE_ID | PROCESS_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | THREAD_ID | INSTANCE_ID | MSG_TEXT | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID | ATTRIBUTE_VALUE_TO_PRINCIPAL_ID | LOGIN_ID_TO_PRINCIPAL_ID>. Valid operation types are: <EQUALS | CONTAINS | STARTS_WITH | EQUALS_IGNORE_CASE | CONTAINS_IGNORE_CASE | STARTS_WITH_IGNORE_CASE | MATCHES | MATCHES_IGNORE_CASE>Note: The query string must be enclosed in a pair of double-quotes and \ must be used to escape ! operand. Time stamp query condition can contain two values separated by a comma. Query fields ATTRIBUTE_VALUE_TO_ PRINCIPAL_ID and LOGIN_ID_TO_PRINCIPAL_ID are special cases. Field ATTRIBUTE_VALUE_TO_PRINCIPAL_ID works with four operation types: <equals | contains | beginsWith | endsWith> and the search operation is always case-insensitive. But the operation type is not applicable to field LOGIN_ID_TO_PRINCIPAL_ID and any operation type specified for it will be ignored. Those fields are used to match corresponding BEE_PRINCIPAL_ID. Then the matched BEE_PRINCIPAL_ID will be used for the subsequent query with operation type <EQUALS> only.
Mandatory if option "query_string" is not specified. Force an upload of all the log files to refresh the repository.
Valid order-by column names are: <TSTZ_ORIGINATING | TSTZ_NORMALIZED | ORG_ID | COMPONENT_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MSG_LEVEL | HOST_ID | HOST_NWADDR | MODULE_ID | PROCESS_ID | USER_ID | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | THREAD_ID | INSTANCE_ID | MSG_TEXT | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>.
The query result set can be sorted in ascending or descending order.
Default is to display all the log record fields. Restrict to display only specified fields. Valid field names are: <ORG_ID | COMPONENT_ID | INSTANCE_ID | MSG_ID | HOSTING_CLIENT_ID | MSG_TYPE | MSG_GROUP | MODULE_ID | PROCESS_ID | THREAD_ID | USER_ID | SUPPL_ATTRS | UPSTREAM_COMPONENT_ID | DOWNSTREAM_COMPONENT_ID | EXEC_CONTEXT_UNIQUE_ID | ERROR_UNIQUE_ID | MSG_TEXT | MSG_ARGS | DETAIL_PATH | SUPPL_DETAIL | TSTZ_ORIGINATING | TSTZ_NORMALIZED | HOST_ID | HOST_NWADDR | PROB_KEY | BEE_COMPID | BEE_PRINCIPALID | BEE_COMPNAME | BEE_LOGONRECID | BEE_VTHREADID>. Note: field TSTZ_ORIGINATING will always be displayed.
Specify if direct the output to the screen or to a file.
Specify output format. Supported formats are ODL-Text and XML.
Default to false. Specify if display the name of the log file source for the returned record.
Maximum number of returned records.
beectl export_logs --refresh_repository true
beectl export_logs --query_string "((user_id='janedoe'||user_id='johndoe')&&\!component_id='j2ee')&&(msg_text='esb_console' op='contains')"
beectl export_logs --query_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00,2007-05-31T17:08:15.639-07:00')"
beectl export_logs --query_string "(TSTZ_ORIGINATING='2007-05-31T17:06:45.620-07:00')" --maximum_results 10
beectl export_logs --query_string "(user_id='janedoe'&&module_id='security.oc4j')" --order_by THREAD_ID --sort descending --columns MODULE_ID --columns USER_ID --columns USER_ID --columns MSG_TEXT --columns THREAD_ID --output_target /tmp/temp.log --output_format xml --display_source true --maximum_results 10
Exports policy data into an XML file.
beectl export_policy --policy_name <name of the policy to export> --scope <identifier of the container where the policy is defined> --destination <destination directory where the XML file will be exported>
Specify the name of the policy to export.
Specify the policy container identifier.
Specify the destination directory for the XML file.
beectl export_policy --policy_name MyPolicy --scope enpr=MyEnterprise --destination /private
Lists all probe information in beehive.
beectl export_probes
ID of a Probe to get detailed information about
Get Summary
Start time to search for probes
End time to search for probes
Service instance names to search for
Calling class
Thread ID
Thread Rep
Transaction Context
User context
beectl export_probes
Lists all probe information in beehive.
Exports workspace contents into an external directory.
beectl export_workspace --workspace <Workspace identifier> --output_dir <Output directory> [--log_file <The log file where the results will be printed. If none is specified, the log file will be located in the output directory, and will be called export-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name export-log-(timestamp).>]
Workspace identifier
Output directory
The log file where the results will be printed. If none is specified, the log file will be located in the output directory, and will be called export-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name export-log-(timestamp).
beectl export_workspace --workspace wksp=test_team_ws,orgn=test_org,enpr=test_enterprise --output_dir /scratch/export/wspc --log_file /tmp/export.log
Import data from the coexisting remote system for a given user.
beectl import_coexistence_data {--user <user_cen> | --email <user_email> } --data_type <type> [--data_type <type> ...] [--timerange_start <start>] [--relative_timerange_start <relative_start>] [--timerange_end <end>] [--relative_timerange_end <relative_end>] [--modified_since <modified_since>] beectl import_coexistence_data --generate_refresh_import_commands --generated_file <file> [--system_affinity <system_name>]
Specify the identifier of the user.
Specify the email address of the user.
Type of data to import. Must be one of: MEETING, TASK.
Start date time of import time range.
Start time of import time range specified by number of days relative to current time (eg. -30)
End date time of import time range.
End time of import time range specified by number of days relative to current time (eg. 90)
Import only entries that have been modified since the specified date.
--generate_refresh_import_commands
Generate the import commands to import all newer entries of coexisting remote users using a [-14 days, INFINITY] date range. This is required after converting profiles to accessible_by beehive. The generated command file can be used with beectl --batchfile.
Specify the generated output file. This file is generated only when generate_refresh_import_commands option is selected and will hold the newly generated coexistence_data_import commands.
Specify the name of the coexisting remote system.
beectl import_coexistence_data --user user=user_loginid --data_type TASK --data_type MEETING --relative_timerange_start=-90 --relative_timerange_end 90
beectl import_coexistence_data --email user@example.com --data_type MEETING --timerange_start 2007-10-01T12:00:00Z --timerange_end NOW
beectl import_coexistence_data --user user=user_loginid --data_type MEETING --timerange_start=-INFINITY --timerange_end INFINITY
beectl import_coexistence_data --generate_refresh_import_commands --generated_file outfile.beectl
Imports documents into Beehive from files on the server without copying the file content. Data on the server files will be treated as read-only; should an imported document be edited in Beehive, a copy of the content will be made at that time.
beectl import_documents --filesystem_reference <Identifier of the filesystem reference> --folder_path <Folder path> [ --name_filter <Name filter> ] [ --conflict_resolution_mode <ABORT, OVERWRITE, or CREATE_UNIQUE> ]
Identifier of the filesystem reference to import from.
Full path of the Beehive folder to import to. E.g. /MyEnterprise/MyOrganization/MyWorkspace/Documents/MyFolder would import to MyFolder.
(Optional) Filter to use for choosing which documents to import. Syntax is equivalent to SQL LIKE. E.g. 'file%' would import file1, file2.txt, but not my_file. If not specified, defaults to '%', which includes all documents.
(Optional) How to handle naming conflicts between existing Beehive documents and new documents being imported. ABORT will avoid creating the conflicting document, OVERWRITE will overwrite the conflicting document, and CREATE_UNIQUE will create a unique name for the imported document. If not specified, defaults to CREATE_UNIQUE.
beectl import_documents --filesystem_reference fsref=MyFilesystemReference,enpr=MyEnterprise --folder_path /MyEnterprise/MyOrganization/MyWorkspace/Documents/MyFolder --name_filter %.txt --conflict_resolution_mode CREATE_UNIQUE
Import email data from a file created by export command into a given folder
beectl import_email_data --user_name <user name> --folder <folder name> --file <file name>
The authentication ID of the user to be exported/imported.
The relative folder path (from the workspace level) of the folder to hold all the imported data.
The file name of the file that holds the exported email data.
beectl import_email_data --user_name user1 --folder Archive/backup1 --file user1.dat
Import an iCalendar file to an existing calendar and/or tasklist. If an iCalendarObject has a UID that already exists in the destination calendar and/or tasklist it will be re-created. VCALENDAR components can have many VEVENT and VTODO sub-components with different UIDs but sub-components of the same UID must be consecutive. A VCALENDAR component imported with a METHOD:X-ORACLE-DELETE or METHOD:CANCEL will cause all sub-components to be deleted.
beectl import_icalendar --file <file> [--charset <charset>] { --do_as <unique_identifier> | --do_as_address <uri> | --do_as_authuser <authuser> } [--continue_on_error] [{ --calendar <unique_identifier> | --nocalendar }] [{ --tasklist <unique_identifier> | --notasklist }] [--authuser <authuser> --authpassword <password>] [--obfuscated] [--holiday] [--migration [--reconciliation]] [--removeicalname <canonical_ical_name>]
Specify the full path and name of the iCalendar file to import.
Specify the charset that is used in the iCalendar file that is being imported (http://www.iana.org/assignments/character-sets).
Specify the unique identifier of the user or resource performing the action.
Specify the Uniform Resource Identifie (URI) of the user or resource performing the action.
Specify the login name of the user performing the action.
Force the tool to continue the import even if some of the iCalendar objects fail to be imported.
Specify the unique identifier of the destination calendar, the default calendar of the "do_as" entity will be used if nothing is specified.
Specify the unique identifier of the destination tasklist, the default tasklist of the "do_as" entity will be used if nothing is specified.
Do not import to a calendar (Discard VEVENT components).
Do not import to a tasklist (Discard VTODO components).
All events imported in a team workspace will be imported as Holiday events.
Specify that all the iCalendar file will be imported in the context of a migration. The participation status of all users can be set by the importer and a limited number of beehive events will be raised.
Specify that a reconciliation should be done for existing meetings attended by the user before he was created in the system, this option can only be used if --migration is used.
Remove canonical ical names such as VCALENDAR.VEVENT.VALARM, VCALENDAR.VEVENT.ORGANIZER.
beectl import_icalendar --file file.ics --do_as_address user@example.com
Imports time zone definitions to the database.
beectl import_timezones --file <absolute path of tzInfoPkg.xml>
Spcify the full path and file name of the time zone definition file (tzInfoPkg.xml).
beectl import_timezones --file $ORACLE_HOME/beehive/seed/tm/tzInfoPkg.xml
Imports contents of an external directory into a new team workspace.
beectl import_workspace --input_dir <Input directory> --scope <The scope under which the workspace will be created.> [--log_file <The log file where the results will be printed. If none is specified, the log file will be located in the input directory, and will be called import-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name import-log-(timestamp).>] [--auto_name_resolution <Automatic workspace name conflict resolution.>] [--keep_original_owner <Whether to keep the workspace's original owner.>] [--import_members <Whether to import members.>] [--add_connected_user <Whether to add the connected user to the new workspace.>] [--new_owner <New owner>]
Input directory
The scope under which the workspace will be created.
The log file where the results will be printed. If none is specified, the log file will be located in the input directory, and will be called import-log-(timestamp). This option can be either the path to a logfile or the path to a directory. If the latter, the log file will be created under the directory with the default name import-log-(timestamp).
Automatic workspace name conflict resolution.
Whether to keep the workspace's original owner.
Whether to import members.
Whether to add the connected user to the new workspace.
New owner
beectl import_workspace --input_dir /scratch/import/wspc --scope orgn=test_org,enpr=test_enterprise --log_file /tmp/import.log --auto_name_resolution false --keep_original_owner false --import_members false --add_connected_user true --new_owner user=beeadmin
Lists the AccessControlFields of an entity.
beectl list_access_control_fields --entity <unique identifier of the entity>
Specify the unique identifier of the entity for which the AccessControlFields should be listed.
beectl list_access_control_fields --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise
Lists available access type names and identifiers.
beectl list_access_types
This command has no options
beectl list_access_types
Lists the workspace templates that have been applied to this workspace. For each applied template it indicates whether this workspace is a template evolution target.
beectl list_applied_workspace_templates --workspace <Workspace identifier>
Workspace identifier
beectl list_applied_workspace_templates --workspace wksp=test_team_ws,enpr=test_enterprise
Lists AssignedRole entities.
beectl list_assigned_roles [--scope <unique identifier of the Scope>] [--name <like string>] [--role_definition <like string>]
Specify the unique identifier of the Scope of the AssignedRoles to be listed. If not specified the Scope will be the Enterprise.
Specify the name pattern for the AssignedRoles to be listed. If not specified all accessible AssignedRoles will be returned.
Specify the name pattern for the RoleDefinitions of the AssignedRoles to be listed. If not specified any corresponding RoleDefinition is allowed for the returned AssignedRoles.
beectl list_assigned_roles --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole
Prints the Auto Attendant Markup Language for an auto attendant.
beectl list_attendant_aaml --name <attendant name>
Name of the attendant to be displayed.
beectl list_attendant_aaml --name myAttendant
Lists all prompts that have been uploaded for an attendant.
beectl list_attendant_prompts --name <attendant name>
Name of the attendant for which to display prompts.
beectl list_attendant_prompts --name my_attendant
Lists all attendants in the system.
beectl list_attendants
This command has no options
beectl list_attendants
Lists audit policies and prints policy information
beectl list_audit_policies [--name <Name of the audit policy>] [--policy <Audit policy identifier>] [--detail]
Name of the audit policy
Audit policy identifier
Detail toggle
beectl list_audit_policies --name MyPolicy
beectl list_audit_policies --name MyPolicy --detail
beectl list_audit_policies --policy MyPolicy
beectl list_audit_policies --policy plcy=MyPolicy --detail
Lists audit trails and prints trail information
beectl list_audit_trails [--name <Name of the audit trail>] [--4} <Name of the audit trail>]
Name of the audit trail
Audit trail identifier
beectl list_audit_trails --name MyAuditTrail
beectl list_audit_trails --trail audt=MyAuditTrail
Displays bootstrap configuration for local midtier.
beectl list_bootstrap_configuration
This command has no options
beectl list_bootstrap_configuration
List the directly enrolled and directly unenrolled members of the specified team workspace calendar.
beectl list_calendar_enrollments { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_workspace_name <workspace_name> }
Specify the unique identifier of a calendar.
Specify the unique identifier of a team workspace.
Specify the Uniform Resource Identifier (URI) of a team workspace using the format '[scheme:]value'. If scheme is not supplied, mailto will be used.
Specify the name of a team workspace.
beectl list_calendar_enrollments --select_by_address teamworkspace@example.com
List the access control permissions of a user, resource or workspace's calendar. When multiple calendars match the selection criteria for the user, resource or workspace, the default calendar will be used.
beectl list_calendar_permissions { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> }
Specify the unique identifier of a calendar.
Specify the unique identifier of a user, resource or workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
beectl list_calendar_permissions --select_by_address user@example.com
Lists the existing calendars of a user, resource or workspace.
beectl list_calendars { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [ --show <DEFAULT | ALL | MORE>]
Specify the unique identifier of a calendar.
Specify the unique identifier of a user, resource or workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
Lists some or all of the attributes of the calendar. Valid values are DEFAULT, ALL or MORE. If nothing (or DEFAULT) is specified the default important attributes are listed.
beectl list_calendars --select_by_address user@example.com
Lists the categories in the enterprise.If the recurse option is used then sub-categories are also listed.
beectl list_categories --recurse <Y/N> --parent_category <Identifier of the parent category> --output_format <XML>
Control the categories that are returned. Use the Y argument with this option to return all categories in an enterprise. Use the N argument with this option to return only root level categories.
Unique Identifier for Parent Category.
If 'XML' the output is sent as xml to standard out else its printed as table on standard output.
beectl list_categories --recurse Y --parent_category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent
beectl list_categories --recurse Y --parent_category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent --output_format XML
Prints information about a category given a category identifier
beectl list_category --category <Identifier of the category to be listed>
Specify the identifier of the category.
beectl list_category --category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent
List all the categories (and associated attributes) applied to a specific entity. Lists the application of a specific category to the entity if the [category] parameter is provided.
beectl list_category_applications --entity <entity id> --category <category id>
Identifier of the entity for which applied categories should be listed.
Identifier of a specific category whose application should be listed.
beectl list_category_applications --entity wksp=Example_Team_Workspace,enpr=Oracle
beectl list_category_applications --entity wksp=Example_Team_Workspace,enpr=Oracle --category catg=TechnicalDocuments,enpr=Oracle
Lists the category configuration on the given scope or heterogenous folder.
beectl list_category_configuration --container <Configuration scope or heterogenous folder>
Scope or heterogenous folder on which the category configuration should be listed.
beectl list_category_configuration --container orgn=MyOrganization,enpr=MyEnterprise
Lists the client application configurations.
beectl list_client_application_configuration {--configuration <client application configuration identifier >|--community <community identifier>}
Specify the identifier of the community.
Specify the identifier of the client application configuration.
beectl list_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
beectl list_client_application_configuration --community orgn=myOrg,enpr=myEnterprise
Lists the modules for a given client application patchset.
beectl list_client_application_modules --patchset <identifier of the client application patchset>
Specify the identifier of the client application patchset. {--select_users_without_profile|-ion_patchsets command to determine the identifier of a client application patchset.
beectl list_client_application_modules --patchset 1234:5678:capp:2E0329B0705F0E40E040578C92160957000000000434
Lists the patchsets for a given client application version.
beectl list_client_application_patchsets --application_version <identifier of the client application version>
Specify the identifier of the client application version. Use list_client_application_versions command to determine the identifier of a client application version.
beectl list_client_application_patchsets --application_version 1234:5678:capv:2E0329B0705F0E40E040578C92160957000000000434
Lists all the versions for a given client application.
beectl list_client_application_versions --application <identifier of the client application>
Specify the identifier of the client application. Use list_client_applications command to determine the identifier of the client application.
beectl list_client_application_versions --application 1234:5678:capn:2E0329B0705F0E40E040578C92160957000000000434
Lists all the client applications.
beectl list_client_applications
This command has no options
beectl list_client_applications
Lists the client applications usage report. The command displays the number of devices that have installed a client application.
beectl list_client_applications_usage
This command has no options
beectl list_client_applications_usage
Lists the set of system model properties required for ias cloning scripts.
beectl list_clone_properties
This command has no options
beectl list_clone_properties
Lists all coexistence connectors for a coexisting remote system.
beectl list_coexistence_connectors
Show extra connector details.
Specify the name of the coexisting remote system.
beectl list_coexistence_connectors
Lists the profile of coexisting users.
beectl list_coexistence_profiles [{--user <user_identifier>|--email <user_email> <example_message>beectl list-select_users_with_profile} --file <file_name> }] [--show] [--sort]
Specify the identifier of the user.
Specify the email address of the user.
--select_users_without_profile
List users without a coexistence profile in a XML document.
List users with a coexistence profile in a XML document.
Specify the name of the file in which the list should be outputed.
Specify the details level. Supported values: MORE, ALL.
List coexiting users ordered by their name.
beectl list_coexistence_profiles
beectl list_coexistence_profiles --select_users_without_profile --file users.xml
beectl list_coexistence_profiles --user user=user_loginid --show ALL
Reports the status of the coexisting containers and coexistence profiles.
beectl list_coexistence_status [--calendar] [--tasklist] [--addressbook] [--message_inbox] [--profile]
Lists calendar coexistence status.
Lists task list coexistence status.
Lists address book coexistence status.
Lists message inbox coexistence status.
Lists coexistence profile registration status.
beectl list_coexistence_status
beectl list_coexistence_status --profile
beectl list_coexistence_status --calendar
Lists all coexisting remote systems.
beectl list_coexistence_systems
beectl list_coexistence_systems
Lists all the metadata about given command.
beectl list_command_metadata --command_name <command name>
Command name.
beectl list_command_metadata --command_name list_command_metadata
Lists the command names based on the given criteria.
It also lists all the available categories and actions for easy access. If the command is executed with various options then the result would be command names qualifying for ALL specified criteria rather than ONE OR MORE of the criteria.
beectl list_commands (--display_actions | --display_categories | ( [--action <action name>] [--category <category name> ] [--name <substring of desired command list> ] [--advanced] [--all_visibilities])
Displays all available actions.
Displays all available categories.
Search will be based on given action.
Search will be based on given category. This option can be supplied multiple times.
Command name substring, a regular expression using * or ? can be used as option value. Blank search using * or ? meta characters only is not supported. Though these characters can be used at the end of the pattern. For example, list* is a valid pattern, but *list is not.
Lists advanced visibility data.
Lists general and advanced visibility data.
beectl list_commands --display_actions
ectl-output_commands --display_categories
beectl list_commands --advanced
beectl list_commands --category "users" --category "coexistence" --action LIST
Above example will return all command names having general visibility, categories users, coexistence and action LIST.
beectl list_commands --category "users" --name oc4j
Above example will list all the commands which have "oc4j" in their name.
Specifying Visibility Options: Any of the following options can be used for specific visibility data.
--advanced can be passed to include advanced visibility data.
--all_visibilities can be passed to include general and advanced visibility data.
Lists components in the configuration repository.
If no option is specified, then all the components in the configuration repository will be listed.
When --type <type name> is specified all the components of that type are listed.
When --use_local_home flag is specified, only managed system components from the current ORACLE HOME is returned.
All the property values are assumed to be strings and with that assumption search is performed.
beectl list_components (--display_types |[--type <type name>)] [--use_local_home] [--configuration_version <required version>])
Displays all the valid component types.
Lists all components of given type.
Searches only in the current ORACLE HOME.
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
Lists advanced visibility data.
Lists general and advanced visibility data.
beectl list_components
beectl list_components --type ServiceInstance
Lists all the components of type ServiceInstance.
beectl list_components --display_types
Above example lists all valid component type names.
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
Specifying Visibility Options: Any of the following options can be used for specific visibility data.
--advanced can be passed to include advanced visibility data.
--all_visibilities can be passed to include general and advanced visibility data.
Lists conference-template artifacts under workspace
beectl list_conference_templates --parent <Workspace identifier> --count-limit <A count limit for a list of conference templates>
Workspace identifier
A count limit for a list of conference templates
beectl list_conference_templates --parent wksp=MyWorkspace,enpr=MyEnterprise
Lists conference artifacts under workspace
beectl list_conferences --parent <Workspace identifier> --count-limit <A count limit for a list of conferences>
Workspace identifier
A count limit for a list of conferences
beectl list_conferences --parent wksp=MyWorkspace,enpr=MyEnterprise
Lists all available configuration versions and activation time information
beectl list_configuration_versions [--configuration_version <required version>]
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
beectl list_configuration_versions
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
Lists available connection pools in the system.
beectl list_connection_pools [--configuration_version <required version>]
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
beectl list_connection_pools
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
The list_custom_user_properties command lists all custom properties of users.
beectl list_custom_user_properties
This command has no options
beectl list_custom_user_properties
Lists deleted organizations
beectl list_deleted_organizations
This command has no options
beectl list_deleted_organizations
Lists deleted workspaces
beectl list_deleted_workspaces
This command has no options
beectl list_deleted_workspaces
Lists the available deployment templates in central configuration repository
beectl list_deployment_templates [ --component <component id> ] [--configuration_version <required version>] [--advanced] [--all_visibilities]
Alias or identifier of deployment template configuration object.
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
Lists advanced visibility data.
Lists general and advanced visibility data.
beectl list_deployment_templates
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
Specifying Visibility Options: Any of the following options can be used for specific visibility data.
--advanced can be passed to include advanced visibility data.
--all_visibilities can be passed to include general and advanced visibility data.
Lists the device commands for a given device. The list can be further filtered by specifying the status of the device command.
beectl list_device_commands --device <identifier of the device> [--status <device command status>]
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
Specify the status of the device command. The following are the valid command statuses: PENDING SUCCESS ERROR WARNING
beectl list_device_commands --device 1234:5678:devi:1234567890123456789012 --status PENDING
Lists the device logs for a given device.
beectl list_device_logs --device <identifier of the device>
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
beectl list_device_logs --device 1234:5678:devi:1234567890123456789012
Lists all the device profiles.
beectl list_device_profiles
This command has no options
beectl list_device_profiles
Lists all the device types.
beectl list_device_types
This command has no options
beectl list_device_types
Lists the devices either belonging to a user or with the specified device status.
beectl list_devices {--user <identifier of the user>|--status <device status>} [--count_limit <count limit>]
Specify the identifier of the user owning the device. Use list_users command to determine the identifier of a user.
Specify the status of the device. The following are the valid device statuses: ACTIVE PROVISIONED BLACKLISTED LOCKDOWN .
Specify the maximum number of rows to be returned.
beectl list_devices --user user=john.doe
beectl list_devices --status BLACKLISTED
The list_directory_profiles command lists directory profiles in an XML file.
beectl list_directory_profiles --file <filename>
XML file to be created.
beectl list_directory_profiles --file MyDirectoryProfile.xml
List the email messages in a transport queue
beectl list_email_messages --queue_id <queue_id> --max_count <max_count>
The email transport queue id
The maximum count of rows to be displayed
beectl list_email_messages --queue_id 1234 --max_count 100
List the email transport queues information
beectl list_email_queues
This command has no options
beectl list_email_queues
Lists all enterprises and prints names and identifiers
beectl list_enterprises
This command has no options
beectl list_enterprises
List all error code definitions in beehive.
beectl list_errorcode_catalog [--display_columns <STRING_LIST>] [--errorcode_range <xxxxx-yyyyy>] [--errorcode <BEEX-12345> ... ]
Comma separated list of columns to be displayed. Valid arguments are [service, messageid, displayname, severity, cause, effect, action]
Dash-separated range of error codes to list from the catalog, without the prefix. Default: 00000-99999
An individual error code to display information about, including prefix.
beectl list_errorcode_catalog
Lists all error code definitions in beehive.
beectl list_errorcode_catalog --display_columns messageid,displayname,cause --errorcode_range 00400-00499
Lists the messageid, display name, and cause of all errorcodes between 00400 and 00499
beectl list_errorcode_catalog --errorcode 'BEEU-00822'
Lists all catalog information on the error BEEU-00822
Lists all business object events.
beectl list_event_groups [ --name <name of event group to be listed> ]
Specify the name of the event to be listed.
beectl list_event_groups --name MyEventGroup
Lists all business object events.
beectl list_events [ --internal_name <event name to be listed> ]
Specify the name of the event to be listed.
beectl list_events --internal_name MyEvent
Displays the status of all expertise background jobs.
beectl list_expertise_background_jobs { [ --job <job>] [--detail] }
Job type of the expertise background job. Allowed values are CONFIDENCE_UPDATER, PROFILING_HANDLER, PROFILE_OPTIMIZER, PROFILE_TRANSFER, RELATIONSHIP_HANDLER and WHOIS_HANDLER.
A detailed view of all the specified jobs is shown.
beectl list_expertise_background_jobs --job PROFILE_TRANSFER
beectl list_expertise_background_jobs --job CONFIDENCE_UPDATER --detail true
beectl list_expertise_background_jobs --detail true
The list_expertise_profiling_configuration command lists the profiling configuration.
beectl list_expertise_profiling_configuration
This command has no options
beectl list_expertise_profiling_configuration
The list_expertise_profiling_enabled_entities command lists all the entities for whom expertise profiling is enabled.
beectl list_expertise_profiling_enabled_entities
This command has no options
beectl list_expertise_profiling_enabled_entities
The list_expertise_profiling_status command lists the expertise profiling status of the user specified. The profiling status information comprises Enability, Bootstrap, Searchability statuses.
beectl list_expertise_profiling_status --entity <identifier>
Identifier of the entity whose expertise profiling status is to be determined. Permitted value is a valid collab id or BODN id of the entity. This option is mandatory.
beectl list_expertise_profiling_status --entity 3F5B:23D3:user:40EA125BD4941FBEE040578CA8027E89000000030E6F
beectl list_expertise_profiling_status --entity user=user1,enpr=oracle
The list_expertise_relationship_blacklist_emails command lists all the email addresses that have been blacklisted for expertise relationship profiling.
beectl list_expertise_relationship_blacklist_emails
This command has no options
beectl list_expertise_relationship_blacklist_emails
Lists the stop phrases for expertise service.
beectl list_expertise_stop_phrases { --enterprise <enterprise identifier> --output_format <output_format> }
Identifier of the enterprise for which the stop phrases will be added.
The output format for stop phrases. Only XML format is supported.
beectl list_expertise_stop_phrases --enterprise enpr=Example
beectl list_expertise_stop_phrases --enterprise enpr=Example --output_format XML
The list_expertise_user_scopes command lists all expertise user scope or detailed version of supplied expertise user scope CollabId/BODN with --expertise_user_scope option.
beectl list_expertise_user_scopes [--output_format <XML>] [--expertise_user_scope <BODN or CollabId>]
Output format
CollabId or BODN format of the expertise user scope to be detailed.
beectl list_expertise_user_scopes --output_format XML
beectl list_expertise_user_scopes --expertise_user_scope exus=ExpertiseUserScopeName,enpr=Oracle
beectl list_expertise_user_scopes --expertise_user_scope 416E:25BF:exus:6A9CBED7822AA32EE040578C5C8453AB000000018705
The list_external_contacts command lists contacts that match specified search criteria. If search criteria are not specified, then all contacts are listed. It also lists the details of the contact(s) whose identifier is specified.
beectl list_external_contacts { --count <true|false> | --contact <identifier of external contact > [ --show <show attributes(ALL|MORE)> ] | --email_id <Email address of the user> [ --show <show attributes(ALL|MORE)> ] | [ --family_name <family name of the contact> ... ] [ --given_name <given name of the contact> ... ] [ --display_name <display name of the contact> ... ] [ --middle_name <middle name of the contact> ... ] [ --job_title <job title of the contact> ... ] [ --prefix <prefix of the contact> ... ] [ --suffix <suffix of the contact> ... ] [ --nick_name <nick name of the contact> ... ] [ --office_location <office location of the contact> ... ] [ --company <company of the contact> ... ] [ --profession <profession of the contact> ... ] [ --department <department of the contact> ... ] [ --organization <organization identifier> ... ] [ --property <name(assistant|certificate|notes)=value=description> ... ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --status <status of user(enabled|disabled|locked|marked_for_delete)> ... ] [ --is_deleted <true|false> ] [ --created_by <identifier of creator> ... ] [ --modified_by <identifier of modifier> ... ] [ --match <match attributes(ANY|ALL)> ] [ --show <show attributes(ALL|MORE)> ] }
The identifier of the external contact
Email id of the external contact
Family name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Given name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Display name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Middle name of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Job title of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Prefix of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Suffix of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
ta_type="STRING">Feed type of the feed configuration. Permitted vaed. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Office location of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Company of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Profession of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Department of the contact. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Identifiers of the organizations the contact belongs to.
Details of the property in the format name=value. Supported names are certificate, assistant and notes. Note, no equals to symbol(=) should be present in the name or value.
Address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Sets the provisioning status of the external contact. Sets the provisioning status of the user. Supported values are ENABLED, DISABLED, LOCKED.
Contacts whose provisioning status is deleted.
Identifier of the entity who created the contact.
Identifier of the entity who modified the contact.
Lists the number of contacts. When this option is used, no other information about the contacts is listed.
Lists some or all the attributes of the contact. Valid values are ALL or MORE. If nothing is specified the default important attributes are listed.
Lists all contacts whose attributes match either one or more or all the predicates passed. Permitted values are ALL or ANY. Default is ALL.
beectl list_external_contacts
beectl list_external_contacts --count
beectl list_external_contacts --contact 6A95:21EB:extp:D9E9FC8134544BCE9D60559F9B997CCD000000000000 --show ALL
beectl list_external_contacts --email_id person1@example.com --show MORE
beectl list_external_contacts --given_name User1GivenName --show ALL
beectl list_external_contacts --given_name User1% --office_location 4A0% --match ALL --show MORE
List actions that have not completed successfully.
beectl list_failed_action_events [ --bucket <Partition number> --sequence <Sequence number> ]
Partition number
Sequence number
beectl list_failed_action_events --bucket MyBucketNumber --sequence MySequenceNumber
The list_feed_configurations command lists the feed configurations in the given scope.
beectl list_feed_configurations { --scope <scope identifier> [--feedtype <feed type >] | [--feedtype <feed type > --effective_feed_configuration] }
Scope in which the feed configuration will be created
st_groups --count </example_message> <examplues are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.
--effective_feed_configuration
Get the effective feed configuration associated with the given scope. Default is true.
beectl list_feed_configurations --scope enpr=example
beectl list_feed_configurations --scope enpr=example --feedtype RECENT --effective_feed_configuration True
Lists the file plan.
beectl list_file_plan
This command has no options
beectl list_file_plan
Lists the filesystem path, read-only status, and identifier of all available filesystem references.
beectl list_filesystem_references
This command has no options
beectl list_filesystem_references
The list_groups command lists groups that match specified search criteria. If search criteria are not specified, then all groups are listed.
beectl list_groups { --count <true|false> | --group <Identifier of the group> [ --show <show attributes(ALL|MORE|MEMBERS)> ] | --email <Email address of the group> [ --show <show attributes(ALL|MORE|MEMBERS)> ] | [ --name <name of the group> ... ] [ --description <description of the group> ... ] [ --scope <scope of the group> ... ] [ --organization <organization identifier> ... ] [ --property <name(is_auto_confirm_on|moderator)=value=description> ... ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ] [ --is_deleted <true|false> ... ] [ --created_by <identifier of creator> ... ] [ --modified_by <identifier of modifier> ... ] [ --match <match attributes(ANY|ALL)> ] [ --show <show attributes(ALL|MORE|MEMBERS)> ] }
Identifier of the group
Email id of the group
Name of the group. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Description of the group. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Scope or parent identifier of the group.
Identifiers of the organizations the group belongs to.
Details of the property in the format name=value. Supported names are is_auto_confirm_on, moderator. Note, no equals to symbol(=) should be present in the name or value.
Address of the group in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Groups whose status is deleted.
Identifier of the entity who created the group.
Identifier of the entity who modified the group.
Lists the number of groups. When this option is used, no other information about the groups is listed.
Lists some or all attribute or the members of the group. Valid values are ALL or MORE OR MEMBERS. If nothing is specified the default important attributes are listed.
Lists groups whose attributes match either one or more or all the predicates passed. Permitted values are ALL or ANY. Default is ALL.
beectl list_groups
beectl list_groups --count
beectl list_groups --group grup=group1,enpr=example --show all
beectl list_groups --email group1@example.com --show more
beectl list_groups --group grup=group1,enpr=example --show MEMBERS
beectl list_groups --name Group1Name --show all
beectl list_groups --name Group1% --scope enpr=enpr1 --match all --show more
List remote iSchedule Server configurations.
beectl list_ischedule_servers [--name <name>]
Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.
beectl list_ischedule_servers --name remoteserver
Displays summarized informations for the resources in language pack. The search criteria can include a combination of string contained in the resource name, locale of the resource, type of resource (built-in or custom). Note that only resources matching ALL (as compared to ANY) specified search criteria are displayed.
beectl list_language_pack [--full | --base_name --locale --only_built_in --only_custom]
List all resources in the language pack.
List resources containing the specified name.
List resources with the specified locale.
List only built-in resources.
List only custom resources.
Below command will display summarized information for resources which have been localized for English locale with names containing the string CommandImplRB, irrespective of whether they are built-in or custom.
beectl list_language_pack --base_name CommandImplRB --locale en
Lists the last change-log number processed by beehive for specified profile.
beectl list_ldap_change_number --profile <profile>
Name of the profile.
beectl list_ldap_change_number --profile MyDirectoryProfileName
Lists the Local Access Control List (LACL) of an entity.
beectl list_local_acl --entity <unique identifier of the entity>
Specify the unique identifier of the entity for which the Local Access Control List (LACL) should be listed.
beectl list_local_acl --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise
The list_max_address_count command lists the maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL and OTHER. This command also lists the system defined maximum limit, which cannot be exceeded.
beectl list_max_address_count
This command has no options
beectl list_max_address_count
Lists conference artifacts under workspace
beectl list_my_conferences --count-limit <A count limit for a list of conferences>
A count limit for a list of conferences
beectl list_my_conferences --count-limit 1000
List the Operation Statuses
beectl list_operation_statuses [--operation_status <CollabId of the Operation Status you would like to display.>] [--name <List Operation Statuses with this name.>] [--status_code <COMPLETED | EXECUTING | FAILED | TIMED_OUT. List Operation Statuses with this status code.>] [--operation <List Operation Statuses with this Operation.>] [--sort_by <name | modified_on. The sort order of the Operation Statuses. Sorting by name will be ascending and sorting by modified_on will be descending. Default is sorting by name.>]
CollabId of the Operation Status you would like to display.
List Operation Statuses with this name.
COMPLETED | EXECUTING | FAILED | TIMED_OUT. List Operation Statuses with this status code.
List Operation Statuses with this Operation.
name | modified_on. The sort order of the Operation Statuses. Sorting by name will be ascending and sorting by modified_on will be descending. Default is sorting by name.
The maximum number of Operation Statuses that will be returned. If not specified, 200 will be returned.
beectl list_operation_statuses --operation_status 1CF3:35AF:opst:6828B43CD3944E06A5CD425F0225CF2500000000004C
beectl list_operation_statuses --status_code EXECUTING --sort_by modified_on
Lists organizations in the given scope
beectl list_organizations --scope <Identifier of enterprise or organization> [--recurse <TRUE|FALSE. Default value is FALSE. Recursively list organizations>] [--name <Organization name>]
Identifier of the parent scope (enterprise or organization)
TRUE|FALSE. Default value is FALSE. Recursively list organizations
Organization name
beectl list_organizations --scope enpr=test_enterprise --recurse TRUE
beectl list_organizations --scope enpr=test_enterprise --name MyOrg
Lists the patch information for given archives.
beectl list_patch_informations (--archive_directory <directory containing archives> | --archive_file <archive file> )
Directory in which archives will be searched.
Enterprise archive file for listing the patch information.
beectl list_patch_informations --archive_file /tmp/some_service.ear --archive_file /tmp/some_service2.ear
Above command will list private and public patch numbers for given archive files.
beectl list_patch_informations --archive_directory /seed/archive/
Above command will list private and public patch numbers for all the files available in the given directory.
Lists policies in an specific container. Details returned include policy names and identifiers.
beectl list_policies [ --policy_name <name of the policy to be listed> ] [ --scope <container where the policy is deployed> ] [ --children <boolean specifying whether to include policies defined at child containers> ] [ --enforced <boolean specifying whether to include enforced policies> ][ --policy_type <name of the policy classification to be listed> ]
Specify the name of the policy.
Specify the identifier of the container where policy is deployed.
Specify whether to include policies defined at child containers.
Specify whether to include enforced policies.
Specify the type of policy to list [general|audit|record]. Default is [general].
beectl list_policies --policy_name MyPolicy --scope enpr=MyEnterprise --children true --enforced false--policy_type policyType
Lists all policy actions.
beectl list_policy_actions
This command has no options
beectl list_policy_actions
Lists policy schemas in the current enterprise. Details returned include policy schema names and identifiers.
beectl list_policy_schemas --name <name of the policy schema> --policy_type <name of the policy classification to be listed>
Specify the name of the policy schema.
Specify the type of policy to list [general|audit|record]. Default is [general].
beectl list_policy_schemas --name ExamplePolicySchema --name policyType
Lists policy templates in a specified container. Details returned include policy template names and identifiers.
beectl list_policy_templates --name <name of the policy template to be listed> --scope <container where the policy template is defined>--policy_type <name of the policy classification to be listed>
Specify the name of the policy template.
Specify the identifier of the container where policy template is deployed.
Specify the type of policy to list [general|audit|record]. Default is [general].
beectl list_policy_templates --name ExamplePolicyTemplate --scope enpr=oracle --policy_type policyType
Lists various available ports.
By default it shows ports used by current midtier only.
Valid protocols are
SMTP
IMAP
XMPP
XMPPS
FTP
HTTP
HTTPS
BTP
BTPS
OC4J-JGROUP-RANGE
OC4J-AJP-RANGE
OC4J-RMI-RANGE
OC4J-RMIS-RANGE
OC4J-JMS-RANGE
OC4J-SIP-RANGE
OC4J-AJP-RANGE identifies the range of ports in current site for either AJP or secure AJP protocol whichever is enabled.
Description of command output:-
ists general and advanced visibility data.</option> </options> <descr
2- Listen Port:- The value of the port on which listening component is listenning. This is the value which will be seen in operating system port management utilities like netstat.
3- Virtual Port:- Port to which the clients will connect. This value is for entire site.
4- Defining Component:- Identifier of the component, port property is modeled.
5- Property Name:- Name of the property for port on the defining configuration object.
6- Listen Component:- Identifier of the configuration object which listens on the listen port.
beectl list_ports [--instance <beehive instance system identifier or alias>] [--all] [--configuration_version <required version>]
System object identifier of Beehive Instance for which ports should be shown.
Flag indicating if all the ports in the system should be listed.
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
beectl list_ports --all
Above example lists ports used by all the midtiers.
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
The list_preference_profiles command lists preference profiles for a consumer.
beectl list_preference_profiles --consumer <Identifier of the consumer>
Identifier of the consumer
beectl list_preference_profiles --consumer user=user1
The list_preference_properties command lists all effective preference properties of a preference set.
beectl list_preference_properties --set <Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.>
Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.
beectl list_preference_properties --set prfs=set1,user=user1
The list_preference_sets command lists all preference sets for a preference profile.
beectl list_preference_sets --profile <Preference profile identifier>
Identifier of the preference profile.
beectl list_preference_sets --profile prfp=MyProfile,user=user1
Lists available Privilege names.
beectl list_privileges
This command has no options
beectl list_privileges
Prints property value of a component given a component identifier and property name. If property name is not specified then all the properties will be listed.
beectl list_properties --component <system object identifier or alias of the component> [--name <name>] [--configuration_version <required version>] [--advanced] [--all_visibilities]
Component identifier
Name of the property
Specifies configuration version. Valid values are proposed, active or any number equivalent to creation time of the configuration snapshot. Refer to the first column from the output of command list_configuration_versions for valid snapshot identifiers.
Lists advanced visibility data.
Lists general and advanced visibility data.
beectl list_properties --component 288d5051-2632-4800-b796-b3e16ca58f2d
Specifying Configuration Version: Any of the following can be specified for accessing specific snapshot. If not specified, latest active snapshot will be accessed.
--configuration_version 89098787 can be passed to use snapshot having specific creation time as 89098787.
--configuration_version active can be passed for active snapshot.
--configuration_version proposed can be passed for latest proposed snapshot.
Specifying Visibility Options: Any of the following options can be used for specific visibility data.
--advanced can be passed to include advanced visibility data.
--all_visibilities can be passed to include general and advanced visibility data.
Lists the metadata about all the properties of a system model object.
beectl list_property_metadata --type <System model object type> [--full_report]
Type of the component for which property metadata to be listed.
Flag indicating if full report should be displayed. It contains description about properties also.
beectl list_property_metadata --type WorkspacesService
Lists remote repositories.
beectl list_remote_repositories --scope <Remote Repository Container.> [ --name <Remote Repository Name.>]
Remote Repository Container.
Remote Repository Name.
beectl list_remote_repositories --scope myRemoteRepositoryScope --name myRemoteRepositoryName
Lists seeded remote repository definitions.
beectl list_remote_repository_definitions [ --name <Remote Repository Definition Name.>]
Remote Repository Definition Name.
beectl list_remote_repository_definitions --name myRemoteRepositoryDefinitionName
Lists remote shares.
beectl list_remote_shares --scope <Remote Share Container.> [ --name <Remote Share Name.>]
Remote Share Container.
Remote Share Name.
beectl list_remote_shares --scope myRemoteShareScope --name myRemoteShareName
Lists resources.
beectl list_resources {[--select_by_name <name_regex>] | [--select_by_identifier <identifier_regex>] | [--select_by_capacity <capacity>]} [--external] [--show <DEFAULT | ALL | MORE>]
Specify the resource name criteria. This option accepts a regular expression match.
Specify the resource identifier criteria. This option accepts a regular expression match.
Specify the resource capacity.
List external resources. If this option is not specified, only bookableresources will be listed.
t; ] ]<ome or all the attributes of the resource. Valid values are DEFAULT, ALL or MORE. If nothing (or DEFAULT) is specified the default important attributes are listed.
beectl list_resources --select_by_name "Resource"
Lists RoleDefinition entities.
beectl list_role_definitions [--scope <unique identifier of the Scope>] [--name <like string>]
Specify the unique identifier of the Scope of the RoleDefinitions to be listed. If not specified the Scope will be the Enterprise.
Specify the name pattern of the RoleDefinitions to be listed. If not specified all accessible RoleDefinitions will be returned.
beectl list_role_definitions --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition
Search the ocs_clone_registry table based on the specified options and display the matched clone records.
beectl list_schema_clones [ --orig_schema_id <from_schema_id> ] [ --cloned_schema_id <to_schema_id> ] [ --phase <clone_phase> ] [ --status <clone_status> ] [ [ --start_time <clone_start_time> ] | [ --start_time_from <from_time> ] [ --start_time_to <to_time> ] ] [ [ --end_time <clone_end_time> ] | [ --end_time_from <from_time> ] [ --end_time_to <to_time> ] ] [ --description <schema_description> ] [ [ --maximum_results <max_results> ] [ --sort_by <sort_colum_name> ] [ --display_column <display_column> ] | [ --count_only <true/false> ] ]
Option used to match the original schema id from which the new schema is cloned.
Option used to match the new schema id which is being cloned.
Option used to match the clone phase.
Option used to match the clone status.
The time stamp option specified to match the clone start time.
The time stamp option specified as the lower inclusive bound to match the clone start time.
The time stamp option specified as the upper inclusive bound to match the clone start time.
The time stamp option specified to match the clone end time.
The time stamp option specified as the lower inclusive bound to match the clone end time.
The time stamp option specified as the upper inclusive bound to match the clone end time.
Option used to match the description.
Option specified to limit the returned results. This option will be ignored, if the count_only option is true.
Option specified the column name by which the returned result will be sorted. Valid column names are: <CLONENO | ORIG_SCHEMA_ID | CLONED_SCHEMA_ID | PHASE | STATUS | START_TIME | END_TIME | DESCRIPTION>.
Option specify which column to display. Valid column names are: <CLONENO | ORIG_SCHEMA_ID | CLONED_SCHEMA_ID | PHASE | STATUS | START_TIME | END_TIME | DESCRIPTION>.
Option specified to only return only the total count of records matching the criteria.
beectl list_schema_clones --start_time_from 2008-07-10T00:00:00 --start_time_to 2008-07-10T23:59:59 --orig_schema_id 56 --display_column ORIG_SCHEMA_ID --display_column CLONED_SCHEMA_ID --display_column STATUS --maximum_results 200
beectl list_schema_clones --count_only true
Search the ocs_schema_registry table based on the specified options and display the matched schema records.
beectl list_schemas [ --schema_name <name> ] [ --schema_id <id> ] [ --version_id <id> ] [ --schema_type <type> ] [ --status <status> ] [ --description <description> ] [ [ --creation_time <time> ] | [ --creation_time_from <from_time> ] [ --creation_time_to <to_time> ] ] [ [ --activationready_time <time> ] | [ --activationready_time_from <from_time> ] [ --activationready_time_to <to_time> ] ] [ [ --upgradeready_time <time> ] | [ --upgradeready_time_from <from_time> ] [ --upgradeready_time_to <to_time> ] ] [ [ --activation_time <time> ] | [ --activation_time_from <from_time> ] [ --activation_time_to <to_time> ] ] [ [ --legacy_time <time> ] | [ --legacy_time_from <from_time> ] [ --legacy_time_to <to_time> ] ] [ [ --24} <time> ] | [ --deacitvation_time_from <from_time> ] [ --deacitvation_time_to <to_time> ] ] [ [ --deinstall_time <time> ] | [ --deinstall_time_from <from_time> ] [ --deinstall_time_to <to_time> ] ] [ [ --maximum_results <max_results> ] [ --sort_by <sort_colum_name> ] [ --sort_by <display_column> ] | [ --count_only <true/false> ] ]
Option used to match the schema name.
Option used to match the schema id.
Option used to match the version id.
Option used to match the schema type.
Option used to match the schema status.
The time stamp option specified to match the creation time.
The time stamp option specified as the lower inclusive bound to match the creation time.
The time stamp option specified as the upper inclusive bound to match the creation time.
The time stamp option specified to match the activation ready time.
The time stamp option specified as the lower inclusive bound to match the activation ready time.
The time stamp option specified as the upper inclusive bound to match the activation ready time.
The time stamp option specified to match the upgrade ready time.
The time stamp option specified as the lower inclusive bound to match the upgrade ready time.
The time stamp option specified as the upper inclusive bound to match the upgrade ready time.
The time stamp option specified to match the activation time.
The time stamp option specified as the lower inclusive bound to match the activation time.
The time stamp option specified as the upper inclusive bound to match the activation time.
The time stamp option specified to match the legacy time.
The time stamp option specified as the lower inclusive bound to match the legacy time.
The time stamp option specified as the upper inclusive bound to match the legacy time.
The time stamp option specified to match the deactivation time.
The time stamp option specified as the lower inclusive bound to match the deactivation time.
The time stamp option specified as the upper inclusive bound to match the deactivation time.
The time stamp option specified to match the deinstall time.
The time stamp option specified as the lower inclusive bound to match the deinstall time.
The time stamp option specified as the upper inclusive bound to match the deinstall time.
Option used to match the description.
Option specified to limit the returned results. This option will be ignored, if the count_only option is true.
Option specified the column name by which the returned result will be sorted. Valid column names are: <SCHEMA_NAME | SCHEMA_ID | VERSION_ID | SCHEMA_TYPE | STATUS | CREATION_TIME | ACTIVATIONREADY_TIME | UPGRADEREADY_TIME | ACTIVATION_TIME | LEGACY_TIME | DEACTIVATION_TIME | DEINSTALL_TIME | DESCRIPTION>.
Option specify which column to display. Valid column names are: <SCHEMA_NAME | SCHEMA_ID | VERSION_ID | SCHEMA_TYPE | STATUS | CREATION_TIME | ACTIVATIONREADY_TIME | UPGRADEREADY_TIME | ACTIVATION_TIME | LEGACY_TIME | DEACTIVATION_TIME | DEINSTALL_TIME | DESCRIPTION>.
Option specified to only return only the total count of records matching the criteria.
beectl list_schemas --creation_time_from 2008-07-10T00:00:00 --creation_time_to 2008-07-10T23:59:59 --schema_name BEE_CODE --display_column schema_name --display_column schema_id --display_column creation_time --maximum_results 200
beectl list_schemas --count_only true
Lists Sensitivity entities.
beectl list_sensitivities --workspace <unique identifier of the Workspace> [--name <like string>]
Specify the unique identifier of the Workspace of the Sensitivities to be listed.
Specify the name pattern for the Sensitivities to be listed. If not specified all accessible Sensitivities will be returned.
beectl list_sensitivities --workspace wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity
Lists the Sensitivity Access Control List (SACL) of a Sensitivity.
ecify the uniqnsitivity_acl --sensitivity <unique identifier of the Sensitivity>
Specify the unique identifier of the Sensitivity whose Sensitivity Access Control List (SACL) should be listed.
beectl list_sensitivity_acl --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise
Lists the statistics for a given type or component or for the entire site.
beectl list_statistics ([--type <System model object type>] [--component <stat provider system model object identifier or alias>] | [--all_components]) [--advanced] [--all_visibilities]
Type of the component for which statistics to be listed.
System object identifier of the component for which statistics to be listed.
If specified, statistics for all components will be listed.
Lists advanced visibility data.
Lists general and advanced visibility data.
beectl list_statistics --type WorkspacesServiceInstance
Above example will list statistics for WorkspacesServiceInstance with GENERAL visibility.
Specifying Visibility Options: Any of the following options can be used for specific visibility data.
--advanced can be passed to include advanced visibility data.
--all_visibilities can be passed to include general and advanced visibility data.
Prints the supported entity types which can be used in business object distinguished naming pattern instead of system generated identifier and their description.
If a value contains \ (back slash) or a , (comma), then it has to be escaped using back slash. For example, "wksp=Personal workspace\, Admin,orgn=HR,enpr=oracle" refers to Workspace of name "Personal workspace, Admin" that exists in Organization "HR" that exists directly in Enterprise "Oracle".
beectl list_supported_entity_types
This command has no options
beectl list_supported_entity_types
List the access control permissions of a user, resource or workspace's tasklist. When multiple tasklists match the selection criteria for the user, resource or workspace, the default tasklist will be used.
beectl list_tasklist_permissions { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> }
Specify the unique identifier of a tasklist.
Specify the unique identifier of a user, resource or team workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
beectl list_tasklist_permissions --select_by_address user@example.com
Lists existing tasklists of a user, resource or workspace.
beectl list_tasklists { --tasklist <tasklistid> --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> }[--show <DEFAULT | ALL | MORE>]
<usage>beecue identifier of a tasklist.
Specify the unique identifier of a user, resource or team workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
Lists some or all the attributes of the tasklist. Valid values are DEFAULT, ALL or MORE. If nothing (or DEFAULT) is specified the default important attributes are listed.
beectl list_tasklists --select_by_address user@example.com
Lists the workspaces to which the latest version of the given workspace template needs to be applied to make the workspaces conform to the latest version of the template
beectl list_template_evolution_target_workspaces --template <Workspace template identifier> --limit <Maximum number of workspaces to upgrade>
Workspace template identifier
Maximum number of workspaces to upgrade
beectl list_template_evolution_target_workspaces --template wstp=test_team_ws_template,enpr=test_enterprise --limit 100
Lists time zones in the database.
beectl list_timezones [--all] | [--select_by_common] [--select_by_name <TimezoneName>]
Lists all time zones. This option cannot be used with the --select_by_name or --select_by_common option.
Lists common time zones. This is the default when no options are specified.
Specifies a time zone name. To list all time zones, use an asterisk(*) as the options value.
beectl list_timezones --all
beectl list_timezones --select_by_common
beectl list_timezones --select_by_name Asia/Shanghai
beectl list_timezones --select_by_common --select_by_name Asia/Shanghai
This command lists the trusted identities. The type has to be specified. For type SES, it lists the names of the trusted entities.
beectl list_trusted_identity --type <(WSSEC|S2S|SES)>
Type of the trusted identity. Permitted values are SES or WSSEC. SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
List user subscriptions
beectl list_user_subscriptions --subscriber <identifier of subscriber> [ --attach <identifier of attached entity> --source_entity_class <sourceEntityClass of template> ]
Specify the identifier of the subscriber who owns the subscription.
Specify the Identifier of the entity to which the subscription is attached.
Specify the name of the source entity Class that is defined in subscription template.
beectl list_user_subscriptions --subscriber user=user1
The list_users command lists users that match specified search criteria. If search criteria are not specified, then all users are listed.
oratl list_users { --count <true|false> | --user <User Identifier> [ --show <show attributes(ALL|MORE)> ] | --email <Email address of the user> [ --show <show attributes(ALL|MORE)> ] | [ --family_name <family name of the user> ... ] [ --given_name <given name of the user> ... ] [ --display_name <display name of the user> ... ] [ --middle_name <middle name of the user> ... ] [ --job_title <job title of the user> ... ] [ --prefix <prefix of the user> ... ] [ --suffix <suffix of the user> ... ] [ --nick_name <nick name of the user> ... ] [ --office_location <office location of the user> ... ] [ --company <company of the user> ... ] [ --profession <profession of the user> ... ] [ --department <department of the user> ... ] [ --organization <organization identifier> ... ] [ --property <name=value=description> ... ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --status <status of user(enabled|disabled|locked|marked_for_delete)> ... ] [ --is_deleted <true|false> ] [ --created_by <identifier of creator> ... ] [ --modified_by <identifier of modifier> ... ] [ --match <match attributes(ANY|ALL)> ] [ --show <show attributes(ALL|MORE)> ] [ --manager <manager identifier> ] [ --extended_enterprise_user <true|false> ] [ --is_locked <locked status(user)> ] [ --external_inbox <true|false> ] }
Identifier of the user.
Exact email id of the user whose details have to be retrieved. It should be in the format user1@example.com
Family name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Given name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Display name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Middle name of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Job title of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Prefix of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Suffix of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Nickname of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Office location of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Company of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Profession of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Department of the user. SQL wildcards '%' and '_' are also permitted. The % and _ characters will be treated as literals if preceded by the '\' character. Examples: doc1% will return doc1 and doctest whereas doctest_ will return doctest2. doc_ will return doc1 and doc_. doc\_ will return doc_. Exact match is found if no wildcards exists.
Identifier of the manager.
Identifiers of the organizations the user belongs to.
Details of the property in the format name=value. All custom properties are supported. Note, no equals to symbol(=) should be present in the name or value.
ive bound for matching with the scan date.</option> <option name="scandate_to" mandatory="false" data_type="DATE_TIME">Value specified will be used as the upper inclusive bound for matching with the scan date. </option> <option name="virus_name" mandatory="false" data_type="STRING">Value specified wradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Sets the provisioning status of the user. Supported values are ENABLED, DISABLED.
Users whose provisioning status is deleted.
Lists all extended enterprise user.
Lists all users whose external inbox is set.
Identifier of the entity who created the user.
Identifier of the entity who modified the user.
Lists the number of users. When this option is used, no other information about the users is listed.
Lists some or all the attributes of the user. Valid values are ALL or MORE. If nothing is specified the default important attributes are listed.
Lists users whose attributes match either one or more or all the predicates passed. Permitted values are ALL or ANY. Default is ALL.
locked status of user, valid value is (user).
beectl list_users
beectl list_users --count
beectl list_users --user user=user1@example.com --show ALL
beectl list_users --email user1@example.com --show MORE
beectl list_users --given_name User1GivenName --show ALL
beectl list_users --given_name User1% --office_location 4A0% --match ALL --show MORE
beectl list_users --manager user=user2@example.com --extended_enterprise_user --match ALL --show MORE
beectl list_users --address BUSINESS_1:mailto:%@example.com --address BUSINESS_1:mailto:user1@example.com --match ANY --show ALL
Lists the version configuration on the given scope or heterogenous folder.
beectl list_version_configuration --container <Configuration scope or heterogenous folder> --effective <TRUE|FALSE. Default value is FALSE>
Scope or heterogenous folder on which the version configuration should be listed.
Whether the effective version configuration should be returned or the one directly defined.
beectl list_version_configuration --container orgn=MyOrganization,enpr=MyEnterprise
Lists the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR.
beectl list_virus_scan_policy
This command has no options
<beectl list_virus_scan_policy>
Lists the virus scan results that match the specified criteria. Only a count of the matches found will be displayed if the option to list only the counts is specified. Option count_only cannot be specified with options maximum_results or display_columns. Option scandate cannot be specified with options scandate_from or scandate_to.
beectl list_virus_scan_results [ [ --scandate <scandate> ] | [ --scandate_from <scandate_from> ] [ --scandate_to <scandate_to> ] ] [ --virus_name <virus_name> ] [ --virus_id <virus_id> ] [ --entity_type <entity_type> ] [ --obsolete_only <true/false> ] [ [ --maximum_results <max_results> ] [ --display_columns <display_colummns> ] | [ --count_only <true/false> ] ]
Comma separated list of columns to display. Valid arguments are [virus_id, virus_name, component_name, scan_date, repair_attempts, entity_id, entity_type, repaired, aux_data, collab_id]. If this option is not specified all columns will be displayed.
Value specified will be used to do an exact match with the scan date attribute of the scan results.
Value specified will be used as the lower inclusive bound for matching with the scan date.
Value specified will be used as the upper inclusive bound for matching with the scan date.
TUSINITIATED">Speill be used to do an exact match with the virus name attribute of the scan results.
Value specified will be used to do an exact match with the virus id attribute of the scan results.
Value specified will be used to pick up only the scan results for the entered entity type.
This option returns matches found for the specified criteria only for those entities that are obsolete, i.e. these entities no longer exists in the system.
Value specified limits the number of results returned.
This option returns only a total count of matches found for the specified criteria.
<beectl list_virus_scan_results --scandate_from 2008-07-10T00:00:00 --scandate_to 2008-07-10T23:59:59 --entity_type emsg --maximum_results 10 --display_columns entity_id,entity_type,virus_id,virus_name>
<beectl list_virus_scan_results --count_only true>
The list command shows all of the facilities, their collab ids and phone number matching rules. The command accepts three optional parameters to help refine the search, if no parameters are specified, then all facilities are presented.
beectl list_voice_facilities [--group_collabid <collabid>] [--includes <phone rule>] [--excludes <phone rule>] [--phone <phone number>]
The group collabid to search for. The list will show the facility the group collabid belongs to.
The inclusion rule to search for. For example: 1312???????. The list will show the facility that has the given inclusion rule.
The exclusion rule to search for. For example: 1312???????. The list will show the facility that has the given exclusion rule.
The phone number to match against all known facilities. For example, specifying 13125551212 will result in a list of all facilities that match ordered such that the top of the list is the first match.
beectl list_voice_facilities --group_collabid grup=GroupName,enpr=MyEnterprise
beectl list_voice_facilities --includes 1312???????
beectl list_voice_facilities --excludes 1312???????
beectl list_voice_facilities --phone 13125551212
Lists all workspace templates
beectl list_workspace_templates --scope <Identifier of enterprise or organization> [--name <Workspace template name>] [--domain <Workspace template domain>] [--file <Full path of the output file>]
Identifier of enterprise or organization
Workspace template name
Workspace template domain
Full path of the output file
beectl list_workspace_templates --scope orgn=test_org,enpr=test_enterprise
beectl list_workspace_templates --scope orgn=test_org,enpr=test_enterprise --name Test_template --domain Test_domain --file /tmp/template.xml
Lists workspaces in an organization or enterprise
beectl list_workspaces --scope <Identifier of enterprise or organization> [--type <p (Personal) | t (Team) | a (All)>] [--name <Workspace name>] [--recurse] [--countLimit <count>]
Identifier of enterprise or organization
p (Personal) | t (Team) | a (All)
Workspace name
Recursively list workspaces in all organizations
The maxium number of workspaces that can be returned. If not specified, a default value of 200 will be assumed
beectl list_workspaces --scope orgn=test_org,enpr=test_enterprise --type t
beectl list_workspaces --scope enpr=test_enterprise --name My_Workspace
Used to list all currently existing XMPP chat rooms.
beectl list_xmpp_chat_rooms
This command has no options
beectl list_xmpp_chat_rooms
Modifies the AccessControlFields of an existing entity.
This command alters sensitive data in the system. Oracle recommends using this command with caution.
beectl modify_access_control_fields --entity <unique identifier of the entity> [--owner <unique identifier of the owner Accessor>] [--owner_access_types <owner access types string>] [--sensitivity <unique identifier of the Sensitivity>] [--{7} <unique identifier of the Scope>]
Specify the unique identifier of the entity to be modified.
Modify the owner of the entity. Specify the unique identifier of the new owner.
Modify the access types string for the entity's owner.
Modify the Sensitivity of the entity. Specify the unique identifier of the new Sensitivity.
beectl modify_access_control_fields --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --owner user=MyUser
Modifies an existing AssignedRole entity.
beectl modify_assigned_role --assigned_role <unique identifier of the AssignedRole> [--name <name of AssignedRole>] [--description <description>] [--assigned_scope <unique identifier of the assigned Scope>] [--role_definition <unique identifier of the assigned RoleDefinition>] [[--accessor <unique identifier of an Accessor>]...] [[--add_accessor <unique identifier of an Accessor>]...] [[--remove_accessor <unique identifier of an Accessor>]...]
Specify the unique identifier of the AssignedRole to be modified.
Modify the name of the AssignedRole.
Modify the description of the AssignedRole.
Modify the assigned Scope of the AssignedRole. Specify the unique identifier of the new assigned Scope.
Modify the assigned RoleDefinition of the AssignedRole. Specify the unique identifier of the new RoleDefinition.
Modify the set of Accessors. Specify the unique identifier of an Accessor. This option can be specified more than once.
Adds an Accessor. Specify the unique identifier of an Accessor to add. This option can be specified more than once.
Removes an Accessor. Specify the unique identifier of an Accessor to remove. This option can be specified more than once.
beectl modify_assigned_role --assigned_role acar=MyAssignedRole,wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole2
Update an existing attendant with a new markup file or rename it.
beectl modify_attendant { --file <aaml file> | --name <attendant name> --new_name <new name> }
An auto-attendant markup language file describing the attendant to be added. When specified, name and new_name must be specified.
Name of an existing attendant. Must be specified when 'new_name' is specified. Must not be specified when 'file' is specified
The name to which the attendant should be changed. Must be specified when 'name' is specified. Must not be specified when 'file' is specified
beectl modify_attendant --file /var/attendant.aaml
beectl modify_attendant --name myattendant --new_name myattendant2
Modifies an existing audit policy
beectl modify_audit_policy --policy <Audit policy identifier> [--file <Full path of the input file>] [--enable <true|false>]
Audit policy identifier
Full path of the input file
true: Enable audit policy
false: Disable audit policy
beectl modify_audit_policy --policy plcy=MyAuditPolicy --file /tmp/policy_ex.xml
beectl modify_audit_policy --policy plcy=MyAuditPolicy --enable false
Modifies an existing audit trail
beectl modify_audit_trail --trail <Audit trail identifier> --file <Full path of the input file>
Audit trail identifier
Full path name of the input XML file
beectl modify_audit_trail --trail autr=MyAuditTrail --file /tmp/trail_ex.xml
Modify various attributes of the selected calendar.
beectl modify_calendar { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--name <name>] [--booking_characteristics <booking_characteristices>] [--allow_double_booking <allow_double_booking> ] [--include_in_freebusy <include_in_freebusy>] [--priority <priority>] [--sensitivity <sensitivity>] [--enrollment_type <enrollment_type>] [--self_enrollment <self_enrollment>] [--caldav_resource_name <caldav_resource_name>] [--derive_timezone <derive_timezone>] [--timezone <timezone>] [--derive_available_hours <derive_available_hours>] [--available_hours <available_hours>] [--enable_presence <enable_presence>] [--enroll_members <enroll_members>]
Specify the unique identifier of a calendar.
Specify the unique identifier of a user, resource or workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
Modify the calendar name.
Modify the calendar booking behavior. Permitted values are O for Open, F for FirstComeFirstServed, case insensitive.
Modify the calendar double booking behavior. Permitted values are Y for Yes (allow double booking), N for No (deny double booking), case insensitive.
Modify if this calendar is included in free busy. Permitted values are Y for Yes, N for No, case insensitive.
Modify the default priority of the calendar. Permitted values are HIGH, MEDIUM, LOW and NONE, case insensitive.
Modify the default sensitivity of the calendar. Permitted values are PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL and PRIVATE, case insensitive.
Modify the enrollment type of the calendar. Permitted values are PUBLIC, PRIVATE, case insensitive.
Modify the self enrollment status for the calendar. Permitted values are OPEN, CLOSED, case insensitive. This option applies to Team Workspace only.
Modify the caldav resource name of the calendar.
Modify the calendar's 'derives timezone from the owner' configuration. Permitted values are Y (derive the calendar timezone from its owner's timezone) or N.
Modify the timezone of the calendar.
Modify the calendar's 'derives available hours from the owner' configuration. Permitted values are Y (derive the calendar available hours from its owner's timezone) or N.
Modify the available hours of the calendar.
Modify the calendar presence integration configuration. Permitted values are Y (enable presence integration) or N. This option does not apply to Team Workspace.
Modify the calendar's team workspace members enrollment configuration. Permitted values are Y (automatically enroll workspace members) or N . This option applies to Team Workspace only.
beectl modify_calendar --select_by_address user@example.com
Modify the enrollment list of the specified team workspace calendar.
beectl modify_calendar_enrollments { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_workspace_name <workspace_name> } { --enroll <loginid> | --unenroll <loginid>}
Specify the unique identifier of a calendar.
Specify the unique identifier of a user, resource or workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.
Specify the name of a team workspace.
Explicitly enroll the specified user to the team workspace calendar.
Explicitly unenroll the specified user from the team workspace calendar.
beectl modify_calendar_enrollments --select_by_address user@example.com --enroll user=user1
Modify access permissions for grantee (user or group) on the specified calendar.
beectl modify_calendar_permissions { --calendar <calendarid> | --calendarowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> | --select_by_resource_name <resource_name>} --user <userid> | --group <groupid> [--user_principal | --delegated_principal] [--can_invite | --cannot_invite] [--manage <sensitivity> ...] [--read <sensitivity> ...] [--discover <sensitivity> ...] [--deny <sensitivity> ...]
Specify the unique identifier of a calendar.
Specify the unique identifier of a user, resource.
Specify the Uniform Resource Identifier (URI) of a user, resource using the format '[scheme:]value'. If 'scheme:' is not supplied, mailto will be used.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the unique identifier of the user (grantee).
Specify the unique identifier of the group (grantee).
Set permissions to user only (do not modify any access given to this user as delegate).
Set permissions to delegated principal only (do not modify any access given to this user directly).
Specify the grantee (user or group) can invite this calendar.
Specify the grantee (user or group) cannot invite this calendar.
Grant manage access (delegate) to the grantee (user) on specified sensitivities of this calendar. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
Grant read access to the grantee (user or group) on specified sensitivities of this calendar. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
Grant discover access to the grantee (user or group) on specified sensitivities of this calendar. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
Deny the grantee (user or group) access to contents in this calendar on the specified sensitivities. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
beectl modify_calendar_permissions --calendarowner user=user1 --user user=user2 --can_invte --manage PUBLIC --read NORMAL --read PRIVATE
Modifies an existing category
beectl modify_category --category <Category identifier> --file <Full path of the category XML file>
Category to be updated.
Full path name of the XML file. The file must contain properly formatted data to update the category
beectl modify_category --category catg=MyCategory,enpr=MyEnterprise --file /tmp/category.xml
Updates a given category configuration.
beectl modify_category_configuration --configuration <Configuration identifier> --file <Full path of the configuration XML file>
Category configuration to be updated.
Full path of the category configuration XML file. The file must contain properly formatted data.
beectl modify_category_configuration --configuration 9941:2345:ctcf:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/configuration.xml
Create or modify the coexistence profile of a user.
beectl modify_coexistence_profile {--user <user_identifier>|--email <user_email>|{--file <file_name>|--select_users_without_profile|--select_users_with_profile} --errors_file <file_name>} --system_affinity <system_name> [--accessible_system <system_name> ...] [--no_data_import] [--force_retry]
Specify the identifier of the user.
Specify the email address of the user.
--select_users_without_profile
Specify all beehive users without a coexistence profile.
Specify all beehive users with a coexistence profile.
Specify the xml input file. File encoding MUST be UTF-8.
Specify the output file. This file will only be generated if errors occurs.
Specify the system affinity of the user.
Specify the collaboration system which can be access by the user.
Specify to disable default data import.
Specify to reset the NextAttempt time to current time. Only applies to coexistence profile that are not completed.
beectl modify_coexistence_profile --user user=userid --accessible_system beehive --system_affinity sys_name
beectl modify_coexistence_profile --file users.xml --accessible_system sys_name --errors_file errors.xml
beectl modify_coexistence_profile --select_users_without_profile --accessible_system sys_name
beectl modify_coexistence_profile --user user=userid --force_retry
Modifies a coexisting remote system.
beectl modify_coexistence_system --select_by_name <old_name> [--name <name>] [--product_name <product_name>] [{--url <url>|--host_name <host_name> --port <port_number> {--use_http|--use_https}}] [--partnership_key] [--query_capabilities] [--timezone_alias_namespace <timezone_alias_namespace>]
Specify the actual name of the coexisting remote system.
Specify the name of the coexisting remote system.
Specify the new name of the coexisting remote system.
Specify the URL of the coexisting remote system.
Specify that "HTTP" MUST be used for the coexisting remote system.
Specify that "HTTPS" MUST be used for the coexisting remote system.
Specify the host name of the coexisting remote system.
Specify the port number used by the coexisting remote system.
Specify the partnership key of the coexisting remote system.
Specify the timezone alias namespace used by the coexisting remote system.
Force the coexistence service to query the remote system for its capabilities.
beectl modify_coexistence_system --select_by_name ex-101 --url http://example.com:7777
Modifies the connection pool configuration.
beectl modify_connection_pool [--connection_pool <connection pool system model identifier or alias>] [--max_connections <maximum connections>] [--min_connections <minimun connections>] [--max_statement_limit <maximum cached statements>] [--initial_connections <initial connections>] [--connection_wait_timeout <connection wait timeout>] [--inactivity_timeout <inactivity timeout>] [--time_to_live_timeout <time to live timeout>] [--abandoned_connection_timeout <abandon connection timeout>] [--lower_threshold_limit <lower threshold limit>] [--property_check_interval <property check interval>] [--validate_connection <true/false>]
Connection pool system object identifier.
Maximun number of connections in connection pool.
Number of minimum connections in connection pool.
Maximum number of cached statements in connection pool.
Number of initial connections in connection pool.
Connection wait timeout.
Inactivity timeout.
Time to live timeout.
--abandoned_connection_timeout
Abandoned connection timeout.
Lower threshold limit.
Property check interval.
Should connection be validated or not.
beectl modify_connection_pool --connection_pool 232323-der344-455-3455ded --max_connections 40
Modifies given database configuration.
beectl modify_database --database <database instance id or alias> [--schema_name <schema name>] [--connect_string <connect string>] [--schema_password <schema password>] [--xa_service_names <xa schema name> [--xa_service_names < xa schema name>] .. ] [--ons_entry <ons name host:port> [--ons_entry < ons entry host:port>] .. ] [--parent_database <system object identifier of the parent database>
Database system object identifier.
Schema name.
Connection descriptor.
Schema password.
Multiple values of xa service names can be given. See the usage.
Notification server details in form of host:port.
System object identifier of the parent database. When '--parent_database' option presents, all the options other than '--database' will be ignored.
beectl modify_database --database ab222-aa4-eee333-ddede5 --schema_name schema1
This command applies the specified template(s) to the local BeehiveInstance. Execute beectl list_deployment_templates command to view the available templates.
beectl modify_deployment_structure --primary_template <primary template name> [(--supplementary_template <supplementary template name>) ...] [--physical_memory_available <physical memory>] [--number_of_processors_available <no of processors>] [--bti_control_port <bti control port>] [--bti_server_port <bti server port>] [--disable_sizing] [--cold_add_delete] [--do_not_restart_at_end] [--update_oc4j_soa] [--console_output_verbosity <verbosity level>] [--no_extraction_after_cold_upgrade]
Identifier of the primary template to be applied. The command beectl list_deployment_templates displays the identifiers of available templates.
Identifier(s) of the supplementary template(s) to be applied. The command beectl list_deployment_templates displays the identifiers of available templates. A Supplementary Template represents the deployment structure of an oc4j with auxiliary services which augment the structure of the local midtier without changing the primary template.
Amount of physical memory in MB or GB allocated to this BeehiveInstance. For eg 600MB or 10GB. This option updates the property AvailablePhysicalMemoryInMB of the local BeehiveInstance and is used in sizing. This option need not be provided if the value of this property is already set as needed.
--number_of_processors_available
No of processors allocated to this BeehiveInstance. This option updates the property AvailableNumberOfProcessors of the local BeehiveInstance. This option need not be provided if the value of this property is already set as needed.
BTI control port. This port is used to get BTI heartbeat by the OPMN daemon. This option is useful to configure or re-configure BTI control port and it need not be specified if BTI is already correctly configured on this midtier.
BTI server port. This option is useful to configure or re-configure BTI server port on this midtier and it need not be specified when BTI is already correctly configured on this midtier.
Disable automatic sizing. Create only the minimum number of oc4j instances per oc4j template.
If specified, addition and deletion of j2ee components happens in cold mode. By default this happens in hot mode.
If specified, the components are not restarted after deployment. By default components are restarted after deployment.
If specified, the oc4j_soa will also be updated. By default, oc4j_soa will not be updated.
Specifies verbosity level of the console output from the command. Valid values are FINE, INFO, MINIMAL .
Below command will apply the mentioned primary and supplementary templates to current midtier. This command "may" wipe off existing deployment structure of the midtier.
beectl modify_deployment_structure --primary_template SERVER_ONLY --supplementary_template EXAMPLE_SUPPLEMENTARY_TEMPLATE --supplementary_template ANOTHER_EXAMPLE_SUPPLEMENTARY_TEMPLATE
Below command will apply the mentioned supplementary template to current midtier without changing any other deployment structure. Configured minimum number of oc4j instances for the specified supplementary template are created.
beectl modify_deployment_structure --supplementary_template EXAMPLE_SUPPLEMENTARY_TEMPLATE --disable_sizing
If --console_output_verbosity <verbosity level> is also provided on command line, console output will be controlled by specified verbosity level.
Modifies the device with the given identifier.
beectl modify_device --device <identifier of the device> --status <status of the device>
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
Specify the status of the device. The following are the valid device statuses: ACTIVE PROVISIONED BLACKLISTED LOCKDOWN .
beectl modify_device --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --status BLACKLISTED
Modifies the directory id and locator for a given directory entry. This command can be used to convert a directory user to an external directory user and vice versa. This command must be executed before a deleted user in the directory gets synced with the Oracle Beehive server, otherwise this change deletes the Oracle Beehive user (user marked for deletion).
beectl modify_directory_entry --identifier <identifier> --directory_profile <+/-profilename> --directory_identifier <+/-directory-locator> [-- no_validate]
Object identifier. This command supports user and group identifiers. Permitted value is String. This option is mandatory.
Profile name. Use this option to change the directory profile with which the user is currently syncing. Permitted value is String. This option is mandatory.
Directory Locator of the user. Use this option to modify the directory locator of the user, so that a current Oracle Beehive user can be synced with another directory entry present in LDAP. Permitted value is String. This option is mandatory.
Skips the validation of directory profile name and directory identifier.
This command can be used in the following scenarios:
If you want to sync an Oracle Beehive user with different GUID present in the current LDAP or new LDAP without deleting the user in Oracle Beehive.
If you want to sync an Oracle Beehive user with new LDAP by changing directory profile without deleting the user in Oracle Beehive.
beectl modify_directory_entry --identifier user=user1 --directory_profile MyDirectoryProfileName --directory_identifier A12345
The modify_directory_profile command modifies an existing directory profile. Modification to the profile name cannot be done.
beectl modify_directory_profile --file <filename> [ --no_validate ]
XML file containing directory profile.
Skips the validation of profile against the directory server.
beectl modify_directory_profile --file MyDirectoryProfile.xml
beectl modify_directory_profile --file MyDirectoryProfile.xml --no_validate
Modifies Email service' SMTP or IMAP port number
beectl modify_email_port --type <smtp|imap> --port <port_number>
Specifies type of the port to be modified. Valid values are imap and smtp.
Port number for the specified port type.
beectl modify_email_port --type smtp --port 1234
Enables or disables Email asynchronous queue processing
beectl modify_email_queue --type <enable|disable|process|status>
Acceptable options are enable,disable,process,status
beectl modify_email_queue --type enable
Resume or enable queue processing.
beectl modify_email_queue --type disable
Disable queue processing.
beectl modify_email_queue --type process
Process all the messages in the email asynchronous queue immediately.
beectl modify_email_queue --type status
Show current status.
Modifies an existing enterprise
beectl modify_enterprise --enterprise <Enterprise identifier> [--name <Enterprise name>] [--description <Description>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--sub_organization_quota <Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--team_workspace_hard_quota <Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --team_workspace_soft_quota <Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_workspace_hard_quota <Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --personal_workspace_soft_quota <Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_template <Personal workspace default template identifier>] [--team_template <Team workspace default template identifier>]
Enterprise identifier
Enterprise name
Description
Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
--personal_workspace_hard_quota
Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
--personal_workspace_soft_quota
Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Personal workspace default template identifier
Team workspace default template identifier
beectl modify_enterprise --enterprise enpr=test_enterprise --name New_Name --description New_description
beectl modify_enterprise --enterprise enpr=test_enterprise --hard_quota 10000 --sub_organization_quota 1500 --team_workspace_hard_quota 1000 --team_workspace_soft_quota 1000 --personal_workspace_hard_quota 1000 --personal_workspace_soft_quota 1000 --team_template wstp=team_wksp_template,enpr=test_enterprise --personal_template wstp=personal_wksp_template,enpr=test_enterprise
Modifies the expertise background jobs.
beectl modify_expertise_background_job { --job <job> [--start_hour <start hour>] [--start_minute <start minute>] [--frequency_minute <frequency minute>] [--enable <enable>] [--stop <stop>] }
Job type of the expertise background job. Allowed values are CONFIDENCE_UPDATER, PROFILING_HANDLER, PROFILE_OPTIMIZER, PROFILE_TRANSFER, RELATIONSHIP_HANDLER and WHOIS_HANDLER.
The scheduled start hour of the job, 0 to 23 inclusive.
The scheduled start minute of the job, 0 to 59 inclusive.
The scheduled frequency of the job, in minutes.
; | --email <Email address of the disables it.
Flag to stop the job. True stops the job, false has no effect.
beectl modify_expertise_background_job --job PROFILE_TRANSFER --start_hour 16 --frequency_minute 240
beectl modify_expertise_background_job --job PROFILE_TRANSFER --enable False
beectl modify_expertise_background_job --job RELATIONSHIP_HANDLER --stop True
The modify_expertise_entity_searchability command controls whether the specified entity will be searchable or not.
beectl modify_expertise_entity_searchability { --entity <identifier> --terms_searchable <true/false> | --relationships_searchable <true/false> }
Identifier of the entity whose searchability is to be modified.
Whether the entity should be searchable for terms after expertise profiling.
Whether the entity should be searchable for relationships after expertise profiling.
beectl modify_expertise_entity_searchability --entity 3F5B:23D3:user:40EA125BD4941FBEE040578CA8027E89000000030E6F --terms_searchable true
beectl modify_expertise_entity_searchability --entity user=user1,enpr=oracle --terms_searchable false --relationships_searchable true
The modify_expertise_profiling_configuration command modifies the expertise profiling configuration. The profiling configuration information is supplied in an XML file.
beectl modify_expertise_profiling_configuration --file <filename>
Filename of the XML file containing expertise profiling configuration definition.
beectl modify_expertise_profiling_configuration --file MyProfilingConfig.xml
The modify_expertise_stop_phrases command modifies (add/remove) stop phrases for Expertise service. The phrases are supplied in a XML file
beectl modify_expertise_stop_phrases --enterprise <enterpise> --action [add|remove] --file <filename> --phrase <phrase>
Identifier of the enterprise for which the stop phrases will be modified.
Action add or remove to be performed.
XML file containing stop phrases.
Stop phrase.
beectl modify_expertise_stop_phrases --enterprise <enterpise> --action add --file AddESP.xml
beectl modify_expertise_stop_phrases --enterprise <enterpise> --action add --phrase phrase1 --phrase phrase2 --file AddESP.xml
The modify_expertise_user_scope command modifies expertise user scope. The expertise user scope information is supplied in a XML file.
beectl modify_expertise_user_scope --file <filename>
Filename of the XML file containing bodn, description, include_list and exclude_list for the extertise user scope to be modified.
beectl modify_expertise_user_scope --file MyUserScope.xml
The modify_external_contact command modifies existing external contact.
beectl modify_external_contact { --contact <identifier of external contact > | --email <ostal-code>?c=<contact> } [ --family_name <+/-[locale:]family name> ... ] [ --given_name <+/-[locale:]given name> ... ] [ --display_name <+/-[locale:]display name> ... ] [ --middle_name <+/-[locale:]middle name> ... ] [ --job_title <+/-[locale:]job title> ... ] [ --prefix <+/-[locale:]prefix> ... ] [ --suffix <+/-[locale:]suffix> ... ] [ --nick_name <+/-[locale:]nick name> ... ] [ --scope <identifier of contacts parent> ] [ --office_location <office location of the contact> ] [ --company <company of the contact> ] [ --profession <profession of the contact> ] [ --timezone <timezone of the contact> ] [ --locale <locale of the contact> ] [ --department <department of the contact> ] [ --organization <organization identifier> ... ] [ --remove_organization <organization identifier> ... ] [ --property <+/-name(assistant|certificate|notes)=value=description> ... ] [ --address <+/-type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ] [ --status <status of contact(enabled|disabled|locked)> ]
The identifier of the external contact
Email id of the external contact
Family name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Given name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Display name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Middle name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Job title of the contact in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Prefix of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Suffix of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Nick name of the contact in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Identifier of the enterprise under which this contact will be created.
Office location of the contact.
Company of the contact.
Profession of the contact.
Timezone of the contact. list_timezones lists the valid timezones
Locale details of the contact. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Department of the contact.
Identifiers of the organizations the contact must be part of.
Identifiers of the organizations the contact must be removed from.
Details of the property in the format [+/-]name=value=description. Supported names are certificate, assistant and notes. Note, no equals to symbol(=) should be present in the name or value or description. + or no symbol means the property should be added. If - is specified that means the property should be removed. Default action is addition.
Address of the contact in the format [+/-]type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25. + or - in the start of the string tells whether the address should be added or removed. + or no symbol means the address should be added. If - is specified that means the address should be removed. Default action is addition.
Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Address of the contact in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Primary address of the contact in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Sets the provisioning status of the external contact. Sets the provisioning status of the user. Supported values are ENABLED, DISABLED, LOCKED.
beectl modify_external_contact --contact 6A95:21EB:extp:D9E9FC8134544BCE9D60559F9B997CCD000000000000 --given_name User1GivenName --family_name -en_CA:User1FamilyName --office_location 4A037
beectl modify_external_contact --email contact1@example.com --property +prop1:prop1value
beectl modify_external_contact --email contact1@example.com --address +BUSINESS_1:mailto:contact1@example.com --address -BUSINESS_2:im:contact2@example.com
beectl modify_external_contact --email contact1@example.com --status disabled
Retry actions that have not completed successfully.
beectl modify_failed_action_events --retry --bucket <Partition number> --sequence <Sequence number>
Retry the failed action event.
Partition number
Sequence number
beectl modify_failed_action_events --retry --bucket MyBucketNumber --sequence MySequenceNumber
The modify_feed_configuration command modifies existing feed configurations.
beectl modify_feed_configuration { --feed_configuration <feed configuration> | --scope <scope identifier> --feedtype <feed type > [--name <name >] [--title <title >] [--description <description >] [--image <image >] [--language <language >] [--copyright <copyright>] [--webmaster <webmaster>] [--managing_editor <managing editor>] }
Collabid of the feed configuration to be modified
Scope in which the feed configuration will be created
Feed type of the feed configuration. Permitted values are ANNOUNCEMENT, FORUM, FOLDER, LABEL, RECENT, TOPIC and VERSION.
Name of the feed configuration.
Title associated the feed configuration
Description associated the feed configuration
Image associated with this feed configuration
Language associated with the feed configuration
Copyright associated with the feed configuration
Webmaster associated with the feed configuration
Managing Editor associated with the feed configuration
beectl modify_feed_configuration --scope enpr=example --feedtype RECENT --name MyFeedConfiguration --title BeehiveFeedConfiguration --description This is my beehive feed configuration.
beectl modify_feed_configuration --feed_configuration 6790:39AC:afrf:52921E226193384EE040578C5C84269C0000000ABB75 --name ForumFeedConfiguration --description This is a forum feed. --image ForumLogo.gif --language en
The modify_group command modifies a group. The group information is supplied in an XML file.
beectl modify_group --file <filename> [ --ldapbootstrap ]
Filename of the XML file containing group definition.
LDAP bootstrap flag. If this flag is specified, then uds groups will be created with directory locator and directory id. This is relevant only when --file option is used.
beectl modify_group --file MyGroups.xml
beectl modify_group --file MyGroups.xml --ldapbootstrap
Modifies the configuration repository for hostname of the system and updates required configuration files.
beectl modify_hostname [--start_at_end] [--no_dns_validation] [(--sync | --new_host_name <new host name> [--old_host_name <old host name>]... )] [--ignore_validation_warnings]
If specified, command will read values from configuration repository and sync it to the system configuration files.
New host name of the local server.
Old host names of the local server. This value will be used to replace any of the old host name pattern available in local files.
If specified, components on current beehive instance will be started after modification to configuration files.
If specified, DNS lookup validation of the new host name will not be performed.
If specified, commands using validation framework will ignore the warnings and continue.
beectl modify_hostname
Above command will read the values from file system and updates configuration files and configuration repository with it.
beectl modify_hostname --sync --old_host_name oldhost1.example.com --old_host_name oldhost2.example.com
Above command will read the values from configuration repository and update it to all configuration files. There will be no configuration repository updates when this option is used.
beectl modify_hostname --new_host_name demo.example.com --old_host_name oldhost1.example.com --old_host_name oldhost2.example.com
Above example will update configuration repository as well as all other configuration files with new hostname.
Note: Shutdown the midtier before running this command.
This command does not modify iAS instance name.
If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.
Modifies existing instant message preferences of a user.
beectl modify_im_preferences --user <user identifier or alias> [--archive <true|false>] [--archive_folder <folder identifier or alias>] [--offline_delivery_channel <mailto|pull>]
The user whose instant message preferences are to be modified.
Knob to turn user archiving on/off. Set it to true to turn it on or false otherwise.
Folder to keep the instant message archive for this user.
Effects the mode of offline message delivery. A value of "pull" refers to the semantics wherein the messages are kept with the server and are explicitly fetched by a client facing service on behalf of the user upon his next login. A value of "mailto" on other hand refers to the semantics wherein the offline message will be right away sent as an email to the user.
beectl modify_im_preferences --user user=beehive_test1 --offline_delivery_channel mailto
beectl modify_im_preferences --user 6C3E:0532:user:88E1F9EA3DD341A6B2E18768F17AC838000000000000 --archive true
Modify a remote iSchedule Server configuration.
beectl modify_ischedule_server --name <name> [--domain_regexp <regexp>] [--outgoing_url <remote_url>] [--outgoing_auth_id <auth_id>] [--outgoing_auth_key <auth_key>] [--incoming_auth_id <auth_id>] [--incoming_auth_key <auth_key>] [--incoming_allow_ip_regexp <regexp>] [--incoming_allow_host_regexp <regexp>]
Name of the remote server configuration, can contain only alpha numerical characters, underscores and dashes.
Regular expression that must match the remote user's email address.
Address of the remote iSchedule server.
Authentication ID that must be used when connecting to the remote server.
Key that must be used when connecting to the remote server.
Authentication ID that the remote server must use when connecting to the Oracle Beehive server.
Key that the remote server must use when connecting to the Oracle Beehive server.
IP Addresses connecting to the Oracle Beehive server must match this regular expression
Host names connecting to the Oracle Beehive server must match this regular expression
beectl modify_ischedule_server --name remoteserver --domain_regexp ".*@example.com" --outgoing_url http://remoteserver@example.com/ischedule
Modifies the changelog number of a profile.
beectl modify_ldap_change_number --profile <profilename> --changelog_number <changelognumber>
Name of the profile.
Changelog number of the profile.
beectl modify_ldap_change_number --profile MyDirectoryProfileName --changelog_number 100
Replaces an Access Control Entry (ACE) in the Local Access Control List (LACL) of an entity.
beectl modify_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
Specify the unique identifier of the entity in which the ACE will be replaced.
Specify the unique identifier of the Accessor to whom the access types will be applied.
Specify the access types string for the Accessor.
beectl modify_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D
This command updates configuration files local to current midtier with activated changes to centralized configuration. It can restart one or more components on current midtier if needed to make the changes take effect. Some updates to local configuration files require this command to restart all midtier components.
beectl modify_local_configuration_files [--restart_needed] force_apply
Indicates if components should be restarted or not. If this option is specified with value false then no component will be stopped/restarted even though changes to local configuration files require a restart of one or more components for taking effect. If this option is specified with value true, and if the changes to local configuration files require a restart of one or more already running components then they will be restarted. The components which were NOT running will NOT be restarted.
If specified, commands using validation framework will ignore the warnings and continue.
beectl modify_local_configuration_files
Above command will update local configuration files with changes if any and restart one or more midtier components if needed.
beectl modify_local_configuration_files --restart_needed false
Above command will not restart any component but it will display warnings about components which need to be restarted due to changes to local configuration files.
If --ignore_validation_warnings is also specified, warnings from validation framework will be ignored and command execution will continue.
The modify_max_address_count command modifies maximum number of addresses of an address type that can be set for a given person-contact, group-contact or resource-contact in an address-book. The address types determine the type of address like BUSINESS, PERSONAL & OTHER. The maximum count specified in this command must be less than the system defined maximum limit, which can be determined by running list_max_address_count command.
beectl modify_max_address_count --max_address_count <integer value>
Maximum number of addresses of an address-type.
beectl modify_max_address_count --max_address_count 5
Modifies a specified notification template for the Notification service.
beectl modify_notification_template --file <path to the xml instruction file>
Specify the full path and file name of the notification XML file.
beectl modify_notification_template --file /tmp/nms/UpdateNewInvitationTemplate.xml
Modifies oc4j administrator password in central configuration.
beectl modify_oc4j_administrator_password --admin_password <oc4j adminisrator password>
New password of the oc4j administrator for Beehive.
beectl modify_oc4j_administrator_password --admin_password <secure string>
Modifies an existing organization
beectl modify_organization --organization <Organization identifier> [--name <Organization name>] [--description <Description>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--sub_organization_quota <Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--team_workspace_hard_quota <Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --team_workspace_soft_quota <Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_workspace_hard_quota <Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --personal_workspace_soft_quota <Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--personal_template <Personal workspace default template identifier>] [--team_template <Team workspace default template identifier>]
Organization identifier
Organization name
Description
Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Default sub-organization quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Default team workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Default team workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
--personal_workspace_hard_quota
Default personal workspace hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
--personal_workspace_soft_quota
Default personal workspace soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Personal workspace default template identifier
Team workspace default template identifier
beectl modify_organization --organization orgn=test_org,enpr=test_enterprise --name New_Name --description New_description
beectl modify_organization --organization orgn=test_org,enpr=test_enterprise --hard_quota 10000 --sub_organization_quota 1500 --team_workspace_hard_quota 1000 --team_workspace_soft_quota 1000 --personal_workspace_hard_quota 1000 --personal_workspace_soft_quota 1000 --personal_template wstp=personal_wksp_template,enpr=test_enterprise --team_template wstp=team_wksp_template,enpr=test_enterprise
Add, append or removes the patch information from the given archives.
beectl modify_patch_information (--archive_file_list <file containing list of archives> | --archive_directory <directory containing archives> | --archive_file <archive name> [--archive_file <archive name> ...]) (--upgrade_conf <patch of upgrade.conf> | --add_patch <patch id > [--private_patch] [--constituent_patch <constituent patch id> ...] | --delete_patch <patch id to delete> [--delete_patch <patch id to delete> ...])
A simple text file containing list of archive files which needs to be acted upon. Every line in the file will be taken as one archive file entry relative to current oracle home. Non-archive files will be ignored.
Directory in which archives will be searched.
Archive file which should be acted upon.
Full path of upgrade.conf which has the upgrade information.
The specified patch will be added in all archives.
The patch specified above is a private patch.
Set of constituent patches to the above main patch.
The specified patch will be removed from all archives.
beectl modify_patch_information --upgrade_conf --archive_file_list /tmp/upgrade.conf --upgrade_conf /tmp/file_list.txt
Above command will update the archives specified in file list according to the patch information in upgrade.conf.
Modifies an existing personal workspace
beectl modify_personal_workspace --workspace <Workspace identifier> [--name <Workspace name>] [--description <Description>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --soft_quota <Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>]
Workspace identifier
Workspace name
Description
Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
beectl modify_personal_workspace --workspace wksp=test_workspace,enpr=Oracle --name New_Name --description New_description
ssage>beectl modify_port --protocol HTTP --port 80 </example_message> <exrd_quota 1000 --soft_quota 1000
Modifies an existing policy using data in an XML file.
beectl modify_policy --file <full path to the policy xml file>
Specify the absolute path of the XML file that contains the policy data.
beectl modify_policy --file /private/xml/MyPolicy.xml
Modifies an existing policy schema using data in an XML file.
beectl modify_policy_schema --file <full path to the xml file>
Specify the absolute path of the XML file that contains the policy schema data.
beectl modify_policy_schema --file /private/xml/MyPolicySchema.xml
Modifies an existing policy template using data in an XML file.
beectl modify_policy_template --file <full path to the xml file>
Specify the absolute path of the XML file that contains the policy template data.
beectl modify_policy_template --file /private/xml/MyPolicyTemplate.xml
Modifies various ports.
Valid protocols are
SMTP
IMAP
XMPP
XMPPS
FTP
HTTP
HTTPS
BTP
BTPS
OC4J-JGROUP-RANGE
OC4J-AJP-RANGE
OC4J-RMI-RANGE
OC4J-RMIS-RANGE
OC4J-JMS-RANGE
OC4J-SIP-RANGE
OC4J-AJP-RANGE identifies the range of ports in current site for either AJP or secure AJP protocol whichever is enabled.
beectl modify_port [--protocol <protocol name> [([--virtual_port <virtual port for the site>][--listen_port <listen port for protocol>] |[--port <common port value>])] [--maximum_port <maximum value in the range> --minimum_port <minimum value in the range>]] |[--component <system object identifier or alias> --name <name of the port property> --port <value of the port> ]
Name of the protocol for which port needs to be modified.
Port to which the clients will connect. This value will be modified for the entire site.
The actual port which will be opened on each midtier. Typically a listening port.
Convenience option to set both --virtual_port and --listen_port together with same value.
Identifier of the configuration component to be modified. Combined with --name, this option can be used to modify internal ports. For example control port of the Bti or request port of opmn.
Name of the internal port property on the configuration object identified by --component option.
Some components allocate free port dynamically during process start. For such processes, only the permitted port range is managed. This option can be used to modify the maximum value of the range for the given protocol.
Some components allocate free port dynamically during process start. For such processes, only the permitted port range is managed. This option can be used to modify the maximum value of the range for the given protocol.
beectl modify_port --protocol HTTP --virtual_port 80 --listen_port 7774
Above example modifies virtual and listen port values for HTTP protocol for all midtiers.
beectl modify_port --protocol HTTP --port 80
Above example modifies virtual and listen port values to same given port value for HTTP protocol for all midtiers.
beectl modify_port --protocol HTTPS --port 7445 --component c093d4cc-d9cc-42ae-bc45-4b31fab07190
Above example modifies listen port value for HTTPS protocol for given HttpServer configuration component. This can also be achieved using the beectl modify_property command.
beectl modify_port --component c093d4cc-d9cc-42ae-bc45-4b31fab07190 --name RequestPort --port 2003
Above example modifies port value identified by name RequestPort for given configuration component specified by option --component. This can also be achieved using the beectl modify_property command.
beectl modify_port --protocol OC4J-AJP-RANGE --maximum_port 20601 --minimum_port 20700
Above example modifies port range values for given protocol for all OC4Js in all midtiers. Use option --component to specify the identifier of the OC4J to be modified.
The modify_preference_set command modifies the preference set by setting the extends from attribute.
beectl modify_preference_set --set <Preference set identifier> --extends <Preference set identifier>
Identifier of the preference set specified in id format, which can be determined by running list_preference_sets command with "--entity_format id" option.
Identifier of the preference set from which the new preference set is extended.
beectl modify_preference_set --set prfs=set1,user=user1 --extends prfs=set2,user=user2
Modifies the value(s) of a named property of the component identified by --component. Multiple values can be set for one property.
Note :- Option value should not start with hyphen(-). If an option value starts with hyphen, use any one of the following syntaxes. 1. Use <option-name>=<option value> format. This is the preferred way to specify the option values starting with hypens. 2. Prepend the option value with string "ESCAPE:". 3. Prepend the option value with backslash "\\". This is the least preferred way. This may not work in some platforms, esp in windows platforms it will not work.
beectl modify_property --component <system object identifier or alias> --name <name> [ --file <filename> | --revert_to_default | --value <value>... ]
component id.
Name of the property.
Value of the property.
The contents of this file would be assigned as the value of the specified property. The property MUST be of type String.
flag indicating, if values need to be reverted back as original.
The command execution shown below would set the BaseLogLevel property of the config object to FINE.
beectl modify_property --component 486318ac-f162-477b-814f-140836c257af --name BaseLogLevel --value FINE
The command execution shown below would revert back the BaseLogLevel property of the config object to the initial default value, if any. If there is no initial default value configured for this property on this config object then the value would be cleared.
beectl modify_property --component 486318ac-f162-477b-814f-140836c257af --name BaseLogLevel --revert_to_default
The command execution shown below would set the contents of the specified file as the value of the PostResolutionRules property of the config object. The property PostResolutionRules must be of type String.
beectl modify_property --component 520118ac-f162-477b-814f-452106c257cb --name PostResolutionRules --file /tmp/post_resolution_rules.xml
The command execution shown below would set the values starting '-' to the StartParameter property of the config object. The property StartParameter must be of type String.
beectl modify_property --component 520118ac-f162-477b-814f-452106c257cb --name StartParameter --value="-Dhttp.maxFileInfoCacheEntries=-1 -ms128M -mx512M"
Modifies the name and/or the description of a Remote Repository.
beectl modify_remote_repository --scope <Remote Repository Container.> --name <Remote Repository Name.> [ --new_name <The new name for the Remote Repository.> ] [ --new_description <The new description for the Remote Repository.> ] [ { --online <Turn the repository online.> | --offline <Turn the repository offline.> } ]
Remote Repository Container.
Remote Repository Name.
The new name for the Remote Repository.
The new description for the Remote Repository.
Turn the repository online.
Turn the repository offline.
beectl modify_remote_repository --scope myRemoteRepositoryScope --name myRemoteRepositoryName --new_name myNewRemoteRepositoryName --new_description myNewRemoteRepositoryDescription --offline
Modifies the name and/or the description of a Remote Share.
beectl modify_remote_share --scope <Remote Share Container.> --name <Remote Share Name.> [ --new_name <The new name for the Remote Share.> ] [ --new_description <The new description for the Remote Share.> ] [ { --online <Turn the share online.> | --offline <Turn the share offline.> } ]
Remote Share Container.
Remote Share Name.
The new name for the Remote Share.
The new description for the Remote Share.
Turn the share online.
Turn the share offline.
beectl modify_remote_share --scope myRemoteShareScope --name myRemoteShareName --new_name myNewRemoteShareName --new_description myNewRemoteShareDescription --offline
This command set the given category as resource root classification.
beectl modify_resource_classifications [--enterprise <enterpriseid>] --category <categoryid>
Deprecated option. Use --scope instead.
Category identifier to set as root classification.
beectl modify_resource_classifications --category 395A:346B:catg:2C5F7E98E076D382E040578CA60B0D0E000000062022
Modifies an existing resource.
beectl modify_resources {--resource resourceid | --select_by_name name } [--name <name>] [--email_address <email address>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>] [--identifier <identifier>] [--booking_info <booking info>] [--description <description>] [--timezone <timezoneid>] [--location <location>] [--capacity <capacity>] [--add_approver <approverid>][--delete_approver <approverid>] [--booking_characteristics <[O]pen>|<[F]CFS>] [--scope <organization>] [--custom_processing <[T]rue>|<[F]alse>] [--accessible_by <everyone | nobody | groupid | userid> ] beectl modify_resources {--resource resourceid | --select_by_name name } --external [--name <name>] [--email_address <email address>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>] [--capacity <capacity>] [--timezone <timezone name>] [--location <location>] [--booking_info <booking info>] [--description <description>] [--scope <organization>]
Resource ID.
modify a resource by name
Modify the name of the resource.
Modify the BUSINESS_1 e-mail address of the resource.
Modify the BUSINESS_1 phone number of the resource.
Modify the BUSINESS_1 web site of the resource.
Specify the BUSINESS_1 postal address of the resource. The required format is: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country>. All fields are optional but at least one field must appear in a valid address of this type. For example, orapostal:l1=1, Main Street is a valid address. The ? character must not be encoded when used as a separator; it must be encoded in all other cases. For example orapostal:l1=1?l2=Which Street%3F?code=12345 is a valid address; but orapostal:l1=1?l2=Which Street??code=12345 is not a valid address because the question mark appearing as part of the address "Which Street?" is not encoded.
Modify the timezone of the resource.
e="sensitivity" mandatory="true" data_type="BOMe. It must be a xHTML string.
Modify the identifier of the resource.
Modify the capacity of the resource.
Modify an external resource. If this option is not specified, the command modifies bookable resources.
Resource approver to add.
Resource approver to delete.
Specify resource default calendar booking characteristic. Specify [O] for Open or [F] for First Come First Serve, case insensitive.
Specify resource booking information. It must be a xHTML string.
Specify the description of the resource. It must be a xHTML string.
Specify the new enterprise/organization the resource will be attached to.
Specify if this resource requires custom processing. Specify "T", "True", "F" or "False", case insensitive.
Specify who can access this resource. It must be one of "everyone", "nobody", a group id or finally a user id, case insensitive. Use "everyone" to reset the accessibility to the default for the resource.
beectl modify_resources --resource 395A:346B:bkrs:2C5F7E98E076D382E040578CA60B0D0E000000062327 --name "Resource2" --capacity 3
Modifies an existing RoleDefinition entity.
beectl modify_role_definition --role_definition <unique identifier of the RoleDefinition> [--name <name of RoleDefinition>] [--description <description>] [[--privilege <privilege name>]...] [[--add_privilege <privilege name>]...] [[--remove_privilege <privilege name>]...] [--access_types <access types string>] [--always_enabled <boolean value>]
Specify the unique identifier of the RoleDefinition to be modified.
Modify the name of the RoleDefinition.
Modify the description of the RoleDefinition.
Modify the privileges of the RoleDefinition. To determine a list of valid privilege arguments, use the list_privileges command. This option can be specified more than once.
Add privileges to the RoleDefinition. To determine a list of valid privilege arguments, use the list_privileges command. This option can be specified more than once.
Remove privileges from the RoleDefinition. To determine a list of valid privilege arguments, use the list_privileges command. This option can be specified more than once.
Modify the access types for the RoleDefinition.
Modify the AlwaysEnabled option of the RoleDefinition. Specify the TRUE argument to enable, and FALSE to disable.
beectl modify_role_definition --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition2
This command updates the sensitive property of the system model object identified by the --component.
Note :- Option value should not start with hyphen(-). If an option value starts with hyphen, use any one of the following syntaxes. 1. Use <option-name>=<option value> format. This is the preferred way to specify the option values starting with hypens. 2. Prepend the option value with string "ESCAPE:". 3. Prepend the option value with backslash "\\". This is the least preferred way. This may not work in some platforms, esp in windows platforms it will not work.
beectl modify_secure_property --component <system object identifier or alias> --name <name> --value <obfuscated value> --obfuscated
component id.
Name of the property.
Value of the property.
beectl modify_secure_property --component d4261c24-e917-4e37-9777-41799ef9abe8 --obfuscated --name AdminPassword --value
Modifies an existing Sensitivity entity.
beectl modify_sensitivity --sensitivity <unique identifier of the Sensitivity> [--name <name of Sensitivity>] [--description <description>] [--sensitivity_only <boolean value>] [--delegatable <boolean value>]
Specify the unique identifier of the Sensitivity to be modified.
Modify the name of the Sensitivity.
Modify the description of the Sensitivity.
Modify the SensitivityOnly option for the Sensitivity. Specify the TRUE argument to enable, and FALSE to disable.
Modify the Delegatable option for the Sensitivity. Specify the TRUE argument to enable, and FALSE to disable.
beectl modify_sensitivity --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity2
Replaces an Access Control Entry (ACE) in the Sensitivity Access Control List (SACL) of a Sensitivity entity.
beectl modify_sensitivity_ace --sensitivity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
Specify the unique identifier of the Sensitivity in which the ACE will be replaced.
Specify the unique identifier of the accessor to whom the access types were applied.
Specify the access types string for the Accessor.
beectl modify_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor user=MyUser --access_types +RW-D
Modify various attributes of the selected tasklist.
beectl modify_tasklist { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> --select_by_user_name <user_name> | --select_by_resource_name <resource_name> | --select_by_workspace_name <workspace_name> } [--name <name>] [--priority <priority>] [--sensitivity <sensitivity>] [--caldav_resource_name <caldav_resource_name> [--derive_timezone <derive_timezone>] [--timezone <timezone>]
Specify the unique identifier of a tasklist.
Specify the unique identifier of a user, resource or team workspace.
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.
Specify the login name of a user.
Specify the name of a user.
Specify the name of a resource.
Specify the name of a team workspace.
Modify the tasklist name.
Modify the default priority of the tasklist. Permitted values are HIGH, MEDIUM, LOW and NONE, case insensitive.
Modify the default sensitivity of the tasklist. Permitted values are PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL and PRIVATE, case insensitive.
Modify the caldav resource name of the tasklist.
Modify the tasklist's 'derives timezone from the owner' configuration. Permitted values are Y (derive the tasklist timezone from its owner's timezone) or N.
Modify the timezone of the tasklist.
beectl modify_tasklist --select_by_address user@example.com --name newName
Modify access permissions for grantee (user or group) on the specified tasklist.
beectl modify_tasklist_permissions { --tasklist <tasklistid> | --tasklistowner <unique_identifier> | --select_by_address <uri> | --select_by_authuser <authuser> | --select_by_user_name <user_name> } --user <userid> | --group <groupid> [--user_principal | --delegated_principal] [--can_assign | --cannot_assign] [--manage <sensitivity> ...] [--read <sensitivity> ...] [--deny <sensitivity> ...]
Specify the unique identifier of a tasklist.
Specify the unique identifier of a user.
Specify the Uniform Resource Identifier (URI) of a user using the format 'scheme:value'. If scheme is not supplied, mailto is assumed.
Specify the login name of a user.
Specify the name of a user.
Specify the unique identifier of the target user.
Specify the unique identifier of the target group.
Set permissions to user only.
Set permissions to delegated principal only.
Specify the grantee (user or group) can assign this tasklist.
Specify the grantee (user or group) cannot assign this tasklist.
Grant manage access (delegate) to the grantee (user) on specified sensitivities of this tasklist. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
Grant read access to the grantee (user or group) on specified sensitivities of this tasklist. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
Deny the grantee (user or group) access to contents in this tasklist on the specified sensitivities. Permitted values are: PUBLIC, NORMAL, CONFIDENTIAL, PERSONAL AND PRIVATE, case insensitive.
beectl modify_tasklist_permissions --tasklistowner user=user1 --user user=user2 --can_assign --manage PUBLIC --read NORMAL --read PRIVATE
Modifies an existing team workspace
beectl modify_team_workspace --workspace <Workspace identifier> [--name <Workspace name>] [--description <Description>] [--add_participant <User or group identifier> [--role <Role definition identifier>]] [--remove_participant <User or group identifier>] [--email_address <Team workspace email address>] [--participation_mode <Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED>] [--directory_listed <TRUE|FALSE. Default value is FALSE>] [--hard_quota <Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota> --soft_quota <Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota>] [--workspace_owner <Workspace owner identifier>] [--enable_public_access <true | false>] [--public_access_role <Role definition identifier for public access>]
Workspace identifier
Add a user or group to the team workspace
Workspace role definition identifier for the participants to be added
Remove a user or group from the team workspace
Team workspace email address
Team workspace participation mode. Value can be INVITE_ONLY, OPEN, or APPROVE_REQUIRED
TRUE|FALSE. Default value is FALSE
Workspace owner identifier
Whether to enable public access. If true is specified, option public_access_role must be specified
Role definition identifier for public access
Workspace name
Description
Hard quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
Soft quota in megabytes (MB). Use 'UNLIMITED' for unlimited quota
beectl modify_team_workspace --workspace wksp=myWorkspace,enpr=Oracle --add_participant user=userId --role acrd=workspace-coordinator,enpr=Oracle --email_address teamworkspace@company.com --participation_mode OPEN --directory_listed TRUE
Modify a time zone.
beectl modify_timezones {--select_by_name <TimeZoneName> [--common] | --timezone <TimeZoneCollabId> [--common] | --reset_to_default}
Time zone ID. This option is optional and can be entered only once.
Select time zone by name. This option is optional and can be entered only once.
Set the specified time zone as common. This option is optional and can be entered only once.
Reset time zones to factory default. This option is optional and can be entered only once.
beectl modify_timezones --select_by_name America/New_York
beectl modify_timezones --reset_to_default
This command modifies the details of the trusted identity. At least one of the options new_service_name or new_key_alias need to be specified for this modification if the type is WSSEC. If the type of identity is not specified, it is defaulted to WSSEC.
beectl modify_trusted_identity [--type WSSEC --service_name <Trusted Identity Name> [--new_service_name <New Trusted Identity Name>] [--new_key_alias <new key alias>]] [--type S2S --service_name <Trusted Identity Name> [--new_service_name <New Trusted Identity Name>] [--new_password <New Trusted Identity Password>]] [--type SES --name <Trusted Entity Name> --new_name <New Trusted Entity Name> --new_password <New Trusted Entity Password>]
String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
String value of the new service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
The new alias of the service which is used to register the certificate in the wallet. This option is mandatory if type is WSSEC.
String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
String value representing the name of the SES trusted entity.
String value representing the new name of the SES trusted entity.
String value representing the new password of the SES trusted entity.
update urm urls
beectl modify_urm_urls
This command has no options
beectl modify_urm_urls
The modify_user command modifies exisiting users.
beectl modify_user { --user <User Identifier> | --email <Email address of the user> } [ --family_name <+/-[locale:]family name> ] [ --given_name <+/-[locale:]given name> ... ] [ --display_name <+/-[locale:]display name> ... ] [ --middle_name <+/-[locale:]middle name> ... ] [ --job_title <+/-[locale:]job title> ... ] [ --prefix <+/-[locale:]prefix> ... ] [ --suffix <+/-[locale:]suffix> ... ] [ --nick_name <+/-[locale:]nick name> ... ] [ --scope <identifier of users parent> ] [ --office_location <office location of the user> ] [ --company <company of the user> ] [ --profession <profession of the user> ] [ --timezone <timezone of the user> ] [ --locale <locale of the user> ] [ --department <department of the user> ] [ --assistant <assistant identifier> ] [ --manager <manager identifier> ] [ --organization <organization identifier> ... ] [ --remove_organization <organization identifier> ... ] [ --login_id <+/-login_id> ] [ --login_password <password> ] [ --voice_principal <+/-voice devicenumber> ] [ --voice_pin <pin> ] [ --property <+/-name=value=description> ... ] [ --protocol_principal <+/-protocol principal> ] [ --protocol_password <protocol password> ] [ --address <+/-type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_type <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --default_address_for_scheme <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --primary_address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ] [ --status <status of user(enabled|disabled|locked)> ] [ --external_inbox <true|false> ] [ --delegate <[+][delegated_principal_name]:identifier_of_delegator or -delegated_principal_identifier> ] [ --lock <principal/account to be locked(PRIMARY|PROTOCOL|VOICE|USER)> ] [ --unlock <principal/account to be unlocked(PRIMARY|PROTOCOL|VOICE|USER)> ] [ --public_presence <ENABLE|DISABLE> ] [ --extended_enterprise_user <true|false> ]
Identifier of the user.
Exact email id of the user whose details have to be retrieved. It should be in the format user1@example.com
Family name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Given name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Display name of the user in the format: [+/-]value or [+/-]address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESSeter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Middle name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Job title of the user in the format: value or locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Prefix of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Suffix of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Nick name of the user in the format: [+/-]value or [+/-]locale:value. If only value is specified, the assumed value of locale is en_US. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc. + or - in the start of the string tells whether the parameter should be added or removed. + or no symbol means the parameter should be added. If - is specified that means the parameter should be removed. Default action is addition.
Identifier of the enterprise or organization under which this user will be created.
Office location of the user. To unset the previously defined value pass either of the following strings: NULL or null.
Company of the user. To unset the previously defined value pass either of the following strings: NULL or null.
Profession of the user. To unset the previously defined value pass either of the following strings: NULL or null.
Timezone of the user. list_timezones lists the valid timezones
Locale details of the user. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
Department of the user. To unset the previously defined value pass either of the following strings: NULL or null.
Identifier of the assistant.
Identifier of the manager.
Identifiers of the organizations the user must be part of.
Identifiers of the organizations the user must be removed from.
Details of the property in the format [+/-]name=value=description. All custom properties are supported. Note, no equals to symbol(=) should be present in the name or value or description. + or no symbol means the property should be added. If - is specified that means the property should be removed. Default action is addition.
Address of the user in the format [+/-]type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25. + or - in the start of the string tells whether the address should be added or removed. + or no symbol means the address should be added. If - is specified that means the address should be removed. Default action is addition.
Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified type. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Address of the user in the format type:scheme:value. Sets the specified address as the default for the specified scheme. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country> where all fields l1, l2, box, cy are optional but at least one of them should be present. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
Primary address of the user in the format type:scheme:value. Supported schemes are mailto, tel, fax, ftp, http, https, im, imap, ldap, news, nntp, oraalert, oraassistantphone, oracallback, oraisdn, oramobile, oracarphone, orapager, orapostal, orapush, oraradio, orasms, oratelex, orattyttd, oravmail, pres, sip, urn, xmpp. Note: orapostal should be of the format: l1=<address-line-1>?l2=<address-line-2>?box=<post-box-number>?cy=<city>?st=<state>?code=<postal-code>?c=<country>s> <option name="configuration" mandatory="true" data_type="BOM_OBJECT_ID">Version configuration to be updated.<_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
The login credentials of the user. A user can have only one login id. Hence if a user already has a login id then the old value will be replaced with the new value.
Login password.
Voice principal of the user. A user can have only one voice principal. Hence if a user already has a voice principal then the old value will be replaced with the new value.
Pin number for the voice device.
Protocol principal of the user. A user can have only one protocol principal. Hence if a user already has a protocol principal then the old value will be replaced with the new value.
Protocol password.
Sets the provisioning status of the user. Supported values are ENABLED, DISABLED.
Boolean values which indicates if user's inbox is external or not. Supported values are TRUE, FALSE.
Details of the delegated principal in the format principal_name:delegated_identifier or -delegated_principal_identifer. principal_name is the name of the delegated principal that will be created and delegated_identifier is the identifier of the actor who is being delegated. + or - in the start of the string tells whether the principal should be added or removed. + or no symbol means the delegated principal should be added. If the principal name contains a colon(:) it should be properly escaped. If - is specified that means the delegated principal should be removed. In this case only the identifier of the delegated principal has to be specified. Default action is addition. While removing the principal the minus sign (-) has to be escaped. Example: use a s ESCAPE:-. For more details on escaping please refer to beectl help.
Locks the principal sepcified. Valid values are PRIMARY, PROTOCOL, VOICE, USER. USER will lock account of the user.
Unlocks the principal sepcified. Valid values are PRIMARY, PROTOCOL, VOICE, USER. USER will unlock account as well as all the principals of the user.
Enables or disables the public presence of the users (ability of unauthorized users to see someone's presence). Supported values are ENABLED, DISABLED.
Boolean if user is an external user or not.
beectl modify_user --user user=user1 --given_name User1GivenName --family_name -en_CA:User1FamilyName --office_location 4A037
beectl modify_user --email user1@example.com --property +employee_number=1234
beectl modify_user --email user1@example.com --address BUSINESS_1:mailto:user1@example.com --address ESCAPE:-BUSINESS_2:im:user1@example.com
beectl modify_user --user user=user1 --voice_principal 1234567 --voice_pin 123423 --protocol_principal ESCAPE:-protocolPrincipal
beectl modify_user --user user=user1 --lock PROTOCOL
beectl modify_user --user user=user1 --unlock PRIMARY
beectl modify_user --user user=user1 --unlock USER
beectl modify_user --user user=user1 --nick_name +en:User1NickName --assistant user=user3 --manager user=user2
beectl modify_user --email user1@example.com --status disabled
beectl modify_user --user user=user1 --delegate DelegatedPrincipalName:user=user2
beectl modify_user --user user=user1 --delegate ESCAPE:-pcpd=CalendarDelegation2,user=rafiul2
Enables or disables an existing subscription
beectl modify_user_subscription {--enable {true|false} --subscription <Subscription identifier> | --disable_all_subscriptions_for_user <identifier of subscriber>}
Enable or disable the subscription. Permitted values are 'true' (enable subscription) or 'false' (disable subscription)
Specify the identifier of the subscription.
--disable_all_subscriptions_for_user
Specify the identifier of the subscriber who owns the subscription.
beectl modify_user_subscription --enable true --subscription 5457:7954:subs:337F34E37E8E81F1E040578C921630B700000000B864
beectl modify_user_subscription --disable_all_subscriptions_for_user user=john.smith
Updates a given version configuration.
beectl modify_version_configuration --configuration <Configuration identifier> --file <Full path of the configuration XML file>
-component 5792bd5f-3b46-42de-a15d-8
Full path of the version configuration XML file. The file must contain properly formatted data.
beectl modify_version_configuration --configuration 9941:2345:avcg:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/configuration.xml
Modifies the virus scan policy configured for the Site. Valid values for the scan policy are: NO_SCAN_OR_REPAIR, SCAN_ONLY, SCAN_AND_REPAIR. Default is NO_SCAN_OR_REPAIR.
beectl modify_virus_scan_policy [ --scanpolicy <virusscanpolicy> ]
Virus scan policy. Default is NO_SCAN_OR_REPAIR.
<beectl modify_virus_scan_policy --scanpolicy SCAN_AND_REPAIR>
Modifies an existing workspace template
beectl modify_workspace_template --template <Full path of the template file> --file <{7}>
Workspace template identifier
Full path of the template file
beectl modify_workspace_template --template wstp=test_team_ws_template,enpr=test_enterprise --file /tmp/template.xml
Obfuscates the prompted string.
beectl obfuscate [--expiration_time_in_minutes 30]
Indicates the time in minutes for which obfuscated string should be valid for the use in this Beehive instance. If "0" is passed, obfuscated string will never expire.
beectl obfuscate
(Prompted)Enter the password : [User types in the password which is not echoed on the standard output].
Recover search failures. If scope is not specified, Recover search failures from all scopes.
beectl recover_search_failures [--crawl <Recover crawl failures>] [--scope <Recover failures for this personal or team workspace scope>] [--start_date <Recover failures of entities modified on or after this date>] [--end_date <Recover failures of entities modified on or before this date>]
Recover crawl failures
Recover failures for this personal or team workspace scope
Recover failures of entities modified on or after this date
Recover failures of entities modified on or before this date
beectl recover_search_failures --crawl true --scope 4731:36F4:wspr:B886F81BB37C40708B773C94BF30B063000000000001 --start_date 2010-06-01T00:00:01 --end_date 2010-06-30T00:00:01
Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.
beectl restart [ --component <component id> | --all | --serially]
Identifier of component to restart. To restart more than one component at a time, specify this option multiple times.
restart all managed components.
It specified, restarts all the components one by one.
beectl restart --all
<option name="all" mandatory="false" data_type="BOOLEe4b86fd46f
Sends Instant Message to all online users.
beectl send_broadcast_im_message --from <IM address of user sending the message> [--subject Subject of the Instant Message to be sent to all online users] --message <Instant Message to be sent to all online users>
IM address of user sending the message
Subject of the Instant Message to be sent to all online users
Instant Message to be sent to all online users
beectl send_broadcast_im_message --from im:user1@example.com --subject announcement --message Hello
beectl send_broadcast_im_message --from im:user1@example.com --message Hello
Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.
beectl start [ --component <component id> | --all | --serially]
Identifier of component to start. To start more than one component at a time, specify this option multiple times.
start all managed components.
It specified, starts all the components one by one.
beectl start --all
beectl start --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f
Displays the status of all managed components.
beectl status [--dashboard | --detail] [--all_home_instances | --all_services | (--component <State manageable component>) ... --all_disabled_components | [--disabled_beehive_instances] [--disabled_oc4js] [--disabled_service_instances] [--disabled_services] ]
A dashboard view of all the specified components is shown.
A detailed view of all the specified components is shown.
Status of all Beehive instances is shown.
Status of all Services is shown.
Status of the specified components is shown.
Lists all the disabled components in the system is shown.
Lists all the disabled beehive instances in the system is shown.
Lists all the disabled managed oc4js in the system is shown.
Lists all the disabled service instances in the system is shown.
Lists all the disabled services in the system is shown.
beectl status
Manages OC4J Instances, Beehive Transport Infrastructure Monitors and Oracle HTTP servers components. The command "beectl status" displays the component id and the status of these manageable components.
beectl stop [ --component <component id> | --all | --serially]
Identifier of component to stop. To stop more than one component at a time, specify this option multiple times.
stop all managed components.
It specified, stops all the components one by one.
beectl stop --all
beectl stop --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f
Uploads the provider file for Apple Push Notification Service.
beectl upload_apns_keystore --file <path to the apns provider file>
Specify the full path and file name of the .p12 file.
beectl upload_apns_keystore --file $BH/beehive/seed/push/anps.p12
Upload a prompt to the database.
beectl upload_attendant_prompt --name <name of attendant> --type <type of prompt> [--language <language of prompt>] --file <prompt file>
Name of the attendant.
Type of the prompt. Can be one of language, menu, greeting, extension-prompt, extension-nomatch, option1, option2, option3, option4, option4, option5, option6, option7, option8, option9, noinput, noinput-term, nomatch, nomatch-term.
Language of the prompt.
Path to the prompt file.
beectl upload_attendant_prompt --name myAttendant --type menu --language en_US --file menu.wav
Uploads client application binaries to the repository. Either a binary file path or path to a directory containing binary files should be specified.
beectl upload_client_application { --file <path to the client binary> | --dir <full path to the directory containing the client binaries>}]
Specify the full path and file name of the client ZIP file.
Specify the full path of the directory containing the client ZIP files.
beectl upload_client_application --file $BH/beehive/seed/dm/pushmail_debug.PPC5.0_ARM.element.zip
beectl upload_client_application --dir $BH/beehive/seed/dm/
Uploads device profiles to the repository. An XML file or a directory containing XML files can be used as the source for the device profiles. The file can also contain device types and device profile schema.
beectl upload_device_profiles { --file <Full file path of the device profiles XML file> | --dir <Full path of the directory containing device profiles XML files>}
Specify the full path and file name of the device profiles XML file.
Specify the full path of the directory containing the device profiles XML files.
beectl upload_device_profiles --file /tmp/device-profiles.xml
beectl upload_device_profiles --dir /tmp/device-profiles/
Loads language pack resources into the system.
beectl upload_language_pack --source <source> [--ignore_version] [--suppress_warning] [--accept_builtin]
Source jar file containing one or more xliff files or one or more helpsets. Only a jar file is permitted as source value.
Ignore version information in the xliff files; use with caution.
Suppress warnings about potential xliff problems; only report fatal errors.
Accept xliff files or helpsets marked as built-in. This option must be used only when necessary because uploading built-in xliff files or helpsets is typically a maintenance activity. In absence of this option the command will fail if a built-in xliff file or helpset is being uploaded - this behaviour has been designed to guard against accidentally uploading built-in xliff files or helpsets.
beectl upload_language_pack --source abc.jar
Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will fail if any .xlf or helpset is of filetype builtin. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/custom/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/custom/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Command will fail if any .xlf does not contain version. The command will fail if the version of an .xlf file is prior to the version of corresponding .xlf file in existing language pack. Helpsets are not versioned hence all custom helpsets from abc.jar MUST overwrite custom helpsets of same name and same locale in same library in existing language pack.
beectl upload_language_pack --source abc.jar --accept_builtin
Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will process helpsets or xliff files of both filetypes - built-in and custom. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/<filetype>/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/<filetype>/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Command will fail if any .xlf does not contain version. The command will fail if the version of an .xlf file is prior to the version of corresponding .xlf file in existing language pack.
beectl upload_language_pack --source abc.jar --ignore_version
Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will fail if any .xlf or helpset is of filetype builtin. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/custom/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/custom/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Version info in xliff files is completely ignored i.e. all custom .xlf files from abc.jar WILL overwrite custom files of same name in existing language pack.
beectl upload_language_pack --source abc.jar --accept_builtin --ignore_version
Add/modify the xliff file(s) or helpset(s) packaged in abc.jar to existing language pack. Command will process helpsets or xliff files of both filetypes - built-in and custom. abc.jar is expected to package helpset(s) in the directory structure helpsets/<library_name>/<filetype>/<locale>/<helpset.jar>. .xlf files (and associated .class files) must be packaged in langpack/xliff/<filetype>/x.xlf and langpack/<java-package-tree>/x.class directories respectively. Version info in xliff files is completely ignored i.e. all custom .xlf files from abc.jar WILL overwrite custom files of same name in existing language pack.
Validates the configuration for given component id or for the whole system model tree.
beectl validate_configuration [ --id <system object id or alias of system object>]
component id.
beectl validate_configuration
Validates the whole configuration system model.
beectl validate_configuration --id a1d290a8-f8a7-46ea-ae3d-0696c0bde331
Validates the system model object identified by given id or alias.
e> <s the directory entry in ldap with corresponding entry in beehive. The directory entry can be of type user, group or external person. The command provides an option to correct any data inconsistencies by applying necessary changes in beehive. The state of the profile specified in this command can either be ENABLE or DISABLE.
beectl validate_directory_entry ( ([ --email <email>] | [ --identifier <bodn> ] | [ --dn <dn> ] [ --verbose ] [ --timezone_update ]) | --all_users [ --timezone_update ] | --all_groups | --all | --delete | --profile <Profile_name> [--commit]
Identifier of the user, group or external-person in beehive
Email-ID of the user, group or external-person.
DN(distinguished name) of the user, group or external-person in ldap directory
When Command is run with this option, it makes the changes in beehive database. The default is set to non-commit mode or no database changes.
This option is used display the detailed information.
Name of the profile
To reconcile all users.
To reconcile all groups.
To reconcile all users and group.
To reconcile all deleted entries.
To reconcile timezone.
beectl validate_directory_entry --email user1@example.com --profile exampleProfile --commit --verbose
beectl validate_directory_entry --dn cn=user2,cn=users,dc=example,dc=com --profile exampleProfile --commit --verbose
beectl validate_directory_entry --identifier user=user3@example.com --profile exampleProfile --verbose
beectl validate_directory_entry --all --profile exampleProfile
beectl validate_directory_entry --all_users --profile exampleProfile
beectl validate_directory_entry --all_groups --profile exampleProfile
It validates midtier for various conditions. For example, it reports the issues of database connectivity with each individual rac node.
beectl validate_midtier [--connection_string <connection string to validate>] [--schema_user <user having sysdba privilege>] [--schema_password <Password for user having sysdba privilege>]
Configuration repository connect string.
Name of the user having sysdba privilege.
Password for user having sysdba privilege.
beectl validate_midtier
Above command will use the connection string and credentials available with boot strap configuration and validate the connectivity.
beectl validate_midtier --connection_string (DESCRIPTION=(ENABLE=BROKEN)(ADDRESS_LIST=(LOAD_BALANCE=on)(FAILOVER=on)(ADDRESS=(PROTOCOL=TCP)(HOST=1234.example.com)(PORT=1234)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=mydb.example.com))) --schema_user system --schema_password 1234dedrf2wddgeyeheteeddy
Above command will use the given connection string, credential for sys user and validate the connectivity
Evaluates or executes a policy based on an event payload file.
beectl validate_policy --event_name <Event name.> --event_payload_file <Path to the event payload xml file.> --policy <The policy identifier.> { --evaluate <Evaluate this policy.> | --execute <Execute this policy.> }
Event name.
Path to the event payload xml file.
The policy identifier.
Evaluate this policy.
Execute this policy.
beectl validate_policy --event_name MyEventTypeName --event_payload_file MyEventPayloadFile.xml --policy MyPolicy --policy
Validates the given site key.
beectl validate_site_key --site_key <new site key>
Site key to be validated.
beectl validate_site_key --site_key 87hyhuh78e=122nddn356763yhd34bnh
Tests the connectivity to the virus scan engine running at the specified host and port.
beectl validate_virus_scan_engine_connectivity [ --hostname <scanengine_hostname> ] [ --port <scanengine_port> ]
Name of the host where the virus scan engine is installed. Default is localhost.
Port number used by the virus scan engine for communication with its clients. Default is 1344.
<beectl validate_virus_scan_engine_connectivity --hostname scanenginehost.example.com --port 1344>
This command shows the version information of the Beehive products.
List of valid Beehive products is shown below. Use them as a value for the "product" option.
accesschecks
accesscontrol
admin
alarm
artifacts
audit
authn
beectl
beehivemail
bio
btimon
caldav
cms
collabcoex
common-framework
content
core
csi_r1
csi_r1-impl
cspi
discussions
dms
event
event-definitions
framework
ftp
im
jcr
management
mds
mgmtsvc
mobileclient
mobiledm
nms
oma
omb
owc
owc-stdmedia
platform
policy
presence
push
pushmail
rds
search
smpp
teamcollaboration
tms
tzs
uds
uss
version
virusscanner
voice
voip
webdav
wiki
workspaces
xbom
xmpp
xms
List of valid field names is shown below. Use them as a value for "field" option.
name
build_version
internal_version
internal_version_name
public_version
public_version_name
product_description
product_suite_association_ids
beectl version command output is fully customizable. The multi-valued "product" option can be used to get version information for a specified set of products. Similarly the multi-valued "field" option can be used to get the information about the specified set of fields only.
When multi-valued product and field options are used, beectl version command display order is same as the order specified for product and field options in command line.
beectl version [--all | [[--product <Product Name>] ...]] [[--field <Field Name>]...]
Shows version information for all products.
Shows version information for the specified products. This option is multi-valued.
Shows the value of the specified fields. This option is multi-valued.
beectl version --all
The above command will list the version information about all the products.
beectl version --product uds --field internal_version --field internal_version_name --field product_suite_association_ids
The above command will list internal_version, internal_version_name and product_suite information for the user directory service component.
|
 Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|