Oracle® Beehive Administrator's Reference Guide Release 1 (1.3) Part Number E10483-02 |
|
|
View PDF |
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 an 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.
The following tables list all the available beectl commands.
Table 2-1 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. |
Table 2-2 Category: audit
Utility | Function |
---|---|
Creates an audit policy from the XML file information |
|
Creates an audit policy template 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 policy template |
|
Deletes an existing audit trail |
|
Exports an existing audit trail by the given identifier |
|
Lists auditable events |
|
Lists audit policies and prints policy information |
|
Lists audit policy templates and prints template information. Use --name option for detailed information about each audit policy template |
|
Lists audit trails and prints trail information |
|
Modifies an existing audit policy |
|
Modifies an existing audit trail |
|
Validates an existing audit trail |
Table 2-3 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 enterprise with the given name. |
|
Creates a voice facility with the given name. |
|
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. |
|
Deletes a client application version. |
|
Deletes a voice enterprise with the given id. |
|
Deletes a voice facility with the given id. |
|
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. |
|
Update an existing attendant with a new markup file or rename it. |
|
Resets the seed of the password generator for IP phones. To send commands to an IP phone the requestor must be authenticated. The password is generated based on information in the phone but must be seeded to ensure security. |
|
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. If the community option is specified, the uploaded client application patchset will also be provisioned to the community. |
Table 2-4 Category: cloning
Utility | Function |
---|---|
Top level clone command that clones a Oracle Beehive Application tier. |
|
Creates a new oc4j instance by cloning the given oc4j instance. |
|
Prepares the existing oracle home for cloning. |
|
Top level clone command that clones a Oracle Beehive Application tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details. |
|
This command updates the beectl file with the given oracle home & perl home |
Table 2-5 Category: coexistence
Utility | Function |
---|---|
Configures a new coexistence connector. |
|
Deletes a coexistence connector. |
|
Deletes the coexistence profile of user. |
|
Lists all configured coexistence connectors. |
|
Lists the users configured with a coexistence profile. |
|
Reports the status of the containers and users involved in the coexistence. By default this command outputs the status of calendars, address books,email inboxes as well as of the users configured for coexistence. One can restrict the information being returned by specifying one or more of the optional parameters. |
|
Modifies the configuration of a coexistence connector. |
|
Specifies the coexistence profile of a user. |
Table 2-6 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. |
|
Configures a new coexistence connector. |
|
Creates configuration for a Beehive installation in the DMZ that is, outside the firewall. |
|
Creates system model objects for External BPEL process manager and a corresponding Bpel Cluster |
|
Configures an agent for a Universal Records Management 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 Oracle Beehive Application tier. |
|
Creates a new oc4j instance by cloning the given oc4j instance. |
|
Prepares the existing oracle home for cloning. |
|
Top level clone command that clones a Oracle Beehive Application 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 coexistence connector. |
|
Removes configuration for a Beehive installation in the DMZ that is, outside the firewall. |
|
Clears the value of specified property in the configuration object identified by specified id. |
|
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. |
|
Displays bootstrap configuration for local Oracle Beehive Application tier. |
|
Lists components in the configuration repository. |
|
Lists all available configuration versions and activation time information |
|
Lists available connection pools in the system. |
|
Displays details of the language pack resources managed by the Beehive deployment. |
|
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. |
|
This commands lists the trusted identities. The type has to be specified. For type SES, it lists the names of the trusted entities. |
|
This command updates the beectl file with the given oracle home & perl home |
|
Modify the connect string or credentials for the central configuration repository also known as bootstrap database. Misconfiguration will result in Oracle Beehive Application tier and site being not operable. |
|
Modifies the configuration of a coexistence connector. |
|
Modifies the connection pool configuration. |
|
Modifies given database configuration. |
|
Modifies the configuration repository for hostname of the system and updates required configuration files. |
|
This command updates configuration files local to current Oracle Beehive Application tier with activated changes to centralized configuration. It can restart one or more components on current Oracle Beehive Application tier if needed to make the changes take effect. Some updates to local configuration files require this command to restart all Oracle Beehive Application tier components. |
|
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. |
|
Create system model objects for Search and configure them |
|
This command updates the sensitive property of the system model object identified by the --component. |
|
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. |
|
Loads language pack resources into the system. |
|
Validates the configuration for given component id or for the whole system model tree. |
|
Tests the connectivity to the virus scan engine running at the specified host and port. |
Table 2-7 Category: contents
Utility | Function |
---|---|
Creates a reference in Beehive to a directory on the file system. |
|
Removes a file system reference from Beehive. |
|
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 file system path, read-only status, and identifier of all available file system references. |
Table 2-8 Category: devices
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 profile with the given identifier. 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 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 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 for a user. |
|
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-9 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 details of the language pack resources managed by the Beehive deployment. |
|
Loads language pack resources into the system. |
Table 2-10 Category: messaging
Utility | Function |
---|---|
Modifies Email service' SMTP or IMAP port number |
|
Enables or disables Email asynchronous queue processing |
Table 2-11 Category: organizations
Utility | Function |
---|---|
Creates an organization in the given scope |
|
Deletes an existing organization |
|
Lists all enterprises and prints names and identifiers |
|
Lists organizations in the given scope |
|
Modifies an existing enterprise |
|
Modifies an existing organization |
Table 2-12 Category: policies
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. |
|
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 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. |
|
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. |
Table 2-13 Category: process control
Utility | Function |
---|---|
Starts or stops the search crawl process for a specific source type |
|
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-14 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 |
Table 2-15 Category: records
Utility | Function |
---|---|
Adds a record or non-record. |
|
Deletes a record or non-record. |
|
Lists the file plan. |
Table 2-16 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. |
Table 2-17 Category: security
Utility | Function |
---|---|
This commands 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 commands unregisters a trusted identity. If the type of identity is not specified, it is defaulted to WSSEC. |
|
This commands 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-18 Category: subscription
Utility | Function |
---|---|
Creates a user subscription from a pre-defined rule in a subscription template. |
|
Enables or disables an existing subscription |
Table 2-19 Category: templates
Utility | Function |
---|---|
Modifies a specified notification template for the Notification service. |
Table 2-20 Category: time management
Utility | Function |
---|---|
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 will cause all sub-components to be deleted. |
|
Lists the existing calendars of a user, resource or workspace. |
|
Lists existing tasklists of a user, resource or workspace. |
Table 2-21 Category: time zones
Utility | Function |
---|---|
Imports time zone definitions to the database. |
|
Lists time zones in the database. The list can be limited by common time zones or by time zone names. |
|
Modify a time zone. |
Table 2-22 Category: users
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_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_external_contact command deletes an external contact with an option to purge. |
|
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 users configured with a coexistence profile. |
|
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_groups command lists groups that match specified search criteria. If search criteria are not specified, then all groups are listed. |
|
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. |
|
Modifies the change log number of a profile. |
|
Specifies the coexistence profile of a user. |
|
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_group command modifies a group. The group information is supplied in an XML file. |
|
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 existing users. |
|
Validates 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-23 Category: utilities
Utility | Function |
---|---|
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 the metadata about given command. |
|
Lists the command names based on the given criteria. |
|
List all error code definitions in beehive. |
|
Lists the statistics for a given type or system object or for the entire site (default). |
|
Prints the supported entity types which can be used in business object distinguished naming pattern instead of system generated identifier and their description. |
|
Obfuscates the prompted string. |
|
This command shows the version information of the Beehive products. |
Table 2-24 Category: workflows
Utility | Function |
---|---|
Deploys a workflow and seeds workflow information. |
|
Creates a workflow template using data in an XML file. |
|
Deletes a workflow schema. |
|
Deletes a workflow template. |
|
Exports a workflow template into an XML file. |
|
Lists workflow schemas. |
|
Lists workflow templates deployed in a container. Details returned include workflow template names and identifiers. |
|
List all workflows for which the active user has privileges. Specify user and status options for filtering. |
Table 2-25 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 heterogeneous folder. |
|
Creates a team workspace from a template |
|
Creates a version configuration on the given scope or heterogeneous folder. |
|
Creates a workspace template in an organization or enterprise |
|
Deletes a category and all category applications. |
|
Removes a category from an entity |
|
Deletes a given category configuration. |
|
Deletes an existing team workspace |
|
Deletes a given version configuration. |
|
Deletes an existing workspace template |
|
Downloads workspace template XML schema to a file |
|
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 |
|
Lists the category configuration on the given scope or heterogeneous folder. |
|
Lists the version configuration on the given scope or heterogeneous 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:
--format
Specify the output format type. Valid options are multiline
, xml
, table
, and tiled
. The default format is multiline
.
--separator
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 "|
".
--entity_format
Specify display format of the entity. Valid entity format options are name
, id
, and name_and_id
. Default format is name
.
--timezone_id
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.
--no_confirmation
Allow the command to be executed without prompting for any confirmation. This option applies only to remove and delete commands.
--version
Print the version information of a beectl command. This option does not require an argument.
--help
Print a usage message.
--log_level
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.
--logdir
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.
--batchfile
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.
--continue
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.
--activate_configuration
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.
--no_wrap
If specified, the cell values in the tabular format output of a command will not be wrapped.
--no_stagger
If specified, the columns of the tabular format output of a command will not be staggered.
--column_format
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.
--terminal_width
Modify the default terminal width. By default, the terminal width is 80 characters.
--obfuscated
Specify this option when all passwords passed with the command are obfuscated.
--authuser
Specify the user name for beectl commands requiring authentication.
--authpassword
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.
Notes:
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:
System Object Identifier
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
.
Built-In Alias
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.
User Defined Alias
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:
Prompt
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
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.
Clear Text
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:
--no_wrap
Specify that content wrapping will not be applied to cell values.
--no_stagger
Specify that columns will not be staggered. By default, columns will not be staggered if there are three or less columns.
--column_format
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.
--terminal_width
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.
SYNTAX
beectl activate_configuration
OPTIONS
This command has no options
EXAMPLES
beectl activate_configuration
Creates an AssignedRole entity.
SYNTAX
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>]...]
OPTIONS
--scope
Specify the unique identifier of the Scope in which the AssignedRole should be created.
--name
Specify the name of the AssignedRole.
--description
Specify a description for the AssignedRole.
--assigned_scope
Specify the unique identifier of an assigned Scope for the AssignedRole.
--role_definition
Specify the unique identifier of an assigned RoleDefinition for the AssignedRole.
--accessor
Specify the unique identifier of an Accessor to add to the AssignedRole. This option can be specified more than once.
EXAMPLES
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.
SYNTAX
beectl add_attendant { --file <AAML file> | --name <new name> --copy_from <existing attendant> }
OPTIONS
--file
An auto-attendant markup language file describing the attendant to be added. When specified, name and copy_from must be specified.
--name
Name to be given to copied attendant. When specified, copy_from must also be specified and file must not be specified
--copy_from
Name of attendant to copy. When specified, copy_from must also be specified and file must not be specified
EXAMPLES
beectl add_attendant --file example.aaml
beectl add_attendant --name copiedAttendant --copy_from someAttendant
Creates an audit policy from the XML file information
SYNTAX
beectl add_audit_policy --file <Full path of the input file>
OPTIONS
--file
Full path name of the input XML file
EXAMPLES
beectl add_audit_policy --file /tmp/policy_ex.xml
Creates an audit policy template from the XML file information
SYNTAX
beectl add_audit_template --file <Full path of the input file>
OPTIONS
--file
Full path of the input file
EXAMPLES
beectl add_audit_template --file /tmp/templ_ex.xml
Creates an audit trail from the search result generated using the XML file
SYNTAX
beectl add_audit_trail --file <Full path of the input file>
OPTIONS
--file
Full path name of the input XML file
EXAMPLES
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.
SYNTAX
beectl add_blocked_device --device <deviceid> [--description <description>]
OPTIONS
--device
Specify the local device identifier.
--description
Describe why the device is being blocked.
EXAMPLES
beectl add_blocked_device --device 981214
Creates a category at the enterprise scope
SYNTAX
beectl add_category --file <Full path of the category XML file>
OPTIONS
--file
Full path name of the XML file. The file must contain the properly formatted data to create the category
EXAMPLES
beectl add_category --file /tmp/category.xml
Applies a category on a given entity
SYNTAX
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>
OPTIONS
--category
Specify the identifier of the category.
--entity
Specify the identifier of an Oracle Beehive entity to which the category needs to be applied.
EXAMPLES
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 heterogeneous folder.
SYNTAX
beectl add_category_configuration --container <Configuration scope or heterogenous folder> --file <Full path of the configuration XML file>
OPTIONS
--container
Scope or heterogeneous folder on which the category configuration should be defined.
--file
Full path of the category configuration XML file. The file must contain properly formatted data.
EXAMPLES
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.
SYNTAX
beectl add_client_application_configuration --file <path to the XML file>
OPTIONS
--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.
EXAMPLES
beectl add_client_application_configuration --file /tmp/app-config.xml
Provisions client applications to a community.
SYNTAX
beectl add_client_application_provisioning --community <community identifier> {--configuration <client application configuration identifier>... | --all | --none | --patchset <Identifier of the client application patchset>}
OPTIONS
--community
Specify the identifier of the community.
--configuration
Specify the identifier of the client application configuration. This option can be specified more than once.
--all
Specify this option to provision the latest patchset of all client applications to this community.
--none
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.
--patchset
Specify this option to provision the specified patchset to this community.
EXAMPLES
beectl add_client_application_provisioning --community 1234:5678:entr:2E0329B0705F0E40E040578C92160957000000000434 --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434 --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
beectl add_client_application_provisioning --community 1234:5678:entr:2E0329B0705F0E40E040578C92160957000000000434 --all
beectl add_client_application_provisioning --community 1234:5678:entr:2E0329B0705F0E40E040578C92160957000000000434 --none
beectl add_client_application_provisioning --community 1234:5678:entr:2E0329B0705F0E40E040578C92160957000000000434 --patchset 21EC:0AE5:capp:406E6CD925A8F087E040578C921636E5000000000979
Configures a new coexistence connector.
SYNTAX
beectl add_coexistence_connector --name <name> {--url <url> | --use_secure_connection <use_secure_connection> --host_name <host_name> --port <port_number>} --sitekey [<obfuscated_sitekey> --obfuscated] [--timezone_alias_namespace <timezone_alias_namespace>]
OPTIONS
--name
Specify the name of the coexistence connector.
--url
Specify the URL of the coexistence connector.
--use_secure_connection
Specify whether "HTTPS" MUST be used.
--host_name
Specify the host name of the connector.
--port
Specify the port number used by the connector. Value MUST be an integer.
--sitekey
Specify the site key of the coexistence connector.
--timezone_alias_namespace
Specify the time zone alias namespace used by the connector.
EXAMPLES
beectl add_coexistence_connector --name MsExch2003_1 --url http://www.example.com:7777 --sitekey
beectl add_coexistence_connector --name MsExch2003_1 --url http://www.example.com:7777 --sitekey 5YD7Dj9/AIEgWuuAzmb7o5TULTVzqO31uby7ZcOfIY4j/mPAxT83nc8+7RK281jQ --obfuscated
beectl add_coexistence_connector --name MsExch2003_1 --host_name www.example.com --port 7777 --sitekey
Creates conference artifact under workspace
SYNTAX
beectl add_conference --parent <Workspace identifier> --name <Conference name> --template <Conference identifier>
OPTIONS
--parent
Workspace identifier
--name
Conference name
--template
Conference identifier
EXAMPLES
beectl add_conference --parent 6490:45C8:wspr:F20E3F75004040B5AE14B64B96F89C3A000000000022 --name MyConference --template 6490:45C8:owct:B3EABD85714E4DBDA92201A54EAE56C3000000002C2C
Creates conference-template artifact under workspace
SYNTAX
beectl add_conference_template --parent <Workspace identifier> --name <Conference name> --model <Conference or conference template identifier> --settings-xml-file <Conference settings XML file>
OPTIONS
--parent
Workspace identifier
--name
Conference name
--model
Conference identifier
--settings-xml-file
Conference settings XML file
EXAMPLES
beectl add_conference_template --parent 6490:45C8:wspr:F20E3F75004040B5AE14B64B96F89C3A000000000022 --name Template_from_template --model 6490:45C8:owct:B3EABD85714E4DBDA92201A54EAE56C3000000002C2C
beectl add_conference_template --parent 6490:45C8:wspr:F20E3F75004040B5AE14B64B96F89C3A000000000022 --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.
SYNTAX
beectl add_custom_user_property --name <property_name> --type <property_type> [ --description <description> ]
OPTIONS
--name
Name of the custom property
--type
Type of the property. Supported types are BOOLEAN, COLLABID, DATETIME, DOUBLE, STRING.
--description
Description of the custom property.
EXAMPLES
beectl add_custom_user_property --name employeenumber --type DOUBLE
Creates a device command for a given device.
SYNTAX
beectl add_device_command --device <identifier of the device> --action <device command action>
OPTIONS
--device
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
--action
Specify the action of the device command. The following are the valid command actions: UPLOADLOG UPLOADCONFIG CHECKUPDATE WIPEOUT .
EXAMPLES
beectl add_device_command --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --action CHECKUPDATE
The add_directory_profile command adds a new directory profile.
SYNTAX
beectl add_directory_profile --file <filename> [ --no_validate ]
OPTIONS
--file
XML file containing directory profile.
--no_validate
Skips the validation of profile.
EXAMPLES
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.
SYNTAX
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>]
OPTIONS
--hostname
Host name of the machine.
--oracle_home
oracle home path.
--bti_unique_id
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.
--no_of_client_workers
This is the number of MX processes in the DMZ Oracle Beehive Application tier. The value of this parameter should be the value of "NumberOfClientWorkers" in $OH/beehive/conf/bti.properties in DMZ Oracle Beehive Application tier.
--opmn_request_port
OPMN request port
--opmn_remote_port
OPMN remote port
--bti_server_port
The server port.
--instance_name
instance name of DMZ Oracle Beehive Application tier
EXAMPLES
beectl add_dmz_home_instance --hostname dmzhost.example.com --bti_unique_id 813130873 --no_of_client_workers 4
Creates an event subscription using data in an XML file.
SYNTAX
beectl add_event_subscription --file <full path to the event subscription xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains data to create the event subscription.
EXAMPLES
beectl add_event_subscription --file /private/xml/MyEventSubscription.xml
Creates system model objects for External BPEL process manager and a corresponding Bpel Cluster
SYNTAX
beectl add_external_bpel_pm --oc4j_instance_name <name> --oc4j_admin_password <obfuscated password> --domain <domain name> --domain_password <obfuscated domain password> --OBFUSCATED --bpel_application_name <bpel application name> --bpel_admin_password <obfuscated bpel administrator password> --host_name <hostname>--opmn_port<opmn request port>
OPTIONS
--oc4j_instance_name
OC4J instance name.
--oc4j_admin_password
OC4J admin password.
--bpel_admin_password
Bpel administrator password.
--domain
Domain id of the BPEL process
--domain_password
Domain password of the bpel process manager.
--bpel_application_name
Bpel application name.
--host_name
Host name of the machine.
--opmn_port
The OPMN Request Port to administer AS11g managed Oc4j.
EXAMPLES
beectl add_external_bpel_pm --oc4j_instance_name oc4j_soa --oc4j_admin_password pwd234 --domain domain.com--domain_password pwdefrfrfr4 --bpel_application_name orabpel --bpel_admin_password pwdefrfrfrfrf --host_name host.example.com --opmn_port 1243
The add_external_contact command adds new external contact.
SYNTAX
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 <time zone of the contact> ] [ --locale <locale of the contact> ] [ --department <department of the contact> ] [ --organization <organization identifier> ... ] [ --property <name(assistant|profession|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> ]
OPTIONS
--family_name
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.
--scope
Identifier of the enterprise under which this contact will be created.
--given_name
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
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
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
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
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
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
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
Office location of the contact.
--company
Company of the contact.
--profession
Profession of the contact.
--timezone
time zone of the contact. list_timezones lists the valid time zones
--locale
Locale details of the contact. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
--department
Department of the contact.
--organization
Identifiers of the organizations the contact belongs to.
--property
Details of the property in the format name=value=description. Supported names are certificate, assistant, profession and notes. Note, no equals to symbol(=) should be present in the name or value or description.
--address
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--default_address_for_type
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--default_address_for_scheme
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. 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
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
EXAMPLES
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
Creates a reference in Beehive to a directory on the file system.
SYNTAX
beectl add_filesystem_reference --name <file system reference name> --filesystem_path <Server path> --read_only <true or false>
OPTIONS
--name
Name to give to this file system reference.
--filesystem_path
Fully-qualified path on the file system to which this reference should point.
--read_only
Whether the referenced file system directory should be treated as read-only by Beehive.
EXAMPLES
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.
SYNTAX
beectl add_group --file <filename> [ --ldapbootstrap ]
OPTIONS
--file
Filename of the XML file containing group definition.
--ldapbootstrap
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.
EXAMPLES
beectl add_group --file MyGroup.xml
beectl add_group --file MyGroup.xml --ldapbootstrap
Adds an Access Control Entry (ACE) to an entity's Local Access Control List (LACL).
SYNTAX
beectl add_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
OPTIONS
--entity
Specify the unique identifier of the entity to which the ACE will be added.
--accessor
Specify the Accessor to whom the access types will apply.
--access_types
Specify the access types string for the Accessor.
EXAMPLES
beectl add_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor loginid=MyUser --access_types +RW-D
Creates an organization in the given scope
SYNTAX
beectl add_organization --name <Organization name> --scope <Identifier of enterprise or organization>
OPTIONS
--name
Name of the organization
--scope
Identifier of the parent scope (enterprise or organization)
EXAMPLES
beectl add_organization --name Sample_organization --scope 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453
Creates a policy using data in an XML file.
SYNTAX
beectl add_policy --file <full path to the policy xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains the policy data.
EXAMPLES
beectl add_policy --file /private/xml/MyPolicy.xml
Creates a policy schema using data in an XML file.
SYNTAX
beectl add_policy_schema --file <full path to the policy schema xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains the policy schema data.
EXAMPLES
beectl add_policy_schema --file /private/xml/MyPolicySchema.xml
Creates a policy template using data in an XML file.
SYNTAX
beectl add_policy_template --file <full path to the policy template xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains the policy template data.
EXAMPLES
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.
SYNTAX
beectl add_preference_profile --consumer <identifier> --name <profile-name> [ --description <description> ]
OPTIONS
--consumer
Identifier of the consumer
--name
Name of the preference profile to be created.
--description
Description of preference profile.
EXAMPLES
beectl add_preference_profile --consumer loginid=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
SYNTAX
beectl add_preference_property --set <identifier> --name <property-name> --type <string | date | ... | identifiable> [ --value <property-value> ] [ --file <file-name> ] [ --final ]
OPTIONS
--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.
--name
Name of the preference property.
--type
Type of preference property.
--value
Value of preference property.
--file
File name for business hours type preference property.
--final
Whether the preference property be overridden in extended property.
EXAMPLES
beectl add_preference_property --set 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000979 --name MyProperty --type integer --value 100 --final
beectl add_preference_property --set 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000979 --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.
SYNTAX
beectl add_preference_set --parent <preference-profile-identifier> --name <preference-set-name> [ --extends <preference-set-identifier> ]
OPTIONS
--parent
Identifier of the preference profile to which the preference set is added.
--name
Name of the preference set.
--extends
Identifier of the preference set from which the new preference set is extended.
EXAMPLES
beectl add_preference_set --parent prfp=MyProfile,loginid=user1 --name MyPreferenceSet
Adds a record or non-record.
SYNTAX
beectl add_record --artifact <identifier of the artifact to be filed as a record or non-record> { --retention_category <identifier of the Universal Records Management retention category> | --record_folder <identifier of the Universal Records Management record folder> } [ --no_retention <boolean specifying a record or non-record> ]
OPTIONS
--artifact
identifier of the artifact to be filed as a record or non-record
--retention_category
identifier of the Universal Records Management retention category
--record_folder
identifier of the Universal Records Management record folder
--no_retention
boolean specifying a record or non-record
EXAMPLES
beectl add_record --artifact myArtifact --retention_category myRetentionCategory --no_retention
Creates a new resource.
SYNTAX
beectl add_resource --name <name> --email_address <email address> --resource_type <type> [--enterprise <enterpriseid>] [--capacity <capacity>] [--identifier <identifier>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>] [--timezone <time zone name>] [--location <location>] [--add_approver <approverid>] [--description <description>] [--booking_info <booking info>] [--booking_characteristics <[O]pen|<[F]CFS>] beectl add_resource --external --name <name> --email_address <email address> --resource_type <type> [--enterprise <enterpriseid>] [--capacity <capacity>] [--phone_number <phone_number>] [--website <website>] [--postal_address <postal address>] [--timezone <time zone name>] [--location <location>] [--booking_info <booking info>] [--description <description>]
OPTIONS
--name
Define the unique name of the resource.
--enterprise
Specify the identifier of the enterprise under which the resource will be created.
--resource_type
Specify the type of the resource. Accepted arguments for this option are: e, equipment, o, other, r and room. Arguments are case insensitive.
--bookableresource_type
Deprecated option. Use --resource_type instead.
--email_address
Specify the BUSINESS_1 e-mail address of the resource.
--phone_number
Specify the BUSINESS_1 phone number of the resource.
--website
Specify the BUSINESS_1 web site of the Resource.
--postal_address
Specify the BUSINESS_1 postal address of the resource.
--identifier
Specify the identifier of the resource. The identifier can be used as an alternative to the name: such as a room or serial number.
--capacity
Specify the capacity of the resource.
--external
Create the resource as an external resource. If this option is not specified, a BookableResource will be created.
--add_approver
Resource approver to add.
--booking_characteristics
Specify resource default calendar booking characteristics. The characteristics can be Open or First Come First Serve.
--booking_info
Specify resource booking information. It must be a XHTML string.
--description
Specify the description of the resource. It must be a XHTML string.
--timezone
Specify the time zone of the Resource.
--location
Specify the location description of the resource. It must be a XHTML string.
EXAMPLES
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.
SYNTAX
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>]
OPTIONS
--scope
Specify the unique identifier of the Scope in which the RoleDefinition should be created.
--name
Specify the name of the RoleDefinition.
--description
Specify a description for the RoleDefinition.
--privilege
Specify a privilege which will be granted by the RoleDefinition. This option can be specified more than once.
--access_types
Specify the access types string for the RoleDefinition.
--always_enabled
Specify the AlwaysEnabled option for RoleDefinition.
EXAMPLES
beectl add_role_definition --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition
Creates a Sensitivity entity.
SYNTAX
beectl add_sensitivity --workspace <unique identifier of the Workspace> --name <name of Sensitivity> [--description <description>] [--sensitivity_only <boolean value>] [--delegatable <boolean value>]
OPTIONS
--workspace
Specify the unique identifier of the Workspace in which the Sensitivity should be created.
--name
Specify the name of the Sensitivity.
--description
Specify a description for the Sensitivity.
--sensitivity_only
Specify the SensitivityOnly option for the Sensitivity.
--delegatable
Specify the Delegatable option for the Sensitivity.
EXAMPLES
beectl add_sensitivity --workspace wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity
Adds an Access Control Entry (ACE) to a Sensitivity entity's Sensitivity ACL (SACL).
SYNTAX
beectl add_sensitivity_ace --sensitivity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
OPTIONS
--sensitivity
Specify the unique identifier of the Sensitivity to which the ACE will be added.
--accessor
Specify the unique identifier of an Accessor to whom the access types will apply.
--access_types
Specify the access types string for the Accessor.
EXAMPLES
beectl add_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor loginid=MyUser --access_types +RW-D
Creates a team workspace from a template
SYNTAX
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>]
OPTIONS
--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
EXAMPLES
beectl add_team_workspace --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name My_Team_worksapce --hard_quota UNLIMITED --soft_quota 100
beectl add_team_workspace --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --template 9941:2345:wtss:88D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/input.xml --hard_quota 1000 --soft_quota 100 --email_address teamworkspace@company.com
This commands 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.
SYNTAX
beectl add_trusted_identity [--type WSSEC --is_service <boolean> [--key_alias <Key Alias>] --service_name <Principal Name>] [--type SES --name <Trusted Entity Name> --password <Trusted Entity Password>]
OPTIONS
--key_alias
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.
--is_service
Boolean value, true if this is a service. This option is mandatory if type is WSSEC.
--service_name
String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
--type
String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
--name
String value representing the name of the SES trusted entity.
--password
Secure string value representing the password of the SES trusted entity.
EXAMPLES
Configures an agent for a Universal Records Management instance.
SYNTAX
beectl add_urm --rm_admin_name <RM Admin Name for the Universal Records Management instance.> --rm_admin_password <RM Admin Pass for the Universal Records Management instance.> --urm_url <The URL for the Universal Records Management instance.> [ --disposition_loader_interval <The Disposition Loader Interval for the Universal Records Management instance.> ] [ --disposition_processor_interval <The Disposition Processor Interval for the Universal Records Management instance.> ] [ --agent_name <The Agent Name for the Universal Records Management instance.> ]
OPTIONS
--rm_admin_name
RM Admin Name for the Universal Records Management instance.
--rm_admin_password
RM Admin Pass for the Universal Records Management instance.
--urm_url
The URL for the Universal Records Management instance.
--disposition_loader_interval
The Disposition Loader Interval for the Universal Records Management instance.
--disposition_processor_interval
The Disposition Processor Interval for the Universal Records Management instance.
--agent_name
The Agent Name for the Universal Records Management instance.
EXAMPLES
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
The add_user command adds new users. The user information is supplied either on command line or in an XML file.
SYNTAX
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 <time zone 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(certificate|notes)=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> [ --ldapbootstrap ] }
OPTIONS
--family_name
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.
--scope
Identifier of the enterprise or organization under which this user will be created.
--given_name
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
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
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
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
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
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
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
Office location of the user.
--company
Company of the user.
--profession
Profession of the user.
--timezone
Time zone of the user. list_timezones lists the valid time zones
--locale
Locale details of the user. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
--department
Department of the user.
--assistant
Identifier of the assistant.
--manager
Identifier of the manager.
--organization
Identifiers of the organizations the user belongs to.
--property
Details of the property in the format name=value=description. Supported names are certificate, and notes. Note, no equals to symbol(=) should be present in the name or value or description.
--address
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--default_address_for_type
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--default_address_for_scheme
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. 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
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--login_id
The login credentials of the user.
--login_password
Login password.
--voice_principal
Voice principal of the user.
--voice_pin
Pin number for the voice device.
--protocol_principal
Protocol principal of the user.
--protocol_password
Protocol password.
--file
Name of the file, which contains user information in XML format.
--ldapbootstrap
LDAP bootstrap flag. This option is used to specify that users are mastered in a LDAP server. This is relevant only when --file option is used.
--external_inbox
Boolean if user's inbox is external or not.
--extended_enterprise_user
Boolean if user is an external user or not.
EXAMPLES
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
beectl add_user --file Users.xml --ldapbootstrap
Creates a user subscription from a pre-defined rule in a subscription template.
SYNTAX
beectl add_user_subscription --source_entity_class <sourceEntityClass of template> --rule <rule name> --attach <identifier of attached entity> --subscriber <identifier of subscriber>
OPTIONS
--source_entity_class
Specify the name of the source entity Class that is defined in subscription template.
--rule
Specify the name of the pre-defined rule that is selected for creating subscription.
--attach
Specify the Identifier of the entity to which the subscription is attached.
--subscriber
Specify the identifier of the subscriber who owns the subscription.
EXAMPLES
beectl add_user_subscription --source_entity_class Invitation --rule NOTIFY_ON_ANY_UPDATED_INVITATION --attach 5457:7954:clnd:337F34E37E8E81F1E040578C921630B700000000B864 --subscriber 5457:7954:user:6390824F2C4C4BD1B54A21B2DD7423F300000000000A
Creates a version configuration on the given scope or heterogeneous folder.
SYNTAX
beectl add_version_configuration --container <Configuration scope or heterogenous folder> --file <Full path of the configuration XML file>
OPTIONS
--container
Scope or heterogeneous folder on which the version configuration should be defined.
--file
Full path of the version configuration XML file. The file must contain properly formatted data.
EXAMPLES
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.
SYNTAX
beectl add_virus_scan_engine [ --hostname <scanengine_hostname> ] [ --port <scanengine_port> ] [ --validate_connection <true/false> ]
OPTIONS
--hostname
Name of the host where the virus scan engine is installed. Default is localhost.
--port
Port number used by the virus scan engine for communication with its clients. Default is 1344.
--validate_connection
Indicates if the connection to the virus scan engine needs to be validated.
EXAMPLES
beectl add_virus_scan_engine --hostname scanenginehost.example.com --port 1344 --validate_connection true
Creates a voice enterprise with the given name.
SYNTAX
beectl add_voice_enterprise --name <name>
OPTIONS
--name
Name to be assigned to this voice enterprise.
EXAMPLES
beectl add_voice_enterprise --name sample
Creates a voice facility with the given name.
SYNTAX
beectl add_voice_facility --name <name>
OPTIONS
--name
Name to be assigned to this voice facility.
EXAMPLES
beectl add_voice_facility --name 13125551234
Deploys a workflow and seeds workflow information.
SYNTAX
beectl add_workflow_schema --file <full path to the workflow jar file>
OPTIONS
--file
Specify the absolute path of the workflow schema jar file.
EXAMPLES
beectl add_workflow_schema --file /private/bpel/MyWorkflowSchema.jar
Creates a workflow template using data in an XML file.
SYNTAX
beectl add_workflow_template --file <full path to the workflow template xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains data to create the workflow template.
EXAMPLES
beectl add_workflow_template --file /private/bpel/MyWorkflowTemplate.xml
Creates a workspace template in an organization or enterprise
SYNTAX
beectl add_workspace_template --scope <Identifier of enterprise or organization> --file <Full path of the template file>
OPTIONS
--scope
Identifier of enterprise or organization
--file
Full path of the input file
EXAMPLES
beectl add_workspace_template --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/template.xml
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 hyphens. 2. Prefix the option value with string "ESCAPE:". 3. Prefix 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.
SYNTAX
beectl append_value --component <system object identifier or alias> --name <name> --value <value>...
OPTIONS
--component
component id.
--name
Name of the property.
--value
Value of the property.
EXAMPLES
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"
Clears proposed configuration of the Beehive system object model
SYNTAX
beectl clear_proposed_configuration
OPTIONS
This command has no options
EXAMPLES
beectl clear_proposed_configuration
Top level clone command that clones a Oracle Beehive Application tier.
SYNTAX
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]
OPTIONS
--ias_instance_name
Ias instance name with out appending host name. For example "myinstance"
--host_name
Fully qualified host name of the new Oracle Beehive Application tier.
--db_schema_password
Database schema password.
--oui_inv_ptr_loc
OUI inventory pointer location.
--oracle_home_name
Oracle home name. The default value is the value for --ias_instance_name option.
--do_not_start_at_end
If specified, beehive components will not be started at the end.
EXAMPLES
beectl clone_midtier --ias_instance_name MyIASInstance --host_name machine1.example.com --db_schema_password dbbeehiveschemapassword
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 restarted 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.
SYNTAX
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> [--working_list <ServiceInterface or archive file name without path> ...] [--exclusion_list <ServiceInterface or archive file name without path> ...]
OPTIONS
--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.
--exclusion_list
Given ServiceInterfaces or archive file names provided via this option will be excluded.
--working_list
Only given ServiceInterfaces or archive file names provided via this option will be included.
EXAMPLES
beectl clone_oc4j_instance --source_oc4j_instance_name BEEAPP --target_oc4j_instance_name BEEAPP_CLONE
--exclusion_list ClientManagementService can be passed to exclude ClientManagementService service interface.
--working_list ClientManagementService can be passed to include only ClientManagementService service interface.
Prepares the existing oracle home for cloning.
SYNTAX
beectl clone_preparation --file <output file name>
OPTIONS
--file
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.
EXAMPLES
beectl clone_preparation --file /tmp/clone-list.txt
Top level clone command that clones a Oracle Beehive Application tier in a new deployment (i.e., site). This command is part of the Deployment Cloning solution. Please see the administrator guide for details.
SYNTAX
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>]
OPTIONS
--ias_instance_name
Ias instance name with out appending host name. For example "myinstance"
--host_name
Fully qualified host name of the new Oracle Beehive Application tier.
--db_connect_string
Database connect string.
--db_schema_password
Database schema password.
--db_schema_name
Database schema name.
--db_rac_node_information
Database RAC node information. It should be of the format hostname:port. For example: sample.com:1521
--db_xa_service_name
Database XA service name.
--retain_rac_node_information
Retains the old RAC node and ONS information. By default old RAC node information is removed.
--oracle_home_name
Oracle home name. The default value is the value provided for --ias_instance_name option.
--oui_inv_ptr_loc
OUI inventory pointer location.
--do_not_start_at_end
If specified, beehive components will not be started at the end.
--site_name
New site name
EXAMPLES
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
Deletes an AssignedRole entity.
SYNTAX
beectl delete_assigned_role --assigned_role <unique identifier of the AssignedRole>
OPTIONS
--assigned_role
Specify the unique identifier of the AssignedRole to be deleted.
EXAMPLES
beectl delete_assigned_role --assigned_role acar=MyAssignedRole,wksp=MyWorkspace,enpr=MyEnterprise
Deletes an auto attendant by name.
SYNTAX
beectl delete_attendant --name <name of attendant>
OPTIONS
--name
Name of the attendant to delete.
EXAMPLES
beectl delete_attendant --name my_attendant
Deletes a prompt.
SYNTAX
beectl delete_attendant_prompt --name <attendant name> --type <prompt type> --language <prompt language>
OPTIONS
--name
Name of the attendant to which the prompt belongs.
--type
The type of the prompt. Can be one of language, menu, greeting, option1, option2, option3, option4, option4, option5, option6, option7, option8, option9, noinput, noinput-term, nomatch, nomatch-term.
--language
The language of the prompt.
EXAMPLES
beectl delete_attendant_prompt --name myAttendant --type greeting --language en_US
beectl delete_attendant_prompt --name myAttendant --type language
Deletes an existing audit
SYNTAX
beectl delete_audit_policy --policy <Audit policy identifier>
OPTIONS
--policy
Audit policy identifier
EXAMPLES
beectl delete_audit_policy --policy aupl=MyAuditPolicy
Deletes an existing audit policy template
SYNTAX
beectl delete_audit_template --template <Audit template identifier>
OPTIONS
--template
Audit template identifier
EXAMPLES
beectl delete_audit_template --template autp=MyAuditTemplate
Deletes an existing audit trail
SYNTAX
beectl delete_audit_trail --trail <Audit trail identifier>
OPTIONS
--trail
Audit trail identifier
EXAMPLES
beectl delete_audit_trail --trail autr=MyAuditTrail
Deletes a category and all category applications.
SYNTAX
beectl delete_category --category <Identifier of the category to be deleted>
OPTIONS
--category
Specify the identifier of the category.
EXAMPLES
beectl delete_category --category 421C:6639:catg:3BF460625AB3FCC9E040548C1C82796300000000020B
beectl delete_category --category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent
Removes a category from an entity
SYNTAX
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>
OPTIONS
--category
Specify the identifier of the category to be removed.
--entity
Specify the identifier of an Oracle Beehive entity from which the category needs to be removed.
EXAMPLES
beectl delete_category_application --category catg=MyCategory,enpr=MyEnterprise --entity adoc=MyDocument,fldr=MyFolder,wksp=MyWorkspace,enpr=MyEnterprise
Deletes a given category configuration.
SYNTAX
beectl delete_category_configuration --configuration <Configuration identifier>
OPTIONS
--configuration
Category configuration to be deleted.
EXAMPLES
beectl delete_category_configuration --configuration 9941:2345:ctcf:58D193D162CE4ED89FF66AB4E55745B6345464545453
Deletes a client application.
SYNTAX
beectl delete_client_application --application <identifier of the client application>
OPTIONS
--application
Specify the identifier of the client application. Use list_client_applications command to determine the identifier of the client application.
EXAMPLES
beectl delete_client_application --application 1234:5678:capn:2E0329B0705F0E40E040578C92160957000000000434
Deletes the client application configuration with the given identifier.
SYNTAX
beectl delete_client_application_configuration --configuration <identifier of the client application configuration>
OPTIONS
--configuration
Specify the identifier of the client application configuration.
EXAMPLES
beectl delete_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
Deletes a client application patchset.
SYNTAX
beectl delete_client_application_patchset --patchset <identifier of the client application patchset>
OPTIONS
--patchset
Specify the identifier of the client application patchset. Use list_client_application_patchsets command to determine the identifier of a client application patchset.
EXAMPLES
beectl delete_client_application_patchset --patchset 1234:5678:capp:2E0329B0705F0E40E040578C92160957000000000434
Deletes a client application version.
SYNTAX
beectl delete_client_application_version --application_version <identifier of the client application version>
OPTIONS
--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.
EXAMPLES
beectl delete_client_application_version --application_version 1234:5678:capv:2E0329B0705F0E40E040578C92160957000000000434
Deletes a coexistence connector.
SYNTAX
beectl delete_coexistence_connector [--connector <connectorid>] [--select_by_name <connector_name>]
OPTIONS
--select_by_name
Specify the name of the coexistence connector.
--connector
Specify the identifier of the coexistence connector.
EXAMPLES
beectl delete_coexistence_connector
beectl delete_coexistence_connector --select_by_name MsExch2003_1
Deletes the coexistence profile of user.
SYNTAX
beectl delete_coexistence_profile {--user <user_cen> | --select_by_name <user_name> | --select_by_address <user_address> --select_by_authuser <user_loginid>}
OPTIONS
--user
Specify the identifier of the user.
--select_by_name
Specify the name of the user.
--select_by_address
Specify the email address of the user.
--select_by_authuser
Specify the login ID of the user.
EXAMPLES
beectl delete_coexistence_profile --select_by_authuser user_login_id
Deletes conference artifact under workspace
SYNTAX
beectl delete_conference --conference_id <Conference identifier>
OPTIONS
--conference_id
Conference identifier
EXAMPLES
beectl delete_conference --conference_id 6490:45C8:owch:B3EABD85714E4DBDA92201A54EAE56C3000000002C2C
Deletes conference template artifact under workspace
SYNTAX
beectl delete_conference_template --template_id <Conference identifier>
OPTIONS
--template_id
Conference identifier
EXAMPLES
beectl delete_conference_template --template_id 6490:45C8:owch:B3EABD85714E4DBDA92201A54EAE56C3000000002C2C
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.
SYNTAX
beectl delete_custom_user_property --name <name>
OPTIONS
--name
Property name. Example: employeenumber.
EXAMPLES
beectl delete_custom_user_property --name employeenumber
Deletes the device profile with the given identifier. The command can also optionally delete all the device types associated with this device profile.
SYNTAX
beectl delete_device_profile --profile <identifier of the device profile> [--delete_device_types]
OPTIONS
--profile
Identifier of the device profile.
--delete_device_types
Deletes all the device types associated with this device profile.
EXAMPLES
beectl delete_device_profile --profile 1234:5678:devp:2E0329B0705F0E40E040578C92160957000000000434
beectl delete_device_profile --profile 1234:5678:devp:2E0329B0705F0E40E040578C92160957000000000434 --delete_device_types
Deletes the device type with the given identifier.
SYNTAX
beectl delete_device_type --type <identifier of the device type>
OPTIONS
--type
Identifier of the device type.
EXAMPLES
beectl delete_device_type --type 1234:5678:devt:2E0329B0705F0E40E040578C92160957000000000434
The delete_directory_profile command deletes a directory profile.
Change log number for the directory profile is not deleted from beehive, unless the activate_configuration option is used. To delete the change log number from beehive, run this command by specifying the common option activate_configuration with value as true.
SYNTAX
beectl delete_directory_profile --profile <profile-name>
OPTIONS
--profile
Profile name to be deleted.
EXAMPLES
beectl delete_directory_profile --profile MyDirectoryProfile
Removes configuration for a Beehive installation in the DMZ that is, outside the firewall.
SYNTAX
beectl delete_dmz_home_instance --id <dmz beehive instance id>
OPTIONS
--id
Identifier for DMZ beehive instance.
EXAMPLES
beectl delete_dmz_home_instance --id dmz_on_server1
Deletes an event subscription from the Oracle Beehive repository.
SYNTAX
beectl delete_event_subscription --subscription <identifier of the event subscription to be deleted>
OPTIONS
--subscription
Specify the identifier of the event subscription to be deleted.
EXAMPLES
beectl delete_event_subscription --subscription 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453
The delete_external_contact command deletes an external contact with an option to purge.
SYNTAX
beectl delete_external_contact { --contact <identifier of external contact > | --email <Email address of the contact> } --purge
OPTIONS
--contact
identifier of external contact
Email id of the external contact
--purge
Purges the external contact after deletion.
EXAMPLES
beectl delete_external_contact --contact 6A95:21EB:extp:D9E9FC8134544BCE9D60559F9B997CCD000000000000
beectl delete_external_contact --email contact1@example.com
beectl delete_external_contact --email contact1@example.com --purge
Removes a file system reference from Beehive.
SYNTAX
beectl delete_filesystem_reference --filesystem_reference_id <Identifier of the file system reference>
OPTIONS
--filesystem_reference_id
Identifier of the file system reference to delete.
EXAMPLES
beectl delete_filesystem_reference --filesystem_reference_id fsref=MyFilesystemReference,enpr=MyEnterprise
The delete_group command deletes a group with an option to purge.
SYNTAX
beectl delete_group { --group <group_identifier> | --email <group_email> } [ --purge ]
OPTIONS
--group
Identifier of the group.
EmailID of the group.
--purge
Purges the group after deletion.
EXAMPLES
beectl delete_group --group grup=MyGroup,enpr=Example
beectl delete_group --group grup=MyGroup,enpr=Example --purge
Deletes an Access Control Entry (ACE) from the Local Access Control List (LACL) of an entity.
SYNTAX
beectl delete_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor>
OPTIONS
--entity
Specify the unique identifier of the entity from which the ACE will be deleted.
--accessor
Specify the unique identifier of the accessor to whom the access types were applied.
EXAMPLES
beectl delete_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor loginid=MyUser
Deletes an existing organization
SYNTAX
beectl delete_organization --organization <Organization identifier> [--async]
OPTIONS
--organization
Organization identifier
--async
Delete organization asynchronously
EXAMPLES
beectl delete_organization --organization 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453
Deletes a policy.
SYNTAX
beectl delete_policy --policy <identifier of the policy to be deleted>
OPTIONS
--policy
Specify the identifier of the policy to be deleted. Use the list_policies command to obtain the policy identifier.
EXAMPLES
beectl delete_policy --policy plcy=MyPolicy,enpr=MyEnterprise
Deletes a policy action.
SYNTAX
beectl delete_policy_action --action_name <name of action to be deleted>
OPTIONS
--action_name
Specify the name of the policy action to be deleted.
EXAMPLES
beectl delete_policy_action --action_name MyActionName
Deletes a policy schema.
SYNTAX
beectl delete_policy_schema --policy_schema <identifier of the policy schema to be deleted>
OPTIONS
--policy_schema
Specify the identifier of the policy schema to be deleted.
EXAMPLES
beectl delete_policy_schema --policy_schema 9941:2345:plsh:58D193D162CE4ED89FF66AB4E55745B6345464545453
Deletes a policy template.
SYNTAX
beectl delete_policy_template --policy_template <identifier of the policy template to be deleted>
OPTIONS
--policy_template
Specify the identifier of the policy template to be deleted.
EXAMPLES
beectl delete_policy_template --policy_template 9941:2345:plct:58D193D162CE4ED89FF66AB4E55745B6345464545453
The delete_preference_profile command deletes a preference profile.
SYNTAX
beectl delete_preference_profile --profile <Preference profile identifier>
OPTIONS
--profile
Identifier of the preference profile to be deleted.
EXAMPLES
beectl delete_preference_profile --profile prfp=MyProfile,loginid=user1
The delete_preference_property command deletes a preference property from a preference set.
SYNTAX
beectl delete_preference_property --set <set-identifier> --name <property-name>
OPTIONS
--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.
--name
Name of the preference property.
EXAMPLES
beectl delete_preference_property --set 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000979 --name MyProperty
The delete_preference_set command deletes a preference set.
SYNTAX
beectl delete_preference_set --set <set-identifier>
OPTIONS
--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.
EXAMPLES
beectl delete_preference_set --set 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000979
Clears the value of specified property in the configuration object identified by specified id.
SYNTAX
beectl delete_property --component <system object identifier or alias> --name <property name>
OPTIONS
--component
Identifier of a configuration object. The list_components command can be used to lookup the identifier
--name
The property to be cleared.
EXAMPLES
The command execution shown below would clear the value of Alias property of the current site.
beectl delete_property --component _CURRENT_SITE --name Alias
Deletes a record or non-record.
SYNTAX
beectl delete_record --artifact <identifier of the artifact to be deleted as a record/non-record>
OPTIONS
--artifact
identifier of the artifact to be deleted as a record/non-record
EXAMPLES
beectl delete_record --artifact myArtifact
Deletes a resource.
SYNTAX
beectl delete_resources --resource <resourceid> | --select_by_name <name> [--external]
OPTIONS
--resource
Specify the identifier of the resource. Use list_resources command to obtain the identifier of the resource.
--select_by_name
Specify the name criteria of the resource.
--external
Specify this option if the resource is external. If this option is not specified, bookable resources will be deleted.
EXAMPLES
beectl delete_resources --resource 395A:346B:bkrs:2C5F7E98E076D382E040578CA60B0D0E000000062327
Deletes a RoleDefinition entity.
SYNTAX
beectl delete_role_definition --role_definition <unique identifier of the RoleDefinition>
OPTIONS
--role_definition
Specify the unique identifier of the RoleDefinition to be deleted.
EXAMPLES
beectl delete_role_definition --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise
Deletes a Sensitivity entity.
SYNTAX
beectl delete_sensitivity --sensitivity <unique identifier of the Sensitivity>
OPTIONS
--sensitivity
Specify the unique identifier of the Sensitivity to be deleted.
EXAMPLES
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.
SYNTAX
beectl delete_sensitivity_ace --sensitivity <unique identifier of the Sensitivity> --accessor <unique identifier of the Accessor>
OPTIONS
--sensitivity
Specify the unique identifier of the Sensitivity from which the ACE will be deleted.
--accessor
Specify the unique identifier of the accessor to whom the access types were applied.
EXAMPLES
beectl delete_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor loginid=MyUser
Deletes an existing team workspace
SYNTAX
beectl delete_team_workspace --workspace <Workspace identifier> [--async]
OPTIONS
--workspace
Workspace identifier
--async
Delete workspace asynchronously
EXAMPLES
beectl delete_team_workspace --workspace 9941:2345:twsp:58D193D162CE4ED89FF66AB4E55745B6345464545453
This commands unregisters a trusted identity. If the type of identity is not specified, it is defaulted to WSSEC.
SYNTAX
beectl delete_trusted_identity [--type WSSEC --service_name <Trusted Entity Name>] [--type SES --name <Trusted Entity Name>]
OPTIONS
--service_name
String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
--type
String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
--name
String value representing the name of the SES trusted entity.
EXAMPLES
The delete_user command deletes a user with an option to purge.
SYNTAX
beectl delete_user { --user <user_identifier> | --email <user_email> } [ --purge ]
OPTIONS
--user
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.
--purge
Purges the user after deletion.
EXAMPLES
beectl delete_user --user loginid=user1
beectl delete_user --user loginid=user1 --purge
Deletes a given version configuration.
SYNTAX
beectl delete_version_configuration --configuration <Configuration identifier>
OPTIONS
--configuration
Version configuration to be deleted.
EXAMPLES
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.
SYNTAX
beectl delete_virus_scan_engine { --scan_engine <scanengine_systemid> | { --hostname <scanengine_hostname> --port <scanengine_port> }}
OPTIONS
--scan_engine
Identifier of the scan engine to be deleted.
--hostname
Name of the host where the virus scan engine is installed.
--port
Port number used by the virus scan engine for communication with its clients.
EXAMPLES
beectl delete_virus_scan_engine --scan_engine 12345
beectl delete_virus_scan_engine --hostname scanenginehost.example.com --port 1344
Deletes a voice enterprise with the given id.
SYNTAX
beectl delete_voice_enterprise --name <name>
OPTIONS
--name
Identifier of the voice enterprise to be removed.
EXAMPLES
beectl delete_voice_enterprise --name a1d290a8-f8a7-46ea-ae3d-0696c0bde331
Deletes a voice facility with the given id.
SYNTAX
beectl delete_voice_facility --name <name>
OPTIONS
--name
Identifier of the voice facility to be removed.
EXAMPLES
beectl delete_voice_facility --name a1d290a8-f8a7-46ea-ae3d-0696c0bde331
Deletes a workflow schema.
SYNTAX
beectl delete_workflow_schema --workflow_schema <identifier of the workflow schema to be deleted>
OPTIONS
--workflow_schema
Specify the identifier of the workflow schema to be deleted. To determine the identifier of a workflow schema, use the list_workflow_schemas command.
EXAMPLES
beectl delete_workflow_schema --workflow_schema wfsc=myWorkflowSchema,enpr=myEnterprise
Deletes a workflow template.
SYNTAX
beectl delete_workflow_template --workflow_template <identifier of the workflow template to be deleted>
OPTIONS
--workflow_template
Specify the identifier of the workflow template to be deleted. To determine the identifier of a workflow template, use the list_workflow_templates command.
EXAMPLES
beectl delete_workflow_template --workflow_template wftm=myTemplateKey,enpr=myEnterprise
Deletes an existing workspace template
SYNTAX
beectl delete_workspace_template --template <Workspace template identifier>
OPTIONS
--template
Workspace template identifier
EXAMPLES
beectl delete_workspace_template --template 9941:2345:ttws:58D193D162CE4ED89FF66AB4E55745B6345464545453
Downloads the logs for a device. This command can either all log files for a device or all log files for a given application on the device or a particular log file.
SYNTAX
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>]}}
OPTIONS
--dest_dir
Specify the full path of the destination directory. The directory must already exist.
--device_log
Specify the identifier of the device log. Use list_device_logs command to determine the identifier of the device log.
--device
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
--all
Specify this option to download all the log files for this device.
--application_name
Application Name
--log_file_name
Log File Name
EXAMPLES
beectl download_device_logs --dest_dir /tmp --device 1234:5678:devi:2E0329B0705F0E40E040578C92160957000000000434 --application_name MobileMail --log_file_name log.txt
Exports language pack resources managed by the Beehive deployment. The exact resources exported and the output destination details are controlled by command options.
SYNTAX
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> ]
OPTIONS
--full
include everything; other options are silently ignored.
--only_built_in
include built-in xliff file versions.
--only_custom
include custom xliff file versions.
--include_class_files
include jar of internal classes used by runtime.
--destination_file
output destination file; directory extension should be provided, zip/jar recommended; the file must not exist.
--destination_directory
output destination directory; may exist; must not be used with --dest-file.
--base_name
include xliff with this base name; may be repeated; if omitted all base names are implicitly included.
--locale
include this locale for all base names; if omitted all locales are implicitly included.
EXAMPLES
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.
SYNTAX
beectl download_ldap_group_data --file <filename> --profile <profile-name>
OPTIONS
--file
Name of the file to be created with group information in xml format.
--profile
Name of the directory profile.
EXAMPLES
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.
SYNTAX
beectl download_ldap_user_data --file <filename> --profile <profile-name>
OPTIONS
--file
Name of the file to be created with user information in xml format.
--profile
Name of the directory profile.
EXAMPLES
beectl download_ldap_user_data --file Users.xml --profile MyDirectoryProfile
Downloads SyncML messages.
SYNTAX
beectl download_syncml_messages --directory <directory> --date <yyyy-MM-DD> [ --id <id> | --user_id <user_id>]
OPTIONS
--directory
Specify output destination directory. The directory must exist within the same server environment used by the Management Service.
--date
Specify the date of the oldest SyncML messages to download. Use the YYYY-MM-DD format.
--id
Specify the server side synchronization session ID of the SyncML messages to download.
--user_id
Specify the server side synchronization session ID of the SyncML messages to download.
EXAMPLES
beectl download_syncml_messages --directory /syncml_messages --date 2006-10-12 --id 105
Downloads SyncML messages.
SYNTAX
beectl download_syncml_sessions --file <file> --date <yyyy-MM-DD> [ --id <id> | --user_id <user_id>]
OPTIONS
--file
Specify output destination file. The file will be created within the same server environment used by the Management Service.
--date
Specify the date of the oldest SyncML messages to download. Use the YYYY-MM-DD format.
--id
Specify the server side synchronization session ID of the SyncML messages to download.
--user_id
Specify the server side synchronization session ID of the SyncML messages to download.
EXAMPLES
beectl download_syncml_sessions --file /syncml_sessions.log --date 2006-10-12 --id 105
Downloads workspace template XML schema to a file
SYNTAX
beectl download_workspace_template_schema [--file <Full path of the output file>]
OPTIONS
--file
Full path of the output file
EXAMPLES
beectl download_workspace_template_schema --file /tmp/schema.xsd
Exports an existing audit trail by the given identifier
SYNTAX
beectl export_audit_trail --trail <Audit trail identifier> --file <Full path of the output file>
OPTIONS
--trail
Audit trail identifier
--file
Full path name of the export file
EXAMPLES
beectl export_audit_trail --trail autr=MyAuditTrail --file /tmp/trail.xml
Exports a client application configuration to a local file.
SYNTAX
beectl export_client_application_configuration --configuration <client application configuration identifier> --file <destination file>
OPTIONS
--configuration
Specify the identifier of the client application configuration.
--file
Specify the full path and file name. Oracle recommends using the using an .xml extension. If the file already exists, it will be overwritten.
EXAMPLES
beectl export_client_application_configuration --configuration 1234:5678:capc:1234567890123456789012 --file /tmp/client-app-config.xml
Search for occurrences of error codes
SYNTAX
beectl export_errorcodes [--start <DATE_TIME>] [--end <DATE_TIME>] [--errorcode <STRING> ... |--exclude_errorcode <STRING> ... ] [--severity <string>] [--text <string>] [--max_results <INTEGER>] [--display_exception_stack] [--display_columns <STRING_LIST>] [--from_logs] beectl export_errorcodes --get_count_service_by_ec <STRING> beectl export_errorcodes --get_count_ec_by_service <STRING>
OPTIONS
--start
Start of time range
--end
End time range
--errorcode
Specific error codes to query for
--exclude_errorcode
Specific error codes to not search for
--severity
Minimum severity to restrict to
--text
Text in Exception stack or metadata parameters to search for
--max_results
Maximum number of results to return
--display_exception_stack
Should the Exception stack be printed
--display_columns
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]
--ecid
Execution Context ID
--service_inst_id
Service Instance ID
--get_count_service_by_ec
Service instance ID to get error code counts from, or all to aggregate over all service instances.
--get_count_ec_by_service
Error code to get counts from, or all to aggregate over all error codes.
--from_logs
Query the logs instead of the database.
EXAMPLES
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 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.
SYNTAX
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>]
OPTIONS
--search_string
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 operands (!, &&, ||). 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_results
Maximum number of returned records. It tops out at 1,000, if the output_target is screen, otherwise there is no limit.
--file_name_filter
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.
--host_name_filter
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.
--beehive_home_filter
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.
--output_target
Specify if direct the output to the screen or to a file.
--output_format
Specify output format. Supported formats are ODL-Text and XML.
--display_source
Default to false. Specify if display the name of the log file source for the returned record.
--display_original_copy
Default to false. Specify if display the original copy for the returned record.
--columns
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.
--log_analysis
Default to false. Specify if choose to do the log analysis.
--report_time_range
Specify the desired time range for log analysis report. Only apply when option log_analysis is true.
--report_message_type
Specify the desired message type of the unique message count for log analysis report. Only apply when option log_analysis is true.
EXAMPLES
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
Export invitations and assignments from a calendar and/or tasklist to an iCalendar file.
SYNTAX
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_timerange_start <date-time>] [--filter_timerange_end <date-time>] [--authuser <authuser> --authpassword <password>] [--obfuscated]
OPTIONS
--file
Specify the full path and name of the iCalendar file to export.
--overwrite
Specify this option to overwrite the iCalendar export file if it already exists.
--charset
Specify the charset that is to be used in the iCalendar file that is being exported (http://www.iana.org/assignments/character-sets).
--do_as
Specify the unique identifier of the user or resource performing the action.
--do_as_address
Specify the Uniform Resource Identifier (URI) of the user or resource performing the action.
--do_as_authuser
Specify the login name of the user performing the action.
--calendar
Specify the unique identifier of the source calendar, the default calendar of the "do_as" entity will be used if nothing is specified.
--tasklist
Specify the unique identifier of the source tasklist, the default tasklist of the "do_as" entity will be used if nothing is specified.
--filter_uid
Specify a iCalendar UID. This will filter the export to include only invitations and assignments matching the iCalendar UID.
--filter_timerange_start
Specify a start date. This will filter the export to include only invitations and assignments after the specified date.
--filter_timerange_end
Specify an end date. This will filter the export to include only invitations and assignments before the specified date.
--nocalendar
Do not export from a calendar (VEVENT components will not be exported).
--notasklist
Do not export from a tasklist (VTODO components will not be exported).
EXAMPLES
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.
SYNTAX
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>]
OPTIONS
--query_string
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 operands (!, &&, ||). 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.
--refresh_repository
Mandatory if option "query_string" is not specified. Force an upload of all the log files to refresh the repository.
--order_by
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>.
--sort
The query result set can be sorted in ascending or descending order.
--columns
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.
--output_target
Specify if direct the output to the screen or to a file.
--output_format
Specify output format. Supported formats are ODL-Text and XML.
--display_source
Default to false. Specify if display the name of the log file source for the returned record.
--maximum_results
Maximum number of returned records.
EXAMPLES
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.
SYNTAX
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>--verbose true or false to store in verbose or compact form
OPTIONS
--policy_name
Specify the name of the policy to export.
--scope
Specify the policy container identifier.
--destination
Specify the destination directory for the XML file.
--verbose
Specify whether to store the rule conditions of policy in verbose form or compact form.
EXAMPLES
beectl export_policy --policy_name MyPolicy --scope enpr=MyEnterprise --destination /private--verbose true
Exports a workflow template into an XML file.
SYNTAX
beectl export_workflow_template --workflow_template <identifier of the workflow template to be exported> --destination <destination directory of the generated xml file>
OPTIONS
--workflow_template
Specify the identifier of the workflow template to be exported. To determine the identifier of a workflow template, use the list_workflow_templates command.
--destination
Specify the destination directory for the XML file.
EXAMPLES
beectl export_workflow_template --workflow_template 31BE:6DDD:wftm:3B8937F59ACC1A3AE040578C9509017900000007A121 --destination /private
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.
SYNTAX
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> ]
OPTIONS
--filesystem_reference
Identifier of the file system reference to import from.
--folder_path
Full path of the Beehive folder to import to. E.g. /MyEnterprise/MyOrganization/MyWorkspace/Documents/MyFolder would import to MyFolder.
--name_filter
(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.
--conflict_resolution_mode
(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.
EXAMPLES
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 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 will cause all sub-components to be deleted.
SYNTAX
beectl import_icalendar --file <file> [--charset <charset>] { --do_as <unique_identifier> | --do_as_address <uri> | --do_as_authuser <authuser> } [--continue] [{ --calendar <unique_identifier> | --nocalendar }] [{ --tasklist <unique_identifier> | --notasklist }] [--authuser <authuser> --authpassword <password>] [--obfuscated] [--holiday] [--migration]
OPTIONS
--file
Specify the full path and name of the iCalendar file to import.
--charset
Specify the charset that is used in the iCalendar file that is being imported (http://www.iana.org/assignments/character-sets).
--do_as
Specify the unique identifier of the user or resource performing the action.
--do_as_address
Specify the Uniform Resource Identifier (URI) of the user or resource performing the action.
--do_as_authuser
Specify the login name of the user performing the action.
--continue
If it is passed along with --batchfile, it allows next commands to be executed even if previous one fails.
--calendar
Specify the unique identifier of the destination calendar, the default calendar of the "do_as" entity will be used if nothing is specified.
--tasklist
Specify the unique identifier of the destination tasklist, the default tasklist of the "do_as" entity will be used if nothing is specified.
--nocalendar
Do not import to a calendar (Discard VEVENT components).
--notasklist
Do not import to a tasklist (Discard VTODO components).
--holiday
All events imported in a team workspace will be imported as Holiday events.
--migration
Specify that all the iCalendar file will be imported in the context of a migration. All users participation status can be set by the importer and a limited number of beehive events will be raised.
EXAMPLES
beectl import_icalendar --file file.ics --do_as_address user@example.com
Imports time zone definitions to the database.
SYNTAX
beectl import_timezones --file <absolute path of tzInfoPkg.xml>
OPTIONS
--file
Specify the full path and file name of the time zone definition file (tzInfoPkg.xml).
EXAMPLES
beectl import_timezones --file $ORACLE_HOME/beehive/seed/tm/tzInfoPkg.xml
Lists the AccessControlFields of an entity.
SYNTAX
beectl list_access_control_fields --entity <unique identifier of the entity>
OPTIONS
--entity
Specify the unique identifier of the entity for which the AccessControlFields should be listed.
EXAMPLES
beectl list_access_control_fields --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise
Lists available access type names and identifiers.
SYNTAX
beectl list_access_types
OPTIONS
This command has no options
EXAMPLES
beectl list_access_types
Lists AssignedRole entities.
SYNTAX
beectl list_assigned_roles [--scope <unique identifier of the Scope>] [--name <like string>]
OPTIONS
--scope
Specify the unique identifier of the Scope of the AssignedRoles to be listed. If not specified the Scope will be the Enterprise.
--name
Specify the name pattern for the AssignedRoles to be listed. If not specified all accessible AssignedRoles will be returned.
EXAMPLES
beectl list_assigned_roles --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyAssignedRole
Prints the Auto Attendant Markup Language for an auto attendant.
SYNTAX
beectl list_attendant_aaml --name <attendant name>
OPTIONS
--name
Name of the attendant to be displayed.
EXAMPLES
beectl list_attendant_aaml --name myAttendant
Lists all prompts that have been uploaded for an attendant.
SYNTAX
beectl list_attendant_prompts --name <attendant name>
OPTIONS
--name
Name of the attendant for which to display prompts.
EXAMPLES
beectl list_attendant_prompts --name my_attendant
Lists all attendants in the system.
SYNTAX
beectl list_attendants
OPTIONS
This command has no options
EXAMPLES
beectl list_attendants
Lists auditable events
SYNTAX
beectl list_audit_events
OPTIONS
This command has no options
EXAMPLES
beectl list_audit_events
Lists audit policies and prints policy information
SYNTAX
beectl list_audit_policies [--name <Name of the audit policy>] [--container <Container identifier>]
OPTIONS
--name
Name of the audit policy
--container
Container identifier
EXAMPLES
beectl list_audit_policies --name MyAuditPolicy
beectl list_audit_policies --name MyAuditPolicy --container enpr=MyEnterprise
Lists audit policy templates and prints template information. Use --name option for detailed information about each audit policy template
SYNTAX
beectl list_audit_templates [--name <Name of the audit template>]
OPTIONS
--name
Name of the audit template
EXAMPLES
beectl list_audit_templates --name "Artifact access"
Lists audit trails and prints trail information
SYNTAX
beectl list_audit_trails [--name <Name of the audit trail>]
OPTIONS
--name
Name of the audit trail
EXAMPLES
beectl list_audit_trails --name MyAuditTrail
Displays bootstrap configuration for local Oracle Beehive Application tier.
SYNTAX
beectl list_bootstrap_configuration
OPTIONS
This command has no options
EXAMPLES
beectl list_bootstrap_configuration
Lists the existing calendars of a user, resource or workspace.
SYNTAX
beectl list_calendars { --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> } [--authuser <authuser> --authpassword <password>] [--obfuscated]
OPTIONS
--calendarowner
Specify the unique identifier of a user, resource or workspace.
--select_by_address
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace.
--select_by_authuser
Specify the login name of a user.
--select_by_user_name
Specify the name of a user.
--select_by_resource_name
Specify the name of a resource.
--select_by_workspace_name
Specify the name of a workspace.
EXAMPLES
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.
SYNTAX
beectl list_categories --recurse <Y/N> --parent_category <Identifier of the parent category> --output_format <XML>
OPTIONS
--recurse
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.
--parent_category
Unique Identifier for Parent Category.
--output_format
If 'XML' the output is sent as xml to standard out else its printed as table on standard output.
EXAMPLES
beectl list_categories --recurse Y --parent_category 421C:6639:catg:3BF460625AB3FCC9E040548C1C8279630000000001FF
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
SYNTAX
beectl list_category --category <Identifier of the category to be listed>
OPTIONS
--category
Specify the identifier of the category.
EXAMPLES
beectl list_category --category 421C:6639:catg:3BF460625AB3FCC9E040548C1C82796300000000020B
beectl list_category --category catg=Resource_US,catg=Resource_ROOT,enpr=bee_ent
Lists the category configuration on the given scope or heterogeneous folder.
SYNTAX
beectl list_category_configuration --container <Configuration scope or heterogenous folder>
OPTIONS
--container
Scope or heterogeneous folder on which the category configuration should be listed.
EXAMPLES
beectl list_category_configuration --container orgn=MyOrganization,enpr=MyEnterprise
Lists the client application configurations.
SYNTAX
beectl list_client_application_configuration {--configuration <client application configuration identifier >|--community <community identifier>}
OPTIONS
--community
Specify the identifier of the community.
--configuration
Specify the identifier of the client application configuration.
EXAMPLES
beectl list_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434
beectl list_client_application_configuration --configuration 1234:5678:capc:2E0329B0705F0E40E040578C92160957000000000434 --community 1234:5678:orgn:2E0329B0705F0E40E040578C92160957000000000321
Lists the modules for a given client application patchset.
SYNTAX
beectl list_client_application_modules --patchset <identifier of the client application patchset>
OPTIONS
--patchset
Specify the identifier of the client application patchset. Use list_client_application_patchsets command to determine the identifier of a client application patchset.
EXAMPLES
beectl list_client_application_modules --patchset 1234:5678:capp:2E0329B0705F0E40E040578C92160957000000000434
Lists the patchsets for a given client application version.
SYNTAX
beectl list_client_application_patchsets --application_version <identifier of the client application version>
OPTIONS
--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.
EXAMPLES
beectl list_client_application_patchsets --application_version 1234:5678:capv:2E0329B0705F0E40E040578C92160957000000000434
Lists all the versions for a given client application.
SYNTAX
beectl list_client_application_versions --application <identifier of the client application>
OPTIONS
--application
Specify the identifier of the client application. Use list_client_applications command to determine the identifier of the client application.
EXAMPLES
beectl list_client_application_versions --application 1234:5678:capn:2E0329B0705F0E40E040578C92160957000000000434
Lists all the client applications.
SYNTAX
beectl list_client_applications
OPTIONS
This command has no options
EXAMPLES
beectl list_client_applications
Lists all configured coexistence connectors.
SYNTAX
beectl list_coexistence_connectors
OPTIONS
This command has no options
EXAMPLES
beectl list_coexistence_connectors
Lists the users configured with a coexistence profile.
SYNTAX
beectl list_coexistence_profiles [--display_user_id] [--users_without_profile --file users.xml]
OPTIONS
--display_user_id
Specify if the CollabId of users should be displayed.
--users_without_profile
List users without a coexistence profile.
--file
Specify the name of the file in which the list of non coexisting users should be written.
EXAMPLES
beectl list_coexistence_profiles
beectl list_coexistence_profiles --users_without_profile --file users.xml
Reports the status of the containers and users involved in the coexistence. By default this command outputs the status of calendars, address books,email inboxes as well as of the users configured for coexistence. One can restrict the information being returned by specifying one or more of the optional parameters.
SYNTAX
beectl list_coexistence_status [--calendar] [--addressbook] [--email] [--user]
OPTIONS
--calendar
Lists calendar coexistence status.
--addressbook
Lists address book coexistence status.
Lists email coexistence status.
--user
Lists user provision status.
EXAMPLES
beectl list_coexistence_status
beectl list_coexistence_status --user
beectl list_coexistence_status --calendar
beectl list_coexistence_status --calendar --addressbook --email
Lists all the metadata about given command.
SYNTAX
beectl list_command_metadata --command_name <command name>
OPTIONS
--command_name
Command name.
EXAMPLES
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.
SYNTAX
beectl list_commands (--display_actions | --display_categories | ( [--action <action name>] [--category <category name> ] [--name <substring of desired command list> ] [--advanced | --deprecated] | --all)
OPTIONS
--display_actions
Displays all available actions.
--display_categories
Displays all available categories.
--action
Search will be based on given action.
--category
Search will be based on given category. This option can be supplied multiple times.
--name
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.
--advanced
Only ADVANCED commands will be listed.
--deprecated
Only DEPRECATED commands will be listed.
--all
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.
EXAMPLES
beectl list_commands --display_actions
beectl list_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.
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.
SYNTAX
beectl list_components (--display_types |[--type <type name>)] [--use_local_home] [--configuration_version ( proposed | active | <long version number> )])
OPTIONS
--display_types
Displays all the valid component types.
--type
Lists all components of given type.
--use_local_home
Searches only in the current ORACLE HOME.
--configuration_version
Configuration version. Valid values are active, proposed, any positive long number.
EXAMPLES
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.
Lists conference-template artifacts under workspace
SYNTAX
beectl list_conference_templates --parent <Workspace identifier> --count-limit <A count limit for a list of conference templates>
OPTIONS
--parent
Workspace identifier
--count-limit
A count limit for a list of conference templates
EXAMPLES
beectl list_conference_templates --parent 6490:45C8:wspr:F20E3F75004040B5AE14B64B96F89C3A000000000022
Lists conference artifacts under workspace
SYNTAX
beectl list_conferences --parent <Workspace identifier> --count-limit <A count limit for a list of conferences>
OPTIONS
--parent
Workspace identifier
--count-limit
A count limit for a list of conferences
EXAMPLES
beectl list_conferences --parent 6490:45C8:wspr:F20E3F75004040B5AE14B64B96F89C3A000000000022
Lists all available configuration versions and activation time information
SYNTAX
beectl list_configuration_versions
OPTIONS
This command has no options
EXAMPLES
beectl list_configuration_versions
Lists available connection pools in the system.
SYNTAX
beectl list_connection_pools
OPTIONS
This command has no options
EXAMPLES
beectl list_connection_pools
The list_custom_user_properties command lists all custom properties of users.
SYNTAX
beectl list_custom_user_properties
OPTIONS
This command has no options
EXAMPLES
beectl list_custom_user_properties
Lists the device commands for a given device. The list can be further filtered by specifying the status of the device command.
SYNTAX
beectl list_device_commands --device <identifier of the device> [--status <device command status>]
OPTIONS
--device
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
--status
Specify the status of the device command. The following are the valid command statuses: PENDING SUCCESS ERROR WARNING
EXAMPLES
beectl list_device_commands --device 1234:5678:devi:1234567890123456789012 --status PENDING
Lists the device logs for a given device.
SYNTAX
beectl list_device_logs --device <identifier of the device>
OPTIONS
--device
Specify the identifier of the device. Use list_devices command to determine the identifier of the device.
EXAMPLES
beectl list_device_logs --device 1234:5678:devi:1234567890123456789012
Lists all the device profiles.
SYNTAX
beectl list_device_profiles
OPTIONS
This command has no options
EXAMPLES
beectl list_device_profiles
Lists all the device types.
SYNTAX
beectl list_device_types
OPTIONS
This command has no options
EXAMPLES
beectl list_device_types
Lists the devices for a user.
SYNTAX
beectl list_devices --user <identifier of the user>
OPTIONS
--user
Specify the identifier of the user owing the device. Use list_users command to determine the identifier of a user.
EXAMPLES
beectl list_devices --user 1234:5678:user:2E0329B0705F0E40E040578C92160957000000000434
The list_directory_profiles command lists directory profiles in an XML file.
SYNTAX
beectl list_directory_profiles --file <filename>
OPTIONS
--file
XML file to be created.
EXAMPLES
beectl list_directory_profiles --file MyDirectoryProfile.xml
Lists all enterprises and prints names and identifiers
SYNTAX
beectl list_enterprises
OPTIONS
This command has no options
EXAMPLES
beectl list_enterprises
List all error code definitions in beehive.
SYNTAX
beectl list_errorcode_catalog [--display_columns <STRING_LIST>] [--errorcode_range <xxxxx-yyyyy>] [--errorcode <BEEX-12345> ... ]
OPTIONS
--display_columns
Comma separated list of columns to be displayed. Valid arguments are [service, messageid, displayname, severity, cause, effect, action]
--errorcode_range
Dash-separated range of error codes to list from the catalog, without the prefix. Default: 00000-99999
--errorcode
An individual error code to display information about, including prefix.
EXAMPLES
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.
SYNTAX
beectl list_events [ --event_name <event name to be listed> ]
OPTIONS
--event_name
Specify the name of the event to be listed.
EXAMPLES
beectl list_events --event_name MyEvent
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.
SYNTAX
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|profession|certificate|notes)=value=description> ... ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --status <status of contact(enabled|disabled)> ... ] [ --is_deleted <true|false> ] [ --created_by <identifier of creator> ... ] [ --modified_by <identifier of modifier> ... ] [ --show <show attributes(ALL|MORE)> ] }
OPTIONS
--contact
The identifier of the external contact
--email_id
Email id of the external contact
--family_name
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
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
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
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
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
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
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.
--nick_name
Nickname 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.
--office_location
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
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
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
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.
--organization
Identifiers of the organizations the contact belongs to.
--property
Details of the property in the format name=value. Supported names are certificate, assistant, profession and notes. Note, no equals to symbol(=) should be present in the name or value.
--address
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--status
Sets the provisioning status of the external contact. Supported values are ENABLED, DISABLED.
--is_deleted
Contacts whose provisioning status is deleted.
--created_by
Identifier of the entity who created the contact.
--modified_by
Identifier of the entity who modified the contact.
--count
Lists the number of contacts. When this option is used, no other information about the contacts is listed.
--show
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.
--match
If all the predicates values should match with the attributes of the contact or one or more attributes should match. Permitted values are ALL or ANY. Default is ANY.
EXAMPLES
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
Lists the file plan.
SYNTAX
beectl list_file_plan
OPTIONS
This command has no options
EXAMPLES
beectl list_file_plan
Lists the file system path, read-only status, and identifier of all available file system references.
SYNTAX
beectl list_filesystem_references
OPTIONS
This command has no options
EXAMPLES
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.
SYNTAX
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)> ] }
OPTIONS
--group
Identifier of the group
Email id of the group
--family_name
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
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
Scope or parent identifier of the group.
--organization
Identifiers of the organizations the group belongs to.
--property
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
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--is_deleted
Groups whose status is deleted.
--created_by
Identifier of the entity who created the group.
--modified_by
Identifier of the entity who modified the group.
--count
Lists the number of groups. When this option is used, no other information about the groups is listed.
--show
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.
--match
If all the predicates values should match with the attributes of the user or one or more attributes should match. Permitted values are ALL or ANY. Default is ANY.
EXAMPLES
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 --MEMBERS
beectl list_groups --name Group1Name --show ALL
beectl list_groups --name Group1% --scope enpr=enpr1 --match ALL --show MORE
Displays details of the language pack resources managed by the Beehive deployment.
SYNTAX
beectl list_language_pack [--full --base_names --locales --all_names --warnings --versions]
OPTIONS
--full
Include all details.
--base_names
include the supported base-names.
--locales
include all supported locales.
--warnings
include warnings about non-fatal inconsistencies.
--all_names
include all xliff file names.
--versions
include version information for each listed file.
EXAMPLES
beectl list_language_pack --full
Lists the Local Access Control List (LACL) of an entity.
SYNTAX
beectl list_local_acl --entity <unique identifier of the entity>
OPTIONS
--entity
Specify the unique identifier of the entity for which the Local Access Control List (LACL) should be listed.
EXAMPLES
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.
SYNTAX
beectl list_max_address_count
OPTIONS
This command has no options
EXAMPLES
beectl list_max_address_count
Lists conference artifacts under workspace
SYNTAX
beectl list_my_conferences --count-limit <A count limit for a list of conferences>
OPTIONS
--count-limit
A count limit for a list of conferences
EXAMPLES
beectl list_my_conferences --count-limit 1000
Lists organizations in the given scope
SYNTAX
beectl list_organizations --scope <Identifier of enterprise or organization> [--recurse <TRUE|FALSE. Default value is FALSE. Recursively list organizations>] [--name <Organization name>]
OPTIONS
--scope
Identifier of the parent scope (enterprise or organization)
--recurse
TRUE|FALSE. Default value is FALSE. Recursively list organizations
--name
Organization name
EXAMPLES
beectl list_organizations --scope 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453 --recurse TRUE
beectl list_organizations --scope enpr=ORCL --name MyOrg
Lists policies in an specific container. Details returned include policy names and identifiers.
SYNTAX
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> ]
OPTIONS
--policy_name
Specify the name of the policy.
--scope
Specify the identifier of the container where policy is deployed.
--children
Specify whether to include policies defined at child containers.
--enforced
Specify whether to include enforced policies.
EXAMPLES
beectl list_policies --policy_name MyPolicy --scope enpr=MyEnterprise --children true --enforced false
Lists all policy actions.
SYNTAX
beectl list_policy_actions
OPTIONS
This command has no options
EXAMPLES
beectl list_policy_actions
Lists policy schemas in the current enterprise. Details returned include policy schema names and identifiers.
SYNTAX
beectl list_policy_schemas --name <name of the policy schema>
OPTIONS
--name
Specify the name of the policy schema.
EXAMPLES
beectl list_policy_schemas --name ExamplePolicySchema
Lists policy templates in a specified container. Details returned include policy template names and identifiers.
SYNTAX
beectl list_policy_templates --name <name of the policy template to be listed> --scope <container where the policy template is defined>
OPTIONS
--name
Specify the name of the policy template.
--scope
Specify the identifier of the container where policy template is deployed.
EXAMPLES
beectl list_policy_templates --name ExamplePolicyTemplate --scope 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453
Lists various available ports.
By default it shows ports used by current Oracle Beehive Application tier only.
Valid protocols are
SMTP
IMAP
XMPP
XMPPS
FTP
HTTP
HTTPS
BTP
BTPS
OC4J-AJP-RANGE
OC4J-RMI-RANGE
OC4J-RMIS-RANGE
OC4J-JMS-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:-
1- Protocol:- Contains protocol name. It can be empty, if port is internal.
2- Listen Port:- The value of the port on which listening component is listening. 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.
SYNTAX
beectl list_ports [--instance <beehive instance system identifier or alias>] [--all]
OPTIONS
--instance
System object identifier of Beehive Instance for which ports should be shown.
--all
Flag indicating if all the ports in the system should be listed.
EXAMPLES
beectl list_ports --all
Above example lists ports used by all the Oracle Beehive Application tiers.
The list_preference_profiles command lists preference profiles for a consumer.
SYNTAX
beectl list_preference_profiles --consumer <Identifier of the consumer>
OPTIONS
--consumer
Identifier of the consumer
EXAMPLES
beectl list_preference_profiles --consumer loginid=user1
The list_preference_properties command lists all effective preference properties of a preference set.
SYNTAX
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.>
OPTIONS
--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.
EXAMPLES
beectl list_preference_properties --set 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000979
The list_preference_sets command lists all preference sets for a preference profile.
SYNTAX
beectl list_preference_sets --profile <Preference profile identifier>
OPTIONS
--profile
Identifier of the preference profile.
EXAMPLES
beectl list_preference_sets --profile prfp=MyProfile,loginid=user1
Lists available Privilege names.
SYNTAX
beectl list_privileges
OPTIONS
This command has no options
EXAMPLES
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.
SYNTAX
beectl list_properties --component <system object identifier or alias of the component> [--name <name>] [--configuration_version ( ACTIVE | PROPOSED | <long version number> )]
OPTIONS
--component
Component identifier
--name
Name of the property
--configuration_version
Configuration version. Valid values are active, proposed, any positive long number.
EXAMPLES
beectl list_properties --component 288d5051-2632-4800-b796-b3e16ca58f2d --configuration_version ACTIVE
Lists the metadata about all the properties of a system model object.
SYNTAX
beectl list_property_metadata --type <System model object type> [--full_report]
OPTIONS
--type
Type of the component for which property metadata to be listed.
--full_report
Flag indicating if full report should be displayed. It contains description about properties also.
EXAMPLES
beectl list_property_metadata --type WorkspacesService
Lists resources.
SYNTAX
beectl list_resources [--select_by_name <name_regex>] [--select_by_identifier <identifier_regex>] [--select_by_capacity <capacity>] [--external]
OPTIONS
--select_by_name
Specify the resource name criteria. This option accepts a regular expression match.
--select_by_identifier
Specify the resource identifier criteria. This option accepts a regular expression match.
--select_by_capacity
Specify the resource capacity.
--external
Return external resources. If this option is not specified, only bookableresources will be returned.
EXAMPLES
beectl list_resources --select_by_name "Resource"
Lists RoleDefinition entities.
SYNTAX
beectl list_role_definitions [--scope <unique identifier of the Scope>] [--name <like string>]
OPTIONS
--scope
Specify the unique identifier of the Scope of the RoleDefinitions to be listed. If not specified the Scope will be the Enterprise.
--name
Specify the name pattern of the RoleDefinitions to be listed. If not specified all accessible RoleDefinitions will be returned.
EXAMPLES
beectl list_role_definitions --scope wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition
Lists Sensitivity entities.
SYNTAX
beectl list_sensitivities --workspace <unique identifier of the Workspace> [--name <like string>]
OPTIONS
--workspace
Specify the unique identifier of the Workspace of the Sensitivities to be listed.
--name
Specify the name pattern for the Sensitivities to be listed. If not specified all accessible Sensitivities will be returned.
EXAMPLES
beectl list_sensitivities --workspace wksp=MyWorkspace,enpr=MyEnterprise --name MySensitivity
Lists the Sensitivity Access Control List (SACL) of a Sensitivity.
SYNTAX
beectl list_sensitivity_acl --sensitivity <unique identifier of the Sensitivity>
OPTIONS
--sensitivity
Specify the unique identifier of the Sensitivity whose Sensitivity Access Control List (SACL) should be listed.
EXAMPLES
beectl list_sensitivity_acl --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise
Lists the statistics for a given type or system object or for the entire site (default).
SYNTAX
beectl list_statistics ([--type <System model object type>] [--component <stat provider system model object identifier or alias>])
OPTIONS
--type
Type of the component for which statistics to be listed.
--component
System object identifier of the component for which statistics to be listed.
EXAMPLES
beectl list_statistics --type WorkspacesServiceInstance
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".
SYNTAX
beectl list_supported_entity_types
OPTIONS
This command has no options
EXAMPLES
beectl list_supported_entity_types
Lists existing tasklists of a user, resource or workspace.
SYNTAX
beectl list_tasklists { --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> } [--authuser <authuser> --authpassword <password>] [--obfuscated]
OPTIONS
--tasklistowner
Specify the unique identifier of a user, resource or workspace.
--select_by_address
Specify the Uniform Resource Identifier (URI) of a user, resource or team workspace.
--select_by_authuser
Specify the login name of a user.
--select_by_user_name
Specify the name of a user.
--select_by_resource_name
Specify the name of a resource.
--select_by_workspace_name
Specify the name of a workspace.
EXAMPLES
beectl list_tasklists --select_by_address user@example.com
Lists time zones in the database. The list can be limited by common time zones or by time zone names.
SYNTAX
beectl list_timezones [--all] | [--select_by_common] [--select_by_name <TimezoneName>]
OPTIONS
--all
Lists all time zones. This option cannot be used with the --select_by_name or --select_by_common option.
--select_by_common
Lists common time zones. This is a default option if no arguments are specified.
--select_by_name
Specifies a time zone name. To list all time zones, use an asterisk(*) as an argument.
EXAMPLES
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 commands lists the trusted identities. The type has to be specified. For type SES, it lists the names of the trusted entities.
SYNTAX
beectl list_trusted_identity --type <type(SES|WSSEC)>
OPTIONS
--type
Type of the trusted identity. Permitted values are SES or WSSEC. SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
EXAMPLES
The list_users command lists users that match specified search criteria. If search criteria are not specified, then all users are listed.
SYNTAX
beectl 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> ... ] [ --manager <manager identifier> ... ] [ --extended_enterprise_user <true|false> ] [ --organization <organization identifier> ... ] [ --property <name(certificate|notes)=value=description> ... ] [ --address <type of address(business_1|other_5|personal_4|proxy_1|...):scheme(im|mailto|...):value> ... ] [ --status <status of user(locked|enabled|disabled)> ... ] [ --is_deleted <true|false> ] [ --created_by <identifier of creator> ... ] [ --modified_by <identifier of modifier> ... ] [ --show <show attributes(ALL|MORE)> ] }
OPTIONS
--user
Identifier of the user.
Email id of the user
--family_name
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
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
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
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
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
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
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.
--nick_name
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
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
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
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
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.
--manager
Identifier of the manager.
--organization
Identifiers of the organizations the user belongs to.
--property
Details of the property in the format name=value. Supported names are certificate, assistant, profession and notes. Note, no equals to symbol(=) should be present in the name or value.
--address
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--status
Sets the provisioning status of the user. Supported values are ENABLED, DISABLED, LOCKED.
--is_deleted
Users whose provisioning status is deleted.
--extended_enterprise_user
Lists all extended enterprise user.
--created_by
Identifier of the entity who created the user.
--modified_by
Identifier of the entity who modified the user.
--count
Lists the number of users. When this option is used, no other information about the users is listed.
--show
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.
--match
If all the predicates values should match with the attributes of the user or one or more attributes should match. Permitted values are ALL or ANY. Default is ANY.
EXAMPLES
beectl list_users
beectl list_users --count
beectl list_users --user loginid=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 loginid=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 heterogeneous folder.
SYNTAX
beectl list_version_configuration --container <Configuration scope or heterogenous folder> --effective <TRUE|FALSE. Default value is FALSE>
OPTIONS
--container
Scope or heterogeneous folder on which the version configuration should be listed.
--effective
Whether the effective version configuration should be returned or the one directly defined.
EXAMPLES
beectl list_version_configuration --container orgn=MyOrganization,enpr=MyEnterprise
Lists workflow schemas.
SYNTAX
beectl list_workflow_schemas [ --workflow_schema <Specify the identifier of the workflow schema to be listed.> ]
OPTIONS
--workflow_schema
Specify the identifier of the workflow schema to be listed.
EXAMPLES
beectl list_workflow_schemas --workflow_schema wfsc=MyWorkflowSchema,enpr=MyEnterprise
Lists workflow templates deployed in a container. Details returned include workflow template names and identifiers.
SYNTAX
beectl list_workflow_templates --scope <container where the workflow is configured> [ --template_key <workflow template key> ]
OPTIONS
--scope
Specify the identifier of the container.
--template_key
Specify the template key. To determine the template key, use the list_events command.
EXAMPLES
beectl list_workflow_templates --scope enpr=MyEnterprise --template_key MyTemplateKey
List all workflows for which the active user has privileges. Specify user and status options for filtering.
SYNTAX
beectl list_workflows [ --status <Specify the status of the workflows to be listed.> ] [ --creator <Specify the identifier of the creator of the workflows to be listed. When this option is omitted, workflows created by the active user will be listed.> ] [ --identifier <Specify the identifier of the workflow to be listed.> ]
OPTIONS
--status
Specify the status of the workflows to be listed. The valid workflow status options are: WORKFLOWSTATUSINITIATED, WORKFLOWSTATUSCANCELED, WORKFLOWSTATUSCLOSED, WORKFLOWSTATUSCOMPLETED, WORKFLOWSTATUSEXPIRED, WORKFLOWSTATUSFAULTED.
--creator
Specify the identifier of the creator of the workflows to be listed. When this option is omitted, workflows created by the active user will be listed.
--identifier
Specify the identifier of the workflow to be listed.
EXAMPLES
beectl list_workflows --status MyWorkflowStatus --creator loginid=MyUser --identifier 18A4:72D2:wkfl:43EE9FA76C0E4935E040578C95096F4E000000018F
Lists all workspace templates
SYNTAX
beectl list_workspace_templates --scope <Identifier of enterprise or organization> [--name <Workspace template name>] [--file <Full path of the output file>]
OPTIONS
--scope
Identifier of enterprise or organization
--name
Workspace template name
--file
Full path of the output file
EXAMPLES
beectl list_workspace_templates --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453
beectl list_workspace_templates --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name Test_template --file /tmp/template.xml
Lists workspaces in an organization or enterprise
SYNTAX
beectl list_workspaces --scope <Identifier of enterprise or organization> [--type <p (Personal) | t (Team) | a (All)>] [--name <Workspace name>] [--recurse]
OPTIONS
--scope
Identifier of enterprise or organization
--type
p (Personal) | t (Team) | a (All)
--name
Workspace name
--recurse
Recursively list workspaces in all organizations
EXAMPLES
beectl list_workspaces --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --type t
beectl list_workspaces --scope 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name My_Workspace
Modifies the AccessControlFields of an existing entity.
This command alters sensitive data in the system. Oracle recommends using this command with caution.
SYNTAX
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>] [--scope <unique identifier of the Scope>]
OPTIONS
--entity
Specify the unique identifier of the entity to be modified.
--owner
Modify the owner of the entity. Specify the unique identifier of the new owner.
--owner_access_types
Modify the access types string for the entity's owner.
--sensitivity
Modify the Sensitivity of the entity. Specify the unique identifier of the new Sensitivity.
--scope
Modify the Scope of the entity. Specify the unique identifier of the new Scope.
EXAMPLES
beectl modify_access_control_fields --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --owner loginid=MyUser
Modifies an existing AssignedRole entity.
SYNTAX
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>]...]
OPTIONS
--assigned_role
Specify the unique identifier of the AssignedRole to be modified.
--name
Modify the name of the AssignedRole.
--description
Modify the description of the AssignedRole.
--assigned_scope
Modify the assigned Scope of the AssignedRole. Specify the unique identifier of the new assigned Scope.
--role_definition
Modify the assigned RoleDefinition of the AssignedRole. Specify the unique identifier of the new RoleDefinition.
--accessor
Modify the set of Accessors. Specify the unique identifier of an Accessor. This option can be specified more than once.
--add_accessor
Adds an Accessor. Specify the unique identifier of an Accessor to add. This option can be specified more than once.
--remove_accessor
Removes an Accessor. Specify the unique identifier of an Accessor to remove. This option can be specified more than once.
EXAMPLES
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.
SYNTAX
beectl modify_attendant { --file <aaml file> | --name <attendant name> --new_name <new name> }
OPTIONS
--file
An auto-attendant markup language file describing the attendant to be added. When specified, name and new_name must be specified.
--name
Name of an existing attendant. Must be specified when 'new_name' is specified. Must not be specified when 'file' is specified
--new_name
The name to which the attendant should be changed. Must be specified when 'name' is specified. Must not be specified when 'file' is specified
EXAMPLES
beectl modify_attendant --file /var/attendant.aaml
beectl modify_attendant --name myattendant --new_name myattendant2
Modifies an existing audit policy
SYNTAX
beectl modify_audit_policy --policy <Audit policy identifier> [--file <Full path of the input file>] [--enable <true|false>]
OPTIONS
--policy
Audit policy identifier
--file
Full path of the input file
--enable
true: Enable audit policy
--enable
false: Disable audit policy
EXAMPLES
beectl modify_audit_policy --policy aupl=MyAuditPolicy --file /tmp/policy_ex.xml
beectl modify_audit_policy --policy aupl=MyAuditPolicy --enable false
Modifies an existing audit trail
SYNTAX
beectl modify_audit_trail --trail <Audit trail identifier> --file <Full path of the input file>
OPTIONS
--trail
Audit trail identifier
--file
Full path name of the input XML file
EXAMPLES
beectl modify_audit_trail --trail autr=MyAuditTrail --file /tmp/trail_ex.xml
This command updates the beectl file with the given oracle home & perl home
SYNTAX
beectl modify_beectl --new_oracle_home <new oracle home> [--new_perl_home <new perl home>]
OPTIONS
--new_oracle_home
Absolute path of the new oracle home
--new_perl_home
Absolute path of the new perl home
EXAMPLES
beectl modify_beectl --new_oracle_home /app/product/oracle/beehive/
Modify the connect string or credentials for the central configuration repository also known as bootstrap database. Misconfiguration will result in Oracle Beehive Application tier and site being not operable.
This command will modify the local bootstrap configuration file. Additionally, it will update the central configuration repository if the properties connect string, schema name or schema password are changed. This command does not revert the changes to local bootstrap configuration file if it fails to update the central configuration repository.
SYNTAX
beectl modify_bootstrap_configuration --connect_string <configuration repository connect string> --schema_name <configuration repository schema name> --schema_password <configuration repository schema password>
OPTIONS
--connect_string
Configuration repository connect string.
--schema_name
Configuration repository schema name.
--schema_password
Configuration repository schema password.
EXAMPLES
beectl modify_bootstrap_configuration --connect_string <connect string> --schema_name <schema name> --schema_password <schema password>
Modifies an existing category
SYNTAX
beectl modify_category --category <Category identifier> --file <Full path of the category XML file>
OPTIONS
--category
Category to be updated.
--file
Full path name of the XML file. The file must contain properly formatted data to update the category
EXAMPLES
beectl modify_category --category catg=MyCategory,enpr=MyEnterprise --file /tmp/category.xml
Updates a given category configuration.
SYNTAX
beectl modify_category_configuration --configuration <Configuration identifier> --file <Full path of the configuration XML file>
OPTIONS
--configuration
Category configuration to be updated.
--file
Full path of the category configuration XML file. The file must contain properly formatted data.
EXAMPLES
beectl modify_category_configuration --configuration 9941:2345:ctcf:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/configuration.xml
Modifies the change log number of a profile.
SYNTAX
beectl modify_change_number --profile <profilename> --changelog_number <changelognumber>
OPTIONS
--profile
Name of the profile.
--changelog_number
Change log number of the profile.
EXAMPLES
beectl modify_change_number --profile MyDirectoryProfileName --changelog_number 100
Modifies the configuration of a coexistence connector.
SYNTAX
beectl modify_coexistence_connector [--select_by_name <connectorid>] [--url <old_name>] [--use_secure_connection <url>] [--host_name <use_secure_connection>] [--port <host_name>] [--name <port_number>] [--sitekey <new_name>] [--timezone_alias_namespace [<obfuscated_sitekey> --obfuscated]] [--{11} <timezone_alias_namespace>]
OPTIONS
--select_by_name
Specify the name of the coexistence connector to be modified.
--name
Specify a new name for the coexistence connector.
--url
Specify the URL of the coexistence connector.
--use_secure_connection
Specify whether "HTTPS" MUST be used.
--host_name
Specify the host name of the connector.
--port
Specify the port number used by the connector. Value MUST be an integer.
--sitekey
Specify the site key of the coexistence connector.
--timezone_alias_namespace
Specify the time zone alias namespace used by the connector.
EXAMPLES
beectl modify_coexistence_connector --select_by_name MsExch2001 --url http://www.example.com:7777 --name MsExch2003_1
Specifies the coexistence profile of a user.
SYNTAX
beectl modify_coexistence_profile {--user <user_cen> | --select_by_name <user_name> | --select_by_address <user_address> --select_by_authuser <user_loginid> | --file <input.xml> --errors_file <errors.xml> | --select_users_without_profile --errors_file <errors.xml>} --accessible_system <system_name> ...
OPTIONS
--user
Specify the identifier of the user.
--select_by_name
Specify the name of the user.
--select_by_address
Specify the email address of the user.
--select_by_authuser
Specify the login ID of the user.
--select_users_without_profile
Specify all beehive users without coexistence profile.
--file
Specify the xml input file. File encoding MUST be UTF-8. Only supported for creation.
--errors_file
Specify the output file. This file will only be generated if errors occurs.
--accessible_system
Specify the collaboration system which can be accessed by the user. Supported collaboration systems are BEEHIVE and EXCHANGE.
EXAMPLES
beectl modify_coexistence_profile --select_by_authuser user_login_id --accessible_system BEEHIVE
beectl modify_coexistence_profile --select_by_address user@example.com --accessible_system EXCHANGE
beectl modify_coexistence_profile --accessible_system BEEHIVE --accessible_system EXCHANGE --file users.xml --errors_file errors.xml
beectl modify_coexistence_profile --accessible_system EXCHANGE --select_users_without_profile --errors_file errors.xml
Modifies the connection pool configuration.
SYNTAX
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>]
OPTIONS
--connection_pool
Connection pool system object identifier.
--max_connections
Maximum number of connections in connection pool.
--min_connections
Number of minimum connections in connection pool.
--max_statement_limit
Maximum number of cached statements in connection pool.
--initial_connections
Number of initial connections in connection pool.
--connection_wait_timeout
Connection wait timeout.
--inactivity_timeout
Inactivity timeout.
--time_to_live_timeout
Time to live timeout.
--abandoned_connection_timeout
Abandoned connection timeout.
--lower_threshold_limit
Lower threshold limit.
--property_check_interval
Property check interval.
--validate_connection
Should connection be validated or not.
EXAMPLES
beectl modify_connection_pool --connection_pool 232323-der344-455-3455ded --max_connections 40
Modifies given database configuration.
SYNTAX
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>] .. ]
OPTIONS
--database
Database system object identifier.
--schema_name
Schema name.
--connect_string
Connection descriptor.
--schema_password
Schema password.
--xa_service_names
Multiple values of xa service names can be given. See the usage.
--ons_entry
Notification server details in form of host:port.
EXAMPLES
beectl modify_database --database ab222-aa4-eee333-ddede5 --schema_name schema1
The modify_directory_profile command modifies an existing directory profile. Modification to the profile name cannot be done.
SYNTAX
beectl modify_directory_profile --file <filename> [ --no_validate ]
OPTIONS
--file
XML file containing directory profile.
--no_validate
Skips the validation of profile.
EXAMPLES
beectl modify_directory_profile --file MyDirectoryProfile.xml
beectl modify_directory_profile --file MyDirectoryProfile.xml --no_validate
Modifies Email service' SMTP or IMAP port number
SYNTAX
beectl modify_email_port --type <smtp|imap> --port <port_number>
OPTIONS
--type
imap: IMAP port number
--type
smtp: SMTP port number
EXAMPLES
beectl modify_email_port --type smtp --port 1234
Enables or disables Email asynchronous queue processing
SYNTAX
beectl modify_email_queue --type <enable|disable|process|status>
OPTIONS
--type
enable: Resume or enable queue processing
--type
disable: Disable queue processing
--type
process: Process all the messages in the Email asynchronous queue immediately
--type
status: Show current status
EXAMPLES
beectl modify_email_queue --type enable
beectl modify_email_queue --type process
Modifies an existing enterprise
SYNTAX
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>]
OPTIONS
--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
EXAMPLES
beectl modify_enterprise --enterprise 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name New_Name --description New_description
beectl modify_enterprise --enterprise 9941:2345:enpr:58D193D162CE4ED89FF66AB4E55745B6345464545453 --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 09F3:7265:ttws:3A599FA8F12533AEE0404498826342040000000001DC --personal_template 09F3:7265:tpws:3A599FA8F12533AEE0404498826342040000000001DB
The modify_external_contact command modifies existing external contact.
SYNTAX
beectl modify_external_contact { --contact <identifier of external contact > | --email <Email address of the 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 <time zone of the contact> ] [ --locale <locale of the contact> ] [ --department <department of the contact> ] [ --organization <organization identifier> ... ] [ --remove_organization <organization identifier> ... ] [ --property <+/-name(assistant|profession|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)> ]
OPTIONS
--contact
The identifier of the external contact
Email id of the external contact
--family_name
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
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
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
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
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
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
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
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.
--scope
Identifier of the enterprise under which this contact will be created.
--office_location
Office location of the contact.
--company
Company of the contact.
--profession
Profession of the contact.
--timezone
Time zone of the contact. list_timezones lists the valid time zones
--locale
Locale details of the contact. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
--department
Department of the contact.
--organization
Identifiers of the organizations the contact must be part of.
--remove_organization
Identifiers of the organizations the contact must be removed from.
--property
Details of the property in the format [+/-]name=value=description. Supported names are certificate, assistant, profession 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
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. 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.
--default_address_for_type
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--default_address_for_scheme
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. 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
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--status
Sets the provisioning status of the external contact. Supported values are ENABLED, DISABLED.
EXAMPLES
beectl modify_external_contact --user 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
The modify_group command modifies a group. The group information is supplied in an XML file.
SYNTAX
beectl modify_group --file <filename> [ --ldapbootstrap ]
OPTIONS
--file
Filename of the XML file containing group definition.
--ldapbootstrap
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.
EXAMPLES
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.
SYNTAX
beectl modify_hostname [--no_start_at_end] [(--sync | --new_host_name <new host name> [--no_dns_validation]) [--old_host_name <old host name>]... ]
OPTIONS
--sync
If specified, command will read values from configuration repository and sync it to the system configuration files.
--new_host_name
New host name of the local server.
--old_host_name
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.
--new_host_ip
New IP address of the local server.
--old_host_ip
Old IP address of the local server.
--no_start_at_end
It assures that no component will be started after modification to configuration files.
--no_dns_validation
If specified, DNS lookup validation of the new host name will not be performed.
EXAMPLES
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
Above example will update configuration repository as well as all other configuration files with new hostname.
Resets the seed of the password generator for IP phones. To send commands to an IP phone the requestor must be authenticated. The password is generated based on information in the phone but must be seeded to ensure security.
SYNTAX
beectl modify_ip_phone_password_seed --enterprise <Enterprise identifier> [--algorithm <algorithm>] [--seed_length <seed length>]
OPTIONS
--enterprise
Identifier of the enterprise for which we are resetting the password seed.
--algorithm
Name of the algorithm used to generate password, this value will be stored on the server. If not given, the value will be taken from the enterprise. An error will result if not given and not found on the enterprise. Must be a standard name allowed with instances of KeyGenerator according to appendix A of Java Cryptography Extension Reference Guide.
--seed_length
The length in bits of the seed to be generated. This value will be stored in the server. If not given, the value will be taken from the enterprise. An error will result if not given and not found on the enterprise.
EXAMPLES
beectl modify_ip_phone_password_seed --enterprise <740F:6AC7:enpr:3540AA5334A61A3AE040578C60160AFD000000030D45> [--algorithm <DES>] [--seed_length <256>]
Replaces an Access Control Entry (ACE) in the Local Access Control List (LACL) of an entity.
SYNTAX
beectl modify_local_ace --entity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
OPTIONS
--entity
Specify the unique identifier of the entity in which the ACE will be replaced.
--accessor
Specify the unique identifier of the Accessor to whom the access types will be applied.
--access_types
Specify the access types string for the Accessor.
EXAMPLES
beectl modify_local_ace --entity adoc=MyDocument,wksp=MyWorkspace,enpr=MyEnterprise --accessor loginid=MyUser --access_types +RW-D
This command updates configuration files local to current Oracle Beehive Application tier with activated changes to centralized configuration. It can restart one or more components on current Oracle Beehive Application tier if needed to make the changes take effect. Some updates to local configuration files require this command to restart all Oracle Beehive Application tier components.
SYNTAX
beectl modify_local_configuration_files [--restart_needed]
OPTIONS
--restart_needed
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.
EXAMPLES
beectl modify_local_configuration_files
Above command will update local configuration files with changes if any and restart one or more Oracle Beehive Application tier 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.
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.
SYNTAX
beectl modify_max_address_count --max_address_count <integer value>
OPTIONS
--max_address_count
Maximum number of addresses of an address-type.
EXAMPLES
beectl modify_max_address_count --max_address_count 5
Modifies a specified notification template for the Notification service.
SYNTAX
beectl modify_notification_template --file <path to the xml instruction file>
OPTIONS
--file
Specify the full path and file name of the notification XML file.
EXAMPLES
beectl modify_notification_template --file /tmp/nms/UpdateNewInvitationSchema.xml
Modifies an existing organization
SYNTAX
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>]
OPTIONS
--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
EXAMPLES
beectl modify_organization --organization 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name New_Name --description New_description
beectl modify_organization --organization 9941:2345:orgn:58D193D162CE4ED89FF66AB4E55745B6345464545453 --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 09F3:7265:tpws:3A599FA8F12533AEE0404498826342040000000001DB --team_template 09F3:7265:ttws:3A599FA8F12533AEE0404498826342040000000001DC
Modifies an existing personal workspace
SYNTAX
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>]
OPTIONS
--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
EXAMPLES
beectl modify_personal_workspace --workspace 9941:2345:wspr:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name New_Name --description New_description
beectl modify_personal_workspace --workspace 9941:2345:wspr:58D193D162CE4ED89FF66AB4E55745B6345464545453--hard_quota 1000 --soft_quota 1000
Modifies an existing policy using data in an XML file.
SYNTAX
beectl modify_policy --file <full path to the policy xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains the policy data.
EXAMPLES
beectl modify_policy --file /private/xml/MyPolicy.xml
Modifies an existing policy schema using data in an XML file.
SYNTAX
beectl modify_policy_schema --file <full path to the xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains the policy schema data.
EXAMPLES
beectl modify_policy_schema --file /private/xml/MyPolicySchema.xml
Modifies an existing policy template using data in an XML file.
SYNTAX
beectl modify_policy_template --file <full path to the xml file>
OPTIONS
--file
Specify the absolute path of the XML file that contains the policy template data.
EXAMPLES
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-AJP-RANGE
OC4J-RMI-RANGE
OC4J-RMIS-RANGE
OC4J-JMS-RANGE
OC4J-AJP-RANGE identifies the range of ports in current site for either AJP or secure AJP protocol whichever is enabled.
SYNTAX
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> ]
OPTIONS
--protocol
Name of the protocol for which port needs to be modified.
--virtual_port
Port to which the clients will connect. This value will be modified for the entire site.
--listen_port
The actual port which will be opened on each Oracle Beehive Application tier. Typically a listening port.
--port
Convenience option to set both --virtual_port and --listen_port together with same value.
--component
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
Name of the internal port property on the configuration object identified by --component option.
--maximum_port
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.
--minimum_port
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.
EXAMPLES
beectl modify_port --protocol HTTP --virtual_port 80 --listen_port 7774
Above example modifies virtual and listen port values for HTTP protocol for all Oracle Beehive Application tiers.
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 Oracle Beehive Application tiers.
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 Oracle Beehive Application tiers. 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.
SYNTAX
beectl modify_preference_set --set <Preference set identifier> --extends <Preference set identifier>
OPTIONS
--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.
--extends
Identifier of the preference set from which the new preference set is extended.
EXAMPLES
beectl modify_preference_set --set 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000979 --extends 5965:3658:prfs:B7CAC0E31E554593B7A93B24B0FD09F2000000000978
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 hyphens. 2. Prefix the option value with string "ESCAPE:". 3. Prefix 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.
SYNTAX
beectl modify_property --component <system object identifier or alias> --name <name> [ --file <filename> | --revert_to_default | --value <value>... ]
OPTIONS
--component
component id.
--name
Name of the property.
--value
Value of the property.
--file
The contents of this file would be assigned as the value of the specified property. The property MUST be of type String.
--revert_to_default
flag indicating, if values need to be reverted back as original.
EXAMPLES
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"
This command set the given category as resource root classification.
SYNTAX
beectl modify_resource_classifications [--enterprise <enterpriseid>] --category <categoryid>
OPTIONS
--enterprise
Specify the identifier of the enterprise under which the resource will be created.
--category
Category identifier to set as root classification.
EXAMPLES
beectl modify_resource_classifications --category 395A:346B:catg:2C5F7E98E076D382E040578CA60B0D0E000000062022
Modifies an existing resource.
SYNTAX
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>] 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 <time zone name>] [--location <location>] [--booking_info <booking info>] [--description <description>]
OPTIONS
--resource
Resource ID.
--select_by_name
modify a resource by name
--name
Modify the name of the resource.
--email_address
Modify the e-mail address of the resource.
--phone_number
Modify the phone number of the resource.
--website
Modify the web site of the resource.
--postal_address
Specify the BUSINESS_1 postal address of the resource.
--timezone
Modify the time zone of the resource.
--location
Specify the location description of the resource. It must be a XHTML string.
--identifier
Modify the identifier of the resource.
--capacity
Modify the capacity of the resource.
--external
Specify this option when the resource is external. If this option is not specified, the command modifies bookable resources.
--add_approver
Resource approver to add.
--delete_approver
Resource approver to delete.
--booking_characteristics
Specify resource default calendar booking characteristics. The characteristics can be Open or First Come First Serve.
--booking_info
Specify resource booking information. It must be a XHTML string.
--description
Specify the description of the resource. It must be a xHTML string.
EXAMPLES
beectl modify_resources --resource 395A:346B:bkrs:2C5F7E98E076D382E040578CA60B0D0E000000062327 --name "Resource2" --capacity 3
Modifies an existing RoleDefinition entity.
SYNTAX
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>]
OPTIONS
--role_definition
Specify the unique identifier of the RoleDefinition to be modified.
--name
Modify the name of the RoleDefinition.
--description
Modify the description of the RoleDefinition.
--privilege
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_privilege
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_privilege
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.
--access_types
Modify the access types for the RoleDefinition.
--always_enabled
Modify the AlwaysEnabled option of the RoleDefinition. Specify the TRUE argument to enable, and FALSE to disable.
EXAMPLES
beectl modify_role_definition --role_definition acrd=MyRoleDefinition,wksp=MyWorkspace,enpr=MyEnterprise --name MyRoleDefinition2
Create system model objects for Search and configure them
SYNTAX
beectl modify_search [--option1 <option1argument> ... ]
OPTIONS
--sync_frequency
Sync frequency of the search crawler (in seconds)
--max_results
Maximum number of results to return
--cached_page_max_length
Maximum length of cached pages
--wildcard_char
The desired wildcard character
--exclude_regex
True to exclude regular expressions, false otherwise
--maximum_search_duration
Maximum time to allow a search to run before returning (in seconds)
--case_sensitive
True for case sensitivity, false otherwise
--two_db_mode
True if operating in two db mode, false otherwise
--recovery
True if operating in recovery mode, false otherwise
EXAMPLES
beectl modify_search --sync_frequency 100 --max_results 1000 --cached_page_max_length 1000 --wildcard_char \* --exclude_regex false --maximum_search_duration 30 --case_sensitive false --two_db_mode false --recovery false
Starts or stops the search crawl process for a specific source type
SYNTAX
beectl modify_search_engine --crawl <start|stop> --source <type>
OPTIONS
--crawl
Starts or stops the search crawl process
--source
Source type to start or stop crawling (E.g. EMAILS, DOCUMENTS, CALENDARS and ALL)
EXAMPLES
beectl modify_search_engine --crawl start --source all
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 hyphens. 2. Prefix the option value with string "ESCAPE:". 3. Prefix 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.
SYNTAX
beectl modify_secure_property --component <system object identifier or alias> --name <name> --value <obfuscated value> --obfuscated
OPTIONS
--component
component id.
--name
Name of the property.
--value
Value of the property.
EXAMPLES
beectl modify_secure_property --component d4261c24-e917-4e37-9777-41799ef9abe8 --obfuscated --name AdminPassword --value
Modifies an existing Sensitivity entity.
SYNTAX
beectl modify_sensitivity --sensitivity <unique identifier of the Sensitivity> [--name <name of Sensitivity>] [--description <description>] [--sensitivity_only <boolean value>] [--delegatable <boolean value>]
OPTIONS
--sensitivity
Specify the unique identifier of the Sensitivity to be modified.
--name
Modify the name of the Sensitivity.
--description
Modify the description of the Sensitivity.
--sensitivity_only
Modify the SensitivityOnly option for the Sensitivity. Specify the TRUE argument to enable, and FALSE to disable.
--delegatable
Modify the Delegatable option for the Sensitivity. Specify the TRUE argument to enable, and FALSE to disable.
EXAMPLES
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.
SYNTAX
beectl modify_sensitivity_ace --sensitivity <unique identifier of the entity> --accessor <unique identifier of the Accessor> [--access_types <access types string>]
OPTIONS
--sensitivity
Specify the unique identifier of the Sensitivity in which the ACE will be replaced.
--accessor
Specify the unique identifier of the accessor to whom the access types were applied.
--access_types
Specify the access types string for the Accessor.
EXAMPLES
beectl modify_sensitivity_ace --sensitivity acsn=MySensitivity,wksp=MyWorkspace,enpr=MyEnterprise --accessor loginid=MyUser --access_types +RW-D
Modifies an existing team workspace
SYNTAX
beectl modify_team_workspace --workspace <Workspace identifier> [--name <Workspace name>] [--description <Description>] [--add_participant <User or group identifier> [--role <Role definition name>]] [--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>]
OPTIONS
--workspace
Workspace identifier
--add_participant
Add a user or group to the team workspace
--role
Workspace role of the user. Example: workspace-member, workspace-coordinator, workspace-viewer etc
--remove_participant
Remove a user or group from the team workspace
--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
--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
EXAMPLES
beectl modify_team_workspace --workspace 9941:2345:wspr:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name New_Name --description New_description
beectl modify_team_workspace --workspace 9941:2345:wspr:58D193D162CE4ED89FF66AB4E55745B6345464545453--hard_quota 1000 --soft_quota 1000
beectl modify_team_workspace --workspace 9941:2345:wspr:58D193D162CE4ED89FF66AB4E55745B6345464545453 --add_participant 9941:2345:user:58D193D162CE4ED89FF66AB4E55745B6345461245453 --role workspace-viewer --email_address teamworkspace@company.com --participation_mode OPEN --directory_listed TRUE
Modify a time zone.
SYNTAX
beectl modify_timezones <--select_by_name TimeZoneName | --timezone TimeZoneCollabId > [--common] | <--reset_to_default>
OPTIONS
--timezone
Time zone ID. This option is optional and can be entered only once.
--select_by_name
Select time zone by name. This option is optional and can be entered only once.
--common
Set the specified time zone as common. This option is optional and can be entered only once.
--reset_to_default
Reset time zones to factory default. This option is optional and can be entered only once.
EXAMPLES
beectl modify_timezones --select_by_name America/New_York
beectl modify_timezones --reset_to_default
This commands 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.
SYNTAX
beectl modify_trusted_identity [--type WSSEC --service_name <service name> [--new_service_name <new service name>] [--new_key_alias <new key alias>]] [--type SES --name <Trusted Entity Name> --new_name <New Trusted Entity Name> --new_password <New Trusted Entity Password>]
OPTIONS
--service_name
String value of the service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
--new_service_name
String value of the new service principal name with which it will be identified in Beehive. This option is mandatory if type is WSSEC.
--new_key_alias
The new alias of the service which is used to register the certificate in the wallet. This option is mandatory if type is WSSEC.
--type
String value indicating the type of trusted identity: SES or WSSEC.SES refers to Secure Enterprise Search. WSSEC refers to Web services security.
--name
String value representing the name of the SES trusted entity.
--new_name
String value representing the new name of the SES trusted entity.
--new_password
String value representing the new password of the SES trusted entity.
EXAMPLES
The modify_user command modifies existing users.
SYNTAX
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 <time zone 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(certificate|notes)=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(locked|enabled|disabled)> ] [ --external_inbox <true|false> ] [ --delegate <[+][delegated_principal_name]:identifier_of_delegator or -delegated_principal_identifier> ] [ --lock <principal to be locked(PRIMARY|PROTOCOL|VOICE|ALL)> ] [ --unlock <principal to be unlocked(PRIMARY|PROTOCOL|VOICE|ALL)> ]
OPTIONS
--user
Identifier of the user.
Email id of the user
--family_name
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
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
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. + 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
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
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
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
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
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.
--scope
Identifier of the enterprise or organization under which this user will be created.
--office_location
Office location of the user. To remove the previously defined value pass either of the following strings: NULL or null.
--company
Company of the user. To remove the previously defined value pass either of the following strings: NULL or null.
--profession
Profession of the user. To remove the previously defined value pass either of the following strings: NULL or null.
--timezone
Time zone of the user. list_timezones lists the valid time zones
--locale
Locale details of the user. Example of locales are en, en_US, en_CA, zh_CN, fr_FR, ja_JP, etc.
--department
Department of the user. To remove the previously defined value pass either of the following strings: NULL or null.
--assistant
Identifier of the assistant.
--manager
Identifier of the manager.
--organization
Identifiers of the organizations the user must be part of.
--remove_organization
Identifiers of the organizations the user must be removed from.
--property
Details of the property in the format [+/-]name=value=description. Supported names are certificate, 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
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. 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.
--default_address_for_type
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--default_address_for_scheme
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. 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
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. Supported types are BUSINESS_1 to BUSINESS_5, PERSONAL_1 to PERSONAL_5, OTHER_1 to OTHER_5, PROXY_1 to PROXY_25.
--login_id
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
Login password.
--voice_principal
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.
--voice_pin
Pin number for the voice device.
--protocol_principal
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
Protocol password.
--status
Sets the provisioning status of the user. Supported values are ENABLED, DISABLED, LOCKED.
--external_inbox
Boolean values which indicates if user's inbox is external or not. Supported values are TRUE, FALSE.
--delegate
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.
--lock
Locks the principal specified. Valid values are PRIMARY, PROTOCOL, VOICE, ALL. ALL will lock all the principals of the user.
--unlock
Unlocks the principal specified. Valid values are PRIMARY, PROTOCOL, VOICE, ALL. ALL will unlock all the principals of the user.
EXAMPLES
beectl modify_user --user loginid=user1 --given_name User1GivenName --family_name -en_CA:User1FamilyName --office_location 4A037
beectl modify_user --email user1@example.com --property +is_external_user=true
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 loginid=user1 --voice_principal 1234567 --voice_pin 123423 --protocol_principal ESCAPE:-protocolPrincipal
beectl modify_user --user loginid=user1 --lock PROTOCOL
beectl modify_user --user loginid=user1 --unlock PRIMARY
beectl modify_user --user loginid=user1 --unlock ALL
beectl modify_user --user loginid=user1 --nick_name +en:User1NickName --assistant loginid=user3 --manager loginid=user2
beectl modify_user --email user1@example.com --status disabled
beectl modify_user --user loginid=user1 --delegate DelegatedPrincipalName:loginid=user2
beectl modify_user --user loginid=user1 --delegate ESCAPE:-pcpd=CalendarDelegation2,loginid=rafiul2
Enables or disables an existing subscription
SYNTAX
beectl modify_user_subscription --enable {true|false} --subscription <Subscription identifier>
OPTIONS
--enable
Enable or disable the subscription. Permitted values are 'true' (enable subscription) or 'false' (disable subscription)
--subscription
Specify the identifier of the subscription.
EXAMPLES
beectl modify_user_subscription --enable true --subscription 5457:7954:subs:337F34E37E8E81F1E040578C921630B700000000B864
Updates a given version configuration.
SYNTAX
beectl modify_version_configuration --configuration <Configuration identifier> --file <Full path of the configuration XML file>
OPTIONS
--configuration
Version configuration to be updated.
--file
Full path of the version configuration XML file. The file must contain properly formatted data.
EXAMPLES
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.
SYNTAX
beectl modify_virus_scan_policy [ --scanpolicy <virusscanpolicy> ]
OPTIONS
--scanpolicy
Virus scan policy. Default is NO_SCAN_OR_REPAIR.
EXAMPLES
beectl modify_virus_scan_policy --scanpolicy SCAN_AND_REPAIR
Modifies an existing workspace template
SYNTAX
beectl modify_workspace_template --template <Workspace template identifier> [--file <Full path of the template file>] [--name <Workspace template name>]
OPTIONS
--template
Workspace template identifier
--file
Full path of the template file
--name
Workspace template name
EXAMPLES
beectl modify_workspace_template --template 9941:2345:twtt:58D193D162CE4ED89FF66AB4E55745B6345464545453 --file /tmp/template.xml
beectl modify_workspace_template --template 9941:2345:twtt:58D193D162CE4ED89FF66AB4E55745B6345464545453 --name New_Name --file /tmp/template.xml
Obfuscates the prompted string.
SYNTAX
beectl obfuscate [--expiration_time_in_minutes 30]
OPTIONS
--expiration_time_in_minutes
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.
EXAMPLES
beectl obfuscate
(Prompted)Enter the password : [User types in the password which is not echoed on the standard output].
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.
SYNTAX
beectl restart [ --component <component id> | --all | --serially]
OPTIONS
--component
Identifier of component to restart. To restart more than one component at a time, specify this option multiple times.
--all
restart all managed components.
--serially
It specified, restarts all the components one by one.
EXAMPLES
beectl restart --all
beectl restart --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f
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.
SYNTAX
beectl start [ --component <component id> | --all | --serially]
OPTIONS
--component
Identifier of component to start. To start more than one component at a time, specify this option multiple times.
--all
start all managed components.
--serially
It specified, starts all the components one by one.
EXAMPLES
beectl start --all
beectl start --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f
Displays the status of all managed components.
SYNTAX
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] ]
OPTIONS
--dashboard
A dashboard view of all the specified components is shown.
--detail
A detailed view of all the specified components is shown.
--all_home_instances
Status of all Beehive instances is shown.
--all_services
Status of all Services is shown.
--component
Status of the specified components is shown.
--all_disabled_components
Lists all the disabled components in the system is shown.
--disabled_beehive_instances
Lists all the disabled beehive instances in the system is shown.
--disabled_oc4js
Lists all the disabled managed oc4js in the system is shown.
--disabled_service_instances
Lists all the disabled service instances in the system is shown.
--disabled_services
Lists all the disabled services in the system is shown.
EXAMPLES
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.
SYNTAX
beectl stop [ --component <component id> | --all | --serially]
OPTIONS
--component
Identifier of component to stop. To stop more than one component at a time, specify this option multiple times.
--all
stop all managed components.
--serially
It specified, stops all the components one by one.
EXAMPLES
beectl stop --all
beectl stop --component 5792bd5f-3b46-42de-a15d-8fe4b86fd46f
Upload a prompt to the database.
SYNTAX
beectl upload_attendant_prompt --name <name of attendant> --type <type of prompt> [--language <language of prompt>] --file <prompt file>
OPTIONS
--name
Name of the attendant.
--type
Type of the prompt. Can be one of language, menu, greeting, option1, option2, option3, option4, option4, option5, option6, option7, option8, option9, noinput, noinput-term, nomatch, nomatch-term.
--language
Language of the prompt.
--file
Path to the prompt file.
EXAMPLES
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. If the community option is specified, the uploaded client application patchset will also be provisioned to the community.
SYNTAX
beectl upload_client_application { --file <path to the client binary> | --dir <full path to the directory containing the client binaries>} [[--community <Identifier of a community>]...]
OPTIONS
--file
Specify the full path and file name of the client ZIP file.
--dir
Specify the full path of the directory containing the client ZIP files.
--community
Specify the identifier of the community to be provisioned with this uploaded patchset.
EXAMPLES
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/
beectl upload_client_application --file $BH/beehive/seed/dm/pushmail_debug.PPC5.0_ARM.element.zip --community 1234:5678:entr:2E0329B0705F0E40E040578C92160957000000000434
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.
SYNTAX
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>}
OPTIONS
--file
Specify the full path and file name of the device profiles XML file.
--dir
Specify the full path of the directory containing the device profiles XML files.
EXAMPLES
beectl upload_device_profiles --file /tmp/device-profiles.xml
beectl upload_device_profiles --dir /tmp/device-profiles/
Loads language pack resources into the system.
SYNTAX
beectl upload_language_pack --source <source> [--ignore_version] [--suppress_warning] [--accept_builtin]
OPTIONS
--source
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
Ignore version information in the xliff files; use with caution.
--suppress_warning
Suppress warnings about potential xliff problems; only report fatal errors.
--accept_builtin
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 behavior has been designed to guard against accidentally uploading built-in xliff files or helpsets.
EXAMPLES
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 an existing audit trail
SYNTAX
beectl validate_audit_trail --trail <Audit trail identifier> [--count <Maximum number of audit records to print>]
OPTIONS
--trail
Audit trail identifier
--count
Maximum number of audit records to print
EXAMPLES
beectl validate_audit_trail --trail autr=MyAuditTrail
Validates the configuration for given component id or for the whole system model tree.
SYNTAX
beectl validate_configuration [ --id <system object id or alias of system object>]
OPTIONS
--id
component id.
EXAMPLES
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.
Validates 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.
SYNTAX
beectl validate_directory_entry ([ --email <user_email>] | [ --identifier <user_bodn> ] | [ --dn <user_dn> ]) --profile <Profile_name> [--commit] [--verbose]
OPTIONS
--identifier
Identifier of the user, group or external-person in beehive
Email-ID of the user, group or external-person.
--dn
DN (distinguished name) of the user, group or external-person in ldap directory
--commit
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.
--verbose
This option is used display the detailed information.
--profile
Name of the profile
EXAMPLES
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 loginid=user3@example.com --profile exampleProfile --verbose
beectl validate_directory_entry --identifier loginid=user3@example.com --profile exampleProfile
Tests the connectivity to the virus scan engine running at the specified host and port.
SYNTAX
beectl validate_virus_scan_engine_connectivity [ --hostname <scanengine_hostname> ] [ --port <scanengine_port> ]
OPTIONS
--hostname
Name of the host where the virus scan engine is installed. Default is localhost.
--port
Port number used by the virus scan engine for communication with its clients. Default is 1344.
EXAMPLES
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
artifacts
audit
authn
beectl
beehivemail
bio
btimon
cms
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
search
smpp
tms
uds
uss
version
virusscanner
voice
voip
webdav
workflow
workspaces
xbom
xmpp
xms
List of vaild 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.
SYNTAX
beectl version [--all | [[--product <Product Name>] ...]] [[--field <Field Name>]...]
OPTIONS
--all
Shows version information for all products.
--product
Shows version information for the specified products. This option is multi-valued.
--field
Shows the value of the specified fields. This option is multi-valued.
EXAMPLES
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 uds product.