Skip Headers
Oracle® Enterprise Manager Command Line Interface
11g Release 1 (11.1)

E16185-08
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

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

2 Verb Reference

This chapter provides a complete listing of all EM CLI verbs in categorical as well as alphabetical order. Complete syntax and usage information is also available for each verb through EM CLI's command line help system.

Verb Categories

For your convenience, this section provides another method other than alphabetization for finding verbs. All of the verbs for this release are listed in their respective categories.

Agent Administration Verbs


get_agent_properties
get_agent_property
secure_agent
set_agent_property

Agent Patch Verbs


submit_agent_patch

Agent Recovery Verbs


resyncAgent

Audit Settings Verbs


disable_audit
enable_audit
show_audit_settings
show_operations_list
update_audit_settings

Basic Operational Verbs

Note: These verbs are the only ones available immediately after installation.


argfile
help
login
logout
setup
sync
version

Blackout Verbs


create_blackout
delete_blackout
get_blackout_details
get_blackout_reasons
get_blackout_targets
get_blackouts
stop_blackout

Cloning Verbs


clone_as_home
clone_crs_home
clone_database_home
extend_as_home
extend_crs_home
extend_rac_home

Credential Verbs


clear_credential
set_credential
show_credential_set_info
show_credential_type_info
update_host_password
update_password
update_target_password

Credential Verbs - Oracle Database


update_db_password

Deployment Procedure Verbs


confirm_instance
delete_instance
get_instance_data_xml
get_instance_status
get_instances
get_procedure_types
get_procedure_xml
get_procedures
get_retry_arguments
ignore_instance
reschedule_instance
resume_instance
retry_instance
set_instance_jobgrants
start_paf_daemon
status_paf_daemon
stop_instance
stop_paf_daemon
submit_procedure
suspend_instance
update_and_retry_step

Execute Command Verbs


execute_hostcmd
execute_sql

Group Verbs


create_group
delete_group
get_group_members
get_groups
modify_group

Job Verbs


delete_job
get_job_execution_detail
get_jobs
retry_job
stop_job
submit_job

Licensing Verbs


grant_license_no_validation
grant_license_with_validation
revoke_license_no_validation
revoke_license_with_validation

Management Plug-in Verbs


add_group_to_mpa
add_mp_to_mpa

Management Services and Repository Verbs


loader_perf

Masking Verbs


export_masking_definition
generate_masking_script
import_masking_definition
list_masking_definitions
reassoc_masking_definition
save_masking_script
submit_masking_job

Metric Collection and Alerts Verbs


clear_stateless_alerts
collect_metric
get_metrics_for_stateless_alerts
get_on_demand_metrics
get_unsync_alerts
modify_collection_schedule

Monitoring Templates Verbs


apply_template
export_template
import_template

Notification Verbs

subscribeto_rule

Privilege Delegation Settings Verbs


apply_privilege_delegation_setting
clear_privilege_delegation_setting
create_privilege_delegation_setting
delete_privilege_delegation_settings
list_privilege_delegation_settings
list_target_privilege_delegation_settings

Provisioning Verbs


provision

Redundancy Group Verbs


create_red_group
create_redundancy_group
modify_red_group
modify_redundancy_group
view_redundancy_group

Report Import/Export Verbs


export_report
get_reports
import_report

SecureComm Verbs


get_ca_info

Services Verbs


add_beacon
apply_template_tests
assign_test_to_target
change_service_system_assoc
create_aggregate_service
create_service
delete_metric_promotion
delete_test
delete_test_threshold
disable_test
enable_test
extract_template_tests
get_aggregate_service_info
get_aggregate_service_members
get_test_thresholds
modify_aggregate_service
remove_beacon
remove_service_system_assoc
run_avail_diag
run_promoted_metric_diag
set_availability
set_key_beacons_tests
set_metric_promotion
set_properties
set_test_threshold
sync_beacon

System Verbs


create_system
delete_system
get_system_members
modify_system

Target Data Verbs


add_target
add_target_property
delete_target
get_target_properties
get_targets
modify_target
relocate_targets
remove_target_property
set_target_property_value set_standby_agent

User Administration Verbs


create_role
create_user
delete_role
delete_user
grant_privs
grant_roles
modify_role
modify_user
revoke_privs
revoke_roles

Virtualization Verbs

Note: Use of any of the following verbs requires that you install a one-off patch. Refer to the documentation in this chapter for any of the verbs in this list for more information.


delete_guest_vm
get_guest_vm_status
get_virtual_server_status
list_guest_vm
list_ovm_virtual_server_pool
list_virtual_server
list_virtual_server_pool
migrate_vsp_ovm_to_em
pause_guest_vm
reboot_guest_vm
reboot_virtual_server
resume_guest_vm
start_guest_vm
start_vt_daemon
status_vt_daemon
stop_guest_vm
stop_virtual_server
stop_vt_daemon
suspend_guest_vm
unpause_guest_vm

WebLogic Server Verbs


discover_wls

2.2 Alphabetical Verb List

The following list provides the names of all verbs and their associated pages where you can find the definition, format, options, and examples for each verb.


add_beacon

Adds a beacon to the monitoring set of beacons. All enabled tests are pushed to the beacon.

Format

emcli add_beacon
      -name=target name
      -type=target type
      -bcnName=beacon name
      [-dontSetKey]

Options

Examples

The following example adds MyBeacon to the MyTarget service target of type generic_service.

emcli add_beacon -name='MyTarget' -type='generic_service'
      -bcnName='MyBeacon'

add_group_to_mpa

Adds a Management Plug-in (MP) group to a Management Plug-in Archive (MPA). If the MPA file does not exist, it is created.

Format

