This chapter provides a complete listing of all EM CLI verbs in categorical as well as alphabetical order. Each verb provides complete syntax and usage information.
This section lists all of the verbs for this release in the following categories:
Note: Only these verbs are available immediately after installation.
Configuration/Assocation History
Credential Verbs - Oracle Database
Database Machine Targets Customer Support Identifier (CSI) Assignment Verbs
Discover and Push to Agents Verbs
Fusion Middleware Provisioning Verbs
Java EE Application Component Verbs
Metric Collection and Alerts Verbs
Oracle Database as Service (DBaaS) Verbs
Package Fusion Application Problem Verbs
Platform as a Service (PaaS) Verbs
Privilege Delegation Settings Verbs
Server-generated Alert Metric Verbs
User-defined Metrics (UDM) Migration Verbs
User Session Administration Verbs
This option enables you to provide an argument to be specified in a file. For example:
emcli xyzverb -input_file="arg1:file1.txt" -input_file="arg2:file2.txt"
This string literally translates to:
emcli xyzverb -arg1=<contents of file1.txt> -arg2=<contents of file2.txt>
emcli xyzverb -input_file="name:/tmp/b1.txt" -input_file="type:/tmp/b2.txt" -input_file="bcnName:/tmp/b3.txt"
This example makes User1 an Enterprise Manager user, which is already created on an external user store like the SSO server. The contents of priv_file are
view_target;host1.example.com:host. User1 will have view privileges on the host1.example.com:host target.
emcli create_user
-name="User1"
-type="EXTERNAL_USER"
-input_file="privilege:/home/user1/priv_file"
For most job verbs, you can specify all of the needed properties in a property file. You can also provide a few properties on the command line. Properties set on the command line override values set in the file.
The property file consists of name=value pairs. For example, put the following into myFile.txt:
name=MY JOB 1
type=OSCommand
description=this is a test job
target_list=target1:host
variable.default_shell_command=ls -l
schedule.frequency=IMMEDIATE
... then run:
emcli create_job -input_file=property_file:myFile.txt
This creates an OS Command job called "MY JOB 1" using preferred credentials.
For the create verbs, all properties set in the file are used. For verbs that act on multiple jobs, like suspend and resume, only "search" properties are used (name, type, targets. and scheduled starting and ending times).
The best way to create a property file is to start by describing a job similar to the one you want to create, and/or by describing a job type. This provides a list of which properties are needed by a given job type.
Determining Variables for a Job
Most properties are the same from one job to another. For example:
name, type, description, kind, targetType, cred, schedule notification
The variables needed for a job type change from job to job. Describe a job type to find out which variables it requires.
For example, the following command creates a property file template based on job MYJOB1. This lists the properties set by this job.
emcli describe_job [-verbose] -name=MyJob1 > myPropFile.txt
This example creates a property file template for an OS Command job. This lists the properties allowed by this job type, including all required and optional variables. Variables marked as deprecated should be avoided.
emcli describe_job_type [-verbose] -type=OSCommand > myPropFile.txt
Not all verbs allow separator and subseparator to be overridden. The semi-colon ( ; ) and colon ( : ) are respectively the default separator and subseparator. The separator is used for arguments that take multiple values, and subseparator is used when the value itself has multiple values. You can override either one of them or both.
The syntax is:
separator=<option_for_which_separator_has_to_be_applied>="separator_value"
As an example of using the separator and subseperator to create a group containing database2 and database3, the command could be:
emcli create_group -name="tstgrp" -add_targets="database2:oracle_database; database3:oracle_database"
Using this command as the basis for modification, these examples show overrides of separator and/or subseperator:
emcli create_group -name="tstgrp1" -add_targets="database2:oracle_database, database3:oracle_database" -separator=add_targets="," emcli create_group -name="tstgrp2" -add_targets="database2&oracle_database, database3&oracle_database" -separator=add_targets="," -subseparator=add_targets="&" emcli create_group -name="tstgrp3" -add_targets="database2&oracle_database; database3&oracle_database" -subseparator=add_targets="&"
The following sections provide descriptions, formats, and options for all EM CLI verbs. Some of the verbs also contain one or more examples.
Aborts the migration of user-defined metrics (UDMs) to metric extensions in a session.
emcli abort_udmmig_session
-session_id=<sessionId>
[-input_file=specific_tasks:<complete_path_to_file>]
[ ] indicates that the parameter is optional
session_id
Specify the ID that was returned when the session was created, or from the output of udmmig_summary.
input_file
Points at a file name that contains a target UDM, one per line in the following format:
<targetType>,<targetName>,<collection name>
Use targetType=Template to indicate a template. Use * for the collection name to abort all UDMs for a target. The input file should be in UTF-8 format.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
This example aborts the specified migration session. The UDM is returned to the unconverted list.
emcli abort_udmmig_session -session_id=<sessionId>
This example partially aborts the migration session by removing the specified UDMs from the session.
emcli abort_udmmig_session -session_id=<sessionId> -input_file=specific_tasks:<complete file path>
Adds a beacon to the monitoring set of beacons. All enabled tests are pushed to the beacon.
emcli add_beacon
-name=target_name
-type=target_type
-bcnName=beacon_name
[-dontSetKey]
[ ] indicates that the parameter is optional
name
Service target name.
type
Service target type.
bcnName
Beacon name to add.
dontSetKey
Indicates the added beacon is not automatically a key beacon. Only use this option if you do not want the beacon to participate in the availability calculation of the service and tests.
Adds the given entity to Chargeback.
entity_name
Name of the entity to be added to Chargeback.
entity_type
Type of entity to be added to Chargeback.
usage_mode
Usage mode by which it should be added to Chargeback. You can see the usage modes for a particular entity type by entering list_chargeback_entity_types -entity_type .
Adds forwarders for a given PaaS agent.
emcli add_forwarders_for_paas_agent
-paas_agent_name="paas_agent_name"
-agent_list="agent_list"
paas_agent_name
Agent name of the hybrid agent.
agent_list
Forwarder agent list separated by a space.
Associates new auxiliary hosts with the system. An auxiliary host can be any host that is not part of the system but is managed by Enterprise Manager Cloud Control. These hosts can be used to execute any script. Any other targets running on this host will not be part of Site Guard operation plan(s).
emcli add_siteguard_aux_hosts
-system_name="name_of_the_system"
-host_name="name_of_the_auxiliary_host"
[ ] indicates that the parameter is optional
system_name
Name of the system.
host_name
Name of the auxiliary host that the current user needs to add. This host must be managed by Enterprise Manager Cloud Control.
This example adds the auxiliary host host1.domain.com to austin-system:
emcli add_siteguard_aux_hosts
-system_name="austin-system"
-host_name="host1.domain.com"
This example adds auxiliary hosts host1.domain.com and host2.domain.com to the system austin-system:
emcli add_siteguard_aux_hosts
-system_name="austin-system"
-host_name="host1.domain.com"
-host_name="host2.domain.com"
This example associates auxiliary hosts host1.domain.com and host2.domain.com that are part of austin-system to the system:
emcli add_siteguard_aux_hosts
-system_name="austin-system"
-host_name="host1.domain.com;host2.domain.com"
Adds a named credential as a parameter for a Site Guard script. The values of user name and password of this credential can be accessed within the script.
See Also: emcli delete_siteguard_script_credential_params, emcli get_siteguard_script_credential_params
emcli add_siteguard_script_credential_params -script_id="Id associated with the script" -credential_name="name of the credential" [-credential_owner="credential owner"] [ ] indicates that the parameter is optional.
script_id
The script ID.
credential_name
The name of the credential.
credential_owner
The owner of the credential. This parameter does not need to be specified if the owner of the credential is same as the logged in user.
The following command adds a script ID and credential name to the siteguard script.
emcli add_siteguard_script_credential_params
-script_id="1"
-credential_name="NAMED_CREDENTIAL_X"
The following command adds a script ID and credential name to the siteguard script where the credential owner is SG_ADMIN.
emcli add_siteguard_script_credential_params
-script_id="2"
-credential_name="NAMED_CREDENTIAL_Y"
-credential_owner="SG_ADMIN"
Adds a host to the Site Guard configuration scripts.
script_id
ID associated with the script.
host_name
Name of the host where this script will be run. You can specify more than one host name.
Adds a storage location in the software library.
emcli add_swlib_storage_location
-name="location_name"
-path="location_path"
[-type="OmsShared|OmsAgent|Http|Nfs|ExtAgent"]
[-host="hostname"]
[-credential_set_name="setname"] | [-credential_name="name" - credential_
owner="owner"]
[ ] indicates that the parameter is optional
name
Name of the storage location.
path
Path of the storage location, which can be a file system path or a URL, depending on the storage type chosen.
type
Type of storage location. The default is OmsShared.
host
Target name of the host where the path for the storage location exists. This parameter is required for storage types OmsAgent, Nfs, and ExtAgent. For the Nfs storage type, the host is not required to be a target in Enterprise Manager.
credential_set_name
Set name of the preferred credential stored in the repository for the host target. This is a required parameter for storage types OmsAgent and ExtAgent. The set names can be one of the following:
HostCredsNormal: Default unprivileged credential set
HostCredsPriv: Privileged credential set
credential_name
Name of a named credential stored in the repository. This parameter is required for storage types OmsAgent and ExtAgent. This parameter must be specified together with the credential_owner parameter.
credential_owner
Owner of a named credential stored in the repository. This parameter is required for storage types OmsAgent and ExtAgent. This parameter must be specified together with the credential_name parameter.
This example adds an OMS shared file system storage location named myOMSSharedLocation for the path /u01/swlib .
emcli add_swlib_storage_location
-name="myOMSSharedLocation"
-path="/u01/swlib"
This example adds an OMS Agent File system storage location named myOMSAgtLocation for the path /u01/swlib' on host 'fs1.us.acme.com. The named credential MyAcmeCreds owned by ACME_USER is used for reading/writing files from this location.
emcli add_swlib_storage_location
-name="myOMSAgtLocation"
-path="/u01/swlib"
-type="OmsAgent"
-host="fs1.us.acme.com"
-credential_name="MyAcmeCreds"
-credential_owner="ACME_USER"
Deletes an auxiliary host associated with the system.
emcli delete_siteguard_aux_host
-system_name="name_of_the_system"
[-host_name="name_of_the_auxiliary_host"]
[ ] indicates that the parameter is optional
system_name
Name of the system whose auxiliary host you want to delete.
host_name
Name of the auxiliary host that you want to delete. If not specified, all auxiliary hosts associated with the system will be deleted.
This example deletes all of the auxiliary hosts associated with austin-system:
emcli delete_siteguard_aux_host
-system_name="austin-system"
This example deletes the auxiliary host host1.domain.com associated with austin-system:
emcli delete_siteguard_aux_host
-system_name="austin-system"
-host_name="host1.domain.com"
This example deletes the auxiliary host host2.domain.com associated with austin-system:
emcli delete_siteguard_aux_host
-system_name="austin-system"
-host_name="host2.domain.com"
Adds a target to be monitored by Enterprise Manager. The target type specified is checked on the Management Agent for existence and for required properties, such as user name and password for host target types, or log-in credentials for database target types. You must specify any required properties of a target type when adding a new target of this type.
For oracle_database target types, you must specify Role with the monitoring credentials. If the Role is Normal, the UserName must be dbsnmp. Otherwise, the Role must be SYSDBA, and UserName can be any user with SYSDBA privileges.
Note:
You cannot use this verb for composite targets. The verb does not support adding an association between a parent target such as IAS and a child target such as OC4J.
emcli add_target
-name="name"
-type="type"
-host="hostname"
[-properties="pname1:pval1;pname2:pval2;..."]
[-separator=properties="sep_string"]
[-subseparator=properties="subsep_string"]
[-credentials="userpropname:username;pwdpropname:password;..."]
[-input_file="parameter_tag:file_path"]
[-display_name="display_name"]
[-groups="groupname1:grouptype1;groupname2:grouptype2;..."]
[-timezone_region="gmt_offset"]
[-monitor_mode="monitor_mode"]
[-instances="rac_database_instance_target_name1:target_type1;..."]
[-force=true|false]
[-timeout="time_in_seconds"]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
add_target
(name="name"
,type="type"
,host="hostname"
[,properties="pname1:pval1;pname2:pval2;..."]
[,separator=properties="sep_string"]
[,subseparator=properties="subsep_string"]
[,credentials="userpropname:username;pwdpropname:password;..."]
[,input_file="parameter_tag:file_path"]
[,display_name="display_name"]
[,groups="groupname1:grouptype1;groupname2:grouptype2;..."]
[,timezone_region="gmt_offset"]
[,monitor_mode="monitor_mode"]
[,instances="rac_database_instance_target_name1:target_type1;..."]
[,force=true|false]
[,timeout="time_in_seconds"])
[ ] indicates that the parameter is optional
name
Target name. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks.
type
Target type. Standard target types include: host, oracle_database, oracle_apache, oracle_listener, and oracle_emd. To see all available target types available for your environment, check the
$AGENT_HOME/sysman/admin/metadata
host
Network name of the system running the Management Agent that is collecting data for this target instance.
properties
Name-value pair (that is, prop_name:prop_value) list of properties for the target instance. The "name"(s) are identified in the target-type metadata definition. They must appear exactly as they are defined in this file. Metadata files are located in $AGENT_HOME/sysman/admin/metadata.
Note:
This verb does not support setting global target properties. It is recommended that you use set_target_property_values to set target properties.separator=properties
Specify a string delimiter to use between name-value pairs for the value of the -properties . The default separator delimiter is ";".
For more information about the separator parameter, see Section 5.2, "-input_file Syntax Guidelines".
subseparator=properties
Specifies a string delimiter to use between the name and value in each name-value pair for the value of the -properties option. The default subseparator delimiter is ":".
For more information about the subsepator parameter, see Section 5.2, "-input_file Syntax Guidelines".
credentials
Monitoring credentials (name-value pairs) for the target instance. The "name"(s) are identified in the target-type metadata definition as credential properties. The credentials must be specified exactly as they are defined in the target's metadata file. Metadata files are located in $AGENT_HOME/sysman/admin/metadata.
input_file
Used in conjunction with the -credentials option, this enables you to store specific target monitoring credential values, such as passwords, in a separate file. The -input_file specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific monitoring credentials of the -credentials option. The tag must not contain colons ( : ) or semi-colons ( ; ).
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
display_name
Target name displayed in the Enterprise Manager Cloud Control console.
groups
Name-value pair list of the groups to which this target instance belongs. Follows the format of groupname:grouptype;groupname2:grouptype2.
timezone_region
GMT offset for this target instance. (-7 or -04:00 are acceptable formats.)
monitor_mode
Either 0, 1, or 2. The default is 0. 1 specifies OMS mediated monitoring, and 2 specifies Agent mediated monitoring.
instances
Name-value pair list of RAC database instances that the RAC database target has. Database instance targets must be added before trying to add the cluster database.
force
Forces the target to be added even if the target with the same name exists. Updates the properties of the target with your latest input.
timeout
Time in seconds for the command to wait to add the target to the Agent. The default is 10 minutes.
The following two examples add an oracle_database target with the name "database." Note how the credentials are specified. The "name"(s) in the name-value pairs come from the oracle_database metadata file. They must appear exactly as they are named in that file. This also applies for the property "name"(s). The examples use the base minimum of required credentials and properties for the database target.
emcli add_target
-name="database"
-type="oracle_database"
-host="myhost.us.example.com"
-credentials="UserName:dbsnmp;password:dbsnmp;Role:Normal"
-properties="SID:semcli;Port:15091;OracleHome:/oracle;
MachineName:smpamp-example.com"
-groups="Group1:group;Group2:group"
Example 2 - Scripting and Interactive
add_target
(name="database"
,type="oracle_database"
,host="myhost.us.example.com"
,credentials="UserName:dbsnmp;password:dbsnmp;Role:Normal"
,properties="SID:semcli;Port:15091;OracleHome:/oracle;
MachineName:smpamp-example.com"
,groups="Group1:group;Group2:group")
The following two examples add an oracle_database target with the name "database." The examples illustrate the use of the input_file to camouflage the credentials. The password is actually in a file named at_pwd_file. The input_file argument is used to replace PWD_FILE with the contents of the at_pwd_file in the credentials argument.
emcli add_target
-name="database"
-type="oracle_database"
-host="myhost.us.example.com"
-credentials="UserName:dbsnmp;password:PWD_FILE;Role:Normal"
-properties="SID:semcli;Port:15091;OracleHome:/oracle;
MachineName:smpamp-example.com"
-input_file="PWD_FILE:/emcli_dir/pwdfiles/at_pwd_file"
Example 4 - Scripting and Interactive
add_target
(name="database"
,type="oracle_database"
,host="myhost.us.example.com"
,credentials="UserName:dbsnmp;password:PWD_FILE;Role:Normal"
,properties="SID:semcli;Port:15091;OracleHome:/oracle;
MachineName:smpamp-example.com"
,input_file="PWD_FILE:/emcli_dir/pwdfiles/at_pwd_file")
The following two examples illustrate how to add a RAC database with given installed RAC database instances and clusterware. The examples add a rac_database target with the name cluster_database and the cluster name newdb_cluster. A RAC instance is picked up among instances on the given host. This verb should be called after database instances and clusterwares have been installed. monitor_mode is set to 1, because a RAC database is a multi-agent target.
emcli add_target
-name="cluster_database"
-type="rac_database"
-host="myhost.us.example.com"
-monitor_mode="1"
-properties="ServiceName:service.example.com;ClusterName:
newdb_cluster"
-instances="database_inst1:oracle_database;database_inst2:
oracle_database"
Example 5 - Scripting and Interactive
emcli add_target
(name="cluster_database"
,type="rac_database"
,host="myhost.us.example.com"
,monitor_mode="1"
,properties="ServiceName:service.example.com;ClusterName:
newdb_cluster"
,instances="database_inst1:oracle_database;database_inst2:
oracle_database")
The following two examples add an oracle_listener target with the name mylist. The LsnrName is the name of the listener as configured in the listener.ora file, and ListenerOraDir is the directory containing the listener.ora file.
emcli add_target
-name="mylist"
-type="oracle_listener"
-host="myhost.example.com"
-properties="LsnrName:LISTENER;ListenerOraDir:/oracle/lsnr;
Port:15091;OracleHome:/oracle;Machine:smpamp-sun1.us
Example 7 - Scripting and Interactive
add_target
(name="mylist"
,type="oracle_listener"
,host="myhost.example.com"
,properties="LsnrName:LISTENER;ListenerOraDir:/oracle/lsnr;
Port:15091;OracleHome:/oracle;Machine:smpamp-sun1.us)
Adds a new target property for a given target type. All targets of this target type will have this new target property.
target_type
Target type for which this property needs to be added. To add this property to all existing target types, you can specify a "*" wildcard character.
property
Name of the property to be created for this target type. Property names are case-sensitive. The property name cannot be the same as the following Oracle-provided target property names (in English):
Comment, Deployment Type, Line of Business, Location, Contact
This example adds the Owner Name property for all targets of type
oracle_database.
emcli add_target_property -target_type="oracle_database" -property="Owner Name"
This example adds the Owner property for all target types.
emcli add_target_property -target_type="*" -property="Owner"
Adds a target to an enterprise rule set.
Privilege Requirements: A Super Administrator can add a target to any enterprise rule set except for predefined (out-of-box) rule sets supplied by Oracle.Only the owner or co-author of a rule set can add a target to it.
emcli add_target_to_rule_set
-rule_set_name="rule set name"
-target_name="target name"
-target_type="internal name for the target type. For example, host"
[-rule_set_owner=<ruleset owner>]
[ ] indicates that the parameter is optional
rule_set_name
Name of an enterprise rule set. This option only applies to rule sets that are associated with a list of targets.
target_name
Name of the target to be added.
target_type
Target type of the target to be added. For example, host.
rule_set_owner
Optionally, you can specify the owner of the rule set.
Adds Oracle Virtual Platform(s) to remotely monitor Xen-based Hypervisor(s). The associated Oracle Server and Oracle Virtual Server running on the Hypervisor will is also added.
You can add multiple Hypervisors at the same time. The command returns the name and the execution identifier of the job submitted to add the target(s).
To delete an Oracle Virtual Platform and its related targets, use the delete_target verb.
emcli add_virtual_platform
-name="host_name/IP_address_or_list_from_an_input_file"
-agent="agent_target_name"
[-failover_agent="failover_agent_target_name"]
-credentials="property_name1:property_value1;property_name2:
property_value2;..."
[-wait_for_completion=true|false]
[-wait_for_completion_timeout=<time_in_minutes>]
[-separator=credentials="separator_for_key_value_pairs"]
[-subseparator=credentials="separator_for_key_value_pair"]
[-input_file="FILE:file_path_or_name:FILE"]
[ ] indicates that the parameter is optional
name
IP address or host name of the Xen-based Hypervisor being added as an Oracle Virtual Platform in Enterprise Manager. There are two ways to provide this value. For only one target, you can directly pass this value at the command line with the name of the Host or the IP address. For multiple values, you can use the "-input_file" parameter and list the host names, IP addresses, or an IP address range from a file by passing the name of the input file. A new line is used to delimit the host names or the IP addresses. You can specify the host name of a machine, an IP address, or an IP address range on each line.
See the examples for details.
agent
Target name of the primary agent used to monitor the Oracle Virtual Platform(s) and related targets.
failover_agent
Target name of the failover agent used to monitor the Oracle Virtual Platform(s) and related targets.
credentials
Monitoring credentials (name-value pairs) for the target instance. The "names" are defined in the target type metadata definition as credential properties. Metadata files are located at $AGENT_HOME/sysman/admin/metadata.
See the examples for details on various options.
wait_for_completion
Flag to indicate if the CLI is going to wait for the submitted job to finish. The default value is false. If the value is true, the progress of the job is printed on the command line as and when the addition of Oracle Virtual Platform(s) Succeeds/Fails.
wait_for_completion_timeout
Time in minutes after which CLI stops waiting for the job to finish. This parameter is honored only if the value for parameter wait_for_completion is true. A negative or zero value does not wait for the job to finish.
See the examples for details.
separator=credentials
Custom separator for the credential key value pairs. Specify a string delimiter to use between name-value pairs for the values of the -credentials option. The default separator delimiter is ";".
For more information about the separator parameter, see Section 5.2, "-input_file Syntax Guidelines".
subseparator=credentials
Custom separator for a key value pair. Specify a string delimiter to use between name and value in each name-value pair for the values of the -credentials option. The default separator delimiter is ":".
For more information about the subseparator parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file
Optionally use in conjunction with the -credentials option. You can use this option to set specific target monitoring credential values, such as passwords or SSH keys, in a separate file.
This option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific -credentials property values.
This example adds an Oracle Virtual Platform with root user host credentials. The value of the property "OVSUsername" is used for the user name, and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are collected(true) or not(false) when monitoring. The password is passed at the command line.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsBasicCreds;PrivilegeType:none;privilegedUser:true;
OVSUsername:root;OVSPassword:mypassword'
This example adds an Oracle Virtual Platform with root user host credentials. The value of the property "OVSUsername" is used for the user name, and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are not collected(true) or not(false) when monitoring. The password of the root user is read from the input file "password.txt".
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsBasicCreds;PrivilegeType:none;privilegedUser:true;
OVSUsername:root;OVSPassword:PWD_FILE'
-input_file='PWD_FILE:password.txt'
This example adds multiple Oracle virtual platforms with root user host credentials. You can specify multiple host names, IP addresses, or an IP address range in the host names list file delimited by a new line.
NOTE: In case of multiple target additions, the same credentials are used across all Hypervisors being added.
Host names list file example:
example1.com 192.168.1.0 10.172.10.2-254
emcli add_virtual_platform
-input_file='name:hostnames.txt'
-agent=example.com:1838
-credentials='type:DMOvsBasicCreds;PrivilegeType:none;privilegedUser:true;
OVSUsername:root;OVSPassword:mypassword'
This example adds an Oracle Virtual Platform with Unix Sudo user host credentials. The value of the property "PrivilegeCommand" is used to execute the Sudo command. %RUN_AS% and %COMMAND% are replaced with the user and the command to be executed by the Sudo command. The value of the property "EnablePseudoTerminal" indicates if Sudo requires (true) a tty terminal or not (false). The password is passed at the command line.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsBasicCreds;PrivilegeType:sudo;privilegedUser:true;
RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS%%COMMAND%;
EnablePseudoTerminal:false;OVSUsername:root;OVSPassword:mypassword'
This example adds an Oracle Virtual Platform with Unix PowerBroker user host credentials. The value of the property "PrivilegeCommand" is used to execute the PowerBroker command. %RUN_AS% and %COMMAND% are replaced by you and the command to be executed by PowerBroker. The value of the property "PowerBrokerProfile" is used as the PowerBroker profile. The value of the property "PowerBrokerPasswordPrompt" is used as the PowerBroker password prompt. The password is passed at the command line.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsBasicCreds;PrivilegeType:powerbroker;RunAs:root;
PrivilegeCommand:/usr/bin/pbrun -l -u %RUN_AS%
%COMMAND%;PowerBrokerProfile:profile;
PowerBrokerPasswordPrompt:myprompt;
privilegedUser:true;OVSUsername:root;OVSPassword:mypassword'
This example adds an Oracle Virtual Platform with a Unix Sudo user who requires SSH key Passphraseless-based authentication. The SSH private key, SSH public key, and password are read from input files.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsSshKeyCreds;PrivilegeType:sudo;privilegedUser:true;
RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
EnablePseudoTerminal:false;SshPrivateKey:PRIVATE_KEY;
SshPublicKey:PUBLIC_KEY;OVSUsername:sudoer1;OVSPassword:PWD_FILE'
-input_file='PRIVATE_KEY:id_dsa'
-input_file='PUBLIC_KEY:id_dsa.pub'
-input_file='PWD_FILE:password'
This example adds an Oracle Virtual Platform with a Unix Sudo user who requires SSH key Passphrase-based authentication. The SSH private key, SSH public key, and password are read from input files.
emcli add_virtual_platform
-name=example.com -agent=example.com:1838
-credentials='type:DMOvsSshKeyCreds;PrivilegeType:sudo;privilegedUser:true;
RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
EnablePseudoTerminal:false;PassPhrase:welcome1;
SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;OVSUsername:sudoer1;
OVSPassword:PWD_FILE'
-input_file='PRIVATE_KEY:id_dsa'
-input_file='PUBLIC_KEY:id_dsa.pub'
-input_file='PWD_FILE:password'
This example adds an Oracle Virtual Platform with a Unix PowerBroker user who requires SSH key Passphraseless based authentication. The SSH private key, SSH public key, and password are read from input files.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsSshKeyCreds;PrivilegeType:powerbroker;
privilegedUser:true;RunAs:root;PrivilegeCommand:
/usr/bin/pbrun -l -u %RUN_AS% %COMMAND%;
PowerBrokerProfile:profile;PowerBrokerPasswordPrompt:myprompt;
SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;
OVSUsername:myuser;OVSPassword:PWD_FILE'
-input_file='PRIVATE_KEY:id_dsa'
-input_file='PUBLIC_KEY:id_dsa.pub'
-input_file='PWD_FILE:password'
This example adds an Oracle Virtual Platform with non-privileged user host credentials. The virtualization metrics for the added target will not be monitored. The password is specified at the prompt.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsBasicCreds;privilegedUser:false;
OVSUsername:simpleton;OVSPassword:password'
Analyzes UDMs and lists unique UDMs, any possible matches, and templates that can apply these matching metric extensions.
emcli analyze_unconverted_udms
[-session_id=<sessionId>]
[ ] indicates that the parameter is optional
session_id
ID of a session to be analyzed. Not specifying a session ID creates an analysis session that contains all unconverted UDMs. You can specify this session ID in future invocations to generate a fresh analysis.
Applies a diagnostic check exclusion to a set of target instances. You can exclude certain diagnostic checks by defining an exclusion name. This rule is applied when all diagnostic checks are evaluated for the particular target type so that the checks specified in the rule are excluded.
emcli apply_diagcheck_exclude
-target_type="type"
-exclude_name="name"
[-target_name="target_name" ]*
[ ] indicates that the parameter is optional
Activates Sudo or PowerBroker settings for specified targets.
emcli apply_privilege_delegation_setting
-setting_name="setting"
-target_type="host/composite"
[-target_names="name1;name2;..."]
[-input_file="FILE:file_path"]
[-force="yes/no"]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
apply_privilege_delegation_setting
(setting_name="setting"
,target_type="host/composite"
[,target_names="name1;name2;..."]
[,input_file="FILE:file_path"]
[,force="yes/no"])
[ ] indicates that the parameter is optional
setting_name
Name of the setting you want to apply.
target_names
List of target names. The newly submitted setting applies to this list of Enterprise Manager targets.
All targets must be of the same type.
The target list must not contain more than one element if the element's target type is "group."
The group referenced above should have at least one host target.
target_type
Type of targets to which the setting is applied. Valid target types are "host" or "composite" (group).
input_file
Path of the file that has target names. This enables you to pass targets in a separate file. The file cannot contain any colons ( : ) or semi-colons ( ; ).
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
force
If yes, the operation continues and ignores any invalid targets. The default is no.
These examples apply a privilege setting named sudo_setting. This setting applies to targets of type host, and it is being applied to host1, host2, and so forth.
emcli apply_privilege_delegation_setting
-setting_name=sudo_setting
-target_type=host
-target_names="host1;host2;"
Example 2 - Scripting and Interactive
apply_privilege_delegation_setting
(setting_name="sudo_setting"
,target_type="host"
,target_names="host1;host2")
These examples apply a privilege setting named sudo_setting. This setting applies to targets of type host, and it is being applied to host1, host2, and so forth. The force flag indicates that the setting is applied to all valid targets, and invalid targets are ignored.
emcli apply_privilege_delegation_setting
-setting_name=sudo_setting
-target_type=host
-target_names="host1;host2;"
-force=yes
Example 4 - Scripting and Interactive
apply_privilege_delegation_setting
(setting_name="sudo_setting",
target_type="host",
target_names="host1;host2", force="yes")
These examples apply a privilege setting named sudo_setting. This setting applies to targets of type host, and host names are selected from /home/jdoe/file.txt (one host per line). The force flag indicates that the setting is applied to all valid targets, and invalid targets are ignored.
emcli apply_privilege_delegation_setting
-setting_name=sudo_setting
-target_type=host
-input_file="FILE:/home/jdoe/file.txt"
-force=yes
Example 6 - Scripting and Interactive
apply_privilege_delegation_setting
(setting_name="sudo_setting"
,target_type="host"
,input_file="FILE:/home/jdoe/file.txt"
,force="yes")
Applies a monitoring template to a list of specified targets. The parameters to the verb can be supplied in any order.
emcli apply_template
-name="template_name"
-targets="tname1: ttype1;tname2: ttype2;..."
[-copy_flags="0" or "1" or "2"]
[-replace_metrics="0" or "1"]
[-input_file="FILE1:file_name"]
[ ] indicates that the parameter is optional
name
Template name as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks.
targets
The targets should be specified in the following sequence:
TargetName1:TargetType1;TargetName2:TargetType2
For example:
db1:oracle_database;my db group:composite
A semi-colon is the target separator. Ideally, non-composite targets should be of the target type applicable to the template. If not, the template is not applied to the indicated target. For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable.
copy_flags
This applies only for metrics with multiple thresholds.
'0' indicates: Apply threshold settings for key values common to the template and target.
'1' indicates: Remove key value threshold settings in the target and replace them with key value threshold settings from the template.
'2' indicates: Apply threshold settings for all key values defined in the template. The default is '0'.
replace_metrics
0 indicates that the thresholds of the metrics not included in the template but available in the target will not be changed. This is the default value. 1 indicates that the thresholds of the metrics present in the target, but not in the template, will be set to NULL. That is, such metrics in the target will not be monitored and therefore, no alert will be raised for them.
input_file
You can use this parameter to specify the location of a file, which contains the credentials to be used for the User Defined Metrics (UDMs) if the template contains any UDMs. file_name actually refers to the name of the file along with the path of the location, which contains the credentials applicable for the UDMs. For example:
emcli apply_template -name="template1" -targets="mydb1:oracle_database" -input_file= "FILE1:/usr/template/apply_udm_credentials.txt"
This example applies a monitoring template named "template1" to target mydb1 of type oracle_database, and the credentials needed for the UDMs are accessed from the file "/usr/template/apply_udm_credentials.txt".
The contents of the file apply_udm_credentials.txt should be in one of the following formats:
All UDMs use the same credentials for all targets. For example:
credListType:all; usr_name:joe1;passwrd:pass1;
Each UDM uses its own credentials for all targets. For example:
credListType:perUDM; udm_name:UDM1;usr_name:joe1;passwrd:pass1; udm_name:UDM2;usr_name:joe2;passwrd:pass2;
Each UDM uses different credentials for different targets. For example:
credListType:perTargetperUDM; udm_name:UDM1;tgt_name:TNAME1;usr_name:joe1;passwrd:pass1; udm_name:UDM1;tgt_name:TNAME2;usr_name:joe2;passwrd:pass2; udm_name:UDM2;tgt_name:TNAME1;usr_name:joe3;passwrd:pass3; udm_name:UDM2;tgt_name:TNAME2;usr_name:joe4;passwrd:pass4;
It is important to specify the "credListType" in every input text file that you specify.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
This example applies a monitoring template named my_db_template. This template applies to targets of type oracle_database, and it is being applied to db1 , which is of type oracle_database, and my_db_group, which is of type composite.
For composite targets, the template is only applied to member targets that belong to the target type for which the template is applicable. Since the copy_flags is not specified, the default ("Apply threshold settings for monitored objects common to both template and target") is meant.
emcli apply_template -name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
This example applies a monitoring template named my_db_template. This template applies to targets of type oracle_database and it is being applied to db1, which is of type oracle_database and my_db_group, which is of type composite.
For composite targets, the template is applied only to member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as 1, the threshold settings on the target will be duplicated.
emcli apply_template -name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
-copy_flags="1"
This example applies a monitoring template named my_db_template. This template is applicable to targets of type oracle_database, and it is being applied to db1 of type oracle_database and my_db_group of type composite.
For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as "2", the threshold settings on the target are duplicated, but the keys present only in the target and not present in the template are retained in the target, and their settings are not affected.
emcli apply_template -name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
-copy_flags="2"
This example applies a monitoring template named my_db_template. This template applies to targets of type oracle_database and it is being applied to db1, which is of type oracle_database and my_db_group, which is of type composite.
For composite targets, the template is applied only to member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as "1", the threshold settings on the target will be duplicated. Furthermore, the credentials needed for the UDMs are present in the file /usr/vmotamar/db_credentials.txt.
emcli apply_template -name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
-copy_flags="1" -input_file= "FILE1:/usr/vmotamar/db_credentials.txt"
This example applies the monitoring template named my_db_template. This template is applicable to targets of type oracle_database. This command applies this template to two targets: target db1 of type oracle_database and target my_db_group of type composite.
For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable. In this case, since the
copy_flags option is specified as "1", the template is superimposed on the target. All keys in the template are copied to the target, and any extra keys present in the target are deleted. The credentials needed for the UDMs are present in file /usr/user/db_credentials.txt.
The replace_metrics flag set to 1 denotes that the thresholds of the metrics present in the target, but not in the template, are set to NULL. That is, these metrics in the target are not monitored, and therefore, no alert is raised for them.
emcli apply_template -name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
-copy_flags="1" -replace_metrics="1" -input_file=
"FILE1:/usr/user/db_credentials.txt"
Applies the variables and test definitions from the file(s) into a repository target.
emcli apply_template_tests
-targetName=target_name
-targetType=target_type
-input_file=template:template_filename
[-input_file=variables:<variable_filename>]
[-input_file=atsBundleZip:<ats_bundle_zip_filename>]
[-useBundleDatabankFile]
[-useFirstRowValues]
[-overwriteExisting=all | none | <test1>:<type1>;<test2>:<type2>;...]
[-encryption_key=key]
[-swlibURN=<URN_for_swlib_entity>]
[-swlibPath=<Path_for_swlib_entity>]
[ ] indicates that the parameter is optional
targetName
Target name.
targetType
Target type.
input_file=template
Name of the input file containing the test definitions.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=variables
Name of the input file containing the variable definitions. If this attribute is not specified, the variables are extracted from the same file containing the test definitions.
The variables file format is as follows:
<variables xmlns="template"> <variable name="<name1>" value="<value1>"/> <variable name="<name2>" value="<value2>"/> ... </variables>
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=atsBundleZip
Name of the ATS bundle zip defined in the template.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
useBundleDatabankFile
If you specify this parameter, the bundle databank files are used.
useFirstRowValues
If you specify this parameter, the first row values are used.
overwriteExisting
Specifies which tests should be overwritten in case they already exist on the target. The possible values are:
'none' (default): None of the existing tests on the target will be overwritten.
'all': If a test with the same name exists on the target, it will be overwritten with the test definition specified in the template file.
<test1>:<type1>;<test2>:<type2>;...: If any of the tests with names <test1>, <test2>, and so forth exist on the target, they are overwritten with the definition in the template file.
encryption_key
Optional key to decrypt the file contents. This key should be the same as the one used to encrypt the file.
swlibURN
Loads the software library entity through an URN. The respective entity data such as OATZ zip file and Zip File Name will be associated to the new service test. Either this parameter or the -swlibPath parameter are required to associate the OATS zip file to the service test.
swlibPath
Loads the software library entity through an entity path. The respective entity data such as OATZ zip file and Zip File Name will be associated to the new service test. Either this parameter or the -swlibURN parameter are required to associate the OATS zip file to the service test.
You must have the following privileges to perform these examples:
Operator privilege on the target.
Operator privilege on all beacons currently monitoring the target. Alternatively, you must have the "use any beacon" privilege.
This example applies the test definitions contained in the file
my_template.xml into the Generic Service target my_target, using the key
my_password to decrypt the file contents. If tests with names my_website or
my_script exist on the target, they are overwritten by the test definitions in the file.
emcli apply_template_tests
-targetName='my_target' -targetType='generic_service'
-input_file=template:'my_template.xml' -encryption_key='my_password'
-overwriteExisting='my_website:HTTP;my_script:OS'
This example applies the test definitions contained in file
my_template.xml into the Web Application target my_target using the variable values specified in file my_variables.xml. If any tests in the target have the same name as tests specified in the template file, they are overwritten.
emcli apply_template_tests
-targetName='my_target' -targetType='website'
-input_file=template:'my_template.xml' -input_file=variables:
'my_variables.xml'
-overwriteExisting='all'
Executes one or more EM CLI verbs, where both verbs and the associated arguments are contained in an ASCII file. argfile enables you to use verbs with greater flexibility. For example, when specifying a large list of targets to be blacked out (create_blackout verb), you can use the argfile verb to input the target list from a file.
Multiple EM CLI verb invocations are permitted in this file. You should separate each verb invocation with a new line.
emcli argfile <file_name>
[-delim=<delimiter_string>]
[ ] indicates that the parameter is optional
Assigns a charge plan to the given entity.
assign_charge_plan
-entity_name="eName"
-entity_type="eType"
-plan_name="pName"
-[entity_guid="entity_guid"]
[ ] indicates that the parameter is optional
entity_name
Name of the entity for which the charge plan is to be assigned.
entity_type
Type of entity for which the charge plan is to be assigned.
plan_name
Name of the charge plan to be assigned.
entity_guid
guid of the entity to be added to Chargeback.
When more than one entity is active in Chargeback with the given entity name and entity type, the command lists all such entities with additional details such as creation date, parent entity name, entity guid, and so forth to choose the correct entity. Select the correct entity from the given list and execute the command again with entity guid as the parameter instead of entity name and entity type.
Assigns the cost center to the given entity.
assign_cost_center
-entity_name="eName"
-entity_type="eType"
-cost_center_name="cName"
-[entity_guid="entity guid" ]
[ ] indicates that the parameter is optional
entity_name
Name of the entity for which the cost center is to be assigned.
entity_type
Type of entity for which the cost center is to be assigned.
cost_center
Name of the cost center to be assigned.
entity_guid
guid of the entity in Chargeback.
When more than one entity is active in Chargeback with the given entity name and entity type, the command lists all such entities with additional details such as creation date, parent entity name, entity guid, and so forth to choose the correct entity. Select the correct entity from the given list and execute the command again with entity guid as the parameter instead of entity name and entity type.
Assigns or updates the Customer Support IDentifier (CSI) to the given target name and type.
emcli assign_csi_at_target_level
-target_name="Target_name"
-target_type="Target_type"
-csi="Customer_Support_IDentifier_value"
-mos_id="My_Oracle_Support_ID"
target_name
Name of the Cloud Control target.
target_type
Type of Cloud Control target
csi
Customer Support Identifier value to be assigned.
mos_id
My Oracle Support (MOS) user ID.
Assigns or updates the Customer Support Identifier (CSI) for all of the associated Exadata, RAC, and database targets for a database machine name.
emcli assign_csi_for_dbmachine_targets
-target_name="database_system_name"
-csi="customer_support_identifier_value"
-mos_id="my_oracle_support_ID"
target_name
Name of the database system target.
csi
Customer Support Identifier (CSI) to be assigned.
mos_id
My Oracle Support (MOS) user ID.
Assigns a test-type to a target-type. If a test-type t is assigned to target-type T, all targets of type T can be queried with tests of type t.
emcli assign_test_to_target
-testtype=test-type_to_be_assigned
-type=target_type
[-tgtVersion]=version_of_target_type
[ ] indicates that the parameter is optional
testtype
Test-type to be assigned. Should be the internal name; that is, 'HTTP' instead of 'Web Transaction'.
type
Service target type.
tgtVersion
Version of the target type. If not specified, the latest version is used.
Associates the specified standard with the listed targets.
Note: When the standard is provided by Oracle, the <std_name> is the standard internal name.
associate_cs_targets -name="<std_name>" -version="<std_version>" -author="<author_name>" -target_list="<target_name>[,<target_name>,<group_name>:Group]*" -target_list_file="<file_name>" [ ] indicates that this parameter is optional
name
Name of the standard.
version
Version of the standard.
author
Author of the standard. When the standard is provided by Oracle, the <std_name> is the standard internal name, for example, sysman.
target_list
Name of the target. This option is useful when a compliance standard is to be associated with one or a small number of targets. Targets are separated by commas. When providing a group target, it should be appended with ":Group". Examples are:
-target_list="slc0host"
-target_list="slc0host,slc-host01"
-target_list="slc0host,host_grps:Group"
target_list_file
Name of the file that contains the list of targets. The targets can be either comma-separated values or in a file where the targets are listed on separate lines. Examples are:
-target_list_file=slc0host,slc0host1,slc0host02
-target_list_file="slc0host.txt" Where slc0host.txt contains the following lines:
slc0host
slc0host01
slc0host02
Note: Use either the target_list option or the target_list_file option.
Example 1
The following example specifies the target_list.
emcli associate_cs_targets -name="secure configuration for host" -version="1" -author="sysman" -target_list="host1,host2,group1:Group"
Example 2
The following example specifies the target_list_file.
emcli associate_cs_targets -name="secure configuration for host" -version="1" -author="sysman" -target_list_file="file with target name list"
Associates a target to an existing Application Data Model.
emcli associate_target_to_adm
-adm_name=<application_data_model_name>
-target_name=<target_name>
-target_type=<target_type>
[ ] indicates that the parameter is optional
adm_name
Application Data Model name to which the target will be associated.
target_name
Application Data Model name to which the target will be associated.
target_type
Type of target that will be associated with the Application Data Model.
Assigns a test-type to a target-type. If a test-type t is assigned to target-type T, all targets of type T can be queried with tests of type t.
emcli bareMetalProvisioning
[-input_file="config_properties:input_XML"]
[ ] indicates that the parameter is optional
input_file
Input XML file confirming to the XSD for bare metal provisioning. See below for a detailed XML file used to provision BMP.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
<?xml version="1.0"?> <DeployedImage><ImageName>OracleLinux</ImageName><OperatingSystemType>Oracle Enterprise Linux x86 32 bit</OperatingSystemType> <!--Specify the Operating system type for this operation. Supported operating system types are : Oracle Enterprise Linux x86 32 bit, Oracle Enterprise Linux x86 64 bit, RedHat Enterprise Linux x86 32 bit, RedHat Enterprise Linux x86 64 bit, SUSE Linux Enterprise Server x86 32 bit, SUSE Linux Enterprise Server x86 64 bit--> <TargetInfo><TargetType>MAC</TargetType> <!--Specify the target type for this provisioning operation as follows : MAC : If the provisioning target type is mac address. RE_IMAGE : If reprovisioning the existing EM targets. Subnet : If provisioning all the targets in a Subnet.--> <Target><MACAddress>aa:bb:cc:dd:ee:ff</MACAddress><NetworkInterface><InterfaceName>eth0</InterfaceName><Configuration>Dhcp</Configuration> <!--Specify the network interface type as follows : Dhcp : If the interface configuration is to be dynamically assigned from a DHCP server. Static : If the interface configuration is to be statically configured. Network Profile : If the interface configuration is to be fetched from a Network Profile.--> <Type>Non Bonding</Type> <!--Specify the network interface type as follows : Non Bonding : If the interface is not part of any bond. Bonding Master : If the interface is supposed to be the Bonding master of a bond. Bonding Slave : If the interface is supposed to be a Bonding slave as part of bond.--> <!-- Following are bonding configuration--> <BondingMode>1</BondingMode> <!--Specify the Bonding Mode in case the interface has the role of Bonding Master.--> <SlaveDevices>eth1,eth2</SlaveDevices> <!--Specify the Slave devices as a csv string in case the interface has the role of Bonding Master. For ex : eth1,eth2--> <PrimarySlaveDevice>eth1</PrimarySlaveDevice> <!--Specify the Primary Slave device in case the interface has the role of Bonding Master.--> <ARPInterval>200</ARPInterval><ARPIPTarget>10.177.244.121</ARPIPTarget><ARPFrequency>400</ARPFrequency><ARPDownDelay>200</ARPDownDelay><ARPUpDelay>200</ARPUpDelay> <!--bonding configuration--> <!-- If Configuration is Static <IPAddress></IPAddress> <HostName></HostName> <Netmask></Netmask> <Gateway></Gateway> <DNSServers></DNSServers> --> <IsBootable>true</IsBootable> <!--Specify if the network interface is the bootable one.--> </NetworkInterface></Target> <!-- If TargetType is RE_IMAGE: replace <MACAddress> with following <HostName>myhost.us.example.com</HostName> <BootableMac>aa:bb:cc:dd:ee:ff</BootableMac> --> <!-- If TargetType is Subnet: replace <MACAddress> with following <SubnetIP>10.244.177.252</SubnetIP> <SubnetMask>255.255.252.0</SubnetMask> --> </TargetInfo> <!-- If TargetType is RE_IMAGE: <HostTargetsPreferredCredSetName>cred1<.HostTargetsPreferredCredSetName> Specify the preferred credentials name to be used for accessing the EM Host targetse to be Re-imaged. --> <StageServer>myhost.us.example.com</StageServer> <!--Specify the Stage Server host name. For ex : myhost.mydomain.com--> <StageStorage>/scratch/stage</StageStorage> <!--Specify the Stage Storage on the stage server. For ex : /scratch/stage--> <StageServerPreferredCredSetName>Cred1</StageServerPreferredCredSetName> <!--Specify the preferred credentials name to be used for accessing the stage server.--> <StageServerPrereqs>false</StageServerPrereqs> <!--Specify if the pre-requisties check should be run on the stage server before starting the provisioning.--> <BootServer>myhost.us.example.com</BootServer> <!--Specify the Boot Server host name. For ex : myhost.mydomain.com--> <BootServerPreferredCredSetName>Cred1</BootServerPreferredCredSetName> <!--Specify the preferred credentials name to be used for accessing the boot server.--> <BootServerPrereqs>false</BootServerPrereqs> <!--Specify if the pre-requisties check should be run on the boot server before starting the provisioning.--> <DhcpServer>myhost.us.example.com</DhcpServer> <!--Specify the Dhcp Server host name. This is required only if DHCP automation is required. For ex : myhost.mydomain.com Note : Dhcp automation is supported only for the MAC and RE_IMAGE provisioning types.--> <DhcpServerPreferredCredSetName>Cred1</DhcpServerPreferredCredSetName> <!--Specify the preferred credentials name to be used for accessing the Dhcp server.--> <DhcpServerPrereqs>false</DhcpServerPrereqs> <!--Specify if the pre-requisties check should be run on the Dhcp server before starting the provisioning.--> <RpmRepository>oelrepos</RpmRepository> <!--Specify the RPM repository name to be used for provisioning operation. For ex : OEL4U8repos--> <RootPassword>password</RootPassword> <!--Specify the root password for the provisioned machines.--> <TimeZone>Africa/Algiers</TimeZone> <!--Specify the time zone for the provisioned machines.--> <AgentInstallUser>oraem</AgentInstallUser> <!--Specify the user name for installing EM agent on the provisioned machines. For ex : oraem--> <AgentInstallGroup>dba</AgentInstallGroup> <!--Specify the agent installation user's group for installing EM agent on the provisioned machines. For ex : dba--> <AgentBaseInstallationDirectory>/var/lib/oracle/agent12g</AgentBaseInstallationDirectory> <!--Specify a directory for installing EM agent on the provisioned machines. For ex : /var/lib/oracle/agent12g--> <OracleInventoryLocation>/var/lib/oracle/oraInventory</OracleInventoryLocation> <!--Specify a directory for storing oracle installed product's inventory on the provisioned machines. For ex : /var/lib/oracle/oraInventory--> <AgentRegistrationPassword>password</AgentRegistrationPassword> <!--Specify agent registration password for installing EM agent on the provisioned machines.--> <AgentRpmUrl>http://myhost.us.example.com/oracle-agt.12.1.0.0.1-i386.rpm</AgentRpmUrl> <!--Specify a http URL for fetching agent RPM. This is not mandatory if the agent rom is already placed at the staged location--> <ReferenceAnaconda/> <!--Specify a reference anaconda as a string. It will be used to capture properties like Keyboard, mouse. If not provided they will be defaulted to default values.--> <PackageList>@base</PackageList> <!--Specify the package list to be installed on the provisioned machines.--> <ACPI>off</ACPI> <!--Specify the ACPI value for the provisioned machines. Supported values are : on, off--> <ParaVirtualizedKernel>false</ParaVirtualizedKernel> <!--Specify if the provisioned machines should be booted with paravirtualized kernels.--> <PostInstallScript>%post echo "post" </PostInstallScript> <!--This section provides the option of adding commands to be run on the system once the installation is complete. This section must start with the %post command.--> <FirstBootScript>#!/bin/sh # chkconfig: 345 75 25 # description: Bare Metal Provisioning First boot service # </FirstBootScript> <!--This section provides the option of adding commands to run on the system when it boots for the first time after installation.--> <RequireTTY>false</RequireTTY> <!--Specify if tty is required on the provisioned machines.--> <SeLinux>Disabled</SeLinux> <!--Specify the SELinux configuration for the provisioned machines. Supported values are : Disabled, Enforcing, Permissive--> <MountPointSettings/> <!--Specify /etc/fstab settings for the provisioned machines.--> <NISSettings/> <!--Specify /etc/yp.conf settings for the provisioned machines.--> <NTPSettings/> <!--Specify /etc/ntp.conf settings for the provisioned machines.--> <KernelParameterSettings/> <!--Specify /etc/inittab settings for the provisioned machines.--> <FirewallSettings/> <!--Specify the firewall settings for the provisioned machines.--> <HardDiskProfiles> <!--Specify the Hard Disk profiles for the provisioned machines.--> <HardDiskConfiguration> <!--Specify the hard disk configuration details--> <DeviceName>hda</DeviceName> <!--Specify the device name for the disk. For ex : hda,hdb--> <Capacity>10000000</Capacity> <!--Specify the disk capacity in MB. For ex : 1024--> </HardDiskConfiguration></HardDiskProfiles><PartitionConfigurations> <!--Specify the partition configurations for the provisioned machines.--> <PartitionConfiguration> <!--Specify the partition configuration details.--> <MountPoint>/</MountPoint> <!--Specify the mount point for the partition. For ex : /, /root--> <DeviceName>hda</DeviceName> <!--Specify the disk name on which this partition has to be configured. For ex : hda,hdb--> <SystemDeviceName>/dev/hda1</SystemDeviceName> <!--For ex : /dev/hda1--> <FileSystemType>ext3</FileSystemType> <!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap, Raid, LVM--> <Size>4096</Size> <!--Specify the size in MB for this partition. For ex : 5120--> </PartitionConfiguration></PartitionConfigurations><RaidConfigurations> <!--Specify the RAID configurations for the provisioned machines.--> <RaidConfiguration> <!--Specify the RAID configuration details--> <MountPoint>raid.100</MountPoint> <!--Specify the raid id . For ex : raid.100--> <RaidLevel>0</RaidLevel> <!--Specify the RAID Level for this raid device. Supported RAID Levels are : Raid 0, Raid 1, Raid 5, Raid 6--> <Partitions>/dev/hda1,/dev/hda2</Partitions> <!--Specify the raid partitions for this raid device as a csv string. For ex : /dev/hda1, /dev/hda2--> <FileSystemType>ext3</FileSystemType> <!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap, LVM--> </RaidConfiguration></RaidConfigurations><LogicalVolumeGroups> <!--Specify the Logical Volume Groups for the provisioned machines.--> <LogicalVolumeGroup> <!--Specify the logical volume group configuration details--> <GroupName>LVG1</GroupName> <!--Specify the Logical group name. For ex : mygrp--> <Partitions>/dev/hda1</Partitions> <!--Specify the partitions that take part in this logical volume group as a csv string. For ex : /dev/hda1, /dev/hda2--> <Raids>raid.100</Raids> <!--Specify the RAIDs that take part in this logical volume group as a csv string. For ex : raid.100, raid.200--> </LogicalVolumeGroup></LogicalVolumeGroups><LogicalVolumes> <!--Specify the Logical Volumes for the provisioned machines.--> <LogicalVolume> <!--Specify the logical volume configuration details.--> <MountPoint>/u01</MountPoint> <!--Specify the mount point for this logical volume. For ex : /, /root--> <LogicalVolumeName>LV1</LogicalVolumeName> <!--Specify the logial volume name. For ex : myvols--> <LogicalGroupName>LVG1</LogicalGroupName> <!--Specify the logical group name where this volume should be created. For ex : mygrp--> <FileSystemType>ext3</FileSystemType> <!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap--> <Size>4096</Size> <!--Specify the size in MB for this partition. For ex : 5120--> </LogicalVolume></LogicalVolumes></DeployedImage>
Cancels scheduled cloud service request(s) initiated by the specified user. Note that only scheduled requests can be cancelled.
emcli cancel_cloud_service_requests
-user="username"
[-family="family"]
[-ids="id1;id2..."]
[ ] indicates that the parameter is optional
user
Name of the user who initiated the requests.
family
Service family name to use to filter cloud requests.
ids
List of Request IDs to use to filter cloud requests. Separate each ID with a semicolon ( ; ).
This example cancels all scheduled cloud requests owned by user1.
emcli cancel_cloud_service_requests -user="user1"
This example cancels all cloud requests owned by user1 and belonging to the family1 service family.
emcli cancel_cloud_service_requests -user="user1" -family="family1"
This example cancels cloud requests 1 and 2 owned by user1.
emcli cancel_cloud_service_requests -user="user1" -ids="1;2"
Changes the system that hosts a given service.
emcli change_service_system_assoc
-name='name'
-type='type'
-systemname='system_name'
-systemtype='system_type'
-keycomponents='keycomp1name:keycomp1type[;keycomp2name:keycomp2type;...]'
[ ] indicates that the parameter is optional
name
Service name.
type
Service type.
systemname
System on which the service resides.
systemtype
System type.
keycomponents
Name-type pair (such as keycomp_name:keycomp_type) list of key components in the system used for the service.
This example changes the system for a generic service named my service to a generic system named my system with specified key components.
emcli change_service_system_assoc
-name='my service' -type='generic_service'
-systemname='my system' -systemtype='generic_system'
-keycomponents='database:oracle_database; mytestbeacon:oracle_beacon'
Changes the owner of the target.
emcli change_target_owner
-target="target_name:target_type"
[-target="target_name:target_type"]
-owner="current_target_owner_name"
-new_owner="new_owner_name"
[ ] indicates that the parameter is optional
target
Target name and target type to change the owner.
owner
Name of the existing owner of the target. The default value for this parameter is the currently logged in user.
new_owner
New owner name of the target.
Cleans up requests from the host and Enterprise Manager. Depending on the parameters specified, this verb:
Cleans up all failed requests from a pool.
Cleans up all requests from a pool.
Cleans up failed requests for a specific user.
Cleans up all requests for a specific user.
emcli help cleanup_dbaas_requests
emcli cleanup_dbaas_requests [-ids="<request id>"] [-pool_name="<pool name>" -pool_type="
<database|schema|pluggable_database>"
[-user="<SSA user name>"]
[-all]]
[ ] indicates that the parameter is optional.
ids
Request ID to be used for filtering Cloud requests, separated by semicolons( ; ).
pool_name
Name of the pool from which requests must be cleaned up.
pool_type
Type of pool. Enter one of the following values:
For database pools: database
For schema pools: schema
For pluggable database pools: pluggable_database
user
User name to be used for filtering requests for deletions.
all
If specified, cleans up all requests (successful and failed), cancels the requests that are in a scheduled state, and leaves the requests that are in progress as is. If this parameter is not specified, cleanup is performed on failed requests only.
Note:
The ids and pool_name parameters cannot be used together.This example performs the cleanup for the specified request ID 10.
emcli cleanup_dbaas_requests -ids="10"
This example performs the cleanup for the specified request IDs 10, 11, and 12.
emcli cleanup_dbaas_requests -ids="10;11;12"
This example performs a cleanup of all failed requests.
emcli cleanup_dbaas_requests -pool_name="database_pool" -pool_type="database"
This example performs a cleanup of all requests, both failed and successful. This process essentially resets the pool.
emcli cleanup_dbaas_requests -pool_name="database_pool" -pool_type="database" -all
This example performs a cleanup of all requests (failed and successful) for a specific user. This option is useful in cases where the user is no longer in the system and the administrator wants to clean up all of the service instances owned by this user.
emcli cleanup_dbaas_requests -pool_name="database_pool" -pool_type="database" -all -user="SSA_USER"
Clears preferred or monitoring credentials for given users.
emcli clear_credential
-target_type="ttype"
[-target_name="tname"]
-credential_set="cred_set"
[-user="user"]
[-oracle_homes="home1;home2"]
[ ] indicates that the parameter is optional
target_type
Type of target, which must be "host" if you specify the oracle_homes parameter.
target_name
Name of the target. Omit this option to clear enterprise-preferred credentials. The target name must be the host name if you specify the oracle_homes parameter.
credential_set
Credential set affected.
user
Enterprise Manager user whose credentials are affected. If omitted, the current user's credentials are affected. This value is ignored for monitoring credentials.
oracle_homes
Name of Oracle homes on the target host. Credentials are cleared for all specified homes.
Clears the named credential set as the default preferred credential for the user. The named credential is not deleted from the credential store. Only the user preference to use the named credential as the default preferred credential is cleared.
set_name
Clears the default preferred credential for this credential set.
target_type
Target type for the credential set.
Clears the default privilege delegation settings for a specified platform.
Standard Mode
emcli clear_default_privilege_delegation_setting
-platform_list="PLATFORM_DEFAULT"
Interactive or Script Mode
clear_default_privilege_delegation_setting(
platform_list="PLATFORM_DEFAULT"
)
[ ] indicates that the parameter is optional
platform_list
Comma-separated list of platforms for which default privilege delegation settings are removed. Supported platforms: Linux, HP-UX, SunOS, and AIX.
Clears the monitoring credential set for the target.
emcli clear_monitoring_credential
-set_name="set_name"
-target_name="target_name"
-target_type="ttype"
set_name
Clears the monitoring credential for this credential set.
target_name
Clears the preferred credential for this target.
target_type
Target type for the target/credential set.
Clears the named credential set as the target preferred credential for the user. The named credential is not deleted from the credential store. Only the user preference to use the named credential as the preferred credential is cleared.
emcli clear_preferred_credential
-set_name="set_name"
-target_name="target_name"
-target_type="ttype"
set_name
Sets the preferred credential for this credential set.
target_name
Clears the preferred credential for this target.
target_type
Target type for the target/credential set.
Clears the privilege delegation setting from a given host or hosts.
emcli clear_privilege_delegation_setting
-host_names="name1;name2;..."
[-input_file="FILE:file_path"]
[-force="yes/no"]
[ ] indicates that the parameter is optional
host_names
Names of the hosts.
input_file
Path of the file that has the list of hosts. The file should have one host name per line.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
force
If set to yes, invalid and unreachable targets are ignored and the setting is removed from all valid and up targets. If set to no, invalid and down targets raise an error. The default is no.
emcli clear_privilege_delegation_setting
-host_names="host1;host2;....."
emcli clear_privilege_delegation_setting
-host_names="host1;host2;....."
-force=yes
emcli clear_privilege_delegation_setting
-input_file="FILE:/home/user/file.txt"
-force=yes
Clears problems matching the specified criteria (problem key, target type, and age). Only users with Manage Target privilege can clear the problems for a target. When a problem is cleared, the underlying incidents and events are also cleared.
By default, the problem notification is not sent out. You can override this by specifying the send_notification option. Clearing the underlying incidents and events does not send out a notification.
emcli clear_problem
-problem_key="problem_key"
-target_type="target_type"
-older_than="age_of_problem"
[-target_name="target_name"]
[-unacknowledged_only="clear_unacknowledged_problems"]
[-send_notification="send_notifications_for_problems"]
[-preview]
[ ] indicates that the parameter is optional
problem_key
Problem key of the problem to be cleared
target_type
Internal type name, such as oracle_database for "Oracle Database." You can use the get_target_types command to get the internal name for a target type.
older_tha n
Specify the age (in days) of the problem.
target_name
Name of an existing non-composite target. For example, the name of a single database. You cannot use the name of composite targets (target group).
unacknowledged_only
If provided, only the unacknowledged problems are cleared. This option does not require any value.
send_notification
If provided, any applicable notification is sent out for cleared problems. By default, no notification is sent for cleared problems. This parameter does not require any value.
preview
Gets the number of problems that the command would clear.
This example displays the number of problems matching the specified criteria.
emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database"-preview
This example clears ORA-600 problems across all databases that have occurred (based on the occurrence date of the first incident) for at least 3 days.
emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database" -older_than="3"
This example clears only unacknowledged problems.
emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database" -older_than="3" -unacknowledged_only
This example sends applicable notifications when the problem clears. By default, a notification is not sent for the cleared problems.
emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database" -older_than="3" - send_notification
Clears the stateless alerts associated with the specified target. Only a user can clear these stateless alerts; the Enterprise Manager Agent does not automatically clear these alerts. To find the metric internal name associated with a stateless alert, use the
get_metrics_for_stateless_alerts verb.
You cannot use this command to clear stateless alerts associated with diagnostic incidents. You can only clear these alerts in the Enterprise Manager console by clearing their associated Incident or Problem.
emcli clear_stateless_alerts -older_than=number_in_days -target_type=target_type -target_name=target_name [-include_members] [-metric_internal_name=target_type_metric:metric_name:metric_column] [-unacknowledged_only] [-ignore_notifications] [-preview] [ ] indicates that the parameter is optional
older_than
Specify the age of the alert in days. (Specify 0 for currently open stateless alerts.)
target_type
Internal target type identifier, such as host, oracle_database, and emrep.
target_name
Name of the target.
include_members
Applicable for composite targets to examine alerts belonging to members as well.
metric_internal_name
Metric to be cleaned up. Use the get_metrics_for_stateless_alerts verb to see a complete list of supported metrics for a given target type.
unacknowledged_only
Only clear alerts if they are not acknowledged.
ignore_notifications
Use this option if you do not want to send notifications for the cleared alerts. This may reduce the notification sub-system load.
preview
Shows the number of alerts to be cleared on the target(s).
This example clears alerts generated from the database alert log over a week old. In this example, no notifications are sent when the alerts are cleared.
emcli clear_stateless_alerts -older_than=7 -target_type=oracle_database -tar get_name=database -metric_internal_name=oracle_database:alertLog:genericErrStack -ignore_notifications
Clones the specified Application Server Oracle Home or S/W Library component from the target host to specified destinations. For a Portal and Wireless installation, the OID user and password are also needed. For a J2EE instance connected to only a DB-based repository, a DCM Schema password is needed.
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
emcli clone_as_home
-input_file="dest_properties:file_path"
-list_exclude_files="list of files to exclude"
-isSwLib="true/false"
-tryftp_copy="true/false"
-jobname="name of cloning job"
-iasInstance=instance
-isIas1013="true/false"
[-oldIASAdminPassword=oldpass]
[-newIASAdminPassword=newpass]
[-oldoc4jpassword=oldpass]
[-oc4jpassword=newpass]
[-oiduser=oid admin user]
[-oidpassword=oid admin password]
[-dcmpassword=dcm schema password]
[-prescripts="script name to execute"]
[-run_prescripts_as_root="true/false"]
[-postscripts="script to execute"]
[-run_postscripts_as_root="true/false"]
[-rootscripts="script name to execute"]
[-swlib_component ="path:path to component;version:rev"]
[-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
ScratchLoc:Scratch dir Location"
[-jobdesc="description"]
[ ] denotes that the parameter is optional
input_file="dest_properties:file_path"
File containing information regarding the targets.
Each line in the file corresponds to information regarding one destination.
Format:
Destination Host Name1;Destination Home Loc; Home Name; Scratch Location;
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
list_exclude_files
Comma-separated list of files to exclude. Not required if the source is software lib. "*" can be used as a wild card.
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
ryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the cloning job.
iasInstance
Name of instance.
isIas1013
Specifies whether this is a 10.2.3 Ias home.
oldoc4jpassword
Old OC4j password. (Required for 10.1.3 Ias homes.)
oc4jpassword
New OC4J password. (Required for 10.1.3Ias homes.)
oldIASAdminPassword
Old Application Server administrator password. (Not required for 10.1.3 Ias homes.)
newIASAdminPassword
New Application Server administrator password. (Not required for 10.1.3 Ias homes.)
oiduser
OID admin user.
oidpassword
OID admin password.
dcmpassword
DCM schema password.
prescripts
Path of script to execute.
Note:
Double-quoted parameters can be passed using an escape (\) sequence. For example:prescripts=" <some value here>=\"some value here\" "
run_prescripts_as_root
Run prescripts as "root". By default, the option is set to false.
postscripts
Path of script to execute.
run_postscripts_as_root
Run postscripts as "root". By default, the option is set to false.
rootscripts
Path of the script to execute. The job system environment variables
(%oracle_home%, %perl_bin%) can be used for specifying script locations.
swlib_component
Path to the Software Library to be cloned. "isSwLib" must be true in this case.
source_params
Source Oracle home information. "isSwLib" must be false in this case.
jobdesc
Description of the job. If not specified, a default description is generated automatically.
emcli clone_as_home
-input_file="dest_properties:/home/destinations.txt"
-list_exclude_files="centralagents.lst"
-isSwLib="false"
-tryftp_copy="false"
-jobname="clone as home"
-iasInstance="asinstancename"
-isIas1013="false"
-oldIASAdminPassword="oldpassword"
-newIASAdminPassword="newpassword"
-prescripts="/home/abc/myscripts"
-run_prescripts_as_root="true"
-rootscripts="%oracle_home%/root.sh"
-source_params="TargetName:host.domain.com;HomeLoc=/home/oracle/appserver1;
HomeName=oracleAppServer1;ScratchLoc=/tmp"
Creates an Oracle Clusterware cluster given a source Clusterware home location or a Clusterware S/W Library component for specified destination nodes.
emcli clone_crs_home
-input_file="dest_properties:file_path"
-list_exclude_files="list of files to exclude"
-isSwLib="true/false"
-tryftp_copy="true/false"
-jobname="name of cloning job"
-home_name="name of home to use when creating Oracle Clusterware cluster"
-home_location="location of home when creating Oracle Clusterware cluster"
-clustername=name of cluster to create
[-isWindows="false/true"]
[-ocrLoc=ocr location]
[-vdiskLoc=voting disk location]
[-prescripts="script name to execute"]
[-run_prescripts_as_root="true/false"]
[-postscripts="script to execute"]
[-run_postscripts_as_root="true/false"]
[-rootscripts="script name to execute"]
[-swlib_component ="path:path to component;version:rev"]
[-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
ScratchLoc:Scratch dir Location"] [-jobdesc="description"]
[ ] denotes that the parameter is optional
input_file="dest_properties:file_path"
File containing information regarding the targets.
Each line in the file corresponds to information regarding one destination.
Format:
Destination Host Name;Destination Node Name;Scratch Location;PVTIC;VirtualIP;
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
list_exclude_files
Comma-separated list of files to exclude. Not required if the source is software lib. An asterisk "*" can be used as a wildcard.
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using emcli from the command line.
jobname
Name of the cloning job.
home_name
Name of the home to use for all homes in the Oracle Clusterware cluster.
home_location
Location of the home to use for all homes in the Oracle Clusterware cluster.
clustername
Name of the cluster to create.
isWindows
Specify whether the cloning source is on a Windows Platform. This option only applies for creating CRS cloning from a Gold Image source. The default value is false.
ocrLoc
Oracle Cluster Registry Loaction.
vdiskLoc
Voting disk location.
prescripts
Path of the script to execute.
Note:
Double-quoted parameters can be passed using an escape (\) sequence. For example:prescripts=" <some value here>=\"some value here\" "
run_prescripts_as_root
Run prescripts as "root". By default, this option is set to false.
postscripts
Path of the script to execute.
run_postscripts_as_root
Run postscripts as "root". By default, it is false.
rootscripts
Path of the script to execute.
swlib_component
Path to the Software Library to be cloned. "isSwLib" must be true in this case.
source_params
Source Oracle home info. "isSwLib" must be false in this case.
jobdesc
Description of the job. If not specified, a default description is generated automatically.
emcli clone_crs_home -input_file="dest_properties:crs.prop" -isSwLib="true" -tryftp_copy="true" -jobname="crs cloning job2" -home_name="cloneCRS1" -home_location="/scratch/scott/cloneCRS1 " -clustername="crscluster" -ocrLoc="/scratch/shared/ocr" -vdiskLoc="/scratch/shared/vdisk" -postscripts="%perlbin%/perl%emd_root%/admin/scripts/cloning/samples/ post_crs_ create.pl ORACLE_HOME=%oracle_home%" -run_postscripts_as_root="true" -rootscripts="%oracle_home%/root.sh" -swlib_component="path:Components/crscomp;version:.1"
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
Clones a database.
emcli clone_database
-source_db_name="source_database_name"
-dest_global_dbname="global_name_of_clone_database"
-dest_oracle_sid="clone_database_instance_name"
[-dest_host_name="clone_host_name"]
[-dest_oracle_home="clone_database_oracle_home"]
[-source_db_creds_name="source_database_credential_name"]
[-source_host_creds_name="source_database_host_credential_name"]
[-dest_host_creds_name="clone_database_host_credential_name"]
[-asm_inst_creds_name="asm_instance_credential_name"]
[-dest_target_name="clone_database_name"]
[-clone_type="clone_type"]
[-source_staging_area="source_staging_directory"]
[-dest_staging_area="clone_database_staging_directory"]
[-dest_storage_type="clone_database_storage_type"]
[-dest_database_area="clone_database_files_location"]
[-dest_recovery_area="clone_database_fast_recovery_area"]
[-dest_listener_selection="clone_database_listener_selection"]
[[-dest_listener_name="clone_database_listener_name"]
[-dest_listener_port="clone_database_listener_port"]]
[-configure_with_oracle_restart"]
[-job_name="job_name"]
[-job_desc="job_description"
[ ] denotes that the parameter is optional
source_db_name
Source database Enterprise Manager target name. Can be either a single-instance database or a cluster database instance.
dest_global_dbname
Clone database global database name. Usually specified as <name>.<domain>, with <name> being used for the db_unique_name and <domain> for the
db_domain_name parameters.
dest_oracle_sid
Clone database instance name.
dest_host_name
Clone database host name. If not specified, the clone database is created on the same host as the source database.
dest_oracle_home
Clone database Oracle home. If not specified, the Oracle Home of the source database is used.
source_db_creds_name
Source database named credential.
source_host_creds_name
Source database host named credential.
dest_host_creds_name
Destination (clone) host named credential.
asm_inst_creds_name
Automatic Storage Management(ASM) named credential.
dest_target_name
Clone database Enterprise Manager target name.
clone_type
Type of source database backup that will be used for cloning. Valid values are:
DUPLICATE — Database files are moved directly to the clone database host by the Recovery Manager (RMAN).
STAGING — Database files are backed-up into the staging area and moved to the clone database host through HTTP.
EXISTING_BACKUP — Database files are restored from existing backups to the clone database host by the Recoverey Manager (RMAN).
pitr_date
Clone database as of the specified date in MM/dd/yyyy hh:mm:a (Month/Date/Year Hours:Minutes:AM/PM marker) format. For example: 03/22/2014 08:25:AM. If not specified, the clone database is created as of the latest point-in-time. This option is applicable when the clone_type is
EXISTING_BACKUP.
pitr_scn
Clone database as of the specified System Change Number of the source database. If not specified, the clone database is created as of the latest point-in-time. This option is applicable when the clone_type is EXISTING_BACKUP.
encryption_mode
Encryption mode of the existing source database backups. If not specified, the default value is NONE. This option is applicable when the clone_type is EXISTING_BACKUP. Valid values are:
WALLET — Backups are encrypted using Oracle Encryption Wallet.
PASSWORD — Backups are encrypted using a password.
DUAL — Backups are encrypted using both Oracle Encryption Wallet and a password.
backups_encryption_creds_name
Database named credential for the encrypted backups. This option is applicable if encryption_mode is PASSWORD or DUAL.
Note:
This parameter is applicable only if the clone type is EXISTING_BACKUP and the database backups are encrypted using a password. This database credential should be created in Enterprise Manager of scope GLOBAL with the user name specified astape_settings
Media management vendor settings if the database backups are on tape. This option is applicable when clone_type is EXISTING_BACKUP.
db_backups_location
The location of the backups to be transferred to the destination host. Multiple values can be specified using "," as a delimiter. This option is applicable when cloning to a different host and clone_type is EXISTING_BACKUP.
Note:
This parameter is applicable only if the clone type is EXISTING_BACKUP and the database clone occurs on a different host where the source database backups are not visible. If the backups are visible from the destination host, this parameter should NOT be specified.It is recommended that if the size of the database backups is very large, the backups should be taken in a common location visible from the destination host.
If the source database backups are on ASM diskgroups, ensure that the diskgroups are mounted at the destination host as these backups are not transferred.
When you specify this parameter is specified, all of the available files at this location are transferred to a temporary staging location at the destination host.
You can specify multiple values for this parameter with comma (,) as a delimiter.
source_staging_area
Staging area used to store the backup of source database. This option is applicable when clone_type is STAGING.
dest_staging_area
Staging area used to store backup files transferred from source host. This option is applicable when clone_type is STAGING.
dest_storage_type
Clone database storage type. Valid values are:
FILE_SYSTEM — Clone database files will be in a regular file system (using Oracle-managed Files).
ASM — The clone database will use Automatic Storage Management (ASM).
dest_database_area
Oracle-managed files (OMF) location for clone database files. This can be a regular file system (if storage_type is FILE_SYSTEM) or an ASM disk group (if
storage_type is ASM). If not specified, a default value is used.
dest_recovery_area
Fast recovery area location. If not specified, a default value is used.
dest_listener_selection
Clone database listener selection. Valid values are:
GRID_INFRA — Use Grid Infrastructure Home listener.
DEST_DB_HOME — Use the listener from the clone database Oracle Home.
dest_listener_name
Clone database listener name. This option is applicable only if
dest_listener_selection is DEST_DB_HOME. If not specified, the first existing TCP listener found in the clone database Oracle Home is used. If you specify this option, you must also specify dest_listener_port.
dest_listener_port
Clone database listener port. This option is applicable only if
dest_listener_selection is DEST_DB_HOME. If you specify this option, you must also specify dest_listener_name.
configure_with_oracle_restart
Configure the clone database with Oracle Restart if the clone host has Oracle Restart configured. Oracle Restart automatically starts the database when required.
job_name
Unique job name for the clone job in the Enterprise Manager repository.
job_desc
Job description.
emcli clone_database -source_db_name="database" -dest_target_name="dbClone1" -dest_host_name="host1" -dest_oracle_home="/ade/ngade_gct/oracle" -dest_oracle_sid="dbClone1" -dest_global_dbname="dbClone1" -dest_listener_selection="DEST_DB_HOME" -clone_type="DUPLICATE" -dest_storage_type="FILE_SYSTEM"
emcli clone_database -source_db_name="database" -source_db_creds_name="NC_DBCREDS1" -source_host_creds_name="NC_HOST_CREDS1" -dest_host_name="host1" -dest_host_creds_name="NC_HOST_CREDS2" -dest_oracle_home="/u01/app/oracle/product/11.2.0/dbhome_2" -dest_oracle_sid="TESTDB1" -dest_global_dbname="TESTDB1" -dest_listener_selection="GRID_INFRA" -clone_type="EXISTING_BACKUP" -dest_storage_type="FILE_SYSTEM" db_backups_location="/oracle/dir1"
emcli clone_database -source_db_name="database" -source_db_creds_name="NC_DBCREDS1" -source_host_creds_name="NC_HOST_CREDS1" -dest_host_creds_name="NC_HOST_CREDS2" -dest_oracle_home="/u01/app/oracle/product/11.2.0/dbhome_2" -dest_oracle_sid="TESTDB2" -dest_global_dbname="TESTDB2" -dest_listener_selection="GRID_INFRA" -clone_type="EXISTING_BACKUP" -pitr_date="03/22/2014 08:25:AM" -dest_storage_type="FILE_SYSTEM"
Clones the specified Oracle Home or S/W Library from the target host to specified destinations. If the isRac option is true, a RAC cluster is created. If the isRac option is true, the home name and location of the RAC cluster are needed.
emcli clone_database_home
-input_file="dest_properties:file_path"
-list_exclude_files="files_to_exclude"
-isSwLib="true|false"
-isRac="true|false"
-tryftp_copy="true|false"
-jobname="name_of_cloning_job"
[-home_name="home_when_creating_RAC_cluster"]
[-home_location="location_of_home_when_creating_RAC_cluster"]
[-prescripts="script_name_to_execute"]
[-run_prescripts_as_root="true|false"]
[-postscripts="script_to_execute"]
[-run_postscripts_as_root="true|false"]
[-rootscripts="script_name_to_execute"]
[-swlib_component ="path:path_to_component;version:rev"]
[-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
ScratchLoc:scratch_dir_location"
[-jobdesc="description"]
[ ] denotes that the parameter is optional
input_file=dest_properties
File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.
Format if cloning a database (isRac is false):
Destination Host Name1;Destination Home Loc; Home Name; Scratch Location;
Format if cloning a RAC cluster (isRac is true):
Host Name;Node Name;Scratch Location;
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
list_exclude_files
Comma-separated list of files to exclude. This is not required if the source is software lib. "*" can be used as a wild card.
isSwLib
Specifies whether the source is an Oracle Home database or Software Library.
isRac
Specifies whether cloning in RAC mode. If the isRac option is true, a RAC cluster is created. If the isRac option is true, the home name and location of the RAC cluster are needed.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the cloning job.
home_name
Name of the home to use when creating a RAC cluster.
home_location
Location of the home to use when creating a RAC cluster.
prescripts
Path of the script to execute.
Note:
Double-quoted parameters can be passed using an escape (\) sequence. For example:prescripts=" <some value here>=\"some value here\" "
run_prescripts_as_root
Run prescripts as "root". By default, it is false.
postscripts
Path of the script to execute.
run_postscripts_as_root
Run postscripts as "root". By default it is false.
rootscripts
Path of the script to execute. You can use the job system environment variables (%oracle_home%, %perl_bin%) to specify script locations.
swlib_component
Path to the Software Library to be cloned. "isSwLib" must be true in this case.
source_params
Source Oracle home info. "isSwLib" must be false in this case.
jobdesc
Description of the job. If not specified, it is automatically generated.
emcli clone_database_home
-input_file="dest_properties:clonedestinations"
-list_exclude_files="*.log,*.dbf,sqlnet.ora,tnsnames.ora,listener.ora"
-isSwLib="false"
-isRac="false"
-tryftp_copy="false"
-jobname="clone database home"
-prescripts="/home/joe/myScript"
-run_prescripts_as_root="true"
-rootscripts="%oracle_home%/root.sh"
-source_params="TargetName:host.domain.com;HomeLoc=/oracle/database1; HomeName=OUIHome1;ScratchLoc=/tmp"
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
Performs an immediate collection and threshold evaluation of a set of metrics associated with the specified internal metric name. Metric data collection and threshold evaluation occur asynchronously to the EM CLI call.
You typically use this command when you believe you have resolved an open metric alert or error and would like to clear the event by immediately collecting and reevaluating the metric. This command applies to most metrics except server-generated database metrics.
Use the get_on_demand_metrics verb to see a complete list of supported metrics for a given target.
emcli collect_metric -target_name=name -target_type=type -metric_name=metric_name | -collection_name=user_defined_metric_name [ ] indicates that the parameter is optional
target_name
Name of the target.
target_type
Internal target type identifier, such as host, oracle_database, and emrep.
metric_name
Internal name that represents a set of metrics that are collected together. Use the get_on_demand_metrics verb to see the supported list of metrics for a given target.
collection_name
Name of the user-defined metric or SQL user-defined metric. This parameter only applies to user-defined metrics and SQL user-defined metrics.
If you want to collect the "CPU Utilization (%)" metric, look for the appropriate metric internal name (which is Load) using the get_on_demand_metrics command, then run the command as follows:
emcli collect_metric -target_type=host -target_name=hostname.example.com -metric_name=Load
This example immediately collects and evaluates thresholds for the user-defined metric called MyUDM:
emcli collect_metric -target_type=host -target_name=hostname.example.com -collection=MyUDM
This example immediately collects and evaluates thresholds for the SQL user-defined metric called MySQLUDM:
emcli collect_metric -target_type=oracle_database -target_name=database -collection=MySQLUDM
Compares two SLAs as defined by two XML files. This utility outputs the difference trees as sla1_compare.dif and sla2_compare.dif in the specified directory. You can use a diff utility to diff these two files. Compare two sla.xml's to find out the difference.
emcli compare_sla -input_file=sla1:'first_xml -input_file=sla2:'second_xml' [-dir='directory'] [ ] indicates that the parameter is optional
input_file=sla1
File name for the first XML file.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=sla2
File name for the second XML file.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
dir
The default is the current directory. If you need to specify another directory, use this option for the output files sla1_compare.dif and sla2_compare.dif.
This example compares two SLAs as defined in sla1.xml and sla2.xml, and outputs sla1_compare.dif and sla2_compare.dif in the current directory.
emcli compare_sla
-input_file=sla1:sla1.xml -input_file=sla2:sla2.xml
You can use a standard diff tool to diff the files, such as This example for Linux:
diff sla1_compare.dif sla2_compare.dif
Submits the configuration comparison job.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="SYSMAN"
-job_name="Test Compare Job"
[-schedule=
{
start_time:yyyy/MM/dd HH:mm;
tz:{java timezone ID};
frequency:interval/weekly/monthly/yearly;
repeat:#m|#h|#d|#w;
months:#,#,...;
days:#,#,...;
end_time:yyyy/MM/dd HH:mm;
grace_period:;
}]
[-template_id="18"]
[-job_description="Test Description"]
[-mapping_display="Tree"]
[-email_address]
[-save_mode="save_all|save_only_diffs"]
[ ] indicates that the parameter is optional
target_type
Target type on which the comparison job is being submitted. The value should be the internal name. To get the internal name, execute the following EM CLI command:
emcli get_target_types
first_config
Name of the first configuration, which can be either the latest configuration or a saved configuration of a target. If submitting the latest configuration, provide the target name. If submitting a saved configuration, the format should be:
"target_name|saved_configuration_name(which is the "name" field from the output of "emcli get_saved_configs"
second_config
Names of the second and subsequent configurations, which can contain one or more latest configurations and/or one or more saved configurations of one or more targets. Multiple configurations can be specified, separated by a comma. If the latest configuration needs to be submitted, provide the target name. If the saved configuration needs to be submitted, then the format should be:
"target_name|saved_configuration_name(which is the "name" field from the output of "emcli get_saved_configs"
job_name
Name of the comparison job.
schedule
Schedule with which the comparison job must be scheduled. If the schedule option is not provided, the comparison job runs immediately.
start_time - Time when comparison job has to start executing. The format is "yyyy/MM/dd HH:mm"
tz - Timezone ID ( optional )
frequency - Valid values are once/interval/weekly/monthly/yearly. (optional)
If frequency is set to interval, repeat must be specified.
If frequency is set to weekly or monthly, days must be specified.
If frequency is set to yearly, both days and months must be specified.
repeat - Frequency with which the comparison job must be repeated. (Required only if frequency is set to interval.)
days - Comma-separated list of days. (Required only if frequency is weekly, monthly, or yearly.) Example: "repeat=1d"
If frequency is weekly, then the valid range is 1 to 7 inclusive.
If frequency is monthly or yearly, then the valid range is 1 to 30 inclusive.
months - Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive.
end_time - End time for comparison job executions. (optional). If it is not specified, the comparison job runs indefinitely. The format is "yyyy/MM/dd HH:mm"
grace_period - grace period in minutes(optional)
template_id
ID of the template. The value is an integer.
job_description
Description of the comparison job.
mapping_display
Can be either "tree" or "table." The default value is "tree". This option is only for composite targets. Note: When "template_id" is specified, do not specify
mapping_display.
email_address
Email address to which notification mail is to be sent, if differences are found.
save_mode
Tells the comparison engine whether to save all the results or only the differences. Valid inputs are "save_all" and "save_only_diffs". The save_only_diffs option saves the differences to the Management Repository. Otherwise, all the comparison results are saved. The default value is "save_only_diffs".
Once submitted, the comparison job's status can be viewed by issuing the following EM CLI command:
emcli get_jobs -name="jobName"
Once submitted, the comparison job can be aborted by issuing the following EM CLI command:
emcli stop_job -name="jobName"
This example compares the latest configuration of one target to the latest configurations of multiple targets. All the comparison results will be saved.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database","Test_Database"
-job_name="Test Job" -template_id="18"
-save_mode="save_all"
This example compares the latest configuration with the saved configuration specifying a start_time.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database|Test Database|oracle_
database|20140101224530","Test_Database" -job_name="Test Job"
-schedule="start_time:2014/06/10 15:45"
This example compares the latest configuration with the latest configuration specifying a repeating frequency of 1 day.
emcli config_compare -target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database","Test_Database"
-job_name="Test Job"
-schedule="start_time:2014/10/29 2:00;frequency:interval;repeat:1d"
This example compares the latest configuration with the latest configuration specifying a repeating frequency of 1 week.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database","Test_Database"
-job_name="Test Job"
-schedule="start_time:2014/08/10 01:00;frequency:interval;repeat:1w"
This example compares the latest configuration to the latest configuration specifying a repeating frequency of Saturday and Sunday.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database","Test_Database"
-job_name="Test Job"
-schedule="start_time:2014/08/10 01:00;frequency:weekly;
days:6,7;grace_period:60;tz:America/New_York"
Creates a Database as a Service (DBaaS) target for Oracle Public Cloud.
emcli config_db_service_target
-database_unique_name="database unique name"
-service_grp_name="service group name"
-cloud_service_name="cloud service name"
-operation="operation to be performed"
-schema_name="schema name"
-tablespace_name="tablespace name"
[-subscription_id="subscription ID"]
[-customer_name="customer name"]
[-csi_number="CSI number"]
[-connection_service_name="connection service name"]
[-cloud_service_version="cloud service version"]
[-l_o_b="line of business"]
database_unique_name
Identifies the DBName property of a database target on which the DBaaS target will be based.
service_grp_name
Identifies the DBaaS target service group name. The DBaaS target name will be service_grp_name_cloud_service_name.
cloud_service_name
Identifies the Oracle Public Cloud service name.
operation
Identifies the operation to be performed on the DBaaS target (for example, "create").
schema_name
Identifies the name of the schema associated with the DBaaS target.
tablespace_name
Identifies the name of the tablespace associated with the DBaaS target.
subscription_id
Provides a value for the Cost Center property of a DBaaS target.
customer_name
Provides a customer point of contact for the DBaaS target.
csi_number
Identifies the Customer Support Identifier (CSI) of the DBaaS target.
connection_service_name
Identifies the name of the Database Service associated with the DBaaS Target.
cloud_service_version
Shows the Oracle Public Cloud Service version of the DBaaS target.
l_o_b
Identifies the Line of Business (LOB) of the DBaaS target.
Creates a new Database as a Service (DBaaS) target (db_serv1). Specifies the schema, tablespace name, and connection service name. The new DBaaS target is based on a Database target using db.example.com as the DBName property:
emcli config_db_service_target
-database_unique_name="db.example.com"
-service_grp_name="db"
-cloud_service_name="serv1"
-operation="Create"
-schema_name="HR"
-tablespace_name="SYSTEM"
-connection_service_name="nservice1"
Configures Log Archive Locations for the root target and its children. To configure Log Archive Location for a target, you should know the configuration parameters, like host name, from where the log archive files are accessible, the credentials to access the host, and the location of the log archive files.
emcli configure_log_archive_locations
-root_target_name="<target_name>"
-root_target_type="<target_type>"
[-archive_config_file="<target_archive_config_file_location>"]
[-no_update]
[-debug]
[ ] indicates that the parameter is optional.
root_target_name
Name of the root target. A configurable tree target hierarchy will be created with this root target. Example root targets are WebLogic Domain and Fusion Application Instance.
root_target_type
Target type of the root target name.
archive_config_file
Location of the archive config file. Every line in this file should contain the following 7 fields in the same order.
target_name,target_type,host_target_name,host_cred_type,host_cred_name or new_cred_user_name,new_cred_password,archive_dir_location
target_name
If this target is part of the root hierarchy, then this target and it's children will be updated with the archive parameters specified.
target_type
Target type of the above target.
host_target_name
Host name from where archive location is accessible. The Management Agent monitoring this target should have Oracle Fusion Middleware plug-in release 12.1.0.4 or later installed.
host_cred_type
Credential type. Possible values are preferred_credentials or named_credentials or new_credentials.
host_cred_name
Credential set name for preferred_credentials type or Named credential name for named_credentials type.
new_cred_user_name
New credential user name for new_credentials type.
new_cred_password
New credential password for new_credentials type.
archive_dir_location
Directory location where log archive files available.
no_update
If this flag is provided, targets which are already configured with the archive properties, will not be updated again.
debug
Runs the verb in verbose mode for debugging purposes.
The following example configures Log Archive Locations for Fusion Instance target and its children.
emcli configure_log_archive_locations
-root_target_name=fa1
-root_target_type=fusion_apps_instance
-archive_config_file=/scratch/config.txt
Sample Archive Config File:
In the case of new credentials:
fa1,fusion_apps_instance,adc123.oracle.com,new_credentials,user1,pwd1,/scratch/fa1
In the case of preferred credentials:
fa1,fusion_apps_instance,adc123.oracle.com,preferred_credentials,credential_set1,,/scratch/fa1
(Because this is preferred credentials, ',,' means the new_cred_password field is not valid and therefore skipped.)
Configures the limit of Apply lag and Transport lag for all or selected databases of the system.
emcli configure_siteguard_lag
[-system_name="name_of_the_system"]
[-target_name="name_of_the_target_database"]
[-property_name="lag_type"]
[-value="max_limit_in_seconds"]
[ ] indicates that the parameter is optional.
system_name
Name of the system on which lag limits need to be configured.
target_name
Name of the database on which lag limits need to be configured.
property_name
Name of the lag property to be configured. Valid values are ApplyLag and TransportLag.
value
Limit of the lag. These values are specified in seconds.
This example configures the Apply lag limit of 1000 seconds on all of the databases of austin-system:
emcli configure_siteguard_lag
-system_name="austin-system"
-property_name="ApplyLag"
-value="1000"
This example configures the Transport lag limit of 2500 seconds on the database OID-db of austin-system:
emcli configure_siteguard_lag
-system_name="austin-system"
-target_name="OID_db"
-property_name="TransportLag"
-value="2500"
Confirms a manual step. An instance cannot be confirmed when its status is suspended, stopped, completed, or completed with an error.
emcli confirm_instance
[-instance=<instance_guid>]
[exec=<execution_guid>]
[-name=<execution name>]
[-owner=<execution owner>]
-stateguid=<state_guid>
[ ] indicates that the parameter is optional
instance
Instance GUID.
exec
Execution GUID.
name
Execution name.
owner
Execution owner.
stateguid
Comma-separated list of state GUIDs.
Performs resume/continue operations of a previously submitted add host session that has failed at some phase.
emcli continue_add_host
-session_name="session_name"
-continue_all_hosts | -continue_ignoring_failed_hosts"
[-wait_for_completion]
[ ] indicates that the parameter is optional
session_name
Name of the session you want to continue to the next phase of Agent deployment.
continue_all_hosts
Continues the session on all hosts, including those on which the current deployment phase failed.
continue_ignoring_failed_hosts
Continues the session for only the hosts on which the current deployment phase succeeded.
wait_for_completion
Specifies whether the command should run in synchronous or asynchronous mode. If you specify this option (for synchronous mode), the command waits until the add host session completes before returning control to you on the command line.
This example continues the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' to the next phase of deployment on all hosts.
emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -continue_all_hosts
This example continues the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' synchronously to the next phase of deployment only on hosts on which the current phase was successful.
emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -continue_ignoring_failed_hosts -wait_for_completion
Converts a single-instance database to a Real Application Cluster (RAC) database.
emcli convert_to_cluster_database
-sourceTargetName="Single instance database target to be converted to RAC"
-sysdbaCreds="Named credentials for SYSDBA user"
-hostCreds="Named credentials for Host"
[-newOracleHome="RAC Oracle Home, if moving to differnt home"]
[-racConfigType="ADMIN_MANAGED | POLICY_MA NAGED"]
[-nodeList="Comma-separated node names for Admin Managed RAC database"]
[-serverPoolList="Comma-separated list of server pools for Policy Managed
database"]
[-databaseArea="Shared storage location for database files"]
[-recoveryArea="Shared storage location for recovery files"]
[-listenerPort="RAC Listener port"]
[ ] indicates that the parameter is optional
sourceTargetName
Enterprise Manager target name of the single-instance database to be converted to a RAC database. Database versions 10.2.0.1.0 and above are supported for conversion. The single-instance database target should exist on one of the nodes of the cluster where the RAC database will be created, and the cluster should be an Enterprise Manager target.
sysdbaCreds
Named database credentials with SYSDBA privileges on the database to be converted to a RAC database.
hostCreds
Named host credentials of the user who owns the Oracle home installation.
newOracleHome
RAC Oracle home location of the converted database. You only need to provide this if different from the Oracle home of the single-instance database to be converted.
racConfigType
RAC configuration type. Valid values are POLICY_MANAGED and
ADMIN_MANAGED. POLICY_MANAGED is valid only for database versions 11.2 or higher. The default is ADMIN_MANAGED if not provided.
nodeList
List of valid node names for an ADMIN_MANAGED RAC database. It should include the node where the single instance database to be converted exists. If not provided, all the nodes in the cluster are used.
serverPoolList
Comma-separated list of server pool names for a POLICY_MANAGED RAC database. Applicable only for database versions 11.2 or higher.
databaseArea
New location for data files of the RAC database. This location should be shared across the nodes of the cluster. It can either be a Cluster File System location or an Automatic Storage Management diskgroup. If not specified, the existing database files should already be on shared storage, and files are not moved during RAC conversion.
recoveryArea
Fast recovery area location of the RAC database. This location should be shared across the nodes of the cluster. It can either be a Cluster File System location or an Automatic Storage Management diskgroup. If not specified, the existing recovery area location should already be on shared storage, and it does not change during RAC conversion.
listenerPort
Port of the new RAC listener to be created for the new RAC database. If not provided, the existing listener is used. This option is only applicable to 10.2 and 11.1 database versions. For 11.2 or higher database versions, this value is ignored and the RAC database is always registered with the existing listener in the Cloud Infrastructure home.
emcli convert_to_cluster_database -sourceTargetName=sidb -sysdbaCreds=sysCreds -hostCreds=hostCreds racConfigType=ADMIN_MANAGED
emcli convert_to_cluster_database -sourceTargetName=sidb -sysdbaCreds=sysCreds -hostCreds=hostCreds racConfigType=POLICY_MANAGED -serverPoolList=sp1,sp2 -databaseArea=+DATA -recoveryArea=+RECOVERY
emcli convert_to_cluster_database -sourceTargetName=sidb -sysdbaCreds=sysCreds -hostCreds=hostCreds -nodeList=node1,node2 -databaseArea=/u01/share/oradata -recoveryArea=/u01/share/fra -listenerPort=1525
Defines an aggregate service: name and its sub-services. After the aggregate service is created, you can edit it from the Enterprise Manager Cloud Control console to configure performance and usage metrics to be collected and displayed.
emcli create_aggregate_service
-name='name'
-type='type'
-availType=SUB-SERVICE|SYSTEM|TESTS
-add_sub_services="name1:type1;name2:type2;..."
-avail_eval_func=and|or
[-hostName=<host_name>
[-agentURL=<agent_url>
[-properties='pname1|pval1;pname2|pval2;...']
[-timezone_region=<gmt_offset>]
[-systemname=<system_name>]
[-systemtype=<system_type>]
[-keycomponents='keycomp1name:keycomp1type;keycomp2name:keycomp2type;...']
[-beacons='bcn1name:bcn1isKey;bcn2name:bcn2isKey;...']
[-input_file='template:Template_file_name;[vars:Variables_file_name]']
[-sysAvailType=<availability_type>]
[ ] indicates that the parameter is optional
name
Aggregate service name.
type
Aggregate service type.
availType
Sets availability to either sub-service, system-based, or test-based. Valid values are SUB-SERVICE, SYSTEM, and TESTS.
If availability is set to SYSTEM, -systemname and -systemtype are required.
If availability is set to TESTS, -beacons, template file, and variables are required.
add_sub_services
Sub-services list.
avail_eval_func
Operator to evaluate availability. If "and" is used, all sub-services, tests, and system-components must be up in order for this aggregate_service to be up. If "or" is used, only one of the sub-services, tests, and system-components needs to be up for this aggregate_service to be up.
hostName
Network name of the system running the Management Agent that is collecting data for this target instance.
agentURL
URL of the Management Agent that is collecting data for this target instance. If you enter the host name, the Agent URL of the host is automatically entered in this field.
properties
Name-value pair (that is, prop_name|prop_value) list of properties for the service instance.
timezone_region
Accepts either long formats ("America/Los Angeles") or short formats ("PST"). If you do not provide a time zone, the default OMS time zone is used.
systemname
System name on which service resides.
systemtype
Use emcli get_targets to obtain the system type for the system name.
keycomponents
Name-type pair (that is, keycomp_name:keycomp_type) list of key components in the system that are used for the service.
beacons
Name-isKey pairs that describe the beacons of the service. If isKey is set to Y, the beacon is set as a key-beacon of the service. The service should have at least one key beacon if the availability is set to test-based.
input_file
Template file name is the XML file that includes the template definition. Variable file defines the values for the template.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
See below for an example of an XML file for this parameter.
sysAvailType
Type of availability when the availType is system-based. Sets the availability to either SYSTEM_TARGET_DIRECTLY or SELECTED_COMPONENTS_OF_A_SYSTEM.
If availability is set to SYSTEM_TARGET_DIRECTLY, the system needs to have availability[status] defined. -systemname and -systemtype are required parameters.
If availability is set to SELECTED_COMPONENTS_OF_A_SYSTEM, -systemname, -systemtype and -keycomponents are required parameters.
If availability is set to SYSTEM_TARGET_DIRECTLY and if the system does not have availability[status] defined, the availability set is invalid. Therefore, the only option that can be set is SELECTED_COMPONENTS_OF_A_SYSTEM.
emcli create_aggregate_service -name="My_Name"
-type="aggregate_service"
-add_sub_services="sub1:type1;sub2:type2"
-avail_eval_func="and"
-availType="SUB_SERVICE"
-properties="prop1|value1;prop2|value2"
-timezone_region="PST"
emcli create_aggregate_service -name="My_Name"
-type="aggregate_service"
-add_sub_services="sub1:type1;sub2:type2"
-avail_eval_func="or"
-availType="SYSTEM"
-systemname="my system" -systemtype="generic_system"
-sysAvailType="SYSTEM_TARGET_DIRECTLY"
-timezone_region="PST"
emcli create_aggregate_service -name="My_Name"
-type="aggregate_service"
-add_sub_services="sub1:type1;sub2:type2"
-avail_eval_func="and"
-availType="SYSTEM"
-systemname="my system" -systemtype="generic_system"
-sysAvailType="SELECTED_COMPONENTS_OF_A_SYSTEM"
-keycomponents="database:oracle_database;
mytestbeacon:oracle_beacon"
-timezone_region="PST"
emcli create_aggregate_service -name="My_Name"
-type="aggregate_service"
-add_sub_services="sub1:type1;sub2:type2"
-avail_eval_func="or"
-timezone_region="PST"
-availType="TESTS"
-beacons="MyBeacon:Y;MyOtherBeacon:N"
-properties="prop1|value1;prop2|value2"
-input_file="template:mytests.xml"
-input_file="variables:myvariable.xml"
The following sample XML file creates a service test of name 'EM Console Service Test' and of type 'Web Transaction'. It defines some properties, such as readTimeout, Collection Interval, and so forth under the <properties> section, which are related to this service test.
This service test has defined step information under <mgmt_bcn_step_with_props>. The name of the step is '1.Access Logout page'. The URL to be monitoried under this step is https://myhost.in.domain.com:14513/em/console/logon/logoff?event=load, which is defined under the properties section of the step.
This XML file also defines some threshold levels for this service test on the transaction level under <txn_thresholds>. For the metric avg_response_time, it states that if the metric value is greater than 6000.0, raise a warning alert, and if the metric value is greater than 12000.0, raise a critical alert.
<?xml version = '1.0' encoding = 'UTF-8'?> <transaction-template template_type="aggregate_service" xmlns="template">
<variables>
<variable name="HOST1" value="myhost.in.domain.com"/>
<variable name="PORT1" value="14513"/>
<variable name="PROTOCOL1" value="https"/>
</variables>
<transactions>
<mgmt_bcn_transaction>
<mgmt_bcn_txn_with_props>
<mgmt_bcn_txn description="Test for checking the availability of EM Console/Website" is_representative="true" name="EM Console Service Test" monitoring="true" txn_type="HTTP"/>
<properties>
<property name="readTimeout" num_value="120000.0" prop_type="2" encrypt="false"/>
<property name="certValidationMode" string_value="1" prop_type="1" encrypt="false"/>
<property name="maxDownloadSize" num_value="1.0E8" prop_type="2" encrypt="false"/>
<property name="sensitiveValuesProtection" string_value="0" prop_type="1" encrypt="false"/>
<property name="failureStringModes" string_value="regularText" prop_type="1" encrypt="false"/>
<property name="UserAgent" string_value="Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) OracleEMAgentURLTiming/3.0" prop_type="1" encrypt="false"/>
<property name="successStringModes" string_value="regularText" prop_type="1" encrypt="false"/>
<property name="variablesModes" string_value="urlEncode" prop_type="1" encrypt="false"/>
<property name="content" string_value="0" prop_type="1" encrypt="false"/>
<property name="AcceptLanguage" string_value="en" prop_type="1" encrypt="false"/>
<property name="connectionTimeout" num_value="120000.0" prop_type="2" encrypt="false"/>
<property name="useCache" string_value="yes" prop_type="1" encrypt="false"/>
<property name="stringValidationMode" string_value="1" prop_type="1" encrypt="false"/>
<property name="granularity" string_value="transaction" prop_type="1" encrypt="false"/>
<property name="numThreads" num_value="4.0" prop_type="2" encrypt="false"/>
<property name="retries" num_value="1.0" prop_type="2" encrypt="false"/>
<property name="timeout" num_value="300000.0" prop_type="2" encrypt="false"/>
<property name="retryInterval" num_value="5000.0" prop_type="2" encrypt="false"/>
</properties>
<per_bcn_properties/>
</mgmt_bcn_txn_with_props>
<steps_defn_with_props>
<mgmt_bcn_step_with_props>
<mgmt_bcn_step step_number="1" name="1.Access Logout page" step_type="HTTP"/>
<properties>
<property name="req_mode" num_value="1.0" prop_type="2" encrypt="false"/>
<property name="http_method" string_value="G" prop_type="1" encrypt="false"/>
<property name="url" string_value="{PROTOCOL1}://{HOST1}:{PORT1}/em/console/logon/logoff?event=load" prop_type="1" encrypt="false"/>
</properties>
</mgmt_bcn_step_with_props>
</steps_defn_with_props>
<stepgroups_defn/>
<txn_thresholds>
<mgmt_bcn_threshold warning_threshold="6000.0" warning_operator="0" critical_threshold="12000.0" critical_operator="0" num_occurrences="1">
<mgmt_bcn_threshold_key metric_name="http_response" metric_column="avg_response_time"/>
</mgmt_bcn_threshold>
<mgmt_bcn_threshold warning_threshold="0.0" warning_operator="1" critical_threshold="0.0" critical_operator="1" num_occurrences="1">
<mgmt_bcn_threshold_key metric_name="http_response" metric_column="status"/>
</mgmt_bcn_threshold>
</txn_thresholds>
<step_thresholds/>
<stepgroup_thresholds/>
</mgmt_bcn_transaction>
</transactions>
</transaction-template>
Creates target association instances.
emcli create_assoc
-assoc_type="association type"
-source="source"
-dest="destination_target"
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
create_assoc(
assoc_type="association type"
,source="source"
,dest="destination_target"
[,separator="separator:attribute_name:character"]
[,subseparator="subseparator:attribute_name:character"]
)
[ ] indicates that the parameter is optional.
source_type
Source target type.
source
Source target.
dest
Destination target.
separator
By default, multi-value input attributes use a semicolon ( ; ) as a separator. Specifying this option overrides the default separator value.
Example: separator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new separator character.Example: separator="att=#"
subseparator
By default, multi-value input attributes use a colon ( : ) as a subseparator. Specifying this option overrides the default subseparator value.
Example: subseparator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character and sep_char is the new subseparator character.Example: separator="att=#"
Note:
The name and owner parameters must be used together.0 indicates that the verb processing was successful.
Non-zero values indicate that the verb processing was not successful.
This example creates an association of type cluster_contains from target "abc_cluster:cluster" to targets "def.oracle.com:host" and "ghi.oracle.com:host":
emcli create_assoc
-assoc_type="cluster_contains"
-source="abc_cluster:cluster"
-dest="def.oracle.com:host;ghi.oracle.com:host"
For a list of allowed pairs, enter emcli list_allowed_pairs .
Creates a scheduled blackout to suspend any data collection activity on one or more monitored targets.
emcli create_blackout
-name="name"
-add_targets="name1:type1;name2:type2;..."...
-reason="reason"
[-description="description"]
[-jobs_allowed]
[-propagate_targets]
-schedule=
frequency:once|interval|weekly|monthly|yearly];
duration:[HH...][:mm...];
[start_time:yy-MM-dd HH:mm];
[end_time:yy-MM-dd HH:mm];
[repeat:#m|#h|#d|#w];
[months:#,#,...];
[days:#,#,...];
[tzinfo:specified|target|repository]
[tzoffset:#|[-][HH][:mm]]
[tzregion:...]
[ ] indicates that the parameter is optional
Constraints on schedule arguments:
frequency:once
requires => duration or end_time
optional => start_time, tzinfo, tzoffset
frequency:interval
requires => duration, repeat
optional => start_time, end_time, tzinfo, tzoffset
frequency:weekly
requires => duration, days
optional => start_time, end_time, tzinfo, tzoffset
frequency:monthly
requires => duration, days
optional => start_time, end_time, tzinfo, tzoffset
frequency:yearly
requires => duration, days, months
optional => start_time, end_time, tzinfo, tzoffset
name
Name of the blackout to create.
add_targets
Targets to add to the blackout, each specified as target_name:target_type. You can specify this parameter more than once.
reason
Reason for the blackout. If you have SUPER_USER privileges (you are an Enterprise Manager Super Administrator), any text string can be used for the reason. The reason is added to the list of allowable blackout reasons if it is not already in the list. If you do not have SUPER_USER privileges, you must specify one of the text strings returned by the get_blackout_reasons verb.
description
Description or comments pertaining to the blackout. The description, limited to 2000 characters, can be any text string.
jobs_allowed
When you specify this option, jobs are allowed to run against blacked-out targets during the blackout period. If you do not specify this option, jobs scheduled to be run against these targets are not allowed to run during the blackout period. After a blackout has been created, you cannot change the "allowed jobs" from either EM CLI or the Enterprise Manager Cloud Control console.
propagate_targets
When you specify this option, a blackout for a target of type "host" applies the blackout to all targets on the host, including the Agent. This is equivalent to nodelevel in the emctl command. Regardless of whether you specify this option, a blackout for a target that is a composite or a group applies the blackout to all members of the composite or group.
schedule
Blackout schedule. Note that the "frequency" argument determines which other arguments are required or optional.
schedule=frequency
Type of blackout schedule (default is "once").
schedule=duration
Duration in hours and minutes of the blackout (-1 means indefinite). Hours and minutes each can be up to 6-digits long.
schedule=start_time
Start date/time of the blackout. The default value is the current date/time. The format of the value is "yy-MM-dd HH:mm", for example: "2003-09-25 18:34"
schedule=end_time
Last date/time of the blackout. When "frequency" is weekly, monthly, or yearly, only the date portion is used. When "frequency" is interval or once, the date and time are taken into account. The format of the value is "yy-MM-dd HH:mm"; for example: "2003-09-25 18:34"
schedule=repeat
Time between successive start times of the blackout. The letter following the number value represents the time units: "m" is minutes, "h" is hours, "d" is days, and "w" is weeks.
schedule=months
List of integer month values in the range 1-12. Each value must have a corresponding "day" value to fully specify (month, day) pairs that indicate the blackout starting days of the year.
schedule=days
When "frequency" is weekly, this is a list of integer day-of-week values in the range 1-7 (1 is Sunday). When "frequency" is monthly, this is a list of integer day-of-month values in the range 1-31 or -1 (last day of the month). When "frequency" is yearly, this is a list of integer day-of-month values in the range 1-31 or -1 (last day of the month); in this case, the month is taken as the corresponding "month" value for each (month, day) pair.
schedule=tzinfo
Type of timezone. The tzinfo argument is used in conjunction with tzoffset. Available timezone types are: "specified" (offset between GMT and the target timezone), "target" (timezone of the specified target), and "repository" (repository timezone -- default setting when tzinfo is not specified). See -schedule=tzoffset for more information.
schedule=tzoffset
Value of the timezone. When the tzinfo argument is not specified or is "repository", the timezone value is the repository timezone. In this case, the tzoffset argument must not be specified. Otherwise, the tzoffset argument is required. When tzinfo is set to "specified", the tzoffset argument specifies the offset in hours and minutes between GMT and the timezone. When tzinfo is set to "target", the tzoffset argument specifies an integer index (the first is 1) into the list of targets passed as arguments. For example, for a tzoffset setting of 1, the timezone of the first target specified in the -add_targets parameter is used.
Note that the timezone is applied to the start time and the end time of the blackout periods. The timezones associated with each target are not taken into account when scheduling the blackout periods (except that when tzinfo is set to "target", the specified target's timezone is used for the blackout times).
schedule=[tzregion:<...>]
Time zone region to use. When you "specify" the tzinfo parameter, this parameter determines which timezone to use for the blackout schedule. Otherwise, it is ignored. It defaults to "GMT".
This example creates blackout b1 for the specified target (database2) to start immediately and last for 30 minutes.
emcli create_blackout -name=b1 -add_targets=database2:oracle_database
-schedule="duration::30"
-reason="good reason1"
This example creates blackout b1 for all targets on myhost to start immediately and last until 2007-04-26 05:00 (in the timezone America/New_York).
emcli create_blackout -name=b1 -add_targets=myhost:host
-propagate_targets -jobs_allowed
-schedule="end_time:2007-04-26 05:00;tzinfo:specified;
tzregion:America/New_York"
-reason="good reason2"
This example creates blackout b1 for all targets in group mygroup to start immediately and last until 2007-04-26 05:00 (in the timezone America/New_York). No jobs are allowed to run during the blackout.
emcli create_blackout -name=b1 -add_targets=mygroup:group
-schedule="end_time:2007-04-26 05:00;tzinfo:specified;
tzregion:America/New_York"
-reason="good reason3"
This example creates blackout b1 for the specified targets (database2 and database3) to start at 2007-08-24 22:30 and last for 30 minutes. The timezone is the timezone for the database2 target.
emcli create_blackout -name=b1
-add_targets="database2:oracle_database;database3:oracle_database
-schedule="frequency:once;start_time:07-08-24 22:30;duration::30;tzinfo:target:tzoffset:1"
-reason="good reason4"
This example creates blackout b1 for the specified targets (database2 and database3) to start at 2007-08-24 22:30 and last for 30 minutes. The timezone is the timezone for the database3 target.
emcli create_blackout -name=b1 -add_targets=database2:oracle_database
-add_targets=database3:oracle_database
-schedule="frequency:once;start_time:07-08-24 22:30;duration::30;tzinfo:target;tzoffset:2"
-reason="good reason5"
This example creates blackout b2 for the specified target (database2) to start at 2007-08-25 03:00 and every day thereafter, and to last 2 hours each time. The timezone is the repository timezone.
emcli create_blackout -name=b2 -add_targets=database2:oracle_database
-schedule="frequency:interval;start_time:2007-08-25 03:00;duration:2;repeat=1d"
-reason="good reason"
This example creates blackout b2 for the specified target (database2) to start immediately and every 2 days thereafter (until 06-12-31 23:59), and to last 2 hours 5 minutes each time. The timezone is the repository timezone.
emcli create_blackout -name=b2 -add_targets=database2:oracle_database
-schedule="frequency:interval;duration:2:5;end_time:06-12-31 23:59;repeat=2d;tzinfo:repository"
-reason="another good reason"
This example creates blackout b4 for all targets on myhost and otherhost to start every Sunday through Thursday at the current time. The blackout will last 1 hour each time.
emcli create_blackout -name=b4 -add_targets="myhost:host;otherhost:host"
-propagate_targets
-schedule="frequency:weekly;duration:1:;days:1,2,3,4,5"
-reason="very good reason"
This example creates blackout b5 for all targets within group mygroup to start on the 15th and last day of each month at time 22:30 and last until 2011-11-24 (2011-11-15 will be the actual last blackout date). The blackout will last 1 hour 10 minutes each time. Jobs are allowed to run during the blackouts.
emcli create_blackout -name=b5 -add_targets=mygroup:group
-propagate_targets -jobs_allowed
-schedule="frequency:monthly;duration:1:10;start_time:06-10-24 22:30;
end_ time:06-12-24 23:59:days:15,-1"
-reason="pretty good reason"
This example creates blackout b6 for the specified target (database2) to start at 13:30 on the following dates of each year: 03-02, 04-22, 09-23. The blackout will last 2 hours each time. Jobs are not allowed to run during the blackouts.
emcli create_blackout -name=b6 -add_targets=database2:oracle_database
-propagate_targets
-schedule="frequency:yearly;duration:2;start_time:07-08-24 13:30:months=3,4,9;days:2,22,23"
-reason="most excellent reason"
Creates a custom entity type for an Enterprise Manager target type for which there is no current Chargeback support. There can be only one custom entity type for the specified Enterprise Manager target type.
Creates a custom charge item for Chargeback based on the properties specified in the referenced file.
The option [-input_file] is the full path of a file that contains the item properties. The following properties can be defined in the file:
target_type
Target type to which the charge item applies.
source_data_type
Source data type. Valid values are metric, config, and property.
item_name
Name of the item.
metric_group
Metric group name as listed in list_item_candidates. This is a required property if source_data_type=metric.
metric_column
Metric column name as listed in list_item_candidates. This is a required property if source_data_type=metric.
config_view
Config view name as listed in list_item_candidates. This is a required property if source_data_type=config.
config_key
Config key name as listed in list_item_candidates. This is a required property if source_data_type=config.
config_column
Config column name as listed in list_item_candidates. This is a required property if source_data_type=config.
config_data_source
Data source of configuration metric. This is a required property if source_data_type=config.
property
Property name as listed in list_item_candidates. This is a required property if source_data_type=property.
item_displayname
Item display name.
unit
Unit display name.
aggregation_type
Type of aggregation to use for this item. Applicable only if data type=number. Valid values are sum and avg. Default value is avg.
is_config_condition
Item used conditionally in a charge plan. Valid values are 0, 1. Default value is 0.
item_category
Category of item. Default value is instance. Valid values are cpu, storage, memory, network, and instance.
data_type
Valid values are string and number. The default value is string for config and property types, and number for metric type.
This example creates a metric custom charge item that bases charges on the average total of processes on a particular host:
emcli create_charge_item -input_file="property_file:/home/user/property_file"
Contents of /home/user/property_file:
target_type=host
source_data_type=metric
item_name=total_proc
metric_group=Load
metric_column=noOfProcs
item_displayname=Total Processes
unit=process
aggregation_type=avg
item_category=instance
data_type=number
This example creates a configuration custom charge item that can charge different rates for various usage charge items based on the instance region:
emcli create_charge_item -input_file="property_file:/home/user/property_file"
Contents of /home/user/property_file:
target_type=oracle_database
source_data_type=config
item_name=custom_config
config_view=myCustomCCS
config_key=region
config_column=country
config_data_source=regionList.txt
item_display_name=Region of Instance
item_category=instance
data_type=string
Creates a new cloned database.
inputFile
The location and name of the file containing the properties required for cloning the database.
Creates a new credential set. Only Enterprise Manager Super Administrators can create new credential sets.
emcli create_credential_set
-set_name="set_name"
-target_type="ttype"
-supported_cred_types="supported_cred_types"
-monitoring
[-auth_target_type = "authenticating_target_type"
[-description ="description]"
[ ] indicates that the parameter is optional
set_name
Credential set name to be created.
target_type
Target type of the new credential set.
supported_cred_types
Credential types supported by this credential set. You can list the available credential types by using the command show_credential_type_info.
monitoring
Creates a monitoring credential set.
auth_target_type
Target type for the supported cred types. The default value is target_type.
description
Description of the credential set.
Creates a custom plug-in update using a plug-in that is already deployed to a Management Agent. Includes all of the patches that were applied to the source plug-in. Use this in place of Oracle-supplied plug-in versions for all subsequent plug-in deployments on any Management Agent.
emcli create_custom_plugin_update
-agent_name="agent_name"
-plugin_id="plugin_id"
[-overwrite]
[ ] indicates that the parameter is optional.
agent_name
Management Agent (host:port) on which the plug-in and its patches are deployed.
plugin_id
ID of the plug-in that should be used for creating the custom plug-in update. To view a list of plug-ins deployed on a Management Agent, run 'emcli list_plugins_on_agent'.
overwrite
Overwrites and updates an existing custom plug-in update, if a custom plug-in update already exists for that plug-in in the repository. If not provided, the new custom plug-in update is not created for that plug-in. Applies only for subsequent plug-in deployments. Does not automatically redeploy on the Management Agents where the source plug-in was previously deployed. To redeploy on such Management Agents, run 'emcli redeploy_plugin_on_agent'.
Example 1
The following example creates a custom plug-in update for the oracle.sysman.db plug-in that is already deployed on the Management Agent named host.example.com. If a custom plug-in update already exists for the oracle.sysman.db plug-in, then the command does not overwrite it, and therefore, does not create a new custom plug-in update.
emcli create_custom_plugin_update
-agent_name="host.example.com"
-plugin_id="oracle.sysman.db"
Example 2
The following example creates a custom plug-in update for the oracle.sysman.db plug-in, which is already deployed on the Management Agent named host.example.com, by overwriting and updating the custom plug-in update that already exists for the oracle.sysman.db plug-in in the repository.
emcli create_custom_plugin_update
-agent_name="host.example.com"
-plugin_id="oracle.sysman.db"
-overwrite
Creates a database.
emcli create_database
[-dbType="type_of_database"]
[-hostTargets="list_of_host_targets"]
[-cluster="cluster_target_name"]
-oracleHome="Oracle_Home_location"
-gdbName="global_database_name"
-templateName="path_and_display_name_of_the_software_library_entity"
-hostCreds="named_credential_for_OS_user"
-sysCreds="named_credential_for_SYS_user"
-systemCreds="named_credential_for_SYSTEM_user"
-dbsnmpCreds="named_credential_for_DBSNMP_user"
[-sid="database_system_identifier"]
[-racConfigType="RAC_configuration_type"]
[-nodeList="comma-separated_node_names"]
[-serverPoolList="comma-separated_list_of_server_pools"]
[-newServerPool="new_server_pool_name_and_cardinality"]
[-racOneServiceName="service_name_for_RAC_one-node_database"]
[-templateInSwlib="TRUE|FALSE"]
[-templateStageLocation="temporary_directory_on_agent_side"]
[-storageType="FS|ASM"]
[-dataFileLocation="Location_of_data_files "]
[-recoveryAreaLocation="Fast_Recovery_Area_location "]
[-enableArchiving]
[-useOMF]
[-listeners="comma-separated_list_of_listeners_database"]
[-newListener="new_listener_and_port"]
[ ] indicates that the parameter is optional
dbType
Type of database that needs to be created. Valid values are:
SINGLE_INSTANCE —To create a database on one particular host or a list of hosts.
RAC — To create a cluster database on multiple nodes.
RACONE — To create a RAC One-node database.
RAC and RACONE require the use of the cluster parameter.
hostTargets
Comma-separated list of host targets where a single-instance database needs to be created. This is a mandatory parameter for a SINGLE_INSTANCE database.
cluster
Cluster target name for the RAC database on which a cluster needs to be created. The target name should be valid and should have at least one node attached to the target. This is a mandatory parameter for RAC and RACONE databases.
oracleHome
Oracle home of the host targets or cluster target. The Oracle home should be present in all of the targets.
gdbName
Global database name of the database.
templateName
Fully-qualified path and display name of the software library entity.
hostCreds
Named host credentials of the user who owns the Oracle Home installation.
sysCreds
Named database credentials to be used to create the SYS user.
systemCreds
Named database credentials to be used to create the SYSTEM user.
dbsnmpCreds
Named database credentials to be used to create the DBSNMP user.
sid
Database system identifier., which can be a maximum length of 12 for SINGLE_INSTANCE, 8 otherwise. This should be alphanumeric, with the first character being an alpha character.
racConfigType
RAC configuration type. Valid values are:
POLICY_MANAGED
ADMIN_MANAGED
The default is ADMIN_MANAGED if not provided.
nodeList
List of valid node names for ADMIN_MANAGED RAC databases. If not provided, all the nodes for the given cluster target are used.
serverPoolList
Comma-separated list of server pool names for POLICY_MANAGED RAC databases.
newServerPool
Note:
You can either use serverPoolList or newServerPool, but not both. For newServerPool, cardinality is mandatory and should be a positive integer greater than 0.racOneServiceName
Service name for the RAC One Node database.
templateInSwlib
Boolean value stating whether the template is from the software library. Valid values are TRUE if the template is from the software library, otherwise FALSE. The default is FALSE if you do not provide this parameter.
templateStageLocation
Fully-qualified path to where the template should be staged on the host target.
storageType
Type of storage preferred for the database. Valid values are:
FS for File System. This is the default if the parameter is not provided.
ASM for Automatic Storage Management.
dataFileLocation
Location of the data files.
recoveryAreaLocation
Fast Recovery Area location.
enableArchiving
Indicates whether archiving of the database is required. Valid values are TRUE if archiving is required, otherwise FALSE. The default is FALSE.
useOMF
Indicates whether to use Oracle Managed Files.
listeners
Comma-separated list of listeners (name:port) to register the created database. This is for the SINGLE_INSTANCE database type only, and will be ignored for a RAC database.
newListener
New listener (name:port) creates a new listener and registers the database. This is for the SINGLE_INSTANCE database type only, and will be ignored for a RAC database.
emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=host_named
-sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/
dbhome_2/assistants/dbca/templates/General_Purpose.dbc
-dbType=SINGLE_INSTANCE -hostTargets=host1
emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=host_named
-sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/
dbhome_2/assistants/dbca/templates/General_Purpose.dbc
-dbType=SINGLE_INSTANCE -hostTargets=host1 -newListener=NEWLSNR:1527
emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testRACCli -hostCreds=cluster_named -sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp
-templateName=/u01/app/oracle/product/11.2.0/
dbhome_2/assistants/dbca/templates/General_Purpose.dbc -dbType=RAC -cluster=cluster1
-dataFileLocation=/u01/share/oradata -recoveryAreaLocation=/u01/share/fra
emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=cluster_named
-sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/
dbhome_2/assistants/dbca/templates/General_Purpose.dbc
-dbType=RAC -cluster=cluster1 -racConfigType=POLICY_MANAGED -newServerPool=sp1:2
Specify a database size that overrides values specified in the service template.
emcli create_database_size -name="<size name>" -description="<size description>" [-attributes="cpu:<number of cores>;memory:<memory in GB>;processes:<max number of processes>;storage:<Total Storage in GB allocated to database>;"] [-source_type="Profile Source"] [ ] indicates that the parameter is optional.
Note: Use one or more attributes to specify the database size. The different attributes must be separated by a semicolon (; ). Attributes specified using the database_size verb override values specified in the service template.
name
Creates a name for the database size.
description
Creates a description for the database size.
attributes
Defines the database size. Attributes must be separated by a semicolon(;). You can specify values for the following attributes:
cpu: Total number of cpu cores.
memory: Total maximum in GB.
processes: Total number of processes that can simultaneously connect to the database.
storage: Total storage that is allocated to the database (in GB)
Creates a new database profile.
emcli create_dbprofile
-input_file=data:"file:path"
[-schedule=
[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{timezone ID}];
[grace_period:xxx];
]
[-purge_policy=DAYS|SNAPSHOTS: number]
[ ] indicates that the parameter is optional.
input_file
A property file which completely describes the type of profile that will be created and the options used.
schedule
frequency: Frequency type with which the Database Profile will be created. It can be interval(in minutes), weekly, monthly or yearly
start_time: Denotes the starting time of Database Profile Component creation in the format yy-MM-dd HH:mm
end_time: Denotes the end time of Database Profile Component Creation Repetition in the format yy-Mm-dd HH:mm
repeat: Repetition rate at which Database Profile will be created. If the frequency is interval, then repeat will be in minutes
months: Number of months after which repetition of Database Profile Component Creation will occur
days: Number of days after which repetition of Database Profile Component Creation will occur
tz: Time Zone ID for example tz:America/New_York
grace_period: A period of time in minutes that defines the maximum permissible delay when attempting to create a Databasse Profile. If the job system cannot start the execution within a time period equal to the scheduled time + grace period, it will set the create Database Profile to be skipped.By default, grace period is indefinite
purge_policy
You can purge the collected data based on number of days or count of snapshots. If you do not specify purge_policy, it is defaulted to NONE. Allowed values: DAYS, SNAPSHOT
DAYS specify the number of days after which the data component should be purged.
SNAPSHOT specify the count or number of data components, after which older data will be purged
The following example creates a new database profile based on the property file "profile.txt" with the specified schedule and purge policy.
emcli create_dbprofile -input_file="data:/tmp/profile.txt" -schedule="frequency:interval;start_time:14-10-05 05:30;end_time:14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York" -purge_policy=DAYS:2
Creates a database quota for an SSA user role.
emcli create_dbaas_quota
-role_name="<SSA user role name>"
-databases="<number of database requests>"
-schema_services="<number of schema service requests>"
-pluggable_databases="<number of Pluggable database service requests>"
-memory="<memory(GB)>"
-storage="<storage(GB)>"
[ ] indicates that the parameter is optional.
role_name
Name of the SSA user role for which the quota is to be created.
databases
Number of database service requests allowed. For example, for 10 requests enter:
-databases="10"
schema_services
Number of schema service requests allowed. For example, for 10 requests enter:
-schema_services="10"
pluggable_databases
Number of pluggable database service requests allowed. For example, for 10 requests enter:
-pluggable_databases="10"
memory
Amount of memory usage allowed. For example, for 10 GB enter:
-memory="10"
storage
Amount of storage usage allowed. For example, for 10 GB enter:
-storage="10"
Creates a new database profile.
emcli create_dbprofile
-input_file=data:"file:path"
[-schedule=
[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{timezone ID}];
[grace_period:xxx];
]
[-purge_policy=DAYS|SNAPSHOTS: number]
[ ] indicates that the parameter is optional.
input_file
A property file which completely describes the type of profile that will be created and the options used.
schedule
frequency: Frequency type with which the database profile will be created. It can be interval (in minutes), weekly, monthly, or yearly.
start_time: Denotes the starting time of database profile component creation in the format yy-MM-dd HH:mm.
end_time: Denotes the end time of database profile component creation repetition in the format yy-Mm-dd HH:mm.
repeat: Repetition rate at which the database profile will be created. If the frequency is interval, then repeat is in minutes.
months: The number of months after which repetition of Database Profile Component Creation will occur.
days: The number of days after which repetition of Database Profile Component Creation will occur.
tz: Time zone ID for example tz:America/New_York.
grace_period: A period of time in minutes that defines the maximum permissible delay when attempting to create a databasse profile. If the job system cannot start the execution within a time period equal to the scheduled time + grace period, it sets the create database profile to be skipped. By default, the grace period is indefinite.
purge_policy
The policy that specifies how you can purge the collected data based on number of days or count of snapshots. If you do not specify purge_policy, it is defaulted to NONE. The allowed values are DAYS, SNAPSHOT.
DAYS specifies the number of days after which the data component should be purged.
SNAPSHOT specifies the count or number of data components, after which older data will be purged.
The following example creates a new database profile based on the property file "profile.txt" with the specified schedule and purge policy:
emcli create_dbprofile -input_file="data:/tmp/profile.txt" -schedule="frequency:interval;start_time:14-10-05 05:30;end_time:14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York" -purge_policy=DAYS:2
Creates a diagnostic snapshot for specified targets.
emcli create_diag_snapshot
-name=<name>
-desc=<description>
-start_time=<yyyy/MM/dd HH:mm>
-end_time=<yyyy/MM/dd HH:mm>
-targets=<type1:name1;type2:name2;…>
[-diag_type_odl_target_types=<type1;type2; ….>]
[-diag_type_odl_online_logs=<true|false>]
[-diag_type_odl_offline_logs=<true|false>]
[-diag_type_jvmd_target_types=<type1;type2; ….>]
[-diag_type_jvmd_properties=”<pname1:pval1;pname2:pval2;…>”]
[-debug]
[ ] indicates that the parameter is optional
name
Name of diagnostic snapshot to be created. Make sure that a diagnostic snapshot does not exists for the specified name.
desc
Description of the diagnostics snapshot.
start_time
Start time for collecting the logs. The snapshot will contain all logs between the start time and end time. Make sure that the duration is valid for the snapshot.
end_time
End time for collecting the logs. The snapshot will contain all logs between the start time and end time. Make sure that the duration is valid for the snapshot.
targets
Target type and target name list for the snapshot. This list can contain all targets for the specific system. User can choose specific target types in optional parameters for selected diagnostic types.
diag_type_odl_target_types
Target type list for the Oracle Diagnostic Logging (ODL) diagnostic type. You can select a subset of target types from the target list for snapshot creation.
diag_type_odl_online_logs
By default, online logs are collected for a snapshot. You can choose to collect online, offline, or both logs for the Oracle Diagnostic Logging (ODL) diagnostic type.
diag_type_odl_offline_logs
By default, offline/archive logs are not collected for a snapshot. You can choose to collect online, offline, or both logs for the Oracle Diagnostic Logging (ODL) diagnostic type.
diag_type_jvmd_target_types
Target type list for the JVMD diagnostic type. You can select a subset of target types from the target list for snapshot creation.
diag_type_jvmd_properties
Properties list to collect logs for the JVMD diagnostic type.
debug
Runs the verb in verbose mode for debugging purposes.
This example creates a snapshot for EMGC_DOMAIN and EMGC_OMS1 targets with offline logs. The target types (weblogic_domain and weblogic_j2eeserver) belong to the Oracle Diagnostic Logging (ODL) diagnostic type.
emcli create_diag_snapshot
–name=wls_snapshot
–desc= ”Snapshot for Weblogic Domains and Server”
–start_date=”2012/10/02 10:30”
-end_date=”2012/10/03 22:30”
–targets=”weblogic_domain:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN;
weblogic_j2eeserver: /EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1”
This example creates a snapshot for the weblogic_j2eeserver target type with offline logs. You can filter the target types on top of the target list.
emcli create_diag_snapshot
–name=wls_snapshot
–desc=”Snapshot for Weblogic Domains and Server”
–start_date=”2012/10/02 10:30”
-end_date=”2012/10/03 22:30”
–targets=”weblogic_domain:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN;
weblogic_j2eeserver:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1;
weblogic_j2eeserver:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_ADMIN_SERVER”
-diag_type_odl_target_types=”weblogic_j2eeserver”
-diag_type_odl_offline_logs=true
Creates a Fusion Middleware provisioning profile from a WebLogic Domain.
emcli create_fmw_domain_profile
-name="profile_name"
-ref_target="reference_target_name"
[-description="profile_description"]
[-oh_cred="Oracle_home_owner_credentials"]
[-includeOh]
[-schedule=
start_time:yyyy/MM/dd HH:mm;
[tz:{java_timezone_ID}];
[grace_period:xxx];
]
[ ] indicates that the parameter is optional
name
Name of the profile to be created.
ref_target
Name of the WebLogic Domain target to be used as a reference to create the profile.
description
Description of the profile to be created.
oh_cred
Named credential to be used to access the reference host. The format is:
CREDENTIAL_NAME:CREDENTIAL_OWNER
All operations are performed on the Administration Server host. Credentials of the Oracle Home owner on the Administration Server host are required. If no named credential is provided, preferred host credentials for the Oracle Home target are used.
includeOh
Includes the Oracle Home binaries in the profile.
schedule
Schedule for the Deployment Procedure. If not specified, the procedure executes immediately.
start_time: Time when the procedure should start.
tz: Time zone ID.
grace_period: Grace period in minutes.
This example creates a WebLogic Domain profile for the specified schedule from the given WebLogic Domain target using preferred credentials.
emcli create_fmw_domain_profile
-name="BitlessDomainProfile"
-ref_target="/Farm01_base_domain/base_domain"
-description="A domain profile without software bits"
-schedule="start_time:2014/6/21 21:23;tz:America/New_York;grace_period:60"
This example immediately creates a WebLogic Domain plus Oracle Home from the given WebLogic Domain target using given named credentials.
emcli create_fmw_domain_profile
-name="DomainProfileWithBits"
-ref_target="/Farm01_base_domain/base_domain"
-oh_cred="MY_HOST_CRED:SYSMAN"
-includeOh
Creates a Fusion Middleware provisioning profile from an Oracle Home.
emcli create_fmw_home_profile
-name="profile_name"
-ref_target="reference_target_name"
[-description="profile_description"]
[-oh_cred="Oracle_home_owner_credentials"]
[-schedule=
start_time:yyyy/MM/dd HH:mm;
[tz:{java timezone ID}];
[grace_period:xxx];
]
[ ] indicates that the parameter is optional
name
Name of the profile to be created.
ref_target
Name of the Oracle Home target to be used as a reference to create the profile.
description
Description of the profile to be created.
oh_cred
Named credential to be used to access the reference host. The format is:
CREDENTIAL_NAME:CREDENTIAL_OWNER
If no named credential is provided, preferred host credentials for the Oracle Home target are used.
schedule
Schedule for the Deployment Procedure. If not specified, the procedure executes immediately.
start_time: Time when the procedure should start.
tz: Time zone ID.
grace_period: Grace period in minutes.
This example creates a profile on the specified schedule from the given Oracle Home target using preferred credentials.
emcli create_fmw_home_profile
-name="OhProfile1"
-ref_target="/Farm01_base_domain/base_domain"
-description="An Oracle Home profile"
-schedule="start_time:2014/6/21 21:23;tz:America/New_York;grace_period:60"
This example immediately creates a profile from the given Oracle Home target using given named credentials.
emcli create_fmw_home_profile
-name="OhProfile2"
-ref_target="WebLogicServer_10.3.6.0_myhost.mycompany.com_5033"
-oh_cred="MY_HOST_CRED:SYSMAN"
Defines a group name and its members. After you create the group, you can edit it from the Enterprise Manager Cloud Control console to configure Summary Metrics to be displayed for group members.
emcli create_group
-name="name"
[-type=<group>]
[-add_targets="name1:type1;name2:type2;..."]...
[-is_propagating="true/false"]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
create_group
(name="name"
[,type=<group>]
[,add_targets="name1:type1;name2:type2;..."]...
[,is_propagating="true/false"])
[ ] indicates that the parameter is optional
name
Name of the group.
type
Group type: group. Defaults to "group".
add_targets
Add existing targets to the group. Each target is specified as a name-value pair target_name:target_type. You can specify this option more than once in command-line format.
is_propagating
Flag that indicates whether or not privilege on the group will be propagated to member targets. The default is false.
These examples create a database-only group named db_group. This group consists of two Oracle databases: emp_rec and payroll.
emcli create_group
-name=db_group
-add_targets="emp_rec:oracle_database"
-add_targets="payroll:oracle_database"
Example 2 - Scripting and Interactive
create_group
(name="db_group"
,add_targets="emp_rec:oracle_database;payroll:oracle_database")
These examples create a mixed member-type group named my_group that consists of an Oracle database (database2), listener (dblistener), and host (mymachine.myco.com).
emcli create_group
-name=my_group
-add_targets="database2:oracle_database;dblistener:oracle_listener
-add_targets="mymachine.myco.com:host"
Example 4 - Scripting and Interactive
create_group
(name="my_group"
,add_targets="database2:oracle_database;
dblistener:oracle_listener;mymachine.myco.com:host")
These examples create a host-only group named my_hosts that consists of three systems within the example.com domain: smpsun, dlsun, and supersun.
emcli create_group
-name=my_hosts
-add_targets="example.com:host"
-add_targets="example.com:host;supersun.example.com:host"
Example 6 - Scripting and Interactive
create_group
(name="my_hosts"
,add_targets="example.com:host;example.com:host;supersun.example.com:host")
Defines a group name and its members. After you create the group, you can edit it from the Enterprise Manager Cloud Control console to configure Summary Metrics to be displayed for group members.
emcli create_inst_media_profile
-name="profile_name"
-host="host_target"
-version="media_version"
-platform="media_platform"
[-description="profile_description"]
[-host_cred="Oracle_home_owner_credentials"]
-files=
WebLogic:WLSFile1;
SOA:SOAFile1,SOAFile2;
OSB:OSBFile;
RCU:RCUFile;
[ ] indicates that the parameter is optional
name
Name of the profile to be created.
host
Name of the host target that where all of the installation files are stored.
version
Version of the installation media.
platform
Platform for which the installation media is applicable.
description
Description of the profile to be created.
host_cred
Named credential to be used to access the files. The format is:
CREDENTIAL_NAME:CREDENTIAL_OWNER.
If you do not provide a named credential, preferred host credentials for the Oracle Home target are used.
files
List of files to be uploaded to the Software Library. Acceptable products are WebLogic, SOA, OSB and RCU. An upload for WebLogic is mandatory. The format is:
PRODUCT1:FILE1,FILE2;PRODUCT2:FILE3,FILE4
This example uploads the installation media file for the WebLogic Server to the Software Library from the given location on the given host. Preferred host credentials will be used to access the files.
emcli create_inst_media_profile
-name="WebLogic1036Installer"
-host="myhost.mycompany.com"
-description="WebLogic Server 10.3.6.0 installer"
-version="10.3.6.0"
-platform="Generic"
-files="WebLogic:/u01/media/weblogic/wls1036_generic.jar"
This example uploads the installation media files for SOA and the WebLogic Server to the Software Library from the given location on the given host. The provided named credentials are used to access the files.
emcli create_inst_media_profile
-name="SOA+WLSInstaller"
-host="myhost.mycompany.com"
-description="SOA 11.1.1.7.0 and WebLogic Server 10.3.6.0 installer"
-version="11.1.1.7.0"
-platform="Generic"
-host_cred="MY_HOST_CRED:SYSMAN"
-files="WebLogic:/u01/media/weblogic/
wls1036_generic.jar;SOA:/u01/media/soa/soa1.zip,/u01/media/soa/soa2.zip"
Creates a Java EE Application Component in the software library. On successful creation, the entity revision is displayed under the specified folder in the software library.
emcli create_jeeappcomp
-name="entity_name"
-folder_id="folder_id"
[-desc="entity_desc"]
[-attr="<attr name>:<attr value>"]
[-prop="<prop name>:<prop value>"]
[-secret_prop="<secret prop name>:<secret prop value>"]
[-note="note text"]
[ ] indicates that the parameter is optional
name
Name of the entity.
folder_id
ID of the folder where the entity will be created. The Software Library Home page exposes the identifier for folders and entities as a custom column called Internal ID. By default, this column is hidden.
desc
A short description about the entity. The new description is visible to all existing revisions.
attr
A name:value pair for specifying the attributes of an entity. It is represented as "attr_name:attr_value". For specifying values for multiple attributes, repeat the -attr option.
prop
A name:value pair for specifying the configuration properties of an entity. It is represented as prop_name:prop_value. For specifying values for multiple properties, repeat the option.
secret_prop
A name:value pair for specifying the configuration property and its secret value. Do not provide the secret value on the command line. Instead, enter the property name and press the Enter key. Provide the secret value when you are prompted for it.
note
Information related to the entity such as changes being made to the entity or modification history that you want to track.
Creates a Java EE Application component called "myJeeAppComp' in the folder identified by folder_id. You can find the folder ID using the custom column called Internal ID available on the Software Library home page. Note that this column is hidden by default.
emcli create_jeeappcomp
-name="myJeeAppComp"
folder_ id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
+E34
Creates entity named 'myJeeAppComp' in the folder identified by folder_id with a short description about the entity. Entity attributes such as PRODUCT, PRODUCT_VERSION, and VENDOR are specified. Value for the DEFAULT_HOME configuration property is also specified. A note that includes information related to the entity is included.
The identifier of the newly created entity revision will be printed on the standard output.
emcli upload_jeeappcomp_file
emcli create_jeeappcomp
-name="myJeeAppComp"
folder_id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
-desc="myJeeAppComp description"
-attr="PRODUCT:JEEApp"
-attr="PRODUCT_VERSION:3.0"
-attr="VENDOR:Vendor"
-prop="DEFAULT_HOME:/u01/myJeeAppComp3/"
-note="myJeeAppComp for test servers"
Creates and schedules a job. This verb supports multi-task jobs.
Note:
EM CLI permits OS Script jobs to be run against database targets by setting the targetType property for -input_file in the create_job verb. For example:targetType=oracle_database
You can set other target types similarly.
EM CLI supports the following job types:
ASMSQLScript ASSOCIATE_CS_FA ASSOCIATE_DOMAIN_FA AssociateClusterASM BlockAgent CoherenceCacheAddition CoherenceNodesRefresh Config Log Archive Locations DbMachineDashboard DiscoverPDBEntities FusionMiddlewareProcessControl GlassFishProcessControl InstallKernelModuleJob Log Rotation OSCommand OpatchPatchUpdate_PA RMANScript RefreshFromEMStore RefreshFromMetalink RefreshFusionInstance SOABulkRecovery SQLScript ShutdownDB StartDepartedCohNodes StartDepartedCohStoreNodes StartFusionInstance StartupDB StatspackPurge StopFusionInstance Upgrade Exalogic Systems WebLogic Control WebLogic Domain Discover WebLogic Domain Refresh
Note:
Not all job types support all target types. Useemcli create_job -input_file=property_file:"filename" [-name="job_name"] [-type="job_type"] [ ] indicates that the parameter is optional
name
Name of the job.
job_type
Name of the job type. You can obtain a template property file for the job type by using the describe_job_type verb.
input_file
Provide the file name to load the properties for creating and scheduling the job. The property file must be accessible to the EM CLI client for reading. Another job of the same job type could also be used to generate the property file using the EM CLI verb describe_job.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
Creates a job using a library job as a template. This verb supports multi-task jobs.
emcli create_job_from_library
-lib_job_name="library_job_name"
-name="new_job_name"
[-owner="library_job_owner"]
[-input_file=property_file:"filename"]
[-appendtargets]
[ ] indicates that the parameter is optional
lib_job_name
Library job to use as a template.
owner
Owner of the job. When this parameter is not specified, the default job owner is the logged in Enterprise Manager administrator.
name
Name of the new job to be created. You can also specify the name in the property file. If no name is specified, a name is generated from the name of the library job.
input_file
"filename" can be provided to load the properties for creating the job.
If you specify a property file, the values in the property file override or append to existing values in the library job. If you do not specify a property file, the library job is submitted unchanged.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
appendtargets
Appends targets in the property file to existing targets in the library job. Otherwise, library job targets are overwritten by targets in the property file if they are specified.
This example creates a job named MYJOB based on the library job MYLIBJOB1.
emcli create_job_from_library -lib_job_name=MYLIBJOB1 -name=MyJob
This example creates a job named MYJOB2 based on the library job MYLIBJOB1. Properties in /tmp/myjob1_prop.txt will override library job settings.
emcli create_job_from_library -lib_job_name=MYLIBJOB1 -name=MyJob2 -input_file=property_file:/tmp/myjob1_prop.txt
Creates a library job. This verb supports multi-task jobs.
emcli create_library_job
[-name="job_name"]
[-type="job_type"]
-input_file=property_file:"filename"
[ ] indicates that the parameter is optional
name
Name of the job.
type
Name of the job type. You can obtain a template property file for the job type by using the describe_job_type verb.
input_file
Provide the file name to load the properties for creating the library job. The property file must be accessible to the EM CLI client for reading. Another library job of the same job type could also be used to generate the property file using the EM CLI verb describe_library_job.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
Creates a named credential. You can provide input parameters using command line arguments or an input properties file. It also supports the input_file tag for passwords and parameter values.
emcli create_named_credential -cred_name=<name> -auth_target_type=<authenticating_target_type> -cred_type=<credential_type> -cred_scope=<credential_scope> -cred_desc=<credential_description> -target_name=<target_name> -target_type=<target_type> -test -test_target_name=<test_target_name> -test_target_type=<test_target_type> -input_file=<tag:value> -input_bfile=<tag:value> -properties_file=<filename> -attributes=<p1:v1;p2:v2;...>
Scripting and Interactive Format
create_named_credential (cred_name=<name> ,auth_target_type=<authenticating_target_type> ,cred_type=<credential_type> ,cred_scope=<credential_scope> ,cred_desc=<credential_description> ,target_name=<target_name> ,target_type=<target_type> ,test ,test_target_name=<test_target_name> ,test_target_type=<test_target_type> ,input_file=<tag:value> ,input_bfile=<tag:value> ,properties_file=<filename> ,attributes=<p1:v1;p2:v2;...>)
cred_name
Credential name, such as MyBackUpCreds. This is required if you do not use properties_file.
auth_target_type
Authenticating target type (e.g. host). This is required if you do not use properties_file.
cred_type
Credential type. This is required if you do not use properties_file.
cred_scope
Possible values are global|instance. The default is global.
cred_desc
Credential description.
target_name
This is required when cred_scope is instance.
target_type
This is required when cred_scope is instance.
test
Use this to test the credential before saving.
test_target_name
Use this to supply the target name to test a global credential. This is required when cred_scope is global and the test parameter is used.
test_target_type
Use this to supply the target type to test a global credential. This is required when cred_scope is global and the test parameter is used.
input_file
Use this to supply sensitive property values from the file.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_bfile
Use this to supply binary property values from the file.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
properties_file
Use this to pass all parameters from the file. Values given on the command line take precedence.
attributes
Specify credential columns as follows:
colname:colvalue;colname:colvalue
You can change the separator value using -separator=attributes=<newvalue>, and you can change the subseperator value using -subseparator=attributes=<newvalue>.
For more information about the separator and subseperator parameters , see Section 5.2, "-input_file Syntax Guidelines".
These examples create a HostCreds named credential with username foo and password bar:
emcli create_named_credential
-cred_name=NC1
-auth_target_type=host
-cred_type=HostCreds
-attributes="HostUserName:foo;HostPassword:bar"
Example 2 - Scripting and Interactive
create_named_credential
(cred_name="NC1"
,auth_target_type="host"
,cred_type="HostCreds"
,attributes="HostUserName:foo;HostPassword:bar")
These examples create a privilege delegation credential with user name foo, password bar, privilege delegation type SUDO, and RUNAS user root:
emcli create_named_credential
-cred_name=NC1
-auth_target_type=host
-cred_type=HostCreds
-attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:SUDO;RUNAS:root"
To use Powerbroker attributes, the string should be:
-attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:POWERBROKER;RUNAS:root; PROFILE:EMGC
Example 4 - Scripting and Interactive
create_named_credential
(cred_name="NC1"
,auth_target_type="host"
,cred_type="HostCreds"
,attributes="HostUserName:foo;
HostPassword:bar;PDPTYPE:SUDO;RUNAS:root")
To use Powerbroker attributes, the string should be:
,attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:POWERBROKER;RUNAS:root; PROFILE:EMGC
These examples read the password from the mypasswordfile.txt file.
emcli create_named_credential
-cred_name=NC1
-auth_target_type=host
-cred_type=HostCreds
-attributes="HostUserName:foo;HostPassword:tag"
-input_file="tag:mypasswordfile.txt"
Example 6 - Scripting and Interactive
create_named_credential
(cred_name="NC4",
,auth_target_type="host"
,cred_type="HostCreds"
,attributes="HostUserName:foo;HostPassword:tag"
,input_file="tag:mypasswordfile.txt")
These examples prompt for the password from standard input:
emcli create_named_credential
-cred_name=NC1
-auth_target_type=host
-cred_type=HostCreds
-attributes="HostUserName:foo;HostPassword:"
Example 7 - Scripting and Interactive
create_named_credential
(cred_name="NC1"
,auth_target_type="host"
,cred_type="HostCreds"
,attributes="HostUserName:foo;HostPassword:bar")
These examples specify prop1.txt as a multi-line Java properties file, in which each line contains a parameter=value format. You can provide the password in the same file or not specify it. If not specified, you are prompted for it.
emcli create_named_credential
-properties_file=prop1.txt
Example 9 - Scripting and Interactive
create_named_credential
(properties_file="prop1.txt")
Creates an operational plan for the Oracle Site Guard operation.
emcli create_operation_plan
-primary_system_name="name_of_primary_system"
-standby_system_name="name_of_standby_system"
-system_name="name_of_system"
-operation="name_of_operation"
-name="name_of_operation_plan"
-role="role_associated_with_system"
primary_system_name
Name of your system associated with the primary site. Enter this parameter for switchover or failover operations.
standby_system_name
Name of your system associated with the standby site. Enter this parameter for switch-over or fail-over operations.
system_name
Name of the system. Enter this parameter for start or stop operations.
operation
The function of the operation. Examples: switchover, failover, start, or stop.
name
Name of the operation plan.
role
Role associated with a system when you run an operation (start or stop).
emcli create_operation_plan
-primary_system_name="BISystem1"
-standby_system_name="BISystem2"
-operation="switchover"
-name="BISystem1-switchover-plan"
emcli create_operation_plan
-system_name="austin"
-operation="start"
-name="BISystem1-start-plan"
-role="Primary"
Creates a PaaS Infrastructure Zone.
emcli create_paas_zone
-name="<PaaS Zone name>"
-credential="<global named credential>"
[-hosts="<Host1,Host2,Host3...>"]
[-ovm_zones="<OVMZone1,OVMZone2,OVMZone3...>"]
[-roles="<ssaRole1,ssaRole2,..>"]
[-description="<PaaS Zone description>"]
[-cpu_utilization="<value between 1 and 100>"]
[-memory_utilization="<value between 1 and 100>"]
[ ] indicates that the parameter is optional.
name
Name of the PaaS Infrastructure Zone to be created.
credential
Global named credentials to be used for provisioning in this PaaS Infrastructure Zone. The credentials should be the same for all hosts. A cloud administrator can only use the named credentials that they own.
hosts
A comma-separated list of the host targets to be added as members of this Paas Infrastructure Zone.
ovm_zones
Comma-separated list of the Oracle Virtual Machine (OVM) Zone targets to be added as members of this Paas Infrastructure Zone. You must add at least one host or OVM Zone target for a PaaS Infrastructure Zone to be created.
roles
Comma-separated list of SSA roles that can access this PaaS Infrastructure Zone. A PaaS Infrastructure Zone can be made available to a restricted set of users through the use of roles. The SSA roles should already be created before executing this EM CLI command.
description
Description of the PaaS Infrastructure Zone.
cpu_utilization
Placement policy constraints enable the cloud administrator to set maximum ceilings for any host in the PaaS Infrastructure Zone. This constraint restricts the maximum resource consumption for the host members in a PaaS Infrastructure Zone. For example, a production PaaS Infrastructure Zone might limit CPU utilization to 80%, whereas a development PaaS Infrastructure Zone might allow up to 95 percent utilization. The service instance will be provisioned on the first host that satisfies the placement constraints. The value entered must be between 1 and 100. If not specified, the default value of 80% is used.
memory_utilization
Placement policy constraint for the PaaS Infrastructure Zone that restricts the percent of memory used. The value entered must be between 1 and 100. If not specified, the default value of 80% is used.
This example creates a Paas Infrastructure Zone with the name My PaaS Zone:
emcli create_paas_zone
-name="My PaaS Zone"
-credential="ZoneNamedCredentials"
-hosts="host1.mycompany.com, host2.mycompany.com"
-roles="SSA_USER_ROLE"
-description="This is a test PaaS Zone"
-cpu_utilization="85"
-memory_utilization="75"
Creates a new patch plan with the specified name and the patch-target map.
emcli create_patch_plan
-name="name"
-input_file=data:"file_path"
[-impact_other_targets="add_all | add_original_only | cancel"]
[-problems_assoc_patches="ignore_all_warnings | cancel"]
[ ] indicates that the parameter is optional
name
Name of the setting.
input_file
Input data to create a new patch plan. You must provide the data in the property name-value pairs.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
impact_other_targets
Action to take when other targets are impacted while adding the patches to the plan. Possible values for this parameter are:
add_all — Add all impacted targets to the plan.
add_original_only — Only add original targets to the plan.
cancel — Cancel the plan creation.
problems_assoc_patches
Action to take when there are problems associating patches to targets. Possible values for this parameter are:
ignore_all_warnings — Ignore all warnings.
cancel — Cancel the plan creation.
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
emcli create_patch_plan -name="plan_name" -input_file=data:"/tmp/patchplan.props"
emcli create_patch_plan -name="plan name" -input_file=data:"/tmp/patchplan.props" -impact_other_targets="add_all" emcli create_patch_plan -name="plan name" -input_file=data:"/tmp/patchplan.props" -impact_other_targets="add_all" -problems_assoc_patches="ignore_all_warnings"
You can use the following sample input file to create a patch plan with two patches:
patch.0.patch_id=4518443
patch.0.release_id=80102010
patch.0.platform_id=226
patch.0.language_id=0
patch.0.target_name=orclws
patch.0.target_type=oracle_database
patch.1.patch_id=4424952
patch.1.release_id=80102030
patch.1.platform_id=46
patch.1.language_id=0
patch.1.target_name=arac
patch.1.target_type=rac_database
Creates a software pool.
emcli create_pool
-name="<software pool name>"
-target_type="<software pool target type>"
-paas_zone="<Paas Infrastructure Zone of software pool>"
-members="<Member1, Member2...>"
[-description="<software pool description>"]
[-placement_constraints="<constraint1=value1, constraint2=value2...>"]
[-member_constraints="<constraint1=value1, constraint2=value2>"]
[-properties="<property1=value1, property2=value2>"]
[ ] indicates that the parameter is optional.
name
Name of the software pool to be created.
target_type
Target type of the software pool to be created, for example "mwaas_zone" for the middleware Pool, "oracle_cloud_zone" for the database pool, and "schaas_pool" for schema pool.
paas_zone
Name of PaaS Infrastructure Zone in which the software pool is to be created.
members
Comma-separated list of targets to be added as members of the software pool. The targets to be added must satisfy the member constraints specified.
description
Description of the software pool.
placement_constraints
Comma-separated key-value pairs of the placement constraints that enable the self-service administrator to set maximum ceilings for resource utilization. This ability provides protection for the members of the software pool in terms of resource consumption. For example, a production software pool might enforce more conservative limits, whereas a development software pool might enforce more liberal limits.
member_constraints
Comma-separated key-value pairs that restrict the addition of member targets to a software pool with a set criteria. Execute "emcli get_pool_allowed_member_constraints -target_type=<Target type>" to retrieve the list of allowed possible member constraints for a pool target type.
properties
Comma-separated key-value pairs for additional properties that must be specified based on the pool target type.
Creates a pluggable database.
emcli create_pluggable_database -cdbTargetName="CDB_target_name" -cdbTargetType="CDB_target_type" -cdbHostCreds="CDB_host_credentials" -pdbName="new_PDB_name" -sourceType="DEFAULT|UNPLUGGED_PDB|CLONE" [-cdbTargetCreds="CDB_target_credentials"] [-numOfPdbs="number_of_PDBs"] [-sourceFromSWLIB="Source_from_software_library"] [-pdbTemplateInSWLIB="URN_of_PDB_template_component"] [-sourcePDBTempStagingLocation="source_PDB_temporary_staging_location"] [-unpluggedPDBType="unplugged_PDB_type"] [-sourcePDBArchiveLocation="source_PDB_archive_location"] [-sourcePDBMetadataFile="source_PDB_metadata_file"] [-sourcePDBDatabackup="source_PDB_data_backup"] [-sourcePDBName="source_PDB_name"] [-sourceCDBCreds="source_CDB_credentials"] [-pdbAdminCreds="PDB_admin_crednentials"] [-useOMF="use_OMF_location"] [-sameAsSource="store_data_files_in_same_location_as_source_CDB"] [-newPDBFileLocation="storage_location_for_data_files_of_created_PDB."] [-createAsClone="create_PDB_as_clone"] [-lockAllUsers="locks_PDB users_of_new_PDB."] [ ] indicates that the parameter is optional
cdbTargetName
Name of the setting.
cdbTargetType
Type of setting you want to create.
cdbHostCreds
Parameter value. Choose one of the following parameters:
pdbName
Delimiter inserted between name-value pairs for the given name. The default value is a semi-colon ( ; ).
sourceType
Separator inserted between the name and value in each name-value pair for the given name. The default value is a semi-colon ( ; ).
emcli create_pluggable_database -cdbTargetName=database -cdbTargetType=oracle_database -pdbName=pdb -sourceType=UNPLUGGED_PDB -unpluggedPDBType=ARCHIVE -sourcePDBArchiveLocation=/u01/app/oracle/product/12.1.0/dbhome_2/assistants/dbca/templates/a.tar.gz -cdbHostCreds=HOST_CREDS -cdbTargetCreds=DBSNMP -newPDBFileLocation=/u01/app/oradata/pdb -pdbAdminCreds=pdb_creds -lockAllUsers
emcli create_pluggable_database -cdbTargetName=database -cdbTargetType=oracle_database -pdbName=pdb -numOfPdbs=2 -sourceType=UNPLUGGED_PDB -unpluggedPDBType=RMAN -sourcePDBMetadataFile=/u01/app/oracle/product/12.1.0/dbhome_2/assistants/dbca/templates/a.xml -sourcePDBDatabackup=/u01/app/oracle/product/12.1.0/dbhome_2/assistants/dbca/templates/a.dfb -cdbHostCreds=HOST_CREDS -cdbTargetCreds=DBSNMP -newPDBFileLocation=/u01/app/oradata/pdb -pdbAdminCreds=pdb_creds -createAsClone
Creates a privilege delegation setting template to apply later. You must create at least one setting to use the apply_privilege_delegation_setting verb.
emcli create_privilege_delegation_setting
-setting_name="name"
-setting_type="ttype"
[-settings="setting"]
[-separator=settings=";"]
[-subseparator=settings=","]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
create_privilege_delegation_setting
(setting_name="name"
,setting_type="ttype"
[,settings="setting"]
[,separator=settings=";"]
[,subseparator=settings=","])
[ ] indicates that the parameter is optional
setting_name
Name of the privilege delegation setting template.
setting_type
Type of setting you want to create.
settings
Parameter value. Choose one of the following parameters:
%USERNAME% — Name of the user running the command.
%RUNAS% — Run the command as this user.
%COMMAND% — Sudo command.
The %USER%, %RUNAS%,, %COMMAND% are tokens that the end-user has to use as-is while creating/modifying the privilege delegation settings. The system replaces these tokens with the actual values at run time depending on the command being run and for which user. Also, %command% should be upper case %COMMAND% for 10.2.0.5 GC.
separator
Delimiter inserted between name-value pairs for the given name. The default value is a semi-colon ( ; ).
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
subseparator
Separator inserted between the name and value in each name-value pair for the given name. The default value is a semi-colon ( ; ).
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
These examples create a setting named sudo_setting. The setting is of type SUDO, and the Sudo path used is /usr/local/bin/sudo. Sudo arguments are:
-S
%RUNAS%
%COMMAND%
emcli create_privilege_delegation_setting
-setting_name=sudo_setting
-setting_type=SUDO
-settings="SETTINGS:/usr/local/bin/sudo -S -u %RUNAS% %COMMAND%"
Example 2 - Scripting and Interactive
create_privilege_delegation_setting
(setting_name="sudo_setting",
setting_type="SUDO",
settings="SETTINGS:/usr/local/bin/sudo -S -u %RUNAS% %COMMAND%")
These examples create a setting named pb_setting. The setting is of type POWERBROKER, and the PowerBroker path used is /etc/pbrun. Arguments are:
%RUNAS%
%PROFILE%
%COMMAND%
emcli create_privilege_delegation_setting
-setting_name="pb_setting"
-setting_type="POWERBROKER"
-settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%"
-separator="settings=;"
-subseparator="settings=,"
Example 4 - Scripting and Interactive
create_privilege_delegation_setting
(setting_name=pb_setting
,setting_type=POWERBROKER
,settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%"
,separator="settings=;"
,subseparator="settings=,")
These examples are similar to examples 3 and 4, except that they also add arguments PASSWORD_PROMPT_STRING and Password.
emcli create_privilege_delegation_setting
-setting_name="pb_setting"
-setting_type="POWERBROKER"
-settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%";
PASSWORD_PROMPT_STRING,password:"
-separator="settings=;"
-subseparator="settings=,"
Example 5 - Scripting and Interactive
create_privilege_delegation_setting
(setting_name=pb_setting
,setting_type=POWERBROKER
,settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%";
PASSWORD_PROMPT_STRING,password:"
,separator="settings=;"
,subseparator="settings=,")
Creates a retroactive blackout on given targets and updates their availability. Only Enterprise Manager Administrators with OPERATOR privilege on the target can perform this action. The retroactive blackout feature needs to be enabled from the user interface to use this command.
emcli create_rbk -reason="<blackout_reason>" -add_targets="name1:type1;name2:type2;..." -schedule="start_time:<yyyy-MM-dd HH:mm:ss>;end_time:<yyyy-MM-dd HH:mm:ss>;[tzregion:<timezone_region>;]" [-propagate_targets] [ ] indicates that the parameter is optional
reason
Reason to be stored for the retroactive blackout. If you have SUPER_USER privileges (you are an Enterprise Manager Super Administrator), any text string can be used for the reason. The reason is added to the list of allowable blackout reasons if it is not already in the list. If you do not have SUPER_USER privileges, you must specify one of the text strings returned by the get_blackout_reasons verb.
add_targets
Targets to add to the retroactive blackout. Each target is specified as
target_name:target_type. You can specify this option more than once.
schedule
Schedule for retroactive blackout. The following arguments are mandatory for providing a retroactive blackout schedule:
schedule=start_time - The start date/time of the blackout. The format of the value is "yyyy-MM-dd HH:mm:ss". For example: "2013-09-20 12:12:12"
schedule=end_time - The end date/time of the blackout. The format of the value is "yyyy-MM-dd HH:mm:ss". For example: "2013-09-20 12:15:00"
schedule=tzregion - The timezone region to use. For example: "UTC". If not provided, tzregion is defaulted to UTC.
propagate_targets
A blackout for a target of type "host" applies the blackout to all non-agent targets on the host. Regardless of whether this option is specified, a blackout for a target that is a composite or a group applies the blackout to all members of the composite or group.
This example creates a retroactive blackout on Oemrep_Database and updates the target's availability record from 2013-09-20 12:12:12 UTC to 2013-09-20 12:15:00 UTC as the blackout.
emcli create_rbk -reason="Testing"
-add_targets="Oemrep_Database:oracle_database"
-schedule="start_time:2013-09-20 12:12:12;end_time:2013-09-20
12:15:00;tzregion:UTC"
This example creates a retroactive blackout for all targets on host example.company.com and updates their availability records from 2013-09-20 12:12:12 UTC to 2013-09-20 12:15:00 UTC as the blackout.
emcli create_rbk -reason="Testing"
-add_targets="example.company.com:host"
-schedule="start_time:2013-09-20 12:12:12;end_time:2013-09-20
12:15:00;tzregion:UTC"
-propagate_targets
Defines a redundancy group name and its members. After you create the redundancy group, you can edit it from the Enterprise Manager Cloud Control console to configure charts to be displayed for redundancy group members.
emcli create_red_group
-name="name"
[-type=<generic_redundancy_group>]
-add_targets="name1:type1;name2:type2;..."...
[-owner=<redundancy_group_owner>]
[-timezone_region=<actual_timezone_region>]
[ ] indicates that the parameter is optional
name
Name of the redundancy group.
type
Redundancy group type. Defaults to generic_redundancy_group.
add_targets
Add existing targets to the redundancy group. Each target is specified as a name-value pair target_name:target_type. You can specify this option more than once.
owner
Owner of the redundancy group.
timezone_region
Time zone region of this redundancy group.
Creates a redundancy group.
emcli create_redundancy_group -redundancyGroupName="redGrpName" -memberTargetType="tType" -memberTargetNames="tName1;tName2" [-group_status_criterion=NUMBER|PERCENTAGE] [-group_status_tracked=UP|DOWN] [-group_status_value=<group_status_value>] [-timezone_region=<valid_time_zone_region>]
[is_propagating=true|false]
[ ] indicates that the parameter is optional
redundancyGroupName
Name of the redundancy group.
memberTargetType
Target type of the constituent member targets.
memberTargetNames
Member targets for this redundancy group.
group_status_criterion
This parameter and the next two calculate the status of the Redundancy Group. Consequently, you need to specify all three options together. If this is not to be a capacity group, you need to specify the following combination:
-group_status_criterion='NUMBER' -group_status_tracked='UP' -group_status_value='1']
group_status_tracked
See the parameter above.
group_status_value
See the group_status_criterion parameter.
You can specify any value between 1 and 100 if -group_status_criterion= "PERCENTAGE", or any value between 1 and the number of targets present if
-group_status_criterion="NUMBER".
timezone_region
Time zone region of this redundancy group. For a list of valid time zone regions, enter the following command at SQLPLUS:
SELECT TZNAME FROM V$TIMEZONE_NAMES
You may need to have the SELECT_CATALOG_ROLE role to execute this command.
is_propagating
Indicates whether or not the privilege on the redundancy group will be propagated to member targets. The default value is false.
This example creates a redundancy group with the name 'redGrp1' and with listener, listener2, listener3 as its member targets. The status is calculated as the redundancy group being up if 55 percent of its member targets are up.
emcli create_redundancy_group -redundancyGroupName='redGrp1' -memberTargetType='oracle_listener' -memberTargetNames='listener;listener2;listener3' -group_status_criterion='PERCENTAGE' -group_status_tracked='UP' -group_status_value='55'
This example creates a 'redGrp1' redundancy group with listener, listener2, and listener3 as its member targets and time zone as PST8PDT. The status is calculated as the redundancy group being up if two of its member targets are up.
emcli create_redundancy_group -redundancyGroupName='redGrp1'
-memberTargetType='oracle_listener'
-memberTargetNames='listener;listener2;listener3'
-timezone_region='PST8PDT'
-group_status_criterion='NUMBER'
-group_status_tracked='UP'
-group_status_value='2'
Creates a new resolution state that describes the state of incidents or problems. Only super administrators can execute this command. The new state is always added between the New and Closed states. You need to specify the exact position of this state in the overall list of states by using the position option. The position can be between 2 and 98.
The state is applicable by default to both incidents and problems. You can use the applies_to option to indicate that the state is applicable only to incidents or problems. A success message is reported if the command is successful. An error message is reported if the create fails.
emcli create_resolution_state
-label="label_for_display"
-position="display_position"
[-applies_to="INC|PBLM"]
[ ] indicates that the parameter is optional
label
End-user visible label of the state. The label cannot exceed 32 characters. You can change this later if needed.
position
Position of this state within the overall list of states. This is used when displaying the list of states in the user interface. The position can be between 2 and 98. You can change the position of the state later if needed.
It is recommended that you set the position with sufficient gaps to facilitate moving states around. For example, if you set the positions to 5, 10, and 15 instead of 2, 3, and 4, it is easier to move a state from position 15 to 9, for instance, in contrast to the latter scheme, in which you would have to move all states to provide space for the reordering.
applies_to
Indicates that the state is applicable only for incidents or problems. By default, states apply to both incidents and problems. Supported values are "INC" or "PBLM".
This example adds a resolution state that applies to both incidents and problems at position 25.
emcli create_resolution_state -label="Waiting for Ticket" -position=25
This example adds a resolution state that applies to problems only at position 35.
emcli create_resolution_state -label="Waiting for SR" -position=35 -applies_to=PBLM
Creates a new Enterprise Manager admininistrator role.
emcli create_role
-name="role_name"
[-type="type_of_role"]
[-description="description"]
[-roles="role1;role2;..."]
[-users="user1;user2;..."]
[-privilege="name[;secure_resource_details]]"
[-separator=privilege="sep_string"]
[-subseparator=privilege="subsep_string"]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
create_role
(name="role_name"
[,type="type_of_role"]
[,description="description"]
[,roles="role1;role2;..."]
[,users="user1;user2;..."]
[,privilege="name[;secure_resource_details]]"
[,separator=privilege="sep_string"]
[,subseparator=privilege="subsep_string"])
[ ] indicates that the parameter is optional
name
Role name.
type
Type of role. The default value for this parameter is EM_ROLE. The other possible value is EXTERNAL_ROLE.
description
Description of the role.
roles
List of roles to assign to this new role. Currently, the only built-in role is PUBLIC.
users
List of users to whom this role is assigned.
privilege
Privilege to grant to this role. You can specify this option more than once.
Note: Privileges are case-insensitive.
secure_resource_details should be specified as:
resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
separator
Specify a string delimiter to use between name-value pairs for the value of the privilege option. The default separator delimiter is ";" .
subseparator
Specify a string delimiter to use between name and value in each name-value pair for the value of the privilege option. The default separator delimiter is ";" .
These examples create a role named my_new_role with the one-sentence description - "This is a new role called my_new_role". The role combines three existing roles: role1, role2, and role3. The role also has two added privileges: to view the job with ID 923470234ABCDFE23018494753091111 and to view the target host1.example.com:host. The role is granted to johndoe and janedoe.
emcli create_role
-name="my_new_role"
-desc="This is a new role called my_new_role"
-roles="role1;role2;role3"
-privilege="view_job;923470234ABCDFE23018494753091111"
-privilege="view_target;host1.example.com:host"
-users="johndoe;janedoe"
Example 2 - Scripting and Interactive
create_role
(name="my_new_role"
,desc="This is a new role called my_new_role"
,roles="role1;role2;role3"
,privilege="view_job;923470234ABCDFE23018494753091111"
,privilege="view_target;host1.example.com:host"
,users="johndoe;janedoe")
These examples create a role named my_external_role with a role type of EXTERNAL_ROLE and one-sentence description of "This is an external role."
emcli create_role
-name="my_external_role"
-type="EXTERNAL_ROLE"
-desc="This is an external role"
Example 4 - Scripting and Interactive
create_role
(name="my_external_role"
,type="EXTERNAL_ROLE"
,desc="This is an external role")
Creates a service to be monitored by Enterprise Manager.
emcli create_service
-name='name'
-type='type'
-availType=test|system
-availOp=and|or
[-hostName=<host_name>
[-agentURL=<agent_url>
[-properties='pname1|pval1;pname2|pval2;...']
[-timezone_region=<gmt_offset>]
[-systemname=<system_name>]
[-systemtype=<system_type>]
[-keycomponents='keycomp1name:keycomp1type;keycomp2name:keycomp2type;...']
[-beacons='bcn1name:bcn1isKey;bcn2name:bcn2isKey;...']
[-input_file="template:Template file name]"]
[-input_file="variables:Variable file name]"]
[-sysAvailType=<availability_type>]
[ ] indicates that the parameter is optional
name
Service name. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks.
type
Service type.
availType
Sets the availability to either test-based or system-based. If availability is set to test, template file, beacons, and variable are required arguments. If availability is set to system, systemname, systemtype, and keycomponents are required.
availOp
Availability operator. If and, uses all key tests/components to decide availability. If or, uses any key tests/components to decide availability.
hostName
Network name of the system running the Management Agent that is collecting data for this target instance.
agentURL
URL of the Management Agent that is collecting data for this target instance. If you enter the host name, the Agent URL of the host is automatically entered in this field.
properties
Name-value pair (that is, prop_name|prop_value) list of properties for the service instance.
timezone_region
GMT offset for this target instance (-7 or -04:00 are acceptable formats).
systemname
System name on which service resides.
systemtype
Type of system for which you want to create the service.
keycomponents
Name-type pair (that is, keycomp_name:keycomp_type) list of key components in the system that are used for the service.
beacons
Name-isKey pairs that describe the beacons of the service. If isKey is set to Y, beacon is set as a key-beacon of the service. The service should have at least one key beacon if the availability is set to test-based.
input_file
Template file name is the XML file that includes the template definition. Variable file defines the values for the template.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
sysAvailType
Type of availability when the availType is system-based. Sets the availability to either system target directly or selected components of a system.
If availability is set to 'system target directly,' the system needs to have availability[status] defined. systemname and systemtype are required parameters.
If availability is set to 'selected components of a system,' systemname, systemtype and keycomponents are required parameters.
If availability is set to 'system target directly,' and if the system does not have availability[status] defined, the availability set is invalid. Therefore, the only option that can be set is 'selected components of a system'.
This example creates a generic service named my_service with specified properties on a generic system named my_system. The availability is set as system-based, and the availability is based on system target status.
emcli create_service
-name='my service' -type='generic_service'
-availType='system' -availOp='or'
-sysAvailType='system target directly'
-properties='prop1:value1; prop2:value2'
-timezone_region='PST8PDT'
-systemname='my system' -systemtype='generic_system'
This example creates a generic service named my_service with specified properties on a generic system named my system with specified key components. The availability is set as system-based.
emcli create_service
-name='my_service' -type='generic_service'
-availType='system' -availOp='or'
-properties='prop1:value1; prop2:value2'
-timezone_region='PST8PDT'
-systemname='my system' -systemtype='generic_system'
-keycomponents='database:oracle_database; mytestbeacon:oracle_beacon'
This example creates a generic service named my_service with specified properties with tests defined in mytests.xml, and beacons MyBeacon as the key beacon and MyOtherBeacon as a non-key beacon. Availability is set as test-based.
emcli create_service
-name='my_service' -type='generic_service'
-availType='test' -availOp='or'
-properties='prop1:value1; prop2:value2'
-timezone_region='PST8PDT'
-input_file='template:mytests.xml'
-beacons='MyBeacon:Y;MyOtherBeacon:N'
Creates a service template.
emcli create_service_template
-name="<service template>"
-service_family="<service family>"
-service_type="<service type>"]
-pool_target_type="target type of software pools"
-software_pools="<SwPool1,SwPool2,SwPool3,...>"
[-roles="<SsaRole1,SsaRole2,..>"]
[-description="<service template description>"]
[-input_file="data:<service executable metadata file>"]
[ ] indicates that the parameter is optional.
name
Name of the service template to be created.
service_family
Service family for which the service template is being created, for example DBAAS for database, MWAAS for middleware.
service_type
Service type for which the service template is being created, for example PhysicalWLS for a physical middleware service template.
pool_target_type
Target type of the software pools to be associated with the service template.
software_pools
Comma-separated list of software pools to be associated with the service template.
roles
Comma-separated list of SSA roles that can access this service template. A service template can be made available to a restricted set of users through the use of roles. The SSA roles should already be created before executing this EM CLI command.
description
Description of the service template.
input_file
Contains configuration and profile data in JSON format that will be required for setting values of procedure configuration variables. For example:
input_file="data:executable.json"
This example creates the service template My Service Template:
emcli create_service_template
-name="Middleware service template August"
-service_family="MWAAS"
-service_type="PhysicalWLS"
-pool_target_type="mwaas_zone"
-software_pools="MyPoolOH"
-roles="SSA_USER_ROLE"
-description="Middleware small instance service template."
-input_file="data:executable.json"
Creates a site configuration for Site Guard. It associates the systems and their roles.
emcli create_siteguard_configuration
-primary_system_name=<name>
-standby_system_name=<name1;name2;...>
primary_system_name
Name of the system associated with the primary site.
standby_system_name
Name of the system associated with the standby system. You can specify more than one system name.
emcli create_siteguard_configuration
-primary_system_name="BISystem1"
-standby_system_name="BISystem2"
Associates the credentials with the targets in a site.
emcli create_siteguard_credential_association
-system_name=<name>
[-target_name=<name>]
-credential_type=<type>
[-credential_name=<name>]
[-use_preferred_credential=<type>]
-credential_owner=<owner>
[ ] indicates that the parameter is optional.
system_name
Name of the system.
target_name
Name of the target.
credential_type
Type of credential, which can be HostNormal, HostPrivileged, WLSAdmin, or DatabaseSysdba.
credential_name
Name of the credential. If you do not specify this parameter, you need to specify the use_preferred_credential parameter.
use_preferred_credential
Name of the credential. If you do not specify this parameter, you need to specify the credential_name parameter.
credential_owner
Owner of the credential.
emcli create_siteguard_credential_association
-system_name="BISystem1"
-credential_type="HostNormal"
-credential_name="HOST-SGCRED"
-credential_owner="sysman"
emcli create_siteguard_credential_association
-system_name="BIsystem1"
-target_name="database-instance"
-credential_type="HostNormal"
-credential_name="HOST-DBCRED"
-credential_owner="sysman"
Associates scripts (pre-script, post-script, and storage script) with the Site Guard configuration.
emcli create_siteguard_script
-system_name=<name>
-operation=<name>
-script_type=<type>
[-host_name=[<name1;name2;...>]
-path=<path_of_script>
[-all_hosts=true|false]
[-role=Primary|Standby]
[ ] indicates that the parameter is optional.
system_name
Name of the system.
operation
Name of the operation. Examples: Switchover, Failover, Start, or Stop.
script_type
Type of script, which can be Mount, UnMount, Pre-Script, Post-Script, Failover, or Switchover.
host_name
Name of the host where this script will run. You can specify this option more than once.
path
Path to the script.
all_hosts
Allows the script to run on all the hosts in the system. This parameter overrides the host_name.
role
Configures the script based on the system role. By default, the script is configured for both primary and standby roles for a given system.
emcli create_siteguard_script
-system_name="BISystem1"
-operation="Switchover"
-script_type="Pre-Script"
-path="/tmp/prescript"
-all_hosts="true"
-role="Primary"
emcli create_siteguard_script
-system_name="BISystem1"
-operation="Switchover"
-script_type="Pre-Script"
-path="/tmp/prescript"
-host_name="BIHOST1"
-host_name="BIHOST2"
Creates an entity in the software library. Upon successful creation, the entity revision appears under the specified folder on the software library home page.
emcli create_swlib_entity
-name="entity_name"
-folder_id="folder_id"
[-type]="type_internal_id"]
[-subtype]="subtype_internal_id"]
[-desc="entity_desc"]
[-attr="<attr_name>:<attr value>"]
[-prop="<prop_name>:<prop value>"]
[-secret_prop="<secret_prop_name>:<secret_prop=_value>"]
[-note="note_text"]
[ ] indicates that the parameter is optionalis optional
name
Name of the entity.
folder_id
Identifier of the folder where the entity is to be created. The software library home page exposes the identifier for folders and entities as a custom column (Internal ID), and is hidden by default.
type
Use the list_swlib_entity_types verb to identify the type.
subtype
Internal identifier of the entity subtype, which defaults to the 'Generic Component' subtype for the 'Component' type. Use the list_swlib_entity_types verb to identify the subtype.
desc
Description of the entity.
attr
An attribute and its value, separated by a colon ( : ). To specify values for multiple attributes, repeat this option.
prop
A configuration property and its value, separated by a colon ( : ). To specify values for multiple properties, repeat this option.
secret_prop
A configuration property and its secret value separated by a colon ( : ). It is recommended to not specify the secret value on the command line. If omitted from the command line, the value is prompted for. To specify values for multiple properties, repeat this option.
note
A note on the entity. For multiple notes, repeat this option.
This example creates an entity named 'myAcmeInstall' under the specified folder. The entity is of type 'Component' and subtype 'Generic Component, by default. The folder identifier value can be found on the software library home page. The software library home page exposes the identifier for folders and entities as a custom column (Internal ID), and is hidden by default.
emcli create_swlib_entity
-name="myAcmeInstall"
-folder_id=
"oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
This example creates an entity named 'myAcmeInstall' under the specified folder with the specified description. The entity is of type 'Component' and subtype 'Generic Component' by default. Values for the entity attributes, viz. PRODUCT, PRODUCT_VERSION and VENDOR, are specified. The value for the configuration property named DEFAULT_HOME is specified. A note on the entity is also specified. The identifier of the newly created entity revision is printed on the standard output.
emcli create_swlib_entity
-name="myAcmeInstall"
-folder_id=
"oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
-desc="myAcmeInstall description"
-attr="PRODUCT:Acme"
-attr="PRODUCT_VERSION:3.0"
-attr="VENDOR:Acme Corp"
-prop="DEFAULT_HOME:/u01/acme3/"
-note="myAcmeInstall for test servers"
Creates a folder in the software library.
emcli create_swlib_folder
-name="folder_name"
-parent_id="parent_folder_id"
[-desc="folder_description"]
[ ] indicates that the parameter is optionalis optional
name
Name of the folder.
parent_id
Identifier of the parent folder under which the folder is to be created. To create a folder under the root folder, specify the parent folder identifier as 'ROOT.' The software library home page exposes the identifier for folders and entities as a custom column (Internal ID) and is hidden by default.
desc
Description of the folder.
Defines a system: name and its members. After the system is created, you can edit the system from the Enterprise Manager Cloud Control console to configure charts to be displayed for system members.
emcli create_system
-name="name"
[-type=<system>]
[-add_members="name1:type1:key_member/non_key_member;name2:type2;..."]...
[-separator=add_members="sep_value"]
[-subseparator=add_members="subsep_value"]
-timezone_region="actual_timezone_region"
[-owner="owner"]
[-meta_ver="meta_version_of_system_type"]
[-is_propagating="true|false"]
[-availability_type="ALL|ANY"]
[ ] indicates that the parameter is optionalis optional
name
Name of the system.
type
System type: generic_system. Defaults to "generic_system".
add_members
Add existing targets to the system. Each target is specified as a name-value pair target_name:target_type. You can specify this option more than once.
key_member specifies that this target is a part of the systems availability calculation.
separator
Name-value pair separator for the given argument.
subseparator
Separates the name from the value for the given argument.
timezone_region
Actual time zone region.
owner
Owner of the system.
meta_ver
Meta version of the system type. Defaults to "1.0".
is_propagating
Flag to indicate if the privilege on the system will be propagated to member targets or not. The default value is false.
availability_type
Availability calculation method of the system. Defining this is required if
key_member is defined. ALL denotes that all key members must be up in order to mark the system as up. ANY denotes that at least one of the key members must be up in order to mark the system as up.
This example creates a generic system named db_system and supports backward compatibility. This system consists of two Oracle databases: emp_rec and payroll. The owner of this system is user1. The meta version of the system type is 3.0.
emcli create_system -name=db_system
-add_members="emp_rec:oracle_database"
-add_members="payroll:oracle_database"
-timezone_region="PST8PDT"
-owner="user1"
This example creates a generic system named my_system that consists of an oracle database (database2), listener (dblistener), and host (mymachine.myco.com). The owner of this system is the logged-in user. The meta version of the system type is 1.0. The example supports backward compatibility.
emcli create_system -name=my_system
-add_members="database2:oracle_database;dblistener:oracle_listener
-add_members="mymachine.myco.com:host"
-timezone_region="PST8PDT"
This example creates a generic system named db_system1. This system consists of two Oracle databases: emp_rec and payroll. emp_rec is a key member for the system. The availability calculation method is if ANY of the key members is up, the system is up. The meta version of the system type is 3.0. This example shows the recommended method for creating a system.
emcli create_system -name=db_system1
-add_members="emp_rec$oracle_database$key_member"
-add_members="payroll$oracle_database"
-subseparator=add_members="$"
-timezone_region="PST8PDT"
-availability_type="ANY"
Creates a session to migrate user-defined metrics (UDMs) to metric extensions for targets.
emcli create_udmmig_session
-name=<session_name>
-desc=<session_description>
[-udm_choice=<specific_udm_to_convert>]*
{-target=<type:name_of_target_to_migrate> }*
| {-input_file=targetList:<complete_path_to_file>};
{-template=<template_name_to_update> }*
| {-input_file=templateList:<complete_path_to_file>}
[-allUdms]
[ ] indicates that the parameter is optional
name
Name of the migration session to be created.
desc
Description of the migration session to be created.
udm_choice
Specify if the session should migrate specific UDMs. Otherwise, all UDMs are migrated.
target
The type:name of the target to be updated. You can specify multiple values.
input_file=targetList
Specify a file name that contains a list of targets, one per line, in the following format:
<targetType>:<targetName>
For more information about the input_file parameter see Section 5.2, "-input_file Syntax Guidelines".
template
Name of the monitoring template to update. You can specify multiple values.
input_file=templateList
Specify a file name that contains a list of templates, one name per line.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
allUdms
Forces the session to contain all UDMs from targets and templates. (The default behavior just selects those not in a session.)
This example creates a new session named hostsession that migrates the UDM hostudm on the target testhost.
emcli create_udmmig_session
-name=hostsession -desc="Convert UDMs for Host Target"
-udm_choice=hostudm -target=host:testhost
This example creates a new session named hostsession that migrates all the unconverted UDMs on the target testhost that are not in a session.
emcli create_udmmig_session
-name=hostsession -desc="Convert UDMs for Host Target"
-target=host:testhost -allUdms
Creates a new Enterprise Manager administrator.
emcli create_user
-name="name"
-password="password"
[-type="user_type"]
[-roles="role1;role2;..."]
[-email="email1;email2;..."]
[-privilege="name[;secure-resource-details]]"
[-separator=privilege="sep_string"]
[-subseparator=privilege="subsep_string"]
[-profile="profile_name"]
[-desc="user_description"]
[-expired="true|false"]
[-prevent_change_password="true|false"]
[-department="department_name"]
[-cost_center="cost_center"]
[-line_of_business="line_of_business"]
[-contact="contact"]
[-location="location"]
[-input_file="arg_name:file_path"]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
emcli create_user
(name="name"
,password="password"
[,type="user_type"]
[,roles="role1;role2;..."]
[,email="email1;email2;..."]
[,privilege="name[;secure-resource-details]]"
[,separator=privilege="sep_string"]
[,subseparator=privilege="subsep_string"]
[,profile="profile_name"]
[,desc="user_description"]
[,expired="true|false"]
[,prevent_change_password="true|false"]
[,department="department_name"]
[,cost_center="cost_center"]
[,line_of_business="line_of_business"]
[,contact="contact"]
[,location="location"]
[,input_file="arg_name:file_path"])
[ ] indicates that the parameter is optional
name
Administrator name.
password
Administrator password.
type
Type of User. The default value of this parameter is EM_USER. Possible values for this parameter are:
EM_USER
EXTERNAL_USER
DB_EXTERNAL_USER
roles
List of roles to grant to this administrator. Currently, the built-in roles include PUBLIC.
List of e-mail addresses for this administrator.
privilege
Privilege to grant to this administrator. You can specify this option more than once in command-line format. The original administrator privileges will be revoked. Specify <secure_resource_details> as:
resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
To retrieve the list of system privileges that do not require resource information, execute the get_supported_privileges command.
separator
Specify a string delimiter to use between name-value pairs for the value of the privilege option. The default separator delimiter is a semi-colon ( ; ).
subseparator
Specify a string delimiter to use between name and value in each name-value pair for the value of the privilege option. The default subseparator delimiter is a colon
( : ).
profile
Database profile name. It uses DEFAULT as the default profile name.
desc
User description for the user being added.
expired
Use this option to expire the password immediately. The default is false.
prevent_change_password
When set to true, you cannot change your own password. The default is false.
department
Name of the department of the administrator.
cost_center
Cost center of the administrator in the organization.
line_of_business
Line of business of the administrator.
contact
Contact information of the administrator.
location
Location of the administrator.
input_file
Allow the administrator to provide the value of any argument in a file. The format of the value will be the name_of_argument:file_path_with_file_name. You can specify this option more than once.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
These examples create an Enterprise Manager administrator named
new_admin. This administrator has two privileges: the ability to view the job with ID 923470234ABCDFE23018494753091111 and the ability to view the target host1.example.com:host. The administrator new_admin is granted the PUBLIC role.
emcli create_user
-name="new_admin"
-password="oracle"
-email="first.last@example.com;joe.shmoe@shmoeshop.com"
-roles="public"
-privilege="view_job;923470234ABCDFE23018494753091111"
-privilege="view_target;host1.example.com:host"
Example 2 - Scripting and Interactive
create_user
(name="new_admin"
,password="oracle"
,email="first.last@example.com;joe.shmoe@shmoeshop.com"
,roles="public"
,privilege="view_job;923470234ABCDFE23018494753091111"
,privilege="view_target;host1.example.com:host")
These examples make User1 an Enterprise Manager user, which is already created on an external user store like the SSO server. The contents of priv_file are view_target;host1.example.com:host . User1 will have view privileges on the host1.example.com:host target.
emcli create_user
-name="User1"
-type="EXTERNAL_USER"
-input_file="privilege:/home/user1/priv_file"
Example 4 - Scripting and Interactive
create_user
(name="User1"
,type="EXTERNAL_USER"
,input_file="privilege:/home/user1/priv_file")
These examples make User1 an Enterprise Manager user, provide a description for the user, and prevent the password from being changed. Only another super administrator can change the password. The profile is set as MGMT_ADMIN_USER_PROFILE.
emcli create_user
-name="User1"
-desc="This is temp hire."
-prevent_change_password="true"
-profile="MGMT_ADMIN_USER_PROFILE"
Example 6 - Scripting and Interactive
create_user
(name="User1"
,desc="This is temp hire."
,prevent_change_password="true"
,profile="MGMT_ADMIN_USER_PROFILE")
These examples make User1 an Enterprise Manager user, provide a description for the user, and immediately expire the password. When the user logs in the first time, he/she must change the password.
emcli create_user
-name="User1"
-desc="This is temp hire."
-expire="true"
Example 8 - Scripting and Interactive
create_user
(name="User1"
,desc="This is temp hire."
,expire="true")
These examples make User1 an Enterprise Manager user, and provide a description, department name, cost center, line of business, contact, and location for the administrator.
emcli create_user
-name="User1"
-password="oracle"
-desc="This is temp hire."
-department="dept1"
-cost_center="testCostCenter"
-line_of_business="testLineOfBusiness"
-contact="contact"
-location="location"
Example 10 - Scripting and Interactive
emcli create_user
(name="User1"
,password="oracle"
,desc="This is temp hire."
,department="dept1"
,cost_center="testCostCenter"
,line_of_business="testLineOfBusiness"
,contact="contact"
,location="location")
Transfers data from source to target.
inputFile
Location of file containing properties required for transferring data. The mandatory properties required for this job are:
SOURCE_LOCATION = Location of the data at the source host.
SRC_HOST = Source host containing the data.
SRC_HOST_CREDS = Credentials for the host on which the data is located. If the source host is on OPC, this should be Host SSH Credentials.
DEST_HOST = Destination host where the data should be copied to.
DEST_HOST_CREDS = Credentials for the host where the data will be copied to. If the destination host is on OPC, this should be Host SSH Credentials.
DEST_LOCATION = Location on the destination host where the data should be copied.
Imports data from export dumps to the database target specified.
inputFile
Location of the file containing properties required for importing data to the database.
Performs database Cloud maintenance tasks.
db_cloud_maintenance -activateSoftware
Activates the new software of the pool.
Format
emcli db_cloud_maintenance -activateSoftware
-pool_name= "pool_name"
-pool_type= "pool_type" l
[-force= "force" ]
[ ] indicates that the parameter is optional.
Parameters
pool_name
The name of the pool.
pool_type
The type of the pool.
force
Forcibly activates new members.
Example
The following example forcibly activates new members and activates new software for the Oracle Cloud Zone pool with the name POOL.
emcli db_cloud_maintenance -activateSoftware
-pool_name=POOL
-pool_type=oracle_cloud_zone
-force=true
db_cloud_maintenance -performOperation
Performs a named operation on a specified pool.
Format
emcli db_cloud_maintenance -performOperation
-name= "name"
-description= "description"
-purpose= "purpose"
-pool_name= "pool_name"
-pool_type= "pool_type"
[-start_schedule= "start_schedule"]
[-end_schedule= "end_schedule" ]
[-input_file= "data:input_file" ]
[-target_type= "target_type" ]
[-target_list= "target_list" ]
[ ] indicates that the parameter is optional.
Parameters
name
The name of the operation.
description
The description of the operation.
purpose
The purpose of the operation.
pool_name
The name of the pool.
pool_type
The type of the pool.
start_schedule
The scheduled start time. The format for start_schedule is yyyy-MM-dd HH:mm:ss, for example start_schedule="2013-11-11 12:15:30". The default start time is immediate.
end_schedule
The scheduled end time. The format for end_schedule is yyyy-MM-dd HH:mm:ss, for example end_schedule="2014-11-11 22:30:00". The default end time is indefinite.
input_file
Input data for the maintenance action, for example input_file="data:~/input_files/data.
target_type
The default target type is identified based on the purpose. For example, if the purpose is DEPLOY_DB, then the default target type becomes oracle_home.
target_list
A comma separated list of targets. The target list is the list of entities based on the target type that is selected. For example, if target_type=rac_database target_list,then the target list is "rac1.example.com,rac2.example.com". The default target_list is based on the purpose. For example if the purpose is DEPLOY_DB, the default target list becomes the list of Oracle homes present in the pool.
Example
The following example performs the Update RAC Database operation for the Oracle Cloud Zone pool with the name POOL.
emcli -performOperation
-name="Update RAC Database "
-description="Update RAC database Instance"
-purpose="UPDATE_RACDB"
-start_schedule="start_time:2014/09/01 00:00"
-end_schedule="start_time:2014/09/01 13:00"
-pool_name="POOL NAME"
-pool_type=oracle_cloud_zone
-target_type=rac_database
-target_list="rac1.example.com"
Performs database software maintenance tasks.
db_software_maintenance -searchImage
Searches the image based on the filters provided. Use '%' for wildcards.
Format
emcli db_software_maintenance -searchImage
[-name_pattern= "name_pattern"]
[-version_pattern= "version_pattern"]
[-description_pattern= "description_pattern"]
[-owner= "owner"]
[-target_type= "target_type"]
[-platform_id= "platform_id"]
[ ] indicates that the parameter is optional.
Parameters
name_pattern
The name pattern.
version_pattern
The version pattern.
description_pattern
The description pattern.
version_pattern
The version pattern.
target_type
The target type.
platform_id
The platform id, for example 226 for Linux x86_64.
Example 1
The following example searches the database image for names that contain GI.
emcli db_software_maintenance -searchImage
-name_pattern="%GI%"
Example 2
The following example searches the database image for the Linux x86_64 platform (platform id 226).
emcli db_software_maintenance -searchImage
-platform_id="226"
db_software_maintenance -updateVersionStatus
Updates the version status of the image.
Format
emcli db_software_maintenance -updateVersionStatus
[-version_id= "version_id"] -status= "status"
[ ] indicates that the parameter is optional.
Parameters
version_id
The version id.
status
The status of the version, for example DRAFT, ACTIVE, CURRENT, RESTRICTED.
Example
The following example updates the version of the image with the version ID 02A635AOD8D904A4E05362F3E40ADFD8 to CURRENT.
emcli db_software_maintenance -updateVersionStatus
-version_id=02A635AOD8D904A4E05362F3E40ADFD8
-status=CURRENT
db_software_maintenance -createVersion
Creates a new version in an existing image using an existing software library component.
Format
emcli db_software_maintenance -updateVersionStatus
-version_name= "version_name" -image_id= "image_id" -external_id= "external_id" -status= "status"
Parameters
version_name
The name of the version.
image_id
The ID of the image.
external_id
The external ID of the version. For example, it will be the Uniform Resource Name (URN) of the Software Library gold image.
status
The status of the version, for example DRAFT, ACTIVE, CURRENT, RESTRICTED.
Example
The following example creates a version, Version1.
emcli db_software_maintenance -createVersion
-version_name="Version1"
-image_id="01B5F14FD57D7B89E05313B2F00A739F"
-external_id="oracle:defaultService:em:provisioning:1:cmp:COMP
Component:SUB_OracleDB:0191172464DD36B6E05313B2F00AB90A:0.1"
-status=CURRENT
db_software_maintenance -deleteImage
Deletes an image.
Format
emcli db_software_maintenance -deleteImage
-image_id= "image_id" [-force= "force"]
[ ] indicates that the parameter is optional.
Parameters
image_id
The ID of the image to be deleted.
force
Deletes forcibly even if the image has subscribed targets.
Example
The following example deletes the image with the ID 01B5F14FD57D7B89E05313B2F00A739F.
emcli db_software_maintenance -deleteImage
-image_id="01B5F14FD57D7B89E05313B2F00A739F
db_software_maintenance -createImage
Creates a new image.
Format
emcli db_software_maintenance -createImage
-image_name= "image_name"
-description= "description"
-type= "type"
-target_type= "target_type"
-version= "version"
-platform_id= "platform_id"
-status= "status"
Parameters
image_name
The name of the image.
description
The description of the image.
type
The type of the image, for example SWLIB if the image version will be in the Software Library.
target_type
The target type of the image. For example, if the image is being created to manage single instance Oracle Database then the target type is 'oracle_database.
version
The RDBMS version of the product, for example 11.2.0.4.0.
platform_id
The platform id, for example 226 for Linux x86_64.
status
The image status, for example PRODUCTION.
Example
The following example creates a new image with the name GI_11204.
emcli db_software_maintenance -createImage
-image_name="GI_11204"
-description="GI_11204"
-type="SWLIB"
-target_type=cluster -version=11.2.0.4.0
-platform_id=226 -status=PRODUCTION
db_software_maintenance -getImageSubscriptions
Returns the list of subscribed targets.
Format
emcli db_software_maintenance -getImageSubscriptions
-image_id= "image_id"
Parameters
image_id
The ID of the image.
Example
The following example returns a list of targets for the image with the ID ID01B5F14FD57D7B89E05313B2F00A739F.
emcli db_software_maintenance -getImageSubscriptions
-image_id="01B5F14FD57D7B89E05313B2F00A739F"
db_software_maintenance -getTargetSubscriptions
Returns a list of subscriptions for the specified target.
Format
emcli db_software_maintenance -getTargetSubscriptions
-target_name= "target_name" Target name
-target_type= "target_type" Target type
[-image_type= "image_type" Image type]
[ ] indicates that the parameter is optional.
Parameters
target_name
The name of the target.
target_type
The target type.
image_type
The image type.
Example
The following example returns a list of subscriptions for the Oracle Cloud Zone target with the name POOL NAME.
emcli db_software_maintenance -getTargetSubscriptions
-target_name="POOL NAME"
-target_type="oracle_cloud_zone"
db_software_maintenance -getVersions
Returns a list of the versions for the specified image.
Format
emcli db_software_maintenance -getVersions
-image_id= "image_id"
[-version_status= "version_status"]
[ ] indicates that the parameter is optional.
Parameters
image_id
The name of the image.
version_status
The status filter for the version.
Example
The following example returns a list of versions for the image with theID 01B5F14FD57D7B89E05313B2F00A739F.
emcli db_software_maintenance -getVersions
-image_id="01B5F14FD57D7B89E05313B2F00A739F"
-version_status=CURRENT
db_software_maintenance -getImages
Returns the list of images present in system.
Format
emcli db_software_maintenance -getImages
Example
The following example returns a list of images present in system.
emcli db_software_maintenance -getImages
db_software_maintenance -subscribeTarget
Creates new target or modifies the target subscription.
Format
emcli db_software_maintenance -subscribeTarget
-target_name= "target_name"
-target_type= "target_type"
-[parent_target_name= "parent_target_name"]
-[parent_target_type= "parent_target_type"]
-image_id= "image_id"
-[version_id= "version_id'
[ ] indicates that the parameter is optional.
Parameters
target_name
The name of the target.
target_type
The target type.
parent_target_name
The parent target name.
parent_target_type
The parent target type.
image_id
The image id.
version_id
The version id.
Example
The following example modifies the Oracle Cloud Zone target with the name POOL NAME.
emcli db_software_maintenance -subscribeTarget
-target_name="POOL NAME"
-target_type=oracle_cloud_zone
-image_id=FE55AD7AB28974EFE04313B2F00AD4A0
db_software_maintenance -unsubscribeTarget
Unsubscribes the specified target.
Format
emcli db_software_maintenance -subscribeTarget
-target_name= "target_name"
-target_type= "target_type"
-image_id= "image_id"
[-version_id= "version_id']
[ ] indicates that the parameter is optional.
Parameters
target_name
The name of the target.
target_type
The target type.
image_id
The image id.
Example
The following example unsubscribes the Oracle Cloud Zone target with the name POOL NAME and the image ID FE55AD7AB28974EFE04313B2F00AD4A0.
emcli db_software_maintenance -unsubscribeTarget
-target_name="POOL NAME"
-target_type=oracle_cloud_zone
-image_id=FE55AD7AB28974EFE04313B2F00AD4A0
db_software_maintenance -getSubscriptionsForContainer
Returns the subscriptions for the container target, for example database pool.
Format
emcli db_software_maintenance -getSubscriptionsForContainer
-image_id= "image_id"
-target_name= "target_name"
-target_type= "target_type"
Parameters
image_id
The image id.
target_name
The name of the target in Oracle Enterprise Manager.
target_type
The target type.
Example
The following example returns the subscriptions for the Oracle Cloud Zone target with the name POOL NAME and the image ID FE55AD7AB28974EFE04313B2F00AD4A0.
emcli db_software_maintenance -getSubscriptionsForContainer
-target_name="POOL NAME"
-target_type=oracle_cloud_zone
-image_id=FE55AD7AB28974EFE04313B2F00AD4A0
db_software_maintenance -createSoftwareImage
Creates a new software image for the specified the Oracle home. The createSoftwareImage verb either takes data from a text file or uses the getInputVariableList command.
Format
emcli db_software_maintenance -createSoftwareImage
[-data= "data"] [-getInputVariableList= "getInputVariableList"]
[ ] indicates that the parameter is optional.
Parameters
data
The path of the txt input file.
getInputVariableList
Provides the list of variables to be specified in the input file.
Example 1
To get the list of all of the parameters to be passed inside the data file, run the following command:
emcli db_software_maintenance -createSoftwareImage
-getInputVariableList=true
Example 2
The following example creates a new image and a version.
emcli db_software_maintenance -createSoftwareImage
-data="input_file=data:"/home/user/input_rac"
In this example, the contents of the input_rac file are:
IMAGE_NAME=DbGoldImage
IMAGE_DESCRIPTION=Gold Image for 11g db
REF_TARGET_NAME=ORACLE_HOME
IMAGE_SWLIB_LOC=Oracle Home Provisioning Profiles/11.2.0.3.0/linux_x64
REF_HOST_CREDENTIALS=ZONE_CREDS:TESTSUPERADMIN
WORKING_DIRECTORY=/tmp
STORAGE_TYPE_FOR_SWLIB=OmsShared
STORAGE_NAME_FOR_SWLIB=swlib
VERSION_NAME=Version1
Example 3
The following example creates a new version alone into an existing image.
emcli db_software_maintenance -createSoftwareImage
-data="input_file=data:"/home/user/input_rac"
In this example, the contents of the input_rac file are:
IMAGE_ID=01B5F14FD57D7B89E05313B2F00A739F
REF_TARGET_NAME=ORACLE_HOME
IMAGE_SWLIB_LOC=Oracle Home Provisioning Profiles/11.2.0.3.0/linux_x64
REF_HOST_CREDENTIALS=ZONE_CREDS:TESTSUPERADMIN
WORKING_DIRECTORY=/tm
STORAGE_TYPE_FOR_SWLIB=OmsShared
STORAGE_NAME_FOR_SWLIB=swlib
VERSION_NAME=Version1
Defines a diagnostic check exclusion with regard to groups and checks to exclude.
emcli define_diagcheck_exclude
-target_type="type"
-exclude_name="name"
{ [-excl_group="diag_group" ]*
[-excl_check="diag_check" ]* |
-input_file=excl_def:<complete_path_to_file> }
[ ] indicates that the parameter is optionalis optional
target_type
Type of target.
exclude_name
Name to use for the exclusion.
excl_group
Group of diagchecks to exclude.
excl_check
Name of diagcheck to exclude.
input_file
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
Deletes target association instances.
emcli delete_assoc
-assoc_type="association type"
-source="target_name:target_type"
-dest="target_name1:target_type1[;target_name2:target_type2..]"
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
delete_assoc(
assoc_type="association type"
,source="target_name:target_type"
,dest="target_name1:target_type1[;target_name2:target_type2..]"
[,separator="separator:attribute_name:character"
[,subseparator="subseparator:attribute_name:character"] )
[ ] indicates that the parameter is optional.
assoc_type
Association type.
source
Target name and target type of the source target.
dest
Target name and target type of the destination targets.
separator
By default, multi-value input attributes use a semicolon ( ; ) as a separator. Specifying this option overrides the default separator value.
Example: separator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new separator character.Example: separator="att=#"
subseparator
By default, multi-value input attributes use a colon ( : ) as a subseparator. Specifying this option overrides the default subseparator value.
Example: subseparator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new subseparator character.Example: separator="att=#"
0 indicates that the verb processing was successful.
Non-zero values indicate that the verb processing was not successful.
Deletes the specified Hadoop cluster target and all its children. If this is the last cluster in the BDA target, also deletes the BDA target and all its children.
If Hadoop clusters are spread across multiple racks, performs deletions across the BDA rack. If other clusters exist within the BDA rack, relocates any shared targets before deleting the Hadoop cluster target.
The following example deletes the acme cluster target and all of its children. If acme is the last cluster in the BDA rack, deletes the rack and all of its children. If there are other clusters in the rack, relocates shared targets before deleting the cluster.
emcli delete_bda_cluster
-cluster="acme"
Deletes a blackout that has already ended or has been fully stopped. You cannot delete a blackout that is either in progress or currently scheduled. You need to first run stop_blackout.
emcli delete_blackout
-name="name"
[-createdby="blackout_creator"]
[ ] indicates that the parameter is optional
name
Name of the blackout to delete.
createdby
Enterprise Manager user who created the blackout. The default is the current user. The SUPER_USER privilege is required to delete a blackout created by another user.
This example deletes blackout backup_monthly created by the current user.
emcli delete_blackout -name=backup_monthly
This example deletes blackout db_maintenance that was created by Enterprise Manager administrator sysadmin2. The current user must either be user sysadmin2 or a user with the SUPER_USER privilege.
emcli delete_blackout -name=db_maintenance -createdby=sysadmin2
Deletes the custom charge item from Chargeback.
target_type
Target type associated with the custom charge item.
item_name
Name of the custom charge item to be deleted.
This example deletes a custom charge item named total_proc associated with the host target type:
emcli delete_charge_item
-target_type="host"
-item_name="total_proc"
This example deletes a custom charge item named custom_config associated with the Oracle Database target type:
emcli delete_charge_item
-target_type="oracle_database"
-item_name="custom_config"
Deletes the cloud service instances based on the specified filter.
emcli delete_cloud_service_instances
-user="username"
[-family="family"]
[-type="service type"]
[ ] indicates that the parameter is optional
user
Identifies the name of the user to be used for filtering the service instances that are to be deleted.
family
Identifies the service family name to use to filter cloud requests.
type
Identifies the Service Type to be used for filtering the service instances that are to be deleted.
This example deletes all cloud instances whose owner is the specified user (user1):
emcli delete_cloud_service_instances -user="user1"
This example deletes all cloud instances that are owned by a specified user (user1) and belong to a specified service family (family1):
emcli delete_cloud_service_instances -user="user1" -family="family1"
This example deletes all cloud instances that are owned by a specified user (user1) and belong to a specified service type (type1):
emcli delete_cloud_service_instances -user="user1" -type="type1"
This example deletes all cloud instances that are owned by a specified user (user1), belong to a specified service family (family1), and belong to a specified service type (type1):
emcli delete_cloud_service_instances -user="user1" -family="family1" -type="type1"
Deletes cloud user objects including cloud service instances and requests.
emcli delete_cloud_user_objects
-user="username"
[-purge]
[-force]
[ ] indicates that the parameter is optional
user
Identifies the name of the user to be used for filtering user objects.
purge
Sets a flag to purge the completed cloud service requests. Default is false unless this parameter is used.
force
Sets a flag to attempt to cancel In Progress requests. Depending on the job state, there may be some manual cleanup required.
USE WITH CAUTION. There is no way to undo the operation once started.
Delete all cloud objects owned by a specified user (user1) and cancel all scheduled requests:
emcli delete_cloud_user_objects -user="user1"
Delete all cloud objects owned by a specified user (user1), cancel all scheduled requests, and purge all completed requests:
emcli delete_cloud_user_objects -user="user1" -purge
Delete all cloud objects owned by a specified user (user1), cancel all scheduled requests, and cancel all In Progress requests:
emcli delete_cloud_user_objects -user="user1" -force
Deletes a credential set. Only Enterprise Manager Super Administrators can delete credential sets. Out-of-box credential sets cannot be deleted.
set_name
Credential set name to be deleted.
target_type
Target type of the credential set.
Deletes the custom plug-in update for a plug-in. All subsequent plug-in deployments will use the latest applicable version or revision available with Enterprise Manager Self Update.
Does not automatically redeploy to Management Agents on which this custom plug-in update was previously deployed. Applies only to subsequent plug-in deployments.
plugin
ID, version, and revision of the plug-in. To view the version and revision of a plug-in, run 'emcli list_custom_plugin_updates'.
Deletes a database and target from Oracle Enterprise Manager.
emcli delete_database
-inputFile="File containing properties required for deleting a database"
inputFile
The location and name of the file containing the properties required for deleting the database.
Deletes the database quota for an SSA user role.
emcli delete_dbaas_quota
-role_name="<SSA user role name>"
[ ] indicates that the parameter is optional.
Deletes an existing database profile component.
emcli delete_dbprofile -comp_loc="Database Profile component location and name in software library" [-version="Database Profile component version name"] [ ] indicates that the parameter is optional.
comp_loc
Combination of database profile component location and name.
version
Database profile component version name.
The following example deletes Database profile component with the profile name "RMAN_Profile", version "RMAN_Backup_10_04_14_12_40_PM" and location "Database Provisioning Profiles/11.2.0.4.0/linux_x64".
emcli delete_dbprofile -comp_loc="Database Provisioning Profiles/11.2.0.4.0/linux_x64/RMAN_Profile" -version="RMAN_Backup_10_04_14_12_40_PM"
Deletes a specified diagnostic snapshot.
emcli delete_diag_snapshot
-name="<diag_snapshot_name>"
[-debug]
[ ] indicates that the parameter is optional
name
Name of the diagnostic snapshot to be deleted. Ensure that the diagnostic snapshot exists for the specified name.
debug
Runs the verb in verbose mode for debugging purposes.
Deletes a Fusion Middleware provisioning profile from software library.
emcli delete_fmw_profile
-location="Profile Location"
-source="source"
-dest="association type"
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
[ ] indicates that the parameter is optional.
location
The complete software library path to the profile. Use the list_fmw_profiles verb to identify the complete path.
Note:
The name and owner parameters must be used together.Deletes a group. Deleting a non-existent group generates the error "Group X does not exist."
This example removes the group payroll_group that consists of database target types.
emcli delete_group -name=payroll_group
This example removes the group my_hosts that consists of host target types.
emcli delete_group -name=my_hosts
This example removes the group my_group that consists of mixed target types.
emcli delete_group -name=my_group
Deletes one or more open incidents based on the provided IDs, up to a maximum of 20 incidents. This removes any association with the underlying events and annotates them accordingly. Incident deletion does not remove the actual underlying events: These events will remain open.
Privilege Requirements: Only users with Manage Incident privilege can delete the incident.By default, incidents that have workflow attributes (such as Escalation, Priority, Resolution Status, Acknowledgement, Owner Assignment, or Suppression) set to non-default values will not be deleted unless the -force option is used.Closed incidents, diagnostic (ADR) incidents, and incidents with tickets created cannot be deleted.The status of each incident deletion is displayed upon command execution.
emcli delete_incident_record
-incident_number_list="Comma-separated list of incident numbers"
[-force]
[-preview]
[ ] indicates that the parameter is optional
incident_number_list
Comma-separated list of incident numbers (up to 20) to be deleted.
force
Deletes incidents without checking for their non-default workflow values.
preview
Displays whether or not specified incidents (by incident number) can be deleted.
This example displays whether or not incidents 173, 1886, 32, 5, and 853 can be deleted.
The command output is shown below.
emcli delete_incident_record -incident_number_list="173,1886,32,5,853" -preview ========= RESULTS ========= => Incident 173 can be deleted. => Incident 1886 can only be deleted using the -force option, as one or more incident workflow attributes have been been used. => Incident 32 cannot be deleted because there is ticket attached with the incident. => Incident 5 cannot be deleted because user AdminX does not have at least a manage incident privilege. => Incident 853 can be deleted.
This example deletes incidents 178, 1886, and 853 without checking for non-default incident workflow values. The command output is shown below.
emcli delete_incident_record -incident_number_list="173,1886,853" -force ========= RESULTS ========= => Incident 173 has been successfully deleted. => Incident 1886 has been successfully deleted. => Incident 853 has been successfully deleted.
Deletes a stopped or completed deployment instance. An instance can only be deleted when its status is stopped, completed, or completed with an error.
emcli delete_instance
[-instance=<instance_guid>]
[-exec=<execution_guid>]
[-name=<execution_name>]
[-owner=<execution_owner>]
[ ] indicates that the parameter is optional
Deletes a job or a set of jobs matching the filter criteria. A job cannot be deleted if any of its executions are active. All executions must be in one of the following states:
ABORTED, FAILED, COMPLETED, STOPPED, SKIPPED
Use the get_jobs verb to obtain a list of existing jobs along with their job IDs and statuses.
emcli delete_job
[-job_id="ID1;ID2;..."]
[-name="job name pattern"]
[-owner="job owner"]
[-type="job type"]
[-targets="target name:target type"]
[-input_file=property_file:"filename"]
[-preview]
[ ] indicates that the parameter is optional
job_id
Semi-colon ( ; ) separated list of job(s) to delete.
NOTE: This filter cannot be used with other filters.
name
Name or pattern of the job to delete. To uniquely identify the job, the current user is used.
owner
Owner of the job(s).
type
Job type of the job(s).
targets
Target name and target type of the job(s) to be deleted.
input_file
The properties for filtering jobs can be specified in "filename". Any jobs matching all the specified filter criteria are deleted. You must specify at least one filter, and the logged in administrator must have the necessary privileges on the matching jobs.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
preview
Lists only the jobs to be deleted. In the list of options you specify, if -preview is not one of the options, jobs are deleted, and then these jobs will be listed. If -preview is one of the options, the identical list is shown, but no jobs are deleted.
This example deletes an existing job with the job ID 12345678901234567890123456789012.
emcli delete_job -job_id=12345678901234567890123456789012
This example deletes all jobs of type "Backup."
emcli delete_job -type=Backup
This example stops and deletes a job named MY_JOB owned by the logged in administrator. You can use the stop and delete pattern to delete active jobs.
emcli stop_job -name=my_job emcli delete_job -name=my_job
Deletes a library job you created using the create_library_jobs command.
emcli delete_library_job
-name=<"library_job_name">
[-owner=<"library_job_owner">]
[ ] indicates that the parameter is optional
name
Name of the library job.
owner
Owner of the library job if different from the current logged-in EM CLI administrator.
This example deletes the library job "libjob1" owned by the current logged-in Enterprise Manager administrator.
emcli delete_library_job -name=libjob1
This example deletes the library job "libjob2" owned by the Enterprise Manager administrator "emadmin1."
emcli delete_library_job -name=libjob2 -owner=emadmin1
Deletes a promoted metric.
emcli delete_metric_promotion
-name=<service_target_name>
-type=<service_target_type>
[-category=<usage/performance/business>]
[-promotedMetricName=<promoted_metric]
[-promotedMetricColumn=<promoted_metric_column>]
-promotedMetricKey=<key_value_of_promoted_metric>
[ ] indicates that the parameter is optional
name
Name of the service target.
type
Name of the service type.
category
Defines whether the promoted metric is a usage or a performance metric of a service. This determines the promoted metric name and metric column. If you do not specify this, you must specify the promotedMetricName and promotedMetricColumn.
promotedMetricName
Promoted metric name. This is optional if you specify the category .
promotedMetricColumn
Promoted metric column. This is optional if you specify the category .
promotedMetricKey
Determines the key value of the promoted metric. It is equivalent to the displayed name of the promoted metric in the user interface.
Deletes patch plans.
name
Specifies the names of the patch plans that you want to delete. Use a comma as a separator if you want to specify multiple patch plans for this parameter.
Deletes a PaaS Infrastructure Zone. A PaaS Infrastructure Zone cannot be deleted if an existing software pool is associated with it.
emcli delete_paas_zone
-name="<name of PaaS Zone>
[ ] indicates that the parameter is optional.
Deletes patches from the software library.
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Deletes pluggable databases (PDBs).
emcli delete_pluggable_database
-cdbTargetName="CDB_of_target_PDBs"
-cdbTargetType="CDB_target_type"
-cdbHostCreds="CDB_host_credentials"
-cdbTargetCreds="CDB_target_credentials"
-pdbName="PDB_names"
[-cdbHostPrivCreds="CDB_host_privileged_credentials"]
[-ignoreStorageWarnings]
[ ] indicates that the parameter is optional.
cdbTargetName
Target container database (CDB) that contains the PDBs that you want to delete. Ensure that the target CDB you specify is a valid target in Enterprise Manager.
cdbTargetType
Database type of the target CDB, which can be oracle_database, and so on.
rac_database,
cdbHostCreds
Credentials for the host on which the target CDB is located.
cdbTargetCreds
Credentials for the target CDB.
pdbName
Names of the PDBs that you want to delete. Ensure that you separate the names using a comma.
cdbHostPrivCreds
Privileged credentials for the host on which the Snap Clone storage mount points are located. Note that this parameter is required only if you are deleting PDBs that were created using Snap Clone.
ignoreStorageWarnings
Ignore any storage warnings that may be generated while deleting PDBs that were created using Snap Clone.
This example deletes the test_pdb PDB, which is a part of test_CDB, an Oracle single-instance CDB, using HOST_CREDS as the CDB host credentials and DB_CREDS as the CDB target credentials:
emcli delete_pluggable_database -cdbTargetName=test_database -cdbTargetType=oracle_database -pdbName=test_pdb -cdbHostCreds=HOST_CREDS -cdbTargetCreds=DB_CREDS
Deletes a software pool. A software Pool cannot be deleted if there is an existing service template associated with it.
emcli delete_pool
-name="<software pool name>"
-target_type="<software pool target type>"
[ ] indicates that the parameter is optional.
name
The name of the existing software pool.
target_type
The target type of the existing software pool.
Deletes a privilege delegation setting template.
emcli delete_privilege_delegation_settings
-setting_names="setting_name1;setting_name2;setting_name3;"
Deletes an existing resolution state. You typically use this command for resolution states that are no longer used. You need to also specify an alternative resolution state in case there are any references to the state. In this case, the references are changed to this alternative state. This action might require some time.
Only a super administrator can execute this command. A success message is reported if the command is successful. An error message is reported if the deletion fails.
Note:
No notifications are sent for any incidents or problems updated in this process.
emcli delete_resolution_state
-label="label of the state to be deleted"
-alt_res_state_label="alternative resolution state"
label
Label of the state to be deleted.
alt_res_state_label
Alternative state to be used.
Deletes a service template.
emcli delete_service_template
-name="<service template name>"]
-service_family="<service family name>"]
[ ] indicates that the parameter is optional.
name
Name of the existing service template.
service_family
Service family to which the service template belongs; for example, DBAAS for database and MWAAS for middleware.
Deletes one or more Siebel Enterprise instances and their associated targets, such as Siebel servers, component groups, components, work flows, and so on.
emcli delete_siebel
-enterprise=<Siebel_enterprise_1>,<Siebel_enterprise_2>
[-out_file='<output_file>']
[<-debug>]
[ ] indicates that the parameter is optional
enterprise
Target name of the Siebel enterprise as seen in the Enterprise Manager console. If multiple enterprises need to be deleted at the same time, provide a comma-separated ( , ) value.
out_file
Fully-qualified path of the output file. The output of the command is redirected to this file.
If you include this option, the list of deleted targets are printed in the file. If you do not include this option, the list is printed on the console directly.
debug
Executes in verbose mode and generates debug log messages in the output.
Deletes the Site Guard configuration. The entire configuration (scripts, credential associations, site associations, operation plans) pertaining to the specified system and all the associated standby systems are deleted.
emcli delete_siteguard_configuration
-primary_system_name=<name> | -standby_system_name=<name>
primary_system_name
Name of the primary system. Specify either primary_system_name or
standby_system_name.
standby_system_name
Name of the standby system.
emcli delete_siteguard_configuartion
-primary_system_name="BISystem1"
emcli delete_siteguard_configuration
-standby_system_name="BISystem2"
Deletes the credential association from the Site Guard configuration.
emcli delete_siteguard_credential_association
-system_name=<name>
[-target_name=<name>]
-credential_type=<type>
{ } indicates that the parameter is optional
system_name
Name of the system.
target_name
Name of the target.
credential_type
Type of the credential, which can be HostNormal, HostPrivileged, WLSAdmin, or DatabaseSysdba.
emcli create_siteguard_credential_association
-system_name="BISystem1"
-credential_type="HostNormal"
-credential_name="HOST-SGCRED"
-credential_owner="sysman"
emcli create_siteguard_credential_association
-system_name="BIsystem1"
-target_name="database-instance"
-credential_type="HostNormal"
-credential_name="HOST-DBCRED"
-credential_owner="sysman"
Updates the limit for Apply lag and Transport lag for all or selected databases of the system.
emcli delete_siteguard_lag
[-system_name="name_of_the_system"]
[-target_name="name_of_the_database"]
[-property_name="lag_type"]
[ ] indicates that the parameter is optional
system_name
Name of the system whose lag limit property you want to update.
target_name
Name of the target database whose lag limit property you want to update.
property_name
Name of the lag property. Valid values for this parameter are ApplyLag and TransportLag.
This example deletes the ApplyLag property on all of the databases configured on austin-system:
emcli delete_siteguard_lag
-system_name="austin-system"
-property_name="ApplyLag"
The following example deletes the TransportLag property on the database OID-db configured on austin-system:
emcli delete_siteguard_lag
-system_name="austin-system"
-target_name="OID_db"
-property_name="TransportLag"
Deletes the host or hosts associated with a given script.
script_id
ID associated with the script.
host_name
Name of the host where this script will be run. You can specify this parameter more than once.
Deletes a system.
emcli delete_system
-name="name"
[-type=<generic_system>]
[ ] indicates that the parameter is optional
name
Name of the system to delete.
type
System type: generic_system. Defaults to "generic_system".
Deletes a specified target from the Enterprise Manager Cloud Control monitoring framework. Deleting a target removes it from the Management Repository and does not physically remove the target itself.
You can use the get_targets verb to obtain a list of available targets and their respective types.
emcli delete_target
-name=<name>
-type=<type>
[-delete_monitored_targets]
[-async]
[-delete_members]
[ ] indicates that the parameter is optional
name
Target name.
type
Target type.
delete_monitored_targets
Deletes the targets monitored by the specified Management Agent. This is only applicable with the oracle_emd target type.
async
Deletes the target asynchronously.
delete_members
Deletes all the members of the target as well.
This example deletes the oracle_database target with the name database.
emcli delete_target
-name="database"
-type="oracle_database"
This example deletes the Agent named test.example.com:1836 and all of its monitored targets. The Agent must be marked UNREACHABLE in Enterprise Manger Cloud Control to perform this operation.
emcli delete_target
-name="test.example.com:1836"
-type="oracle_emd"
-delete_monitored_targets
-async
This example deletes the example_ias_farm target with the name "farm01_base_domain" and all of its members, such as domain, clusters, servers, application deployments, and so forth.
emcli delete_target
-name="farm01_base_domain"
-type="example_ias_farm"
-delete_members
Deletes a Services test along with its constituent steps and step groups.
emcli delete_test
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
[ ] indicates that the parameter is optional
name
Service target name.
type
Service target type.
testname
Name of the test.
testtype
Type of test.
Deletes a test threshold.
emcli delete_test_threshold
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
-metricName=<metric_name>
-metricColumn=<metric_column>
[-beaconName=<beacon_name>]
[-stepName=<step_name>]
[-stepGroupName=<stepgroup_name>]
[ ] indicates that the parameter is optional
name
Service target name.
type
Service target type.
testname
Name of the test.
testtype
Type of test.
metricName
Name of the metric.
metricColumn
Name of the column.
beaconName
Name of the beacon.
stepName
Name of the step.
stepGroupName
Name of the step group.
Deletes an existing Enterprise Manager administrator.
When a user is deleted, all jobs the user creates are stopped and deleted. Also, any blackouts the user creates are deleted. However, a user cannot be deleted if any blackouts the user creates are active at the time the call to delete the user is issued. This situation is considered an invalid state from which to delete a user. First, all of these active blackouts must be stopped, and a thwarted delete user call must be reissued.
emcli delete_user
-name=<user_name>
[-new_object_owner=<user_name>]
[-force]
[ ] indicates that the parameter is optional
name
Administrator name.
new_object_owner
Name of the administrator to assign the secure objects owned by the current administrator being deleted. If you do not specify this option, the secure objects are deleted that are owned by the administrator being deleted.
force
Deletes the administrator even if the administrator is currently logged in.
Deletes pluggable databases (PDBs).
emcli delete_pluggable_database
-cdbTargetName="CDB_of_target_PDBs"
-cdbTargetType="CDB_target_type"
-cdbHostCreds="CDB_host_credentials"
-cdbTargetCreds="CDB_target_credentials"
-pdbName="PDB_names"
[-cdbHostPrivCreds="CDB_host_privileged_credentials"]
[-ignoreStorageWarnings]
[ ] indicates that the parameter is optional.
cdbTargetName
The target container database (CDB) that contains the PDBs that you want to delete. Ensure that the target CDB you specify is a valid target in Enterprise Manager.
cdbTargetType
The database type of the target CDB. It can be oracle_database, rac_database, and so on.
cdbHostCreds
The credentials for the host on which the target CDB is located.
cdbTargetCreds
The credentials for the target CDB.
pdbName
The names of the PDBs that you want to delete. Ensure that you separate the names using a comma.
cdbHostPrivCreds
The privileged credentials for the host on which the Snap Clone storage mount points are located. Note that this parameter is required only if you are deleting PDBs that were created using Snap Clone.
ignoreStorageWarnings
Specify this option to ignore any storage warnings that may be generated while deleting PDBs that were created using Snap Clone.
This example deletes the test_pdb PDB, which is a part of test_CDB, an Oracle single-instance CDB, using HOST_CREDS as the CDB host credentials and DB_CREDS as the CDB target credentials:
emcli delete_pluggable_database -cdbTargetName=test_database -cdbTargetType=oracle_database -pdbName=test_pdb -cdbHostCreds=HOST_CREDS -cdbTargetCreds=DB_CREDS
This verb deploys all of the Enterprise Manager Oracle-provided reports, or optionally, specific Enterprise Manager Plug-in reports to the BI Publisher catalog
You can also use this verb to upload a reports jar file (located on the OMS(s)'s file system. The operation does not overwrite existing BI Publisher Reports in the Enterprise Manager reports folder unless you specify the -force option.
Note:
This verb requires Enterprise Manager Super Administrator privileges.
emcli deploy_bipublisher_reports
[-force]
[-all | -reportsjarfile=<reports_jar_file> | (-pluginid=<plugin_id>
[-pluginversion=<plugin_version>]) )
[ ] indicates that the parameter is optional
Note:
Using -force applies to the entire operation. The absence of all parameters assumes -all.You can specify the -all option, or -reportsjarfile option, or -pluginid option, but not all three at the same time. If you use the -pluginid option, you can also also include the -pluginversion option.
force
Overwrites reports. If you use this option, all reports on the BI Publisher server are overwritten with the new copies.
all
Overwrites reports. If you use this option, all reports on the BI Publisher server are overwritten with the new copies.
reportsjarfile
Deploys a single Enterprise Manager reports jar file that contains one or more BI Publisher Reports. This jar file is located relative to the OMS's $ORACLE_HOME.
pluginid
In addition to Enterprise Manager system reports, also deploys any subsequently loaded plug-in-based BI Publisher Reports.
pluginversion
Limits the plug-ins to a specific version.
This example deploys all platform and plug-in Enterprise Manager Oracle-provided reports, but does not overwrite any existing reports
emcli deploy_bipublisher_reports -all
This example deploys only the Chargeback and Trending reports, and overwrites any existing reports.
emcli deploy_bipublisher_reports -force -pluginid=oracle.sysman.emct -pluginversion=12.1.0.3.0
Deploys Self Update Enterprise Manager reports to the BI Publisher catalog. To deploy all reports in a folder, specify the -folder option. To deploy a single report, use the -folder and -report options. To deploy all Self Update reports, use the -all option.
The deploy operation will not overwrite existing BI Publisher reports in the BI Publisher catalog unless the -force option is given.
emcli deploy_bipublisher_selfupdates
[-force]
-all | (-folder=<folder> [-report=<reportname>])
[ ] indicates that the parameter is optional.
force
Overwrites any existing reports in the BI Publisher catalog with the copy being deployed.
all
Deploys all Self Update reports.
folder
Limits the reports deployed to the specified folder. By default, all reports in the folder are deployed unless the -report option is also specified.
report
Deploys a single, specified report. The -folder parameter must be specified when using the -report parameter.
Example 1
The following example deploys all Self Update reports, but does not overwrite any existing reports:
emcli deploy_bipublisher_selfupdates -all
Example 2
The following example deploys all Self Update reports to the Compliance Reports folder:
emcli deploy_bipublisher_selfupdates -folder="Compliance Reports"
Example 3
The following example deploys only the Self Update report named Consolidation Report located in the Compliance Reports folder and overwrites any existing report.
emcli deploy_bipublisher_selfupdates -force -folder="Compliance Reports" -report="Consolidation Report"
Deploys a plug-in on Management Agents. Agent names must be provided for plug-in deployment.
Note:
A plug-in can only be deployed on any Management Agent after it has been successfully deployed on the management server.
emcli deploy_plugin_on_agent
-agent_names=<agent1;agent2>
-plugin=<plug-in_id[:version>]
[-discovery_only]
[ ] indicates that the parameter is optional
agent_names
Management Agents (host:port) on which the plug-in needs to be deployed.
plugin
Plug-in ID and version that needs to be deployed. Version is optional, and it defaults to the latest applicable version deployed on the management server. If a later version is available but not certified on the Agent OS platform, the latest version is not picked up.
discovery_only
To be used when only discovery content needs to be deployed.
This example deploys the latest version of oracle.sysman.db2 on Management Agent myhost1.example.com.
emcli deploy_plugin_on_agent -plugin="oracle.sysman.db2" -agent_names="myhost1.example.com:1838"
This example deploys version 12.1.0.1.0 of plug-in oracle.sysman.db2 on management agent myhost1.us.example.com.
emcli deploy_plugin_on_agent
-plugin="oracle.sysman.db2:12.1.0.1.0"
-agent_names="myhost1.us.example.com:1838"
Deploys a plug-in on the Management Servers. The deployment process for some plug-ins might restart the Management Servers. If the plug-in is already deployed on one of the servers, this server is skipped. If a lower version of the plug-in is already deployed, the plug-in is upgraded. If a lower revision of the plug-in is already deployed, the new revision is applied.
emcli deploy_plugin_on_server
-plugin=<plug-in_id>[:<version>]
[-sys_password=<sys_password>]
[-prereq_check]
[-use_last_prereq_result]
[ ] indicates that the parameter is optional
plugin
ID or ID:Version of the plug-in to be deployed on the Management Servers of the form -plugin=<oracle.sysman.db:12.1.0.1.0>, where the plug-in ID (like oracle.sysman.db) is a required parameter, and the version is optional. If do not specify a version, the highest version of the plug-in that has been downloaded is considered for deployment. If multiple revisions of this plug-in version are downloaded, the highest revision is considered for deployment.
sys_password
Password of the repository DBA SYS. If you do not provide this , you are prompted for the password. This is not required if you use the prereq_check .
prereq_check
If you provide this option, instead of deploying the plug-in, the verb displays only a check for all the unfulfilled prerequisites for this plug-in deployment to be successful. If you do not provide this option, plug-in deployment follows a prerequisities check.
use_last_prereq_result
If prerequisites checks have been performed previously for a given set of plug-ins using the -prereq_check option and no other deployment activity occurred for these plug-ins, you can use this option to skip prerequisite checks and start the deployment immediately.
This example deploys the latest downloaded version of Oracle Database plug-in (plug-in ID: oracle.sysman.db) on the management server.
emcli deploy_plugin_on_server
-plugin=oracle.sysman.db
-sys_password=<sys_password>
This example deploys the latest downloaded version of a Oracle Database plug-in (plug-in ID: oracle.sysman.db) and Oracle Fusion Middleware plug-in (oracle.sysman.emas) on the management server.
emcli deploy_plugin_on_server
-plugin="oracle.sysman.db;oracle.sysman.emas"
-sys_password=<sys password>
This example deploys the Oracle Database plug-in (with version 12.1.0.2.0) and Oracle Fusion Middleware plug-in (version 12.1.0.2.0) on the management server. Since sys password has not been passed on the command line, you are prompted for it.
emcli deploy_plugin_on_server
-plugin="oracle.sysman.db:12.1.0.2.0;oracle.sysman.emas:12.1.0.2.0"
The folllowing example deploys the Oracle Database plug-in (with version 12.1.0.2..0) and Oracle Fusion Middleware plug-in (12.1.0.2.0) on the management server. Since sys password has not been passed on the command line, you are prompted for it. If a lower version of both plug-ins have already been deployed, they are upgraded to 12.1.0.2.0. If a lower version of only one of the plug-ins is deployed, this generates an error, and you will have to deploy them separately.
emcli deploy_plugin_on_server
-plugin="oracle.sysman.db:12.1.0.2.0;oracle.sysman.emas:12.1.0.2.0"
This example only performs prerequisite checks on the Oracle Database plug-in and does not actually deploy the plug-in.
emcli deploy_plugin_on_server
-plugin=oracle.sysman.db:11.2.0.1.0 -prereq_check
Takes a list of agents and deregisters each agent as a forwarding agent.
emcli deregister_forwarder_agents
-agent_list="agent_list"
[ ] indicates that the parameter is optional.
agent_list
List of agents that need to be deregistered as forwarders. The agents must be separated by space.
Lists and describes all database profile creation input variables.
emcli describe_dbprofile_input [-data_mode={EXPORT/DBCA_TEMPLATE/RMAN/STORAGE_SNAPSHOT}]
[ ] indicates that the parameter is optional.
Provides a description of the Fusion Middleware provisioning profile from the software library.
location
The complete software library path to the profile. Use the list_fmw_profiles verb to identify the complete path.
Note:
The name and owner parameters must be used together.Describes a job and gets its properties for a job you have submitted from the user interface or using the create_job verb. The output can be redirected into a file and used as a template.
This verb support multi-task jobs.
emcli describe_job
-name=<"job_name">
[-owner=<"job_owner">]
[-verbose]
[ ] indicates that the parameter is optional
name
Name of the job to describe.
owner
Enterprise Manager administrator who owns this job. If not provided, the current EM CLI logged-in administrator is assumed as the owner. The logged-in Enterprise Manager administrator must have at least the view privilege to describe a job.
verbose
Outputs a help template along with the properties.
This example describes the library job "myJob" owned by the logged-in Enterprise Manager administrator.
emcli describe_job -name=myJob
This example describes the library job "yourJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this job.
emcli describe_job -name=yourJob -owner=admin1
emcli describe_job -name=EMCLI_JOB_2 # Job Name : EMCLI_JOB_2 # Current status of the job is ACTIVE. # Job Type: OSCommand. # This job type supports the following target types only : # host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. target_list=myHost:host # Variable: args # Description: Parameters of the command to run on the target variable.args=hello # Variable: command # Description: Command to run on the target variable.command=echo # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.myHost:host=NAMED:Admin1:CRED1 schedule.frequency=REPEAT_BY_MINUTES schedule.startTime=2012-02-01 01:01:01.0 schedule.endTime=2051-02-01 01:01:01.0 schedule.gracePeriod=-1 schedule.months= schedule.days= schedule.interval=1 schedule.timezone.type=TIMEZONE_TARGET schedule.timezone.targetIndex=1 schedule.timezone.zoneOffset=0 schedule.timezone.region=
emcli describe_job -name=EMCLI_JOB_2 -verbose # Job Name : EMCLI_JOB_2 # Current status of the job is ACTIVE. # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # Target List. # In a target list, each member is specified using the target name and target type # in the fashion: # target_name:target_type # To specify an element of the target list, the following notation is used: # job_target_list.1=target_name:target_type # The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element. # The target target_name:target_type should exists in EM. # Permissible target types are: host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # A sample target list could be: # job_target_list.1=<target_name>:host # job_target_list.2=<target_name>:host # The target list can only contain targets of the same target type. A cluster, # group, domain or system # target must not be intermixed with targets of the other target types. # Variable List. # In a variable list, each member is specified in the following way: # Scalar variable: A variable whose value can be represented as a single string. # variable.variable_name=variable_value # Here "variable" is a keyword. Variable name is the name of the variable whose # value is being specified. # Value is specified on the right hand side after the equal to sign. # Vector variable: A variable whose value is represented as an array or list of # string values. # variable.variable_name.1=value1 # variable.variable_name.2=value2 # Here the numbers suffixing the variable name signify the entry number in the # list. # Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable. # variable.large_variable_name=a_very_very_big_value # Credential List. # This is the list of credential usages declared by the job type. # Each entry takes the form: # cred.credusage_name.target_details=cred_type:cred_details # Here the prefix "cred" is a keyword signifying that this line represents a # credential entry. # "credusage_name" would be substituted with the name of the credential usage # declared in the job type. # This is followed by the target details, which take the following form: # target_name:target_type # The value for this credential usage entry is specified using the type of the # credential and its details. # "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential. # "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type" # A sample entry for a target target1:host for credential usage defaultHostCred # for a credential set could look like: # cred.defaultHostCred.target1:host=SET:HostCredsNormal # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential could look like: # cred.defaultHostCred.target1:host=NAMED:MyNamedCredential # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential shared by EM Admin "admin1" could look like: # cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential # Schedule. # Specify a schedule for the job. Detailed instructions as per below: # Frequency: Specifies the frequency of repeatedly submitting instances of this # job. # scheule.frequency=Frequency_Type # Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY, # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS. # If frequency is IMMEDIATE, then other schedule fields do not matter. # Start Time: Start time for the schedule. # scheule.startTime=MM-DD-YYYY # End Time: End time for the schedule. # scheule.endTime=MM-DD-YYYY # Grace Period: Grace period in minutes for the schedule. # scheule.graceperiod= # Months : Months for repetition. January is denoted by 0 and December by 11 # schedule.months=0,1,2 # Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6. # schedule.days=0,1,2 # Timezone: Timezone information is further detailed into type, target index, zone # offset and region. # schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED, # TIMEZONE_REGION_SPECIFIED. # schedule.timezone.targetIndex : specify the index of the target whose # timezone is to be used. # schedule.timezone.zoneOffset : timezone offset. # schedule.timezone.region : timezone region # Following is a complete schedule section, remove # and populate the values for # submission: # scheule.frequency=ONCE # schedule.startTime=12-21-2012 # schedule.endTime=12-21-2012 # schedule.gracePeriod=10 # schedule.months= # schedule.days= # schedule.timezone.type=TIMEZONE_TARGET # schedule.timezone.targetIndex=1 # schedule.timezone.zoneOffset= # schedule.timezone.region= job_target_list.1=myhost.us.example.com:host # Variable: args # Description: Parameters of the command to run on the target variable.args=hello # Variable: command # Description: Command to run on the target variable.command=echo # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.myhost.us.example.com:host=NAMED:SYSMAN:CRED1 schedule.frequency=REPEAT_BY_MINUTES schedule.startTime=2012-02-01 01:01:01.0 schedule.endTime=2051-02-01 01:01:01.0 schedule.gracePeriod=-1 schedule.months= schedule.days= schedule.interval=1 schedule.timezone.type=TIMEZONE_TARGET schedule.timezone.targetIndex=1 schedule.timezone.zoneOffset=0 schedule.timezone.region=
Describes the job type and gets its properties. The output can be redirected into a file.
This verb dumps out a properties file for a job type that supports the Job System Generic EM CLI. This file contains some documentation, a list of all required credential usages, and a list of all variables required to create a (library) job instance of the job type.
This verb support multi-task jobs.
emcli describe_job_type
-job_type=<"job_type_internal_name">
[-verbose]
[ ] indicates that the parameter is optional
job_type
Specify the name of the job type to describe. You can use the get_job_types verb to obtain the names of all job types for which a job or library jobs can be created using EM CLI.
verbose
Outputs a help template along with the properties.
This example describes the job type "MyJobType."
emcli describe_job_type -job_type=MyJobType
This example produces a property file on the console, which can be redirected to a file and used multiple times.
emcli describe_job_type -job_type=OSCommand # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # Variable: args # Description: Parameters of the command to run on the target variable.args= # Variable: command # Description: Command to run on the target variable.command= # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.<target_name>:<target_type>=
This example with the verbose option generates a property dump with help on how to specify each individual property for the job.
emcli describe_job_type -job_type=OSCommand -verbose # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # Target List. # In a target list, each member is specified using the target name and target type # in the fashion: # target_name:target_type # To specify an element of the target list, the following notation is used: # job_target_list.1=target_name:target_type # The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element. # The target target_name:target_type should exists in EM. # Permissible target types are: host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # A sample target list could be: # job_target_list.1=<target_name>:host # job_target_list.2=<target_name>:host # The target list can only contain targets of the same target type. A cluster, # group, domain or system # target must not be intermixed with targets of the other target types. # Variable List. # In a variable list, each member is specified in the following way: # Scalar variable: A variable whose value can be represented as a single string. # variable.variable_name=variable_value # Here "variable" is a keyword. Variable name is the name of the variable whose # value is being specified. # Value is specified on the right hand side after the equal to sign. # Vector variable: A variable whose value is represented as an array or list of # string values. # variable.variable_name.1=value1 # variable.variable_name.2=value2 # Here the numbers suffixing the variable name signify the entry number in the # list. # Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable. # variable.large_variable_name=a_very_very_big_value # Credential List. # This is the list of credential usages declared by the job type. # Each entry takes the form: # cred.credusage_name.target_details=cred_type:cred_details # Here the prefix "cred" is a keyword signifying that this line represents a # credential entry. # "credusage_name" would be substituted with the name of the credential usage # declared in the job type. # This is followed by the target details, which take the following form: # target_name:target_type # The value for this credential usage entry is specified using the type of the # credential and its details. # "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential. # "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type" # A sample entry for a target target1:host for credential usage defaultHostCred # for a credential set could look like: # cred.defaultHostCred.target1:host=SET:HostCredsNormal # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential could look like: # cred.defaultHostCred.target1:host=NAMED:MyNamedCredential # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential shared by EM Admin "admin1" could look like: # cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential # Schedule. # Specify a schedule for the job. Detailed instructions as per below: # Frequency: Specifies the frequency of repeatedly submitting instances of this # job. # scheule.frequency=Frequency_Type # Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY, # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS. # If frequency is IMMEDIATE, then other schedule fields do not matter. # Start Time: Start time for the schedule. # scheule.startTime=MM-DD-YYYY # End Time: End time for the schedule. # scheule.endTime=MM-DD-YYYY # Grace Period: Grace period in minutes for the schedule. # scheule.graceperiod= # Months : Months for repetition. January is denoted by 0 and December by 11 # schedule.months=0,1,2 # Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6. # schedule.days=0,1,2 # Timezone: Timezone information is further detailed into type, target index, zone # offset and region. # schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED, # TIMEZONE_REGION_SPECIFIED. # schedule.timezone.targetIndex : specify the index of the target whose # timezone is to be used. # schedule.timezone.zoneOffset : timezone offset. # schedule.timezone.region : timezone region # Following is a complete schedule section, remove # and populate the values for # submission: # scheule.frequency=ONCE # schedule.startTime=12-21-2012 # schedule.endTime=12-21-2012 # schedule.gracePeriod=10 # schedule.months= # schedule.days= # schedule.timezone.type=TIMEZONE_TARGET # schedule.timezone.targetIndex=1 # schedule.timezone.zoneOffset= # schedule.timezone.region= # Variable: args # Description: Parameters of the command to run on the target variable.args= # Variable: command # Description: Command to run on the target variable.command= # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.<target_name>:<target_type>=
Describes a library job and gets its properties. The output can be redirected into a file.
emcli describe_library_job
-name=<"job_name">
[-owner=<"job_owner">]
[-verbose]
[ ] indicates that the parameter is optional
name
Name of the library job to describe.
owner
Enterprise Manager administrator who owns this library job. If not provided, the current EM CLI logged-in administrator is assumed as the owner. The logged-in Enterprise Manager administrator must have at least the view privilege to describe a job.
verbose
Outputs a help template along with the properties.
This example describes the library job "myLibJob" owned by the logged-in Enterprise Manager administrator.
emcli describe_library_job -name=myLibJob
This example describes the library job "yourLibJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this library job.
emcli describe_library_job -name=yourLibJob -owner=admin1
emcli describe_library_job -name=MYJOB1 # Job Name : MYJOB1 # Current status of the job is ACTIVE. # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. job_target_list.1=myhost.us.example.com:host # Variable: args # Description: Parameters of the command to run on the target variable.args=hello # Variable: command # Description: Command to run on the target variable.command=echo # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.myhost.us.example.com:host=NAMED:SYSMAN:CRED1 schedule.frequency=REPEAT_BY_MINUTES schedule.startTime=2012-02-01 01:01:01.0 schedule.endTime=2051-02-01 01:01:01.0 schedule.gracePeriod=-1 schedule.months= schedule.days= schedule.interval=1 schedule.timezone.type=TIMEZONE_TARGET schedule.timezone.targetIndex=1 schedule.timezone.zoneOffset=0 schedule.timezone.region=
Describes the input data of a patch plan.
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Describes the input data of a deployment procedure or a procedure configuration.
emcli describe_procedure_input
[-procedure=<procedure_GUID>]
[-name=<procedure_name_or_procedure_conf>]
[-owner=<procedure_owner_or_procedure_config>]
[-parent_proc=<procedure_of_procedure_config>]
[ ] indicates that the parameter is optional
procedure
GUID of the procedure to execute.
name
Name of the procedure or procedure configuration.
owner
Owner of the procedure or procedure configuration.
parent_proc
Procedure of the procedure configuration. This applies to describe a procedure configuration when both a procedure and a procedure configuration have the same name.
Gets the status of diagnostic checks deployments against different target types.
emcli diagchecks_deploy_status
[-target_type=<type>]*
[ ] indicates that the parameter is optional
Gets the target list for a particular deployment type for a target type.
emcli diagchecks_deploy_tgtlist
-target_type=<type>
-deploy_type=<CURRENT|OLDER|MISSING|ALL>
[-show_excludes]
[ ] indicates that the parameter is optional
Disables configuration history computation for a target type.
target_type
Target type for which the configuration history is being disabled. The value should be the internal name or "*" to indicate all target types.
Disables monitoring of a Services test.
emcli disable_test
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
name
Service target name.
type
Service target type.
testname
Test name.
testtype
Test type.
Performs Big Data discovery for the specified host. Can be used for new discovery or for rediscovery of the latest configuration changes.
emcli discover_bda_cluster
-hostname="host_name"
-host_credential="host_named_cred"
-ilom_credential="ilom_named_cred"
-infiniband_credential="ibswitch_named_cred"
-cloudera_credential="cloudera_named_cred"
-snmp_string="SNMP_community_string"
hostname
The name of host in the Big Data Network.
host_credential
Named credentials for the oracle OS account that owns a Management Agent home.
ilom_credential
Named credentials for the root OS account on an Oracle Integrated Lights Out Manager (Oracle ILOM) server in the Big Data Network.
infiniband_credential
Named credentials for the nm2user OS account on an InfiniBand switch in the Big Data Network.
cloudera_credential
Named credentials for the admin account of the Cloudera Manager that manages the CDH cluster.
snmp_string
SNMP community string for PDU and Cisco switch traps. The read-only string is public.
The following example performs BDA cluster discovery on the host named acme101.com. If the cluster already exists, updates the latest configuration.
emcli discover_bda_cluster
-hostname="acme101.com"
-host_credential="HOST_CRED"
-ilom_credential="ILOM_CRED"
-infiniband_credential="IB_CRED"
-cloudera_credential="CM_CRED"
-snmp_string="public"
Discovers the Hadoop cluster for the specified Cloudera Manager host. Can also be used for rediscovery of the latest cluster configuration changes.
emcli discover_cloudera_cluster
-hostname = "host_name"
-cloudera_credential = "cloudera_named_cred"
-host_credential = "host_named_cred"
hostname
Name of one of the hosts that form the cluster.
cloudera_credential
Named credentials for the Cloudera Manager managing the cluster.
host_credential
Named credentials for the specified host.
Discovers one or more Coherence clusters.
emcli discover_coherence
-input_file=coherence_discovery_file:file_path
[-debug]
[ ] indicates that the parameter is optional
input_file
Fully-qualified path to a CSV-formatted file containing one line of details per Coherence cluster. The valid WebLogic version value is 10. The structure of the CSV file is as follows:
<Management Node host machine name>,
<Management Node listen port>,
<Management Node username - optional>,
<Management Node password - optional>,
<Management Node service name - optional>,
<Agent url>
For example:
host1.companyA.com,9910,,,,https://host1.companyA.com:3872/emd/main/,
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
debug
Runs the verb in verbose mode for debugging purposes.
Discovers multiple Fusion Applications domains by reading the Fusion Applications domain discovery file and saving the host-wise discovered targets to the Agents provided in the Host Agent Mapping file. If the Host Agent mapping file is not provided, the local Agent (that is, the Agent on the same host as the target) is used to save/monitor the discoverd targets as well. If a local Agent is not found, the default discovery Agent is used to save/monitor the discoverd targets as well.
Note:
Although this verb supports discovering multiple Fusion instances at one time by adding all the details in one file, it is advisable to discover each Fusion instance separately using individual EM CLI discover_fa commands run multiple times.
emcli discover_fa
-input_file=fa_domain_discovery_file:file_path
[-input_file=host_agent_mapping_file:file_path]
[-input_file=pf_domain_cred_mapping_file:file_path]
[-debug]
[ ] indicates that the parameter is optional
input_file=fa_domain_discovery_file
Fully-qualified path to a CSV-formatted file containing one line of details per domain to be added. The valid WebLogic version value is 10. The structure of the CSV file is as follows:
<WebLogic Server version>, <Administration Server host machine name>, <Administration Server listen port>, <Administration Server username>, <Administration Server password>, <External Parameters - optional>, <JMX Protocol - required only if SSL enabled>, <JMX Service URL - required only if SSL enabled>, <Unique Domain Identifier>, <Agent URL/>, <Discover Down Servers - optional - Default if not specified is false starting <PS1. Before PS1 the default for this is true>, <Use Same Credentials for All Domains in the Fusion Instance - optional - Default if <not specified is true>
For example:
10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_
01,https://mco01.mycompany.com:3872/emd/main/,,
10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_
01,https://mco01.mycompany.com:3872/emd/main/,true,
10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_
01,https://mco01.mycompany.com:3872/emd/main/,true,true
10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_
01,https://mco01.mycompany.com:3872/emd/main/,false,true
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=host_agent_mapping_file
Fully-qualified path to a CSV-formatted file containing multiple lines of host system names where Managed Servers are to be monitored, and the Agent to be used to monitor each host's Managed Servers.
For example:
mycompany.com,https://mco01.mycompany.com:3872/emd/main
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=pf_domain_cred_mapping_file
Fully-qualified path to a CSV-formatted file containing multiple lines of WebLogic admin credentials for each domain of a fusion instance, where the credentials are different from those added in the fa_domain_discovery file.
The same credentials are used for all the domains in a Fusion Application instance unless the credentials are overwritten in the pf_domain_cred_mapping file.
For example:
<UniqueKey - "<Fusion Instance
Identifier><CommonDomainDisplayName>">,<Administration Server
username>,<Administration Server password>,
<UniqueKey - "<Fusion Instance
Identifier>-<CommonDomainDisplayName>">,<Administration Server
username>,<Administration Server password>,<Administration Server Host
Name>
Example:
fi9-FS,weblogic12,welcome1,
fi9-PRJ,faadmin,fusionfa1,
fi9-PRC,faadmin,fusionfa1,myhost.us.example.com
fi9-PRC,,,myhost.us.example.com
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
debug
Runs the verb in verbose mode for debugging purposes.
This example reads the my_domains_info.csv file to determine the Fusion Instances to be added to Cloud Control, reads the my_agent_mapping.csv file to determine which Agents should monitor which host's Managed Servers, and reads the my_domain_cred_mapping.csv file to determine which credentials are to be used to discover an individual product family.
emcli discover_fa
-input_file=fa_domain_discovery_file:c:\emcli\my_domains_info.csv
-input_file=host_agent_mapping_file:c:\emcli\my_agent_mapping.csv
-input_file=pf_domain_cred_mapping_file:c:\emcli\my_domain_cred_mapping.csv
emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_file:/tmp/emcli/ host_agent_mapping_file.txt -debug
emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_filee:/tmp/emcli/ host_agent_mapping_file.txt -input_file=pf_domain_cred_mapping_file:/tmp/emcli/ pf_domain_cred_mapping_file.txt -debug
Discovers Multiple GlassFish Domains by reading the Domain Discovery file and saving the discovered targets of the host to the Agents provided in the Host Agent Mapping file. If the Host Agent mapping file is not provided, the local Agent (the Agent on the same host as the target) is used to save/monitor the discovered targets. If a local Agent is not found, the default discovery Agent is used to save/monitor the discovered targets.
$emcli discover_gf
-input_file=domain_discovery_file:file_path
[-input_file=host_agent_mapping_file:file_path]
[-debug]
[ ] indicates that the parameter is optional
input_file=domain_discovery_file
Fully-qualified path to a CSV-formatted file containing one line of details per domain to be added. The structure of the CSV file is as follows:
<Administration Server host machine name>, <Administration Server listen port>, <Administration Server username>, <Administration Server password>, <Unique Domain Identifier>, <Agent url - optional >, <Protocol - optional >, <Service URL - optional>, <External Parameters - optional>, <Discover Down Servers - optional - Default if not specified is false>,\n" +
For example:
mco01.mycompany.com,4848,admin,welcome1,my_domain_01,https://mco01.mycompany.com:3872/emd/main mco01.mycompany.com,4848,admin,welcome1,my_domain_01,https://mco01.mycompany.com:3872/emd/main,http,,,true
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=host_agent_mapping_file
Fully-qualified path to a CSV-formatted file containing multiple lines of host system names where Managed Servers are to be monitored, and the Agent to be used to monitor each host's Managed Servers. The structure of the CSV file is as follows:
<target_host1>,<save_to_agent1> <target_host2>,<save_to_agent3>
For example:
mycompany.com,https://mco01.mycompany.com:3872/emd/main
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
debug
Runs the verb in verbose mode for debugging purposes.
Discovers Siebel Enterprise instances.
emcli discover_siebel
-input_file=enterprise_info_file:<file_path>
[-out_file='<fully_qualified_path_of_output_file>']
[-precheck]
[-debug]
[ ] indicates that the parameter is optional
input_file
The input file should be in a CSV format. The structure of the CSV file is as follows:
GATEWAY_HOST = < Gateway Server Host >, PORT = < Gateway Server Port - optional Default if not specified is 2320 >, INSTALL_DIR = < Gateway Server Install Directory - optional >, ENTERPRISE_NAME = < Siebel Enterprise Name >, SIEBEL_USERNAME = < Siebel Enterprise User Name >, SIEBEL_PASSWORD = < Siebel Enterprise Password >, DATABASE_USERNAME = < Database User Name >, DATABASE_PASSWORD = < Database Password >
Note:
INSTALL_DIR is a mandatory parameter for discovering Siebel version 8.2.2 and above.This example shows discovery of a Siebel Enterprise (siebel) with the gateway located at host 'host1', installed at location 'Location1' and running at port '23201', with a Siebel user name and password of 'sbluser' and 'SBLpass' respectively, and a database user name and password of 'dbuser' and 'DBpass' respectively.
GATEWAY_HOST=host1,PORT=23201,INSTALL_DIR=Location1, ENTERPRISE_NAME=siebel,SIEBEL_USERNAME=sbluser, SIEBEL_PASSWORD=SBLpass,DATABASE_USERNAME=dbuser, DATABASE_PASSWORD=DBpass
Special cases for commas:
If any entry, such as a password, has a comma ( , ) you need to add it as a backslash comma ( \, ) in the CSV file. For instance, if SIEBEL_PASSWORD is we,lco,me1 the entry in the CSV file would be SIEBEL_PASSWORD = we\,lc\,ome1 .
If any entry, such as a password, has a backslash followed by a comma( \, ) you need to add it as as two backslashes followed by a comma( \\, ) in the CSV file. For instance, if SIEBEL_PASSWORD is we\,lco\,me1 the entry in the CSV file would be SIEBEL_PASSWORD = we\\,lc\\,ome1 .
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
out_file
Command output is redirected to this file. If not specified, output is printed on the console.
debug
Executes in verbose mode and generates additional debug log messages in the output. If specified, detailed output is printed.
precheck
Performs a mock discovery of the Siebel enterprise by executing all of the checks and validations. This option lists the results of these steps to the user for review prior to an actual discovery. It ensures that all prerequisite are met, and discovery does not occur if prerequisites are met.
This example reads the my_enterprise_info.csv file to determine the Siebel Enterprise instances to be added to Cloud Control. The output of the command is redirected to the discovery_output.txt file.
emcli discover_siebel
-input_file=enterprise_info_file:'c:\emcli\my_enterprise_info.csv'
-out_file='c:\emcli\discovery_output.txt'
-debug
This example is the same as the example above, except it adds the -precheck option, which confirms if the precheck is successful, or shows errors if it failed.
emcli discover_siebel
-input_file=enterprise_info_file:'c:\emcli\my_enterprise_info.csv'
-out_file='c:\emcli\discovery_output.txt'
-debug
Used to discover one or more version 8.x, 9.x, 10.x, and 12.x WebLogic Domains (along with Oracle Fusion Middleware 11g software deployed to it), and to specify which Management Agent should monitor which hosts' Managed Servers. Specifying which Management Agent should monitor which hosts' Managed Servers is a feature supported only with versions 9.x, 10.x, and 12.x of the WebLogic Server. If you want to discover version 8.x of the WebLogic Server, you cannot specify which Management Agent to monitor which hosts' Managed Servers; the Management Agent used to perform discovery automatically monitors all WebLogic Servers within the version 8.x domain.
This verb discovers one or more Oracle WebLogic Server Domains. It reads a file labeled domain_discovery_file to discover WebLogic Server versions 8.x, 9.x, 10.x, and 12.x. Note that if you attempt to discover an already discovered WebLogic Server, the discovered WebLogic Server domain will be refreshed.
To discover the WebLogic Server, the Administration Server must be up and running. After initial discovery or during refresh of domain membership, the Administration Server is not required to be up for general WebLogic Server monitoring. After initial discovery or during refresh of domain membership, the Managed Server is not required to be up for general WLS monitoring. Oracle recommends ensuring all Managed Servers to be managed by Cloud Control be up during discovery.
domain_discovery_file is required; discovery cannot occur without it. You must create the CSV (comma-separated values) formatted file before performing discovery. To save the discovered components (WebLogic Server versions 9.x, 10.x, and 12.x only) to a specific Management Agent for monitoring, the discover_wls verb reads a second file labeled host_agent_mapping_file. If host_agent_mapping_file does not exist, the Management Agent specified in domain_discovery_file that performs the actual discovery is used as the Agent that monitors all discovered targets.
Usage with generate_discovery_input Verb
The generate_discovery_input verb creates a discovery input file automatically based on the targets discovered from the automatic discovery operation. You can then use this discovery input file in conjunction with the discover_wls verb to further automate the process of promoting discovered domains as fully managed targets.
emcli discover_wls
-input_file=domain_discovery_file:file_path
[-input_file=host_agent_mapping_file:file_path]
[-input_file=disable_target_types_file:file_path]
[-debug]
[ ] indicates that the parameter is optional
input_file=domain_discovery_file
Fully-qualified path to a CSV (Comma-Separated Values) formatted file that contains one line of details per domain to be added. This is valid for WebLogic Server versions 8.x, 9.x, 10.x, and 12.x. Each line has the format shown for
domain_discovery_file in the "File Structures" section below.
Note the following points about the format of domain_discovery_file:
Parameters —
The order of parameters is fixed. You must provide the parameters in the same order as shown for domain_discovery_file in the "File Structures" section below.
If you want to use a comma ( , ) in any of the parameters provided, you must escape the comma with a backslash as shown in This example, in which a backslash precedes the comma in the password my,pwd:
10,domain123.xyx.us,11990,weblogic,my\,pwd,,,farm_demo,https://myco01.mycompany.com:3872/emd/main/
Delimeters and Requirements —
Use a comma ( , ) as the delimiter.
Delimiters must be present even if the corresponding parameter is not provided. See the last line for domain_discovery_file in the "File Structures" section below.
If you want to use a comma (,) in one of the parameters provided, you must escape the comma (,) with a backslash. In This example, the password contains a comma:
10,mco01.mycompany.com,7001,weblogic,welco\,me1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/
If you want to use a backslash in one of the parameters provided, you must escape the backslash with another backslash. In This example, the password contains a backslash:
10,mco01.mycompany.com,7001,weblogic,we\,lco \ \ me1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/,true,false
The total number of tokens in each line is fixed and should be equal to 10.
The order of parameters is fixed. You must provide the parameters in the same order as specified in the sample file structure shown in the "File Structures" section below.
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=host_agent_mapping_file
Fully-qualified path of the CSV (Comma-Separated Values) formatted file that contains multiple lines of host system names where managed servers are to be monitored, and specifies the Management Agent used to monitor each host's managed servers. This is only valid for WebLogic Server versions 9.x, 10.x, and 12.x. Each line has the following format:
<Discovered_target_host_machine_name>,<Agent_URL_to_save/monitor_the_host>
For example:
myco01.mycompany.com,https://myco01.mycompany.com:3872/emd/main/ myco02.mycompany.com,https://myco02.mycompany.com:3872/emd/main/ myco03.mycompany.com,https://myco03.mycompany.com:3872/emd/main/
Definitions for the parameters are as follows:
Discovered_target_host_machine_name
Host machine with installed WebLogic Servers that need to be discovered. Use full host names, such as myco01.mycompany.com instead of myco01.
Agent_URL_to_save/monitor_the_host
URL for the Management Agent to be used to monitor all discovered targets on the corresponding host.
Delimeters and Requirements —
Use a comma ( , ) as the delimiter.
The total number of tokens in each line is fixed and should be equal to 2.
The order of parameters is fixed. You must provide the parameters in the same order as shown in the sample file structure shown in the "File Structures" section below.
<target_host1> and <save_to_agent1> are both mandatory parameters.
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=disable_target_types_file
Fully-qualified path to a CSV (Comma-Separated Values) formatted file containing multiple lines of internal target type names that should not be discovered.
For example:
oracle_soa_composite j2ee_application
If the discover_wls verb is run against a Fusion Applications WebLogic Server domain, the disabled target types can include Fusion Applications target types.
debug
Runs this verb in verbose mode for debugging purposes.
domain_discovery_file for WebLogic Server version 8.x
This example shows the structure of a sample domain_discovery_file for WebLogic Server version 8.x. The same Management Agent is used to discover and save the targets. OPT signifies an optional parameter. The last entry shows the format when the optional parameters, Administration Server Home Directory and Trusted Keystore Filename, are not provided.
<WebLogic Server version>, <Administration Server host machine name>, <Administration Server listen port>, <Administration Server username>, <Administration Server password>, <Trusted Keystore Filename - required only if SSL enabled>, <Administration Server Home Directory>, <Agent Host>, <Agent Host username>, <Agent Host password>
For example:
8,mco02.mycompany.com,7001,weblogic,welcome1,,/u01/wls/,mco02.mycompany.com,oracle,oracle
Definitions for the parameters are as follows for WebLogic Server version 8:
WebLogic Server version
Valid value is 8. This example shows a sample entry in
domain_discovery_file to discover WebLogic Server version 8:
8,myhost.us.mycompany.com,7001,weblogic,welcome1,,,myhost.us.mycompany.com, oracle,welcome1
Administration Server Host Machine Name
Full host name of the WebLogic Administration Server that needs to be discovered; for example, myhost.us.mycompany.com. This is a mandatory parameter.
Administration Server Listen Port
Listen port of the WebLogic Administration Server.
Administration Server Username
Login user name for the WebLogic Administration Server.
Administration Server Password
Login password for the WebLogic Administration Server.
Trusted Keystore Filename
Absolute path of the Trusted Keystore Filename. This is required if the Administration Server's port is SSL enabled. If the Management Agent is on a different system than the WebLogic Server to be managed, you must manually copy the Trusted Keystore file to an accessible directory on the Management Agent system prior to discovery, and then use this path.
Administration Server Home Directory
Absolute path of the directory where the weblogic.jar file is located. If the Management Agent is on a different system than the Administration Server, you must manually copy the weblogic.jar file (located in the <WEBLOGIC_HOME>/server/lib/ directory) to an accessible directory on the Management Agent system prior to discovery, and then use this path.
Agent Host
Host name of the Management Agent used to discover and monitor the targets.
Agent Host Username | Agent Host Password
Credentials of the operating system user of the Management Agent host. These credentials are used to discover any Oracle WebLogic Server domains.
domain_discovery_file for WebLogic Server versions 9.x, 10.x and 12.x
This example shows the structure of a sample domain_discovery_file for WebLogic Server versions 9.x, 10.x, and 12.x. OPT signifies an optional parameter. The last entry shows the format when optional parameters External Parameters, JMX Protocol, JMX Service URL, and Management Agent URL are not provided.
<WebLogic Server version>,
<Administration Server host machine name>,
<Administration Server listen port>,
<Administration Server username>,
<Administration Server password>,
<External Parameters - optional>,
<JMX Protocol - Required only if SSL enabled>,
<JMX Service URL - Required only if SSL enabled>,
<Unique Domain Identifier>,
<Agent URL/>,
<Discover Down Servers - optional - Default if not specified is false
(starting with the Fusion Middleware Plug-in 12.1.0.3 release. Before this, the
default was true)>,
<Use Credential Store - optional - Default if not specified is false>
<Enable Refresh Job - optional - Default if not specified is false>
<Use Host Name in Service URL - optional - Default if not specified is false>
For example:
10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/,false,false
Definitions for the parameters are as follows:
WebLogic Server Version
Valid values are 9, 10, or 12. This example shows a sample entry in
domain_discovery_file to discover WebLogic Server version 10:
10,myco01.mycompany.com,7001,weblogic,welcome1,,,,soa_farm, https://myco02.mycompany.com:8723/emd/main/
Administration Server Host
Full host name of the WebLogic Administration Server that needs to be discovered; for example, myco01.mycompany.com. This is a mandatory parameter.
Port
Listen port of the WebLogic Administration Server.
Username
Login user name for the WebLogic Administration Server.
Password
Login password for the WebLogic Administration Server.
External Parameters
These parameters are passed to the Java process, which connects to the Administration Server. All of these parameters must begin with -D.
JMX Protocol
The Management Agent makes a JMX connection to the Administration Server to discover the domain's members. Valid values are t3, t3s, iiop, and iiops. If you do not provide a protocol, the t3 default is used.
JML Server URL
Makes a JMX connection to the Administration Server. If you do not specify this parameter, it is created based on the input parameters.
Unique Domain Identifier
Creates a unique target name. This parameter can contain only alphanumeric characters and the special character '_' and cannot contain any other special characters.
Agent URL
URL for the Management Agent used to discover the targets. If you do not provide a value, the local Management Agent present on the target WebLogic Server is used. If a Management Agent is not found on the target WebLogic Server, an error is displayed.
Discover Down Servers
If this value is true, the servers that are down are discovered. If false, the servers that are down are not discovered.
Use Credential Store
If this value is set to true, the verb retrieves the WebLogic credentials from the credential store.
This example reads the my_domains_info.csv file to determine the domains to be added to Cloud Control, and reads the my_agent_mapping.csv file to determine which Management Agents should monitor which host's managed servers.
emcli discover_wls
-input_file=domain_discovery_file:\emcli\my_domains_info.csv
-input_file=host_agent_mapping_file:\emcli\my_agent_mapping.csv
-debug
This example manually redirects the output of discover_wls to a file using standard output redirect.
emcli discover_wls input_file=domain_discovery_file:"<fully_qualified_path_of_domain_discovery_file/domain_discovery_file.csv>” > /tmp/emcli/output_file.out
Downloads the specified databank file corresponding to the given ATS test. If no databank alias is specified, the command downloads all databanks for the test.
emcli download_ats_test_databank_file
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
[-databankAlias=<databank_alias>]
[-output_dir=<output_directory>]
[ ] indicates that the parameter is optional
name
Name of the target.
type
Name of the target type.
testname
Name of the test.
testtype
Type of test.
databankAlias
Databank alias.
output_dir
Output directory. If the directory does not exist, it is created.
This example downloads the databank corresponding to alias1 for the specified test.
emcli download_ats_test_databank_file -name="Service Name"
-type="generic_service"
-testname="Test Name"
-testtype="OATS"
-databankAlias="alias1"
This example downloads all databanks corresponding to the specified test.
emcli download_ats_test_databank_file -name="Service Name"
-type="generic_service"
-testname="Test Name"
-testtype="OATS"
Downloads the zip bundle corresponding to the specified ATS test.
emcli download_ats_test_zip
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
[-output_dir=<output_directory>]
[ ] indicates that the parameter is optional
name
Name of the target.
type
Name of the target type.
testname
Name of the test.
testtype
Type of test.
output_dir
Output directory. If the directory does not exist, it is created.
Edits the schedule and purge policy of an existing database profile.
emcli edit_dbprofile
-comp_loc="Database Profile component location in software library"
[-schedule= [NONE]|[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{java timezone ID}];
[grace_period:xxx];
]
[-purge_policy= DAYS|SNAPSHOTS: number]
[ ] indicates that the parameter is optional.
comp_loc
A combination of the database profile location and name.
schedule
frequency: The frequency type with which the databse profile will be created. It can be an interval (in minutes), weekly, monthly, or yearly.
start_time: Denotes the start time of Database Profile Component Creation in the format yy-MM-dd HH:mm.
end_time: Denotes the end time of Database Profile Component Creation Repetition in the format yy-MM-dd HH:mm
repeat: The repetition rate at which database profile will be created. If the frequency is an interval, then repeat is in minutes.
months: The number of months after which the repetition of Database Profile Component Creation will occur.
days: The number of days after which repetition of Database Profile Component Creation will occur.
tz: The time zone ID, for example tz:America/New_York.
grace_period: A period of time in minutes that defines the maximum permissible delay when attempting to create a databasse profile. If the job system cannot start the execution within a time period equal to the scheduled time plus the grace period, it will set the create database profile to be skipped. By default, the grace period is indefinite.
purge_policy
You can purge the collected data based on a specified number of days (DAYS) or a count of snapshots (SNAPSHOT). If the purge_policy parameter is not specified, then it is defaulted to NONE.
The following example edits the schedule and purge policy database profile RMAN_Profile with the location Database Provisioning Profiles/11.2.0.4.0/linux_x64.
emcli edit_dbprofile -comp_loc="Database Provisioning Profiles/11.2.0.4.0/linux_x64/RMAN_Profile"
-schedule="frequency:interval;start_time:14-10-05 05:30;end_time:
14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York"
-purge_policy=DAYS:2
Edits the service-level rule for the specified service.
emcli edit_sl_rule
-name="target name"
-type="target type"
[-expSL="expected service level value"]
[-repeatSequence="days repeat sequence"]
[-startTime="start time"]
[-endTime="end time"]
[-availStatesInclude="included availability states"]
[-availStatesExclude="excluded availability states"]
[ ] indicates that the parameter is optional
name
Identifies the target name.
type
Identifies the target type. Use emcli get_targets to get the target type.
expSL
Specifies the expected service-level rule. Values must be any number between 0 and 100.
repeatSequence
Specifies the days in which the service-level rule is to be applied. Identify the days value from these comma-separated values: MON, TUE, WED, THU, FRI, SAT, SUN.
startTime
Specifies the time of day that the application of the service-level rule is to begin. Enter the time format as: HH:min
endTime
Specifies the time of day that the application of the service-level rule is to end. Enter the time format as: HH:min
availStatesInclude
Specifies the availability states (apart from UP) that are to be included while computing the service-level rule. Values are: BLACKOUT|UNKNOWN
availStatesExclude
Specifies the availability states (apart from UP) that are to be excluded while computing the service-level rule. Values are: BLACKOUT|UNKNOWN
Update the MyService service-level rule to begin at 6 a.m. on Mondays and Tuesdays:
emcli edit_sl_rule
-name="MyService"
-type="generic_service"
-expSL="90.0"
-repeatSequence="MON,TUE"
-startTime="06:00"
-endTime="23:00"
-availStatesInclude="BLACKOUT"
-availStatesExclude="UNKNOWN"
Enables auditing for ALL and BASIC user operations. For other operations, see the update_audit_settings verb.
Enables configuration history computation for a target type.
target_type
Target type for which the configuration history is being enabled. The value should be the internal name or "*" to indicate all target types.
Takes a list of agents and marks each agent as a forwarder agent.
emcli enable_forwarder_agents
-agent_list="agent_list"
[ ] indicates that the parameter is optional.
agent_list
List of agents that need to be registered as forwarders. The agents must be separated by space.
Enables an SLA for a target.
emcli enable_sla
-targetName=<target_name>
-targetType=<target_type>
-slaName=<SLA_name>
[-now]
[-versionStart=<MM/dd/yyyy hh:mm a>]
[ ] indicates that the parameter is optional
targetName
Name of the target.
targetType
Type of target.
slaName
Name of the SLA.
now
Enables the SLA now, or uses versionStart for a specific time.
versionStart
Specifies when the computation of the SLA should start.
This example immediately enables an SLA named 'gold_sla' for target
my_service (generic_service).
emcli enable_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla' -versionNum=2 -now
This example enables a SLA named 'gold_sla' for target
my_service (generic_service). It becomes active and starts computing at '09/23/2012 3:30 PM'.
emcli enable_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla' -versionNum=2 -versionStart='09/23/2012 3:30 PM'
Enables monitoring of a Services test. It pushes the Service test collection to all the beacons.
emcli enable_test
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
name
Service target name.
type
Service target type.
testname
Test name.
testtype
Test type.
Executes a host command across a set of targets.
emcli execute_hostcmd
-cmd=<host_command"
-osscript=<script_to_be_executed>
-targets=<name1:type1;name2:type2;...>
-credential_set_name=<name>
[-input_file=<parameter_tag:script_file>]
[ ] indicates that the parameter is optional
cmd
Host_command can be any valid host command or group of host commands.
osscript
OS script to be executed with the cmd parameter.
targets
List of target-name, target-type pairs. The host command is executed across this list of Enterprise Manager targets. All targets must be of the type host or composite, which represents a group of targets. If it is a group, the group is expanded to extract all the host targets, and the host command is executed across these host targets.
credential_set_name
The credential_set_name parameter refers to the set name of the preferred credentials stored in the Enterprise Manager repository. If this parameter is not present, HostCredsNormal is used for executing host commands. For the host target type, two credential sets exist:
HostCredsNormal — Default unprivileged credential set for a host target
HostCredsPriv — Privileged credential set for a host target
The credential set parameter can only be specified when the override credential parameters such as username and password are not present.
If provided, the you must fully specify the override credential parameters. For host command, username and password must be specified together.
input_file
Used in conjunction with -osscript , this enables you to load the contents of an OS script. The -input_file specifies a mapping between a tag and a local file path. The tag is specified in lieu of actual osscript contents of the -osscript . The tag must not contain colons ( : ) or semi-colons ( ; ).
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
This example executes the host command ls -l; against the target stach.example.com:host and host targets contained in the group grp. The stored HostCredsPriv preferred credentials are used for all the targets.
emcli execute_hostcmd
-cmd="ls -l;"
-credential_set_name="HostCredsPriv"
-targets="stach.example.com:host;grp:composite"
This example loads the contents of the script
/scratch/dba_scripts/shellscript.sh into the value of -osscript and executes it against target reference.example.com:host and host targets contained in the group grp. The stored HostCredsNormal preferred credentials are used for all the targets.
emcli execute_hostcmd
-cmd="/bin/sh -s"
-osscript="FILE"
-input_file="FILE:/scratch/dba_scripts/shellscript.sh"
-credential_set_name="HostCredsNormal"
-targets="reference.example.com:host;grp:composite"
Executes a SQL command across a set of targets.
emcli execute_sql
-sql=<sql_command>
-targets=<name1:type1;name2:type2;...>
-credential_set_name=<name>
[-input_file=<parameter_tag:script_file>]
[ ] indicates that the parameter is optional
sql
"sql command" is a single SQL statement.
targets
List of target-name, target-type pairs. The SQL command executes across this list of Enterprise Manager targets. All targets must be of the type oracle_database or composite, which represents a group of targets. If it is a group, the group expands to extract all the database targets, and the SQL command is executed across these database targets.
credential_set_name
Refers to the set name of the preferred credentials stored in the Enterprise Manager repository. If this parameter is not present, the DBCredsNormal and DBHostCreds credential set is used for executing SQL commands. For each target type, several credential sets exist:
HostCredsNormal — Default unprivileged credential set for a host target
HostCredsPriv — Privileged credential set for a host target
DBHostCreds — Host credential set for an oracle_database target
DBCredsNormal — Default normal credential set for an oracle_database target
DBCredsSYSDBA — sysdba credential set for an oracle_database target
You can only specify the credential_set_name parameter when the override credential parameters such as [db_|host_]username and
[db_|host_]password are not present. If provided, the override credential parameters must be specified fully. For the SQL commands, db_username,
db_password, db_role, host_username, and host_password must be present.
input_file
Used in conjunction with the -sql option, this option enables you to load the contents of a SQL script. The -input_file option specifies a mapping between a tag and a local file path. The tag is specified in lieu of an actual SQL command for the -sql . The tag must not contain colons ( : ) or semi-colons ( ; ).
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
This example executes the SQL command select * from sysman.mgmt_targets; against the target database:oracle_database and database targets contained in the group grp. The stored SYSDBA preferred credentials are used for all the targets.
emcli execute_sql
-sql="select * from sysman.mgmt_targets;"
-credential_set_name="DBCredsSYSDBA"
-targets="database:oracle_database;grp:composite"
This example loads the contents of the script
/scratch/dba_scripts/enterprise_schema.sql into the value of -sql, and executes it against target database:oracle_database and database targets contained in the group grp. The stored SYSDBA preferred credentials are used for all the targets.
emcli execute_sql
-sql="FILE"
-input_file="FILE:/scratch/dba_scripts/enterprise_schema.sql"
-credential_set_name="DBCredsSYSDBA"
-targets="database:oracle_database;grp:composite"
This example executes the SQL command against "asm:osm_instance" and ASM targets contained in the group 'grp'. The SYSASM preferred credentials are used for all the targets.
emcli execute_sql
-sql="select * from sysman.mgmt_targets;"
-credential_set_name="ASMCredsSYSASM"
-targets="asm:osm_instance;grp:composite"
Exports an Application Data Model to the specified directory with the specified file name.
emcli export_adm
-adm_name=<application_data_model_name>
[-directory=<directory_path>]
[-file_name=<file_name>]
[ ] indicates that the parameter is optional
adm_name
Application data name that will be exported.
directory
Directory where the Application Data Model is to be exported. If the directory is not specified, the file is saved in the current directory.
file_name
Name of the file where the Application Data Model will be exported. If the file name is not specified, the default file name is the same as the specified Application Data Model name. If the file name does not have an extension, '.xml' is the default extension.
Exports charge plan metadata to an XML file.
emcli export_charge_plans
[-charge_plan="plan_name"[-entity_type = chargeback_entity_type]]
[-start_date=ddmmyyyy]
-file=file_name
[ ] indicates that the parameter is optional
charge_plan
Name of the charge plan to be exported. If this parameter is not specified, all charge plan metadata is exported.
entity_type
Name of the Chargeback entity type whose charge plan is to be exported. If this parameter is not specified, all entity type charge rates in the charge plan are exported.
start_date
Start date of the report cycle whose charge plan metadata is to be exported. The start date value must be in ddmmyyyy format. If this parameter is not specified, the start date of the current report cycle is used.
file
Absolute path to which to export the metadata.
This example exports metadata of all charge plans that were active in the current report cycle to the file /home/allplans.xml:
emcli export_charge_plans
-file=/home/allplans.xml
This example exports metadata of charge plan Plan A, if active in the current report cycle, to the file /home/plans.xml:
emcli export_charge_plans
-charge_plan="Plan A"
-file=/home/plans.xml
This example exports metadata of the host entity type associated with charge plan Plan A, if active in the current report cycle, to the file /home/plans.xml:
emcli export_charge_plans
-charge_plan="Plan A"
-entity_type=host
-file=/home/plans.xml
This example exports metadata of charge plan Plan A, if active in the report cycle starting on 01062014, to the file /home/plans.xml:
emcli export_charge_plans
-charge_plan="Plan A"
-start_date=01062014
-file=/home/plans.xml
Exports a compliance group definition and all of its element definitions given the name, author, and version.
emcli export_compliance_group
-name=<name>
-author=<author>
-version=<name>
-output_file=<file>
name
Name of the group to be exported.
author
Author of the group to be exported.
version
Version of the group to be exported.
output_file
Name of the exported file.
Exports a rule to the specified files.
name
Name of the rule to be exported.
target_type
Target type of the rule to be exported.
output_file
Name of the exported file.
Exports user-defined charge item metadata to the specified XML file.
entity_type
Name of the entity whose charge item metadata you want to export.
file
Full path of the file to which to write user-defined charge items associated with the specified entity type.
Exports all matching job definitions in Enterprise Manager, including Corrective Actions. System jobs and nested jobs are excluded.
emcli export_jobs -export_file=<zip_file_name>" [-name="job_name1;job_name2;..."] [-type="job_type1;job_type2;..."] [-targets="tname1:ttype1;tname2:ttype2;..."] [-owner="owner1;owner2;..."] [-preview] [ ] indicates that the parameter is optional
export_file
Zip file name to be created.
name
Job name pattern to be used for filtering. Semicolon-separated job names can be provided. When filtering by a single value, wildcard char(% or _) can also be used. Wildcard "%"matches one or more characters. "_"(underscore) matches exactly one character.
type
Job type pattern to be used for filtering. Semicolon-separated job types can be provided. When filtering by sa ingle value, wildcard chars(% or _) can be used.
targets
Target name, type pattern to be used for filtering. Semicolon-separated target names and types can be provided. When filtering by a single value, wildcard chars(% or _) can be used.
owner
Owner of the jobs to be used for filtering. Semicolon-separated job owners can be provided.
preview
Jobs in the Enterprise Manager site matching the filter criteria are shown to stdout. Jobs are not exported to any file.
This example exports job definitions for jobs MYJOB1 and MYJOB2 to job_data.zip:
emcli export_jobs -name=MYJOB1;MYJOB2 -export_file=jobsdata.zip
This example exports job definitions for any jobs owned by user name starting with ADMIN.
emcli export_jobs -owner=ADMIN% -export_file=jobsdata.zip
This example exports job definitions for jobs MYJOB1 and MYJOB2 to job_data.zip:
emcli export_jobs -name=MYJOB1;MYJOB2 -export_file=jobsdata.zip
This example exports job definitions for any jobs owned by user name starting with ADMIN.
emcli export_jobs -owner=ADMIN% -export_file=jobsdata.zip
Exports a masking definition in XML format.
emcli export_masking_definition
-definition_name=<masking_definition_name>
[-path=file_path]
[-file=file_name]
[ ] indicates that the parameter is optional
definition name
Masking definition name.
path
Path for the file name to save the masking script. The file name is auto-generated. -path and -file are mutually exclusive. Only an absolute path is allowed.
file
File name to save the masking script. The file name must include the absolute path. -path and -file are mutually exclusive.
This example exports the masking definition mask_hr_data to an XML file at the specified path:
emcli export_masking_definition
-definition_name=mask_hr_data
-path=/tmp/
This example exports the masking definition mask_hr_data to an XML file named abc.xml:
emcli export_masking_definition
-definition_name=mask_hr_data
-file=/tmp/abc.xml
Exports a metric extension archive file.
emcli export_metric_extension
-file_name=<metric_extension_archive_name>
-target_type=<metric_extension_target_type>
-name=<metric_extension_name>
-version=<metric_extension_version>
file_name
Name of the metric extension archive file to export into.
target_type
Target type of the metric extension.
name
Name of the metric extension.
version
Version of the metric extension to be exported.
This example creates an archive of a metric extension of a given target type, name, and version.
emcli export_metric_extension -file_name=<name of the metric extension archive> -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension>
Exports an Information Publisher report definition and all of its element definitions given its title and owner.
title
Title of the report to export. To export copies of Oracle-provided reports, the title value should be the internal report title stored in the repository. To avoid using the internal title, make a copy of the report and provide your own custom title, then use your title to export the report.
owner
The owner of the report to export. The logged-in emcli user must have view privilege for the report. Target names are not exported. The report is uniquely defined using title and owner, so both must be supplied.
output_file
Name of the exported file.
Extracts the configuration details of an SLA into a local file. If you do not specify slaName and/or version, multiple SLA are exported to the same output file.
emcli export_sla
-targetName=<target_name>
-targetType=<target_type>
[-slaName=<SLA_name>]
-output_file=<output_filename>
[ ] indicates that the parameter is optional
targetName
Name of the target.
targetType
Type of target.
slaName
Name of the SLA.
output_file
Output file name of the template. If the file does not exist, it is created; if it already exists, it is overwritten. (This assumes that the extract operation was successful. If the operation fails, no files are created, and any existing files remain unchanged.)
Exports a standard from the repository to an XML file.
name
Name of the standard to be exported.
author
Author of the standard to be exported.
version
Author of the standard to be exported.
output_file
Name of the exported file.
Exports the specified subset definition as an XML file at the specified directory location.
emcli export_subset_definition -subset_name=<subset_definition_name> [-file_name=<file_name>] [-directory=<directory_path>] [ ] indicates that the parameter is optional
subset_name
Subset definition name to export.
file_name
File name to save the exported file. If you do not specify the file name, it is saved under the subset definition name. If it is specified without an extension, '.xml' is used as the default extension.
directory
Directory location to save the exported file. If you do not specify a directory, the file is saved in the current directory.
This example exports a subset definition with the name HR_Subset as XML in the current directory.
emcli export_subset_definition -subset_name=HR_Subset
This example exports a subset definition with the name HR_Subset as XML with the name HR_Subset_Export at the directory path /scratch/subset.
emcli export_subset_definition -directory=/scratch/subset -subset_name=HR_Subset -file_name=HR_Subset_Export
Exports a monitoring template and also exports UDMs in the template. You can export a template to the file system in the form of an XML file, or you can print it on standard output in XML form.
emcli export_template
-name=<name>
-target_type=<target_type>
[-output_file=<file_for_exported_template>]
[-archive]
[ ] indicates that the parameter is optional
name
Name of the template. The name and target type uniquely identify a template.
target_type
Target type of the template.
output_file
Specifies the file to output the template. If not specified, the template prints to stdout.
archive
Indicates that the template must be exported as a zip file. When a Metric Extension is included in the template, this option is required to export the template as a zip file.
This example shows that template XML specified by name HOST_TEMP1 and target type host will be output to the screen.
emcli export_template -name=HOST_TEMP1 -target_type=host
This example shows that template XML specified by name HOST_TEMP1 and target type host will be created in the test.xml file.
emcli export_template -name=HOST_TEMP1 -target_type=host -output_file=test.xml
This example shows that the template archive specified by name
HOST_TEMP1 and target type host will be created in the test.zip file.
emcli export_template -name=HOST_TEMP1 -target_type=host -output_file=test.zip -archive
Exports a Self Update archive file from Enterprise Manager to the specified location.
emcli export_update
-id="internal id"
-dir="dir"
-omslocal
emcli export_update
-id="internal id"
-dir="dir"
-host="hostname"
[-credential_set_name="setname"] | -credential_name="name"
-credential_owner="owner"
[ ] indicates that the parameter is optional
id
Internal identification for the update to be exported.
dir
Complete path of the directory where the update is to be exported.
omslocal
Flag specifying that the directory is accessible from the OMS.
host
Target name for a host target where the update is to be exported.
credential_set_name
Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set
credential_name
Name of a named credential stored in the repository. You must specify this option along with the credential_owner option.
credential_owner
Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.
This example exports the update archive file to /u01/common/. The directory must exist on the OMS host. In a multiple OMS setup, the request can be processed by any OMS, so the directory should be accessible from the OMS processing the request. This usually means that the directory must be on a shared location accessible from all OMSes.
emcli export_update
-id="914E3E0F9DB98DECE040E80A2C5233EB"
-dir="/u01/common/"
-omslocal
This example exports the update archive file to /u01/common/ on host host1.example.com. The host must be the managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to push the remote file.
emcli export_update
-id="914E3E0F9DB98DECE040E80A2C5233EB"
-dir="/u01/common/"
-host="host1.example.com"
-credential_set_name="HostCredsNormal"
This example exports the update archive file to /u01/common/ on host host1.example.com. The host must be the managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to push the remote file.
emcli export_update
-id="914E3E0F9DB98DECE040E80A2C5233EB"
-dir="/u01/common/"
-host="host1.example.com"
-credential_name="host1_creds"
-credential_owner="admin1"
Clones the specified Application Server Oracle Home or Software Library component from the target host to specified destinations. The new hosts join an existing cluster. For a Portal and Wireless install, OID user and password are also needed. For a J2EE instance connected to only a database-based repository, a DCM Schema password is needed.
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
emcli extend_as_home
-input_file="dest_properties:file_path"
-list_exclude_files="list of files to exclude"
-isSwLib="true/false"
-tryftp_copy="true/false"
-jobname="name of cloning job"
-iasInstance=instance
-clustername=name of the cluster to join
-oldIASAdminPassword=oldpass
-newIASAdminPassword=newpass
[-oiduser=oid admin user]
[-oidpassword=oid admin password]
[-dcmpassword=dcm schema password]
[-prescripts=script name to execute"]
[-run_prescripts_as_root="true/false"]
[-postscripts=script to execute"]
[-run_postscripts_as_root="true/false"]
[-rootscripts=script name to execute"]
[-swlib_component ="path:path to component;version:rev"]
[-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
ScratchLoc:Scratch dir Location"
[-jobdesc="description"]
[ ] denotes that the parameter is optional
input_file=dest_properties
File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.
Format:
Destination Host Name1;Destination Home Loc; Home Name; Scratch Loca
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
input_file=list_exclude_files
Comma-separated list of files to exclude. This is not required if the source is a Software Library. You can use an asterisk "*" as a wildcard.
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the cloning job.
iasInstance
Application Server instance.
clustername
Name of the cluster to join.
oldIASAdminPassword
Old Application Server administrator password.
newIASAdminPassword
New Application Server administrator password.
oiduser
OID administrator user.
oidpassword
OID administrator password.
dcmpassword
DCM schema password.
prescripts
Path of the script to execute.
Note:
Double-quoted parameters can be passed using an escape (\) sequence. For example:prescripts=" <some value here>=\"some value here\" "
run_prescripts_as_root
Run prescripts as root. By default, this option is set to false.
postscripts
Path of the script to execute.
run_postscripts_as_root
Runs postscripts as root. By default, this option is set to false.
rootscripts
Path of the script to execute. You can use the job system environment variables (%oracle_home%, %perl_bin%) to specify script locations.
swlib_component
Path to the Software Library to be cloned. isSwLib must be true in this case.
source_params
Source Oracle home information. isSwLib must be false in this case.
jobdesc
Description of the job. If not specified, a default description is generated automatically.
emcli extend_as_home
-input_file="dest_properties:/home/destinations.txt"
-list_exclude_files="centralagents.lst"
-isSwLib="false"
-tryftp_copy="false"
-jobname="extend as home"
-iasInstance="asinstancename"
-isIas1013="false"
-clustername=ascluster
-oldIASAdminPassword="oldpassword"
-newIASAdminPassword="newpassword"
-prescripts="/home/abc/myscripts"
-run_prescripts_as_root="true"
-rootscripts="%oracle_home%/root.sh"
-source_params="TargetName:host.domain.com;HomeLoc=/home/oracle/appserver1;
HomeName=oracleAppServer1;ScratchLoc=/tmp"
Extends an Oracle Clusterware cluster, using an Oracle Clusterware source home location or an Oracle Clusterware Software Library component, to specified destinations. If a component is used, you must provide information for a host that is part of the current cluster, along with the Oracle Home name and home location. When cloning from a source home, you do not need to pass source information twice (-srchost, -home_name, and -home_location). This information is extracted from the home. These are only needed when cloning from a Software Library component.
emcli extend_crs_home
-input_file="dest_properties:file_path"
-list_exclude_files="list of files to exclude"
-clusternodes="node1;node2;node3;node4"
-clustername="name of cluster to create"
-isSwLib="true/false"
-tryftp_copy="true/false"
-jobname="name of cloning job"
[-srchost=name of a host node present on the cluster being extended"]
[-home_name="home name on a host for the existing Oracle Clusterware
cluster"]
[-home_location="location on a host for the existing Oracle Clusterware
cluster"]
[-prescripts=script name to execute"]
[-run_prescripts_as_root="true/false"]
[-postscripts=script to execute"]
[-run_postscripts_as_root="true/false"]
[-rootscripts=script name to execute"]
[-swlib_component ="path:path to component;version:rev"]
[-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
ScratchLoc:Scratch dir Location"]
[-jobdesc="description"]
[ ] denotes that the parameter is optional
input_file
File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.
Format:
Destination Host Name1;Destination Node Name;Scratch Location;PVTIC;VirtualIP;
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
list_exclude_files
Comma-separated list of files to exclude. Not required if the source is a Software Library. You can use an asterisk "*" as a wildcard.
clusternodes
List of current nodes in the cluster.
clustername
Name of the cluster to create.
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the Cloning job.
srchost
Name of a host that is part of the Oracle Clusterware cluster being extended.
home_name
Name of home used by all the current Oracle Clusterware cluster nodes.
home_location
Home location used by all the current Oracle Clusterware cluster nodes.
prescripts
Path of the script to execute.
Note:
Double-quoted parameters can be passed using an escape (\) sequence. For example:prescripts=" <some value here>=\"some value here\" "
run_prescripts_as_root
Run prescripts as root. By default, this option is set to false.
postscripts
Path of the script to execute.
run_postscripts_as_root
Run postscripts as root. By default, this option is set to false.
rootscripts
Path of the script to execute. You can use the job system environment variables (%oracle_home%, %perl_bin%) to specify script locations.
swlib_component
Path to the Software Library to be cloned. isSwLib must be true in this case.
source_params
Source Oracle home info. isSwLib must be false in this case.
jobdesc
Description of the job. If not specified, a default description is generated automatically.
emcli extend_crs_home -input_file="dest_properties:crs.prop" -list_exclude_files=""
-isSwLib="false"
-tryftp_copy="false" -jobname="crs extend job"
-home_name="cloneCRS1"
-home_location="/scratch/scott/cloneCRS1 "
-clusternodes="node1;node2" -clustername="crscluster"
-postscripts="%perlbin%/perl%emd_root%/admin/scripts/cloning/samples/
post_crs_extend.pl ORACLE_HOME=%oracle_home%"
-run_postscripts_as_root="false" -rootscripts="%oracle_home%/root.sh"
-source params="TargetName:testhost;HomeLoc:
/scratch/scott/cloneCRS1;HomeName:cloneCRS1;ScratchLoc:/tmp"
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
Extends a RAC cluster by cloning a specified Oracle Home location or a RAC Software Library component to specified destinations. If a component is used, you must provide information for a host that is part of the current cluster, along with the Oracle Home name and home location. When cloning from a source home, this information is automatically extracted from the home.
emcli extend_rac_home
-input_file="dest_properties:file_path"
-list_exclude_files="list of files to exclude"
-isSwLib="true/false"
-tryftp_copy="true/false"
-jobname="name of cloning job"
-clusternodes="node1;node2;node3;node4"
[-srchost=name of a host node present on the RAC cluster being extended"]
[-home_name="home name on a host for the existing RAC cluster"]
[-home_location="location on a host for the existing RAC cluster"]
[-prescripts="script name to execute"]
[-run_prescripts_as_root="true/false"]
[-postscripts="script to execute"]
[-run_postscripts_as_root="true/false"]
[-rootscripts="script name to execute"]
[-swlib_component ="path:path to component;version:rev"]
[-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
ScratchLoc:Scratch dir Location"]
[-jobdesc="description"]
[ ] denotes that the parameter is optional
input_file
File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.
Format:
Destination Host Name;Destination Node Name;Scratch Location;
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
list_exclude_files
Comma-separated list of files to exclude. Not required if the source is a Software Library. You can use an asterisk "*" as a wildcard.
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the cloning job.
clusternodes
Current nodes in the cluster.
srchost
Name of a host that is part of the RAC cluster being extended.
home_name
Name of the home used by all the current RAC cluster nodes.
home_location
Home location used by all the current RAC cluster nodes.
prescripts
Path of the script to execute.
Note:
Double-quoted parameters can be passed using an escape (\) sequence. For example:prescripts=" <some value here>=\"some value here\" "
run_prescripts_as_root
Run prescripts as root. By default, this option is set to false.
postscripts
Path of the script to execute.
run_postscripts_as_root
Run postscripts as root. By default, this option is set to false.
rootscripts
Path of the script to execute.
swlib_component
Path to the Software Library being cloned. isSwLib must be true in this case.
source_params
Source Oracle home info. isSwLib must be false in this case.
jobdesc
Description of the job. If not specified, a default description is generated automatically.
emcli extend_rac_home
-input_file="dest_properties:clonedestinations"
-list_exclude_files="*.log,*.dbf,sqlnet.ora,tnsnames.ora,listener.ora"
-isSwLib="false"
-tryftp_copy="false"
-jobname="clone database home"
-clusternodes="node1;node2"
-prescripts="/home/joe/myScript"
-run_prescripts_as_root="true"
-rootscripts="%oracle_home%/root.sh"
-source_params="TargetName:host.domain.com;HomeLoc:/oracle/database1;
HomeName:OUIHome1;ScratchLoc:/tmp"
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
Extracts variables and test definitions from a repository template into a local file.
emcli extract_template_tests
-templateName=<template_name>
-templateType=<template_type>
-output_file=<output_filename>
[-encryption_key=<key>]
[ ] indicates that the parameter is optional
templateName
Name of the template.
templateType
Type of template.
output_file
Name of the output file. If the file does not exist, it will be created; if it already exists, it will be overwritten. (This is assuming the extract operation was successful; if the operation fails, no files are created, and any existing files are left unchanged.)
encryption_key
Key to encrypt the file contents. The same key should be used to decrypt the file.
This example creates a file named my_template.xml containing the variable values and test definitions of the Web Application template my_template. The file contents are encrypted using the key my_password.
emcli extract_template_tests
-templateName=my_template -templateType=website
-output_file=my_template.xml -encryption_key=my_password
Note:
The emcli user must have operator privilege on the repository template to perform this operation.
Beacon-related information is not exported to the file. In particular, the list of monitoring beacons, as well as any beacon-specific properties or thresholds, are not exported.
The values of password variables are not exported.
Checks if the host configuration is collected or not. If it is not yet collected, it initiates a configuration collection for the hosts.
0 if verb processing is successful.
A non-zero value indicates that verb processing was unsuccessful.
Fusion Middleware Plug-in Release 12.1.0.6 introduced this verb to further automate the process of adding several WebLogic Domains to the Cloud Control console. You can run this verb after automatic discovery has already discovered several WebLogic Domains.
This verb creates a discovery input file automatically based on the targets discovered from the automatic discovery operation. You can then use this discovery input file in conjunction with the discover_wls verb to further automate the process of promoting discovered domains as fully managed targets. Consequently, you do not need to manually create a discovery input file to perform domain discovery from EM CLI.
out_file
Location where the output file will be generated. Verify that the OMS user has write permissions on the specified location. If you are invoking the verb from the EM CLI client, verify that you have read permissions on the specified location.
Generates and downloads a UI Page Trace Report to identify slow rendering pages.
emcli generate_ui_trace_report
[-user_name="user_name"]
[-start_time="start_time"]
[-duration="duration"]
[ ] indicates that the parameter is optional
generate_ui_trace_report(
[user_name="user_name"]
[,start_time="start_time"]
[,duration="duration"]
)
[ ] indicates that the parameter is optional
user_name
User name for which the pager performance trace report needs to be generated. The default is the current logged-in user.
start_time
Start time in MM:dd:yy format from where the report needs to be generated. The default is the current time - 1 hour.
duration
Duration in hh:mm format for which the report needs to be generated. The default is 1 hour.
0 — Successful
100 — Only super users can generate the UI page performance report for other users.
101 — Cannot generate the report. No data found for the given parameters. Please change the input parameters.
102 — Cannot generate the report. Invalid duration. Duration should be specified in HH:MI format and should be less than 24 hours.
Generates a masking script for the given masking definition.
emcli generate_masking_script
-definition_name=masking_definition_name
[-tablespace_name=tablespace_name]
[-parameters=<name1:value1;name2:value2;...>]
[-credential_name=cred_name]
[-input_file=<parameter_tag:file_path>]
[-generate_export=Y|N]
[-generate_mask=Y|N]
[-script | -format=[name:<pretty|script|csv>];
[column_separator:column_sep_string];
[row_separator:row_sep_string];
[ ] indicates that the parameter is optional
definition_name
Name of the masking definition.
tablespace_name
Name of the masking definition.
parameters
List of name-value pairs that represent the credentials required for connecting to the database instance. The supported parameters are db_username,
db_password, and db_role.
credential_name
Name of the database credential. This parameter is mandatory when the
db_username and db_password parameters are not specified.
input_file
Used in conjunction with the 'parameters' option, this enables you to store parameter values, such as username and password, in a separate file. This specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific parameter values of the 'parameters' . The tag must not contain colons
( : ) or semi-colons ( ; ).
For information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
generate_export
Specify whether to generate a script to export masked data from the specified source database using Oracle Data Pump. Specify Y or N.
generate_mask
Specify whether to generate a script to replace sensitive data in-place with masked data on a specified (nonproduction) database. Specify Y or N.
script
This is equivalent to -format='name: script'.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
The following example generates a script for the masking definition named mask_hr_data::
emcli generate_masking_script
-definition_name=mask_hr_data
-parameters=db_username:system;db_password:password;db_role:NORMAL
The following example generates a script for the masking definition named
mask_hr_data. The database password is read from the pwd.txt file:
emcli generate_masking_script
-definition_name=mask_hr_data
-parameters=PWD_FILE
-input_file=PWD_FILE:pwd.txt
The following example reads the database credentials from the named credential
DB_NC and generates a masking script for the masking definition named mask_hr_data:
emcli generate_masking_script
-definition_name=mask_hr_data
-credential_name=DB_NC
Generates a subset using the specified subset definition and target database.
emcli generate_subset
-subset_name=<subset_definition_name>
-target_name=<target_name> -target_type=<target_type>
[-in_place_delete]
[-db_pref_cred_name=<DBCredsNormal | DBCredsSYSDBA>]
[-db_cred_name=<database_credential_name>]
[-host_cred_name=<host_credential_name>]
[-rule_parameters=<rule_parameters>]
[-subset_directory=<database_directory_object_name>]
[-custom_directory_path=<custom_directory_path> ]
[-use_external_directory]
[-external_directory=<external_directory_object_name>]
[-export_file_name=<export_file_name>]
[-max_file_size=<maximum_file_size>]
[-max_threads=<maximum_number_of_threads>]
[-compress_dump_file=<compress_dump>]
[-encrypt_dump_file]
[-encryption_password=<encryption_password>
[-confirm_encryption_password=<encryption_password_confirmation>]
[-seed_flag]
[-seed_password=<seed_password>]
[-log_file_name=<log_file_name>]
[-job_name=<job_name>]
[-job_description=<job_description>]
[-is_non_prod_env]
[ ] indicates that the parameter is optional
subset_name
Name of the existing subset definition to generate the subset.
target_name
Database target name.
target_type
Type of target. The possible values for target type are 'oracle_database', 'rac_database', and 'oracle_pdb'.
in_place_delete
Determines whether to generate a subset operation. The default operation is exporting data into a dump file. Set this flag to delete data from the specified target.
db_pref_cred_name
Name of preferred credentials stored in the Enterprise Manager repository. You must provide a value for either db_pref_cred_name_or db_cred_name. The valid values for this parameter are:
DBCredsNormal — Default normal credential set for an oracle_database target.
DBCredsSYSDBA — SYSDBA credential set for an oracle_database target.
db_cred_name
Name of existing credentials stored in the Enterprise Manager repository to connect a selected target database.
host_cred_name
Name of existing host credentials stored in the Enterprise Manager repository to access the target host. If you do not specify a value, the preferred host credentials set for this target are used to access the target host.
rule_parameters
Maps values to rule parameter names.You must specify the value for this parameter if any of the rule parameters have missing values. However, you can also override the specified values using this option.
For example:
-rule_parameters="department_id_param:80;order_id_param:2400"
subset_directory
Directory location object name to save dump and log files. For example:
DATA_PUMP_DIR
custom_directory_path
User-specified directory location on the target host to save dump and log files. You must provide a value for either subset_directory or custom_directory_path. For example:
/scratch/user/subset_dir
use_external_directory
Enables the external directory (clustered/shared file system or ASM) for a faster export dump. If this parameter is set, you need to provide a value for
external_directory.
external_directory
External directory (clustered/shared file system or ASM) for a faster export dump. For example:
DATA_PUMP_DIR
export_file_name
File name to save the dump file. If not specified, the default value is EXPDAT%U.DMP. You can wildcard a set of dump files using '%U' in the file name.
max_file_size
Maximum file size in MB. If not specified, the default value is 100.
max_threads
Maximum number of threads created for export operation. If not specified, the default value is 1.
compress_dump_file
Enables data compression during the export operation.
encrypt_dump_file
Enables data encryption during the export operation.
encryption_password
Password key to encrypt data during export operation. If encrypt_dump_file is set and a value for this parameter is not specified, you are prompted for the encryption password. For a secure operation, it is recommended that passwords should not be stored in the scripts, but specified instead when prompted for them.
confirm_encryption_password
The value for this parameter should be the same as encryption_password. If encrypt_dump_file is set and the value for this parameter is not specified, you are prompted for confirmation of the encryption password. For a secure operation, it is recommended that passwords should not be stored in the scripts, but specified instead when prompted for the them.
seed_flag
Indicates that the subset definition contains one or more masking definitions, and any of the masking definitions contains a substitute or encrypt format.
seed_password
Seed string to be used if the subset definition contains one or more masking definitions and any of the masking definitions contains a substitute or encrypt format. If seed_flag is set and a value for this parameter is not specified, you are prompted for the seed password. The seed can be any text string. For a secure operation, it is recommended that passwords should not be stored in the scripts, but specified instead when prompted for them.
log_file_name
File name to save the log file. The default value is EXPDAT.LOG.
is_non_prod_env
Confirmation that the specified database is not a production database. This parameter is mandatory for the in-place delete option.
job_name
Generates the subset job name.
job_description
Job description.
This example exports data into a dump file.
emcli generate_subset
-subset_name=hr_subset
-target_name=sample_database
-target_type=oracle_database
-export_file_name=EXPDAT.DMP
-db_cred_name=db_cred
-host_cred_name=host_cred
-subset_directory=DATA_PUMP_DIR
This example exports data into a dump file using preferred database and host credentials. For preferred host credentials, you do not need to specify any parameters.
emcli generate_subset
-subset_name=hr_subset
-target_name=sample_database
-target_type=oracle_database
-export_file_name=EXPDAT.DMP
-db_pref_cred_name=DBCredsNormal
-subset_directory=DATA_PUMP_DIR
This example exports data into a dump file at a user-specified location.
emcli generate_subset
-subset_name=hr_subset
-target_name=sample_database
-custom_directory_path=/scratch/user/custom_location
-target_type=oracle_database
-export_file_name=EXPDAT.DMP
-db_pref_cred_name=DBCredsNormal
This example exports data into a dump file using rule parameters.
emcli generate_subset
-subset_name=hr_subset
-target_name=sample_database
-target_type=oracle_database
-export_file_name=EXPDAT.DMP
-db_cred_name=db_cred
-host_cred_name=host_cred
-subset_directory=DATA_PUMP_DIR
-rule_parameters="department_id:80;order_id:2400"
This example exports data into a dump file with encryption enabled. You are prompted for encryption_password and confirm_encryption_password.
emcli generate_subset
-subset_name=hr_subset
-target_name=sample_database
-encryption_password
-target_type=oracle_database
-export_file_name=EXPDAT.DMP
-db_cred_name=db_cred
-host_cred_name=host_cred
-subset_directory=DATA_PUMP_DIR
This example deletes data from the specified target database. To delete data from a target database, just set in_place_delete and is_non_prod_env flags as in the example.
emcli generate_subset
-subset_name=hr_subset
-target_name=sample_database
-target_type=oracle_database
-db_cred_name=db_cred
-host_cred_name=host_cred
-subset_directory=DATA_PUMP_DIR
-in_place_delete
-is_non_prod_env
Generates a user interface page performance trace report, which enables you to identify slow rendering pages.
Standard Mode
emcli generate_ui_trace_report [-user_name="user_name"] [-start_time="start_time"] [-duration="duration"]
Interactive or Script Mode
generate_ui_trace_report( [user_name="user_name"] [,start_time="start_time"] [,duration="duration"] ) [ ] indicates that the parameter is optional.
user_name
User name for which the page performance trace report will be generated. Default is the currently logged in user.
start_time
Start time in mm:dd:yy format from where page performance trace report has to be generated. Default is current time - 1 hour.
duration
Duration in hh:mm format for which the page performance trace report has to be generated. Default is 1 hour.
Displays the latest status of an Add Host session.
emcli get_add_host_status
-session_name="Session name"
[-details]
[-show_only_failed_hosts]
[-host_name="Host name"]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional.
session_name
Name of the session whose status you want to view.
details
Displays additional information for the given session.
show_only_failed_hosts
Displays only the hosts on which the Add Host operation failed.
host_name
Displays the details of the provided host.
noheader
Display tabular output without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
This example displays the add host status for the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST'
emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST
This example displays the add host status for the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST', with additional information.
emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST -details
This example displays the detailed status of host 'example.com' for the session 'ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT'.
emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT -host_name=example.com
This example displays only the failed hosts for the session 'ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT'.
emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT -show_only_failed_hosts
Gets the Management Agent image for the particular platform and version provided as inputs.
emcli get_agentimage -destination=<download_directory> -platform="<platform>" [-version=<version>] [ ] indicates that the parameter is optional.
destination
Directory where you want to download the Management Agent software. Ensure that you have write permission on this location.
If the destination directory is titled with two or more words separated by a space, enclose the directory name with double-quotes. For instance, if the destination directory is titled /tmp/linuxagentimage, enter the value as -destination="/tmp/linuxagentimage"
platform
Platform for which you want to download the software; this must match one of the platforms for which the software is available on the OMS host. Use the emcli get_supported_platforms command to determine this.
version
Version of the Management Agent software that you want to download. If you do not specify this , the version defaults to the OMS version.
Gets the Management Agent image for the Linux platform and version provided as inputs, then converts the image as rpm.
emcli get_agentimage_rpm -destination=<download_directory> -platform=<platform> [-version=<version>] [ ] indicates that the parameter is optional.
destination
Directory where you want to download the .rpm file. Ensure that you have write permission on this location.
If the destination directory is titled with two or more words separated by a space, enclose the directory name with double-quotes. For instance, if the destination directory is titled /tmp/linuxagentimage, enter the value as -destination="/tmp/linuxagentimage"
platform
Platform for which you want to download the .rpm file; this must match one of the platforms for which the software is available on the OMS host. Use the emcli
get_supported_platforms command to determine this.
version
Version of the Management Agent for which you want to download the .rpm file. If you do not specify this , the version defaults to the OMS version.
Displays Management Agent properties. You can use this command if you have view privilege for the Management Agent.
emcli get_agent_properties -agent_name="<agent_target_name>" [-all] [-format="<format_name>"] [ ] indicates that the parameter is optional
agent_name
Name of the Management Agent target.
all
Shows all Management Agent properties. By default, only basic properties appear.
format
Format to display Management Agent properties. Valid values are pretty, script, and csv. By default, values are displayed in pretty format.
Displays the value of a specific Management Agent property. You can use this command if you have view privilege for the Management Agent.
agent_name
Name of the Management Agent target.
name
Name of the Management Agent property.
Shows Agent upgrade results.
emcli get_agent_upgrade_status
[-agent]
[-job_name]
[-status]
[ ] indicates that the parameter is optional
agent
Shows the upgrade job details of the specified Agent names or Agent name patterns separated by commas.
job_name
Shows the upgrade job details of the specified job name.
status
Shows the upgrade job details with the specified status.
Permutations for combinations of parameters are as follows:
No parameters — Shows <JOB NAME, JOB STATUS, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job.
-job_name only — Shows <AGENT_NAME, UPGRADE STATUS OF AGENT, UPGRADE START TIME, UPGRADE END TIME> for each Agent in the job, where job name is passed in the -job_name parameter.
-agent only — Shows <JOB NAME, UPGRADE STATUS OF AGENT IN THE JOB, UPGRADE START TIME, UPGRADE END TIME> for each job where the Agent is present and the Agent name passed in the -agent parameter.
-agent and -status only — Shows <JOB NAME, UPGRADE START TIME, UPGRADE END TIME> for each job in which the Agent and Agent upgrade status are passed in -agent and -status, respectively.
-job_name and -agent only — Shows <JOB STEP NAME, JOB STEP STATUS, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent passed in the -job_name and -agent parameters.
-job_name and -status only — Shows <AGENT_NAME, UPGRADE START TIME, UPGRADE END TIME> for each Agent in the job in which the Agent upgrade status is passed in -job_name and -status, respectively
-job_name, -agent, and -status — Shows <JOB STEP NAME, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent in which the step status is passed in -job_name , -agent , and -status, respectively
-status only — Shows <JOB NAME, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job in which job status is passed in the -status parameter.
This example shows the Agent upgrade job details for the Agent xyz.domain.com:1243 .
emcli get_agent_upgrade_status -agent="xyz.domain.com:1243"
This example shows the Agent upgrade job details for the job UPGRADE_JOB123 .
emcli get_agent_upgrade_status -job_name="UPGRADE_JOB123"
This example shows the Agent upgrade job details with the status Inprogress.
emcli get_agent_upgrade_status -status="Inprogress"
Gets time zone and availability evaluation function information of an aggregate's service instance.
emcli get_aggregate_service_info
-name=<name>
-type=<type>
[-noheader]
[-script|-format=
[name:<pretty|script|csv>];
[column_separator:<sep_string>];
[row_separator:<row_sep_string>]
]
[ ] indicates that the parameter is optional
name
Aggregate service name.
type
Aggregate service type.
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Gets sub-services of an aggregate service instance.
emcli get_aggregate_service_members
-name=<name>
-type=<type>
[-noheader]
[-script|-format=
[name:<pretty|script|csv>];
[column_separator:<sep_string>];
[row_separator:<row_sep_string>]
]
[ ] indicates that the parameter is optional
name
Aggregate service name.
type
Aggregate service type.
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Gets detailed information for a specified blackout.
emcli get_blackout_details
-name=<name>
[-createdby=<blackout_creator>]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:<column_sep_string>];
[row_separator:<row_sep_string>];
]
[ ] indicates that the parameter is optional
name
Name of the blackout.
createdby
Enterprise Manager user who created the blackout. The default is the current user. For displaying details of a blackout created using emctl, use -createdby="<SYSTEM>".
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
Status, Status ID, Run Jobs, Next Start, Duration, Reason, Frequency, Repeat, Days, Months, Start Time, End Time, TZ Region, TZ Offset
This example shows detailed information for blackout blackout1 that the current user created.
emcli get_blackout_details -name=blackout1
This example shows detailed information for blackout blackout1 that user joe created.
emcli get_blackout_details -name=blackout1 -createdby=joe
Lists targets for a specified blackout.
emcli get_blackout_targets
-name=<name>
[-createdby=<blackout_creator>]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:<column_sep_string>];
[row_separator:<row_sep_string>];
]
[ ] indicates that the parameter is optional
name
Name of the blackout.
createdby
Enterprise Manager user who created the blackout. The default is the current user. For listing details of a blackout created using emctl, use -createdby="<SYSTEM>".
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
Lists all blackouts or just those for a specified target or one or more hosts. Only the blackouts the user has privilege to view are listed.
emcli get_blackouts
[-target=<name1:type1> | -hostnames=<host1;host2;...>]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:<column_sep_string>];
[row_separator:<row_sep_string>];
]
[ ] indicates that the parameter is optional
target
Lists blackouts for this target. When neither this nor the -hostnames option is specified, all blackouts the user has privilege to view are listed.
hostnames
Lists blackouts that have a target on one of the specified hosts. The host name is just the target name part of the host target. For example, specify host.example.com, rather than host.example.com:host. When neither this nor the -target option is specified, all blackouts the user has privilege to view are listed.
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
Name, Created By, Status, Status ID, Next Start, Duration, Reason, Frequency, Repeat, Start Time, End Time, Previous End, TZ Region, TZ Offset
This example shows all blackouts with some details.
emcli get_blackouts
This example shows all blackouts that cover the target database2:oracle_database.
emcli get_blackouts -target=database2:oracle_database
This example shows all blackouts that cover some target on host myhost.example.com.
emcli get_blackouts -hostnames=myhost.example.com
This example shows all blackouts that cover some target on host myhost.example.com or on host yourhost.example.com.
emcli get_blackouts -hostnames=myhost.example.com -hostnames=yourhost.example.com
Displays information about all of the Certificate Authorities (CA) created since the Cloud Control installation. It also displays the Management Agent names whose certificates are issued by the CA(s) when you specify the -details option. The following information is retrieved from the Cloud Control repository:
Unique identifier of the Certificate Authority (CA) in the Cloud Control repository
CA description
CA creation date
CA expiration date
Number of Management Agents registered to this CA
Number of secured Management Agents not registered to any CA
emcli get_ca_info
[-ca_id=<id1;id2;...>]
[-details]
[ ] indicates that the parameter is optional
ca_id
Specifies the Certificate Authority ID.
details
For each Certificate Authority, displays the list of Management Agent names whose certificates are issued by it.
This example shows output for the CA with the ID of 2 specified.
emcli get_ca_info -ca_id=2
Info about CA with ID: 2
CA is configured
DN: EMAILADDRESS=Enterprise.Manager@myomshost.mycompany.com,
CN=myomshost.mycompany.com, OU=EnterpriseManager on myomshost.mycompany.com,
O=EnterpriseManager on myomshost.mycompany.com, L=EnterpriseManager on
myomshost.mycompany.com1, ST=CA, C=US, DC=com
Serial# : 87539237298512593900
Valid From: Mon Oct 25 17:01:15 UTC 2011
Valid Till: Thu Oct 22 17:01:12 UTC 2020
Number of Agents registered with CA ID 2 is 1
Number of Agents to be re-secured, as OMS is secured using force_newca
: 1
Regarding the force_newca option in the last line, the output shows that a new certificate was created with the ID of 2. Two Management Agents have been re-secured to be registered with this new certificate. The OMS running on myomshost.mycompany.com has been re-secured to be registered with the new certificate created. There is still a Management Agent that needs to be secured to be registered to the new certificate. To retrieve the Management Agent name, you need to run the command "emcli get_ca_info -ca_id=2 -details," which is shown in the next example.
This example displays the Management Agent names registered with the CA(s) for ID 2.
emcli get_ca_info -ca_id=2 -details
Info about CA with ID: 2
CA is configured
DN: EMAILADDRESS=Enterprise.Manager@myomshost.mycompany.com,
CN=myomshost.mycompany.com, OU=EnterpriseManager on myomshost.mycompany.com,
O=EnterpriseManager on myomshost.mycompany.com, L=EnterpriseManager on
myomshost.mycompany.com2, ST=CA, C=US, DC=com
Serial# : 87539237298512593900
Valid From: Mon Oct 25 17:01:15 UTC 2011
Valid Till: Thu Oct 22 17:01:12 UTC 2020
Number of Agents registered with CA ID 2 is 1
usagent1.mycompany.com:20872
Following Agents needs to be re-secured, as OMS is secured using force_newca
:
ukagent1.mycompany.com:1830
Retrieves the list of cloud service instances. All instances are printed if you do not specify any options.
emcli get_cloud_service_instances
[-user="username"]
[-family="family"]
[-type="service type"]
[ ] indicates that the parameter is optional
user
Identifies the name of the user to be used for filtering service instances.
family
Identifies the name of the service family to be used for filtering service instances.
type
Identifies the type of service to be used for filtering service instances.
This example shows all cloud service instances:
emcli get_cloud_service_instances
This example shows all cloud instances owned by a specified user (user1):
emcli get_cloud_service_instances -user="user1"
This example shows all cloud instances that belong to a specified service family (family1):
emcli get_cloud_service_instances -family="family1"
This example shows all cloud instances that belong to a specified service type (type1):
emcli get_cloud_service_instances -type="type1"
Retrieves a list of cloud service requests. All requests are printed if you do not provide any options. Options cannot be used simultaneously.
emcli get_cloud_service_requests
[-user="username"]
[-family="family"]
[-ids="id1;id2..."]
[ ] indicates that the parameter is optional
user
Identifies the name of the user to be used for filtering service instances.
family
Identifies the name of the service family to be used for filtering service instances.
ids
Lists the Request IDs to be used for filtering cloud requests. Separate each ID with a semicolon ( ; ).
This example shows all cloud service requests:
emcli get_cloud_service_requests
This example shows all cloud service requests created by a specified user (user1):
emcli get_cloud_service_requests -user="user1"
This example shows all cloud service requests that belong to a specified service family (family1):
emcli get_cloud_service_requests -family="family1"
This example shows all cloud service requests with a specific request ID (1 and 2):
emcli get_cloud_service_requests -ids="1;2"
Retrieves a list of cloud user objects, cloud service instances, and cloud service requests. All objects are printed if you do not provide the -user option.
This example shows all cloud user objects, cloud service instances, cloud service requests, and any other objects:
emcli get_cloud_user_objects
This example shows all cloud user objects, cloud service instances, cloud service requests, and any other objects for a specified user (user1):
emcli get_cloud_user_objects -user="user1"
Displays information about saved configuration searches.
emcli get_config_searches
[-target_type="<name_or_pattern>"]
[-format="name:<format_option>"]
[-noheader]
[ ] indicates that the parameter is optional.
target_type
A string matching the target type on which the configuration search is based. Use the internal target type name. Specify the full name or a pattern match using "%" as a wildcard.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings may be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
noheader
Display tabular output without column headers.
Gets all of the comparison templates.
emcli get_config_templates
[-target_type="oracle_database"]
[-template_name="host_template"]
[-owner="SYSMAN"]
[-list_default_templates="yes"]
[-list_oracle_provided_templates="no"]
[-format="[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"]"]
[-noheader]
[ ] indicates that the parameter is optional
target_type
Target type on which the comparison template is created. The value should be the internal name. To get the internal name, execute the following EM CLI command:
emcli get_target_types
template_name
Name of the template, which can be a full value or a pattern match using "%". The value should be an internal name.
owner
Owner of the comparison template, which can be a full value or a pattern match using "%".
list_default_templates
Valid inputs are "yes" and "no". If the value of this option is "yes", the result will contain default templates. If the value of this option is "no", the result will not contain default templates. If this option is not specified, the result shows all templates.
list_oracle_provided_templates
Valid inputs are "yes" and "no". If this option is provided, the result will be only templates provided by Oracle. If the value of this option is "yes", the result contains Oracle-provided templates. If the value of this option is "no", the result will not contain Oracle-provided templates. If this option is not specified, the result shows all templates.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab, and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
noheader
Displays tabular output without column headers.
This example shows all of the comparison templates created on target type "Test Database".
emcli get_config_templates -target_type="oracle_database"
This example shows all of the comparison templates created on target type "Test Database" and having the name "Test Database Template".
emcli get_config_templates -target_type="oracle_database" -template_name="Test Database Template"
This example shows all of the comparison templates created by the user name "Test Admin" that are created on target type "Test Database" and having the template_name as "Test Database Template".
emcli get_config_templates -target_type="oracle_database" -template_name="Test Database Template" -owner="Test Admin"
This example shows all of the comparison templates having the name that contains the string "Test".
emcli get_config_templates -template_name="%Test%"
This example shows all of the comparison templates created by users whose user name contains the string "Admin".
emcli get_config_templates -owner="%Admin%"
This example shows all of the default comparison templates.
emcli get_config_templates -list_default_templates="yes"
This example shows all of the comparison templates provided by Oracle.
emcli get_config_templates -list_oracle_provided_templates="yes"
Gets the My Oracle Supporrt (MOS) connection mode. The two MOS connection modes are online and offline.
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Prints credential-type information for a credential type. The verb prints credential column names. These column names should be used as parameter names for the create_named_credential and modify_named_credential verbs.
Lists the database quota setup for SSA user roles.
The following example successfully retrieves quotas for roles:
emcli get_dbaas_quota
It displays information similar to the following:
ROLE_NAME: SSA_USER_ROLE1 NUMBER_OF_SCHEMA_SERVICES: 99 MEMORY: 99 STORAGE: 99 NUMBER_OF_PLUGGABLE_DATABASES: 99NUMBER_OF_DB_INSTANCES : 99 Quotas for Roles retrieved successfully
Lists the database request settings.
The following example successfully retrieves database request settings:
emcli get_dbaas_request_settings
It displays information similar to the following:
Future Reservation Length : 2 Months Maximum Archive Duration : 10 Weeks Default Retirement Period : 1 Years Request Settings retrieved successfully.
Retrieves the details of an Oracle Database System target from a Database Unique Name.
db_unique_name
Identifies the database unique name of the database target. You can find this name on the Last Collected page of the database target, or you can query for it.
Gets all the target-scoped named credentials that are the same as the given
target-scoped named credential. Duplicate credentials are redundant. Named credentials can be managed better if reused. The same named credential can be reused for all of the usages.
emcli get_duplicate_credential
-cred_name=<cred_name>
[-cred_owner=<cred_owner>]
[ ] indicates that the parameter is optional
cred_name
Searches duplicates of this credential.
cred_owner
Owner of the credential, which defaults to the current user.
Downloads the Extensibility Development Kit to your local system. This verb has no parameters and only downloads a kit called edk.zip to the directory where you execute the command. After extracting the contents, you can use this kit to develop extensible components (plug-ins) of Enterprise Manager.
Lists the members of the specified group.
Note that targets are only listed once, even though they can be in more than one sub-group of the group.
emcli get_group_members
-name=<name>
[-type=<group>]
[-depth=#]
[-noheader]
[-expand_non_groups]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:<column_sep_string>];
[row_separator:<row_sep_string>];
]
[ ] indicates that the parameter is optional
name
Target name of the group.
type
Group type: group. Defaults to group.
depth
Lists target members in sub-groups to the depth specified. The default is 1. When the depth is set to 0, no group target members are listed, and only the group's existence is verified. When the depth is set to -1, all group and sub-group target members are listed; in this case no groups appear in the output. Note that a target is listed at most once, even though it can be a member of several sub-groups.
noheader
Displays tabular information without column headers.
expand_non_groups
Lists members of aggregates and the aggregate target. By default, only sub-group target members are listed.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
This example lists the databases in group db2_group.
emcli get_group_members -name=db2_group
This example verifies that group my_hosts:group exists.
emcli get_group_members -name=my_hosts -depth=0
This example lists the unique targets in group my_group:group and its sub-groups.
emcli get_group_members -name=my_group -depth=-1
This example lists the unique targets in group my_group:group and its sub-groups/aggregates. The aggregate targets are also listed.
emcli get_group_members -name=my_group -depth=-1 -expand_non_groups
Lists all groups.
emcli get_groups
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:<column_sep_string>];
[row_separator:<row_sep_string>];
]
[ ] indicates that the parameter is optional
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Downloads instance submission data.
emcli get_instance_data
[-instance=<instance_guid>]
[-exec=<execution_guid>]
[-name=<execution name>]
[-owner=<execution owner>]
[ ] indicates that the parameter is optional
Displays the procedure instance status identified by the GUID on the command line.
emcli get_instance_status
-instance=<instance_guid>
[-exec=<execution_guid>]
[-name=<execution_name>]
[-owner=<execution_owner>]
[-xml [-details] [-showJobOutput [-tailLength=<last_n_characters>]]]
[ ] indicates that the parameter is optional
instance
Display the details of a procedure instance identified by the GUID number. You can find the GUID number by using the emcli get_instances command.
exec
Execution GUID.
name
Execution name.
owner
Execution owner.
xml
Shows the complete status of each of the steps in XML format.
details
Displays more details for the command output. This option also requires the -xml option.
showJobOutput
Shows the output or errors for the job execution steps. This option also requires the -xml option.
tailLength
Limits the number of characters in the job step output or error. This option also requires the -showJobOutput option.
<Last N Characters> is a positive non-zero number until which the characters are chosen from the end of the job step output. The system sets the maximum permissible characters to dump. If you do not provide this option, the maximum permissible characters are dumped.
This example shows procedure details in CSV format:
emcli get_instance_status -guid=12345678901234567890123456789012
This example shows details in XML format:
emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -details
This example shows details in XML format with complete output:
emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -details -showJobOutput
This example shows details in XML format with the last 1024 characters of output:
emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -showJobOutput -tailLength=1024
Displays a list of procedure instances.
Tip:
See also get_procedure_types.This example lists all procedure instances:
emcli get_instances
This example lists all procedure instances of type 'PatchOracleSoftware':
emcli get_instances -type=PatchOracleSoftware
Gets the value of an internal metric from the specified OMS. This verb obtains metric values for any of the internal metrics returned by the list_internal_metrics verb.
emcli get_internal_metric
-metric_name=<metric name>
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
[-oms_name=<specific oms name> ]
]
[ ] indicates that the parameter is optional.
metric_name
The name of the internal metric whose value you want to extract from the OMS. A list of internal metrics can be obtained using the list_internal_metrics verb.
oms_name
The name of the target OMS. The explicit OMS name can be found in the Cloud Control console Management Services page. To navigate to this page, from the Setup menu select Manage Cloud Control and then Management Services. In the Servers area, look for the full name of the Management Service (<host name>:<port number>_Management_Service).
Note: You only need to specify the oms_name option if you are attempting to access a specific OMS in a multi-OMS environment. If you omit the oms_name option, the get_internal_metric verb will access the OMS running the current instance of EMCLI.
Example 1
The following example extracts metric values for the metric "pbc_WorkManagerStatistics" from the OMS named "myserver.myco.com:17999_Management_Service".
emcli get_internal_metric -metric_name=pbs_WorkManagerStatistics -oms_name=myserver.myco.com:17999_Management_Service
Example 2
The following example extracts metric values for the metric "pbc_WorkManagerStatistics" from the OMS currently running EMCLI.
emcli get_internal_metric -metric_name=pbs_WorkManagerStatistics
Displays details of a job execution.
emcli get_job_execution_detail -execution=<"execution_id"> [-xml [-showOutput [-tailLength=<"length">]]] [ ] indicates that the parameter is optional
execution
Specifies that the ID of the job execution (execution_id) is the job execution ID.
xml
Shows the execution details as XML.
showOutput
Shows the output of the steps inside the job execution. You can only use this option in conjunction with the -xml option.
tailLength
Limits the display of the output to the number of characters from the end of the output. (length) is in characters. You can only use this option in conjunction with the -showOutput option. If you do not specify this option, a system-generated hard limit is enforced.
This example shows the details in CSV format:
emcli get_job_execution_detail -execution=1234567890123456789012345678901
This example shows the details in XML format:
emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml
This example shows the details in XML format with complete output:
emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml -showOutput
This example shows the details in XML format with last N chars output:
emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml -showOutput -tailLength=1024
Lists existing jobs.
emcli get_jobs
[-name="job_name_pattern"]
[-owner="job_owner"]
[-job_ids="ID1;ID2;..."]
[-targets="type1:name1;type2:name2;..."]
[-status_ids="status1;status2;..."]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
get_jobs
[(name="job_name_pattern"]
[,owner="job_owner"]
[,job_ids="ID1;ID2;..."]
[,targets="type1:name1;type2:name2;..."]
[,status_ids="status1;status2;..."]
[,noheader=True|False]
[,script=True|False | ,format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
])
[ ] indicates that the parameter is optional
name
Job name pattern to filter on.
owner
Owner of the jobs to filter on.
job_ids
Lists job IDs to use as the output filters.
targets
Lists targets (as name-type pairs) to use as the output filters.
status_ids
Lists numeric status IDs to use as the output filters.
The numeric codes for all possible job statuses are as follows:
ABORTED(Error)=3
ACTION_REQUIRED_STATUS=22
COMPLETED(Successful)=5
EXECUTING(Running)=2
FAILED=4
INACTIVE=14
MISSING_CREDS_STATUS=21
QUEUED=15
REASSIGNED_STATUS=20
SCHEDULED=1
SKIPPED=18
STOPPED=8
STOP_PENDING=12
SUSPENDED_AGENT_DOWN=7
SUSPENDED_BLACKOUT=11
SUSPENDED_EVENT=10
SUSPENDED_LOCK=9
SUSPEND_PENDING=13
SUSPENDED_USER=6
TARGET_NOT_READY_STATUS =26
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Name, Type, ID, Execution ID, Scheduled, TimeZone, Completed, Status, Status ID, Owner, Target Type, Target Name
These examples show the jobs with the specified job IDs 12345678901234567890123456789012 and 09876543210987654321098765432100:
emcli get_jobs
-job_ids="12345678901234567890123456789012;09876543210987654321098765432100"
Example 2 - Script and Interactive
get_jobs
(job_ids="12345678901234567890123456789012;
09876543210987654321098765432100")
These examples show all jobs run against a host target named mainhost.example.com that are scheduled or have completed.
emcli get_jobs
-status_ids="1;5"
-targets="mainhost.example.com:host"
Example 4 - Script and Interactive
get_jobs
(status_ids="1;5",
targets="mainhost.example.com:host")
These examples show all jobs run against an Oracle database target named payroll that have failed. Tabular output is generated using tabs as column separators and newlines as row separators.
emcli get_jobs
-status_ids="4"
-targets="payroll:oracle_database"
-script
Example 6 - Scripting and Interactive
get_jobs
(status_ids="4"
,targets="payroll:oracle_database"
,script=True)
These examples list all jobs whose names start with BACKUP.
emcli get_jobs
-name="backup%"
Example 8 - Scripting and Interactive
emcli get_jobs
(name="backup%")
These examples list all jobs owned by admin1.
emcli get_jobs
-owner="admin1"
Example 10 - Scripting and Interactive
emcli get_jobs
(owner="admin1")
Lists all the job types that can be used to create jobs, library jobs, and multi-task jobs from EM CLI.
EM CLI supports the following job types:
ASMSQLScript ASSOCIATE_CS_FA ASSOCIATE_DOMAIN_FA AssociateClusterASM BlockAgent CoherenceCacheAddition CoherenceNodesRefresh Config Log Archive Locations DbMachineDashboard DiscoverPDBEntities FusionMiddlewareProcessControl GlassFishProcessControl InstallKernelModuleJob Log Rotation OSCommand OpatchPatchUpdate_PA RMANScript RefreshFromEMStore RefreshFromMetalink RefreshFusionInstance SOABulkRecovery SQLScript ShutdownDB StartDepartedCohNodes StartDepartedCohStoreNodes StartFusionInstance StartupDB StatspackPurge StopFusionInstance Upgrade Exalogic Systems WebLogic Control WebLogic Domain Discover WebLogic Domain Refresh
emcli get_job_types [-type="job_type_pattern"] [-target_type="target_type"] [ ] indicates that the parameter is optional
Gets usage details.
emcli get_metering_data
[-start_date=<start_date_in_mmddyyyy>]
[-end_date=<end_date_in_mmddyyyy>]
[-charge]
[-cost_center=<cost_center_name>]
[-target_type=<target_type>
[-target_name=<target_name>]
[ ] indicates that the parameter is optional
start_date
Report cycle start date in mmddyyyy. If you do not specify the report cycle start date, the latest report cycle is used.
end_date
Report cycle end date in mmddyyyy. If you do not specify the report cycle end date, the latest report cycle is used.
charge
Prints charge relation information.
cost_center
Cost center name. If you do not specify the cost center name, the logged in user is used as the cost center name.
target_type
If you do not specify the target type, all targets are used. Supported target types for this release are oracle_database, oracle_vm_guest, host, and weblogic_j2eeserver. This parameter is not valid without the target_name parameter.
target_name
If you do not specify the target name, all targets of a given target type are used. This parameter is not valid without the target_type parameter.
This example shows the latest cycle usage data for the logged in user.
emcli get_metering_data
This example shows usage data for the cost center cost_center_internal_name for the report cycle with a starting date of 10012011.
emcli get_metering_data -start_date=10012011 -cost_center=cost_center_internal_name
This example shows charge data for the my_target Oracle Guest VM target for cost center cost_center_internal_name for a report cycle with a starting date of 10012011.
emcli get_metering_data
-start_date=10012011
-cost_center=cost_center_internal_name
-target_type=oracle_vm_guest
-target_name=my_target
-charge
For the specified target type, lists the metrics whose alerts are stateless and thus can be manually cleared. Both the metric name and metric internal name are provided in the output of this command. To clear the stateless alerts associated with the specified metric, use the clear_stateless_alerts verb.
target_type
Internal target type identifier, such as host, oracle_database, oc4j, oracle_emrep, and oracle_emd.
Displays named credential details.
emcli get_named_credential
-cred_owner=<owner>
-cred_name=<name>
-out=<filename>
Scripting and Interactive Format
get_named_credential
(cred_owner=<owner>
,cred_name=<name>
,out=<filename>)
cred_owner
Owner of the credential.
cred_name
Required credential name.
out
Output file name. The same file can be used as the input properties file for
create_named_credential and modify_named_credential.
These examples display the details of the named credential NC1 owned by the current logged in user.
emcli get_named_credential
-cred_name=NC1
Example 2 - Scripting and Interactive
get_named_credential
(cred_name="NC1")
These examples display the details of the named credential NC2 owned by the Administrator CREDS_MGR.
emcli get_named_credential
-cred_name=NC2
-cred_owner=CREDS_MGR
Example 4 - Scripting and Interactive
get_named_credential
(cred_name="NC2"
,cred_owner="CREDS_MGR")
Gets the property value corresponding to the specified property name.
emcli get_oms_config_property
-property_name="propertyName"
[-oms_name="omsName"]
[-details]
[ ] indicates that the parameter is optional
property_name
Name of the property whose value must be retrieved.
oms_name
Name of the mangaement server for which the property must be retrieved.
details
Specifies details about from where the property value has been derived, and also the global and default values for the property.
This example retrieves the property value set for the property name "propName" from the management server myhost:1159_Management_Service.
get_oms_config_property -property_name=propName -oms_name="myhost:1159_Management_Service"
This example retrieves the property value set for the property name "propName" from all the management servers.
get_oms_config_property -property_name=propName
This example retrieves the property value set for the property name "propName" from all the management servers with details.
get_oms_config_property -property_name=propName -details
Gets the property value corresponding to the specified logging property name.
emcli get_oms_logging_property
-property_name="propertyName"
[-oms_name="omsName"]
[-details]
[ ] indicates that the parameter is optional
property_name
Name of the logging property whose value must be retrieved.
oms_name
Name of the mangaement server for which the property must be retrieved.
details
Specifies details about from where the property value has been derived, and also the global and default values for the logging property.
This example retrieves the property value set for the property name "propName" from the management server myhost:1159_Management_Service.
get_oms_logging_property -property_name=propName -oms_name="myhost:1159_Management_Service"
This example retrieves the property value set for the property name "propName" from all the management servers.
get_oms_logging_property -property_name=propName
Gets a list of metrics that can be immediately collected with the collect_metric EM CLI verb. From this list, identify the metric you are interested in under the Metric Name column, then use its corresponding Metric Internal name in the collect_metric verb.
target_type
Internal target type identifier, such as host, oracle_database, oc4j, oracle_emrep, and oracle_emd.
target_name
Name of the target.
Generates an agent registration token for one-time use.
Standard Mode
emcli get_onetime_registration_token [-validity="number of minutes"]
Interactive or Script Mode
get_onetime_registration_token([validity="number of minutes"] ) [ ] indicates that the parameter is optional.
validity1
Number of minutes the registration token is valid. The default validity is 15 minutes. The maximum validity allowed is 720 minutes.
Provides detailed step-by-step information about the specified operation plan.
Lists all configured operation plans.
name
Name of the operation plan.
operation
Name of the operation, such as switchover, failover, start, or stop.
Retrieves the PaaS Infrastructure Zone details.
This example retrieves the PaaS Infrastructure Zone details for My PaaS Zone:
emcli get_paas_zone_detail
-name="My PaaS Zone"
It displays the following information:
Name My PaaS Zone Description This is a test PaaS Zone Named Credentials ZoneNamedCredentials Number of Hosts 2 Roles CLOUD_ADMIN_ROLE Maximum Memory Allocation (%) 75 Maximum CPU Utilization (%) 85
Note:
To retrieve the members of this PaaS Infrastructure Zone, run:emcli get_system_members -name="My PaaS Zone" -type="self_service_zone"
Gets patch plan user-editable data.
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Retrieves the list of placement constraints for a pool target type.
Retrieves the capacity details for a software pool including CPU utilization, memory allocation, and number of instances per host.
emcli get_pool_capacity
-name="<Software Pool name>"
-target_type="<Target type of Software Pool>"
Retrieves details for a software pool.
emcli get_pool_detail
-name="<Software Pool name>"
-target_type="<Target type of Software Pool>"
This example retrieves details for the MyPool software pool:
emcli get_pool_detail
-name="My Pool"
-target_type="mwaas_zone"
It displays the following information:
Name My Pool Target Type mwaas_zone Description This is a test Pool Paas Infrastructure Zone My PaaS Zone Number of Members 1 Placement Constraints MAX_INSTANCES : 25 Member Constraints VERSION : 10.3.5.0
Note:
To retrieve the members of this software pool, run:emcli get_system_members -name="My Pool" -type="mwaas_zone"
Retrieves the filtered targets available for software pool creation based on the given criteria.
emcli get_pool_filtered_targets
-target_type="<Target type of Software Pool>"
-paas_zone="<Paas Infrastructure Zone of Software Pool>"
[-member_constraints="<constraint1=value1, constraint2=value2>"
]
[] indicates that the parameter is optional.
target_type
Target type of the Software Pool.
paas_zone
Name of PaaS infrastructure zone within which the filtered targets are to be retrieved.
member_constraints
Comma separated key value pairs that restrict the addition of member targets to a software pool with a set criteria.
Displays the status of a specific plug-in deployment or undeployment activity as well as the list of steps.
emcli get_plugin_deployment_status
[-plugin_id="plugin_id"]
[ ] indicates that the parameter is optional
plugin_id
ID of the plug-in for which you need to view the deployment/undeployment status. If not provided, the command shows the status of the latest plug-in being deployed, or the last one that was deployed or undeployed.
Displays the status of the last plug-in deployment/undeployment activity.
emcli get_plugin_deployment_status
This example displays the status of the last deployment/undeployment activity of a specific plug-in.
emcli get_plugin_deployment_status -plugin_id=oracle.sysman.db
Gets a list of deployment procedures and pre-saved procedure configurations.
Tip:
See also get_procedure_types .
emcli get_procedures [-type=<procedure_type>]
[-parent_proc=<procedure_associate>]
[ ] indicates that the parameter is optional
type
Displays all the deployment procedures of type procedure_type.
parent_proc
Procedure associated with procedure configurations.
Gets the deployment procedure XML file. XML is printed on standard output.
emcli get_procedure_xml
-procedure=[procedure_guid]
[-name=<procedure_name>]
[-owner=<procedure_owner>]
[ ] indicates that the parameter is optional
Returns a list of Information Publisher reports owned by or viewable by all users or a specified user. The output of this report is space-separated, quoted strings for the report title and owner, with each report on its own line.
Space-separated quoted strings for the report title and owner, with each report on its own line.
Gets the list of existing resolution states used in managing incidents and problems. It also prints the display position of states. It does not list the fixed "New" and "Closed" resolution states.
Get arguments of failed steps that can be retried.
emcli get_retry_arguments
[-instance=<instance_guid>]
[-exec=<execution_guid>]
[-name=<execution_name>]
[-owner=<execution_owner>]
[-stateguid=<state_guid>]
[ ] indicates that the parameter is optional
instance
Instance GUID.
exec
Execution GUID.
name
Execution name.
owner
Execution owner.
stateguid
State GUID.
Downloads the execution run-time properties data. The execution can be retrieved by using the instance GUID, execution GUID, or a name value pair.
emcli get_runtime_data
[-instance={instance_guid}]
[-exec={execution_guid}]
[-name={execution name}]
[-owner={execution owner}]
[ ] indicates that the parameter is optional.
instance
Instance GUID.
exec
Execution GUID.
name
Execution name.
owner
Execution owner.
Note:
The name and owner parameters must be used together.Lists the saved configurations.
emcli get_saved_configs
[-target_type="<target_type>"]
[-target_name="<target_name>"]
[-owner="<owner>"]
[-format=name:<pretty|script|csv>;
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];]
[ ] indicates that the parameter is optional
target_type
Internal type name, such as oracle_database for "Oracle Database." You can use the get_target_types command to get the internal name for a target type.
target_name
Name of the target.Either specify the complete name or a pattern match using "%".
owner
Owner of the saved configuration.
This can be a full value or a pattern match using "%".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
noheader
Display tabular output without column headers.
Name (Saved configuration name, the concatenation of target name, target type and saved time in YYYYMMDDHH24MISS format), Target Type, Target Name, Saved Time (Format of the time is: yyyy/MM/dd HH:mm), Time Zone, Owner, Description
This example lists all of the saved configurations created on target type "host":
emcli get_saved_configs -target_type="host"
This example lists all of the saved configurations created on target type "host" and target name "test host":
emcli get_saved_configs -target_type="host" -target_name="test host"
The example lists all of the saved configurations created by user with name "test user" and created on target type "host" and target name "test host":
emcli get_saved_configs -target_type="host" -target_name="test host" -owner="test user"
This example lists all of the saved configurations whose target name contains the string "Test":
emcli get_saved_configs -target_name="%Test%"
This example lists all of the saved configurations created by users whose user name contains the string "Admin":
emcli get_saved_configs -owner="%Admin%"
Retrieves the Service Template details.
emcli get_service_template_detail
-name="<Service_Template_name>"
-service_family="<Service_family_name>"
[ ] indicates that the parameter is optional
name
Name of the existing Service Template.
service_family
Service family to which the Service Template belongs. Examples: DBAAS for Database, and MWAAS for Middleware.
emcli clear_problem
-problem_key="ORA-600"
-target_type="oracle_database"-preview
displays the following output:
Name Middleware service template August
Service Family MWAAS
Description Middleware small instance service template
Roles CLOUD_USER_ROLE_1
Software Pools mwaas_zone:pool1
Configurations
{
"type" : "CDP"
"serviceFamily" : "MWAAS",
"payloads": null,
"configurations" : [ {
"name" : "WebLogic Username *",
"value" : "weblogic",
"id" : "wlsUserName",
"displayName" : null,
"description" : "Username for the WebLogic Server",
"values" : null,
"required" : false,
"secret" : false,
"subconfigurations" : null
}, {
"name" : "WebLogic Password *",
"value" : "Welcome_123",
"id" : "wlsUserPassword",
"displayName" : null,
"description" : "Password for the WebLogic Server",
"values" : null,
"required" : false,
"secret" : true,
"subconfigurations" : null
},{
"name" : "Topology",
"value" : "1",
"id" : "topology",
"displayName" : null,
"description" : "Enter 1 for single cluster, 0 for no cluster. For physical provisioning it is auto populated based on the profile selected. For virtual provisioning it is defaulted to 1. Please change based on the actual topology of the assembly. ",
"values" : null,
"required" : false,
"secret" : false,
"subconfigurations" : null
},
Note that all configurations are not shown in the example above.
Lists the available service templates.
emcli get_service_templates
[-service_family="<Service_family_name>"]
[ ] indicates that the parameter is optional
Shows the available Agents for sign-off.
If you do not specify any options, the command shows all Agents available for sign-off. If you specify more than one option, the command shows the union of Agents available for sign-off belonging to each option passed.
emcli get_signoff_agents
[-agents="List_of_agents"]
[-platforms="List_of_platforms"]
[-versions="list_of_versions"]
[-groups="list_of_group_names"]
[-output_file="location_of_output_file"]
[ ] indicates that the parameter is optional
agents
List of Agents for sign-off matching Agent names or Agent names pattern separated by commas.
platforms
Lists Agents available for sign-off on the specified platforms.
versions
Lists Agents available for sign-off with the specified version.
groups
Lists Agents available for sign-off belonging to the specified groups.
output_file
Adds the Agents into the output file, which can be submitted for a clean-up job to remove old Oracle Management Agent homes and old Oracle home targets, and back up directories of upgraded Oracle Management Agents.
This example shows the list of Agents for clean up that match the Agents specified in the option.
emcli get_signoff_agents -agents="abc%,xyz.domain.com:1243"
This example shows the list of Agents for clean up that match the platform specified in the option.
emcli get_signoff_agents -platforms="Linux x86,Microsoft Windows x64 (64-bit)"
This example shows the list of Agents for clean up that match the versions specified in the option.
emcli get_signoff_agents -versions="12.1.0.1.0,12.1.0.2.0"
This example shows the list of Agents for clean up that match the group names specified in the option.
emcli get_signoff_agents -groups="GROUP1,GROUP2"
This example adds the list of Agents for clean up to the /scratch/agents_file.txt file.
emcli get_signoff_agents -output_file="/scratch/agents_file.txt"
Shows Agent sign-off results.
emcli get_signoff_status
[-agent="full_agent_name"]
[-job_name="job_name"]
[-status="status"]
[ ] indicates that the parameter is optional
agent
Shows the sign-off job details of the specified Agent names or Agent names pattern separated by commas.
job_name
Shows the sign-off job details of the specified job name.
status
Shows the sign-off job details of the specified status.
Permutations for combinations of parameters are as follows:
No parameters — Shows <JOB NAME, JOB STATUS, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job.
-job_name — Shows <AGENT_NAME, STATUS OF JOB, START TIME, END TIME> for each Agent in the job, where tje job name is passed in the -job_name parameter.
-status only — Shows <JOB NAME, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job, where the job status is passed in -status parameter.
-agent only — Shows <JOB NAME, STATUS OF JOB, START TIME, END TIME> for each job, where the Agent is present and the Agent name is passed in the -agent parameter.
-job_name and -agent only — Shows <JOB STEP NAME, JOB STEP STATUS, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent passed in -job_name , -agent parameter
-job_name, -agent, and -status — Shows <JOB STEP NAME, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent having step status passed in -job_name , -agent , and -status respectively.
-job_name and -status — Shows <AGENT_NAME, START TIME, END TIME> for each Agent in the job having an Agent upgrade status passed in -job_name and -status respectively.
-agent and -status — Shows <JOB NAME, START TIME, END TIME> for each job having the Agent and clean-up status passed in -agent and -status respectively.
This example shows the sign-off job details for agent xyz.domain.com:1243 .
emcli get_signoff_status -agent=xyz.domain.com:1243
This example shows the sign-off job details with the job name cleanup_123.
emcli get_signoff_status -job_name="cleanup_123"
This example shows the sign-off job details with the status Success.
emcli get_signoff_status -status="Success"
Lists the credential associations configured for a system.
emcli get_siteguard_credential_association
[-system_name=<name_of_system>]
[-target_name=<name_of_target>]
[-credential_type=<type_of_credential>]
[ ] indicates that the parameter is optional
system_name
Name of the system.
target_name
Name of the target.
credential_type
Type of the credential, which can be HostNormal, HostPrivileged, WLSAdmin, or DatabaseSysdba.
emcli get_siteguard_credential_association
-system_name="austin-system"
-credential_type="HostNormal"
emcli create_siteguard_credential_association
-system_name="austin-system"
-target_name="austin-database-instance"
-credential_type="HostNormal"
Displays the schedule of health checks for an operation plan.
emcli get_siteguard_health_checks
[-operation_plan="name_of_the_operation_plan"]
[ ] indicates that the parameter is optional
Retrieves and shows the configured limit for the Apply lag and Transport lag for all or selected databases of the system.
emcli get_siteguard_lag
[-system_name="name_of_the_system"]
[-target_name="name_of_the_target_database"]
[-property_name="lag_type"]
[ ] indicates that the parameter is optional
system_name
Name of the system whose configuration details you want to view.
target_name
Name of the database whose lag configuration details you want to view.
property_name
Name of the lag property configured. Valid values are ApplyLag and TransportLag.
This example displays the details of the Apply lag limit configured on all of the databases of the system austin-system:
emcli get_siteguard_lag
-system_name="austin-system"
-property_name="ApplyLag"
This example displays the details of the Transport lag limit configured on the database OID-db of austin-system:
emcli get_siteguard_lag
-system_name="austin-system"
-target_name="OID_db"
-property_name="TransportLag"
Retrieves all credentials parameters for a Site Guard script.
emcli get_siteguard_script_credential_params -script_id="Id associated with the script" -credential_name="name of the credential" [-credential_owner="credential owner"] [ ] indicates that the parameter is optional.
script_id
The script ID.
credential_name
Name of the credential. If this parameter is not specified, all credentials associated as parameters for the script will be listed.
credential_owner
The owner of the credential. If this argument is not specified, all credentials associated as parameters for the script will be listed.
The following command retrieves the Site Guard credential parameters for the script with the ID 1 and name NAMED_CREDENTIAL_X.
emcli get_siteguard_script_credential_params
-script_id="1"
-credential_name="NAMED_CREDENTIAL_X"
The following command retrieves the Site Guard credential parameters for all scripts with the script ID of 3.
emcli get_siteguard_script_credential_params
-script_id=3"
The following command retrieves the Site Guard credential parameters for all scripts with the script ID of 3, owned by the user SG_ADMIN.
emcli get_siteguard_script_credential_params
-script_id="3"
-credential_owner="SG_ADMIN"
Lists the host or hosts associated with any script where the script is designated to run.
emcli get_siteguard_script_hosts
[-script_id=<script_id>]
[ ] indicates that the parameter is optional
Obtains the Site Guard scripts associated with the specified system.
emcli get_siteguard_scripts
-system_name=<system_name>
-operation=<operation_name>
[-script_type=<type_of_script>]
[-role=<role_of_system>]
system_name
Name of the system.
operation
Name of the operation, such as switchover, failover, start, or stop.
script_type
Type of the script. For example: mount, unmount, pre-script, post-script, failover, or switchover.
role
Filters the scripts based on the role associated with the system. For example: Primary or Standby.
emcli get_siteguard_scripts
-system_name="BISystem1"
-operation="Switchover"
-script_type="Pre-Script"
emcli get_siteguard_scripts
-system_name="austin-system"
-operation="Switchover"
-script_type="Pre-Script"
-role="Primary"
Lists the platforms for which the Management Agent software is available on the OMS host.
Gets the list of available privileges in Enterprise Manager based on the type specified.
emcli get_supported_privileges
-type="ResourceType"
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional
type
Type of privileges to retrieve from Enterprise Manager. Possible values are:
ALL (default value)
SYSTEM
TARGET
JOB
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Lists the members of the specified system.
emcli get_system_members
-name="name"
[-type=<generic_system>]
[-depth=# (default 1)]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional
name
Target name of the system.
type
System type: generic_system. Defaults to generic_system.
depth
Lists target members in sub-systems to the specified depth. When the depth is set to 0, no system target members are listed, and only the system's existence is verified. When the depth is set to -1, all system and sub-system target members are listed.
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script". In interactive and script mode, the value must be True or False.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
This example lists the databases in system db2_system.
emcli get_system_members -name=db2_system
This example verifies that system my_system:generic_system exists.
emcli get_system_members -name=my_system -depth=0
This example lists the unique targets in system my_system:generic_system and its sub-systems.
emcli get_system_members -name=my_system -depth=-1
Obtain target types and their details for the input plug-in.
emcli get_target_types
-plugin="Plug-in Id for which the targets types needs to be retrieved"
Output columns:Display Target Type, Target Type Is Composite (Y/N)
Gets status and alert information for targets.
emcli get_targets
[-targets="[name1:]type1;[name2:]type2;..."]
[-alerts]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[-limit_rows="maximum_targets_to_be_retrieved"]
[-config_search="configuration_search_UI_name"]
[-unmanaged]
[-properties]
[-separator_properties="properties_sep_string"]
[-subseparator_properties="properties_subsep_string"]
[ ] indicates that the parameter is optional
Scripting and Interactive Format
get_targets
[(targets="[name1:]type1;[name2:]type2;..."]
[,alerts=True|False]
[,noheader=True|False]
[,script=True|False | ,format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[,-limit_rows="maximum_targets_to_be_retrieved"]
[,-config_search="configuration_search_UI_name"]
[,-unmanaged]
[,-properties]
[,-separator_properties="properties_sep_string"]
[,-subseparator_properties="properties_subsep_string"])
[ ] indicates that the parameter is optional
targets=name:type
Name or type can be either a full value or a pattern match using %. Also, name is optional, so the type can be specified alone.
alerts
Shows the count of critical and warning alerts for each target. In scripting and interactive mode, the value needs to be set to either True or False.
noheader
Display tabular output without column headers. In scripting and interactive mode, the value needs to be set to either True or False.
script
This is equivalent to -format="name:script". In scripting and interactive mode, the value needs to be set to either True or False.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
limit_rows
Maximum number of targets to be retrieved. This defaults to 2000 rows if not specified.
config_search
The search UI name should be the display name of the configuration search.
unmanaged
Gets unmanaged targets (no status or alert information).
properties
Maximum number of targets to be retrieved. This defaults to 2000 rows if not specified.
separator_properties
Displays unmanaged target properties with separator_properties.
subseparator_properties
Displays unmanaged target properties with subseparator_properties.
These examples show all targets. Critical and Warning columns are not included.
emcli get_targets
Example 2 - Scripting and Interactive
get_targets()
These examples show all targets. Critical and Warning columns are shown.
emcli get_targets
-alerts
Example 4 - Scripting and Interactive
get_targets
(alerts=True)
These examples show all oracle_database targets.
emcli get_targets
-targets="oracle_database"
Example 6 - Scripting and Interactive
get_targets
(targets="oracle_database")
These examples show all targets whose type contains the string oracle.
emcli get_targets
-targets="%oracle%"
Example 8 - Scripting and Interactive
get_targets
(targets="%oracle%")
These examples show all targets whose name starts with databa and type contains oracle.
emcli get_targets
-targets="databa%:%oracle%"
Example 10 - Scripting and Interactive
get_targets
(targets="databa%:%oracle%")
These examples show status and alert information on the Oracle database named database3.
emcli get_targets
-targets="database3:oracle_database"
-alerts
Example 12 - Scripting and Interactive
get_targets
(targets="database3:oracle_database"
,alerts=True)
These examples show name and type information for unmanaged host targets.
emcli get_targets
-targets="host"
-unmanaged
Example 14 - Scripting and Interactive
get_targets (targets="host" ,unmanaged)
These examples show name, type, and properties for unmanaged host targets with the specified separators. By default, the separator_properties is ";" and the subseparator_properties is ":".
emcli get_targets
-unmanaged -properties
-separator_properties=,
-subseparator_properties==
Example 16 - Scripting and Interactive
get_targets
(unmanaged -properties
,separator_properties=,
,subseparator_properties==)
Shows test thresholds.
emcli get_test_thresholds -name=<target_name> -type=<target_type> -testname=<test_name> -testtype=<test_type> [-script|-format= [name:"pretty|script|csv"]; [column_separator:"sep_string"]; [row_separator:"row_sep_string"]
]
[ ] indicates that the parameter is optional
name
Target name.
type
Target type.
testname
Test name.
testtype
Test type.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Obtains threshold information for a given target and metric.
emcli get_threshold -target_name="tname" -target_type="ttype" [-metric="metric_group"] [ ] indicates that the parameter is optional
target_name
Name of the target associated with the threshold.
target_type
Type of target associated with the threshold.
metric
Metric group associated with the threshold. The default without this option is to show the threshold of all metrics.
This example gets the threshold data for the Load category on the host myhost.example.com.
emcli get_threshold
-target_name="myhost.example.com"
-target_type="host"
-metric="Load"
This example gets the DiskActivitybusy threshold for the Disk Activity on the host myhost.oracle.com.
emcli get_threshold
-target_name="myhost.oracle.com"
-target_type="host"
-metric="DiskActivity"
Gets a list of alerts that are out-of-sync between the Management Agent and the repository for the specified target. You would typically use this command when you think that the Management Agent has not uploaded the latest alert to the repository. Under these circumstances, the repository would be out-of-sync with the Management Agent state.
target_type
Internal target type identifier, such as host, oracle_database, emrep, and so forth.
target_name
Name of the target.
Gets a list of metric extensions deployed to Agents, but not attached to any targets.
Shows upgradable Agents. If you do not specify any options, the command shows all upgradable Agents. If you specify more than one option, the command shows the union of upgradable Agents belonging to each option specified.
emcli get_upgradable_agents
[-agents="full_agent_name"]
[-platforms="list_of_platforms"]
[-versions="list_of_versions"]
[-groups="list_of_group_names"]
[-output_file="output_file_location"]
[ ] indicates that the parameter is optional
agents
Lists upgradable Agents matching Agent names or an Agent names pattern.
platforms
Lists upgradable Agents on the specified platforms.
versions
Lists upgradable Agents with the specified version.
groups
Lists upgradable Agents belonging to the specified groups.
output_file
Lists upgradable Agents and adds them to the specified file.
This example lists upgradable Agents matching the pattern abc% and xyz.domain.com agent.
emcli get_upgradable_agents -agents="abc%,xyz.domain.com:1243"
This example lists upgradable Agents on the platforms Linux x86 and Microsoft Windows x64 (64-bit).
emcli get_upgradable_agents -platforms="Linux x86,Microsoft Windows x64 (64-bit)"
This example lists upgradable Agents with version 12.1.0.1.0 and 12.1.0.2.0
emcli get_upgradable_agents -versions="12.1.0.1.0,12.1.0.2.0"
This example lists upgradable Agents belonging to groups GROUP1 and GRP2.
emcli get_upgradable_agents -groups="GROUP1,GRP2"
This example lists upgradable Agents and adds them to the file /scratch/agents_file.txt.
emcli get_upgradable_agents -output_file="/scratch/agents_file.txt"
Grants roles for accessing the BI Publisher catalog.
emcli grant_bipublisher_roles
(-roles="role1[;role2;...role_n]"
[-users="user"]
[-external_role="grantee_group"])
[ ] indicates that the parameter is optional
roles
Grants one or more roles to BI Publisher. Specify one or more roles separated by a semicolon.
users
Users to receive the granted role.
external_role
Group to assign the role.
This example grants one role to a group.
emcli grant_bipublisher_roles -roles="EMBIPViewer" -external_role="TESTGROUPNAME"
This example grants more than one role to a group.
emcli grant_bipublisher_roles -roles="EMBIPViewer;EMBIPAuthor"
-external_role="TESTGROUPNAME"
This example grants one role to a user.
emcli grant_bipublisher_roles -roles="EMBIPViewer"
-users="TESTUSERNAME"
This example grants one role to multiple users.
emcli grant_bipublisher_roles -roles="EMBIPViewer"
-users="TESTUSERNAME;TESTUSERNAME2"
This example grants more than one role to multiple users and a group.
emcli grant_bipublisher_roles -roles="EMBIPViewer;EMBIPAuthor"
-external_role="TESTGROUPNAME"
-users="TESTUSERNAME;TESTUSERNAME2
Grants licenses on a set of user-specified packs, or all packs to a set of user-specified targets, or all targets belonging to the input licensable target type.
For 11g database targets, you cannot enable or disable the Database Diagnostic and Tuning Packs through the user interface. You need to set the control_management_pack_access initialization parameter to manage your licenses. For information about this parameter, see the Enterprise Database Management chapter of Oracle Enterprise Manager Licensing Information.
Tip:
You can use this verb to grant licenses for standalone target types, such as hosts and databases, but you cannot use this verb to grant licenses for the parent Application Server (oracle_ias) target type, which has dependent target types of OC4J, Jserv, Web Cache, and so forth. To do this, use the grant_license_with_validation verb instead.For example, for pack ias_config and an Application Server target of AS1 with an associated dependent target of OC4J1, this verb grants a license to AS1, but this does not propagate to OC4J1.
emcli grant_license_no_validation -type="target_type" [-targets="tname1;tname2;..."] [-packs="pack1;pack2;..."] [-file="file_name"]
[-displayAllMessages]
[ ] indicates that the parameter is optional
type
Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".
targets
Targets should be specified in the following sequence:
TargetName1;TargetName2;
For example:
-targets="database1;database2;database3;"
The semi-colon ( ; ) is the target separator.
See the "Examples" section below for information about providing arguments for the targets .
packs
License packs should be specified in the following sequence:
pack1;pack2;
For example:
-packs="db_diag;db_config;"
The semi-colon ( ; ) is the pack separator.
See the "Examples" section below for information about providing arguments for the packs .
file
Specify the file name, including the complete path. For example:
-file="/usr/admin1/db_license.txt"
The file should contain the list of targets and packs according to the following cases:
If you only need to provide a list of targets, use the following format:
targets=database1;database2;database3;
If you only need to provide a list of packs, use the following format:
packs=db_diag;db_config;
If you need to provide a list of both targets and packs, use the following format:
targets=database1;database2;database3;packs=db_diag;db_config;
displayAllMessages
Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the command line.
Example 1 and Example 2 below grant licenses to specific packs for specific targets. In order to know which target types and pack names you can pass as arguments, you can use the view named mgmt_license_view to see a list of licensable targets, their target types, and the list of packs licensed on them.
To obtain this information, do the following:
Access SQL*Plus with your username and password, using sysman or other user that has access to sysman.mgmt_license_view.
Select a distinct pack name from sysman.mgmt_license_view, where:
target_type=<oracle_database>
This example shows pack names for an Oracle database you specify as the target type.
PACK_NAME ------------------- db_config provisioning db_sadm db_tuning db_diag provisioning_db db_chgmgt 7 rows selected.
Based on this information, to grant a license to the database1 target for the db_chgmgt pack, you would enter the following command:
emcli grant_license_no_validation -type="oracle_database" -targets="database1" -packs="db_chgmgt"
The only limitation of mgmt_license_view is that it only lists the packs for a target type where the pack is granted to at least one target of that type. That is, if the pack is not granted to any target of that type, mgmt_license_view cannot provide any information.
This example grants the license to the db_diag and db_config packs to database1, database2, and database3 targets (oracle_database target type):
emcli grant_license_no_validation -type="oracle_database" -targets="database1;database2;database3;" -packs="db_diag;db_config;"
This example grants the license to the db_diag and db_config packs to all database targets in the setup:
emcli grant_license_no_validation -type="oracle_database"
-packs="db_diag;db_config;"
This example grants the license to all packs (applicable to database targets) to database1, database2, and database3 targets in the setup:
emcli grant_license_no_validation -type="oracle_database" -targets="database1;database2;database3;"
This example grants the license to all packs (applicable to database targets) to all database targets in the setup:
emcli grant_license_no_validation -type="oracle_database"
This example uses a text file to pass targets and pack names as the argument. It grants the license to the db_diag and db_config packs to the database1, database2, and database3 targets (oracle_database target type):
emcli grant_license_no_validation -type="oracle_database" -file="/usr/admin1/db_license.txt" targets=database1;database2;database3; packs=db_diag;db_config;
... where the content of the "/usr/admin1/license/db_license.txt" file is as follows:
targets=database1;database2;database3; packs=db_diag;db_config;
Grants licenses on a set of user-specified packs, or all packs to a set of user-specified targets, or all targets belonging to the input licensable target type as per business rules.
For 11g database targets, you cannot enable or disable the Database Diagnostic and Tuning Packs through the user interface. You need to set the control_management_pack_access initialization parameter to manage your licenses. For information about this parameter, see the Enterprise Database Management chapter of Oracle Enterprise Manager Licensing Information.
Tip:
You can use this verb to grant licenses for standalone target types, such as hosts and databases, and you also use this verb to grant licenses for the parent Application Server (oracle_ias) target type, which has dependent target types of OC4J, Jserv, Web Cache, and so forth.For example, for pack ias_config and an Application Server target of AS1 with an associated dependent target of OC4J1, this verb grants a license to AS1 and also propagates to OC4J1 (and all other dependent targets associated with AS1).
To grant licenses for only standalone target types, use the grant_license_no_validation verb.
emcli grant_license_with_validation -type="target_type" [-targets="tname1;tname2;..."] [-packs="pack1;pack2;..."] [-file="file_name"] [-displayAllMessages] [ ] indicates that the parameter is optional
type
Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".
targets
Targets should be specified in the following sequence:
TargetName1;TargetName2;
For example:
-targets="database1;database2;database3;"
The semi-colon ( ; ) is the target separator.
See the "Examples" section below for information about providing arguments for the targets .
packs
License packs should be specified in the following sequence:
pack1;pack2;
For example:
-packs="db_diag;db_config;"
The semi-colon ( ; ) is the pack separator.
See the "Examples" section below for information about providing arguments for the packs .
file
Specify the file name, including the complete path. For example:
-file="/usr/admin1/db_license.txt"
The file should contain the list of targets and packs according to the following cases:
If you only need to provide a list of targets, use the following format:
targets=database1;database2;database3;
If you only need to provide a list of packs, use the following format:
packs=db_diag;db_config;
If you need to provide a list of both targets and packs, use the following format:
targets=database1;database2;database3; packs=db_diag;db_config;
displayAllMessages
Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the cmd line.
Example 1 and Example 2 below grant licenses to specific packs for specific targets. In order to know which target types and pack names you can pass as arguments, you can use the view named mgmt_license_view to see a list of licensable targets, their target types, and the list of packs licensed on them.
To obtain this information, do the following:
Access SQL*Plus with your username and password, using sysman or other user that has access to sysman.mgmt_license_view.
Select a distinct pack name from sysman.mgmt_license_view, where:
target_type=<oracle_database>
This example shows pack names for an Oracle database you specify as the target type.
PACK_NAME ------------------- db_config provisioning db_sadm db_tuning db_diag provisioning_db db_chgmgt 7 rows selected.
Based on this information, to grant a license to the database1 target for the db_chgmgt pack, you would enter the following command:
emcli grant_license_with_validation -type="oracle_database" -targets="database1" -packs="db_chgmgt"
The only limitation of mgmt_license_view is that it only lists the packs for a target type where the pack is granted to at least one target of that type. That is, if the pack is not granted to any target of that type, mgmt_license_view cannot provide any information.
This example grants a license to the db_diag and db_config packs to database1, database2, and database3 targets (oracle_database target type):
emcli grant_license_with_validation -type="oracle_database" -targets="database1;database2;database3;" -packs="db_diag;db_config;"
This example grants a license to the db_diag and db_config packs to all database targets in the setup:
emcli grant_license_with_validation -type="oracle_database"
-packs="db_diag;db_config;"
This example grants a license to all packs (applicable to database targets) to database1, database2, and database3 targets in the setup:
emcli grant_license_with_validation -type="oracle_database" -targets="database1;database2;database3;"
This example grants a license to all packs (applicable to database targets) to all database targets in the setup:
emcli grant_license_with_validation -type="oracle_database"
This example uses a text file to pass targets and pack names as the argument. It grants a license to the db_diag and db_config packs to the database1, database2, and database3 targets (oracle_database target type):
emcli grant_license_with_validation -type="oracle_database" -file="/usr/admin1/db_license.txt" targets=database1;database2;database3; packs=db_diag;db_config;
where the content of the "/usr/admin1/license/db_license.txt" file is as follows:
targets=database1;database2;database3; packs=db_diag;db_config;
Grants the privileges to the existing Enterprise Manager user or Enterprise Manager Role.
Note:
To replace an existing Enterprise Manager administrator role, use the modify_role verb.
emcli grant_privs
-name="username"
-privilege="name[;secure_resource_details]"
[-grant_all_targets_on_host="yes|no"]
[-separator=privilege="sep_string"]
[-subseparator=privilege="subsep_string"]
[ ] indicates that the parameter is optional
name
User name or role name to which privileges will be assigned.
privilege
Privilege to be granted to the Enterprise Manager user or role. You can specify this parameter more than once.
Specify secure_resource_details as:
resource_guid|[resource_column_name1=resource_column_value1 [:resource_column_name2=resource_column_value2]..]"
Optionally, you can drop resource column names from this parameter if you provide resource information in the order described by emcli get_supported_privileges. See the "See Also" section below for more information.
grant_all_targets_on_host
Indicates if the privilege needs to be granted on all targets of the host specified as part of the privilege parameter. The default value is no.
separator=privilege
Specify a string delimiter to use between name-value pairs for the value of the -privilege option. The default separator delimiter is a semi-colon ( ; ).
subseparator=privilege
Specify a string delimiter to use between the name and value in each name-value pair for the value of the -privilege option. The default subseparator delimiter is a colon ( : ).
This example grants these privileges to user1:
Privilege to use any beacon
Full control of the jobs with ID 923470234ABCDFE23018494753091111
Full control on the target host1.example.com:host
Full control on the credential cred1:user2
View Privilege on target with ID 123451234ABCDFE23018494753092222
emcli grant_privs
-name="user1"
-privilege="USE_ANY_BEACON"
-privilege="FULL_JOB;923470234ABCDFE23018494753091111"
-privilege="FULL_TARGET;TARGET_NAME=host1.example.com:TARGET_TYPE=host"
-privilege="FULL_CREDENTIAL;CRED_NAME=cred1:CRED_OWNER=user2"
-privilege="FULL_CREDENTIAL;CRED_GUID=123451234ABCDFE23018494753092222"
This example grants target privileges to EM Role : Role1:
emcli grant_privs
-name="Role1"
-privilege="FULL_TARGET;TARGET_NAME=host1.example.com:TARGET_TYPE=host"
This example grants FULL_TARGET privilege on all targets on host host1.example.com to user1.
emcli grant_privs
-name="user1"
-privilege="FULL_TARGET;TARGET_NAME=host1.exemple.com:TARGET_TYPE=host"
-grant_all_targets_on_host="yes"
This example uses the separator and subseparator parameters to grant FULL_TARGET privilege on host1.example.com to user1.
emcli grant_privs
-name="user1"
-privilege="FULL_TARGET->TARGET_NAME=host1.example.com@@TARGET_TYPE=host"
-separator=privilege="->"
-subseparator=privilege="@@"
To see the complete list of privileges and resource column names, execute the following command:
emcli get_supported_privileges
To see the list of SYSTEM privileges, which do require resource information:
emcli get_supported_privileges -type=SYSTEM
To see the list of TARGET privileges:
emcli get_supported_privileges -type=TARGET
To see the list of JOB privileges:
emcli get_supported_privileges -type=JOB
Grants roles to an existing Enterprise Manager user or Enterprise Manager role.
emcli grant_roles
-name="username"
[-roles="role1;role2;..."]
[ ] indicates that the parameter is optional
name
User name or role name to which roles will be assigned.
roles
Roles that will be granted to an Enterprise Manager user or role. You can specify this option more than once.
Shows a summary of all verbs or command-line help for individual EM CLI verbs.
Note:
EM CLI must be set up and configured before command line help is available for all verbs.Ignores a failed step. An instance cannot be ignored when it completes, completes with an error, is suspended, or is stopped.
emcli ignore_instance
-instance=<instance_guid>
[exec=<execution_guid>]
[-name=<execution_name>]
[-owner=<execution_owner>]
[-stateguid=<state_guid>]
[ ] indicates that the parameter is optional
instance
Instance GUID.
exec
Execution GUID.
name
Execution name.
owner
Execution owner.
stateguid
Comma-separated list of state GUIDs.
Imports an Application Data Model from the specified XML file.
emcli import_adm
-file=<file_name>
-adm_name=<application_data_model_name>
-target_name=<target_name>
-target_type=<target type>
[-desc=<description>]
[ ] indicates that the parameter is optional
file
File name with the absolute path of the XML file.
adm_name
Model name with which the Application Data Model will be imported.
target_name
Target for which the Application Data Model will be created.
target_type
Target type of the target for which the Application Data Model will be created.
desc
Application Data Model description.
Imports a workload metadata XML file and creates a new application replay workload object. A Workload metadata XML file, which is stored in the workload root directory, is automatically generated as part of the workload capture process. The XML file contains a pointer to the actual raw captured workload data files. If you are importing a workload captured by one Enterprise Manager system to another, make sure the workload storage location specified in the XML file is reachable and contains the workload data files.
emcli import_appreplay_workload
-input_file=template:<input_filename>
[ ] indicates that the parameter is optional
input_file
Fully-qualified path to a workload metadata XML file. The workload XML file is automatically created during capture. However, you may need to make necessary changes to the XML file before you import. For example, you may want to change the workload name in the exported file and rename the XML file to match the workload name. You may also need to modify the storage locations to point to where the workload data files are located if you have moved the captured data files.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
Imports charge plan metadata from the specified file.
emcli import_charge_plans
[-charge_plan="plan_name"[-entity_type=entity_type_name]]
[<-create|-create_revision|-validate|-describe>]
[-start_date=ddmmyyyy]
-file=file_name
[ ] indicates that the parameter is optional
charge_plan
Name of the charge plan to import. If this parameter is not specified, imports all charge plans within the file.
entity_type
Name of the Chargeback entity type whose charge rate metadata to import from the specified charge plan within the file. If this parameter not specified, import all entity type charge rates from the charge plan.
create
Import charge plan metadata to create a charge plan.
create_revision
Import charge plan metadata to create a charge plan revision.
validate
Validate the charge plan metadata file. This is the default action if no import operation is specified.
describe
Describe the charge plan metadata in the specified file.
start_date
Start date in ddmmyyyy format of the report cycle for the applicable charge plan import operation. If this parameter not specified, uses the start date of the current report cycle.
file
Absolute path of the XML file containing the charge plan metadata to import.
This example validates charge plan metadata in /home/allplans.xml:
emcli import_charge_plans
-file=/home/allplans.xml
-validate
This example describes charge plan metadata in /home/allplans.xml:
emcli import_charge_plans
-file=/home/allplans.xml
-describe
This example imports Plan A charge plan metadata in /home/plans.xml to create a plan, using the current report cycle start date as the plan's effective date:
emcli import_charge_plans
-charge_plan="Plan A"
-file=/home/plans.xml
-create
This example imports Plan B charge plan metadata in /home/plans.xml to create a plan, with an effective start date of 01092014:
emcli import_charge_plans
-charge_plan="Plan B"
-file=/home/plans.xml
-create
-start_date=01092014
This example imports Plan C charge plan metadata in /home/plans.xml to create a plan revision with an effective start date of 01092014:
emcli import_charge_plans
-charge_plan="Plan C"
-file=/home/plans.xml
-create_revision
-start_date=01092014
This example imports Chargeback host entity type metadata from Plan D in /home/plans.xml to create a plan using the current report cycle start date as the plan's effective date:
emcli import_charge_plans
-charge_plan="Plan D"
-file=/home/plans.xml
-entity_type=host
-create
Imports a compliance object into the repository.
import_compliance_object
-files=file1;file2;... [-overwrite] [-deep]
[ ] indicates that the parameter is optional
Imports user-defined charge item metadata from the specified file.
emcli import_custom_charge_items
-file=file_name
[-validate]
[ ] indicates that the parameter is optional
file
Absolute path of the XML file from which to import user-defined charge item metadata.
validate
Validates the XML file.
This example imports user-defined charge item metadata from /home/host.xml:
emcli import_custom_charge_items
-file=/home/host.xml
This example validates user-defined charge item metadata in /home/host.xml:
emcli import_custom_charge_items
-file=-file=/home/host.xml
-validate
Imports a custom plug-in update that was created using the Extensibility Development Kit. The imported plug-in update is used for all subsequent plug-in deployments on the Management Agents.
archive
Absolute path to the custom update archive file.
overwrite
Overwrites an existing custom plug-in update, if a custom plug-in update already exists for that plug-in. If not provided, the custom plug-in update is not imported for that plug-in. Applies only to subsequent plug-in deployments. Does not automatically redeploy on the Management Agents where the already-existing plug-in was previously deployed. To redeploy on such Management Agents, run the emcli redeploy_plugin_on_agent verb.
Example 1
The following example imports the 12.1.0.4.0_oracle.sysman.db.008.zip archive file from the /u01/oracle/plugin_updates/ location, assuming no custom plug-in update already exists for that plug-in.
emcli verb_name
-archive="/u01/oracle/plugin_updates/12.1.0.4.0_oracle.sysman.db.008.zip"
Example 2
The following example imports the 12.1.0.4.0_oracle.sysman.db.008.zip archive file from the /u01/oracle/plugin_updates/ location, and overwrites any existing custom plug-in update that already exists for that plug-in.
emcli import_custom_plugin_update
-archive="/u01/oracle/plugin_updates/12.1.0.4.0_oracle.sysman.db.008.zip"
-overwrite
Imports all job definitions into Enterprise Manager, including Corrective Actions from a zip file. Library jobs are created. The EM CLI logged-in user is set as the library job owner.
emcli import_jobs -import_file=<zip_file_name>" [-name="job name1;job_name2;..."] [-type="job type1;job_type2;..."] [-targets="tname1:ttype1;tname2:ttype2;..."] [-owner="owner1;owner2;..."] [-preview] [-force] [-stoponerror] [ ] indicates that the parameter is optional
import_file
Zip file name that contains job definitions.
name
Job name to be used for filtering. Semicolon-separated job names can be provided. Filtering by using a wildcard character is not supported.
type
Job type to be used for filtering. Semicolon-separated job types can be provided. Filtering by using a wildcard character is not supported.
targets
Target name and target type to be used for filtering. Semicolon-separated target names and types can be provided. Filtering by using a wildcard character is not supported.
owner
Job owner to be used for filtering. Semicolon-separated owners can be provided. Filtering by using a wildcard character is not supported.
preview
Prints the job definitions in the zip file. Filter values provided are used to show only matching job definitions. Jobs are not created in Enterprise Manager.
force
Updates the job record if it already exists. Otherwise, the job record is created. When this option is not specified, the default behavior of the system is to always create jobs from the import file.
stoponerror
Stops the import operation is after the first failure of the job import and rolls back the transaction. All jobs created by using this EM CLI session are deleted.
This example displays all job definitions in the zip file.
emcli import_jobs -preview -import_file=job_data.zip
This example displays all job definitions owned by SYSMAN or ADMIN from the zip file.
emcli import_jobs -owner=SYSMAN;ADMIN -preview -import_file=job_data.zip
This example import jobs MYJOB1 and MYJOB2.
emcli import_jobs -name=MYJOB1;MYJOB2 -import_file=job data.zip
This example imports all jobs owned by user SYSMAN:
emcli export_jobs -owner=ADMIN% -export_file=jobsdata.zip
This example imports all job definitions into Enterprise Manager.
emcli import_jobs -import_file=job data.zip
This example imports all job definitions into Enterprise Manager. If the job already exists, the details are edited. Otherwise, a new job is created.
emcli import_jobs -import_file=job data.zip -force
This example imports all job definitions into Enterprise Manager, and on the first failure, rolls back the jobs created in this session. The remaining jobs from the import file are not processed. Otherwise, a new job is created.
emcli import_jobs -import_file=job data.zip -stoponerror
Imports a metric extension archive file.
emcli import_metric_extension
-file_name=<metric_extension_archive>
-rename_as=<metric_extension_to_import_as>
file_name
Name of the metric extension archive file to be imported.
rename_as
Imports the metric extension using the specified name, replacing the name given in the archive.
Imports one or more Information Publisher report definitions from an XML file(s) using the title in the XML file and the currently logged-in CLI user as the owner of the report. If the report/owner already exists, the operation fails for this report with an accompanying error message. (You can override this with the -force option.) The report will be changed to a just-in-time report with the target type from the exported report.
You will need to edit schedules and access privileges using the Enterprise Manager user interface. The system enforces title/owner uniqueness, so an error occurs if a report with the same title and owner already exists.
emcli import_report
-files="file1;file2;..."
[-force]
[ ] indicates that the parameter is optional
files
List of path/file name(s) of XML file(s) that contain valid report definition(s).
force
First delete the report (and all jobs and saved copies) if a report with the same title/owner exists.
Imports an SLA configuration XML file for a target. This verb provides the functionality of creating a new SLA, creating a new version, and creating a new copy.
Note:
The XML file can only contain one SLA to be imported; that is, when export_sla has successfully exported a file when slaName and version are specified.Note:
The target must have the metrics required by the SLA template's SLI. If the template's SLI calls for a metric not found in the target, the SLI cannot be created.
emcli import_sla
-targetName=<target name>
-targetType=<target type>
-input_file=slaTemplate:<input filename>
[-slaName=<SLA name>]
[ ] indicates that the parameter is optional
targetName
Name of the target.
targetType
Type of target.
input_file
Name of the input file. There can only be one SLA root node in the XML document.
For more information about the input_file parameter, see Section 5.2, "-input_file Syntax Guidelines".
slaName
Specifying this name overrides the name contained in the SLA template XML file. This effectively creates a new SLA version series starting with version 1.
Imports a subset definition from the specified XML file.
emcli import_subset_definition
-adm_name=<Application_Data_Model_Name>
-subset_name=<Subset_Definition_Name>
-target_name=<Target_Database_Name>
-target_type=<Target_Type>
-file=<Import_File>
[-db_pref_cred_name=<DBCredsNormal | DBCredsSYSDBA>]
[-db_cred_name=<Database_Credential_Name>]
[-description=<Description>]
[-job_name=<Job_Name>]
[-job_description=<Job_Description>]
[ ] indicates that the parameter is optional
adm_name
Application Data Model (ADM) name.
subset_name
Name of the imported subset definition.
target_name
Target database name.
target_type
Type of target. Possible values are 'oracle_database', 'rac_database' and
'oracle_pdb'.
file
Fully-qualified file name of the file in XML format.
db_cred_name
Name of existing credentials stored in the Enterprise Manager repository to connect selected target database.
You must provide a value for either db_cred_name or db_pref_cred_name.
db_pref_cred_name
Name of preferred credentials stored in the Enterprise Manager repository. You must provide a value for either db_cred_name or db_pref_cred_name.
Valid values for this parameter are:
DBCredsNormal: Default normal credential set for an oracle_database target.
DBCredsSYSDBA: SYSDBA credential set for an oracle_database target.
description
Description for the imported subset definition.
job_name
Job name for the import subset definition operation.
job_description
Job description.
This example imports a subset definition from an XML file at path /scratch/samples/HR_subset.xml.
emcli import_subset_definition
-adm_name=adm
-file=/scratch/samples/HR_subset.xml
-subset_name=HR_Subset
-db_cred=cred
-target_name=sample_database
-target_type=oracle_database
This example imports a subset definition from an XML file at path /scratch/samples/HR_subset.xml using preferred normal database credentials.
emcli import_template -files="e1.xml;e2.xml;e3.xml"
Imports the dump file into the specified target database.
emcli import_subset_dump
-target_name=<Target Database>
-target_type=<Target Database type>
[-db_cred_name=<Database Credential Name>]
[-db_pref_cred_name=<DBCredsNormal | DBCredsSYSDBA> ]
[-host_cred_name=<Host Credential Name>]
[-subset_directory=<Database Directory Object Name> ]
[-custom_directory_path=<Custom Directory Path>]
[-use_external_directory]
[-external_directory=<External Directory Object Name>]
[-export_file_name=<Exported Dump File Name>]
[-max_imp_threads=< Maximum Number of Import Threads>]
[-encrypted_dump_file]
[-encryption_password=<Encryption Password>]
[-import_type=<ALL | DATA_T_L| DATA_A_L> ]
[-tablespace_map=<Tablespace Map>]
[-schema_map=<Schema Map>]
[-log_file_name=<Log file name>]
[-job_name=<Job Name>]
[-job_description=<Job Description>]
[-oid_transform]
[ ] indicates that the parameter is optional
target_name
Name of the existing target database.
target_type
Type of target. Possible values target type are 'oracle_database', 'rac_database', and 'oracle_pdb'.
db_cred_name
Name of existing credentials stored in the Enterprise Manager repository to connect selected target database. You must provide a value for either
db_pref_cred_name_or db_cred_name.
db_pref_cred_name
Name of preferred credentials stored in the Enterprise Manager repository.
Valid values are:
DBCredsNormal — Default normal credential set for an oracle_database target.
DBCredsSYSDBA — SYSDBA credential set for an oracle_database target.
You must provide a value for either db_pref_cred_name_or db_cred_name.
host_cred_name
Name of existing host credentials stored in the Enterprise Manager repository to access the target host.
subset_directory
Database Directory where the dump file is stored. For example:
DATA_PUMP_DIR
You must provide a value for either subset_directory or custom_directory_path.
custom_directory_path
User-specified directory location on the target host where the dump file is present. For example: /scratch/user/subset_dir
You must provide a value for either subset_directory or custom_directory_path.
use_external_directory
Flag to enable using an external directory (clustered/shared file system or ASM) for faster import processing. If you do not set this parameter, you must provide a value for external_directory.
external_directory
External directory location (clustered/shared file system or ASM) object for faster host access. For example: DATA_PUMP_DIR
export_file_name
Name of the dump file to import. If not specified, the default value is EXPDAT%U.DMP.
max_imp_threads
Maximum number of import threads. If not specified, the default value is 1.
encrypted_dump_file
Set this option if an encryption password was specified during the export operation. If you use this option, you must also provide a value for encryption_password.
encryption_password
Password to decrypt encrypted data during an import operation. The specified password should be same as that specified during the export operation. If the encrypted_dump_file option is set and a value for this option is not specified, you are prompted for the encryption password.For a secure operation, it is recommended that passwords not be stored in the scripts, but instead specified when prompted for them.
import_type
Drives an import operation. Valid values are:
ALL: Import both metadata and data.
DATA_T_L: Data within the preexisting table will be removed. Data in the import source will replace it.
DATA_A_L: Data contained within the table to be imported will be appended to the end of the preexisting table.
The default value is ALL.
tablespace_map
This password is required to re-map data from one tablespace to another. For example:
-tablespace_map="source_tbsp1:target_tbsp1;source_tbsp2:target_tbsp2"
schema_map
This password is required to re-map data from one schema to another.
-schema_map="source_schema1:target_schema1;source_schema2:target_schema2"
log_file_name
If not specified, the default value is IMPORT.LOG.
oid_transform
By default, the exported OID is imported during table or type creation. Set this option to create a new OID. This is useful when some of the objects already exist in the database and a cloned copy is required. However, selecting this option will cause breakage in REF columns that point to the table.
job_name
Import subset dump operation job name.
job_description
Job description.
This example imports dump(E.dmp) located at the DATA_PUMP_DIR directory into the target sample_database.
emcli import_subset_dump -db_cred_name=db_cred -export_file_name=E.dmp -host_cred_name=host_cred -subset_directory=DATA_PUMP_DIR -target_type=oracle_database -target_name=sample_database -import_type=All
This example imports dump(E.dmp) located at the DATA_PUMP_DIR directory into the target sample_database using preferred database and host credentials.
emcli import_subset_dump -export_file_name=E.dmp -db_pref_cred_name=DBCredsNormal -subset_directory=DATA_PUMP_DIR -target_type=oracle_database -target_name=sample_database -import_type=All
This example imports dump(E.dmp) located at the DATA_PUMP_DIR file directory target sample_database with oid transformation enabled.
emcli import_subset_dump -db_cred_name=db_cred -export_file_name=E.dmp -host_cred_name=host_cred -subset_directory=DATA_PUMP_DIR -target_type=oracle_database -target_name=sample_database -import_type=All -oid_transform
This example imports the encrypted data dump(E.dmp) located at the DATA_PUMP_DIR directory into the target sample_database. You are prompted for
encryption_password.
emcli import_subset_dump -db_cred_name=db_cred -export_file_name=E.dmp -host_cred_name=host_cred -subset_directory=DATA_PUMP_DIR -target_type=oracle_database -target_name=sample_database -import_type=All -encrypted_dump_file
This example imports dump(E.dmp) located at the DATA_PUMP_DIR file directory target sample_database with schema mapping.
emcli import_subset_dump -db_cred_name=db_cred -export_file_name=E.dmp -host_cred_name=host_cred -subset_directory=DATA_PUMP_DIR -target_type=oracle_database -target_name=sample_database -import_type=All -schema_map="HR:HR_COPY;OE:OE_COPY"
This example imports dump(E.dmp) located at the custom directory location(\scratch\user\custom_dir) into the target sample_database with schema mapping.
emcli import_subset_dump -db_cred_name=db_cred -export_file_name=E.dmp -host_cred_name=host_cred -custom_directory_path=\scratch\user\custom_dir -target_type=oracle_database -target_name=sample_database -import_type=All -schema_map="HR:HR_COPY;OE:OE_COPY"
Imports a monitoring template from an XML or zip file. The resulting definition is saved in the repository.
files
Path/file name of an XML file, which contains a valid template definition. You can specify multiple files with this option by separating each file with a semi-colon
( ; ).
This example imports a template from template.xml.
emcli import_template -files="template.xml"
This example imports three templates — one from each of the files specified.
emcli import_template -files="e1.xml;e2.xml;e3.xml"
This example imports a template from the template.zip file along with any metric extensions.
emcli import_template -files="template.zip"
Imports a Self Update archive file into Enterprise Manager. Upon successful import, the update is displayed on the Self Update Home in downloaded status for further action.
emcli import_update
-file="file"
-omslocal
emcli import_update
-file="file"
-host="hostname"
[-credential_set_name="setname"] | -credential_name="name"
-credential_owner="owner"
[ ] indicates that the parameter is optional
file
Complete path name of the update archive file.
omslocal
Flag specifying that the file is accessible from the OMS.
host
Target name for a host target where the file is available.
credential_set_name
Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set
credential_name
Name of a named credential stored in the repository. You must specify this along with the credential_owner .
credential_owner
Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.
This example imports the file update1.zip. The file must be present on the OMS host. In a multiple OMS setup, any OMS can process the request, so the file should be accessible from the OMS processing the request. This usually means that the file must be kept on a shared location accessible from all OMSes.
emcli import_update
-file="/u01/common/update1.zip"
-omslocal
This example imports the file update1.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to retrieve the remote file.
emcli import_update
-file="/u01/common/update1.zip"
-host="host1.example.com"
-credential_set_name="HostCredsNormal"
This example imports the file update1.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to retrieve the remote file.
emcli import_update
-file="/u01/common/update1.zip"
-host="host1.example.com"
-credential_name="host1_creds"
-credential_owner="admin1"
Imports a Self Update master catalog file when Enterprise Manager is configured in offline mode. All updates present in the catalog are processed, and the applicable updates are displayed on the Self Update Home for further action.
emcli import_update_catalog
-file="file"
-omslocal
-file="file"
-host="hostname"
[-credential_set_name="setname"] | -credential_name="name"
-credential_owner="owner"
[ ] indicates that the parameter is optional
file
Complete path name of the self update catalog file.
omslocal
Flag specifying that the file is accessible from the OMS.
host
Target name for a host target where the file is available.
credential_set_name
Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set
credential_name
Name of a named credential stored in the repository. You must specify this along with the credential_owner option.
credential_owner
Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.
This example imports the master catalog file p9984818_121000_Generic.zip. The file must be present on the OMS host. In a multiple OMS setup, the request can be processed by any OMS, so the file should be accessible from the OMS processing the request. This usually means that the file must be kept on a shared location accessible from all OMSes.
emcli import_update_catalog
-file="/u01/common/p9984818_121000_Generic.zip"
-omslocal
This example imports the master catalog file p9984818_121000_Generic.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to retrieve the remote file.
emcli import_update_catalog
-file="/u01/common/p9984818_121000_Generic.zip"
-host="host1.example.com"
-credential_set_name="HostCredsNormal"
This example imports the master catalog file p9984818_121000_Generic.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to retrieve the remote file.
emcli import_update_catalog
-file="/u01/common/p9984818_121000_Generic.zip"
-host="host1.example.com"
-credential_name="host1_creds"
-credential_owner="admin1"
Lists resource data. The maximum number of rows displayed is controlled by OMS property oracle.sysman.core.dataservice.max_fetch_rows. When the property is not set, it uses the default value of 2000.
emcli list
[-help]
[-resource="list_resource_name"]
[-columns="column_options"]
[-colsize="column_sizes"]
[-search="search_options"]
[-bind="bind_parameters"]
[-sql="sql"]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[-noheader]
[ ] indicates that the parameter is optional
help
Lists all resource names with their descriptions. You can use this option with the -resource option to see more details about the resource.
resource
Resource name for which data is displayed.
columns
Specify columns as shown, separated by commas:
-columns="colname,colname,colname"
Example:
-columns="COL1,COL3,COL5"
Specify column size and width as shown below. A colon precedes the size for a given column.
-columns="colname:colsize,colname,colname"
Example:
-columns="COL1:30,COL3,COL5"
colsize
Resizes column widths. Most resource columns have some default widths. You can override them with this option.Example: -colsize="col1:30,col2:5"
search
You can specify multiple search options. The usage is -search="ColumnName Operator 'Value'. The search value must be enclosed in quotes unless searching for null or not null.
The following operators are supported:
= !+ > < >= <= like
The option also supports is null and is not null.
bind
Use for resources that require specific input. The usage is -bind="Name Operator Value".
sql
Specifies arbitrary SQL against views. This query is executed as MGMT_VIEW user.
script
Sets the default column separator to a tab and the default row separator to a newline. You can change the column and row separator strings to change these defaults.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
noheader
Displays tabular output without column headers.
When run in script mode, returns JSON output that can be easily parsed.
Exit Codes:
0 — Appears when successful.
1 — Appears when the list service fails to process the request.
These examples list all resource names.
emcli list -help
Example 2 - Scripting and Interactive
list (help)
These examples list column information about the 'Administrators' resources. They also list which columns users can search.
emcli list
-help
-resource=Administrators
Example 4 - Scripting and Interactive
list
(help
,resource=Administrators)
These examples list all data for the 'Administrators' resource.
emcli list -resource=Administrators
Example 6 - Scripting and Interactive
list (resource=Administrators)
These examples list only user_name and user_type columns.
emcli list
-resource=Administrators
-columns="USER_NAME,USER_TYPE"
Example 8 - Scripting and Interactive
list
(resource=Administrators
,columns="USER_NAME,USER_TYPE")
These examples show details about SYSMAN users.
emcli list
-resource=Administrators
-columns="USER_NAME,USER_TYPE"
-search="USER_NAME = 'SYSMAN'"
Example 10 - Scripting and Interactive
list
(resource=Administrators
,columns="USER_NAME,USER_TYPE"
,search="USER_NAME = 'SYSMAN'")
Lists active sessions on all OMSes in the environment. By default, the verb prints a summary for each OMS.
emcli list_active_sessions
[-details
[-table]
[-script]
[-format=name:value;name:value]
[-noheader]]
[ ] indicates that the parameter is optional
details
Displays active user sessions on each OMS. The output format is non-tabular.
table
Prints details in table format.
script
Prints output that can be processed by script.
format
Supports the following name/value pairs:csv — Output will be comma-separated script — Output will be in a format that can be processed by script. You can also specify row_separator and column_separator.
noheader
Skips the header.
emcli list_active_sessions
emcli list_active_sessions -details
emcli list_active_sessions -details -table
emcli list_active_sessions -details -table -script
emcli list_active_sessions -details -table -script -noheader
emcli list_active_sessions -details -table -format="name:csv"
emcli list_active_sessions -details -table -format="name:script;row_separator:@@;column_separator:!"
Lists the platforms on which the Add Host operation can be performed.
emcli list_add_host_platforms
[-all]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] denotes that the parameter is optional
all
Displays all of the platforms, including those for which the Agent software is not available.
noheader
Displays tabular output without column headers.
script
This option is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
This example displays the platforms for which the agent software is available so that the Add Host operation can be performed.
emcli list_add_host_platforms
This example displays all of the platforms, including those for which the Agent software is not available.
emcli list_add_host_platforms -all
Lists all of the Add Host sessions.
emcli list_add_host_sessions
[-host_name="Host name"]
[-session_name="Session name"]
[-match_all]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] denotes that the parameter is optional
host_name
Displays all of the Add Host sessions that the provided host is a part of.
session_name
Displays all of the sessions that match the session name provided.
match_all
Displays results that match all of the provided query criteria. By default, the results that match any of the provided query criteria are displayed.
noheader
Displays tabular output without column headers.
script
This option is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Session Name, Deployment Type, Host, Initialization, Remote Prerequisite, Agent Deployment
This example displays all of the Add Host sessions.
emcli list_add_host_sessions
This example displays all of the Add Host sessions that the host 'example.com' was part of.
emcli list_add_host_sessions -host_name=example.com
This example displays all of the Add Host sessions whose session name contains the string 'Jan_1'.
emcli list_add_host_sessions -session_name=Jan_1
This example displays all of the Add Host sessions that the host 'example.com' was part of, OR whose session name contains the string 'Dec_25'.
emcli list_add_host_sessions -host_name=example.com -session_name=Dec_25
This example displays all of the Add Host sessions that the host 'example.com' was part of, AND whose session name contains the string 'Jan_15'.
emcli list_add_host_sessions -host_name=example.com -session_name=Jan_15 -match_all
Lists the names, source target name, and application suites of existing Application Data Models.
Lists allowed association types for the specified source and destination target types.
emcli list_allowed_pairs
-source_type="source type"
-dest_type="dest type"]
[-noheader]
[-script]
[-format="[name:<pretty|script|csv>];[column_separator:
"column_sep_ string"];[row separator:"row_sep_string"]"]
list_allowed_pairs(
source_type="source type"
[,dest_type="dest type"]
[,noheader=True/False]
[,script=True/False]
[,format="[name:<pretty|script|csv>];[column_separator:
"column_sep_string"];[row_separator:"row_sep_string"]"]
)
[ ] indicates that the parameter is optional.
source_type
Source target type.
dest_type
Destination target type.
noheader
Displays the output in tabular output without column headers.
script
Prints the output in a format that can be used in scripting.
format
Specifies how the output is formatted. The default value is "name:pretty", which prints the output table in a readable format not intended to be parsed by scripts. Other format options include:
format="name:script"
Sets the default column separator to a tab and the default row separator to a newline in the output. You can override the column and row separator strings with your own values.
format="name:script;column_separator:<column_sep_string>"
Causes the verb output to be column-separated by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>"
Causes the verb output to be row-separated by <row_sep_string>.
format="name:script;column_separator:<column_sep_string>;row_separator:<row_sep_string>"
Causes the verb output to be column-separated by <column_sep_string> and row- separated by <row_sep_string>.
format="name:csv"
Sets the default column separator to a comma and the default row separator to a newline in the output.
0 indicates that the verb processing was successful.
Non-zero values indicate that the verb processing was not successful.
Lists ARU language information.
emcli list_aru_languages
[-name="language_name" | -id="language_id"]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
[ ] indicates that the parameter is optional
name
Language name.
id
Language ID.
noheader
Displays tabular information without column headers.
script
This option is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
emcli list_aru_languages
emcli list_aru_languages -noheader
emcli list_aru_languages -name="language name" -format="name:pretty"
emcli list_aru_languages -id="language id" -format="name:script"
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Lists ARU platform information.
emcli list_aru_platforms
[-name="platform_name" | -id="platform_id"]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
[ ] indicates that the parameter is optional
name
Platform name.
id
Platform ID.
noheader
Displays tabular information without column headers.
script
This option is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
emcli list_aru_platforms
emcli list_aru_platforms -noheader
emcli list_aru_platforms -name="platform_name" -format="name:pretty"
emcli list_aru_platforms -id="platform id" -noheader -format="name:script"
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Lists ARU product information.
emcli list_aru_products
[-name="product_name" | -id="product_id"]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional
name
Product name.
id
Product ID.
noheader
Displays tabular information without column headers.
script
This option is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
emcli list_aru_products
emcli list_aru_products -id="product id"
emcli list_aru_products -name="product name"
emcli list_aru_products -id="product id" -noheader
emcli list_aru_products -id="product id" -noheader -script
emcli list_aru_products -id="product id" -noheader -format="name:pretty"
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Lists ARU release information.
emcli list_aru_releases
[-name="release_name" | -id="release_id" | -productId="product_id"]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional
name
Release name.
id
Release ID.
productId
Product ID.
noheader
Displays tabular information without column headers.
script
This option is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
emcli list_aru_releases
emcli list_aru_releases -noheader
emcli list_aru_releases -name="release_name" -format="name:pretty"
emcli list_aru_releases -id="release id" -format="name:script"
emcli list_aru_releases -productId="product id" -noheader -format="name:csv"
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Lists associations between the specified source and destination targets.
emcli list_assoc
-source="target_name:target_type"
-dest="target_name:target_type"[-subseparator="subseparator:attribute_
name:character"]
[-noheader]
[-script
[-format="[name:<pretty|script|csv>];[column_separator:
"column_sep_string"];[row_separator:"row_sep_string"]"]
list_assoc(
source="target_name:target_type"
,dest="target_name:target_type"
[,subseparator="subseparator:attribute_name:character"]
[,noheader=True/False]
[,script=True/False]
[,format="[name:<pretty|script|csv>];[column_separator:
"column_sep_string"];[row_separator:"row_sep_string"]"]
)
[ ] indicates that the parameter is optional.
source
Source target.
dest
Destination target.
subseparator
By default, multi-value input attributes use a colon (:) as a subseparator. Specifying this option overrides the default subseparator value.
Example: subseparator="<attribute_name=sep_char>" where attribute_name is the name of the attribute for which you want to override the separator character, and sep_char is the new subseparator character.Example: separator="att=#"
noheader
Displays the output in tabular output without column headers.
script
Prints the output in a format that can be used in scripting.
format
Specifies how the output is formatted. The default value is "name:pretty", which prints the output table in a readable format not intended to be parsed by scripts. Other format options include:
format="name:script"
Sets the default column separator to a tab and the default row separator to a newline in the output. You can override the column and row separator strings with your own values.
format="name:script;column_separator:<column_sep_string>"
Causes the verb output to be column-separated by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>"
Causes the verb output to be row-separated by <row_sep_string>.
format="name:script;column_separator:<column_sep_string>;row_separator:<row_sep_string>"
Causes the verb output to be column-separated by <column_sep_string> and row- separated by <row_sep_string>.
format="name:csv"
Sets the default column separator to a comma and the default row separator to a newline in the output.
0 indicates that the verb processing was successful.
Non-zero values indicate that the verb processing was unsuccessful.
Lists all of the entity types supported by Chargeback.
list_chargeback_entity_types -[usage_mode] -[entity_type="eType"] [ ] indicates that the parameter is optional
usage_mode
Lists all of the entity types supported by Chargeback and the corresponding usage modes.
entity_type
Lists all of the usage modes supported for the particular entity type "eType".
This example lists all of the entity types supported by Chargeback.
list_chargeback_entity_types
Output:
Entity Type--------------------Entity Type Display Name -------------------------------------------------------------------- 1. oracle_database--------Database Instance 2. host-------------------------Host
This example lists all of the entity types supported by Chargeback and the corresponding usage modes.
list_chargeback_entity_types -usage_mode
Output:
Entity Type----------------Entity Type Display Name--------------------Usage Mode ---------------------------------------------------------------------- 1. oracle_database-------------------Database Instance-----------------------dbMetered 2. oracle_database-------------------Database Instance-----------------------dbByService 3. oracle_database-------------------Database Instance-----------------------cdbBypdb 4. host---------------------------------Host---------------------------hostMetered
This example lists all of the usage modes supported for the particular entity type.
list_chargeback_entity_types -entity_type="oracle_database"
Output:
Entity Type-------------------Entity Type Display Name-----------------Usage Mode ---------------------------------------------------------------------------------- 1. oracle_database----------Database Instance-------------------------dbMetered 2. oracle_database----------Database Instance-------------------------dbByService 3. oracle_database----------Database Instance-------------------------cdbBypdb
Lists the charge items that can be registered to Chargeback.
emcli list_charge_item_candidates
-target_type=target_type
-source_data_type=<metric|config|property>
[-target_name=target_name]
[-config_name=config_name]
[-config_data_source=target_name]
[-all]
[ ] indicates that the parameter is optional
target_name
Name of a target type.
source_data_type
Type of source data. Valid values are metric, config, and property.
target_name
If specified, metering and charge data are retrieved only for the named target. If you do not specify a valid target name, or if the specified target has not been enabled, then no data is generated. If this parameter is not specified, All targets for the specified target-type are included. Required if source_data_type=config.
config_name
Name of a configuration. Required if source_data_type=config.
config_data_source
Data source of the configuration. Required if source_data_type=config.
all
Applies only when source_date=metric. Displays all items, including out-of-box metrics of target type. Without this option, only user-defined metric extensions, are displayed.
This example lists the metric extensions created for the Oracle Database target type:
emcli list_charge_item_candidates
-target_type="oracle_database"
-source_data_type="metric"
This example lists the configuration items of the myCustomCCS configuration for an Oracle Database target named myDatabase:
emcli list_charge_item_candidates
-target_type="oracle_database"
-source_data_type="config"
-target_name="myDatabase"
-config_name="myCustomCCS"
-config_data_source="CCSDataSource"
Lists the charge plans in Chargeback.
list_charge_plans
[[-entity_type="entity_type" [-all]]
[-charge_plan="charge_plan_name" [-all]]
[-all]
[ ] indicates that the parameter is optional
entity_type
Entity type for which the charge plans are to be listed.
charge_plan
Lists details about a specific charge plan.
all
Lists all active and future plans.
This example lists all of the charge plans in Chargeback.
list_charge_plans
This example lists all of the active and future charge plans in Chargeback.
list_charge_plans -all
This example lists all of the active charge plans that support the "eType" entity type.
list_charge_plans -entity_type="eType"
This example lists all of the active and future charge plans that support the "eType" entity type.
list_charge_plans -entity_type="eType" -all
This example provides details about the active version of the charge plan.
list_charge_plans -charge_plan="chargePlanName"
This example provides details about the active and future versions of the charge plan.
list_charge_plans -charge_plan="chargePlanName" -all
Lists the cost centers in various formats depending on the options given.
list_cost_centers
-[[cost_center_name="cName"]
-[parent]
-[children]
-[top]
-[leaf]]
[ ] indicates that the parameter is optional
cost_center_name
Name of the cost center for which further details like parent/children/top/leaf should be listed.
parent
Provides the parent cost center of the given cost center.
children
Provides the list of child cost centers of the given cost center.
top
Provides the hierarchy of the given cost center from the top.
leaf
Provides the leaf nodes of the given cost center.
This example lists all of the cost centers.
list_cost_centers
This example provides the parent of the given cost centers.
list_cost_centers -cost_center_name="c11" -parent
Output:
Parent Node ----------------- c1
This example provides a list of all the child cost centers of the given cost center
list_cost_centers -cost_center_name="c1" -children
Output:
Children Nodes --------------------- c11 c12
This example provides the top hierarchy of the given cost center.
list_cost_centers -cost_center_name="c111" -top
Output:
Hierarchy ------------- [c1]----->[c11]----->[c111]
This example provides the leaf nodes of the given cost center.
list_cost_centers -cost_center_name="c1" -leaf
Output:
Leaf Nodes --------------- c111 c112 c12
Lists all of the custom plug-in updates imported to Enterprise Manager to date. Only one custom plug-in update can be imported for each plug-in version and revision combination.
Lists all of the database sizes that have been created.
emcli list_database_sizes
[-name="<Existing size name>"]
[ ] indicates that the parameter is optional.
name
A complete or a partial string. If the name parameter is specified, only database sizes that include the specified string are returned.
The following command finds all database sizes that have been created.
emcli list_database_sizes
Output:
Name:Extra-Small Description:Extra-small database size CPU(cores):4 Memory(GB):4 Storage(GB):Not Specified Processes(Units):Not Specified Name:Small Description:Small database CPU(cores):8 Memory(GB):8 Storage(GB):Not Specified Processes(Units):Not Specified Name:Medium Description:Medium CPU(cores):8 Memory(GB):16 Storage(GB):Not Specified Processes(Units):Not Specified
The following command finds all database sizes that include 'Extra' in the name string.
emcli list_database_sizes -name="Extra*"
Output:
Name:Extra-Small Description:Extra-small database size CPU(cores):4 Memory(GB):4 Storage(GB):Not Specified Processes(Units):Not Specified
The following command finds all database sizes that include 'Extra-Small' in the name string.
emcli list_database_sizes -name="Extra-Small*"
Output:
Name:Extra-SmallDescription:Extra-smallCPU(cores):4Memory(GB):4Storage(GB):Not SpecifiedProcesses(Units):Not Specified
Lists all the database profiles.
The following example lists all the existing database profiles in detail:
emcli list_dbprofiles -details
Output:
Name=RMAN Profile,Location=Database Provisioning Profiles/11.2.0.4.0/linux_x64/,Type=RMAN,Status=Ready,Description=Database Reference Profile 04-11-2014 12:40 PM from database.mycompany.com
Version : 11.2.0.4.0,contains=Structure and Data,removalOverdue=0,sourceDatabaseName=database.mycompany.com.
Name=DB Template,Location=Database Provisioning Profiles/11.2.0.4.0/linux_x64/,Type=DBCA_TEMPLATE,Status=Ready,Description=Database Reference Profile 03-11-2014 04:55 PM from database.mycompany.com
Version : 11.2.0.4.0,contains=Structure only,removalOverdue=0,sourceDatabaseName=database.mycompany.com.
Name=Snapshot Profile,Location=Database Provisioning Profiles/11.2.0.4.0/linux_x64/,Type=SNAPSHOT,Status=Ready,Description=Database Reference Profile 05-11-2014 03:09 PM from database.mycompany.com
Version : 11.2.0.4.0,contains=Structure and Data,removalOverdue=2,sourceDatabaseName=database.mycompany.com.
Gets the list of diagnostic check exclusions defined for a target type.
emcli list_diagchecks
-target_type="type"
[-version="<diag_version>" ]
[ ] indicates that the parameter is optional
Lists all available Fusion Middleware provisioning profiles in the software library.
emcli list_fmw_profiles
[-source_type="Profile Source"]
[ ] indicates that the parameter is optional.
source_type
Specify one source type to view only profiles of that type. Valid values are weblogic_domain, oracle_home, or install_media.
Lists all available internal metrics in an OMS.
emcli list_internal_metrics [-oms_name=<specific oms name> ] [ ] indicates that the parameter is optional.
oms_name
The name of the target OMS . The explicit OMS name can be found in the Cloud Control console Management Services page. To navigate to this page, from the Setup menu, select Manage Cloud Control and then Management Services. In the Servers area, look for the full name of the Management Service (<host name>:<port number>_Management_Service).
Note: You only need to specify the oms_name option if you are attempting to access a specific OMS in a multi-OMS environment. If you omit the oms_name option, the list_internal_metric verb will access the OMS running the current instance of EMCLI..
Example 1
The following example generates a list of internal metrics from an Enterprise Manager repository named "myserver.myco.com:17999_Management_Service".
emcli list_internal_metrics -oms_name=myserver.myco.com:17999_Management_Service
Example 2
The following example generates a list of internal metrics from the OMS currently running EMCLI.
emcli list_internal_metrics
Gets the list of masking definitions for an associated target and its script status.
emcli list_masking_definitions
[-definition_name=<masking_defn_name_filter>]
[-adm_name=<application_data_model_filter>]
[-target_type=<target_type_filter>]
[-target_name=<target_name_filter>]
[-string_match]
[-script | -format=[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[-noheader]
[ ] indicates that the parameter is optional
definition_name
Masking definition name filter. This can be either a full value or a pattern match (%).
adm_name
Application Data Model (ADM) name. This can be either a full value or a pattern match (%).
target_type
Database target type. This can be either 'oracle_database' or 'rac_database'.
target_name
Database target name. This can be either a full value or a pattern match (%).
string_match
Uses an exact string match for a target_name and definition_name match.
script
This option is equivalent to -format='name: script' .
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
noheader
Suppresses printing of column headers.
This example lists all masking definitions.
emcli list_masking_definitions
This example lists the masking definition named mask_hr_data.
emcli list_masking_definitions -definition_name=mask_hr_data
This example lists all masking definitions with names starting with credit_card.
emcli list_masking_definitions -definition_name=credit_card%
This example lists all masking definitions created on a database named testdb.
emcli list_masking_definitions -target_name=testdb
This example lists all masking definitions created on databases with names starting with test.
emcli list_masking_definitions -target_name=test%
This example lists the masking definition named mask_hr_data created on a database named testdb.
emcli list_masking_definitions -definition_name=mask_hr_data -target_name=testdb
This example lists all masking definitions with names starting with credit and created on databases with names starting with test.
emcli list_masking_definitions -definition_name=credit% -target_name=test%
This example lists all masking definitions without printing the column headers.
emcli list_masking_definitions -noheader
Lists the named credentials. You can list the credentials you own or have explicit access to.
emcli list_named_credentials
[-cred_name="cred_name"]
[-cred_owner="cred_owner"]
[-script | -format=[name:<pretty|script|csv>];
[column_separator:column_sep_string];
[row_separator:row_sep_string];
[-separator="separator:attname:charseq"]
[-noheader]
[ ] indicates that the parameter is optional
cred_name
Credential name to filter the list of credentials displayed.
cred_owner
Credential owner to filter the list of credentials displayed.
script
This is equivalent to -format='name: script'.
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.
separator
Multi-value attributes use the semi-colon character as the separator. When data contains this character, you can override its value. For example:
separator="<attributename=sep_char"
... where 'attributename' is the name of the attribute for which you want to override the separator character, and 'sepchar' is the new separator character. For example:
separator="att=#"
noheader
Suppresses printing of column headers in tabular output.
Lists the OMS configuration properties.
emcli list_oms_config_properties
[-oms_name="omsName"]
[-details]
[ ] indicates that the parameter is optional
oms_name
Name of the OMS from where the properties have to be retrieved.
details
Displays the details about from where the property value has been derived, and also the global and default values for the property.
Lists the logging configuration properties.
emcli list_oms_logging_properties
[-oms_name="omsName"]
[-details]
[ ] indicates that the parameter is optional
oms_name
Name of the OMS from where the logging properties have to be retrieved.
details
Displays the details about from where the property value has been derived, and also the global and default values for the logging property.
Lists existing patch plans. You can list all the existing patch plans and can also list the existing patch plans whose names match the specified pattern.
emcli list_patch_plans
[-name="name"]
[-noheader]
[-script | -format=
[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[ ] indicates that the parameter is optional
name
Plan name used for searching patch plans. If you do not specify this parameter, the patch plan whose name is the same as the specified name, or contains the specified name string, will be listed. If you do not specify this option, all of the existing patch plans are listed.
noheader
Suppresses printing of column headers.
script
This option is equivalent to -format='name: script' .
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
emcli list_patch_plans
emcli list_patch_plans -name="plan name" -noheader
emcli list_patch_plans -name="plan name" -noheader -script
emcli list_patch_plans -name="plan name" -noheader -format="name:pretty"
emcli list_patch_plans -name="plan name" -noheader
-format="name:pretty";column_separator="separator"
upload_patches
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Lists all of the patches included in the custom plug-in update for a particular plug-in.
emcli list_patches_in_custom_plugin_update
-plugin="<plugin_id>:<plugin_version>:<plugin_revision>"
[-discovery]
[ ] indicates that the parameter is optional.
plugin
ID, version, and revision of the plug-in. To view the version and revision of a plug-in, run the emcli list_custom_plugin_updates verb.
discovery
Lists even patches with the discovery component of the plug. If not passed, only patches with the monitoring component of the plug-in are listed.
Example 1
The following example lists all of the patches included in the custom plug-in update of the 12.1.0.2.0 version of the oracle.sysman.db2 plug-in. The patch list includes patches that contain only the monitoring component of the plug-in.
emcli list_patches_in_custom_plugin_update
-plugin="oracle.sysman.db2:12.1.0.2.0"
Example 2
The following example lists all the patches included in the custom plug-in update of the 12.1.0.2.0 version of the oracle.sysman.db2 plug-in. The patch list includes patches that contain not only the monitoring component but also the discovery component of the plug-in.
emcli list_patches_in_custom_plugin_update
-plugin="oracle.sysman.db2:12.1.0.2.0"
-discovery
Lists all of the plug-ins deployed on the management Agents.
emcli list_plugins_on_agent
[-agent_names="agent1,agent2,agent3 "
[-all]
[-include_discovery]
[ ] indicates that the parameter is optional
agent_names
All of the management Agents(host:port) whose deployed plug-ins need to be listed. If you do not provide any Agent names, plug-ins on all Agents are listed. String literals with a wildcard (*) expression are accepted. For example:
emcli list_plugins_on_agent -agent_names='adc*,st*93'
all
Lists plug-ins on all the management's Agents.
include_discovery
Includes discovery components of the plug-ins. By default, discovery components of the plug-ins are ignored.
This example lists plug-ins on the Agent abc.example.com.
emcli list_plugins_on_agent -agent_names=abc.example.com:3872
This example lists plug-ins for both of the Agents as well as their discovery components.
emcli list_plugins_on_agent -agent_names= abcd.example.com:3872,efgh.example.com:3872 -include_discovery
This example lists plug-ins for all Agents with the name that matches one of the regular expressions adc* or st*93.
emcli list_plugins_on_agent -agent_names='adc*,st*93'
This example lists plug-ins for all of the management Agents.
emcli list_plugins_on_agent -all
Lists all of the plug-ins that are deployed on the OMS instances.
Example 1
The following example lists all the plug-ins that are deployed on the OMS instances.
emcli list_plugins_on_server
Example 2
The following example lists all of the plug-ins, with their plug-in home locations, which are deployed on the OMS instances.
emcli list_plugins_on_server
-details
Displays a list of Enterprise Manager repository-related prerequisites.
emcli list_prerequisites
-db_user=<database_user>
-db_password=<database_password>
-db_role=<database_role>
-repos_user=<repository_user>
[-prerequisite_xml_root_dir=<xml_root_directory_for_platform_prerequisites>]
[-prerequisite_resource_locs="<xml_resource_location_for_platform/
plug-in_prerequisites>"]
[-log_loc=<location_for_log_files_of_EMPrereqKit_tool>]
[-upgrade_version=<EM_version_to_which_upgrade_is_being>]
[-configuration_type=<configuration/deployment_type>]
[ ] indicates that the parameter is optional.
db_user
Database user account with which a connection to the database can be established, for example SYS.
db_password
Database user account password. If you do not provide here, you will be prompted for the password.
db_role
Database role. For example, sysdba. Required only when the -db_user value is SYS.
repos_user
Repository user account with which the prerequisite checks can be run, for example, SYSMAN. Required only when the -db_user value is SYS.
prerequisite_xml_root_dir
Absolute path to the requisites/list directory where of the all prerequisite XMLs are located. This is an optional parameter and if not provided, the value is calculated internally. The XML files can be in a subdirectory within the requisites/list directory, but make sure the path that you enter leads only up to the list directory. For example, $<OMS_HOME>/install/requisites/list.
prerequisite_resource_locs
Absolute path to the directory where the plug-in opar files or the platform/plug-in binaries, which contains XML files for platform or plug-in prerequisite checks, are located. This is an optional parameter. For plug-in opar files, use the format plugin_id=<<absolute_path_.opar_file>>. For the plug-in home directory use the format plugin_id=<<plugin_home>>.
log_loc
Absolute path to a directory where the logs of the execution of the Enterprise Manager prerequisite kit can be stored.
upgrade_version
The Enterprise Manager version to which the upgrade is being done. For example, 12.1.0.3. If you have downloaded the Enterprise Manager prerequisite resources for two future versions, for example v1 and v2 through Self-Update then with -upgrade_version, you can see or run the prerequisite of the specified version.
configuration_type
Configuration or deployment type. For example, MINI, SMALL, MEDIUM, LARGE. This is an optional parameter, and if not provided, it will be calculated internally.
Example 1
Displays a list of Enterprise Manager repository-related prerequisites with the configuration type MEDIUM.
emcli list_prerequisites
-db_user=SYS
-db_password=pwd
-db_role=sysdba
-repos_user=SYSMAN
-prerequisite_xml_root_dir=$ORACLE_HOME/install/requisites/list
-configuration_type=MEDIUM
Example 2
Displays a list of Enterprise Manager repository-related prerequisites with upgrade version 12.1.0.4.
emcli list_prerequisites
-db_user=SYS
-db_password=pwd
-db_role=sysdba
-repos_user=SYSMAN
-prerequisite_xml_root_dir=$ORACLE_HOME/install/requisites/list
-upgrade_version=12.1.0.4.0
Example 3
Displays a list of Enterprise Manager repository-related prerequisites with the prerequisite resource location oracle.sysman.db=<<MW_HOME>>/plugins/oracle.sysman.db.oms.plugin_x.x.x.x.x,oracle.sysman.emas=<<Absolute directory path>>/x.x.x.x.x_oracle.sysman.emas_2000_0.opar'.
emcli list_prerequisites
-db_user=SYS
-db_password=pwd
-db_role=sysdba
-repos_user=SYSMAN
-prerequisite_resource_locs="oracle.sysman.db=
<<MW_HOME>>/plugins/oracle.sysman.db.oms.plugin_x.x.x.x.x,
oracle.sysman.emas=<<Absolute directory path>>/
x.x.x.x.x_oracle.sysman.emas_2000_0.opar"
Lists privilege delegation setting templates available on the server that apply to targets.
emcli list_privilege_delegation_settings [-setting_type="SUDO/POWERBROKER]" [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ] [ ] indicates that the parameter is optional
setting_type
Setting type. All applicable settings are displayed if you do not specify this option.
noheader
Displays tabular information without column headers.
script
This is equivalent to -format="name:script".
format
Format specification (default is -format="name:pretty").
format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.
format="name:csv" sets the column separator to a comma and the row separator to a newline.
format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.
row_separator:"row_sep_string" row-separates the verb output by
<row_sep_string>. Rows are separated by the tab character.
Lists the Siebel servers present in the specified Siebel enterprise.
enterprise
Indicates the fully-qualified name of the Siebel enterprise.
For example, to list servers under a Siebel enterprise <Seibel enterprise>, enter the option as: -enterprise=<Siebel enterprise>.
Note:
The commandemcli list_siebel_enterprises can be used to list the currently monitored Siebel enterprises in EM.Lists the SLA life-cycle status and version information for a target. If you specify the slaName, the command prints the summary information of the different versions. If you do not specify the slaName, the command prints all the available SLA version series for a target. When you specify the version, this commands prints only summary information for the specified version.
emcli list_sla
-targetName=<target_name>
-targetType=<target_type>
[-slaName=<SLA_name>]
[ ] indicates that the parameter is optional
This example prints the SLA information for one SLA.
emcli list_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla' -version=2
This example prints the SLA information for all SLAs of a target.
emcli list_sla -targetName='my_service' -targetType='generic_service'
Gets the list of subset definitions, Application Data Models, and target names.
emcli list_subset_definitions
[-subset_name=<subset_definition_name_filter>]
[-adm_name=<application_data_model_filter>]
[-target_name=<target_name_filter>]
[-string_match]
[-script | -format=[name:<pretty|script|csv>];
[column_separator:"column_sep_string"];
[row_separator:"row_sep_string"];
]
[-noheader]
[ ] indicates that the parameter is optional
subset_name
Filter for the subset definition name. This can either be a full value or a pattern match(%).
adm_name
Filter for the Application Data Model (ADM) name. This can be either a full value or a pattern match(%).
target_name
Filter for the database target name. This can be either a full value or a pattern match (%).
string_match
Uses an exact string match for the subset definition name, target name, and ADM name.
script
This option is equivalent to -format='name: script'.
format
Format specification (default is -format="name: pretty").
-format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
-format="name:script" sets the default column separator to a tab and the default row separator to a newline.
-format="name:csv" sets the column separator to a comma and the row separator to a newline.
noheader
Suppresses the printing of column headers.
This example prints the SLA information for one SLA.
emcli list_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla' -version=2
This example prints the SLA information for all SLAs of a target.
emcli list_sla -targetName='my_service' -targetType='generic_service'
Lists the entities in the software library based on the specified filter criteria. The results are printed in the following order:
Display Name, Revision, Description, Status, Type, Subtype, Maturity, Owner, [Folder Path, Folder Id, Entity Rev Id]
emcli list_swlib_entities
[-name="entity_name"]
[-folder_id="folder_internal_id"]
[-desc="entity_desc"]
[-attr="<attr_name>:<attr_value>"]
[-type]="type_internal_id"]
[-subtype]="subtype_internal_id"]
[-maturity]="maturity"]
[-owner]="owner"]
[-status]="status"]
[-show_folder_path]
[-show_folder_id]
[-show_entity_rev_id]
[ ] indicates that the parameter is optional
name
Name of the entity. The value specified for this option is considered for a case-insensitive match.
folder_id
Internal identifier of the parent folder. The value specified for this option is considered for an exact match.
desc
Description of the entity. The value specified for this option is considered for a case-insensitive match.
attr
An attribute and its value, separated by a colon ( : ). For specifying values for multiple attributes, repeat the option. The value specified for this option is considered for an exact match.
You can only use this parameter with the type parameter.
type
Internal identifier of the entity type. Use the list_swlib_entity_types verb to identify the type.
subtype
Internal identifier of the entity sub-type. Use the list_swlib_entity_subtypes verb to identify the sub-type.
maturity
Maturity of the entity revision. Can be one of: MAT_Untested MAT_Beta MAT_Production
owner
Owner of the entity revision.
status
Status of the entity revision. Can be one of: STATE_Incomplete STATE_Ready STATE_Deleted
show_folder_path
Enables printing of the internal path of each entity's folder.
show_folder_id
Enables printing of the internal ID of each entity's folder. If specified, the value is printed after the value for show_folder_path.
show_entity_rev_id
Enables printing of the internal ID of each entity. If specified, the value is printed after the value for show_folder_id.
Lists the entity subtypes available in the software library for a specified entity type.
emcli list_swlib_entity_subtypes
[-entity_type_id="type_internal_name"]
[-show_subtype_id]
[ ] indicates that the parameter is optional
entity_type_id
Internal identifier of the type.
show_subtype_id
Enables printing of the internal identifier for the subtype.
Lists folders in the software library.
emcli list_swlib_folders
[-parent_id="parent_folder_id"]
[-show_folder_path]
[-show_folder_id]
[ ] indicates that the parameter is optional
parent_id
Internal identifier of the parent folder.
show_folder_path
Enables printing of the internal path for the folder.
show_folder_id
Enables printing of the internal identifier for the folder.