emcli add_group_to_mpa     -mpa="mpa"     -name="group name"     -member="mpname:mpversion"...     [-desc="description"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example adds a group that contains a single Management Plug-in.

emcli add_group_to_mpa
       -mpa="MyMPA.jar"
       -name="MyGroup"
       -desc="MyGroup is described by this text."
       -member="an_mp:1.1"

Example 2

The following example adds a group that contains multiple Management Plug-ins. On deployment, an_mp is deployed before another_mp. The newest imported version of another_mp is used.

emcli add_group_to_mpa
      -mpa="MyMPA.jar"
      -name="AnotherGroup"
      -desc="AnotherGroup is described by this text."
      -member="an_mp:1.1"
      -member="another_mp:newest"

add_mp_to_mpa

Adds a Management Plug-in (MP) to a Management Plug-in Archive (MPA). If the MPA file does not exist, it is created.

Format

emcli add_mp_to_mpa
      -mpa="mpa"
      -mp_version="mp_version"
      -ttd="target_type_definition"
      -dc="default_collection"
      [-oms_version="oms_version"]
      [-agent_version="agent_version"]
      [-file="file_type":"file_path"]...
      [-func_desc="functional_desc"]
      [-req_desc="requirements_desc"]

[ ] denotes that the parameter is optional

Options

Example

The following example adds Management Plug-in files to a Management Plug-in Archive called my_new_type.jar.

emcli add_mp_to_mpa
      -mpa="/my_dir/my_new_type.jar"
      -mp_version="2.0"
      -ttd="/my_dir/ttd/new_type.xml"
      -dc="/my_dir/dc/new_type.xml"
      -file="MONITORING_SCRIPT:/my_dir/script1.pl"
      -file="MONITORING_SCRIPT:/my_dir/script2.pl"
      -file="MONITORING_BINARY:/my_dir/bin1"
      -func_desc="Management Plug-in to define target type new_type"

add_target

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.

Format

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;..."]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example adds 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). This example uses the base minimum of required credentials and properties for the database target.

emcli add_target
      -name="database"
      -type="oracle_database"
      -host="myhost.example.com"
      -credentials="UserName:dbsnmp;password:dbsnmp;Role:Normal"
      -properties="SID:semcli;Port:15091;OracleHome:/oracle;        MachineName:smpamp-example.com"
      -groups="Group1:database_group;Group2:group"

Example 2

The following example adds an oracle_database target with the name "database." This example illustrates 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.example.com"
      -credentials="UserName:dbsnmp;password:PWD_FILE;Role:Normal"
      -properties="SID:semcli;Port:15091;OracleHome:/oracle;        MachineName:example.com"
      -input_file="PWD_FILE:/emcli_dir/pwdfiles/at_pwd_file"

Example 3

The following example illustrates how to add a RAC database with given installed RAC database instances and clusterware. The example adds 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.

emcli add_target
      -name="cluster_database"
      -type="rac_database"
      -host="myhost.example.com"
      -monitor_mode="1"
      -properties="ServiceName:service.example.com;ClusterName:        newdb_cluster"
      -instances="database_inst1:oracle_database;database_inst2:        oracle_database"

Example 4

The following example adds 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

add_target_property

Adds a new target property for a given target type. All targets of this target type will have this new target property.

Format

emcli add_target_property
         -target_type="target_type"
         -property="prop_name"

Options

Examples

Example 1

The following example adds the owner name property for all targets of type oracle_database.

emcli add_target_property -target_type="oracle_database" -property="Owner Name"

Example 2

The following example adds the Owner property for all target types.

emcli add_target_property -target_type="*" -property="Owner"

apply_privilege_delegation_setting

Activates Sudo or PowerBroker settings for specified targets.

Format

emcli apply_privilege_delegation_setting
         -setting_name="setting"
         -target_type="host/composite"
         [-target_names="name1;name2;..."]
         [-input_file="FILE:file_path"]
         [-force="yes/no"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example applies 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

The following example applies 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 3

The following example applies 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

apply_template

Applies a template to a list of specified targets. The parameters to the verb can be supplied in any order.

Format

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"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following 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 option is not specified, the default option ("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"

Example 2

The following 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. In case of 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"

Example 3

The following 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"

apply_template_tests

Applies the variables and test definitions from the file(s) into a repository target.

Format

emcli apply_template_tests
      -targetName=<target name>
      -targetType=<target type>
      -input_file=template:<template filename>
      [-input_file=variables:<variable filename>]
      [-overwriteExisting=<all | none | <test1>:<type1>;<test2>:<type2>;...>]
      [-encryption_key=<key>]

[ ] denotes that the parameter is optional

Options

Examples

The following 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'

argfile

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 emcli verb invocations are permitted in this file. You should separate each verb invocation with a new line.

Format

emcli argfile /path/to/<input_file_name>

Options

None.

Examples

emcli argfile my_verb_arguments

assign_test_to_target

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.

Format

emcli assign_test_to_target
      -testtype=test-type to be assigned
      -type=target type
      [-tgtVersion]=version of target type

[ ] denotes that the parameter is optional

Options

Examples

The following example assigns test type HTTP to targets of type generic service v2.

emcli assign_test_to_target -testtype='HTTP' -type='generic_service'
      -tgtVersion='2.0'

change_service_system_assoc

Changes the system that hosts a given service.

Format

emcli change_service_system_assoc
      -name='name'
      -type='type'
      -systemname='system name'
      -systemtype='system type'
      -keycomponents='keycomp1name:keycomp1type[;keycomp2name:keycomp2type;...]'

[ ] denotes that the parameter is optional

Options

Example

The following 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'

clear_credential

Clears preferred or monitoring credentials for given users.

Format

emcli clear_credential
      -target_type="<ttype>"
      [-target_name="<tname>"]
      -credential_set="<cred_set>"
      [-user="<user>"]
      [-oracle_homes="<home1;home2"]

[ ] denotes that the parameter is optional

Options

Examples

emcli clear_credential
       -target_type=oracle_database
       -target_name=myDB
       -credential_set=DBCredsNormal
       -user=admin1
emcli clear_credential
       -target_type=oracle_database
       -credential_set=DBCredsNormal
       -user=admin1

clear_privilege_delegation_setting

Clears the privilege delegation setting from a given host or hosts.

Format

emcli clear_privilege_delegation_setting
        -host_names="name1;name2;..."
        [-input_file="FILE:file_path"]
        [-force="yes/no"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

emcli clear_privilege_delegation_setting
      -host_names="host1;host2;....."

Example 2

emcli clear_privilege_delegation_setting
      -host_names="host1;host2;....."
      -force=yes

Example 3

emcli clear_privilege_delegation_setting
      -input_file="FILE:/home/user/file.txt"
      -force=yes

clear_stateless_alerts

Clears the stateless alerts associated with the specified target. Only the 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.

Format

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]

[ ] denotes that the parameter is optional

Options

Examples

The following 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

clone_as_home

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 EMCLI

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 %%.

Format

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

Options

Examples

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" 

clone_crs_home

Creates an Oracle Clusterware cluster given a source Clusterware home location or a Clusterware S/W Library component for specified destination nodes.

Format

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

Options

Examples

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 EMCLI

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 %%.


clone_database_home

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.

Format

 emcli clone_database_home
       -input_file="dest_properties:file_path"
       -list_exclude_files="list of files to exclude"
       -isSwLib="true/false"
       -isRac="true/false"
       -tryftp_copy="true/false"
       -jobname="name of cloning job"
       [-home_name="name of home to use 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

Options

Examples

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 EMCLI

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 %%.


collect_metric

Performs an immediate collection and threshold evaluation of a set of metrics associated with the specified internal metric name. 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.

Format

 emcli collect_metric        -target_name=name        -target_type=type        -metric_name=metric_name | -collection_name=user_defined_metric_name

[ ] denotes that the parameter is optional

Options

Examples

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.oracle.com  -metric_name=Load

The following example immediately collects and evaluates thresholds for the user-defined metric called MyUDM:

emcli collect_metric -target_type=host -target_name=hostname.oracle.com  -collection=MyUDM

The following 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

confirm_instance

Confirms a manual step.

Format

emcli confirm_instance
-instance=[instance_guid]
-stateguid=[state_guids]

Options

Examples

emcli confirm_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid=51F762417C4943DEE040578C4E087168

emcli confirm_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid='51F762417C4943DEE040578C4E087168,51F762417C4944DEE040578C4E087168'

create_aggregate_service

Defines an aggregate service: name and its sub-services. After the aggregate service is created, you can edit it from the Enterprise Manager Grid Control console to configure performance and usage metrics to be collected and displayed.

Format

emcli create_aggregate_service
      -name="name"
      -type="type"
      -add_sub_services="name1:type1;name2:type2;..."
      -avail_eval_func="function to evaluate availability"
      [-timezone_region="timezone region"]
      [-is_propagating="true/false"]

[ ] denotes that the parameter is optional

Options

Examples

emcli create_aggregate_service -name="My_Name"
      -type="aggregate_service" 
      -add_sub_services="sub1:type1;sub2:type2"
      -avail_eval_func="my_pkg.my_eval_func"
      -timezone_region="PST"

create_blackout

Creates a scheduled blackout to suspend any data collection activity on one or more monitored targets.

Format

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:<...>]

[ ] denotes 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

Options

Examples

The following 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"

The following 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"

The following 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"

The following 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"

The following 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"

The following 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"

The following 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"

The following 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"

The following 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 2006-12-24 (2006-12-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"

The following 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"

create_group

Defines a group name and its members. After you create the group, you can edit it from the Enterprise Manager Grid Control console to configure Summary Metrics to be displayed for group members.

Format

emcli create_group
      -name="name"
      [-type=<group>]
      [-add_targets="name1:type1;name2:type2;..."]...
      [-is_propagating="true/false"]

[ ] denotes that the parameter is optional

Options

Examples

The following example creates 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"

The following example creates 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"

The following example creates a host-only group named my_hosts that consists of three systems within the oracle.com domain: smpsun, dlsun, and supersun.

emcli create_group -name=my_hosts
      -add_targets="smpsun.oracle.com:host"
      -add_targets="dlsun.oracle.com:host;supersun.oracle.com:host"

create_privilege_delegation_setting

Creates Sudo or PowerBroker settings to apply later. You must create at least one setting to use the apply_privilege_delegation_setting verb.

Format

 emcli create_privilege_delegation_setting
         -setting_name="setting_name"
         -setting_type="ttype"
         [-settings="setting"]
         [-separator=settings=";"]
         [-subseparator=settings=","]

[ ] denotes that the parameter is optional

Options

Examples

The following example creates 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-u %RUNAS%%COMMAND%

emcli create_privilege_delegation_setting
      -setting_name=sudo_setting
      -setting_type=SUDO
      -settings="SETTINGS:/usr/local/bin/sudo -S -u %RUNAS% %COMMAND%"

The following example creates a setting named pb_setting. The setting is of type POWERBROKER, and the PowerBroker path used is /etc/pbrun. Arguments are:

%RUNAS%%PROFILE%%COMMAND%;PASSWORD_PROMPT_STRING 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=","

For more examples, see the online help.


create_red_group

Defines a redundancy group name and its members. After you create the redundancy group, you can edit it from the Enterprise Manager Grid Control console to configure charts to be displayed for redundancy group members.

Format

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>]

[ ] denotes that the parameter is optional

Options

Examples

The following example creates a redundancy group named lsnr_group. This group consists of two Oracle listeners: emp_rec and payroll.

emcli create_red_group -name=lsnr_group
      -add_targets="emp_rec:oracle_listener"
      -add_targets="payroll:oracle_listener"

create_redundancy_group

Creates a redundancy group.

Format

 emcli create_redundancy_group        -redundancyGroupName="redGrpName"        -memberTargetType="tType"        -memberTargetNames="tName1;tName2"        [-group_status_criterion="NUMBER" or "PERCENTAGE"]        [-group_status_tracked="UP" or "DOWN"]        [-group_status_value=(see the Options section)]        [-timezone_region=<valid_time_zone_region>]
        [-is_propagating="true/false"]

[ ] denotes that the parameter is optional

Options

Examples

The following 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'

The following example creates a 'redGrp1' redundancy group with listener, listener2, listener3 as its member targets and time zone as PST8PDT. The status is calculated as the redundancy group being up if 2 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'

create_role

Creates a new Enterprise Manager admininistrator role.

Format

emcli create_role
      -name="role_name"
      [-description="description"]
      [-roles="role1;role2;..."]
      [-users="user1;user2;..."]
      [-privilege="name;[[target_name:target_type]|jobid]"]...

[ ] denotes that the parameter is optional

Options

Examples

The following example creates 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"

create_service

Creates a service to be monitored by Enterprise Manager.

Format

emcli create_service
      -name='name'
      -type='type'
      -availType=availability type (can be 'test' or 'system')
      -availOp=availability operator (can be 'and' or '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]']

[ ] denotes that the parameter is optional

Options

Examples

The following 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'

The following 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'

create_system

Defines a system: name and its members. After the system is created, you can edit the system from the Enterprise Manager Grid Control console to configure charts to be displayed for system members.

Format

emcli create_system
      -name="name"
      [-type=<system>]
      [-add_members="name1:type1;name2:type2;..."]...
      -timezone_region="actual timezone region"
      [-owner="owner"]
      [-meta_ver="meta version of system type"]
      [-is_propagating="true/false"]

[ ] denotes that the parameter is optional

Options

Examples

The following example creates a generic system named db_system. 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"
      -meta_ver="3.0"

The following 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.

emcli create_system -name=my_system
      -add_members="database2:oracle_database;dblistener:oracle_listener
      -add_members="mymachine.myco.com:host"
      -timezone_region="PST8PDT"

create_user

Creates a new Enterprise Manager administrator.

Format

emcli create_user
      -name="name"
      -type="type of user"
      -password="password"
      [-roles="role1;role2;..."]
      [-email="email1;email2;..."]
      [-privilege="name;[[target_name:target_type]|jobid]"]...
      [-profile="profile_name"]
      [-desc="user_description"]
      [-expired="true|false"]
      [-prevent_change_password="true|false"]
      [-input_file="arg_name:file_path"]

Options

Examples

Example 1

The following example creates 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@oracle.com;joe.shmoe@shmoeshop.com"
      -roles="public"
      -privilege="view_job;923470234ABCDFE23018494753091111"
      -privilege="view_target;host1.example.com:host"

Example 2

The following 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"

Example 3

The following example makes User1 an Enterprise Manager user, provides a description for the user, and prevents the password from being changed. Only another super administrator could 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 4

The following example makes User1 an Enterprise Manager user, provides a description for the user, and immediately expires 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"

delete_blackout

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.

Format

emcli delete_blackout
      -name="name"
      [-createdby="blackout_creator" (default is current user)]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example deletes blackout backup_monthly created by the current user.

emcli delete_blackout -name=backup_monthly

Example 2

The following 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

delete_guest_vm

Deletes a guest virtual machine. To delete the guest virtual machine, it should be in the Halted state.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Format

emcli delete_guest_vm 
      -guest_vm_name=Virtual Machine Name
      -server_pool_name=Server Pool Name

Options

Examples

The following example deletes the guest VM dom15, which is in the Oracle Server Pool.

emcli delete_guest_vm -guest_vm_name="dom15"           -server_pool_name="Oracle Server Pool"

delete_group

Deletes a group. Deleting a non-existent group generates the error "Group X does not exist."

Format

emcli delete_group
      -name="name"
      [-type=<group>]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example removes the group payroll_group that consists of database target types.

emcli delete_group -name=payroll_group

Example 2

The following example removes the group my_hosts that consists of host target types.

emcli delete_group -name=my_hosts

Example 3

The following example removes the group my_group that consists of mixed target types.

emcli delete_group -name=my_group

delete_instance

Deletes a specified job. A job cannot be deleted if any of its executions are in the EXECUTING (Running) state. Use the get_jobs verb to obtain a list of existing jobs along with their job IDs and statuses.

Format

emcli delete_job
      -job_id="jobID" | -name="jobName"

Options

Examples

Example 1

The following example deletes an existing job with the job ID 12345678901234567890123456789012.

emcli delete_job -job_id=12345678901234567890123456789012

Example 2

The following example deletes an existing job named my_job, which belongs to the current Enterprise Manager user.

emcli delete_job -name=my_job

delete_job

Deletes a specified job. A job cannot be deleted if any of its executions are in the EXECUTING (Running) state. Use the get_jobs verb to obtain a list of existing jobs along with their job IDs and statuses.

Format

emcli delete_job
      -job_id="jobID" | -name="jobName"

Options

Examples

Example 1

The following example deletes an existing job with the job ID 12345678901234567890123456789012.

emcli delete_job -job_id=12345678901234567890123456789012

Example 2

The following example deletes an existing job named my_job, which belongs to the current Enterprise Manager user.

emcli delete_job -name=my_job

delete_metric_promotion

Deletes a promoted metric.

Format

emcli delete_metric_promotion
      -name=Service target name
      -type=Service target type
      -promotedMetricKey = Key Value of the promoted metric
      [-category = Usage/Performance/Business]
      [-promotedMetricName = Promoted Metric]
      [-promotedMetricColumn = Promoted Metric Column]

[ ] denotes that the parameter is optional

Options

Examples

The following example deletes the promoted Performance metric with key value mymetric1 on service MyTarget.

emcli delete_metric_promotion -name='MyTarget' -type='generic_service'
      -category=Performance -promotedMetricKey=mymetric1

delete_privilege_delegation_settings

Deletes Sudo or PowerBroker settings.

Format

emcli delete_privilege_delegation_settings
      -setting_names="setting_name1;setting_name2;setting_name3;"

Options

Example

The following example deletes the privilege settings for the names setting_name1, setting_name2, and setting_name3.

emcli delete_privilege_delegation_settings
        -setting_names="sudo_setting1;sudo_setting2;pbSetting1

delete_role

Deletes an existing Enterprise Manager administrator role.

Format

emcli delete_role
      -name="role_name"

Options

Examples

The following example deletes the role name existing_role.

emcli delete_role -name="existing_role"

delete_system

Deletes a system.

Format

emcli delete_system
      -name="name"
      [-type=<generic_system>]

[ ] denotes that the parameter is optional

Options

Examples

The following example deletes the system my_system.

emcli delete_system -name=my_system

delete_target

Deletes a specified target from the Enterprise Manager Grid 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.

Format

emcli delete_target
      -name="name"
      -type="type"
      -delete_monitored_targets

Options

Examples

The following example deletes the oracle_database target with the name database.

emcli delete_target
      -name="database"
      -type="oracle_database"

delete_test

Deletes a Services test along with its constituent steps and stepgroups.

Format

emcli delete_test
      -name=<target_name>
      -type=<target_type>
      -testname=<test_name>
      -testtype=<test_type>

Options

Examples

The following example deletes the HTTP test named MyTest for the generic_service target named MyTarget.

emcli delete_test -name='MyTarget' -type='generic_service'
      -testname='MyTest' -testtype='HTTP'

delete_test_threshold

Deletes a test threshold.

Format

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=<stepgroupname>]

[ ] denotes that the parameter is optional

Options

Examples

emcli delete_test_threshold          -name="Service Name"         -type="generic_service"         -testname="Test Name"         -testtype="HTTP"         -metricName="http_response"         -metricColumn="timing"

delete_user

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 created by the user 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.

Format

emcli delete_user
      -name="user_name"

Options

Examples

The following example deletes the Enterprise Manager administrator named sysman3.

emcli delete_user -name=sysman3

disable_audit

Disables auditing for all user operations.

Format

emcli disable_audit

disable_test

Disables monitoring of a Services test.

Format

emcli disable_test
      -name=<target name>
      -type=<target type>
      -testname=<test name>
      -testtype=<test type>

Options

Examples

The following example disables the HTTP test named MyTest for the generic_service target named MyTarget.

emcli disable_test -name='MyTarget' -type='generic_service'
      -testname='MyTest' -testtype='HTTP'

discover_wls

This verb discovers one or more Oracle WebLogic Server Domains. It reads a file labeled domain_discovery_file to discover WebLogic Server versions 7.x, 8.x, 9.x, and 10.x.

domain_discovery_file is required; discovery cannot occur without it. You must create the file prior to performing discovery. To save the discovered components (WebLogic Server versions 9.x and 10.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 will monitor all discovered targets.

Format

emcli discover_wls
        -input_file=domain_discovery_file:"domain_discovery_file_           fully_qualified_path"
        [-input_file=host_agent_mapping_file:"host_agent_mapping_           fully_qualified_path"]
        [-out_file="output_file_path"]
        [-debug]

[ ] denotes that the parameter is optional

Options

File Structures

domain_discovery_file for WebLogic Server versions 7.x and 8.x

The following example shows the structure of a sample domain_discovery_file for WebLogic Server versions 7.x and 8.x. The same 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>,<port>,<Administration Server Username>,<password>,<Trusted Keystore Filename - OPT>,<Administration Server Home Directory - OPT>,<Agent Host>,<Agent Host username>,<Agent Host password>
<WebLogic Server version>,<Administration Server Host>,<port>,<Administration Server Username>,<password>,<Trusted Keystore Filename - OPT>,<Administration Server Home Directory - OPT>,<Agent Host>,<Agent Host username>,<Agent Host password>
<WebLogic Server version>,<Administration Server Host>,<port>,<Administration Server Username>,<password>,<Trusted Keystore Filename - OPT>,<Administration Server Home Directory - OPT>,<Agent Host>,<Agent Host username>,<Agent Host password>
<WebLogic Server version>,<Administration Server Host>,<port>,<Administration Server Username>,<password>,,,<Agent Host>,<Agent Host username>,<Agent Host password>

Definitions for the parameters are as follows for WebLogic Server versions 7 and 8:

domain_discovery_file for WebLogic Server versions 9.x and 10.x

The following example shows the structure of a sample domain_discovery_file for WebLogic Server versions 9.x and 10.x. OPT signifies an optional parameter. The last entry shows the format when optional parameters External Parameters, JMX Protocol, JMX Service URL, and Agent URL are not provided.

<WebLogic Server version>,<Administration Server Host>, <port>,<username>,<password>,<External Parameters - OPT>,<JMX Protocol - OPT>, <JMX Service URL - OPT>,<Unique Domain Identifier>,<Agent URL -OPT>
<WebLogic Server version>,<Administration Server Host>, <port>,<username>,<password>,<External Parameters - OPT>,<JMX Protocol - OPT>, <JMX Service URL - OPT>,<Unique Domain Identifier>,<Agent URL -OPT>
<WebLogic Server version>,<Administration Server Host>, <port>,<username>,<password>,<External Parameters - OPT>,<JMX Protocol - OPT>, <JMX    Service URL - OPT>,<Unique Domain Identifier>,<Agent URL -OPT>
<WebLogic Server version>,<Administration Server Host>, <port>,<username>,<password>,,,,<Unique Domain Identifier>,

Definitions for the parameters are as follows for WebLogic Server versions 9 and 10:

host_agent_mapping_file

The following example shows the structure of a sample host_agent_mapping_file, valid only for WebLogic Server versions 9.x and 10.x.

<Discovered Target Host>,<Agent URL to save/monitor the host>

Definitions for the parameters are as follows for WebLogic Server versions 9 and 10:

Examples

Example 1

emcli discover_wls
       -input_file=domain_discovery_file:/tmp/discovery/emcli/domain_discovery_         file.csv

Example 2

emcli discover_wls
       -input_file=domain_discovery_file:/tmp/discovery/emcli/domain_discovery_         file.csv -debug

Example 3

emcli discover_wls
       -input_file=domain_discovery_file:/tmp/discovery/emcli/domain_discovery_          file.csv
       -debug
       -out_file=/tmp/discovery/emcli/logs/emcliLog.txt

Example 4

emcli discover_wls
       -input_file=domain_discovery_file:/tmp/discovery/emcli/domain_discovery_         file.csv
       -input_file=host_agent_mapping_file:/tmp/discovery/emcli/host_agent_         mapping_file.csv
       -debug
       -out_file=/tmp/discovery/emcli/logs/emcliLog.txt

enable_audit

Enables auditing for all user operations.

Format

emcli enable_audit [-level=basic]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example enables auditing for all operations:

emcli enable_audit

Example 2

The following example enables auditing for LOGIN, LOGOUT, DB_LOGIN, and DB_LOGOUT:

emcli enable_audit [-level=basic]

enable_test

Enables monitoring of a Services test. It pushes the Service test collection to all the beacons.

Format

emcli enable_test
      -name=<target name>
      -type=<target type>
      -testname=<test name>
      -testtype=<test type>

Options

Examples

The following example enables the HTTP test named MyTest for the generic_service target named MyTarget.

emcli enable_test -name='MyTarget' -type='generic_service'
      -testname='MyTest' -testtype='HTTP'

execute_hostcmd

Executes a host command across a set of targets.

Format

emcli execute_hostcmd
      -cmd="host command"
      -osscript="os script to be executed with "cmd" "
      -targets="name1:type1;name2:type2;..."
      -credential_set_name="name"
      [-input_file="parameter_tag:script_file"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following 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"

Example 2

The following example loads the contents of the script /scratch/dba_scripts/shellscript.sh into the value of option -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"

execute_sql

Executes a SQL command across a set of targets.

Format

emcli execute_sql
      -sql="sql command"
      -targets="name1:type1;name2:type2;..."
      -credential_set_name="name"
      [-input_file="parameter_tag:script_file"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following 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"

Example 2

The following example loads the contents of the script /scratch/dba_scripts/enterprise_schema.sql into the value of option -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"

export_masking_definition

Exports a masking definition in XML format.

Format

emcli export_masking_definition
     -definition_name=<masking_definition_name>
     [-path=file path]
     [-file=file name]

Options

Output Columns

Success/Error messages.

Examples

Example 1

The following 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/

Example 2

The following 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

export_report

Exports a report definition and all of its element definitions given its title and owner.

Format

emcli export_report
  -title="<report-title>"
  -owner="<report-owner>"
  -output_file="<file>"

Options

Examples

 emcli export_report   -title="maintenance report"   -owner="SHIFT1_OPERATOR"   -output_file="$HOME/reports/maint_report.xml"

export_template

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.

Format

emcli export_template
      -name="name"
      -target_type="target_type"
      [-output_file=<File to which template will be exported>]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following 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

Example 2

The following 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

extend_as_home

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 EMCLI

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 %%.

Format

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

Options

Examples

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" 

extend_crs_home

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.

Format

 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

Options

Examples

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 EMCLI

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 %%.


extend_rac_home

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.

Format

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

Options

Examples

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 EMCLI

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 %%.


extract_template_tests

Extracts variables and test definitions from a repository template into a local file.

Format

emcli extract_template_tests
      -templateName=<template name>
      -templateType=<template type>
      -output_file=<output filename>
      [-encryption_key=<key>]

[ ] denotes that the parameter is optional

Options

Examples

The following 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.


generate_masking_script

Generates a masking script for the given masking definition.

Format

       emcli generate_masking_script 
      -definition_name=masking definition name 
      [-parameters="name1:value1;name2:value2;..."] 
      [-credential_set_name=credential_set_name]
      [-input_file="parameter_tag:file_path"]
      [-script | -format=[name:<pretty|script|csv>]; 
                 [column_separator:column_sep_string]; 
                 [row_separator:row_sep_string];
      ]

Options

Output

Success or error messages as well as the impact report (if generated).

Examples

Example 1

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"

Example 2

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"

Example 3

The following example reads the credentials from the preferred credential set DBCredsNormal and generates the masking script.

     emcli generate_masking_script     -definition_name=mask_hr_data

Example 4

The following example reads the credentials from the preferred credential set DBCredsSYSDBA and generates the masking script.

     emcli generate_masking_script     -definition_name=mask_hr_data     -credential_set_name=DBCredsSYSDBA   

get_agent_properties

Displays Agent properties. You can use this command if you have view privilege for the Agent.

Format

emcli get_agent_properties      -agent_name="<agent_target_name>"      [-all]      [-format="<format_name>"]

[ ] denotes that the parameter is optional

Options

Examples

The following example shows all of the Agent properties in CSV format:

 emcli get_agent_properties -agent_name="agent.example.com:11850"         -all         -format=csv
 

get_agent_property

Displays the value of a specific Agent property. You can use this command if you have view privilege for the Agent.

Format

emcli get_agent_property      -agent_name="<agent_target_name>"      -name="<agent_property_name>"

Options

Examples

The following example shows the current value of the UploadInterval property in emd.properties.

emcli get_agent_property -agent_name="agent.example.com:11850"
         -name=UploadInterval

get_aggregate_service_info

Gets time zone and availability evaluation function information of an aggregate's service instance.

Format

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"]
      ]

[ ] denotes that the parameter is optional

Options

Examples

 emcli get_aggregate_service_info -name="My_Name"
      -type="aggregate_service"

get_aggregate_service_members

Gets sub-services of an aggregate service instance.

Format

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"]
      ]

[ ] denotes that the parameter is optional

Options

Examples

emcli get_aggregate_service_members -name="My_Name"
      -type="aggregate_service"

get_blackout_details

Gets detailed information for a specified blackout.

Format

emcli get_blackout_details
      -name="name"
      [-createdby="blackout_creator" (default is current user)]
      [-noheader]
      [-script | -format=
           [name:<pretty|script|csv>];
           [column_separator:"column_sep_string"];
           [row_separator:"row_sep_string"];
      ]
[ ] denotes that the parameter is optional

Options

Output Columns

Status, Status ID, Run Jobs, Next Start, Duration, Reason, Frequency, Repeat, Days, Months, Start Time, End Time, TZ Region, TZ Offset

Examples

Example 1

The following example shows detailed information for blackout blackout1 that the current user created.

emcli get_blackout_details -name=blackout1

Example 2

The following example shows detailed information for blackout blackout1 that user joe created.

emcli get_blackout_details -name=blackout1 -createdby=joe

get_blackout_reasons

Lists all blackout reasons, one per line.

Format

emcli get_blackout_reasons

Examples

The following example lists all blackout reasons, one per line.

emcli get_blackout_reasons

get_blackout_targets

Lists targets for a specified blackout.

Format

emcli get_blackout_targets
      -name="name"
      [-createdby="blackout_creator" (default is current user)]
      [-noheader]
      [-script | -format=
           [name:<pretty|script|csv>];
           [column_separator:"column_sep_string"];
           [row_separator:"row_sep_string"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns

Target Name, Target Type, Status, Status ID

Examples

Example 1

The following example lists targets in the blackout blackout1 the current user created.

emcli get_blackout_targets -name=blackout1

Example 2

The following example lists targets in the blackout blackout1 that user joe created.

emcli get_blackout_targets -name=blackout1 -createdby=joe

get_blackouts

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.

Format

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"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns

Name, Created By, Status, Status ID, Next Start, Duration, Reason, Frequency, Repeat, Start Time, End Time, Previous End, TZ Region, TZ Offset

Examples

Example 1

The following example shows all blackouts with some details.

emcli get_blackouts

Example 2

The following example shows all blackouts that cover the target database2:oracle_database.

emcli get_blackouts -target=database2:oracle_database

Example 3

The following example shows all blackouts that cover some target on host myhost.example.com.

emcli get_blackouts -hostnames=myhost.example.com

Example 4

The following 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"

get_ca_info

Displays information about all of the Certificate Authorities (CA) created since the Grid Control installation. It also displays the Agent names whose certificates are issued by the CA(s) when you specify the -details option. The following information is retrieved from the Grid Control repository:

Format

emcli get_ca_info
        [-ca_id="id1;id2;..."] [-details]

[ ] denotes that the parameter is optional

Options

Examples

The following example shows output for 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 2010
     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           option: 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 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. The command "emctl secure oms" failed because a secured Agent was not registered to the new CA, hence the command "emctl secure oms force-newca" to secure the OMS anyway. There is still an Agent that needs to be secured to be registered to the new certificate. To retrieve the Agent name, you need to run the command "emcli get_ca_info -ca_id=2 -details," which is shown in the next example.

The following example displays the 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 2010
     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          option:

     ukagent1.mycompany.com:1830

get_guest_vm_status

Gets the status of the guest virtual machine.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Format

emcli get_guest_vm_status 
      -guest_vm_name=<Guest VM Name>
      -server_pool_name=<Server Pool Name>

Options

Output Column

Status

Examples

The following example gets the guest status for VM st-vs1.example.com.

emcli get_guest_vm_status -guest_vm_name="st-vs1.example.com"  -server_pool_name="Oracle Server Pool"

get_group_members

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.

Format

emcli get_group_members
      -name="name"
      [-type=<group>]
      [-depth=#  (default 1)]
      [-noheader]
      [-expand_non_groups]
      [-script | -format=
           [name:<pretty|script|csv>];
           [column_separator:"column_sep_string"];
           [row_separator:"row_sep_string"];
      ]
[ ] denotes that the parameter is optional

Options

Output Columns

Target Name, Target Type

Examples

Example 1

The following example lists the databases in group db2_group.

emcli get_group_members -name=db2_group

Example 2

The following example verifies that group my_hosts:group exists.

emcli get_group_members -name=my_hosts -depth=0

Example 3

The following example lists the unique targets in group my_group:group and its sub-groups.

emcli get_group_members -name=my_group -depth=-1

Example 4

The following 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

get_groups

Lists all groups.

Format

emcli get_groups
      [-noheader]
      [-script | -format=
           [name:<pretty|script|csv>];
           [column_separator:"column_sep_string"];
           [row_separator:"row_sep_string"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns

Target Name, Target Type

Examples

The following example lists all groups.

emcli get_groups

get_instance_data_xml

Downloads instance data XML and generates an XML file containing that data.

Format

emcli get_instance_data_xml -instance={instance_guid}

Options

Examples

emcli get_instance_data_xml -instance=16B15CB29C3F9E6CE040578C96093F61 > data.xml

get_instance_status

Displays the procedure instance status identified by the GUID on the command line.

Format

emcli get_instance_status -guid=<guid_number>
[-xml [-details] [-showJobOutput [-tailLength=<Last N Characters>]]]

Options

Output Columns

GUID, Procedure Type, Instance Name, Status

Examples

Example 1

The following example shows procedure details in CSV format:

emcli get_instance_status -guid=12345678901234567890123456789012

Example 2

The following example shows details in XML format:

emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -details

Example 3

The following example shows details in XML format with complete output:

emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -details -showJobOutput

Example 4

The following example shows details in XML format with the last 1024 characters of output:

 emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -showJobOutput -tailLength=1024

get_instances

Displays a list of procedure instances.

Tip:

See also get_procedure_types.

Format

emcli get_instances [-type=<procedure_type>]

[  ] denotes that the parameter is optional

Options

Output Columns

GUID, Procedure Type, Instance Name, Status

Examples

Example 1

The following example lists all procedure instances:

emcli get_instances

Example 2

The following example lists all procedure instances of type 'PatchOracleSoftware':

emcli get_instances -type=PatchOracleSoftware

get_job_execution_detail

Displays details of a job execution.

Format

 emcli get_job_execution_detail        -execution=<execution_id>        [-xml [-showOutput [-tailLength=<length>]]]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example shows the details in CSV format:

emcli get_job_execution_detail -execution=1234567890123456789012345678901

Example 2

The following example shows the details in XML format:

emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml

Example 3

The following example shows the details in XML format with complete output:

emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml -showOutput

Example 4

The following example shows the details in XML format with last N chars output:

emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml -showOutput -tailLength=1024

get_jobs

Lists existing jobs.

Format

emcli get_jobs
      [-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"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns

Name, Type, ID, Execution ID, Scheduled, Completed, Status, Status ID, Owner, Target Type, Target Name

Examples

Example 1

The following example shows the jobs with the specified job IDs 12345678901234567890123456789012 and 09876543210987654321098765432100:

emcli get_jobs
      -job_ids="12345678901234567890123456789012, 09876543210987654321098765432100"

Example 2

The following example shows 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 3

The following example shows 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

get_metrics_for_stateless_alerts

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.

Format

emcli get_metrics_for_stateless_alerts      -target_type=type

Options

Examples

The following example provides a list of all metrics for which stateless alerts can be manually cleared for any Oracle database (internal name for the target type is oracle_database).

emcli get_metrics_for_stateless_alerts -target_type=oracle_database

get_on _demand_metrics

Gets a list of metrics that can be immediately collected with the collect_metric EMCLI 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.

Format

emcli get_on_demand_metrics      -target_type=type
      -target_name=name

Options

Examples

The following example shows a list of collectible metrics for the host target called hostname.oracle.com.

emcli get_on_demand_metrics -target_type=host -target_name=hostname.oracle.com

get_procedure_types

Gets the list of all Deployment Procedure types.

Format

emcli get_procedure_types

Output Column

Procedure Type

Examples

The following example lists all procedure types:

emcli get_procedure_types

get_procedure_xml

Gets the Deployment Procedure XML file. XML is printed on standard output.

Format

emcli get_procedure_xml -procedure=[procedure_guid]

Options

Output

The Deployment Procedure XML.

Examples

emcli get_procedure_xml -procedure=16B15CB29C3F9E6CE040578C96093F61 > proc.xml

get_procedures

Gets a list of Deployment Procedures.

Tip:

See also get_procedure_types .

Format

emcli get_procedures [-type=<procedure_type>]

[ ] denotes that the parameter is optional

Options

Output Columns

GUID, Procedure Type, Name, Version, Created By

Examples

Example 1

The following example lists all procedures:

emcli get_procedures

Example 2

The following example lists all procedures of type 'AS Provisioning':

emcli get_procedures -type="AS Provisioning"

get_reports

Returns a list of 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.

Format

emcli get_reports   [-owner="<report-owner>"]

[ ] denotes that the parameter is optional

Options

Examples

emcli get_reports –owner=username
“report 1”,”username”
“example report 2”,”username”
emcli get_reports
“report A”,”username1”
“report 1”,”username2”
“example report 2”,”username2

get_retry_arguments

Get arguments of failed steps that can be retried.

Format

emcli get_retry_arguments 
-instance=<instance_guid> 
[-stateguid=<state_guid>]

[ ] denotes that the parameter is optional

Options

Examples

emcli get_retry_arguments -instance=16B15CB29C3F9E6CE040578C96093F61
emcli get_retry_arguments -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid=51F762417C4943DEE040578C4E087168

get_system_members

Lists the members of the specified system.

Format

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"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns

Source Target Name, Member Target Name, Member Target Type, Level

Examples

Example 1

The following example lists the databases in system db2_system.

emcli get_system_members -name=db2_system

Example 2

The following example verifies that system my_system:generic_system exists.

emcli get_system_members -name=my_system -depth=0

Example 3

The following example lists the unique targets in system my_system:generic_system and its sub-systems.

emcli get_system_members -name=my_system -depth=-1

get_target_properties

Lists all the property names for the target type provided.

Format

emcli get_target_properties
         -target_type="target_type"

Options

Examples

emcli get_target_properties -target_type="host"

Comment
Contact
Deployment Type
Line of Business
Location
Target properties fetched successfully

get_targets

Gets status and alert information for targets.

Format

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"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns

Status ID, Status, Target Type, Target Name, Critical, Warning

Examples

Example 1

The following example shows all targets. Critical and Warning columns are not included.

emcli get_targets

Example 2

The following example shows all targets. Critical and Warning columns are shown.

emcli get_targets
      -alerts

Example 3

The following example shows all oracle_database targets.

emcli get_targets
      -targets="oracle_database"

Example 4

The following example shows all targets whose type contains the string oracle.

emcli get_targets
      -targets="%oracle%"

Example 5

The following example shows all targets whose name starts with databa and type contains oracle.

emcli get_targets
      -targets="databa%:%oracle%"

Example 6

The following example shows status and alert information on the Oracle database named database3.

emcli get_targets
      -targets="database3:oracle_database"
      -alerts

get_test_thresholds

Shows test thresholds.

Format

 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"]
      ]

[ ] denotes that the parameter is optional

Options

Examples

emcli get_test_thresholds -name="Service Name"
               -type="generic_service"
               -testname="Test Name"
               -testtype="HTTP"

get_unsync_alerts

Gets a list of alerts that are out-of-sync between the Agent and the repository for the specified target. You would typically use this command when you think that the Agent has not uploaded the latest alert to the repository. Under these circumstances, the repository would be out-of-sync with the Agent state.

Format

 emcli get_unsync_alerts       -target_type="type"
       -target_name="name"

Options

Output Column

Status

Examples

The following example shows the out-of-sync alert states for the host target type and abc.oracle.com target name:

emcli get_unsync_alerts -target_type=host -target_name=abc.oracle.com

get_virtual_server_status

Gets the status of the virtual server.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Format

 emcli get_virtual_server_status           -server_name=<Virtual Server Name>

Options

Output Column

Status

Examples

The following example gets the status of the virtual server st-vs1.example.com.

emcli get_virtual_server_status -server_name="st-vs1.example.com"

grant_license_no_validation

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.

Format

emcli grant_license_no_validation      -type="target_type"      [-targets="tname1;tname2;..."]      [-packs="pack1;pack2;..."]      [-file="file_name"]
      [-displayAllMessages]
     
[ ] denotes that the parameter is optional

Options

Examples

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:

  1. Access SQL*Plus with your username and password, using sysman or other user that has access to sysman.mgmt_license_view.

  2. Select a distinct pack name from sysman.mgmt_license_view, where:

    target_type=<oracle_database>
    

The following 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.

Example 1

The following 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;"

Example 2

The following 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;"

Example 3

The following 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;"

Example 4

The following 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"

Example 5

The following 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;

grant_license_with_validation

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.

Format

emcli grant_license_with_validation      -type="target_type"      [-targets="tname1;tname2;..."]      [-packs="pack1;pack2;..."]      [-file="file_name"]      [-displayAllMessages]

[ ] denotes that the parameter is optional

Options

Examples

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:

  1. Access SQL*Plus with your username and password, using sysman or other user that has access to sysman.mgmt_license_view.

  2. Select a distinct pack name from sysman.mgmt_license_view, where:

    target_type=<oracle_database>
    

The following 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.

Example 1

The following 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;"

Example 2

The following 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;"

Example 3

The following 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;"

Example 4

The following 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"

Example 5

The following 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;

grant_privs

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.

Format

emcli grant_privs
     -name="username/rolename"
     [-privilege="name;[[target_name:target_type]|jobid]"]...

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example grants these privileges to user1:

emcli grant_privs
          -name="user1"
          -privilege="USE_ANY_BEACON"
          -privilege="FULL_JOB;923470234ABCDFE23018494753091111"
          -privilege="FULL_TARGET;host1.example.com:host"

Example 2

The following example grants target privileges to EM Role : Role1:

emcli grant_privs
          -name="Role1"
          -privilege="FULL_TARGET;host1.example.com:host"

grant_roles

Grants roles to an existing Enterprise Manager user or Enterprise Manager role.

Format

emcli grant_roles
     -name="username/rolename"
     [-roles="role1;role2;..."]

[ ] denotes that the parameter is optional

Options

Examples

emcli grant_roles
      -name="user1"
      -roles="SUPER_USER"

emcli grant_roles
      -name="Role1"
      -roles="BLACKOUT_ADMIN;MAINTAIN_TARGET"

help

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.

Format

emcli help [verbname]

[ ] denotes that the parameter is optional

Options

None.

Examples

Example 1

The following example provides an overview for all available verbs:

emcli help

Example 2

The following example provides the description, syntax, and usage examples for the add_target verb:

emcli help add_target

ignore_instance

Ignores a failed step.

Format

emcli ignore_instance
-instance=<instance_guid> 
[-stateguid=<state_guid>]

[ ] denotes that the parameter is optional

Options

Examples

emcli ignore_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid=51F762417C4943DEE040578C4E087168
emcli ignore_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid='51F762417C4943DEE040578C4E087168,51F762417C4944DEE040578C4E087168'

import_masking_definition

Imports a masking definition from the specified XML file.

Format

emcli import_masking_definition
     -file=/tmp/file_name.xml

Options

Output

Success or error messages

Examples

The following example imports the masking definition from the hr_mask.xml file.

emcli import_masking_definition
       -file=/tmp/hr_mask.xml

import_report

Imports one or more 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 optional -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 UI. The system enforces title/owner uniqueness, so an error occurs if a report with the same title and owner already exists.

Format

emcli import_report
   [-force]
   -files="file1;file2;..."

Options

Examples

emcli import_report \     -files="$HOME/reports/maint_report1.xml;$HOME/reports/file2.xml"

import_template

Imports a monitoring template from an XML file. The resulting definition is saved in the repository.

Format

emcli import_template
      -files="file1;file2;..."

Options

Examples

Example 1

The following example imports a template from template.xml.

emcli import_template -files="template.xml"

Example 2

The following example imports three templates — one from each of the files specified.

emcli import_template -files="e1.xml;e2.xml;e3.xml"

list_guest_vm

Lists all guest virtual machines.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Format

emcli list_guest_vm           [-server_pool_name=<Server Pool Name>]          [-server_name=<Virtual Server Name>]          [-operating_system=<Operating system name>]

[ ] denotes that the parameter is optional

Options

Output Columns

Name, Status, Operating system, VNC url, Server name, Server pool name

Examples

    emcli list_guest_vm  -server_pool_name="Oracle Server Pool"    emcli list_guest_vm  -server_name="st-vs1.oracle.com"    emcli list_guest_vm  -operating_system="Linux"    emcli list_guest_vm  -server_pool_name="Oracle Server Pool"      -server_name="st-vs1.oracle.com" -operating_system="Linux"

list_masking_definitions

Gets the list of masking definitions for an associated target and its script status.

Format

emcli list_masking_definitions
     [-definition_name=masking_defn_name_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]


[ ] denotes that the parameter is optional

Options

Output Columns

Masking Definition, Database, Status

Examples

Example 1

The following example lists all masking definitions:

emcli list_masking_definitions

Example 2

The following example lists the masking definition named mask_hr_data :

emcli list_masking_definitions -definition_name=mask_hr_data

Example 3

The following example lists all masking definitions with names starting with credit_card :

emcli list_masking_definitions  -definition_name=credit_card%

Example 4

The following example lists all masking definitions created on a database named testdb :

emcli list_masking_definitions -target_name=testdb

Example 5

The following example lists all masking definitions created on databases with names starting with test :

emcli list_masking_definitions -target_name=test%

Example 6

The following 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

Example 7

The following 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%

Example 8

The following example lists all masking definitions without printing the column headers:

emcli list_masking_definitions -noheader

list_ovm_virtual_server_pool

Lists virtual server pools that the OVM Manager is managing. Note that the OVM Manager's repository should be accessible to OMS.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Note:

When you execute this EMCLI verb, you are prompted to enter the following value in non-echo mode (if not already provided):

ovm_rep_password

Format

emcli list_ovm_virtual_server_pool
          -ovm_rep_desc="OVM Manager repository connect string"
          -ovm_rep_username="OVM Manager repository username"
          -ovm_rep_password="OVM Manager repository password"
          [-ovm_sp_name="OVM Virtual Server Pool name"]

Options

Output

Virtual Server Pool details, including the Virtual Server Pool name and its associated Virtual Server(s), name(s), and IP(s).

Sample output:

Virtual Server Pool Name: vsp0
Master Virtual Server Name: vsp0_master
Master Virtual Server IP: 1.1.1.1
Virtual Server Name: vsp0_vs1
Virtual Server IP: 1.1.1.2

Example

The following example lists the Virtual Server Pool details of my_ovs_sp1., which is available in the remote OVM Manager's repository specified by the connect string.

emcli list_ovm_virtual_server_pool
  -ovm_rep_desc="(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)
    (HOST=myovm.example.com)(PORT=1521)))(CONNECT_DATA=(SID=xe)))"
  -ovm_rep_username= "my_rep_username"
  -ovm_rep_password= "my_rep_password"
  -ovm_sp_name= "my_ovs_sp1"

list_privilege_delegation_settings

Lists privilege delegation setting templates available on the server that apply to targets.

Format

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"];       ]

[ ] denotes that the parameter is optional

Options

Examples

    emcli list_privilege_delegation_settings      -setting_type="SUDO"   

list_target_privilege_delegation_settings

Lists current privilege delegation settings for targets.

Format

emcli list_target_privilege_delegation_settings      -target_names="name1;name2;name3"      [-input_file="FILE:file_path"]      [-noheader]      [-script | -format=               [name:<pretty|script|csv>];               [column_separator:"column_sep_string"];               [row_separator:"row_sep_string"];      ]

[ ] denotes that the parameter is optional

Options

Examples

   emcli list_target_privilege_delegation_settings          -target_names="host.oracle.com;host2.oracle.com;      emcli list_target_privilege_delegation_settings          -input_file="FILE:/home/nqureshi/targets.txt"

emcli list_target_privilege_delegation_settings
          -target_names="host.oracle.com;host2.oracle.com;

list_virtual_server

Lists all virtual servers.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Format

emcli list_virtual_server      [-server_pool_name=<Server Pool Name>]

[ ] denotes that the parameter is optional

Options

Output Columns

Name, Server type, Status, Server pool name, Is master, Monitoring server name

Examples

emcli list_virtual_server  -server_pool_name="Oracle Server Pool"   

list_virtual_server_pool

Lists all virtual server pools.

Note:

Before you can use this verb or any other virtualization verb, you need to install a one-off patch. Refer to My Oracle Support note 781879.1 for information:

https://support.oracle.com

Format

emcli list_virtual_server_pool

Output Columns

Name, Type, Is HA enabled, Master virtual server

Examples

emcli list_virtual_server_pool

loader_perf

Executes a performance test to determine the network bottleneck between OMS and the Enterprise Manager repository. Only a SYSMAN user can execute this verb.

Format

emcli loader_perf
[-batchSize="batch size 1" -batchSize="batch size 3" -batchSize="batch size 3"    ...][-commitSize="commit size 1" -commitSize="commit size 2" -commitSize="commit size    3" ...][-dataSize="data size"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example displays the time taken to load 10000 records for the default values of batchSize and commitSize.

emcli loader_perf

Example 2

The following example displays the time taken to load 100000 records for batchSize as {15,40} and commitSize as {10,100}..

emcli loader_perf -b=15 -b=40 -c=10 -c=100 -d=100000

login

Establishes a new session between the OMS and the EM CLI client. This verb and the Logout verb are useful when you need to run a particular verb as a different user.

The login verb requires Enterprise Manager credentials (or Single Sign-On credentials or both) to log in and establish a session. You do not need to provide the same credentials you provided during setup. The credentials you provide during emcli login overwrite the setup credentials.

Always provide the exact credentials. Providing extra credentials may cause erroneous behavior that you can usually resolve by running emcli setup.

If Enterprise Manager is not SSO-enabled, you should only provide Enterprise Manager credentials using the -username and -password options. For an SSO-enabled Enterprise Manager, if the SSO user is also the Enterprise Manager user, you should only provide SSO credentials with the -ssousername and -ssopassword options. Otherwise, you must provide both Enterprise Manager credentials and SSO credentials.

Note:

To avoid an uncommon occurrence in which multiple emcli sessions are created on the OMS, Oracle recommends that you enter the login command before running a script containing EMCLI commands.

Tip:

See also logout.

Format

emcli login      -username=<EM Console Username>      [-password=<EM Console Password>]      [-ssousername=<EM SSO Username>]      [-ssopassword=<EM SSO Password>]      [-force]

Options

Examples

The following example shows a login as a different user for a non SSO-enabled Enterprise Manager using newly specified credentials, then a subsequent login using the previous credentials.

emcli logut
emcli login -user=new_user -pass=new_user_pass
emcli <verb-name>
emcli logout
emcli login -user=old_user -pass=old_user_pass

logout

Terminates the existing session with the OMS. This verb and the Login verb are useful when you need to run a particular verb as a different user. After a logout, you need to invoke either the Setup verb or Login verb before invoking any other emcli verb.

Tip:

See also login.

Format

emcli logout

Options

None.

Examples

The following example shows a login as a different user for a non SSO-enabled Enterprise Manager using newly specified credentials, then a subsequent login using the previous credentials.

emcli logut
emcli login -user=new_user -pass=new_user_pass
emcli <verb-name>
emcli logout
emcli login -user=old_user -pass=old_user_pass

migrate_vsp_ovm_to_em

Provides an automated migration solution that seamlessly migrates the Virtual Server Pool (including Virtual Servers, VMs, and other resources belonging to the server pool) managed by the OVM Manager into Enterprise Manager. This verb does not disrupt the virtualized environment, meaning that no downtime will occur for all GVMs.

Prerequistes

Before starting the migration, ensure that the following prerequisites are met:

Format

        emcli migrate_vsp_ovm_to_em          -ovm_rep_desc="OVM Manager repository connect string"          -ovm_rep_username="OVM Manager repository username"          -ovm_rep_password="OVM Manager repository password"          -ovm_sp_name="OVM Virtual Server Pool name"          [-ms_details="Monitoring Server details list"]          [-vs_details="Virtual Server details list"]          [-input_file="FILE:filename"]          [-new_em_sp_name="New Virtual Server Pool name"]          [-on_error="rollback|stop"]          [-repair="Job ID"]          [-clean]          [-rollback="Job ID"]

Note:

When you execute this EMCLI verb, you are prompted to enter the following values in non-echo mode if they are required but not specified:
  • OVM repository password

  • Virtual Server host password

  • Monitoring Server password

Options

Output

Job name, Job ID, and Job Execution ID.

Note that future executions of the same migration task (such as repair and rollback) require the same Job ID.

Sample output:

Job details:
Job name = OVMEMMigrationJob_2010-03-11_15-09-44
Job ID = 818E82AE0318AD90E040449820C47F2D
Job execution ID = 818E82AE031AAD90E040449820C47F2D

Examples

Example 1

The following example shows migration with rollback as an on_error option.

This operation migrates the Virtual Server Pool my_ovs from OVM Manager to Enterprise Manager and changes the name to my_new_ovs_sp1. my_ovs contains two Virtual Servers: vs1.example.com and vs2.example.com. After migration, Monitoring Servers ms1.example.com:3872 and ms2.example.com:1830 respectively will monitor the virtual servers. If the job fails, no partial data will be left in the Enterprise Manager repository, since the on_error option is rollback.

This verb functions only on versions 2.1.2, 2.1.5, and 2.2 of the OVM Manager.

emcli migrate_vsp_ovm_to_em 
  -ovm_rep_desc= "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=myovm.example.com)(PORT=1521)))(CONNECT_DATA=(SID=xe)))" 
  -ovm_rep_username= "my_rep_username" 
  -ovm_rep_password= "my_rep_password" 
  -ovm_sp_name= "my_ovs_sp1" 
  -new_em_sp_name= "my_new_ovs_sp1" 
  -ms_details=    "ms1.example.com:3872:my_ms_username1:my_ms_password1;     ms2.example.com:1830:my_ms_username2:my_ms_password2"
  -vs_details=    "vs1.example.com:vs1_root:vs1_root_password:ms1.example.com:3872:/tmp;     vs2.example.com:vs2_root:vs2_root_password:ms2.example.com:1830:/tmp"
  -on_error= "rollback"

Example 2

The following example shows migration with stop as an on_error option. The operation is the same as for Example 1, except that new data loaded in the Enterprise Manager repository is not cleaned up when the job fails. The most common reasons for the job failure are typos while providing details and incorrect passwords.

emcli migrate_vsp_ovm_to_em 
  -ovm_rep_desc= "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=myovm.example.com)(PORT=1521)))(CONNECT_DATA=(SID=xe)))" 
  -ovm_rep_username= "my_rep_username" 
  -ovm_rep_password= "my_rep_password" 
  -ovm_sp_name= "my_ovs_sp1" 
  -new_em_sp_name= "my_new_ovs_sp1" 
  -ms_details=    "ms1.example.com:3872:my_ms_username1:my_ms_password1;     ms2.example.com:1830:my_ms_username2:my_ms_password2"
  -vs_details=    "vs1.example.com:vs1_root:vs1_root_password:ms1.example.com:3872:/tmp;     vs2.example.com:vs2_root:vs2_root_password:ms2.example.com:1830:/tmp"
  -on_error= "stop"

Example 3

The following example repairs a failed migration job. Suppose that the job submitted (assume the Job ID is 7BFE0457A7E39410E040449820C4093E) in example 2 failed because of an incorrect Monitoring Server Password (my_fixed_ms_password1 is the correct one). You can supply the correct password (ms_details option) as shown below and also provide the repair option with the Job ID of the previous submission so that the job can re-run from the step where it failed.

emcli migrate_vsp_ovm_to_em 
  -ms_details= "ms1.example.com:3872:my_ms_username1:  my_fixed_ms_password1;ms2.example.com:1830:
 my_ms_username2:my_ms_password2"
  -repair="7BFE0457A7E39410E040449820C4093E" 

Example 4

The following example of migration with the -input_file option functions like Example 1, except that it reads Monitoring Sever and Virtual Server details from /path/to/migration.txt.

emcli migrate_vsp_ovm_to_em 
  -ovm_rep_desc="(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)
     (HOST=myovm.example.com)(PORT=1521)))(CONNECT_DATA=(SID=xe)))" 
  -ovm_rep_username="my_rep_username" 
  -ovm_rep_password="my_rep_password" 
  -INPUF_FILE= "FILE:/path/to/migration.txt" 
  -on_error="stop"

File content of /path/to/migration.txt:

monitoring_server_details=" ms1.example.com:3872: my_ms_username1:my_ms_password1"
monitoring_server_details="ms2.example.com:1830: my_ms_username2:my_ms_password2"
virtual_server_details="vs1.example.com:vs1_root: vs1_root_password:ms1.example.com:3872:/tmp"
virtual_server_details="vs2.example.com:vs2_root: vs2_root_password:ms2.example.com:1830:/tmp"

Example 5

The following example rolls back the partial data (including targets created) migrated in Enterprise Manager by the migration job with Job ID (of example2) 7BFE0457A7E39410E040449820C4093E .

emcli migrate_vsp_ovm_to_em 
          -rollback=7BFE0457A7E39410E040449820C4093E

modify_aggregate_service

Modifies an aggregate service instance.

Format

emcli modify_aggregate_service
      -name="name"
      -type="type"
      [-add_sub_services="name1:type1;name2:type2;..."]
      [-del_sub_services="name1:type1;name2:type2;..."]
      [-avail_eval_func="function to evaluate availability."]
      [-timezone_region="timezone region"]
      [-privilege_propagation=true/false]
      [-drop_existing_grants=yes/no]

[ ] denotes that the parameter is optional

Options

Examples

emcli modify_aggregate_service -name="My_Name"
      -type="aggregate_service"
      -add_sub_services="sub1:type1;sub2:type2"
      -del_sub_services="sub3:type3"
      -avail_eval_func="my_pkg.my_eval_func"
      -timezone_region="CST"

modify_collection_schedule

Modifies the collection schedule of a collection setup for metrics and policies for the specified set of targets. Combining all the metrics, running a script, and collecting the data is referred to as a collection. The collection has various attributes associated with it, such as the collection schedule, upload frequency, and so forth.

Format

emcli modify_collection_schedule
      -targetType=ttype
      -targetNames=tname1;tname2;tname3...
      -collectionName=collname
      [-collectionStatus=Enabled or Disabled]
      [-freqType={Minute}{Hour}{Day}{Week}{Weekly}{Month}
      [-freqValue={any integer value for Minute/Hour/Day/Week}{One or more from        Mon...Sun for Weekly}{One or more from 1;2..31 or Last for Month}
      [-preview=Y or N]

[ ] denotes that the parameter is optional
{ } denotes that you can select one of the options in the series shown

Note: All of the parameters and choices are case-insensitive

Options

Examples

Example 1

The following example changes the collection schedule to collect once every 5 minutes for hosts host1, host2, and host3. DiskActivity is a collection item associated with a host target type. The preview flag is set to Y, so the changes are not executed, but you can see the metrics affected if the changes were implemented.

emcli modify_collection_schedule -targetType="host"
      -targetNames="host1;host2;host3" -collectionName="DiskActivity"
      -freqType="Minute" -freqValue="5" -preview="Y"

Example 2

The following example changes the collection schedule to collect once every 15 hours for host host1. Inventory is a collection item associated with a host target type. The preview flag is set to N, so the changes are executed for the associated metrics for both the repository and Agent.

emcli modify_collection_schedule -targetType="host"
      -targetNames="host1" -collectionName="Inventory"
      -freqType="Hour" -freqValue="15" -preview="N"

Example 3

The following example changes the collection schedule to collect on Monday and Thursday every week for hosts host1 and host2. Inventory is a collection item associated with a host target type. The preview option is not specified, but since the value is Y whether you specify the option or not, the changes are not executed, but you can see the metrics affected if the changes were implemented.

emcli modify_collection_schedule -targetType="host"
      -targetNames="host1;host2" -collectionName="Inventory"
      -freqType="Weekly" -freqValue="Mon;Thu"

Example 4

The following example changes the collection schedule to collect on the 1st, 5th, 23rd, and last day of every month for hosts host1 and host2. Inventory is a collection item associated with a host target type.

emcli modify_collection_schedule -targetType="host"
      -targetNames="host1;host2" -collectionName="Inventory"
      -freqType="Month" -freqValue="1;5;23;Last"

Example 5

The following example disables the collection schedule for hosts host1 and host2. Inventory is a collection item associated with a host target type.

emcli modify_collection_schedule -targetType="host"
      -targetNames="host1;host2" -collectionName="Inventory"
      -collectionStatus="Disabled"

modify_group

Adds or removes targets from an existing group.

An error is not generated when attempting to delete a non-existent target in the group or when attempting to add a target that already exists in the group.

Format

emcli modify_group
      -name="name"
      [-type=<group>]
      [-add_targets="name1:type1;name2:type2;..."]...
      [-delete_targets="name1:type1;name2:type2;..."]...
      [-privilege_propagation=true/false]
      [-drop_existing_grants=yes/no]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example modifies group db2_group by adding database database:oracle_database and deleting database database2:oracle_database from the group.

emcli modify_group -name=db2_group
      -add_targets=database:oracle_database
      -delete_targets=database2:oracle_database

Example 2

The following example modifies group my_hosts by adding host yourhost.example.com:host to the group.

 emcli modify_group -name=my_hosts
      -add_targets=yourhost.example.com:host

Example 3

The following example modifies group my_group by adding targets group_a:group and database:oracle_database and deleting the nonexistent target nogroup:group from the group.

emcli modify_group -name=my_group
      -add_targets=group_a:group
      -add_targets=database:oracle_database
      -delete_targets=nogroup:group

Example 4

The following example converts group my_group to privilege propagation, ignores if already converted, and drops all of its existing grants.

emcli modify_group -name=my_group 
      -privilege_propagation=true 

Example 5

The following example converts group my_group to non-privilege propagation, ignores if already converted, and retains all of its existing grants on my_group.

emcli modify_group -name=my_group 
      -privilege_propagation=false 
      -drop_existing_grants=no

modify_red_group

Adds or removes targets from an existing redundancy group.

An error is not generated when attempting to delete a non-existent target in the redundancy group.

Format

emcli modify_red_group
      -name="name"
      -type=<generic_redundancy_group>
      [-add_targets="name1:type1;name2:type2;..."]...
      [-delete_targets="name1:type1;name2:type2;..."]...
      [-owner=<Redundancy Group Owner>]

[ ] denotes that the parameter is optional

Options

Examples

The following example modifies redundancy group servers by adding Oracle Apache Server1:oracle_apache and deleting Oracle Apache Server5:oracle_apache from the redundancy group.

emcli modify_red_group -name=Servers
      -add_targets=HTTP_Server1:oracle_apache
      -delete_targets=Server5:oracle_apache

modify_redundancy_group

Modifies a redundancy group.

Format

emcli modify_redundancy_group
        -redundancyGroupName="redGrpName"
        [-owner="new owner"]
        [-memberTargetType="tType"]
        [-add_targets="tName1;tName2"]
        [-delete_targets="tName3;tName4"]
        [-group_status_criterion="NUMBER" or "PERCENTAGE"]        [-group_status_tracked="UP" or "DOWN"]        [-group_status_value=(see the Options section)]
        [-privilege_propagation=true/false] 
        [-drop_existing_grants=yes/no]

[ ] denotes that the parameter is optional

Options

Examples

The following example changes the configuration of the 'redGrp1' redundancy group to add listener, listener2, and listener3 to its existing members, and delete listener4 and listener5 from its existing members.

emcli modify_redundancy_group -redundancyGroupName='redGrp1'       -memberTargetType='oracle_listener'       -add_targets='listener;listener2;listener3'       -delete_targets='listener4;listener5'       -group_status_criterion='NUMBER'       -group_status_tracked='UP'       -group_status_value='2'

modify_role

Modifies an existing Enterprise Manager administrator role.

Note:

Omit an argument to leave its value unchanged.

To update a role and add targets to the role, use the grant_privs verb.

Format

emcli modify_role
      -name="role_name"
      [-description="description"]
      [-roles="role1;role2;..."]
      [-privilege="name;[[target_name:target_type]|jobid]"]...
      [-users="user1;user2;..."]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example modifies a role named existing_role with the one-sentence description This role was changed. 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 modify_role
      -name="existing_role"
      -desc="This role was changed"
      -roles="role1;role2;role3"
      -privilege="view_job;923470234ABCDFE23018494753091111"
      -privilege="view_target;host1.example.com:host"
      -users="johndoe;janedoe"

Example 2

The following example modifies a role named existing_role by assigning role4, role5, and role6 to it. The description, privileges, and users associated with this role remain unchanged.

emcli modify_role
      -name="existing_role"
      -roles="role4;role5;role6"

modify_system

Adds or removes targets from an existing system.

An error is not generated when attempting to delete a non-existent target in the system or when attempting to add a target that already exists in the system.

If you specify both the -add_members and -delete_members options in the same command, the members specified by -delete_members are deleted first, then the members specified by -add_members are added.

Format

emcli modify_system
      -name="name"
      [-type=<generic_system>]
      [-add_members="name1:type1;name2:type2;..."]...
      [-delete_members="name1:type1;name2:type2;..."]...
      [-owner="new_owner"]
      [-privilege_propagation=true/false]
      [-drop_existing_grants=yes/no]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example modifies system db2_system by adding database database:oracle_database and deleting database database2:oracle_database from the system. The new owner of the system is user2.

emcli modify_system -name=db2_system
      -add_members=database:oracle_database
      -delete_members=database2:oracle_database
      -owner=user2

Example 2

The following example modifies system my_hosts by adding host yourhost.example.com:host to the system.

emcli modify_system -name=my_hosts
      -add_members=yourhost.example.com:host

Example 3

The following example modifies system my_system by adding targets system_a:generic_system and database:oracle_database, and deleting the nonexistent target nosystem:generic_system from the system.

emcli modify_system -name=my_system
      -add_members=system_a:generic_system
      -add_members=database:oracle_database
      -delete_members=nosystem:generic_system

modify_target

Modifies a target instance definition.

Format

emcli modify_target
      -name="name"
      -type="type"
      [-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"]
      [-on_agent]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example modifies the display name to New Name DB for the database with the internal name database.

emcli modify_target
      -name="database"
      -type="oracle_database"
      -display_name="New Name DB"

Example 2

The following example modifies the credentials for the oracle_database target with the name database. This example illustrates 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 replaces PWD_FILE with the contents of the at_pwd_file in the credentials argument. The on_agent flag ensures that the changes are propagated to the Management Agent collecting for this target.

emcli modify_target
      -name="database"
      -type="oracle_database"
      -credentials="UserName:newuser;password:PWD_FILE;Role:SYSDBA"
      -input_file="PWD_FILE:at_pwd_file"
      -on_agent

Example 3

The following example modifies the display name and properties for the oracle_database target with the name database. The on_agent flag ensures that the changes are propagated to the Management Agent collecting for this target.

emcli modify_target
      -name="database"
      -type="oracle_database"
      -display_name="New Name DB"
      -properties="SID=newsid|Port=15091|OracleHome=/oracle"
      -properties="MachineName=smpamp-sun1.example.com"
      -separator=properties="|"
      -subseparator=properties="="
      -on_agent

Example 4

The following example modifies an oracle_database target type with the name payroll_db. In this example, the display name for this database (target name that is displayed in the Enterprise Manager UI) is being changed to payroll. The port number is being changed to 15067, and the Oracle Home is being changed to /oradb. The administrator (dbsnmp), whose previous default role was normal, is being changed to sysdba. This example also illustrates 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 replaces PWD_FILE with the contents of at_pwd_file in the -credentials option.

emcli modify_target
      -name="payroll_db"
      -type="oracle_database"
      -credentials="UserName:Fred;password:PWD_FILE;Role:sysdba"
      -properties="Port:15067;OracleHome:/oradb"
      -input_file="PWD_FILE:at_pwd_file"
      -display_name=payroll
      -on_agent

modify_user

Modifies an existing Enterprise Manager administrator.

Format

emcli modify_user
      -name="name"
      [-password="password"]
      [-roles="role1;role2;..."]
      [-email="email1;email2;..."]
      [-privilege="name;[[target_name:target_type]|jobid]"]...
      [-profile="profile_name"]
      [-desc="user_description"]
      [-expired="true/false"]
      [-prevent_change_password="true/false"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example modifies the new_admin administrator. The user will have two privileges: to view the job with ID 923470234ABCDFE230184947530911111 and to view the target host1.example.com:host. The user will also be granted role PUBLIC. The user email addresses will be set to first.last@oracle.com and joe.shmoe@shmoeshop.com.

emcli modify_user
      -name="new_admin"
      -password="oracle"
      -email="first.last@oracle.com;joe.shmoe@shmoeshop.com"
      -roles="public"
      -privilege="view_job;923470234ABCDFE230184947530911111"
      -privilege="view_target;host1.example.com:host"

Example 2

The following example deletes all the email addresses and privileges for administrator new_admin. Note that -privilege="" and -privilege are equivalent if specified at the command line in a UNIX shell.

emcli modify_user
      -name="new_admin"
      -email=""
      -privilege=""

pause_guest_vm

Pauses a guest Virtual Machine. To pause the guest Virtual Machine, it should be in the Running state.

Tip:

See also unpause_guest_vm .

Format

emcli pause_guest_vm       -guest_vm_name=<Virtual Machine Name>      -server_pool_name=<Server Pool Name>

Options

Examples

The following example pauses the dom15 guest Virtual Machine.

emcli pause_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"



provision

Provisions a hardware server using configuration properties from the input file. The configuration properties required for a component can be viewed from the Grid Control console. After you make a provisioning request, you can view the status of the request from the Enterprise Manager Grid Control console by using the assignment name (specified by you or the automatically generated name returned to you).

Format

emcli provision
      -image="path to the image"
      -network="network profile path"
      -bootserver="boot server name"
      -stageserver="stage server name"
      -stgcredentials="username"
      -schedule="type:immediate/onetime;timezone:zone;        startdt:startdate;starttm:time"
      -resettimeout="time"
      -target="hardware server label"
      -input_file="config_properties:file_path"
      -assignment="assignment name"
      [-desc="assignment description"]

[ ] denotes that the parameter is optional

Options

Examples

The following example submits a job to provision myimage on a target with the label of mylabel. The job runs immediately with a reset timeout of 100 minutes. Image properties are picked from properties.txt that overrides the default image. properties.stageserver is used as the staging server, and /private/share as the staging storage with joe as the user name.

emcli provision
      -image="Images/myimage"
      -network="Networks/networkprofile"
      -bootserver="booservername.example.com"
      -stageserver="stageserver.example.com:/private/share"
      -stgcredentials="joe"
      -schedule="type:immediate"
      -resettimeout="100"
      -target="mylabel"
      -input_file="config_properties:properties.txt"
      -assignment="provision mylabel"

reassoc_masking_definition

Reassociates an existing masking definition with another database target.

Format

    emcli reassoc_masking_definition 
       -definition_name=masking definition name
       -target_name=database target name
       [-parameters=name1:value1;name2:value2;...]
       [-credential_set_name=credential_set_name]
       [-input_file=parameter_tag:file_path]

[ ] denotes that the parameter is optional

Options

Output

Success or failure message along with the details.

Examples

Example 1

The following example reassociates the masking definition mask_hr_data with the new database target testdb2 :

emcli reassoc_masking_definition
     -definition_name=mask_hr_data
     -target_name=testdb2
     -parameters="db_username:system;db_password:password;db_role:NORMAL"

Example 2

The following example reassociates the masking definition mask_hr_data with the new database target testdb2. The database password is read from the pwd.txt file.

emcli reassoc_masking_definition
      -definition_name=mask_hr_data
      -target_name=testdb2
      -parameters="db_username:system;db_password:PWD_FILE;db_role=SYSDBA"
      -input_file="PWD_FILE:pwd.txt"

Example 3

The following example reads the credentials from the preferred credential set DBCredsNormal and reassociates the masking definition.

      emcli reassoc_masking_definition
      -definition_name=mask_hr_data
      -target_name=testdb2

Example 4

The following example reads the credentials from the preferred credential set DBCredsSYSDBA and reassociates the masking definition.

      emcli reassoc_masking_definition
      -definition_name=mask_hr_data
      -target_name=testdb2
      -credential_set_name=DBCredsSYSDBA

reboot_guest_vm

Reboots a guest virtual machine. To reboot the guest virtual machine, it should be in the Running state.

Format

emcli reboot_guest_vm       -guest_vm_name=<Virtual Machine Name>      -server_pool_name=<Server Pool Name>

Options

Examples

The following example reboots the dom15 guest Virtual Machine.

emcli reboot_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"

reboot_virtual_server

Reboots a virtual server. To reboot the virtual server, it should be in the Up state.

Format

emcli reboot_virtual_server       -server_name=Server name

Options

Examples

The following example reboots the st-vs1.example.com virtual server.

emcli reboot_virtual_server -server_name="st-vs1.example.com" 

relocate_targets

Format

emcli relocate_targets 
       -src_agent=<source agent target name>
       -dest_agent=<dest agent target name>
       -target_name=<name of the target to be relocated>
       -target_type=<type of target to be relocated>
       -changed_param=<propName>:<propValue>
       -input_file=dupTargets:<targets contents>
       -input_file=moveTargets:"complete path to file containing targets with 
         overridden property values" 
       -copy_from_src [-changed_param=<propName>:<propValue>]*
       [-ignoreTimeSkew=yes]
       [-force=yes]

[ ] denotes that the parameter is optional

Note:

To relocate a composite target, you must specify the input_file=dupTargets option, and you must not combine -target_type or -target_name.

Modes

There are two modes for this verb:

In all cases, relocation moves all collections and blackouts for these targets from the source Agent to destination Agent, and makes the destination Agent the monitoring Agent for these targets in Enterprise Manager.

Options

Examples

Example 1

The following Create Mode example creates a target on the destination Agent by copying the target property content from the source Agent, while allowing some property values to be changed.

emcli relocate_targets -src_agent=<source agent>
      -dest_agent=<destination agent>
      -target_name=<target name>
      -target_type=<target type>
      -copy_from_src
      [-ignoreTimeSkew=yes]
      [-changed_param=<Propname>:<Value>]*

Example 2

The following Create Mode example creates a list of targets on the destination Agent specified in the moveTargets file. You can specify property value overrides.

emcli relocate_targets -src_agent=<source agent>
      -dest_agent=<destination agent>
      -input_file=moveTargets:<complete file path>
      [-ignoreTimeSkew=yes]

remove_beacon

Removes a beacon from the monitoring set of beacons.

Format

emcli remove_beacon
      -name=target name
      -type=target type
      -bcnName=beacon name
      [-forceRemove]

[ ] denotes that the parameter is optional

Options

Examples

The following example removes MyBeacon from the MyTarget service target of type generic_service.

emcli remove_beacon -name='MyTarget' -type='generic_service'
      -bcnName='MyBeacon'

remove_service_system_assoc

Removes the system for a given service.

Format

emcli remove_service_system_assoc
      -name='name'
      -type='type'

Options

Examples

The following example removes the system for the generic service named my service.

emcli remove_service_system_assoc
      -name='my service' -type='generic_service'

remove_target_property

Removes the target property from all targets of the specified target type. This also removes all values associated with this target property.

Format

emcli remove_target_property
      -target_type="target_type"
      -property="property_name"

Options

Examples

Example 1

The following example removes the target property Owner from all targets of type oracle_database. This also removes all values associated with this target property.

emcli remove_target_property  -target_type="oracle_database" -property="Owner"

Example 2

The following example removes the target property Owner from all targets. This also removes all values associated with this property for all target types.

emcli remove_target_property  -target_type="*" -property="Owner"

reschedule_instance

Reschedules a submitted procedure instance. You can only reschedule scheduled instances.

Format

emcli reshedule_instance
      -instance={instance guid}
      -schedule=
          start_time:yyyy/MM/dd HH:mm;
          [tz:{java timezone ID}];
          [grace_period:xxx]

Options

Examples

emcli reschedule_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -schedule="start_time:2006/6/21 21:23;tz:America/New_York;grace_period:60"

resume_guest_vm

Resumes a guest Virtual Machine. To resume the guest Virtual Machine, it should be in the Suspended state.

Tip:

See also suspend_guest_vm .

Format

emcli resume_guest_vm 
      -guest_vm_name=<Virtual Machine Name>
      -server_pool_name=<Server Pool Name>

Options

Examples

The following example resumes the dom15 guest Virtual Machine.

emcli resume_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"

resume_instance

Resumes a suspended deployment instance.

Format

emcli resume_instance
      -instance={instance_guid}

Options

Examples

emcli resume_instance -instance=16B15CB29C3F9E6CE040578C96093F61

resync_agent

Performs an Agent recovery. A message is issued if the specified Agent does not exist.

Format

 emcli resyncAgent       -agent="Agent Name"       [-keep_blocked]

[ ] denotes that the parameter is optional

Options

Examples

emcli resyncAgent -agent="Agent Name"

retry_instance

Retries a failed instance or failed step.

Format

emcli retry_instance       -instance=<instance_guid>       [-stateguid=<state_guid>]

[ ] denotes that the parameter is optional

Options

Examples

emcli retry_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid=51F762417C4943DEE040578C4E087168

emcli retry_instance -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid='51F762417C4943DEE040578C4E087168,51F762417C4944DEE040578C4E087168'

retry_job

Restarts a previously failed job execution.

Format

emcli retry_job
      -exec_id="executionID"
      [-noheader]
      [-script | -format=
            [name:<pretty|script|csv>];
            [column_separator:"column_sep_string"];
            [row_separator:"row_sep_string"];
      ]

[ ] denotes that the parameter is optional

Options

Output Columns:

Execution ID

Examples

The following example restarts the job execution with Id 12345678901234567890123456789012 and displays a new execution ID.

emcli retry_job -exec_id=12345678901234567890123456789012

revoke_license_no_validation

Revokes 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 revoke licenses for standalone target types, such as hosts and databases, but you cannot use this verb to revoke 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 revoke_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 revokes the license to AS1, but this does not propagate to OC4J1.

Format

emcli revoke_license_no_validation      -type="target_type"      [-targets="tname1;tname2;..."]      [-packs="pack1;pack2;..."]      [-file="file_name"]      [-displayAllMessages]

[ ] denotes that the parameter is optional

Options

Examples

Example 1 and Example 2 below revoke licenses of 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:

  1. Access SQL*Plus with your username and password, using sysman or other user that has access to sysman.mgmt_license_view.

  2. Select a distinct pack name from sysman.mgmt_license_view, where:

    target_type=<oracle_database>
    

The following 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 revoke a license to the database1 target for the db_chgmgt pack, you would enter the following command:

emcli revoke_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.

Example 1

The following example revokes the license of the db_diag and db_config packs to database1, database2, and database3 targets (oracle_database target type):

emcli revoke_license_no_validation -type="oracle_database"           -targets="database1;database2;database3;" -packs="db_diag;db_config;"

Example 2

The following example revokes the license of the db_diag and db_config packs to all database targets in the setup:

emcli revoke_license_no_validation -type="oracle_database"
       -packs="db_diag;db_config;"

Example 3

The following example revokes the license of all packs (applicable to database targets) to database1, database2, and database3 targets in the setup:

emcli revoke_license_no_validation -type="oracle_database"          -targets="database1;database2;database3;"

Example 4

The following example revokes the license of all packs (applicable to database targets) to all database targets in the setup:

emcli revoke_license_no_validation -type="oracle_database"

Example 5

The following example uses a text file to pass targets and pack names as the argument. It revokes the license of the db_diag and db_config packs to the database1, database2, and database3 targets (oracle_database target type):

emcli revoke_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;

revoke_license_with_validation

Revokes 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 revoke licenses for standalone target types, such as hosts and databases, and you also use this verb to revoke 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 revokes the license to AS1 and also propagates to OC4J1 (and all other dependent targets associated with AS1).

To revoke licenses for only standalone target types, use the revoke_license_no_validation verb.

Format

emcli revoke_license_with_validation      -type="target_type"      [-targets="tname1;tname2;..."]      [-packs="pack1;pack2;..."]      [-file="file_name"]      [-displayAllMessages]

[ ] denotes that the parameter is optional

Options

Examples

Example 1 and Example 2 below revoke licenses of 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:

  1. Access SQL*Plus with your username and password, using sysman or other user that has access to sysman.mgmt_license_view.

  2. Select a distinct pack name from sysman.mgmt_license_view, where:

    target_type=<oracle_database>
    

The following 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 revoke a license to the database1 target for the db_chgmgt pack, you would enter the following command:

emcli revoke_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.

Example 1

The following example revokes the license of the db_diag and db_config packs to database1, database2, and database3 targets (oracle_database target type):

emcli revoke_license_with_validation -type="oracle_database"           -targets="database1;database2;database3;" -packs="db_diag;db_config;"

Example 1

The following example revokes the license of the db_diag and db_config packs to database1, database2, and database3 targets (oracle_database target type):

emcli revoke_license_with_validation -type="oracle_database"           -targets="database1;database2;database3;" -packs="db_diag;db_config;"

Example 2

The following example revokes the license of the db_diag and db_config packs to all database targets in the setup:

emcli revoke_license_with_validation -type="oracle_database"
       -packs="db_diag;db_config;"

Example 3

The following example revokes the license of all packs (applicable to database targets) to database1, database2, and database3 targets in the setup:

emcli revoke_license_with_validation -type="oracle_database"          -targets="database1;database2;database3;"

Example 4

The following example revokes the license of all packs (applicable to database targets) to all database targets in the setup:

emcli revoke_license_with_validation -type="oracle_database"

Example 5

The following example uses a text file to pass targets and pack names as the argument. It revokes the license of the db_diag and db_config packs to the database1, database2, and database3 targets (oracle_database target type):

emcli revoke_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;

revoke_privs

Revokes the privileges from an existing Enterprise Manager User or Enterprise Manager Role.

Format

emcli revoke_privs
       -name="username/rolename"
       [-privilege="name;[[target_name:target_type]|jobid]"]...

Options

Examples

Example 1

For user1, the following example revokes full control of the jobs with ID 923470234ABCDFE23018494753091111, and revokes full control on the target host1.example.com:host:

emcli revoke_privs
          -name="user1"
          -privilege="FULL_JOB;923470234ABCDFE23018494753091111"
          -privilege="FULL_TARGET;host1.example.com:host"

Example 2

The following example revokes the target privileges from EM Role : Role1:

emcli revoke_privs
          -name="Role1"
          -privilege="FULL_TARGET;host1.example.com:host"

revoke_roles

Revokes the roles to existing an Enterprise Manager user or Enterprise Manager role.

Format

emcli revoke_roles 
      -name="username/rolename"
      [-roles="role1;role2;..."]

[ ] denotes that the parameter is optional

Options

Examples

emcli revoke_roles
        -name="user1"
        -roles="SUPER_USER"


emcli revoke_roles
        -name="Role1"
        -roles="BLACKOUT_ADMIN;MAINTAIN_TARGET"

run_avail_diag

Runs diagnostics for an availability algorithm for a test-based service. This is mostly useful when the "last calculated" time stamp is running behind the current time and the service status has been unresponsive for some time.

Format

emcli run_avail_diag
      -name=<target_name>
      -type=<target_type>

Options

Examples

emcli run_avail_diag  -name='MyTarget' -type='generic_service'

run_promoted_metric_diag

Runs promoted metric diagnostics.

Format

emcli run_promoted_metric_diag
        -name=<target_name>
        -type=<target_type>
        -promotedMetricName=<metric_name>
        -promotedColumn=<metric_type>

Options

Examples

emcli run_promoted_metric_diag  -name='MyTarget' -type='generic_service'
-promotedMetricName='metric1' -promotedColumn='Performance'

save_masking_script

Saves a masking script already generated to the specified path or file.

Format

emcli save_masking_script
     -definition_name=<masking_definition_name>
     [-path=file path]
     [-file=file name]

Options

Output

Success or error messages

Examples

Example 1

The following example saves the masking script for the definition named mask_hr_data to the /tmp directory:

emcli save_masking_script
       -definition_name=mask_hr_data
       -path=/tmp/

Example 2

The following example saves the masking script for the definition named mask_hr_data to /tmp/abc.sql :

emcli save_masking_script
       -definition_name=mask_hr_data
       -file=/tmp/abc.sql

secure_agent

Re-secures up to 50 Grid Control Management Agents after you create a new Certificate Authority for the Grid Control Management Servers.

Agents can be secured by providing a list of Agent names, a group name, or with an input file. If you provide a group name, Enterprise Manager resolves that to a list of Agents that monitor targets in the group. You can also provide an Agent list with an input file to this EMCLI command. For all of these options, you must either provide a username/password, or the user must have been configured with preferred credentials on Agent targets.

The verb submits a job with the list of Agents and the credntials provided as input, and ouputs the Job Name and Job ID, which can be used track the status of the job. This verb also calculates the list of Agents to resecure by filtering out invalid Agents, insecure Agents, Agents that are down, and Agents that already have an active job execution. This verb also filters out Agents that are already secured by the correct Certifcate Authority, but you can disable this filter by using the -disable_ca_check option.

Note the following additional points about this verb:

Format

emcli secure_agent        [-agt_names="agt1;agt2;..."] [-agt_names_file="<file>"]         [-group_name="group_name"]        [-use_pref_creds]         [-username="username"]         [-password="password"]         [-disable_ca_check]

Options

Examples

The following example assumes that the Grid Control Management Agents are installed with the user oracle on all hosts with the same password.

emcli secure_agent -agt_names="ushost1.mycompany.com:3872; ushost2.mycompany.com:3872;ushost1.mycompany.com:3872" -username="oracle" -password="mypwd"
Summary :
Number of valid agents provided for secure : 2, Filtered : 0, Selected : 2
Details :
Number of agents provided for secure (input) : 3
After merging and removing invalid/duplicate agents : 2
 
Job "SECUREAGENTS JOB 2010-Dec-15 16:08:45" submitted for securing 2 agents
Job ID: DE404669C52F43AC805151306F4B138D
Execution ID: 47225EF8C9A8455FBDFB817BF8722FFF

The following example re-secures the Agents, even if they are already registered to the latest certificate.

emcli secure_agent  -agt_names="ushost1.mycompany.com:3872;ushost2.mycompany.com:3872; ushost3.mycompany.com:3872" -username="oracle" -disable_ca_check

set_agent_property

Modifies a specific Agent property. You can use this command if you have operator privilege for the Agent.

Format

emcli set_agent_property      -agent_name="<agent_target_name>"      -name="<agent_property_name>"
      -value="<agent_property_value>"

Options

Examples

The following example sets the value of the UploadInterval property to 15.

emcli get_agent_property -agent_name="agent.example.com:11850"
         -name=UploadInterval
         -value=15

set_availability

Changes the availability definition of a given service.

Format

  emcli set_availability        -name=target name        -type=target type        -availType=availability type (can be 'test' or 'system')        -availOp=availability operator (can be 'and' or 'or)

Options

Examples

Example 1

The following example sets the availability of the service MyTarget to be based on all key tests:

emcli set_availability -name='MyTarget' type='generic_service'                       -availType='test' -availOp='and'

Example 2

The following example sets the availability of the service MyTarget to be based on any key test:

emcli set_availability -name='MyTarget' type='generic_service'
                       -availType='test' -availOp='or'

set_credential

Sets preferred credentials for given users.

Format

emcli set_credential
      -target_type="ttype"
      [-target_name="tname"]
      -credential_set="cred_set"
      [-user="user"]
      -columns="col1:newval1;col2:newval2;PDP:SUDO/POWERBROKER;RUNAS:oracle;          PROFILE:user1..."
      [-input_file="tag1:file_path1;tag2:file_path2;..."]
      [-oracle_homes="home1;home2"]
      [-monitoring]

[ ] denotes that the parameter is optional

Options

Examples

Example 1:

emcli set_credential
      -target_type=oracle_database
      -target_name=myDB
      -credential_set=DBCredsNormal
      -user=admin1
      -column="username:joe;password:newPass;role:newRole"

Example 2:

In Example 2, FILE1 is a tag used to refer to the contents of passwordFile. Note that Example 2 has the same effect as Example 1.

emcli set_credential
      -target_type=oracle_database
      -target_name=myDB
      -credential_set=DBCredsNormal
      -user=admin1
      -column=FILE1
      -input_file=FILE1:passwordFile

Contents of the passwordFile: username:joe;password:newPass;role:newRole

Example 3:

emcli set_credential
      -target_type=host
      -target_name=host.example.com
      -credential_set=OHCreds
      -user=admin1
      -column="OHUsername:joe;OHPassword:newPass"
      -oracle_homes="database1;mydb"

set_instance_jobgrants

Defines key beacons and tests of the service.

Format

emcli set_instance_jobgrants 
      -instance_guid=<instance guid>
      -grants=<user:privilege>

Options

Examples

emcli set_instance_jobgrants -instance_guid=16B15CB29C3F9E6CE040578C96093F61 -grants="user1:VIEW_JOB;user2:FULL_JOB"

set_key_beacons_tests

Defines key beacons and tests of the service.

Format

emcli set_key_beacons_tests
      -name=target name
      -type=target type
      [-beacons=beacon names]+
      [-tests='test1:type1;test2:type2;...']+
      [-removeKey]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example sets MyTest/HTTP, MyTest2/FTP and MyBeacon as non-key elements of service MyTarget/generic_service.

emcli set_key_beacons_tests -name='MyTarget' -type='generic_service'
      -tests='MyTest:HTTP;MyTest2:FTP'
      -beacons='MyBeacon' -removeKey

Example 2

The following example sets MyBeacon and MyBeacon2 as key beacons of service MyTarget/generic_service.

emcli set_key_beacons_tests -name='MyTarget' -type='generic_service'
      -beacons='MyBeacon;MyBeacon2'

set_metric_promotion

Creates or edits a metric promotion based on a test or system.

Format

emcli set_metric_promotion
      -name=Service target name
      -type=Service target type
      [-category = Usage/Performance/Business]
      -basedOn = system/test
      -aggFunction = AVG|MAX|MIN|SUM|COPY
      [-promotedMetricName = Promoted Metric]
      [-promotedMetricColumn = Promoted Metric Column]
      -promotedMetricKey = Key Value of the promoted metric
      [-metricName = Dependent Metric Name]
      -column = Dependent Metric Column
      *[-depTargetType = Target type of dependent targets]
      *[-depTargets = 'target1;target2...']
      *[-depTargetKeyValues='target1:key11|key12|key13..;          target2:key21|key22|key23..']
      *[-depMetricKeyColumn= Dependent metric key column]
      **[-testname= Dependent Test Name]
      **[-testtype= Dependent Test Type]
      **[-metricLevel= TXN|STEP|STEPGROUP]
      **[-beacons='bcn1;bcn2..']
      **[-depTestComponent= Step or stepgroup name]
      [-threshold= 'Critical threshold value; Warning threshold value;          Threshold Operator (EQ|LE|LT|GT|GE)']
      -mode= CREATE|EDIT

[ ] denotes that the parameter is optional

* — Might be required if basedOn is set to system.

** — Might be required if basedOn is set to test.

Options

Examples

Example 1

The following example creates a promoted Performance metric with key value mymetric1 on service MyTarget using MyTest/HTTP. The promoted metric takes the maximum of the dns_time metric column returned by the MyBeacon and mybcn1 beacons. It also has a threshold with 'greater or equal to' operator (GE) with the critical value set to 200 and warning value set to 100.

emcli set_metric_promotion -name='MyTarget' -type='generic_service' 
      -category=Performance -basedOn=test -aggFunction=MAX
      -testname='MyTest' -testtype=HTTP
      -beacons='MyBeacon, mybcn1'
      -promotedMetricKey=mymetric1 -column=dns_time -metricName=http_response
      -metricLevel=TXN -threshold='200;100;GE' -mode=CREATE

Example 2

The following example creates a promoted Usage metric with key value mymetric1 on service MyTarget. The dependent target is 'myhost.mydomain.com' with type host. The promoted metric just copies the cpuUtil column of the Load metric.

emcli set_metric_promotion -name='MyTarget' -type='generic_service'
      -category=Usage -basedOn=system -aggFunction=COPY
      -promotedMetricKey=mymetric1 -column=cpuUtil -metricName=Load
      -depTargets='myhost.mydomain.com' -depTargetType=host
      -mode=CREATE

Example 3

The following example creates a promoted Usage metric with the key value AppServerComponentUsage on service MyTarget. The dependent target is 'myapp_server' with type 'oracle_ias'. The promoted metric computes the average value of the cpu.component metric column for the specified key values.

emcli set_metric_promotion -name='MyTarget' -type='generic_service'
      -category=Usage -basedOn=system -aggFunction=AVG
      -promotedMetricKey=AppServerComponentUsage -depTargetType=oracle_ias       
      -column=cpu.component
      -metricName=opmn_process_info
      -depTargetKeyValues='myapp_server:petstore;myapp_server:http_server'
      -mode=CREATE 

set_properties

Sets the property for a test or beacons.

Format

emcli set_properties
      -name=target name
      -type=target type
      -testname=test name
      -testtype=test type
      [-beacons=beacon names]
      [-properties='prop1:value1;prop2:value2;..']+

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example sets the property timeout to 30000 and granularity to transaction for the test MyTest defined on MyTarget for all beacons.

emcli set_property -name='MyTarget' -type='generic_service'
      -testname='MyTest' -testtype='HTTP'
      -propertyName='timeout:30000;granularity:transaction'

Example 2

The following example sets the property value to 30000 of the test MyTest defined on MyTarget for only MyBeacon and MyBeacon2. This only works if the specified properties can be set on a per beacon level.

emcli set_property -name='MyTarget' -type='generic_service'
      -testname='MyTest' -testtype='HTTP'
      -bcnName='MyBeacon;MyBeacon2'
      -propertyName='timeout' -propertyValue='30000'

set_standby_agent

Permits targets to relocate from one agent to another. This verb always populates a table that determines which targets from the source agent to the destination agent are permitted to relocate for the Enterprise Manager target.

Format

emcli set_standby_agent
       -src_agent=<source agent>
       -dest_agent=<destination agent>
       -target_name=<target name>
       -target_type=<target type>

[ ] denotes that the parameter is optional

Options

Output

Output message of the command execution.


set_target_property_value

Sets the value of a target property for a specified target. Any prior values of the target property are overwritten. When assigning values to the Oracle-provided target properties, use the English names of these target properties:

Comment, Deployment Type, Line of Business, Location, Contact

Format

emcli set_target_property_value      -property_records="target_name:target_type:property_name:property_value"      [-separator=property_records="sep_string"]      [-subseparator=property_records="subsep_string"]      [-input_file="parameter_tag:file_path"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example sets the 'Owner Name' property to Jane Smith for the database test_database.

emcli set_target_property_value
      -property_records="test_database:oracle_database:Owner Name:Jane Smith"

Example 2

The following example sets the Owner property to Jane Smith for the database test_db and also sets the Asset Number property to 100 for the database test_db1.

emcli set_target_property_value
          -property_records="test_db:oracle_database:Owner:Jane Smith;            test_db1:oracle_database:Asset Number:100"

Example 3

The following example takes the input of the property records from the specified file /temp/rec_file.

emcli set_target_property_value
          -property_records="REC_FILE" -input_file="REC_FILE:/temp/rec_file"

The file /temp/rec_file would contain entries such as:

test_db:oracle_database:Owner:Jane Smith;test_db1:oracle_database:Asset Number:100

Example 4

The following example sets the Owner property to Jane Smith for the test_db database, and sets the Asset Number property to 100 for the test_db1 database. The separator used within the records is "," and the subseparator is "@" .

emcli set_target_property_value
           -property_records="test_db@oracle_database@Owner@             Jane Smith,test_db1@oracle_database@AssetNumber@100"

set_test_threshold

Sets a test threshold.

Format

emcli set_test_threshold
      -name=<target_name>
      -type=<target_type>
      -testname=<test_name>
      -testtype=<test_type>
      -metricName=<metric_name>
      -metricColumn=<metric_column>
      -occurrences=<occurrences>
      [-warningThres=<warning_threshold>]
      [-criticalThres=<critical_threshold>]
      [-operator=<operator>]
      [-beaconName=<beacon_name>]
      [-stepName=<step_name>]
      [-stepGroupName=<stepgroup_name>]

[ ] denotes that the parameter is optional

Examples

emcli set_test_threshold -name="Service Name"
              -type="generic_service"
              -testname="Test Name"
              -testtype="HTTP"
              -metricName="http_response"
              -metricColumn="timing"
              -occurrences=1
              -warningThres=100000

setup

Configures EM CLI to work with a specific management server.

The default mode stores the credentials, which is inherently insecure because of backward compatibility reasons. For a secure setup, you need to specify the noautologin option. See noautologin in the Options section for more information.

Format

 emcli setup
       -url="http[s]://host:port/em/"
       -username=<EM Console Username>
       [-password=<EM Console Password>]
       [-ssousername=<EM SSO Username>]
       [-ssopassword=<EM SSO Password>]
       [-licans=yes|no]
       [-dir=<local emcli configuration directory>]
       [-trustall]
       [-novalidate]
       [-noautologin]
       [-custom_attrib_file=<Custom attribute file path>]
       [-nocertvalidate]

[ ] denotes that the parameter is optional

Options

Examples

emcli setup -url=http://myworkstation.example.com:7770/em -username=sysman

To configure the EM CLI Client to function with multiple OMSs by implementing multiple setups, do the following:

  1. Set up the EM CLI client for OMS1 at location dir1:

    emcli setup -dir=<dir1> -url=<Url of OMS1> -user=<EM Username for OMS1>
    
  2. Set up the EM CLI client for OMS2 at location dir2:

    emcli setup -dir=<dir2> -url=<Url of OMS1> -user=<EM Username for OMS2>
    
  3. Set the environment variable EMCLI_STATE_DIR to point to the setup directory for OMS1:

    setenv EMCLI_STATE_DIR <dir1>
    

    This sets the EM CLI Client to function with OMS1.

  4. Set the environment variable EMCLI_STATE_DIR to point to the setup directory for OMS2:

    setenv EMCLI_STATE_DIR <dir2>
    

    This sets the EM CLI Client to function with OMS2.


show_audit_settings

Shows the following details of the current audit settings:


— Audit Switch
— Externalization Switch
— Directory
— File Prefix
— File Size
— Data Retention Period

Format

emcli show_audit_settings

show_credential_set_info

Displays the parameters of credential sets defined with target types.

Format

emcli show_credential_set_info       [-target_type="<target_type>"]       [-set_name="<credential_set_name>"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example displays the details of all credential sets defined with all target types:

emcli show_credential_set_info

Example 2

The following example displays all credential sets defined with the oracle_database target type:

emcli show_credential_set_info -target_type=oracle_database

Example 3

The following example displays the details of the HostUDMCreds credential set defined for the host target type.

emcli show_credential_set_info -target_type=host
      -set_name=HostUDMCreds

show_credential_type_info

Displays the parameters of credential types defined for target types.

Format

emcli show_credential_type_info       [-target_type="<target_type>"]       [-type_name="<credential_type_name>"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example displays the details of all credential types defined with all target types:

emcli show_credential_type_info

Example 2

The following example displays all credential types defined with the oracle_database target type:

emcli show_credential_type_info -target_type=oracle_database

Example 3

The following example displays the details of the HostUDMCreds credential type defined for the oracle_database target type.

emcli show_credential_type_info -target_type=oracle_database
      -type_name=HostUDMCreds

show_operations_list

Shows the list of all auditable Enterprise Manager operations names.

Format

emcli show_operations_list

Ouput

Output appears as shown in the following example:

ADD_AGENT_REGISTRATION_PASSWORD
AGENT_REGISTRATION_PASSWORD_USAGE
AGENT_RESYNC
APPLY_TEMPLATE
AUDIT_EXPORT_SETTINGS
AUDIT_SETTINGS
CHANGE_PASSWORD
CHANGE_PREFERRED_CREDENTIAL
CREATE_PG_SCHED
CREATE_ROLE
CREATE_TEMPLATE
CREATE_UDP
CREATE_UDPG
CREATE_USER
DELETE_AGENT_REGISTRATION_PASSWORD
DELETE_JOB
DELETE_PG_EVAL
DELETE_PG_SCHED
DELETE_ROLE
DELETE_TEMPLATE
DELETE_UDP
DELETE_UDPG
DELETE_USER
EDIT_AGENT_REGISTRATION_PASSWORD
EDIT_JOB
EDIT_PG_SCHED
EDIT_TEMPLATE
EDIT_UDP
EDIT_UDPG
EVALUATE_UDP
FILE_TRANSFER
GET_FILE
GRANT_JOB_PRIVILEGE
GRANT_ROLE
GRANT_SYSTEM_PRIVILEGE
GRANT_TARGET_PRIVILEGE
IMPORT_UDP
JOB_OUTPUT
LOGIN
LOGOUT
MODIFY_METRIC_SETTINGS
MODIFY_POLICY_SETTINGS
MODIFY_ROLE
MODIFY_USER
PUT_FILE
REMOTE_OPERATION_JOB
REMOVE_PRIVILEGE_DELEGATION_SETTING
REPOSITORY_RESYNC
REVOKE_JOB_PRIVILEGE
REVOKE_ROLE
REVOKE_SYSTEM_PRIVILEGE
REVOKE_TARGET_PRIVILEGE
SAVE_MONITORING_SETTINGS
SET_PRIVILEGE_DELEGATION_SETTING
SUBMIT_JOB
SUSPEND_JOB

start_guest_vm

Starts a guest virtual machine. To start the guest virtual machine, it should be in the Halted state.

Format

emcli start_guest_vm       -guest_vm_name=<Virtual Machine Name>      -server_pool_name=<Server Pool Name>

Options

Examples

The following example starts the dom15 guest Virtual Machine.

emcli start_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"

start_paf_daemon

Starts the Deployment Procedure Manager Daemon.

Format

emcli start_paf_daemon -interval=<number in minutes>

Options


start_vt_daemon

Starts the virtualization daemon.

Tip:

See also stop_vt_daemon.

Format

emcli start_vt_daemon

Options

None.


status_paf_daemon

Gets the Deployment Procedure Manager Daemon status.

Format

emcli status_paf_daemon

Options

None.


status_vt_daemon

Gets the status of the virtualization daemon.

Format

emcli status_vt_daemon

Options

None.


stop_blackout

Stops a blackout.

You can stop a blackout before it has fully started, for example, when it has a "Scheduled" status. You can also stop a blackout while it is in effect.

Format

emcli stop_blackout
      -name="name"
      [-createdby="blackout_creator"]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example stops blackout backup_db3 created by the current user.

emcli stop_blackout -name=backup_db3

Example 2

The following example stops blackout weekly_maint created by user joe. The current user must either be user joe or a user with the SUPER_USER privilege.

emcli stop_blackout -name=weekly_maint -createdby=joe

stop_guest_vm

Stops a guest Virtual Machine. To stop the guest Virtual Machine, it should be in the Running state.

Format

emcli stop_guest_vm       -guest_vm_name=<Virtual Machine Name>      -server_pool_name=<Server Pool Name>

Options

Examples

The following example stops the dom15 guest Virtual Machine.

emcli stop_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"

stop_instance

Stops a scheduled, failed, or running deployment instance.

Format

emcli stop_instance 
      -instance={instance_guid}

Options

Examples

emcli stop_instance -instance=16B15CB29C3F9E6CE040578C96093F61

stop_job

Stops a specified job. You can use the get_jobs verb to obtain a list of job IDs and names.

Format

emcli stop_job
      -job_id="jobID" | -name="jobName"

Options

Examples

Example 1

The following example stops a job with the specified ID.

emcli stop_job -job_id=12345678901234567890123456789012

Example 2

The following example stops a job named Backup_Wednesday, which is owned by the current Enterprise Manager administrator and scheduled to execute in the future.

emcli stop_job -name=Backup_Wednesday

stop_paf_daemon

Stops the Deployment Procedure Manager Daemon.

Format

emcli stop_paf_daemon

Options

None.


stop_virtual_server

Stops a virtual server. To stop the virtual server, it should be in the Up state.

Format

emcli stop_virtual_server       -server_name=Server name

Options

Examples

The following example stops the st-vs1.example.com virtual server.

emcli stop_virtual_server -server_name="st-vs1.example.com" 

stop_vt_daemon

Stops the virtualization daemon.

Tip:

See also start_vt_daemon.

Format

emcli stop_vt_daemon

Options

None.


submit_agent_patch

Patches the Agent. All of the inputs should be present in the targets_file.xml file.

Format

emcli submit_agent_patch
-input_file="data:targets_file.xml"
-schedule="start_time:<value>;tz:<value>;grace_period:<value>"

Options

Examples

emcli submit_agent_patch -input_file="data:targets_file.xml"  -schedule="start_time:2006/6/21 21:23;tz:America/New_York;grace_period:15"

submit_job

Creates and submits a job.

Format

emcli submit_job
      -job="name:type"
      -targets="name1:type1;name2:type2;..."
      -parameters="name1:value1;name2:value2;PDP:SUDO/POWERBROKER;RUNAS:oracle;          PROFILE:user1..."
      [-input_file="parameter_tag:file_path"]
      [-desc="job_description"]
      [-schedule=
           "[frequency:<once|interval|weekly|monthly|yearly>];
            [start_time:<yy-MM-dd HH:mm>];
            [end_time:<yy-MM-dd HH:mm>];
            [repeat:<#m|#h|#d|#w|#M|#Y>];
            [months:<#,#,...>];
            [days:<#,#,...>];
            [tzoffset:#|[-][HH][:mm]]
            [tzregion:<...>]
            [tzinfo:<repository|target|specified>]";
      ]
      [-noheader]
      [-script | -format=
                  [name:<pretty|script|csv>];
                  [column_separator:"column_sep_string"];
                  [row_separator:"row_sep_string"];
      ]

[ ] denotes that the parameter is optional

Constraints on schedule arguments:

frequency:once

optional => start_time, tzinfo, tzoffset

frequency:interval

requires => repeat

optional => start_time, end_time, tzinfo, tzoffset

frequency:weekly

requires => days

optional => repeat in #w, start_time, end_time, tzinfo, tzoffset

frequency:monthly

requires => days

optional => repeat in #M, start_time, end_time, tzinfo, tzoffset

frequency:yearly

requires => days, months

optional => repeat in #Y, start_time, end_time, tzinfo, tzoffset

Options

Output Columns

Job ID, Execution ID

Examples

Example 1

The following example submits a job that runs ls -l against target "hostname.oracle.com:host". The job runs under OS username joe with a password of greetings.

emcli submit_job
      -job="job_host_0:OSCommand"
      -parameters="command:ls;args:-l;username:joe;password:greetings"
      -targets="hostname.example.com:host"

Example 2

The following example submits a job that runs the shell (/bin/sh) script specified by the parameter large_os_script against targets hostname1.oracle.com:host and hostname2.oracle.com:host. The targets' preferred credentials are used to run this job. Here, large_os_script can be up to 4 GB.

emcli submit_job
      -job="job_host_1:OSCommand"
      -parameters='command:/bin/sh;args:-x;large_os_script:LARGE_SCRIPT_FILE'
      -input_file="LARGE_SCRIPT_FILE:very_large_os_script.sql"
      -targets="hostname1.oracle.com:host;hostname2.oracle.com:host"

Example 3

The following example submits a job that runs the SQL script specified in the file ./very_large_script.sql against the target database:oracle_database. The target's preferred credentials are used to run this job. Here, large_sql_script can be up to 4 GB.

emcli submit_job
      -job="job_db_1:SQLScript"
      -parameters="large_sql_script:LARGE_SQL_FILE"
      -targets="database:oracle_database"
      -input_file="LARGE_SQL_FILE:very_large_script.sql"

submit_masking_job

Submits a masking job and returns the display job ID and execution ID.

Format

  emcli submit_masking_job
    -definition_name=masking_defn_name
    [-seed=seed_string]
    [-credential_set_name=credential_set_name]
    [-parameters=name1:value1;name2:value2;...]
    [-script_file_location=script_file_location]
    [-script_file_name=script_file_name]
    [-input_file=PWD_FILE_TAG:credentials file name]
    [-script | -format=[name:<pretty|script|csv>];
                       [column_separator:"column_sep_string"];
                       [row_separator:"row_sep_string"];
    ]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example submits a masking job for the definition name email1 and returns the job ID and execution ID:

emcli submit_masking_job -definition_name=email1 -parameters="db_username:sys;
    db_password:password;db_role:SYSDBA;host_username:test;host_password:password"

Example 2

The following example assumes the default credential set as DBCredsNormal and returns job ID and execution ID.

emcli submit_masking_job -definition_name=email1

Example 3

The following example picks up credentials from the files host_creds.txt and db_creds.txt.

emcli submit_masking_job -definition_name=email1 -parameters="HOST_CREDS;DB_CREDS" -input_file=HOST_CREDS:host_creds.txt -input_file=DB_CREDS:db_creds.txt

It is also possible to specify both of the credentials in one file and use only one -input_file tag. If PDP must be used, you need to provided values in the parameters/input_file as follows:

Example 4

The following example uses the database credential set name as DBCredsSYSDBA, and assumes the database host credential set name as DBHostCreds. If the masking definition involves usage of a substitute format, it uses the seed string of 'abcd'. The example also overrides the default script file name and location by the values specified. The example aslo submits a masking job for the given definition name and returns job ID and execution ID.

emcli submit_masking_job -definition_name=email2  -credential_set_name=DBCredsSYSDBA -seed=abcd -script_file_location=/tmp  -script_file_name=email1.sql

submit_procedure

Submits a Deployment Procedure.

Format

emcli submit_procedure
     -procedure="guid of the procedure"
     -input_file="data:file_path"
     [-instance_name="name for the procedure instance"]
     [-schedule=start_time:yyyy/MM/dd HH:mm;tz:{java timezone ID}];]

[ ] denotes that the parameter is optional

Options

Output Columns

Instance GUID

Examples

emcli submit_procedure -input_file=data:data.xml
     -procedure=16B15CB29C3F9E6CE040578C96093F61 -schedule="start_time:2006/6/21
      21:23;tz:America/New_York"

subscribeto_rule

Subscribes the user to a rule with email notification.

It is not an error to specify email addresses that are already in the assignto user's preferences.

A message appears if the outgoing mail server (SMTP) has not been set up. When you specify the option -fail_if_no_mail_server, this condition is an error and prevents the subscribe from occurring; otherwise, this condition is a warning that does not affect the success of this command.

Format

emcli subscribeto_rule
      -name="rule_name"
      -owner="rule_owner"
      [-assignto="em_username" (default is current user)]
      [-email="email_address";...]
      [-fail_if_no_mail_server]

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example subscribes the current user to the rule "Agent Upload Problems" using the current user's email addresses for notification. The current user must have the SUPER_USER (or have sysman) privilege for this to succeed, since sysman owns the rule. Also, the current user must already have at least one email address in his/her preferences for this command to succeed.

emcli subscribeto_rule -name="Agent Upload Problems" -owner=sysman

Example 2

The following example first adds the two specified email addresses to the preferences for user joe. Then user joe is subscribed to the rule "Agent Upload Problems" using joe's email addresses for notification. The current user must have SUPER_USER privilege (or be joe) for this command to succeed.

emcli subscribeto_rule -name="Agent Upload Problems" -owner=sysma
      -assignto=joe -email="joe@work.com;joe@home.com"

suspend_guest_vm

Suspends a guest Virtual Machine. To suspend the guest Virtual Machine, it should be in the Running state.

Tip:

See also resume_guest_vm.

Format

emcli suspend_guest_vm 
      -guest_vm_name=<Virtual Machine Name>
      -server_pool_name=<Server Pool Name>

Options

Examples

The following example suspends the dom15 guest Virtual Machine.

emcli suspend_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"

suspend_instance

Suspends a running deployment instance.

Format

emcli suspend_instance 
      -instance={instance_guid}

Options

Examples

emcli suspend_instance -instance=16B15CB29C3F9E6CE040578C96093F61

sync

Synchronizes the EM CLI client with an OMS. After synchronization, all verbs and associated command line help available to this OMS become available at the EM CLI client.Synchronization occurs automatically during a call to setup.

Format

emcli sync

Options

None.

Examples

emcli sync

sync_beacon

Synchronizes a beacon that is monitoring the target (reloads all collections to beacon).

Format

emcli sync_beacon
      -name=target name
      -type=target type
      -bcnName=beacon name

Options

Examples

The following example synchronizes MyBeacon, which is monitoring the MyTarget target of type generic_service.

emcli sync_beacon -name='MyTarget' -type='generic_service'
      -bcnName='MyBeacon'

unpause_guest_vm

Unpauses a paused guest virtual machine. To unpause the guest virtual machine, it should be in the Paused state.

Tip:

See also pause_guest_vm .

Format

emcli unpause_guest_vm       -guest_vm_name=<Virtual Machine Name>      -server_pool_name=<Server Pool Name>

Options

Examples

The following example unpauses the paused dom15 guest Virtual Machine.

emcli pause_guest_vm -guest_vm_name="dom15" -server_pool_name="Oracle Server Pool"



update_audit_settings

Updates the current audit settings in the repository and restarts the OMS.

Format

emcli update_audit_settings     [-externalization_switch="ENABLE/DISABLE"]     -directory_name="<database_directory_name>"     -file_prefix="<file_prefix>"     -file_size="<file_size (Bytes)>"     -data_retention_period="<data_retention_period (Days)>"

[ ] denotes that the parameter is optional

Options

Examples

Example 1

The following example enables all operations except LOGIN and LOGOUT:

emcli update_audit_settings
          -audit_switch="ENABLE"
          -operations_to_enable="ALL"
          -operations_to_disable="LOGIN;LOGOUT"

Example 2

emcli update_audit_settings
    -externalization_switch="ENABLE"
    -directory="EM_DIR"
    -file_prefix="my_audit"
    -file_size="10000"
    -data_retention_period="60"

update_and_retry_step

Updates arguments of the failed step and retries it.

Format

emcli update_and_retry_step       -instance=instance_guid       -stateguid=state_guid       [-args="command1:value1;command2:value2;..."]

[ ] denotes that the parameter is optional

Options

Examples

emcli update_and_retry_step -instance=16B15CB29C3F9E6CE040578C96093F61 -stateguid=51F762417C4943DEE040578C4E087168 -args="command:ls"

update_db_password

Updates the target database password change in the Enterprise Manager Credential sub-system and can change the password on the target database as well. This verb also propagates the collection or monitoring credentials to Enterprise Manager Agents.

Format

emcli update_db_password
       -target_name="tname"
       -user_name="user_name"
       [-target_type="ttype"]
       [-change_all_references="yes/no"]
       [-change_at_target="yes/no"]
       [-input_file="tag1:file_path1;tag2:file_path2;..."]

[ ] denotes that the parameter is optional

Options

Examples

emcli update_db_password
      -target_name=myDB
      -user_name=Admin1
emcli update_db_password
      -target_name=myDB
      -user_name=Admin1
      -change_at_target=yes

update_host_password

Updates the changed host password in the credential sub-system. For collection or monitoring credentials, the password change is also propagated to the Enterprise Manager Agent.

Format

emcli update_host_password      -target_name="tname"      -user_name="user_name"      [-change_all_references="yes/no"]      [-input_file="tag1:file_path1;tag2:file_path2;..."]

[ ] denotes that the parameter is optional

Note:

When you execute this verb, you are prompted to enter the following values in non-echo mode:

-old_password -new_password -retype_new_password

Options

Examples

Example 1

The following example asks the user to enter the values of the old and new passwords, then retype the new password to update the new password in Enterprise Manager for this target reference.

emcli update_host_password
      -target_name=myHost
      -user_name=Admin1

Example 2

The following example asks the user to enter the values of the old and new passwords, then retype the new password to update the new password in Enterprise Manager for all users' credentials referenced with the myHost target name and Admin1 user name.

emcli update_host_password
      -target_name=myHost
      -user_name=Admin1
      -change_all_references=yes

update_password

Updates passwords (or other credentials) for a given target.

Format

emcli update_password
      -target_type="ttype"
      -target_name="tname"
      -credential_type="cred_type"
      -key_column="column_name:column_value"
      -non_key_column="col:oldvalue:newvalue;..."
      [-input_file="tag1:file_path1;tag2:file_path2;..."]

[ ] denotes that the parameter is optional

Options

Note: The list of columns and the credential types they belong to is included in the metadata file for each target type. This and other credential information is in the <CredentialInfo> section of the metadata.

Host Example

For credentials associated with host targets, use the following arguments for the command.

target_type=host
credential_type = HostCreds
key_column=HostUserName:<OSUserName>
non_key_column=HostPassword:<oldPassword>:<newPassword>

The following example changes the password associated with the OS user sysUser from sysUserOldPassword to sysUserNewPasword in all features of EM that use this OS username. This includes preferred credentials, corrective actions, jobs, and OS user-defined metrics.

update_password   -target_type=host  -target_name=MyHost  -credential_type=HostCreds  -key_column=HostUserName:sysUser
-non_key_column=HostPassword:sysUserOldPassword:sysUserNewPassword

Oracle Database Examples

For credentials associated with database targets, use the following arguments for the command.

target_type=oracle_database
credential_type = DBCreds
key_column=DBUserName:<DBUser>
non_key_column=DBPassword:<oldPassword>:<newPassword>  OR
non_key_column=DBPassword:<oldPassword>:<newPassword>:<DBRole>

Example 1

The following example changes the password associated with the database user scott from tiger to tiger2 for all features of Enterprise Manager that use this database user name. This includes preferred credentials, corrective actions, jobs, SQL user-defined metrics, and the monitoring configuration for this database target in Enterprise Manager.

update_password -target_type=oracle_database -target_name=ORCL  -credential_type=DBCreds -key_column=DBUserName:scott
-non_key_column=DBPassword:tiger:tiger2

Example 2

The following example changes the password associated with the database user sys from sysPassword to sysNewPassword for all features of Enterprise Manager that use this database username. This includes preferred credentials, corrective actions, jobs, SQL user-defined metrics, and the monitoring configuration for this database target in Enterprise Manager.

update_password -target_type=oracle_database -target_name=ORCL   -credential_type=DBCreds -key_column=DBUserName:sys
-non_key_column=DBPassword:sysPassword:sysNewPassword:DBAROLE

Oracle Listener Example

For credentials associated with Listener targets, use the following arguments for the command.

target_type=oracle_listener
credential_type = LsnrCreds
key_column (not applicable)
non_key_column=Password:<oldPassword>:<newPassword>

The following example changes the password associated with the Listener from oldListenerPassword to newListenerPassword for all features of Enterprise Manager that use this password. This includes preferred credentials, corrective actions, jobs, and the monitoring configuration for this Listener target in Enterprise Manager.

update_password   -target_type=oracle_listener  -target_name=MyListener  -credential_type=LsnrCreds
-non_key_column=Password:oldListenerPassword:newListenerPassword

update_target_password

Updates the changed target password in the Enterprise Manager credential sub-system. For collection or monitoring credentials, the password change is also propagated to Enterprise Manager agents.

Format

emcli update_target_password        -target_type="ttype"        -target_name="tname"        -key_column="column_name:column_value"        [-change_all_references="yes/no"]        [-input_file="tag1:file_path1;tag2:file_path2;..."]

[ ] denotes that the parameter is optional

Note:

When you execute this verb, you are prompted to enter the following values in non-echo mode:

-old_password -new_password -retype_new_password

Options

Examples

Example 1

The following example asks the user to enter the values of the old and new passwords, then retype the new password to update the new password in Enterprise Manager for this target reference.

emcli update_target_password      -target_type=host      -target_name=myHost      -key_column=HostUserName:Admin1

Example 2

The following example asks the user to enter the values of the old and new passwords, then retype the new password to update the new password in Enterprise Manager for all users' credentials referenced with the mydb target name and Admin1 user name.

emcli update_target_password      -target_type=oracle_database      -target_name=mydb      -key_column=DBUserName:Admin1      -change_all_references=yes

version

Lists EM CLI verb versions or the EM CLI client version.

Format

emcli version
    [-verb_name=<verb_name_filter>]
    [-exact_match]
    [-noheader]
    [-script | -format=
               [name:"pretty|script|csv"];
               [column_separator:"column_sep_string"];
               [row_separator:"row_sep_string"];
    ]

[ ] denotes that the parameter is optional

Options

Output Columns

Verb, Version (when -verb_name is specified)

Examples

Example 1

The following example shows the version for all verbs:

emcli version -verb_name=

Example 2

The following example shows the version for all verbs with names that exactly match the string "sync" :

emcli version -verb_name=sync -exact_match

Example 3

The following example shows the version for all verbs with names starting with "log:"

emcli version -verb_name="^log"

Example 4

The following example shows the version for all verbs with names that end with "in:"

emcli version -verb_name="in$"

Example 5

The following example shows the version for all verbs with names that contain a substring matching "elp" or with names that begin with "ver" or "lo", contains "i", and ends with "n:"

emcli version -verb_name="elp|^(ver|lo).*i.*n$"

Example 6

The following example shows the version for all verbs with names that exactly match the string "setup." Alternatively, you could use the -exact_match option.

emcli version -verb_name="^setup$"

view_redundancy_group

Shows the present configuration of the redundancy group.

Format

emcli view_redundancy_group      -redundancyGroupName="redGrpName"

Options

Examples

The following example shows the details for the 'redGrp1' Redundancy Group.

emcli view_redundancy_group -redundancyGroupName='redGrp1'