Skip Headers
Oracle® Enterprise Manager Command Line Interface
12c Release 1 (12.1.0.4)

E17786-12
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

4 Verb Reference

This chapter provides a complete listing of all EM CLI verbs in categorical as well as alphabetical order. Each verb provides complete syntax and usage information.

4.1 Verb Categories

This section lists all of the verbs for this release in the following categories:

Basic Operational Verbs

Note: Only these verbs are available immediately after installation.


argfile
help
login
logout
setup
status
sync
version

Add Host Verbs


continue_add_host
get_add_host_status
list_add_host_platforms
list_add_host_sessions
retry_add_host
submit_add_host

Agent Administration Verbs


get_agent_properties
get_agent_property
modify_monitoring_agent
resecure_agent
restart_agent
secure_agent
set_agent_property
start_agent
stop_agent
unsecure_agent

Agent Upgrade Verbs


get_agent_upgrade_status
get_signoff_agents
get_signoff_status
get_upgradable_agents
signoff_agents
upgrade_agents

Audit Settings Verbs


disable_audit
enable_audit
show_audit_settings
show_operations_list
update_audit_settings

Bare Metal Provisioning Verbs


bareMetalProvisioning

BI Publisher Reports Verbs


deploy_bipublisher_reports
grant_bipublisher_roles
revoke_bipublisher_roles
setup_bipublisher
unregister_bipublisher

Blackout Verbs


add_blackout_reason
create_blackout
delete_blackout
get_blackout_details
get_blackout_reasons
get_blackout_targets
get_blackouts
stop_blackout

Chargeback Verbs


add_chargeback_entity
assign_charge_plan
assign_cost_center
create_charge_entity_type
create_charge_item
delete_charge_item
export_charge_plans
export_custom_charge_items
get_metering_data
import_charge_plans
import_custom_charge_items
list_chargeback_entities
list_chargeback_entity_types
list_charge_item_candidates
list_charge_plans
list_cost_centers
remove_chargeback_entity
unassign_charge_plan
unassign_cost_center

Cloning Verbs


clone_as_home
clone_crs_home
clone_database
clone_database_home
extend_as_home
extend_crs_home
extend_rac_home

Compliance Verbs


export_compliance_group
export_compliance_standard_rule
export_standard
import_compliance_object

Connector Verbs


publish_change_request_ccc
update_ticket_status

Create Database Job Verbs


create_database

Create Pluggable Database Job Verbs


create_pluggable_database

Credential Verbs


clear_credential
clear_default_pref_credential
clear_monitoring_credential
clear_preferred_credential
create_credential_set
create_named_credential
delete_credential_set
delete_named_credential
get_credtype_metadata
get_duplicate_credential
get_named_credential
list_named_credentials
merge_credentials
modify_named_credential
set_credential
set_default_pref_cred
set_monitoring_credential
set_preferred_credential
show_credential_set_info
show_credential_type_info
test_named_credential
update_host_password
update_monitoring_creds_from_agent
update_password
update_target_password

Credential Verbs - Oracle Database


update_db_password

Database Machine Targets Customer Support Identifier (CSI) Assignment Verbs


assign_csi_for_dbmachine_targets

DBaaS Verbs


See "EM CLI for Administrator Flows" in the Enterprise Manager Cloud Administration Guide.

Deployment Procedure Verbs


confirm_instance
delete_instance
describe_procedure_input
get_executions
get_instance_data
get_instance_status
get_instances
get_procedure_types
get_procedure_xml
get_procedures
get_retry_arguments
ignore_instance
reschedule_instance
resume_instance
retry_instance
save_procedure_input
stop_instance
submit_procedure
suspend_instance
update_and_retry_step
update_procedure_input

Diagchecks Verbs


apply_diagcheck_exclude
define_diagcheck_exclude
diagchecks_deploy_status
diagchecks_deploy_tglist
list_diagcheck_exclusions
list_diagchecks
undeploy_diagchecks
update_diagchecks

Diagnostic Snapshots Verbs


create_diag_snapshot
delete_diag_snapshot

Discover and Push to Agents Verbs


delete_siebel
discover_coherence
discover_fa
discover_gf
discover_siebel
discover_wls
generate_discovery_input

Execute Command Verbs


execute_hostcmd
execute_sql

Event and Incident Verbs


clear_problem
create_resolution_state
delete_resolution_state
get_resolution_states
modify_incident_rule
modify_resolution_state
publish_event

Fusion Middleware Provisioning Verbs


create_fmw_domain_profile
create_fmw_home_profile
create_inst_media_profile

Group Verbs


create_group
delete_group
get_group_members
get_groups
modify_group

Installation Verbs


get_agentimage
get_agentimage_rpm
get_supported_platforms

Job Verbs


create_job
create_job_from_library
create_library_job
delete_job
delete_library_job
describe_job
describe_job_type
describe_library_job
get_job_execution_detail
get_jobs
get_job_types
resume_job
retry_job
stop_job
submit_job
suspend_job

Licensing Verbs


grant_bipublisher_roles
grant_license_with_validation
revoke_license_no_validation
revoke_license_with_validation

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
metric_control
sync_alerts

Metric Extension Verbs


export_metric_extension
get_unused_metric_extensions
import_metric_extension
publish_metric_extension
save_metric_extension_draft

Metric Verbs


get_threshold
modify_threshold

Monitoring Template Verbs


apply_template
export_template
import_template
list_templates
modify_collection_schedule

Notification Verbs


subscribeto_rule

OMS Configuration Properties


get_oms_config_property
get_oms_logging_property
list_oms_config_properties
list_oms_logging_properties
list_trace
set_logging_property
set_oms_property
trace

OMS Plug-in Deployment Verbs


deploy_plugin_on_agent
deploy_plugin_on_server
get_ext_dev_kit
get_plugin_deployment_status
list_plugins_on_agent
undeploy_plugin_from_agent
undeploy_plugin_from_server

Package Fusion Application Problem Verbs


package_fa_problem

Patch Verbs


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan
upload_patches

Ping Subsytem Verbs


set_reverse_ping_interval

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

Reconfig Job Verbs


convert_to_cluster_database

Redundancy Group Verbs


create_red_group
create_redundancy_group
modify_red_group
modify_redundancy_group
view_redundancy_group

Refresh Coherence Verbs


refresh_coherence

Refresh WLS Domain Verbs


refresh_wls

Report Import/Export Verbs


export_report
get_reports
import_report

Resource Verbs


list

Secure Communication Verbs


get_ca_info
secure_agents

Self Update Verbs


apply_update
download_update
export_update
get_update_status
import_update
import_update_catalog
remove_update
verify_updates

Services Verbs


add_beacon
apply_template_tests
assign_test_to_target
change_service_system_assoc
compare_sla
create_aggregate_service
create_service
delete_metric_promotion
delete_sla
delete_test
delete_test_threshold
disable_sla
disable_test
download_ats_test_databank_file
download_ats_test_zip
edit_sl_rule
enable_sla
enable_test
export_sla
extract_template_tests
get_aggregate_service_info
get_aggregate_service_members
get_test_thresholds
import_appreplay_workload
import_sla
list_sla
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
upload_ats_test_databank_file

SiteGuard Verbs


add_siteguard_script_hosts
create_operation_plan
create_siteguard_configuration
create_siteguard_credential_association
create_siteguard_script
delete_operation_plan
delete_siteguard_configuration
delete_siteguard_credential_association
delete_siteguard_script
delete_siteguard_script_hosts
get_operation_plan_details
get_operation_plans
get_siteguard_credential_association
get_siteguard_script_hosts
get_siteguard_scripts
run_prechecks
submit_operation_plan
update_operation_plan
update_siteguard_configuration
update_siteguard_credential_association
update_siteguard_script

Software Library Verbs


add_swlib_storage_location
create_swlib_entity
create_swlib_folder
list_swlib_entities
list_swlib_entity_subtypes
list_swlib_entity_types
list_swlib_folders
list_swlib_storage_locations
refer_swlib_entity_files
reimport_swlib_metadata
remove_swlib_storage_location
stage_swlib_entity_files
switch_swlib_oms_agent_storage
update_swlib_entity
upload_swlib_entity_files
verify_swlib

System Verbs


create_system
delete_system
get_system_members
modify_system

Target Data Verbs


add_target
add_target_property
change_target_owner
delete_target
get_target_properties
get_targets
list_target_property_names
migrate_to_lifecycle_status
modify_lifecycle_stage_name
modify_target
relocate_targets
remove_target_property
rename_target
set_standby_agent
set_target_property_value

User-defined Metrics (UDM) Migration Verbs


abort_udmmig_session
analyze_unconverted_udms
create_udmmig_session
list_unconverted_udms
udmmig_list_matches
udmmig_request_udmdelete
udmmig_retry_deploys
udmmig_session_details
udmmig_submit_metricpicks
udmmig_summary
udmmig_update_incrules

Upgrade Database Job Verbs


upgrade_database

User Administration Verbs


create_role
create_user
delete_role
delete_user
get_supported_privileges
grant_privs
grant_roles
modify_role
modify_user
revoke_privs
revoke_roles

User Session Administration Verbs


list_active_sessions

4.2 -input_file, -separator, and -subseparator Syntax Guidelines

4.2.1 input_file Syntax

This option enables you to provide an argument to be specified in a file. For example:

emcli xyzverb -input_file="arg1:file1.txt" -input_file="arg2:file2.txt" 

This string literally translates to:

emcli xyzverb -arg1=<contents of file1.txt> -arg2=<contents of file2.txt>
emcli xyzverb -input_file="name:/tmp/b1.txt"  -input_file="type:/tmp/b2.txt" 
-input_file="bcnName:/tmp/b3.txt" 

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"

4.2.2 input_file Sample

<?xml version = '1.0' encoding = 'UTF-8'?> <transaction-template template_type="aggregate_service" xmlns="template"> 
<variables> 
<variable name="HOST1" value="myhost.in.domain.com"/> 
<variable name="PORT1" value="14513"/> 
<variable name="PROTOCOL1" value="https"/> 
</variables> 
<transactions> 
<mgmt_bcn_transaction> 
<mgmt_bcn_txn_with_props> 
<mgmt_bcn_txn description="Test for checking the availability of EM Console/Website" is_representative="true" name="EM Console Service Test" monitoring="true" txn_type="HTTP"/> 
<properties> 
<property name="readTimeout" num_value="120000.0" prop_type="2" encrypt="false"/> 
<property name="certValidationMode" string_value="1" prop_type="1" encrypt="false"/> 
<property name="maxDownloadSize" num_value="1.0E8" prop_type="2" encrypt="false"/> 
<property name="sensitiveValuesProtection" string_value="0" prop_type="1" encrypt="false"/> 
<property name="failureStringModes" string_value="regularText" prop_type="1" encrypt="false"/> 
<property name="UserAgent" string_value="Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) OracleEMAgentURLTiming/3.0" prop_type="1" encrypt="false"/> 
<property name="successStringModes" string_value="regularText" prop_type="1" encrypt="false"/> 
<property name="variablesModes" string_value="urlEncode" prop_type="1" encrypt="false"/> 
<property name="content" string_value="0" prop_type="1" encrypt="false"/> 
<property name="AcceptLanguage" string_value="en" prop_type="1" encrypt="false"/> 
<property name="connectionTimeout" num_value="120000.0" prop_type="2" encrypt="false"/> 
<property name="useCache" string_value="yes" prop_type="1" encrypt="false"/> 
<property name="stringValidationMode" string_value="1" prop_type="1" encrypt="false"/> 
<property name="granularity" string_value="transaction" prop_type="1" encrypt="false"/> 
<property name="numThreads" num_value="4.0" prop_type="2" encrypt="false"/> 
<property name="retries" num_value="1.0" prop_type="2" encrypt="false"/> 
<property name="timeout" num_value="300000.0" prop_type="2" encrypt="false"/> 
<property name="retryInterval" num_value="5000.0" prop_type="2" encrypt="false"/> 
</properties>
<per_bcn_properties/>
</mgmt_bcn_txn_with_props>
<steps_defn_with_props>
<mgmt_bcn_step_with_props>
<mgmt_bcn_step step_number="1" name="1.Access Logout page" step_type="HTTP"/>
<properties>
<property name="req_mode" num_value="1.0" prop_type="2" encrypt="false"/>
<property name="http_method" string_value="G" prop_type="1" encrypt="false"/>
<property name="url" string_value="{PROTOCOL1}://{HOST1}:{PORT1}/em/console/logon/logoff?event=load" prop_type="1" encrypt="false"/>
</properties>
</mgmt_bcn_step_with_props>
</steps_defn_with_props>
<stepgroups_defn/>
<txn_thresholds>
<mgmt_bcn_threshold warning_threshold="6000.0" warning_operator="0" critical_threshold="12000.0" critical_operator="0" num_occurrences="1">
<mgmt_bcn_threshold_key metric_name="http_response" metric_column="avg_response_time"/>
</mgmt_bcn_threshold>
<mgmt_bcn_threshold warning_threshold="0.0" warning_operator="1" critical_threshold="0.0" critical_operator="1" num_occurrences="1">
<mgmt_bcn_threshold_key metric_name="http_response" metric_column="status"/>
</mgmt_bcn_threshold>
</txn_thresholds>
<step_thresholds/>
<stepgroup_thresholds/>
</mgmt_bcn_transaction>
</transactions>
</transaction-template>

4.2.3 input_file for Jobs

For most job verbs, you can specify all of the needed properties in a property file. You can also provide a few properties on the command line. Properties set on the command line override values set in the file.

The property file consists of name=value pairs. For example, put the following into myFile.txt:

name=MY JOB 1
    type=OSCommand
    description=this is a test job
    target_list=target1:host
    variable.default_shell_command=ls -l
    schedule.frequency=IMMEDIATE

... then run:

emcli create_job -input_file=property_file:myFile.txt

This creates an OS Command job called "MY JOB 1" using preferred credentials.

Usage of Properties

For the create verbs, all properties set in the file are used. For verbs that act on multiple jobs, like suspend and resume, only "search" properties are used (name, type, targets. and scheduled starting and ending times).

Creating a Property File

The best way to create a property file is to start by describing a job similar to the one you want to create, and/or by describing a job type. This provides a list of which properties are needed by a given job type.

Determining Variables for a Job

Most properties are the same from one job to another. For example:

name, type, description, kind, targetType, cred, schedule notification

The variables needed for a job type change from job to job. Describe a job type to find out which variables it requires.

For example, the following command creates a property file template based on job MYJOB1. This lists the properties set by this job.

emcli describe_job [-verbose] -name=MyJob1 > myPropFile.txt

The following example creates a property file template for an OS Command job. This lists the properties allowed by this job type, including all required and optional variables. Variables marked as deprecated should be avoided.

emcli describe_job_type [-verbose] -type=OSCommand > myPropFile.txt

4.2.4 Overriding the Separator and Subseparator

Not all verbs allow separator and subseparator to be overridden. The semi-colon ( ; ) and colon ( : ) are respectively the default separator and subseparator. The separator is used for arguments that take multiple values, and subseparator is used when the value itself has multiple values. You can override either one of them or both.

The syntax is:

separator=<option_for_which_separator_has_to_be_applied>="separator_value"

As an example of using the separator and subseperator to create a group containing database2 and database3, the command could be:

emcli create_group -name="tstgrp" -add_targets="database2:oracle_database;
database3:oracle_database"

Using this command as the basis for modification, the following examples show overrides of separator and/or subseperator:

emcli create_group -name="tstgrp1" -add_targets="database2:oracle_database,
database3:oracle_database" -separator=add_targets="," 

emcli create_group -name="tstgrp2" -add_targets="database2&oracle_database,
database3&oracle_database" -separator=add_targets="," -subseparator=add_targets="&" 

emcli create_group -name="tstgrp3" -add_targets="database2&oracle_database;
database3&oracle_database" -subseparator=add_targets="&" 

EM CLI Verbs

The following sections provide descriptions, formats, and options for all EM CLI verbs. Some of the verbs also contain one or more examples.


abort_udmmig_session

Aborts the migration of user-defined metrics (UDMs) to metric extensions in a session.

Format

emcli abort_udmmig_session
        -session_id=<sessionId>
        [-input_file=specific_tasks:<complete_path_to_file>]

[ ] indicates that the parameter is optional

Parameters

  • session_id

    Specify the ID that was returned when the session was created, or from the output of udmmig_summary.

  • input_file

    Points at a file name that contains a target UDM, one per line in the following format:

    <targetType>,<targetName>,<collection name>
    

    Use targetType=Template to indicate a template. Use * for the collection name to abort all UDMs for a target. The input file should be in UTF-8 format.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Examples

Example 1

The following example aborts the specified migration session. The UDM is returned to the unconverted list.

emcli abort_udmmig_session -session_id=<sessionId>

Example 2

The following example partially aborts the migration session by removing the specified UDMs from the session.

emcli abort_udmmig_session -session_id=<sessionId> -input_file=specific_tasks:<complete file path>

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]

[ ] indicates that the parameter is optional

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • bcnName

    Beacon name to add.

  • dontSetKey

    Indicates the added beacon is not automatically a key beacon. Only use this option if you do not want the beacon to participate in the availability calculation of the service and tests.

Example

The following example adds MyBeacon as a key beacon to the MyTarget service target of type generic_service.

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

add_blackout_reason

Adds a new blackout reason. Only Super Administrators can perform this action.

Format

emcli add_blackout_reason -name="<blackout reason>"

Example

The following example adds the blackout reason "Testing Purposes."

emcli add_blackout_reason -name="Testing Purposes"

add_chargeback_entity

Adds the given entity to Chargeback.

Format

add_chargeback_entity 
     -entity_name="eName"
     -entity_type="eType" 
     -usage_mode="uMode" 

Parameters

  • entity_name

    Name of the entity to be added to Chargeback.

  • entity_type

    Type of entity to be added to Chargeback.

  • usage_mode

    Usage mode by which it should be added to Chargeback. You can see the usage modes for a particular entity type by entering list_chargeback_entity_types -entity_type .

See Also


assign_charge_plan
assign_cost_center
list_chargeback_entities
list_chargeback_entity_types
list_charge_plans
list_cost_centers
remove_chargeback_entity
unassign_charge_plan
unassign_cost_center

add_siteguard_script_hosts

Adds a host to the Site Guard configuration scripts.

Format

emcli add_siteguard_script_hosts
      -script_id=<script_id>
      -host_name=<name1;name2;...>

Parameters

  • script_id

    ID associated with the script.

  • host_name

    Name of the host where this script will be run. You can specify more than one host name.

Examples

emcli add_siteguard_script_hosts
      –script_id=”10”
      –host_name ="host1.domain.com"

See Also

create_siteguard_script

get_siteguard_script_hosts


add_swlib_storage_location

Adds a storage location in the software library.

Format

emcli add_swlib_storage_location 
        -name="location_name" 
        -path="location_path" 
        [-type="OmsShared|OmsAgent|Http|Nfs|ExtAgent"] 
        [-host="hostname"] 
        [-credential_set_name="setname"] | [-credential_name="name" - credential_           owner="owner"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the storage location.

  • path

    Path of the storage location, which can be a file system path or a URL, depending on the storage type chosen.

  • type

    Type of storage location. The default is OmsShared.

  • host

    Target name of the host where the path for the storage location exists. This parameter is required for storage types OmsAgent, Nfs, and ExtAgent. For the Nfs storage type, the host is not required to be a target in Enterprise Manager.

  • credential_set_name

    Set name of the preferred credential stored in the repository for the host target. This is a required parameter for storage types OmsAgent and ExtAgent. The set names can be one of the following:

    • HostCredsNormal: Default unprivileged credential set

    • HostCredsPriv: Privileged credential set

  • credential_name

    Name of a named credential stored in the repository. This parameter is required for storage types OmsAgent and ExtAgent. This parameter must be specified together with the credential_owner parameter.

  • credential_owner

    Owner of a named credential stored in the repository. This parameter is required for storage types OmsAgent and ExtAgent. This parameter must be specified together with the credential_name parameter.

Examples

Example 1

The following example adds an OMS shared file system storage location named myOMSSharedLocation for the path /u01/swlib .

emcli add_swlib_storage_location 
        -name="myOMSSharedLocation" 
        -path="/u01/swlib"

Example 2

The following example adds an OMS Agent File system storage location named myOMSAgtLocation for the path /u01/swlib' on host 'fs1.us.acme.com. The named credential MyAcmeCreds owned by ACME_USER is used for reading/writing files from this location.

emcli add_swlib_storage_location 
        -name="myOMSAgtLocation" 
        -path="/u01/swlib"
        -type="OmsAgent"
        -host="fs1.us.acme.com"  
        -credential_name="MyAcmeCreds"
        -credential_owner="ACME_USER"

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.

Command-Line 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;..."]
      [-force=true|false]
      [-timeout="time_in_seconds"]

[ ] indicates that the parameter is optional

Scripting and Interactive Format

add_target
      (name="name"
      ,type="type"
      ,host="hostname"
      [,properties="pname1:pval1;pname2:pval2;..."]
      [,separator=properties="sep_string"]
      [,subseparator=properties="subsep_string"]
      [,credentials="userpropname:username;pwdpropname:password;..."]
      [,input_file="parameter_tag:file_path"]
      [,display_name="display_name"]
      [,groups="groupname1:grouptype1;groupname2:grouptype2;..."]
      [,timezone_region="gmt_offset"]
      [,monitor_mode="monitor_mode"]
      [,instances="rac_database_instance_target_name1:target_type1;..."]
      [,force=true|false]
      [,timeout="time_in_seconds"])

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks.

  • type

    Target type. Standard target types include: host, oracle_database, oracle_apache, oracle_listener, and oracle_emd. To see all available target types available for your environment, check the $AGENT_HOME/sysman/admin/metadata directory. A metadata file (XML) exists for each target type.

  • host

    Network name of the system running the Management Agent that is collecting data for this target instance.

  • properties

    Name-value pair (that is, prop_name:prop_value) list of properties for the target instance. The "name"(s) are identified in the target-type metadata definition. They must appear exactly as they are defined in this file. Metadata files are located in $AGENT_HOME/sysman/admin/metadata.

    Note:

    This verb does not support setting global target properties. It is recommended that you use set_target_property_values to set target properties.
  • separator=properties

    Specify a string delimiter to use between name-value pairs for the value of the -properties . The default separator delimiter is ";".

    For more information about the separator parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • subseparator=properties

    Specifies a string delimiter to use between the name and value in each name-value pair for the value of the -properties option. The default subseparator delimiter is ":".

    For more information about the subsepator parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • credentials

    Monitoring credentials (name-value pairs) for the target instance. The "name"(s) are identified in the target-type metadata definition as credential properties. The credentials must be specified exactly as they are defined in the target's metadata file. Metadata files are located in $AGENT_HOME/sysman/admin/metadata.

  • input_file

    Used in conjunction with the -credentials option, this enables you to store specific target monitoring credential values, such as passwords, in a separate file. The -input_file specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific monitoring credentials of the -credentials option. The tag must not contain colons ( : ) or semi-colons ( ; ).

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • display_name

    Target name displayed in the Enterprise Manager Cloud Control console.

  • groups

    Name-value pair list of the groups to which this target instance belongs. Follows the format of groupname:grouptype;groupname2:grouptype2.

  • timezone_region

    GMT offset for this target instance. (-7 or -04:00 are acceptable formats.)

  • monitor_mode

    Either 0, 1, or 2. The default is 0. 1 specifies OMS mediated monitoring, and 2 specifies Agent mediated monitoring.

  • instances

    Name-value pair list of RAC database instances that the RAC database target has.

  • force

    Forces the target to be added even if the target with the same name exists. Updates the properties of the target with your latest input.

  • timeout

    Time in seconds for the command to wait to add the target to the Agent. The default is 10 minutes.

Examples

The following two examples add an oracle_database target with the name "database." Note how the credentials are specified. The "name"(s) in the name-value pairs come from the oracle_database metadata file. They must appear exactly as they are named in that file. This also applies for the property "name"(s). The examples use the base minimum of required credentials and properties for the database target.

Example 1 - Command-Line

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

Example 2 - Scripting and Interactive

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

The following two examples add an oracle_database target with the name "database." The examples illustrate the use of the input_file to camouflage the credentials. The password is actually in a file named at_pwd_file. The input_file argument is used to replace PWD_FILE with the contents of the at_pwd_file in the credentials argument.

Example 3 - Command-Line

emcli add_target
      -name="database"
      -type="oracle_database"
      -host="myhost.us.example.com"
      -credentials="UserName:dbsnmp;password:PWD_FILE;Role:Normal"
      -properties="SID:semcli;Port:15091;OracleHome:/oracle;        MachineName:smpamp-example.com"
      -input_file="PWD_FILE:/emcli_dir/pwdfiles/at_pwd_file"

Example 4 - Scripting and Interactive

add_target
      (name="database"
      ,type="oracle_database"
      ,host="myhost.us.example.com"
      ,credentials="UserName:dbsnmp;password:PWD_FILE;Role:Normal"
      ,properties="SID:semcli;Port:15091;OracleHome:/oracle;         MachineName:smpamp-example.com"
      ,input_file="PWD_FILE:/emcli_dir/pwdfiles/at_pwd_file")

The following two examples illustrate how to add a RAC database with given installed RAC database instances and clusterware. The examples add a rac_database target with the name cluster_database and the cluster name newdb_cluster. A RAC instance is picked up among instances on the given host. This verb should be called after database instances and clusterwares have been installed. monitor_mode is set to 1, because a RAC database is a multi-agent target.

Example 4 - Command-Line

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

Example 5 - Scripting and Interactive

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

The following two examples add an oracle_listener target with the name mylist. The LsnrName is the name of the listener as configured in the listener.ora file, and ListenerOraDir is the directory containing the listener.ora file.

Example 6 - Command-Line

emcli add_target
      -name="mylist"
      -type="oracle_listener"
      -host="myhost.example.com"
      -properties="LsnrName:LISTENER;ListenerOraDir:/oracle/lsnr;        Port:15091;OracleHome:/oracle;Machine:smpamp-sun1.us

Example 7 - Scripting and Interactive

add_target
      (name="mylist"
      ,type="oracle_listener"
      ,host="myhost.example.com"
      ,properties="LsnrName:LISTENER;ListenerOraDir:/oracle/lsnr;         Port:15091;OracleHome:/oracle;Machine:smpamp-sun1.us)

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"

Parameters

  • target_type

    Target type for which this property needs to be added. To add this property to all existing target types, you can specify a "*" wildcard character.

  • property

    Name of the property to be created for this target type. Property names are case-sensitive. The property name cannot be the same as the following Oracle-provided target property names (in English):

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

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"

add_virtual_platform

Adds Oracle Virtual Platform(s) to remotely monitor Xen-based Hypervisor(s). The associated Oracle Server and Oracle Virtual Server running on the Hypervisor will is also added.

You can add multiple Hypervisors at the same time. The command returns the name and the execution identifier of the job submitted to add the target(s).

To delete an Oracle Virtual Platform and its related targets, use the delete_target verb.

Format

emcli add_virtual_platform 
       -name="host_name/IP_address_or_list_from_an_input_file"
       -agent="agent_target_name"
       [-failover_agent="failover_agent_target_name"]
       -credentials="property_name1:property_value1;property_name2:            property_value2;..."
               [-wait_for_completion=true|false]
               [-wait_for_completion_timeout=<time_in_minutes>]
       [-separator=credentials="separator_for_key_value_pairs"]
               [-subseparator=credentials="separator_for_key_value_pair"]
       [-input_file="FILE:file_path_or_name:FILE"]

[ ] indicates that the parameter is optional

Parameters

  • name

    IP address or host name of the Xen-based Hypervisor being added as an Oracle Virtual Platform in Enterprise Manager. There are two ways to provide this value. For only one target, you can directly pass this value at the command line with the name of the Host or the IP address. For multiple values, you can use the "-input_file" parameter and list the host names, IP addresses, or an IP address range from a file by passing the name of the input file. A new line is used to delimit the host names or the IP addresses. You can specify the host name of a machine, an IP address, or an IP address range on each line.

    See the examples for details.

  • agent

    Target name of the primary agent used to monitor the Oracle Virtual Platform(s) and related targets.

  • failover_agent

    Target name of the failover agent used to monitor the Oracle Virtual Platform(s) and related targets.

  • credentials

    Monitoring credentials (name-value pairs) for the target instance. The "names" are defined in the target type metadata definition as credential properties. Metadata files are located at $AGENT_HOME/sysman/admin/metadata.

    See the examples for details on various options.

  • wait_for_completion

    Flag to indicate if the CLI is going to wait for the submitted job to finish. The default value is false. If the value is true, the progress of the job is printed on the command line as and when the addition of Oracle Virtual Platform(s) Succeeds/Fails.

  • wait_for_completion_timeout

    Time in minutes after which CLI stops waiting for the job to finish. This parameter is honored only if the value for parameter wait_for_completion is true. A negative or zero value does not wait for the job to finish.

    See the examples for details.

  • separator=credentials

    Custom separator for the credential key value pairs. Specify a string delimiter to use between name-value pairs for the values of the -credentials option. The default separator delimiter is ";".

    For more information about the separator parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • subseparator=credentials

    Custom separator for a key value pair. Specify a string delimiter to use between name and value in each name-value pair for the values of the -credentials option. The default separator delimiter is ":".

    For more information about the subseparator parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file

    Optionally use in conjunction with the -credentials option. You can use this option to set specific target monitoring credential values, such as passwords or SSH keys, in a separate file.

    This option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific -credentials property values.

Examples

Example 1

The following example adds an Oracle Virtual Platform with root user host credentials. The value of the property "OVSUsername" is used for the user name, and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are collected(true) or not(false) when monitoring. The password is passed at the command line.

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838        -credentials='type:DMOvsBasicCreds;PrivilegeType:none;privilegedUser:true;           OVSUsername:root;OVSPassword:mypassword'

Example 2

The following example adds an Oracle Virtual Platform with root user host credentials. The value of the property "OVSUsername" is used for the user name, and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are not collected(true) or not(false) when monitoring. The password of the root user is read from the input file "password.txt".

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838
      -credentials='type:DMOvsBasicCreds;PrivilegeType:none;privilegedUser:true;
          OVSUsername:root;OVSPassword:PWD_FILE'
      -input_file='PWD_FILE:password.txt'

Example 3

The following example adds multiple Oracle virtual platforms with root user host credentials. You can specify multiple host names, IP addresses, or an IP address range in the host names list file delimited by a new line.

NOTE: In case of multiple target additions, the same credentials are used across all Hypervisors being added.

Host names list file example:

example1.com
192.168.1.0
10.172.10.2-254



emcli add_virtual_platform 
      -input_file='name:hostnames.txt' 
      -agent=example.com:1838
      -credentials='type:DMOvsBasicCreds;PrivilegeType:none;privilegedUser:true;
           OVSUsername:root;OVSPassword:mypassword'

Example 4

The following example adds an Oracle Virtual Platform with Unix Sudo user host credentials. The value of the property "PrivilegeCommand" is used to execute the Sudo command. %RUN_AS% and %COMMAND% are replaced with the user and the command to be executed by the Sudo command. The value of the property "EnablePseudoTerminal" indicates if Sudo requires (true) a tty terminal or not (false). The password is passed at the command line.

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838
      -credentials='type:DMOvsBasicCreds;PrivilegeType:sudo;privilegedUser:true;
          RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS%%COMMAND%;
          EnablePseudoTerminal:false;OVSUsername:root;OVSPassword:mypassword'

Example 5

The following example adds an Oracle Virtual Platform with Unix PowerBroker user host credentials. The value of the property "PrivilegeCommand" is used to execute the PowerBroker command. %RUN_AS% and %COMMAND% are replaced by you and the command to be executed by PowerBroker. The value of the property "PowerBrokerProfile" is used as the PowerBroker profile. The value of the property "PowerBrokerPasswordPrompt" is used as the PowerBroker password prompt. The password is passed at the command line.

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838
      -credentials='type:DMOvsBasicCreds;PrivilegeType:powerbroker;RunAs:root;
           PrivilegeCommand:/usr/bin/pbrun -l -u %RUN_AS%            %COMMAND%;PowerBrokerProfile:profile;             PowerBrokerPasswordPrompt:myprompt;
            privilegedUser:true;OVSUsername:root;OVSPassword:mypassword'

Example 6

The following example adds an Oracle Virtual Platform with a Unix Sudo user who requires SSH key Passphraseless-based authentication. The SSH private key, SSH public key, and password are read from input files.

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838   
      -credentials='type:DMOvsSshKeyCreds;PrivilegeType:sudo;privilegedUser:true;
            RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
            EnablePseudoTerminal:false;SshPrivateKey:PRIVATE_KEY;
            SshPublicKey:PUBLIC_KEY;OVSUsername:sudoer1;OVSPassword:PWD_FILE' 
      -input_file='PRIVATE_KEY:id_dsa' 
      -input_file='PUBLIC_KEY:id_dsa.pub' 
      -input_file='PWD_FILE:password'

Example 7

The following example adds an Oracle Virtual Platform with a Unix Sudo user who requires SSH key Passphrase-based authentication. The SSH private key, SSH public key, and password are read from input files.

emcli add_virtual_platform 
      -name=example.com -agent=example.com:1838
      -credentials='type:DMOvsSshKeyCreds;PrivilegeType:sudo;privilegedUser:true;
           RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
           EnablePseudoTerminal:false;PassPhrase:welcome1;
           SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;OVSUsername:sudoer1;
           OVSPassword:PWD_FILE' 
      -input_file='PRIVATE_KEY:id_dsa' 
      -input_file='PUBLIC_KEY:id_dsa.pub' 
      -input_file='PWD_FILE:password'

Example 8

The following example adds an Oracle Virtual Platform with a Unix PowerBroker user who requires SSH key Passphraseless based authentication. The SSH private key, SSH public key, and password are read from input files.

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838
      -credentials='type:DMOvsSshKeyCreds;PrivilegeType:powerbroker;
           privilegedUser:true;RunAs:root;PrivilegeCommand:            /usr/bin/pbrun -l -u %RUN_AS% %COMMAND%;
           PowerBrokerProfile:profile;PowerBrokerPasswordPrompt:myprompt;
           SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;
           OVSUsername:myuser;OVSPassword:PWD_FILE' 
      -input_file='PRIVATE_KEY:id_dsa' 
      -input_file='PUBLIC_KEY:id_dsa.pub' 
      -input_file='PWD_FILE:password'

Example 9

The following example adds an Oracle Virtual Platform with non-privileged user host credentials. The virtualization metrics for the added target will not be monitored. The password is specified at the prompt.

emcli add_virtual_platform 
      -name=example.com 
      -agent=example.com:1838 
      -credentials='type:DMOvsBasicCreds;privilegedUser:false;
           OVSUsername:simpleton;OVSPassword:password'

analyze_unconverted_udms

Analyzes UDMs and lists unique UDMs, any possible matches, and templates that can apply these matching metric extensions.

Format

emcli analyze_unconverted_udms 
      [-session_id=<sessionId>]

[ ] indicates that the parameter is optional

Parameters

  • session_id

    ID of a session to be analyzed. Not specifying a session ID creates an analysis session that contains all unconverted UDMs. You can specify this session ID in future invocations to generate a fresh analysis.

Examples

Example 1

The following example lists matches for all unconverted UDMs in existing metric extensions.

emcli analyze_unconverted_udms 

Example 2

The following example lists matches for all unconverted UDMs in the specified migration session.

emcli list_unconverted_udms -session_id=<sessionId>

apply_diagcheck_exclude

Applies a diagnostic check exclusion to a set of target instances. You can exclude certain diagnostic checks by defining an exclusion name. This rule is applied when all diagnostic checks are evaluated for the particular target type so that the checks specified in the rule are excluded.

Format

emcli apply_diagcheck_exclude
        -target_type="type"
        -exclude_name="name"
        [-target_name="target_name" ]*

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Type of target.

  • exclude_name

    Name to use for the exclusion. To create the exclude_name, use the define_diagcheck_exclude verb.

  • target_name

    Target names to apply the exclusion to.


apply_privilege_delegation_setting

Activates Sudo or PowerBroker settings for specified targets.

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

[ ] indicates that the parameter is optional

Scripting and Interactive Format

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

[ ] indicates that the parameter is optional

Parameters

  • setting_name

    Name of the setting you want to apply.

  • target_names

    List of target names. The newly submitted setting applies to this list of Enterprise Manager targets.

    • All targets must be of the same type.

    • The target list must not contain more than one element if the element's target type is "group."

    • The group referenced above should have at least one host target.

  • target_type

    Type of targets to which the setting is applied. Valid target types are "host" or "composite" (group).

  • input_file

    Path of the file that has target names. This enables you to pass targets in a separate file. The file cannot contain any colons ( : ) or semi-colons ( ; ).

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • force

    If yes, the operation continues and ignores any invalid targets. The default is no.

Examples

The following examples apply a privilege setting named sudo_setting. This setting applies to targets of type host, and it is being applied to host1, host2, and so forth.

Example 1 - Command-Line

emcli apply_privilege_delegation_setting
      -setting_name=sudo_setting
      -target_type=host
      -target_names="host1;host2;"

Example 2 - Scripting and Interactive

apply_privilege_delegation_setting
      (setting_name="sudo_setting"
      ,target_type="host"
      ,target_names="host1;host2")

The following examples apply a privilege setting named sudo_setting. This setting applies to targets of type host, and it is being applied to host1, host2, and so forth. The force flag indicates that the setting is applied to all valid targets, and invalid targets are ignored.

Example 3 - Command-Line

emcli apply_privilege_delegation_setting
      -setting_name=sudo_setting
      -target_type=host
      -target_names="host1;host2;"
      -force=yes

Example 4 - Scripting and Interactive

apply_privilege_delegation_setting
      (setting_name="sudo_setting", 
       target_type="host", 
       target_names="host1;host2", force="yes")

The following examples apply a privilege setting named sudo_setting. This setting applies to targets of type host, and host names are selected from /home/jdoe/file.txt (one host per line). The force flag indicates that the setting is applied to all valid targets, and invalid targets are ignored.

Example 5 - Command-Line

emcli apply_privilege_delegation_setting
      -setting_name=sudo_setting
      -target_type=host
      -input_file="FILE:/home/jdoe/file.txt"
      -force=yes

Example 6 - Scripting and Interactive

apply_privilege_delegation_setting
      (setting_name="sudo_setting"
      ,target_type="host"
      ,input_file="FILE:/home/jdoe/file.txt"
      ,force="yes")

apply_template

Applies a monitoring 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"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Template name as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks.

  • targets

    The targets should be specified in the following sequence:

    TargetName1:TargetType1;TargetName2:TargetType2

    For example:

    db1:oracle_database;my db group:composite

    A semi-colon is the target separator. Ideally, non-composite targets should be of the target type applicable to the template. If not, the template is not applied to the indicated target. For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable.

  • copy_flags

    This applies only for metrics with multiple thresholds.

    '0' indicates: Apply threshold settings for key values common to the template and target.

    '1' indicates: Remove key value threshold settings in the target and replace them with key value threshold settings from the template.

    '2' indicates: Apply threshold settings for all key values defined in the template. The default is '0'.

  • replace_metrics

    0 indicates that the thresholds of the metrics not included in the template but available in the target will not be changed. This is the default value. 1 indicates that the thresholds of the metrics present in the target, but not in the template, will be set to NULL. That is, such metrics in the target will not be monitored and therefore, no alert will be raised for them.

  • input_file

    You can use this parameter to specify the location of a file, which contains the credentials to be used for the User Defined Metrics (UDMs) if the template contains any UDMs. file_name actually refers to the name of the file along with the path of the location, which contains the credentials applicable for the UDMs. For example:

    emcli apply_template -name="template1"  -targets="mydb1:oracle_database" 
      -input_file= "FILE1:/usr/template/apply_udm_credentials.txt"
    

    This example applies a monitoring template named "template1" to target mydb1 of type oracle_database, and the credentials needed for the UDMs are accessed from the file "/usr/template/apply_udm_credentials.txt".

    The contents of the file apply_udm_credentials.txt should be in one of the following formats:

    • All UDMs use the same credentials for all targets. For example:

      credListType:all;
      usr_name:joe1;passwrd:pass1;
      
    • Each UDM uses its own credentials for all targets. For example:

      credListType:perUDM;
      udm_name:UDM1;usr_name:joe1;passwrd:pass1;
      udm_name:UDM2;usr_name:joe2;passwrd:pass2;
      
    • Each UDM uses different credentials for different targets. For example:

      credListType:perTargetperUDM;
      udm_name:UDM1;tgt_name:TNAME1;usr_name:joe1;passwrd:pass1;
      udm_name:UDM1;tgt_name:TNAME2;usr_name:joe2;passwrd:pass2;
      udm_name:UDM2;tgt_name:TNAME1;usr_name:joe3;passwrd:pass3;
      udm_name:UDM2;tgt_name:TNAME2;usr_name:joe4;passwrd:pass4;
      

    It is important to specify the "credListType" in every input text file that you specify.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

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 is not specified, the default ("Apply threshold settings for monitored objects common to both template and target") is meant.

emcli apply_template -name="my_db_template"
          -targets="db1:oracle_database;my_db_group:composite"

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.

For composite targets, the template is applied only to member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as 1, the threshold settings on the target will be duplicated.

emcli apply_template -name="my_db_template"
          -targets="db1:oracle_database;my_db_group:composite"
          -copy_flags="1"

Example 3

The following example applies a monitoring template named my_db_template. This template is applicable to targets of type oracle_database, and it is being applied to db1 of type oracle_database and my_db_group of type composite.

For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as "2", the threshold settings on the target are duplicated, but the keys present only in the target and not present in the template are retained in the target, and their settings are not affected.

emcli apply_template -name="my_db_template"
          -targets="db1:oracle_database;my_db_group:composite"
          -copy_flags="2"

Example 4

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"

Example 5

The following example applies the monitoring template named my_db_template. This template is applicable to targets of type oracle_database. This command applies this template to two targets: target db1 of type oracle_database and target my_db_group of type composite.

For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as "1", the template is superimposed on the target. All keys in the template are copied to the target, and any extra keys present in the target are deleted. The credentials needed for the UDMs are present in file /usr/user/db_credentials.txt.

The replace_metrics flag set to 1 denotes that the thresholds of the metrics present in the target, but not in the template, are set to NULL. That is, these metrics in the target are not monitored, and therefore, no alert is raised for them.

emcli apply_template -name="my_db_template"
          -targets="db1:oracle_database;my_db_group:composite"
          -copy_flags="1" -replace_metrics="1" -input_file=             "FILE1:/usr/user/db_credentials.txt"

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>]
      [-input_file=atsBundleZip:<ats_bundle_zip_filename>]
      [-useBundleDatabankFile]
      [-useFirstRowValues]
      [-overwriteExisting=all | none | <test1>:<type1>;<test2>:<type2>;...]
      [-encryption_key=key]
      [-swlibURN=<URN_for_swlib_entity>] 
      [-swlibPath=<Path_for_swlib_entity>] 

[ ] indicates that the parameter is optional

Parameters

  • targetName

    Target name.

  • targetType

    Target type.

  • input_file=template

    Name of the input file containing the test definitions.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=variables

    Name of the input file containing the variable definitions. If this attribute is not specified, the variables are extracted from the same file containing the test definitions.

    The variables file format is as follows:

    <variables xmlns="template">
    <variable name="<name1>" value="<value1>"/>
    <variable name="<name2>" value="<value2>"/>
    ...
    </variables>
    

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=atsBundleZip

    Name of the ATS bundle zip defined in the template.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • useBundleDatabankFile

    If you specify this parameter, the bundle databank files are used.

  • useFirstRowValues

    If you specify this parameter, the first row values are used.

  • overwriteExisting

    Specifies which tests should be overwritten in case they already exist on the target. The possible values are:

    1. 'none' (default): None of the existing tests on the target will be overwritten.

    2. 'all': If a test with the same name exists on the target, it will be overwritten with the test definition specified in the template file.

    3. <test1>:<type1>;<test2>:<type2>;...: If any of the tests with names <test1>, <test2>, and so forth exist on the target, they are overwritten with the definition in the template file.

  • encryption_key

    Optional key to decrypt the file contents. This key should be the same as the one used to encrypt the file.

  • swlibURN

    Loads the software library entity through an URN. The respective entity data such as OATZ zip file and Zip File Name will be associated to the new service test. Either this parameter or the -swlibPath parameter are required to associate the OATS zip file to the service test.

  • swlibPath

    Loads the software library entity through an entity path. The respective entity data such as OATZ zip file and Zip File Name will be associated to the new service test. Either this parameter or the -swlibURN parameter are required to associate the OATS zip file to the service test.

Examples

You must have the following privileges to perform these examples:

  • Operator privilege on the target.

  • Operator privilege on all beacons currently monitoring the target. Alternatively, you must have the "use any beacon" privilege.

Example 1

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'

Example 2

The following example applies the test definitions contained in file my_template.xml into the Web Application target my_target using the variable values specified in file my_variables.xml. If any tests in the target have the same name as tests specified in the template file, they are overwritten.

emcli apply_template_tests
          -targetName='my_target' -targetType='website' 
          -input_file=template:'my_template.xml' -input_file=variables:             'my_variables.xml' 
          -overwriteExisting='all' 

apply_update

Applies an update.

Format

emcli apply_update 
        -id="internal id" 

Parameters

  • id

    Internal identification for the update to be applied.

Examples

The following example submits a job to apply an update, and prints the job execution ID upon submission.

emcli apply_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB"

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

Format

emcli argfile <file_name>
      [-delim=<delimiter_string>]

[ ] indicates that the parameter is optional

Parameters

  • delim

    String used as a delimiter between two verbs in the argument file. The default delimiter is a newline character.


assign_charge_plan

Assigns a charge plan to the given entity.

Format

assign_charge_plan 
      -entity_name="eName" 
      -entity_type="eType" 
      -plan_name="pName" 
      -[entity_guid="entity_guid"]

[ ] indicates that the parameter is optional

Parameters

  • entity_name

    Name of the entity for which the charge plan is to be assigned.

  • entity_type

    Type of entity for which the charge plan is to be assigned.

  • plan_name

    Name of the charge plan to be assigned.

  • entity_guid

    guid of the entity to be added to Chargeback.

    When more than one entity is active in Chargeback with the given entity name and entity type, the command lists all such entities with additional details such as creation date, parent entity name, entity guid, and so forth to choose the correct entity. Select the correct entity from the given list and execute the command again with entity guid as the parameter instead of entity name and entity type.

Example

The following example assigns charge plan "plan1" to "db1", an oracle_database entity.

emcli assign_charge_plan -entity_name="db1" -entity_type="oracle_database" -plan_name="plan1"

assign_cost_center

Assigns the cost center to the given entity.

Format

assign_cost_center 
     -entity_name="eName" 
     -entity_type="eType" 
     -cost_center_name="cName" 
     -[entity_guid="entity guid" ] 

[ ] indicates that the parameter is optional

Parameters

  • entity_name

    Name of the entity for which the cost center is to be assigned.

  • entity_type

    Type of entity for which the cost center is to be assigned.

  • cost_center

    Name of the cost center to be assigned.

  • entity_guid

    guid of the entity in Chargeback.

    When more than one entity is active in Chargeback with the given entity name and entity type, the command lists all such entities with additional details such as creation date, parent entity name, entity guid, and so forth to choose the correct entity. Select the correct entity from the given list and execute the command again with entity guid as the parameter instead of entity name and entity type.

Example

The following example assigns the cost center "cc1" to "db1", an oracle_database entity.

emcli assign_cost_center -entity_name="db1" -entity_type="oracle_database" -cost_center_name="cc1"

assign_csi_for_dbmachine_targets

Assigns or updates the Customer Support Identifier (CSI) for all of the associated Exadata, RAC, and database targets for a database machine name.

Format

emcli assign_csi_for_dbmachine_targets
      -target_name="database_system_name"
      -csi="customer_support_identifier_value"
      -mos_id="my_oracle_support_ID"

Parameters

  • target_name

    Name of the database system target.

  • csi

    Customer Support Identifier (CSI) to be assigned.

  • mos_id

    My Oracle Support (MOS) user ID.

Example

The following example assigns the CSI 1234567 to database system abcdef.company.com.

emcli assign_csi_for_dbmachine_targets 
      -target_name=abcdef.company.com
      -csi=1234567 
      -mos_id=abc@xyz.com

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

[ ] indicates that the parameter is optional

Parameters

  • testtype

    Test-type to be assigned. Should be the internal name; that is, 'HTTP' instead of 'Web Transaction'.

  • type

    Service target type.

  • tgtVersion

    Version of the target type. If not specified, the latest version is used.

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'

bareMetalProvisioning

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 bareMetalProvisioning
       [-input_file="config_properties:input_XML"]

[ ] indicates that the parameter is optional

Parameters

Example

emcli bareMetalProvisioning
       [-input_file="config_properties:input XML"]

XML Example File

<?xml version="1.0"?>
<DeployedImage><ImageName>OracleLinux</ImageName><OperatingSystemType>Oracle Enterprise Linux x86 32 bit</OperatingSystemType>
 
<!--Specify the Operating system type for this operation. Supported operating system types are : Oracle Enterprise Linux x86 32 bit, Oracle Enterprise Linux x86 64 bit, RedHat Enterprise Linux x86 32 bit, RedHat Enterprise Linux x86 64 bit, SUSE Linux Enterprise Server x86 32 bit, SUSE Linux Enterprise Server x86 64 bit-->
<TargetInfo><TargetType>MAC</TargetType>
 
<!--Specify the target type for this provisioning operation as follows : MAC : If the provisioning target type is mac address. RE_IMAGE : If reprovisioning the existing EM targets. Subnet : If provisioning all the targets in a Subnet.-->
<Target><MACAddress>aa:bb:cc:dd:ee:ff</MACAddress><NetworkInterface><InterfaceName>eth0</InterfaceName><Configuration>Dhcp</Configuration>
 
<!--Specify the network interface type as follows : Dhcp : If the interface configuration is to be dynamically assigned from a DHCP server. Static : If the interface configuration is to be statically configured. Network Profile : If the interface configuration is to be fetched from a Network Profile.-->
<Type>Non Bonding</Type>
 
<!--Specify the network interface type as follows : Non Bonding : If the interface is not part of any bond. Bonding Master : If the interface is supposed to be the Bonding master of a bond. Bonding Slave : If the interface is supposed to be a Bonding slave as part of bond.-->
<!-- Following are bonding configuration-->
<BondingMode>1</BondingMode>
 
<!--Specify the Bonding Mode in case the interface has the role of Bonding Master.-->
<SlaveDevices>eth1,eth2</SlaveDevices>
 
<!--Specify the Slave devices as a csv string in case the interface has the role of Bonding Master. For ex : eth1,eth2-->
<PrimarySlaveDevice>eth1</PrimarySlaveDevice>
 
<!--Specify the Primary Slave device in case the interface has the role of Bonding Master.-->
<ARPInterval>200</ARPInterval><ARPIPTarget>10.177.244.121</ARPIPTarget><ARPFrequency>400</ARPFrequency><ARPDownDelay>200</ARPDownDelay><ARPUpDelay>200</ARPUpDelay>
 
<!--bonding configuration-->
<!-- If Configuration is Static <IPAddress></IPAddress> <HostName></HostName> <Netmask></Netmask> <Gateway></Gateway> <DNSServers></DNSServers> -->
<IsBootable>true</IsBootable>
 
<!--Specify if the network interface is the bootable one.-->
</NetworkInterface></Target>
 
<!-- If TargetType is RE_IMAGE: replace <MACAddress> with following <HostName>abc.us.oracle.com</HostName> <BootableMac>aa:bb:cc:dd:ee:ff</BootableMac> -->
<!-- If TargetType is Subnet: replace <MACAddress> with following <SubnetIP>10.244.177.252</SubnetIP> <SubnetMask>255.255.252.0</SubnetMask> -->
</TargetInfo>
 
<!-- If TargetType is RE_IMAGE: <HostTargetsPreferredCredSetName>cred1<.HostTargetsPreferredCredSetName> Specify the preferred credentials name to be used for accessing the EM Host targetse to be Re-imaged. -->
<StageServer>abc.us.oracle.com</StageServer>
 
<!--Specify the Stage Server host name. For ex : myhost.mydomain.com-->
<StageStorage>/scratch/stage</StageStorage>
 
<!--Specify the Stage Storage on the stage server. For ex : /scratch/stage-->
<StageServerPreferredCredSetName>Cred1</StageServerPreferredCredSetName>
 
<!--Specify the preferred credentials name to be used for accessing the stage server.-->
<StageServerPrereqs>false</StageServerPrereqs>
 
<!--Specify if the pre-requisties check should be run on the stage server before starting the provisioning.-->
<BootServer>abc.us.oracle.com</BootServer>
 
<!--Specify the Boot Server host name. For ex : myhost.mydomain.com-->
<BootServerPreferredCredSetName>Cred1</BootServerPreferredCredSetName>
 
<!--Specify the preferred credentials name to be used for accessing the boot server.-->
<BootServerPrereqs>false</BootServerPrereqs>
 
<!--Specify if the pre-requisties check should be run on the boot server before starting the provisioning.-->
<DhcpServer>abc.us.oracle.com</DhcpServer>
 
<!--Specify the Dhcp Server host name. This is required only if DHCP automation is required. For ex : myhost.mydomain.com Note : Dhcp automation is supported only for the MAC and RE_IMAGE provisioning types.-->
<DhcpServerPreferredCredSetName>Cred1</DhcpServerPreferredCredSetName>
 
<!--Specify the preferred credentials name to be used for accessing the Dhcp server.-->
<DhcpServerPrereqs>false</DhcpServerPrereqs>
 
<!--Specify if the pre-requisties check should be run on the Dhcp server before starting the provisioning.-->
<RpmRepository>oelrepos</RpmRepository>
 
<!--Specify the RPM repository name to be used for provisioning operation. For ex : OEL4U8repos-->
<RootPassword>password</RootPassword>
 
<!--Specify the root password for the provisioned machines.-->
<TimeZone>Africa/Algiers</TimeZone>
 
<!--Specify the time zone for the provisioned machines.-->
<AgentInstallUser>oraem</AgentInstallUser>
 
<!--Specify the user name for installing EM agent on the provisioned machines. For ex : oraem-->
<AgentInstallGroup>dba</AgentInstallGroup>
 
<!--Specify the agent installation user's group for installing EM agent on the provisioned machines. For ex : dba-->
<AgentBaseInstallationDirectory>/var/lib/oracle/agent12g</AgentBaseInstallationDirectory>
 
<!--Specify a directory for installing EM agent on the provisioned machines. For ex : /var/lib/oracle/agent12g-->
<OracleInventoryLocation>/var/lib/oracle/oraInventory</OracleInventoryLocation>
 
<!--Specify a directory for storing oracle installed product's inventory on the provisioned machines. For ex : /var/lib/oracle/oraInventory-->
<AgentRegistrationPassword>password</AgentRegistrationPassword>
 
<!--Specify agent registration password for installing EM agent on the provisioned machines.-->
<AgentRpmUrl>http://abc.us.oracle.com/oracle-agt.12.1.0.0.1-i386.rpm</AgentRpmUrl>
 
<!--Specify a http URL for fetching agent RPM. This is not mandatory if the agent rom is already placed at the staged location-->
<ReferenceAnaconda/>
 
<!--Specify a reference anaconda as a string. It will be used to capture properties like Keyboard, mouse. If not provided they will be defaulted to default values.-->
<PackageList>@base</PackageList>
 
<!--Specify the package list to be installed on the provisioned machines.-->
<ACPI>off</ACPI>
 
<!--Specify the ACPI value for the provisioned machines. Supported values are : on, off-->
<ParaVirtualizedKernel>false</ParaVirtualizedKernel>
 
<!--Specify if the provisioned machines should be booted with paravirtualized kernels.-->
<PostInstallScript>%post echo "post" </PostInstallScript>
 
<!--This section provides the option of adding commands to be run on the system once the installation is complete. This section must start with the %post command.-->
<FirstBootScript>#!/bin/sh # chkconfig: 345 75 25 # description: Bare Metal Provisioning First boot service # </FirstBootScript>
 
<!--This section provides the option of adding commands to run on the system when it boots for the first time after installation.-->
<RequireTTY>false</RequireTTY>
 
<!--Specify if tty is required on the provisioned machines.-->
<SeLinux>Disabled</SeLinux>
 
<!--Specify the SELinux configuration for the provisioned machines. Supported values are : Disabled, Enforcing, Permissive-->
<MountPointSettings/>
 
<!--Specify /etc/fstab settings for the provisioned machines.-->
<NISSettings/>
 
<!--Specify /etc/yp.conf settings for the provisioned machines.-->
<NTPSettings/>
 
<!--Specify /etc/ntp.conf settings for the provisioned machines.-->
<KernelParameterSettings/>
 
<!--Specify /etc/inittab settings for the provisioned machines.-->
<FirewallSettings/>
 
<!--Specify the firewall settings for the provisioned machines.-->
<HardDiskProfiles>
 
<!--Specify the Hard Disk profiles for the provisioned machines.-->
<HardDiskConfiguration>
 
<!--Specify the hard disk configuration details-->
<DeviceName>hda</DeviceName>
 
<!--Specify the device name for the disk. For ex : hda,hdb-->
<Capacity>10000000</Capacity>
 
<!--Specify the disk capacity in MB. For ex : 1024-->
</HardDiskConfiguration></HardDiskProfiles><PartitionConfigurations>
 
<!--Specify the partition configurations for the provisioned machines.-->
<PartitionConfiguration>
 
<!--Specify the partition configuration details.-->
<MountPoint>/</MountPoint>
 
<!--Specify the mount point for the partition. For ex : /, /root-->
<DeviceName>hda</DeviceName>
 
<!--Specify the disk name on which this partition has to be configured. For ex : hda,hdb-->
<SystemDeviceName>/dev/hda1</SystemDeviceName>
 
<!--For ex : /dev/hda1-->
<FileSystemType>ext3</FileSystemType>
 
<!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap, Raid, LVM-->
<Size>4096</Size>
 
<!--Specify the size in MB for this partition. For ex : 5120-->
</PartitionConfiguration></PartitionConfigurations><RaidConfigurations>
 
<!--Specify the RAID configurations for the provisioned machines.-->
<RaidConfiguration>
 
<!--Specify the RAID configuration details-->
<MountPoint>raid.100</MountPoint>
 
<!--Specify the raid id . For ex : raid.100-->
<RaidLevel>0</RaidLevel>
 
<!--Specify the RAID Level for this raid device. Supported RAID Levels are : Raid 0, Raid 1, Raid 5, Raid 6-->
<Partitions>/dev/hda1,/dev/hda2</Partitions>
 
<!--Specify the raid partitions for this raid device as a csv string. For ex : /dev/hda1, /dev/hda2-->
<FileSystemType>ext3</FileSystemType>
 
<!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap, LVM-->
</RaidConfiguration></RaidConfigurations><LogicalVolumeGroups>
 
<!--Specify the Logical Volume Groups for the provisioned machines.-->
<LogicalVolumeGroup>
 
<!--Specify the logical volume group configuration details-->
<GroupName>LVG1</GroupName>
 
<!--Specify the Logical group name. For ex : mygrp-->
<Partitions>/dev/hda1</Partitions>
 
<!--Specify the partitions that take part in this logical volume group as a csv string. For ex : /dev/hda1, /dev/hda2-->
<Raids>raid.100</Raids>
 
<!--Specify the RAIDs that take part in this logical volume group as a csv string. For ex : raid.100, raid.200-->
</LogicalVolumeGroup></LogicalVolumeGroups><LogicalVolumes>
 
<!--Specify the Logical Volumes for the provisioned machines.-->
<LogicalVolume>
 
<!--Specify the logical volume configuration details.-->
<MountPoint>/u01</MountPoint>
 
<!--Specify the mount point for this logical volume. For ex : /, /root-->
<LogicalVolumeName>LV1</LogicalVolumeName>
 
<!--Specify the logial volume name. For ex : myvols-->
<LogicalGroupName>LVG1</LogicalGroupName>
 
<!--Specify the logical group name where this volume should be created. For ex : mygrp-->
<FileSystemType>ext3</FileSystemType>
 
<!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap-->
<Size>4096</Size>
 
<!--Specify the size in MB for this partition. For ex : 5120-->
</LogicalVolume></LogicalVolumes></DeployedImage>

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Service name.

  • type

    Service type.

  • systemname

    System on which the service resides.

  • systemtype

    System type.

  • keycomponents

    Name-type pair (such as keycomp_name:keycomp_type) list of key components in the system used for the service.

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'

change_target_owner

Changes the owner of the target.

Format

emcli change_target_owner
        -target="target_name:target_type"
        [-target="target_name:target_type"]
        -owner="current_target_owner_name"
        -new_owner="new_owner_name"

[ ] indicates that the parameter is optional

Parameters

  • target

    Target name and target type to change the owner.

  • owner

    Name of the existing owner of the target. The default value for this parameter is the currently logged in user.

  • new_owner

    New owner name of the target.

Example

The following example changes the ownership of two targets from admin to admin2.

emcli change_target_owner
          -target="abc.oracle.com:host"
          -target="testDBSystem:oracle_database"
          -owner="admin1"
          -new_owner="admin2"

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

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Type of target, which must be "host" if you specify the oracle_homes parameter.

  • target_name

    Name of the target. Omit this option to clear enterprise-preferred credentials. The target name must be the host name if you specify the oracle_homes parameter.

  • credential_set

    Credential set affected.

  • user

    Enterprise Manager user whose credentials are affected. If omitted, the current user's credentials are affected. This value is ignored for monitoring credentials.

  • oracle_homes

    Name of Oracle homes on the target host. Credentials are cleared for all specified homes.

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_default_pref_credential

Clears the named credential set as the default preferred credential for the user. The named credential is not deleted from the credential store. Only the user preference to use the named credential as the default preferred credential is cleared.

Format

emcli clear_default_pref_cred 
        -set_name="set_name"
        -target_type="ttype"

Parameters

  • set_name

    Clears the default preferred credential for this credential set.

  • target_type

    Target type for the credential set.

Examples

The following example clears the default preferred credential set for the host target type for the HostCredsNormal credential set.

emcli clear_default_pref_cred 
        -set_name=HostCredsNormal
        -target_type=host

clear_monitoring_credential

Clears the monitoring credential set for the target.

Format

emcli clear_monitoring_credential
        -set_name="set_name"
        -target_name="target_name"
        -target_type="ttype"

Parameters

  • set_name

    Clears the monitoring credential for this credential set.

  • target_name

    Clears the preferred credential for this target.

  • target_type

    Target type for the target/credential set.

Examples

The following example clears the monitoring credential set for the target testdb.example.com for the DBCredsMonitoring credential set.

emcli clear_monitoring_credential 
        -set_name=DBCredsMonitoring
        -target_name=testdb.example.com
        -target_type=oracle_database

clear_preferred_credential

Clears the named credential set as the target preferred credential for the user. The named credential is not deleted from the credential store. Only the user preference to use the named credential as the preferred credential is cleared.

Format

emcli clear_preferred_credential 
        -set_name="set_name"
        -target_name="target_name"
        -target_type="ttype"

Parameters

  • set_name

    Sets the preferred credential for this credential set.

  • target_name

    Clears the preferred credential for this target.

  • target_type

    Target type for the target/credential set.

Examples

The following example clears the preferred credential set for the host target test.example.com for the HostCredsNormal credential set.

emcli clear_preferred_credential 
        -set_name=HostCredsNormal
        -target_name=test.example.com
        -target_type=host

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

[ ] indicates that the parameter is optional

Parameters

  • host_names

    Names of the hosts.

  • input_file

    Path of the file that has the list of hosts. The file should have one host name per line.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • force

    If set to yes, invalid and unreachable targets are ignored and the setting is removed from all valid and up targets. If set to no, invalid and down targets raise an error. The default is no.

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_problem

Clears problems matching the specified criteria (problem key, target type, and age). Only users with Manage Target privilege can clear the problems for a target. When a problem is cleared, the underlying incidents and events are also cleared.

By default, the problem notification is not sent out. You can override this by specifying the send_notification option. Clearing the underlying incidents and events does not send out a notification.

Format

emcli clear_problem
        -problem_key="problem_key"
        -target_type="target_type"
        -older_than="age_of_problem"
        [-target_name="target_name"]
        [-unacknowledged_only="clear_unacknowledged_problems"]
        [-send_notification="send_notifications_for_problems"]
        [-preview]

[ ] indicates that the parameter is optional

Parameters

  • problem_key

    Problem key of the problem to be cleared

  • target_type

    Internal type name, such as oracle_database for "Oracle Database." You can use the get_target_types command to get the internal name for a target type.

  • older_tha n

    Specify the age (in days) of the problem.

  • target_name

    Name of an existing non-composite target. For example, the name of a single database. You cannot use the name of composite targets (target group).

  • unacknowledged_only

    If provided, only the unacknowledged problems are cleared. This option does not require any value.

  • send_notification

    If provided, any applicable notification is sent out for cleared problems. By default, no notification is sent for cleared problems. This parameter does not require any value.

  • preview

    Gets the number of problems that the command would clear.

Examples

Example 1

The following example displays the number of problems matching the specified criteria.

emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database"-preview

Example 2

The following example clears ORA-600 problems across all databases that have occurred (based on the occurrence date of the first incident) for at least 3 days.

emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database" -older_than="3"

Example 3

The following example clears only unacknowledged problems.

emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database"  -older_than="3" -unacknowledged_only

Example 4

The following example sends applicable notifications when the problem clears. By default, a notification is not sent for the cleared problems.

emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database"  -older_than="3" - send_notification

clear_stateless_alerts

Clears the stateless alerts associated with the specified target. Only a user can clear these stateless alerts; the Enterprise Manager Agent does not automatically clear these alerts. To find the metric internal name associated with a stateless alert, use the get_metrics_for_stateless_alerts verb.

You cannot use this command to clear stateless alerts associated with diagnostic incidents. You can only clear these alerts in the Enterprise Manager console by clearing their associated Incident or Problem.

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]

[ ] indicates that the parameter is optional

Parameters

  • older_than

    Specify the age of the alert in days. (Specify 0 for currently open stateless alerts.)

  • target_type

    Internal target type identifier, such as host, oracle_database, and emrep.

  • target_name

    Name of the target.

  • include_members

    Applicable for composite targets to examine alerts belonging to members as well.

  • metric_internal_name

    Metric to be cleaned up. Use the get_metrics_for_stateless_alerts verb to see a complete list of supported metrics for a given target type.

  • unacknowledged_only

    Only clear alerts if they are not acknowledged.

  • ignore_notifications

    Use this option if you do not want to send notifications for the cleared alerts. This may reduce the notification sub-system load.

  • preview

    Shows the number of alerts to be cleared on the target(s).

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 EM CLI

When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.

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

  • input_file="dest_properties:file_path"

    File containing information regarding the targets.

    Each line in the file corresponds to information regarding one destination.

    Format:

    Destination Host Name1;Destination Home Loc; Home Name; Scratch Location;

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • list_exclude_files

    Comma-separated list of files to exclude. Not required if the source is software lib. "*" can be used as a wild card.

  • isSwLib

    Specifies whether it is an Oracle Home database or Software Library.

  • ryftp_copy

    Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.

  • jobname

    Name of the cloning job.

  • iasInstance

    Name of instance.

  • isIas1013

    Specifies whether this is a 10.2.3 Ias home.

  • oldoc4jpassword

    Old OC4j password. (Required for 10.1.3 Ias homes.)

  • oc4jpassword

    New OC4J password. (Required for 10.1.3Ias homes.)

  • oldIASAdminPassword

    Old Application Server administrator password. (Not required for 10.1.3 Ias homes.)

  • newIASAdminPassword

    New Application Server administrator password. (Not required for 10.1.3 Ias homes.)

  • oiduser

    OID admin user.

  • oidpassword

    OID admin password.

  • dcmpassword

    DCM schema password.

  • prescripts

    Path of script to execute.

    Note:

    Double-quoted parameters can be passed using an escape (\) sequence. For example:
    prescripts=" <some value here>=\"some value here\" " 
    
  • run_prescripts_as_root

    Run prescripts as "root". By default, the option is set to false.

  • postscripts

    Path of script to execute.

  • run_postscripts_as_root

    Run postscripts as "root". By default, the option is set to false.

  • rootscripts

    Path of the script to execute. The job system environment variables (%oracle_home%, %perl_bin%) can be used for specifying script locations.

  • swlib_component

    Path to the Software Library to be cloned. "isSwLib" must be true in this case.

  • source_params

    Source Oracle home information. "isSwLib" must be false in this case.

  • jobdesc

    Description of the job. If not specified, a default description is generated automatically.

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

  • input_file="dest_properties:file_path"

    File containing information regarding the targets.

    Each line in the file corresponds to information regarding one destination.

    Format:

    Destination Host Name;Destination Node Name;Scratch Location;PVTIC;VirtualIP;

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • list_exclude_files

    Comma-separated list of files to exclude. Not required if the source is software lib. An asterisk "*" can be used as a wildcard.

  • isSwLib

    Specifies whether it is an Oracle Home database or Software Library.

  • tryftp_copy

    Try FTP to copy or not. You should set the FTP copy option to false when using emcli from the command line.

  • jobname

    Name of the cloning job.

  • home_name

    Name of the home to use for all homes in the Oracle Clusterware cluster.

  • home_location

    Location of the home to use for all homes in the Oracle Clusterware cluster.

  • clustername

    Name of the cluster to create.

  • isWindows

    Specify whether the cloning source is on a Windows Platform. This option only applies for creating CRS cloning from a Gold Image source. The default value is false.

  • ocrLoc

    Oracle Cluster Registry Loaction.

  • vdiskLoc

    Voting disk location.

  • prescripts

    Path of the script to execute.

    Note:

    Double-quoted parameters can be passed using an escape (\) sequence. For example:
    prescripts=" <some value here>=\"some value here\" " 
    
  • run_prescripts_as_root

    Run prescripts as "root". By default, this option is set to false.

  • postscripts

    Path of the script to execute.

  • run_postscripts_as_root

    Run postscripts as "root". By default, it is false.

  • rootscripts

    Path of the script to execute.

  • swlib_component

    Path to the Software Library to be cloned. "isSwLib" must be true in this case.

  • source_params

    Source Oracle home info. "isSwLib" must be false in this case.

  • jobdesc

    Description of the job. If not specified, a default description is generated automatically.

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 EM CLI

When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.


clone_database

Clones a database.

Format

emcli clone_database
      -source_db_name="source_database_name"
      -dest_global_dbname="global_name_of_clone_database" 
      -dest_oracle_sid="clone_database_instance_name"
      [-dest_host_name="clone_host_name"]  
      [-dest_oracle_home="clone_database_oracle_home"] 
      [-source_db_creds_name="source_database_credential_name"] 
      [-source_host_creds_name="source_database_host_credential_name"] 
      [-dest_host_creds_name="clone_database_host_credential_name"] 
      [-asm_inst_creds_name="asm_instance_credential_name"]  
      [-dest_target_name="clone_database_name"] 
      [-clone_type="clone_type"] 
      [-source_staging_area="source_staging_directory"]  
      [-dest_staging_area="clone_database_staging_directory"]  
      [-dest_storage_type="clone_database_storage_type"] 
      [-dest_database_area="clone_database_files_location"] 
      [-dest_recovery_area="clone_database_fast_recovery_area"] 
      [-dest_listener_selection="clone_database_listener_selection"] 
      [[-dest_listener_name="clone_database_listener_name"]
       [-dest_listener_port="clone_database_listener_port"]] 
      [-configure_with_oracle_restart"] 
      [-job_name="job_name"] 
      [-job_desc="job_description"

[ ] denotes that the parameter is optional

Options

  • source_db_name

    Source database Enterprise Manager target name. Can be either a single-instance database or a cluster database instance.

  • dest_global_dbname

    Clone database global database name. Usually specified as <name>.<domain>, with <name> being used for the db_unique_name and <domain> for the db_domain_name parameters.

  • dest_oracle_sid

    Clone database instance name.

  • dest_host_name

    Clone database host name. If not specified, the clone database is created on the same host as the source database.

  • dest_oracle_home

    Clone database Oracle home. If not specified, the Oracle Home of the source database is used.

  • source_db_creds_name

    Source database named credential.

  • source_host_creds_name

    Source database host named credential.

  • dest_host_creds_name

    Destination (clone) host named credential.

  • asm_inst_creds_name

    Automatic Storage Management(ASM) named credential.

  • dest_target_name

    Clone database Enterprise Manager target name.

  • clone_type

    Type of source database backup that will be used for cloning. Valid values are:

    • DUPLICATE — Database files are moved directly to the clone database host by the Recovery Manager (RMAN).

    • STAGING — Database files are backed-up into the staging area and moved to the clone database host through HTTP.

    • EXISTING_BACKUP — Database files are restored from existing backups to the clone database host by the Recoverey Manager (RMAN).

  • pitr_date

    Clone database as of the specified date in MM/dd/yyyy hh:mm:a (Month/Date/Year Hours:Minutes:AM/PM marker) format. For example: 03/22/2014 08:25:AM. If not specified, the clone database is created as of the latest point-in-time. This option is applicable when the clone_type is EXISTING_BACKUP.

  • pitr_scn

    Clone database as of the specified System Change Number of the source database. If not specified, the clone database is created as of the latest point-in-time. This option is applicable when the clone_type is EXISTING_BACKUP.

  • encryption_mode

    Encryption mode of the existing source database backups. If not specified, the default value is NONE. This option is applicable when the clone_type is EXISTING_BACKUP. Valid values are:

    • WALLET — Backups are encrypted using Oracle Encryption Wallet.

    • PASSWORD — Backups are encrypted using a password.

    • DUAL — Backups are encrypted using both Oracle Encryption Wallet and a password.

  • backups_encryption_creds_name

    Database named credential for the encrypted backups. This option is applicable if encryption_mode is PASSWORD or DUAL.

    Note:

    This parameter is applicable only if the clone type is EXISTING_BACKUP and the database backups are encrypted using a password. This database credential should be created in Enterprise Manager of scope GLOBAL with the user name specified as "backup_admin".
  • tape_settings

    Media management vendor settings if the database backups are on tape. This option is applicable when clone_type is EXISTING_BACKUP.

  • db_backups_location

    The location of the backups to be transferred to the destination host. Multiple values can be specified using "," as a delimiter. This option is applicable when cloning to a different host and clone_type is EXISTING_BACKUP.

    Note:

    This parameter is applicable only if the clone type is EXISTING_BACKUP and the database clone occurs on a different host where the source database backups are not visible. If the backups are visible from the destination host, this parameter should NOT be specified.
    • It is recommended that if the size of the database backups is very large, the backups should be taken in a common location visible from the destination host.

    • If the source database backups are on ASM diskgroups, ensure that the diskgroups are mounted at the destination host as these backups are not transferred.

    • When you specify this parameter is specified, all of the available files at this location are transferred to a temporary staging location at the destination host.

    • You can specify multiple values for this parameter with comma (,) as a delimiter.

  • source_staging_area

    Staging area used to store the backup of source database. This option is applicable when clone_type is STAGING.

  • dest_staging_area

    Staging area used to store backup files transferred from source host. This option is applicable when clone_type is STAGING.

  • dest_storage_type

    Clone database storage type. Valid values are:

    • FILE_SYSTEM — Clone database files will be in a regular file system (using Oracle-managed Files).

    • ASM — The clone database will use Automatic Storage Management (ASM).

  • dest_database_area

    Oracle-managed files (OMF) location for clone database files. This can be a regular file system (if storage_type is FILE_SYSTEM) or an ASM disk group (if storage_type is ASM). If not specified, a default value is used.

  • dest_recovery_area

    Fast recovery area location. If not specified, a default value is used.

  • dest_listener_selection

    Clone database listener selection. Valid values are:

    • GRID_INFRA — Use Grid Infrastructure Home listener.

    • DEST_DB_HOME — Use the listener from the clone database Oracle Home.

  • dest_listener_name

    Clone database listener name. This option is applicable only if dest_listener_selection is DEST_DB_HOME. If not specified, the first existing TCP listener found in the clone database Oracle Home is used. If you specify this option, you must also specify dest_listener_port.

  • dest_listener_port

    Clone database listener port. This option is applicable only if dest_listener_selection is DEST_DB_HOME. If you specify this option, you must also specify dest_listener_name.

  • configure_with_oracle_restart

    Configure the clone database with Oracle Restart if the clone host has Oracle Restart configured. Oracle Restart automatically starts the database when required.

  • job_name

    Unique job name for the clone job in the Enterprise Manager repository.

  • job_desc

    Job description.

Examples

Example 1

emcli clone_database -source_db_name="database" -dest_target_name="dbClone1" -dest_host_name="host1" -dest_oracle_home="/ade/ngade_gct/oracle" -dest_oracle_sid="dbClone1" -dest_global_dbname="dbClone1" -dest_listener_selection="DEST_DB_HOME" -clone_type="DUPLICATE" -dest_storage_type="FILE_SYSTEM" 

Example 2

emcli clone_database -source_db_name="database" -source_db_creds_name="NC_DBCREDS1" -source_host_creds_name="NC_HOST_CREDS1" -dest_host_name="host1" -dest_host_creds_name="NC_HOST_CREDS2" -dest_oracle_home="/u01/app/oracle/product/11.2.0/dbhome_2" -dest_oracle_sid="TESTDB1" -dest_global_dbname="TESTDB1" -dest_listener_selection="GRID_INFRA" -clone_type="EXISTING_BACKUP" -dest_storage_type="FILE_SYSTEM" db_backups_location="/oracle/dir1"

Example 3

emcli clone_database -source_db_name="database" -source_db_creds_name="NC_DBCREDS1" -source_host_creds_name="NC_HOST_CREDS1" -dest_host_creds_name="NC_HOST_CREDS2" -dest_oracle_home="/u01/app/oracle/product/11.2.0/dbhome_2" -dest_oracle_sid="TESTDB2" -dest_global_dbname="TESTDB2" -dest_listener_selection="GRID_INFRA" -clone_type="EXISTING_BACKUP" -pitr_date="03/22/2014 08:25:AM" -dest_storage_type="FILE_SYSTEM"

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="files_to_exclude"
       -isSwLib="true|false"
       -isRac="true|false"
       -tryftp_copy="true|false"
       -jobname="name_of_cloning_job"
       [-home_name="home_when_creating_RAC_cluster"]
       [-home_location="location_of_home_when_creating_RAC_cluster"]
       [-prescripts="script_name_to_execute"]
       [-run_prescripts_as_root="true|false"]
       [-postscripts="script_to_execute"]
       [-run_postscripts_as_root="true|false"]
       [-rootscripts="script_name_to_execute"]
       [-swlib_component ="path:path_to_component;version:rev"] 
       [-source_params="TargetName:name;HomeLoc:loc;HomeName:name;
         ScratchLoc:scratch_dir_location"
       [-jobdesc="description"]

[ ] denotes that the parameter is optional

Options

  • input_file=dest_properties

    File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.

    Format if cloning a database (isRac is false):

    Destination Host Name1;Destination Home Loc; Home Name; Scratch Location;

    Format if cloning a RAC cluster (isRac is true):

    Host Name;Node Name;Scratch Location;

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • list_exclude_files

    Comma-separated list of files to exclude. This is not required if the source is software lib. "*" can be used as a wild card.

  • isSwLib

    Specifies whether the source is an Oracle Home database or Software Library.

  • isRac

    Specifies whether cloning in RAC mode. If the isRac option is true, a RAC cluster is created. If the isRac option is true, the home name and location of the RAC cluster are needed.

  • tryftp_copy

    Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.

  • jobname

    Name of the cloning job.

  • home_name

    Name of the home to use when creating a RAC cluster.

  • home_location

    Location of the home to use when creating a RAC cluster.

  • prescripts

    Path of the script to execute.

    Note:

    Double-quoted parameters can be passed using an escape (\) sequence. For example:
    prescripts=" <some value here>=\"some value here\" " 
    
  • run_prescripts_as_root

    Run prescripts as "root". By default, it is false.

  • postscripts

    Path of the script to execute.

  • run_postscripts_as_root

    Run postscripts as "root". By default it is false.

  • rootscripts

    Path of the script to execute. You can use the job system environment variables (%oracle_home%, %perl_bin%) to specify script locations.

  • swlib_component

    Path to the Software Library to be cloned. "isSwLib" must be true in this case.

  • source_params

    Source Oracle home info. "isSwLib" must be false in this case.

  • jobdesc

    Description of the job. If not specified, it is automatically generated.

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 EM CLI

When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.


collect_metric

Performs an immediate collection and threshold evaluation of a set of metrics associated with the specified internal metric name. Metric data collection and threshold evaluation occur asynchronously to the EM CLI call.

You typically use this command when you believe you have resolved an open metric alert or error and would like to clear the event by immediately collecting and reevaluating the metric. This command applies to most metrics except server-generated database metrics.

Use the get_on_demand_metrics verb to see a complete list of supported metrics for a given target.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • target_name

    Name of the target.

  • target_type

    Internal target type identifier, such as host, oracle_database, and emrep.

  • metric_name

    Internal name that represents a set of metrics that are collected together. Use the get_on_demand_metrics verb to see the supported list of metrics for a given target.

  • collection_name

    Name of the user-defined metric or SQL user-defined metric. This parameter only applies to user-defined metrics and SQL user-defined metrics.

Examples

Example 1

If you want to collect the "CPU Utilization (%)" metric, look for the appropriate metric internal name (which is Load) using the get_on_demand_metrics command, then run the command as follows:

emcli collect_metric  -target_type=host  -target_name=hostname.example.com  -metric_name=Load

Example 2

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

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

Example 3

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

compare_sla

Compares two SLAs as defined by two XML files. This utility outputs the difference trees as sla1_compare.dif and sla2_compare.dif in the specified directory. You can use a diff utility to diff these two files. Compare two sla.xml's to find out the difference.

Format

emcli compare_sla    -input_file=sla1:'first_xml    -input_file=sla2:'second_xml'    [-dir='directory']

[ ] indicates that the parameter is optional

Parameters

Example

The following example compares two SLAs as defined in sla1.xml and sla2.xml, and outputs sla1_compare.dif and sla2_compare.dif in the current directory.

emcli compare_sla
          -input_file=sla1:sla1.xml -input_file=sla2:sla2.xml

You can use a standard diff tool to diff the files, such as the following example for Linux:

diff sla1_compare.dif sla2_compare.dif

confirm_instance

Confirms a manual step. An instance cannot be confirmed when its status is suspended, stopped, completed, or completed with an error.

Format

emcli confirm_instance 
      [-instance=<instance_guid>] 
      [exec=<execution_guid>] 
      [-name=<execution name>] 
      [-owner=<execution owner>] 
      -stateguid=<state_guid>

[ ] indicates that the parameter is optional

Parameters

  • instance

    Instance GUID.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

  • stateguid

    Comma-separated list of state GUIDs.

Examples

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

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

continue_add_host

Performs resume/continue operations of a previously submitted add host session that has failed at some phase.

Format

emcli continue_add_host
        -session_name="session_name"
        -continue_all_hosts | -continue_ignoring_failed_hosts"
        [-wait_for_completion]

[ ] indicates that the parameter is optional

Parameters

  • session_name

    Name of the session you want to continue to the next phase of Agent deployment.

  • continue_all_hosts

    Continues the session on all hosts, including those on which the current deployment phase failed.

  • continue_ignoring_failed_hosts

    Continues the session for only the hosts on which the current deployment phase succeeded.

  • wait_for_completion

    Specifies whether the command should run in synchronous or asynchronous mode. If you specify this option (for synchronous mode), the command waits until the add host session completes before returning control to you on the command line.

Examples

Example 1

The following example continues the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' to the next phase of deployment on all hosts.

emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -continue_all_hosts 

Example 2

The following example continues the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' synchronously to the next phase of deployment only on hosts on which the current phase was successful.

emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -continue_ignoring_failed_hosts -wait_for_completion 

convert_to_cluster_database

Converts a single-instance database to a Real Application Cluster (RAC) database.

Format

  emcli convert_to_cluster_database 
        -sourceTargetName="Single instance database target to be converted to RAC"
        -sysdbaCreds="Named credentials for SYSDBA user"
        -hostCreds="Named credentials for Host"
        [-newOracleHome="RAC Oracle Home, if moving to differnt home"]
        [-racConfigType="ADMIN_MANAGED | POLICY_MA NAGED"]
        [-nodeList="Comma-separated node names for Admin Managed RAC database"]
        [-serverPoolList="Comma-separated list of server pools for Policy Managed            database"]
        [-databaseArea="Shared storage location for database files"]
        [-recoveryArea="Shared storage location for recovery files"]
        [-listenerPort="RAC Listener port"]

[ ] indicates that the parameter is optional

Parameters

  • sourceTargetName

    Enterprise Manager target name of the single-instance database to be converted to a RAC database. Database versions 10.2.0.1.0 and above are supported for conversion. The single-instance database target should exist on one of the nodes of the cluster where the RAC database will be created, and the cluster should be an Enterprise Manager target.

  • sysdbaCreds

    Named database credentials with SYSDBA privileges on the database to be converted to a RAC database.

  • hostCreds

    Named host credentials of the user who owns the Oracle home installation.

  • newOracleHome

    RAC Oracle home location of the converted database. You only need to provide this if different from the Oracle home of the single-instance database to be converted.

  • racConfigType

    RAC configuration type. Valid values are POLICY_MANAGED and ADMIN_MANAGED. POLICY_MANAGED is valid only for database versions 11.2 or higher. The default is ADMIN_MANAGED if not provided.

  • nodeList

    List of valid node names for an ADMIN_MANAGED RAC database. It should include the node where the single instance database to be converted exists. If not provided, all the nodes in the cluster are used.

  • serverPoolList

    Comma-separated list of server pool names for a POLICY_MANAGED RAC database. Applicable only for database versions 11.2 or higher.

  • databaseArea

    New location for data files of the RAC database. This location should be shared across the nodes of the cluster. It can either be a Cluster File System location or an Automatic Storage Management diskgroup. If not specified, the existing database files should already be on shared storage, and files are not moved during RAC conversion.

  • recoveryArea

    Fast recovery area location of the RAC database. This location should be shared across the nodes of the cluster. It can either be a Cluster File System location or an Automatic Storage Management diskgroup. If not specified, the existing recovery area location should already be on shared storage, and it does not change during RAC conversion.

  • listenerPort

    Port of the new RAC listener to be created for the new RAC database. If not provided, the existing listener is used. This option is only applicable to 10.2 and 11.1 database versions. For 11.2 or higher database versions, this value is ignored and the RAC database is always registered with the existing listener in the Cloud Infrastructure home.

Examples

Example 1

emcli convert_to_cluster_database -sourceTargetName=sidb 
 -sysdbaCreds=sysCreds  -hostCreds=hostCreds racConfigType=ADMIN_MANAGED

Example 2

emcli convert_to_cluster_database -sourceTargetName=sidb 
 -sysdbaCreds=sysCreds  -hostCreds=hostCreds racConfigType=POLICY_MANAGED 
 -serverPoolList=sp1,sp2 -databaseArea=+DATA -recoveryArea=+RECOVERY

Example 3

emcli convert_to_cluster_database -sourceTargetName=sidb 
 -sysdbaCreds=sysCreds  -hostCreds=hostCreds -nodeList=node1,node2 
 -databaseArea=/u01/share/oradata -recoveryArea=/u01/share/fra -listenerPort=1525

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 Cloud Control console to configure performance and usage metrics to be collected and displayed.

Format

emcli create_aggregate_service
      -name='name'
      -type='type'
      -availType=SUB-SERVICE|SYSTEM|TESTS
      -add_sub_services="name1:type1;name2:type2;..."
      -avail_eval_func=and|or
      [-hostName=<host_name>
      [-agentURL=<agent_url>
      [-properties='pname1|pval1;pname2|pval2;...']
      [-timezone_region=<gmt_offset>]
      [-systemname=<system_name>]
      [-systemtype=<system_type>]
      [-keycomponents='keycomp1name:keycomp1type;keycomp2name:keycomp2type;...']
      [-beacons='bcn1name:bcn1isKey;bcn2name:bcn2isKey;...']
      [-input_file='template:Template_file_name;[vars:Variables_file_name]']
      [-sysAvailType=<availability_type>]

[ ] indicates that the parameter is optional

Parameters

  • name

    Aggregate service name.

  • type

    Aggregate service type.

  • availType

    Sets availability to either sub-service, system-based, or test-based. Valid values are SUB-SERVICE, SYSTEM, and TESTS.

    If availability is set to SYSTEM, -systemname and -systemtype are required.

    If availability is set to TESTS, -beacons, template file, and variables are required.

  • add_sub_services

    Sub-services list.

  • avail_eval_func

    Operator to evaluate availability. If "and" is used, all sub-services, tests, and system-components must be up in order for this aggregate_service to be up. If "or" is used, only one of the sub-services, tests, and system-components needs to be up for this aggregate_service to be up.

  • hostName

    Network name of the system running the Management Agent that is collecting data for this target instance.

  • agentURL

    URL of the Management Agent that is collecting data for this target instance. If you enter the host name, the Agent URL of the host is automatically entered in this field.

  • properties

    Name-value pair (that is, prop_name|prop_value) list of properties for the service instance.

  • timezone_region

    Accepts either long formats ("America/Los Angeles") or short formats ("PST"). If you do not provide a time zone, the default OMS time zone is used.

  • systemname

    System name on which service resides.

  • systemtype

    Use emcli get_targets to obtain the system type for the system name.

  • keycomponents

    Name-type pair (that is, keycomp_name:keycomp_type) list of key components in the system that are used for the service.

  • beacons

    Name-isKey pairs that describe the beacons of the service. If isKey is set to Y, the beacon is set as a key-beacon of the service. The service should have at least one key beacon if the availability is set to test-based.

  • input_file

    Template file name is the XML file that includes the template definition. Variable file defines the values for the template.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • sysAvailType

    Type of availability when the availType is system-based. Sets the availability to either SYSTEM_TARGET_DIRECTLY or SELECTED_COMPONENTS_OF_A_SYSTEM.

    If availability is set to SYSTEM_TARGET_DIRECTLY, the system needs to have availability[status] defined. -systemname and -systemtype are required parameters.

    If availability is set to SELECTED_COMPONENTS_OF_A_SYSTEM, -systemname, -systemtype and -keycomponents are required parameters.

    If availability is set to SYSTEM_TARGET_DIRECTLY and if the system does not have availability[status] defined, the availability set is invalid. Therefore, the only option that can be set is SELECTED_COMPONENTS_OF_A_SYSTEM.

Examples

     emcli create_aggregate_service -name="My_Name"
                -type="aggregate_service" 
                -add_sub_services="sub1:type1;sub2:type2"
                -avail_eval_func="and"
                -availType="SUB_SERVICE" 
                 -properties="prop1|value1;prop2|value2"
                -timezone_region="PST"
 
     emcli create_aggregate_service -name="My_Name"
                -type="aggregate_service" 
                -add_sub_services="sub1:type1;sub2:type2"
                -avail_eval_func="or"
                -availType="SYSTEM" 
                -systemname="my system" -systemtype="generic_system"
                -sysAvailType="SYSTEM_TARGET_DIRECTLY"
                -timezone_region="PST"
 
     emcli create_aggregate_service -name="My_Name"
                -type="aggregate_service" 
                -add_sub_services="sub1:type1;sub2:type2"
                -avail_eval_func="and"
                -availType="SYSTEM" 
                -systemname="my system" -systemtype="generic_system"
                -sysAvailType="SELECTED_COMPONENTS_OF_A_SYSTEM"
                -keycomponents="database:oracle_database;  
                 mytestbeacon:oracle_beacon"
                -timezone_region="PST"
 
    emcli create_aggregate_service -name="My_Name"
                -type="aggregate_service" 
                -add_sub_services="sub1:type1;sub2:type2"
                -avail_eval_func="or"
                -timezone_region="PST"
                -availType="TESTS" 
                -beacons="MyBeacon:Y;MyOtherBeacon:N"
                -properties="prop1|value1;prop2|value2"
                -input_file="template:mytests.xml" 
                -input_file="variables:myvariable.xml"

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

[ ] indicates that the parameter is optional

Constraints on schedule arguments:

frequency:once
    requires => duration or end_time
    optional => start_time, tzinfo, tzoffset
frequency:interval
    requires => duration, repeat
    optional => start_time, end_time, tzinfo, tzoffset
frequency:weekly
    requires => duration, days
    optional => start_time, end_time, tzinfo, tzoffset
frequency:monthly
    requires => duration, days
    optional => start_time, end_time, tzinfo, tzoffset
frequency:yearly
    requires => duration, days, months
    optional => start_time, end_time, tzinfo, tzoffset

Parameters

  • name

    Name of the blackout to create.

  • add_targets

    Targets to add to the blackout, each specified as target_name:target_type. You can specify this parameter more than once.

  • reason

    Reason for the blackout. If you have SUPER_USER privileges (you are an Enterprise Manager Super Administrator), any text string can be used for the reason. The reason is added to the list of allowable blackout reasons if it is not already in the list. If you do not have SUPER_USER privileges, you must specify one of the text strings returned by the get_blackout_reasons verb.

  • description

    Description or comments pertaining to the blackout. The description, limited to 2000 characters, can be any text string.

  • jobs_allowed

    When you specify this option, jobs are allowed to run against blacked-out targets during the blackout period. If you do not specify this option, jobs scheduled to be run against these targets are not allowed to run during the blackout period. After a blackout has been created, you cannot change the "allowed jobs" from either EM CLI or the Enterprise Manager Cloud Control console.

  • propagate_targets

    When you specify this option, a blackout for a target of type "host" applies the blackout to all targets on the host, including the Agent. This is equivalent to nodelevel in the emctl command. Regardless of whether you specify this option, a blackout for a target that is a composite or a group applies the blackout to all members of the composite or group.

  • schedule

    Blackout schedule. Note that the "frequency" argument determines which other arguments are required or optional.

  • schedule=frequency

    Type of blackout schedule (default is "once").

  • schedule=duration

    Duration in hours and minutes of the blackout (-1 means indefinite). Hours and minutes each can be up to 6-digits long.

  • schedule=start_time

    Start date/time of the blackout. The default value is the current date/time. The format of the value is "yy-MM-dd HH:mm", for example: "2003-09-25 18:34"

  • schedule=end_time

    Last date/time of the blackout. When "frequency" is weekly, monthly, or yearly, only the date portion is used. When "frequency" is interval or once, the date and time are taken into account. The format of the value is "yy-MM-dd HH:mm"; for example: "2003-09-25 18:34"

  • schedule=repeat

    Time between successive start times of the blackout. The letter following the number value represents the time units: "m" is minutes, "h" is hours, "d" is days, and "w" is weeks.

  • schedule=months

    List of integer month values in the range 1-12. Each value must have a corresponding "day" value to fully specify (month, day) pairs that indicate the blackout starting days of the year.

  • schedule=days

    When "frequency" is weekly, this is a list of integer day-of-week values in the range 1-7 (1 is Sunday). When "frequency" is monthly, this is a list of integer day-of-month values in the range 1-31 or -1 (last day of the month). When "frequency" is yearly, this is a list of integer day-of-month values in the range 1-31 or -1 (last day of the month); in this case, the month is taken as the corresponding "month" value for each (month, day) pair.

  • schedule=tzinfo

    Type of timezone. The tzinfo argument is used in conjunction with tzoffset. Available timezone types are: "specified" (offset between GMT and the target timezone), "target" (timezone of the specified target), and "repository" (repository timezone -- default setting when tzinfo is not specified). See -schedule=tzoffset for more information.

  • schedule=tzoffset

    Value of the timezone. When the tzinfo argument is not specified or is "repository", the timezone value is the repository timezone. In this case, the tzoffset argument must not be specified. Otherwise, the tzoffset argument is required. When tzinfo is set to "specified", the tzoffset argument specifies the offset in hours and minutes between GMT and the timezone. When tzinfo is set to "target", the tzoffset argument specifies an integer index (the first is 1) into the list of targets passed as arguments. For example, for a tzoffset setting of 1, the timezone of the first target specified in the -add_targets parameter is used.

    Note that the timezone is applied to the start time and the end time of the blackout periods. The timezones associated with each target are not taken into account when scheduling the blackout periods (except that when tzinfo is set to "target", the specified target's timezone is used for the blackout times).

  • schedule=[tzregion:<...>]

    Time zone region to use. When you "specify" the tzinfo parameter, this parameter determines which timezone to use for the blackout schedule. Otherwise, it is ignored. It defaults to "GMT".

Examples

Example 1

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"

Example 2

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"

Example 3

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"

Example 4

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"

Example 5

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"

Example 6

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"

Example 7

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"

Example 8

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"

Example 9

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 2011-11-24 (2011-11-15 will be the actual last blackout date). The blackout will last 1 hour 10 minutes each time. Jobs are allowed to run during the blackouts.

emcli create_blackout -name=b5 -add_targets=mygroup:group
      -propagate_targets -jobs_allowed
      -schedule="frequency:monthly;duration:1:10;start_time:06-10-24 22:30;        end_  time:06-12-24 23:59:days:15,-1"
      -reason="pretty good reason"

Example 10

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_credential_set

Creates a new credential set. Only Enterprise Manager Super Administrators can create new credential sets.

Format

  emcli create_credential_set 
        -set_name="set_name"
        -target_type="ttype"
        -supported_cred_types="supported_cred_types"
        -monitoring
        [-auth_target_type = "authenticating_target_type"
        [-description ="description]"

[ ] indicates that the parameter is optional

Parameters

  • set_name

    Credential set name to be created.

  • target_type

    Target type of the new credential set.

  • supported_cred_types

    Credential types supported by this credential set. You can list the available credential types by using the command show_credential_type_info.

  • monitoring

    Creates a monitoring credential set.

  • auth_target_type

    Target type for the supported cred types. The default value is target_type.

  • description

    Description of the credential set.

Examples

The following example creates a new credential set named New_Credential_Set.

emcli create_credential_set 
        -set_name=New_Credential_Set 
        -target_type=host
        -supported_cred_types=HostCreds;HostSSHCreds
        -description="Example credential set"

create_database

Creates a database.

Format

emcli create_database
       [-dbType="type_of_database"]
       [-hostTargets="list_of_host_targets"]
       [-cluster="cluster_target_name"]
       -oracleHome="Oracle_Home_location"
       -gdbName="global_database_name"
       -templateName="fully_qualified_path_for_template"
       -hostCreds="named_credential_for_OS_user"
       -sysCreds="named_credential_for_SYS_user"
       -systemCreds="named_credential_for_SYSTEM_user"
       -dbsnmpCreds="named_credential_for_DBSNMP_user"
       [-sid="database_system_identifier"]
       [-racConfigType="RAC_configuration_type"]
       [-nodeList="comma-separated_node_names"]
       [-serverPoolList="comma-separated_list_of_server_pools"]
       [-newServerPool="new_server_pool_name_and_cardinality"]
       [-racOneServiceName="service_name_for_RAC_one-node_database"]
       [-templateInSwlib="TRUE|FALSE"]
       [-templateStageLocation="temporary_directory_on_agent_side"]
       [-storageType="FS|ASM"]
       [-dataFileLocation="Location_of_data_files "]
       [-recoveryAreaLocation="Fast_Recovery_Area_location "]
       [-enableArchiving]
       [-useOMF]
       [-listeners="comma-separated_list_of_listeners_database"]
       [-newListener="new_listener_and_port"] 

[ ] indicates that the parameter is optional

Parameters

  • dbType

    Type of database that needs to be created. Valid values are:

    • SINGLE_INSTANCE —To create a database on one particular host or a list of hosts.

    • RAC — To create a cluster database on multiple nodes.

    • RACONE — To create a RAC One-node database.

    RAC and RACONE require the use of the cluster parameter.

  • hostTargets

    Comma-separated list of host targets where a single-instance database needs to be created. This is a mandatory parameter for a SINGLE_INSTANCE database.

  • cluster

    Cluster target name for the RAC database on which a cluster needs to be created. The target name should be valid and should have at least one node attached to the target. This is a mandatory parameter for RAC and RACONE databases.

  • oracleHome

    Oracle home of the host targets or cluster target. The Oracle home should be present in all of the targets.

  • gdbName

    Global database name of the database.

  • templateName

    Fully-qualified path of the template if the template is located at the Oracle home. Otherwise, provide the display name if the template is present in the software library.

  • hostCreds

    Named host credentials of the user who owns the Oracle Home installation.

  • sysCreds

    Named database credentials to be used to create the SYS user.

  • systemCreds

    Named database credentials to be used to create the SYSTEM user.

  • dbsnmpCreds

    Named database credentials to be used to create the DBSNMP user.

  • sid

    Database system identifier., which can be a maximum length of 12 for SINGLE_INSTANCE, 8 otherwise. This should be alphanumeric, with the first character being an alpha character.

  • racConfigType

    RAC configuration type. Valid values are:

    • POLICY_MANAGED

    • ADMIN_MANAGED

    The default is ADMIN_MANAGED if not provided.

  • nodeList

    List of valid node names for ADMIN_MANAGED RAC databases. If not provided, all the nodes for the given cluster target are used.

  • serverPoolList

    Comma-separated list of server pool names for POLICY_MANAGED RAC databases.

  • newServerPool

    Note:

    You can either use serverPoolList or newServerPool, but not both. For newServerPool, cardinality is mandatory and should be a positive integer greater than 0.
  • racOneServiceName

    Service name for the RAC One Node database.

  • templateInSwlib

    Boolean value stating whether the template is from the software library. Valid values are TRUE if the template is from the software library, otherwise FALSE. The default is FALSE if you do not provide this parameter.

  • templateStageLocation

    Fully-qualified path to where the template should be staged on the host target.

  • storageType

    Type of storage preferred for the database. Valid values are:

    • FS for File System. This is the default if the parameter is not provided.

    • ASM for Automatic Storage Management.

  • dataFileLocation

    Location of the data files.

  • recoveryAreaLocation

    Fast Recovery Area location.

  • enableArchiving

    Indicates whether archiving of the database is required. Valid values are TRUE if archiving is required, otherwise FALSE. The default is FALSE.

  • useOMF

    Indicates whether to use Oracle Managed Files.

  • listeners

    Comma-separated list of listeners (name:port) to register the created database. This is for the SINGLE_INSTANCE database type only, and will be ignored for a RAC database.

  • newListener

    New listener (name:port) creates a new listener and registers the database. This is for the SINGLE_INSTANCE database type only, and will be ignored for a RAC database.

Examples

Example 1

emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=host_named
                       -sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/ dbhome_2/assistants/dbca/templates/General_Purpose.dbc
                       -dbType=SINGLE_INSTANCE -hostTargets=host1

Example 2

emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=host_named
                       -sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/ dbhome_2/assistants/dbca/templates/General_Purpose.dbc
                       -dbType=SINGLE_INSTANCE -hostTargets=host1 -newListener=NEWLSNR:1527 

Example 3

emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testRACCli -hostCreds=cluster_named -sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp 
                       -templateName=/u01/app/oracle/product/11.2.0/ dbhome_2/assistants/dbca/templates/General_Purpose.dbc -dbType=RAC -cluster=cluster1
                       -dataFileLocation=/u01/share/oradata -recoveryAreaLocation=/u01/share/fra 

Example 4

emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=cluster_named
                       -sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/ dbhome_2/assistants/dbca/templates/General_Purpose.dbc
                       -dbType=RAC -cluster=cluster1 -racConfigType=POLICY_MANAGED -newServerPool=sp1:2 

create_diag_snapshot

Creates a diagnostic snapshot for specified targets.

Format

emcli create_diag_snapshot  
      -name=<name>
      -desc=<description>
      -start_time=<yyyy/MM/dd HH:mm> 
      -end_time=<yyyy/MM/dd HH:mm> 
      -targets=<type1:name1;type2:name2;…>
      [-diag_type_odl_target_types=<type1;type2; ….>]
      [-diag_type_odl_online_logs=<true|false>]
      [-diag_type_odl_offline_logs=<true|false>]
      [-diag_type_jvmd_target_types=<type1;type2; ….>]
      [-diag_type_jvmd_properties=”<pname1:pval1;pname2:pval2;…>”]
      [-debug]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of diagnostic snapshot to be created. Make sure that a diagnostic snapshot does not exists for the specified name.

  • desc

    Description of the diagnostics snapshot.

  • start_time

    Start time for collecting the logs. The snapshot will contain all logs between the start time and end time. Make sure that the duration is valid for the snapshot.

  • end_time

    End time for collecting the logs. The snapshot will contain all logs between the start time and end time. Make sure that the duration is valid for the snapshot.

  • targets

    Target type and target name list for the snapshot. This list can contain all targets for the specific system. User can choose specific target types in optional parameters for selected diagnostic types.

  • diag_type_odl_target_types

    Target type list for the Oracle Diagnostic Logging (ODL) diagnostic type. You can select a subset of target types from the target list for snapshot creation.

  • diag_type_odl_online_logs

    By default, online logs are collected for a snapshot. You can choose to collect online, offline, or both logs for the Oracle Diagnostic Logging (ODL) diagnostic type.

  • diag_type_odl_offline_logs

    By default, offline/archive logs are not collected for a snapshot. You can choose to collect online, offline, or both logs for the Oracle Diagnostic Logging (ODL) diagnostic type.

  • diag_type_jvmd_target_types

    Target type list for the JVMD diagnostic type. You can select a subset of target types from the target list for snapshot creation.

  • diag_type_jvmd_properties

    Properties list to collect logs for the JVMD diagnostic type.

  • debug

    Runs the verb in verbose mode for debugging purposes.

Examples

Example 1

The following example creates a snapshot for EMGC_DOMAIN and EMGC_OMS1 targets with offline logs. The target types (weblogic_domain and weblogic_j2eeserver) belong to the Oracle Diagnostic Logging (ODL) diagnostic type.

emcli create_diag_snapshot 
      –name=wls_snapshot 
      –desc= “Snapshot for Weblogic Domains and Server” 
      –start_date=”2012/10/02 10:30” 
      -end_date=”2012/10/03 22:30” 
      –targets=”weblogic_domain:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN;
                weblogic_j2eeserver: /EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1”

Example 2

The following example creates a snapshot for the weblogic_j2eeserver target type with offline logs. You can filter the target types on top of the target list.

emcli create_diag_snapshot 
      –name=wls_snapshot 
      –desc=“Snapshot for Weblogic Domains and Server” 
      –start_date=”2012/10/02 10:30” 
      -end_date=”2012/10/03 22:30” 
      –targets=”weblogic_domain:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN;
              weblogic_j2eeserver:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1;
              weblogic_j2eeserver:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_ADMIN_SERVER” 
      -diag_type_odl_target_types=”weblogic_j2eeserver” 
      -diag_type_odl_offline_logs=true

create_fmw_domain_profile

Creates a Fusion Middleware provisioning profile from a WebLogic Domain.

Format

emcli create_fmw_domain_profile 
        -name="profile_name" 
        -ref_target="reference_target_name" 
        [-description="profile_description"] 
        [-oh_cred="Oracle_home_owner_credentials"] 
        [-includeOh] 
        [-schedule= 
              start_time:yyyy/MM/dd HH:mm; 
              [tz:{java_timezone_ID}]; 
              [grace_period:xxx]; 
        ] 

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the profile to be created.

  • ref_target

    Name of the WebLogic Domain target to be used as a reference to create the profile.

  • description

    Description of the profile to be created.

  • oh_cred

    Named credential to be used to access the reference host. The format is:

    CREDENTIAL_NAME:CREDENTIAL_OWNER
    

    All operations are performed on the Administration Server host. Credentials of the Oracle Home owner on the Administration Server host are required. If no named credential is provided, preferred host credentials for the Oracle Home target are used.

  • includeOh

    Includes the Oracle Home binaries in the profile.

  • schedule

    Schedule for the Deployment Procedure. If not specified, the procedure executes immediately.

    • start_time: Time when the procedure should start.

    • tz: Time zone ID.

    • grace_period: Grace period in minutes.

Examples

Example 1

The following example creates a WebLogic Domain profile for the specified schedule from the given WebLogic Domain target using preferred credentials.

emcli create_fmw_domain_profile 
      -name="BitlessDomainProfile" 
      -ref_target="/Farm01_base_domain/base_domain" 
      -description="A domain profile without software bits" 
      -schedule="start_time:2014/6/21 21:23;tz:America/New_York;grace_period:60" 

Example 2

The following example immediately creates a WebLogic Domain plus Oracle Home from the given WebLogic Domain target using given named credentials.

emcli create_fmw_domain_profile 
      -name="DomainProfileWithBits" 
      -ref_target="/Farm01_base_domain/base_domain" 
      -oh_cred="MY_HOST_CRED:SYSMAN" 
      -includeOh 

create_fmw_home_profile

Creates a Fusion Middleware provisioning profile from an Oracle Home.

Format

emcli create_fmw_home_profile 
        -name="profile_name" 
        -ref_target="reference_target_name" 
        [-description="profile_description"] 
        [-oh_cred="Oracle_home_owner_credentials"] 
        [-schedule= 
              start_time:yyyy/MM/dd HH:mm; 
              [tz:{java timezone ID}]; 
              [grace_period:xxx]; 
        ] 

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the profile to be created.

  • ref_target

    Name of the Oracle Home target to be used as a reference to create the profile.

  • description

    Description of the profile to be created.

  • oh_cred

    Named credential to be used to access the reference host. The format is:

    CREDENTIAL_NAME:CREDENTIAL_OWNER
    

    If no named credential is provided, preferred host credentials for the Oracle Home target are used.

  • schedule

    Schedule for the Deployment Procedure. If not specified, the procedure executes immediately.

    • start_time: Time when the procedure should start.

    • tz: Time zone ID.

    • grace_period: Grace period in minutes.

Examples

Example 1

The following example creates a profile on the specified schedule from the given Oracle Home target using preferred credentials.

emcli create_fmw_home_profile 
      -name="OhProfile1" 
      -ref_target="/Farm01_base_domain/base_domain" 
      -description="An Oracle Home profile" 
      -schedule="start_time:2014/6/21 21:23;tz:America/New_York;grace_period:60" 

Example 2

The following example immediately creates a profile from the given Oracle Home target using given named credentials.

emcli create_fmw_home_profile 
      -name="OhProfile2" 
      -ref_target="WebLogicServer_10.3.6.0_myhost.mycompany.com_5033" 
      -oh_cred="MY_HOST_CRED:SYSMAN" 

create_group

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

Command-Line Format

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

[ ] indicates that the parameter is optional

Scripting and Interactive Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the group.

  • type

    Group type: group. Defaults to "group".

  • add_targets

    Add existing targets to the group. Each target is specified as a name-value pair target_name:target_type. You can specify this option more than once in command-line format.

  • is_propagating

    Flag that indicates whether or not privilege on the group will be propagated to member targets. The default is false.

Examples

The following examples create a database-only group named db_group. This group consists of two Oracle databases: emp_rec and payroll.

Example 1 - Command-Line

emcli create_group 
      -name=db_group
      -add_targets="emp_rec:oracle_database"
      -add_targets="payroll:oracle_database"

Example 2 - Scripting and Interactive

create_group
       (name="db_group"
       ,add_targets="emp_rec:oracle_database;payroll:oracle_database")

The following examples create a mixed member-type group named my_group that consists of an Oracle database (database2), listener (dblistener), and host (mymachine.myco.com).

Example 3 - Command-Line

emcli create_group 
      -name=my_group
      -add_targets="database2:oracle_database;dblistener:oracle_listener
      -add_targets="mymachine.myco.com:host"

Example 4 - Scripting and Interactive

create_group
       (name="my_group"
       ,add_targets="database2:oracle_database;         dblistener:oracle_listener;mymachine.myco.com:host")

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

Example 5 - Command-Line

emcli create_group 
      -name=my_hosts
      -add_targets="example.com:host"
      -add_targets="example.com:host;supersun.example.com:host"

Example 6 - Scripting and Interactive

create_group        (name="my_hosts"
       ,add_targets="example.com:host;example.com:host;supersun.example.com:host")

create_inst_media_profile

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

Command-Line Format

emcli create_inst_media_profile 
       -name="profile_name" 
       -host="host_target" 
       -version="media_version" 
       -platform="media_platform" 
       [-description="profile_description"] 
       [-host_cred="Oracle_home_owner_credentials"] 
       -files= 
             WebLogic:WLSFile1; 
             SOA:SOAFile1,SOAFile2; 
             OSB:OSBFile; 
             RCU:RCUFile; 

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the profile to be created.

  • host

    Name of the host target that where all of the installation files are stored.

  • version

    Version of the installation media.

  • platform

    Platform for which the installation media is applicable.

  • description

    Description of the profile to be created.

  • host_cred

    Named credential to be used to access the files. The format is:

    CREDENTIAL_NAME:CREDENTIAL_OWNER. 
    

    If you do not provide a named credential, preferred host credentials for the Oracle Home target are used.

  • files

    List of files to be uploaded to the Software Library. Acceptable products are WebLogic, SOA, OSB and RCU. An upload for WebLogic is mandatory. The format is:

    PRODUCT1:FILE1,FILE2;PRODUCT2:FILE3,FILE4
    

Examples

Example 1

The following example uploads the installation media file for the WebLogic Server to the Software Library from the given location on the given host. Preferred host credentials will be used to access the files.

emcli create_inst_media_profile 
      -name="WebLogic1036Installer" 
      -host="myhost.mycompany.com" 
      -description="WebLogic Server 10.3.6.0 installer" 
      -version="10.3.6.0" 
      -platform="Generic" 
      -files="WebLogic:/u01/media/weblogic/wls1036_generic.jar" 

Example 2

The following example uploads the installation media files for SOA and the WebLogic Server to the Software Library from the given location on the given host. The provided named credentials are used to access the files.

emcli create_inst_media_profile 
      -name="SOA+WLSInstaller" 
      -host="myhost.mycompany.com" 
      -description="SOA 11.1.1.7.0 and WebLogic Server 10.3.6.0 installer" 
      -version="11.1.1.7.0" 
      -platform="Generic" 
      -host_cred="MY_HOST_CRED:SYSMAN"
      -files="WebLogic:/u01/media/weblogic/        wls1036_generic.jar;SOA:/u01/media/soa/soa1.zip,/u01/media/soa/soa2.zip" 

create_job

Creates and schedules a job. This verb supports multi-task jobs.

Note:

EM CLI permits OS Script jobs to be run against database targets by setting the targetType property for -input_file in the create_job verb. For example:
targetType=oracle_database

You can set other target types similarly.

EM CLI supports the following job types:

ASMSQLScript
ASSOCIATE_CS_FA
ASSOCIATE_DOMAIN_FA
AssociateClusterASM
BlockAgent
CoherenceCacheAddition
CoherenceNodesRefresh
Config Log Archive Locations
DbMachineDashboard
DiscoverPDBEntities
FusionMiddlewareProcessControl
GlassFishProcessControl
InstallKernelModuleJob
Log Rotation
OSCommand
OpatchPatchUpdate_PA
RMANScript
RefreshFromEMStore
RefreshFromMetalink
RefreshFusionInstance
SOABulkRecovery
SQLScript
ShutdownDB
StartDepartedCohNodes
StartDepartedCohStoreNodes
StartFusionInstance
StartupDB
StatspackPurge
StopFusionInstance
Upgrade Exalogic Systems
WebLogic Control
WebLogic Domain Discover
WebLogic Domain Refresh

Note:

Not all job types support all target types. Use describe_job_type to determine which target types are supported for a given job type.

Format

emcli create_job
   -input_file=property_file:"filename"
   [-name="job_name"]
   [-type="job_type"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the job.

  • job_type

    Name of the job type. You can obtain a template property file for the job type by using the describe_job_type verb.

  • input_file

    Provide the file name to load the properties for creating and scheduling the job. The property file must be accessible to the EM CLI client for reading. Another job of the same job type could also be used to generate the property file using the EM CLI verb describe_job.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Example

The following example creates and schedules a job with name MYJOB1 and job type MyJobType1 with the property file present at location /tmp/myjob1_prop.txt .

emcli create_job -name=MYJOB1 -job_type=MyJobType1 -input_file="property_file:/tmp/myjob1_prop.txt"

create_job_from_library

Creates a job using a library job as a template. This verb supports multi-task jobs.

Format

emcli create_job_from_library
    -lib_job_name="library_job_name"
    -name="new_job_name"
   [-owner="library_job_owner"]
   [-input_file=property_file:"filename"]
   [-appendtargets]

[ ] indicates that the parameter is optional

Parameters

  • lib_job_name

    Library job to use as a template.

  • owner

    Owner of the job. When this parameter is not specified, the default job owner is the logged in Enterprise Manager administrator.

  • name

    Name of the new job to be created. You can also specify the name in the property file. If no name is specified, a name is generated from the name of the library job.

  • input_file

    "filename" can be provided to load the properties for creating the job.

    If you specify a property file, the values in the property file override or append to existing values in the library job. If you do not specify a property file, the library job is submitted unchanged.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • appendtargets

    Appends targets in the property file to existing targets in the library job. Otherwise, library job targets are overwritten by targets in the property file if they are specified.

Examples

Example 1

The following example creates a job named MYJOB based on the library job MYLIBJOB1.

emcli create_job_from_library -lib_job_name=MYLIBJOB1 -name=MyJob

Example 2

The following example creates a job named MYJOB2 based on the library job MYLIBJOB1. Properties in /tmp/myjob1_prop.txt will override library job settings.

emcli create_job_from_library -lib_job_name=MYLIBJOB1 -name=MyJob2 -input_file=property_file:/tmp/myjob1_prop.txt

create_library_job

Creates a library job. This verb supports multi-task jobs.

Format

emcli create_library_job
   [-name="job_name"]
   [-type="job_type"]
    -input_file=property_file:"filename"

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the job.

  • type

    Name of the job type. You can obtain a template property file for the job type by using the describe_job_type verb.

  • input_file

    Provide the file name to load the properties for creating the library job. The property file must be accessible to the EM CLI client for reading. Another library job of the same job type could also be used to generate the property file using the EM CLI verb describe_library_job.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Example

The following example creates a library job with the name MYLIBJOB1 and job type MyJobType1 with the property file present at location /tmp/myjob1_prop.txt .

emcli create_library_job -name=MYLIBJOB1 -job_type=MyJobType1  -input_file="property_file:/tmp/myjob1_prop.txt"

create_named_credential

Creates a named credential. You can provide input parameters using command line arguments or an input properties file. It also supports the input_file tag for passwords and parameter values.

Command-Line Format

 emcli create_named_credential         -cred_name=<name>        -auth_target_type=<authenticating_target_type>        -cred_type=<credential_type>        -cred_scope=<credential_scope>        -cred_desc=<credential_description>        -target_name=<target_name>        -target_type=<target_type>        -test         -test_target_name=<test_target_name>        -test_target_type=<test_target_type>        -input_file=<tag:value>        -input_bfile=<tag:value>        -properties_file=<filename>        -attributes=<p1:v1;p2:v2;...>

Scripting and Interactive Format

 create_named_credential         (cred_name=<name>        ,auth_target_type=<authenticating_target_type>        ,cred_type=<credential_type>        ,cred_scope=<credential_scope>        ,cred_desc=<credential_description>        ,target_name=<target_name>        ,target_type=<target_type>        ,test         ,test_target_name=<test_target_name>        ,test_target_type=<test_target_type>        ,input_file=<tag:value>        ,input_bfile=<tag:value>        ,properties_file=<filename>        ,attributes=<p1:v1;p2:v2;...>)

Parameters

  • cred_name

    Credential name, such as MyBackUpCreds. This is required if you do not use properties_file.

  • auth_target_type

    Authenticating target type (e.g. host). This is required if you do not use properties_file.

  • cred_type

    Credential type. This is required if you do not use properties_file.

  • cred_scope

    Possible values are global|instance. The default is global.

  • cred_desc

    Credential description.

  • target_name

    This is required when cred_scope is instance.

  • target_type

    This is required when cred_scope is instance.

  • test

    Use this to test the credential before saving.

  • test_target_name

    Use this to supply the target name to test a global credential. This is required when cred_scope is global and the test parameter is used.

  • test_target_type

    Use this to supply the target type to test a global credential. This is required when cred_scope is global and the test parameter is used.

  • input_file

    Use this to supply sensitive property values from the file.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_bfile

    Use this to supply binary property values from the file.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • properties_file

    Use this to pass all parameters from the file. Values given on the command line take precedence.

  • attributes

    Specify credential columns as follows:

    colname:colvalue;colname:colvalue
    

    You can change the separator value using -separator=attributes=<newvalue>, and you can change the subseperator value using -subseparator=attributes=<newvalue>.

    For more information about the separator and subseperator parameters , see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Examples

The following examples create a HostCreds named credential with username foo and password bar:

Example 1 - Command Line

emcli create_named_credential
        -cred_name=NC1
        -auth_target_type=host
        -cred_type=HostCreds
        -attributes="HostUserName:foo;HostPassword:bar"

Example 2 - Scripting and Interactive

create_named_credential
       (cred_name="NC1" 
       ,auth_target_type="host" 
       ,cred_type="HostCreds"
       ,attributes="HostUserName:foo;HostPassword:bar")

The following examples create a privilege delegation credential with user name foo, password bar, privilege delegation type SUDO, and RUNAS user root:

Example 3 - Command-Line

emcli create_named_credential 
        -cred_name=NC1 
        -auth_target_type=host 
        -cred_type=HostCreds
        -attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:SUDO;RUNAS:root"

To use Powerbroker attributes, the string should be:

-attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:POWERBROKER;RUNAS:root; PROFILE:EMGC

Example 4 - Scripting and Interactive

create_named_credential
       (cred_name="NC1"
       ,auth_target_type="host"
       ,cred_type="HostCreds"
       ,attributes="HostUserName:foo;
        HostPassword:bar;PDPTYPE:SUDO;RUNAS:root")

To use Powerbroker attributes, the string should be:

,attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:POWERBROKER;RUNAS:root; PROFILE:EMGC

The following examples read the password from the mypasswordfile.txt file.

Example 5 - Command-Line

emcli create_named_credential 
        -cred_name=NC1 
        -auth_target_type=host 
        -cred_type=HostCreds
        -attributes="HostUserName:foo;HostPassword:tag"
        -input_file="tag:mypasswordfile.txt"

Example 6 - Scripting and Interactive

create_named_credential
       (cred_name="NC4",
       ,auth_target_type="host"
       ,cred_type="HostCreds" 
       ,attributes="HostUserName:foo;HostPassword:tag" 
       ,input_file="tag:mypasswordfile.txt")

The following examples prompt for the password from standard input:

Example 7 - Command-Line

emcli create_named_credential
        -cred_name=NC1
        -auth_target_type=host 
        -cred_type=HostCreds
        -attributes="HostUserName:foo;HostPassword:"

Example 7 - Scripting and Interactive

create_named_credential
       (cred_name="NC1"
        ,auth_target_type="host"
        ,cred_type="HostCreds"
        ,attributes="HostUserName:foo;HostPassword:bar")

The following examples specify prop1.txt as a multi-line Java properties file, in which each line contains a parameter=value format. You can provide the password in the same file or not specify it. If not specified, you are prompted for it.

Example 8 - Command-Line

emcli create_named_credential
        -properties_file=prop1.txt

Example 9 - Scripting and Interactive

create_named_credential
        (properties_file="prop1.txt")

create_operation_plan

Creates an operational plan for the Oracle Site Guard operation.

Format

emcli create_operation_plan
        -primary_system_name="name_of_primary_system"
        -standby_system_name="name_of_standby_system"
        -system_name="name_of_system"
        -operation="name_of_operation"
        -name="name_of_operation_plan"
        -role="role_associated_with_system"

Parameters

  • primary_system_name

    Name of your system associated with the primary site. Enter this parameter for switchover or failover operations.

  • standby_system_name

    Name of your system associated with the standby site. Enter this parameter for switch-over or fail-over operations.

  • system_name

    Name of the system. Enter this parameter for start or stop operations.

  • operation

    The function of the operation. Examples: switchover, failover, start, or stop.

  • name

    Name of the operation plan.

  • role

    Role associated with a system when you run an operation (start or stop).

Examples

Example 1

emcli create_operation_plan
      -primary_system_name="BISystem1"
      -standby_system_name="BISystem2"
      -operation="switchover"
      -name="BISystem1-switchover-plan"

Example 2

emcli create_operation_plan
      -system_name="austin"
      -operation="start"
      -name="BISystem1-start-plan"
      -role="Primary"

See Also

emcli get_operation_plans and emcli submit_operation_plan


create_patch_plan

Creates a new patch plan with the specified name and the patch-target map.

Format

emcli create_patch_plan
        -name="name"
        -input_file=data:"file_path" 
        [-impact_other_targets="add_all | add_original_only | cancel"] 
        [-problems_assoc_patches="ignore_all_warnings | cancel"] 

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the setting.

  • input_file

    Input data to create a new patch plan. You must provide the data in the property name-value pairs.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • impact_other_targets

    Action to take when other targets are impacted while adding the patches to the plan. Possible values for this parameter are:

    add_all — Add all impacted targets to the plan. add_original_only — Only add original targets to the plan. cancel — Cancel the plan creation.

  • problems_assoc_patches

    Action to take when there are problems associating patches to targets. Possible values for this parameter are:

    ignore_all_warnings — Ignore all warnings. cancel — Cancel the plan creation.

See Also


delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

Examples

emcli create_patch_plan -name="plan_name" -input_file=data:"/tmp/patchplan.props"
emcli create_patch_plan -name="plan name" -input_file=data:"/tmp/patchplan.props" -impact_other_targets="add_all" 

emcli create_patch_plan -name="plan name"  -input_file=data:"/tmp/patchplan.props" -impact_other_targets="add_all" -problems_assoc_patches="ignore_all_warnings" 

You can use the following sample input file to create a patch plan with two patches:

patch.0.patch_id=4518443
         patch.0.release_id=80102010
         patch.0.platform_id=226
         patch.0.language_id=0
         patch.0.target_name=orclws
         patch.0.target_type=oracle_database
         patch.1.patch_id=4424952
         patch.1.release_id=80102030
         patch.1.platform_id=46
         patch.1.language_id=0
         patch.1.target_name=arac
         patch.1.target_type=rac_database

create_pluggable_database

Creates a pluggable database.

Format

emcli create_pluggable_database
-cdbTargetName="CDB_target_name"
-cdbTargetType="CDB_target_type"
-cdbHostCreds="CDB_host_credentials"
-pdbName="new_PDB_name"
-sourceType="DEFAULT|UNPLUGGED_PDB|CLONE"
[-cdbTargetCreds="CDB_target_credentials"]
[-numOfPdbs="number_of_PDBs"]
[-sourceFromSWLIB="Source_from_software_library"]
[-pdbTemplateInSWLIB="URN_of_PDB_template_component"]
[-sourcePDBTempStagingLocation="source_PDB_temporary_staging_location"]
[-unpluggedPDBType="unplugged_PDB_type"]
[-sourcePDBArchiveLocation="source_PDB_archive_location"]
[-sourcePDBMetadataFile="source_PDB_metadata_file"]
[-sourcePDBDatabackup="source_PDB_data_backup"]
[-sourcePDBName="source_PDB_name"]
[-sourceCDBCreds="source_CDB_credentials"]
[-pdbAdminCreds="PDB_admin_crednentials"]
[-useOMF="use_OMF_location"]
[-sameAsSource="store_data_files_in_same_location_as_source_CDB"]
[-newPDBFileLocation="storage_location_for_data_files_of_created_PDB."]
[-createAsClone="create_PDB_as_clone"]
[-lockAllUsers="locks_PDB users_of_new_PDB."]

[ ] indicates that the parameter is optional

Parameters

  • cdbTargetName

    Name of the setting.

  • cdbTargetType

    Type of setting you want to create.

  • cdbHostCreds

    Parameter value. Choose one of the following parameters:

  • pdbName

    Delimiter inserted between name-value pairs for the given name. The default value is a semi-colon ( ; ).

  • sourceType

    Separator inserted between the name and value in each name-value pair for the given name. The default value is a semi-colon ( ; ).

Examples

Example 1

emcli create_pluggable_database -cdbTargetName=database -cdbTargetType=oracle_database 
-pdbName=pdb -sourceType=UNPLUGGED_PDB -unpluggedPDBType=ARCHIVE 
-sourcePDBArchiveLocation=/u01/app/oracle/product/12.1.0/dbhome_2/assistants/dbca/templates/a.tar.gz
-cdbHostCreds=HOST_CREDS -cdbTargetCreds=DBSNMP -newPDBFileLocation=/u01/app/oradata/pdb 
-pdbAdminCreds=pdb_creds -lockAllUsers

Example 2

emcli create_pluggable_database -cdbTargetName=database  -cdbTargetType=oracle_database 
-pdbName=pdb -numOfPdbs=2 -sourceType=UNPLUGGED_PDB -unpluggedPDBType=RMAN  
-sourcePDBMetadataFile=/u01/app/oracle/product/12.1.0/dbhome_2/assistants/dbca/templates/a.xml
-sourcePDBDatabackup=/u01/app/oracle/product/12.1.0/dbhome_2/assistants/dbca/templates/a.dfb 
-cdbHostCreds=HOST_CREDS -cdbTargetCreds=DBSNMP -newPDBFileLocation=/u01/app/oradata/pdb 
-pdbAdminCreds=pdb_creds -createAsClone

create_privilege_delegation_setting

Creates a privilege delegation setting template to apply later. You must create at least one setting to use the apply_privilege_delegation_setting verb.

Command-Line Format

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

[ ] indicates that the parameter is optional

Scripting and Interactive Format

 create_privilege_delegation_setting
         (setting_name="name"
         ,setting_type="ttype"
         [,settings="setting"]
         [,separator=settings=";"]
         [,subseparator=settings=","])

[ ] indicates that the parameter is optional

Parameters

  • setting_name

    Name of the privilege delegation setting template.

  • setting_type

    Type of setting you want to create.

  • settings

    Parameter value. Choose one of the following parameters:

    %USERNAME% — Name of the user running the command. %RUNAS% — Run the command as this user. %COMMAND% — Sudo command.

    The %USER%, %RUNAS%,, %COMMAND% are tokens that the end-user has to use as-is while creating/modifying the privilege delegation settings. The system replaces these tokens with the actual values at run time depending on the command being run and for which user. Also, %command% should be upper case %COMMAND% for 10.2.0.5 GC.

  • separator

    Delimiter inserted between name-value pairs for the given name. The default value is a semi-colon ( ; ).

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • subseparator

    Separator inserted between the name and value in each name-value pair for the given name. The default value is a semi-colon ( ; ).

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Examples

The following examples create a setting named sudo_setting. The setting is of type SUDO, and the Sudo path used is /usr/local/bin/sudo. Sudo arguments are:

-S-u %RUNAS%%COMMAND%

Example 1 - Command-Line

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

Example 2 - Scripting and Interactive

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

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

%RUNAS%%PROFILE%%COMMAND%

Example 3 - Command-Line

emcli create_privilege_delegation_setting
      -setting_name="pb_setting"
      -setting_type="POWERBROKER"
      -settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%"
      -separator="settings=;"
      -subseparator="settings=,"

Example 4 - Scripting and Interactive

create_privilege_delegation_setting
      (setting_name=pb_setting
      ,setting_type=POWERBROKER
      ,settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%"
      ,separator="settings=;"
      ,subseparator="settings=,")

The following examples are similar to examples 3 and 4, except that they also add arguments PASSWORD_PROMPT_STRING and Password.

Example 5 - Command-Line

emcli create_privilege_delegation_setting
      -setting_name="pb_setting"
      -setting_type="POWERBROKER"
      -settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%";
       PASSWORD_PROMPT_STRING,password:"
      -separator="settings=;"
      -subseparator="settings=,"

Example 5 - Scripting and Interactive

create_privilege_delegation_setting
      (setting_name=pb_setting
      ,setting_type=POWERBROKER
      ,settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%";
       PASSWORD_PROMPT_STRING,password:"
      ,separator="settings=;"
      ,subseparator="settings=,")

create_rbk

Creates a retroactive blackout on given targets and updates their availability. Only Enterprise Manager Administrators with OPERATOR privilege on the target can perform this action. The retroactive blackout feature needs to be enabled from the user interface to use this command.

Format

emcli create_rbk 
  -reason="<blackout_reason>"
  -add_targets="name1:type1;name2:type2;..."  
  -schedule="start_time:<yyyy-MM-dd HH:mm:ss>;end_time:<yyyy-MM-dd    HH:mm:ss>;[tzregion:<timezone_region>;]"
  [-propagate_targets]

[ ] indicates that the parameter is optional

Parameters

  • reason

    Reason to be stored for the retroactive blackout. If you have SUPER_USER privileges (you are an Enterprise Manager Super Administrator), any text string can be used for the reason. The reason is added to the list of allowable blackout reasons if it is not already in the list. If you do not have SUPER_USER privileges, you must specify one of the text strings returned by the get_blackout_reasons verb.

  • add_targets

    Targets to add to the retroactive blackout. Each target is specified as target_name:target_type. You can specify this option more than once.

  • schedule

    Schedule for retroactive blackout. The following arguments are mandatory for providing a retroactive blackout schedule:

    • schedule=start_time - The start date/time of the blackout. The format of the value is "yyyy-MM-dd HH:mm:ss". For example: "2013-09-20 12:12:12"

    • schedule=end_time - The end date/time of the blackout. The format of the value is "yyyy-MM-dd HH:mm:ss". For example: "2013-09-20 12:15:00"

    • schedule=tzregion - The timezone region to use. For example: "UTC". If not provided, tzregion is defaulted to UTC.

  • propagate_targets

    A blackout for a target of type "host" applies the blackout to all non-agent targets on the host. Regardless of whether this option is specified, a blackout for a target that is a composite or a group applies the blackout to all members of the composite or group.

Examples

Example 1

The following example creates a retroactive blackout on Oemrep_Database and updates the target's availability record from 2013-09-20 12:12:12 UTC to 2013-09-20 12:15:00 UTC as the blackout.

emcli create_rbk -reason="Testing" 
      -add_targets="Oemrep_Database:oracle_database"
      -schedule="start_time:2013-09-20 12:12:12;end_time:2013-09-20        12:15:00;tzregion:UTC"

Example 2

The following example creates a retroactive blackout for all targets on host example.company.com and updates their availability records from 2013-09-20 12:12:12 UTC to 2013-09-20 12:15:00 UTC as the blackout.

emcli create_rbk -reason="Testing" 
      -add_targets="example.company.com:host"
      -schedule="start_time:2013-09-20 12:12:12;end_time:2013-09-20         12:15:00;tzregion:UTC"
      -propagate_targets

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the redundancy group.

  • type

    Redundancy group type. Defaults to generic_redundancy_group.

  • add_targets

    Add existing targets to the redundancy group. Each target is specified as a name-value pair target_name:target_type. You can specify this option more than once.

  • owner

    Owner of the redundancy group.

  • timezone_region

    Time zone region of this redundancy group.

Example

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|PERCENTAGE]        [-group_status_tracked=UP|DOWN]        [-group_status_value=<group_status_value>]        [-timezone_region=<valid_time_zone_region>]
        [is_propagating=true|false]

[ ] indicates that the parameter is optional

Parameters

  • redundancyGroupName

    Name of the redundancy group.

  • memberTargetType

    Target type of the constituent member targets.

  • memberTargetNames

    Member targets for this redundancy group.

  • group_status_criterion

    This parameter and the next two calculate the status of the Redundancy Group. Consequently, you need to specify all three options together. If this is not to be a capacity group, you need to specify the following combination:

    -group_status_criterion='NUMBER' -group_status_tracked='UP' -group_status_value='1']
    
  • group_status_tracked

    See the parameter above.

  • group_status_value

    See the group_status_criterion parameter.

    You can specify any value between 1 and 100 if -group_status_criterion= "PERCENTAGE", or any value between 1 and the number of targets present if -group_status_criterion="NUMBER".

  • timezone_region

    Time zone region of this redundancy group. For a list of valid time zone regions, enter the following command at SQLPLUS:

    SELECT TZNAME FROM V$TIMEZONE_NAMES
    

    You may need to have the SELECT_CATALOG_ROLE role to execute this command.

  • is_propagating

    Indicates whether or not the privilege on the redundancy group will be propagated to member targets. The default value is false.

Examples

Example 1

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'

Example 2

The following example creates a 'redGrp1' redundancy group with listener, listener2, and listener3 as its member targets and time zone as PST8PDT. The status is calculated as the redundancy group being up if two of its member targets are up.

emcli create_redundancy_group -redundancyGroupName='redGrp1'
          -memberTargetType='oracle_listener'
          -memberTargetNames='listener;listener2;listener3'
          -timezone_region='PST8PDT'
          -group_status_criterion='NUMBER'
          -group_status_tracked='UP'
          -group_status_value='2'

create_resolution_state

Creates a new resolution state that describes the state of incidents or problems. Only super administrators can execute this command. The new state is always added between the New and Closed states. You need to specify the exact position of this state in the overall list of states by using the position option. The position can be between 2 and 98.

The state is applicable by default to both incidents and problems. You can use the applies_to option to indicate that the state is applicable only to incidents or problems. A success message is reported if the command is successful. An error message is reported if the create fails.

Format

emcli create_resolution_state
      -label="label_for_display"
      -position="display_position"
       [-applies_to="INC|PBLM"]

[ ] indicates that the parameter is optional

Parameters

  • label

    End-user visible label of the state. The label cannot exceed 32 characters. You can change this later if needed.

  • position

    Position of this state within the overall list of states. This is used when displaying the list of states in the user interface. The position can be between 2 and 98. You can change the position of the state later if needed.

    It is recommended that you set the position with sufficient gaps to facilitate moving states around. For example, if you set the positions to 5, 10, and 15 instead of 2, 3, and 4, it is easier to move a state from position 15 to 9, for instance, in contrast to the latter scheme, in which you would have to move all states to provide space for the reordering.

  • applies_to

    Indicates that the state is applicable only for incidents or problems. By default, states apply to both incidents and problems. Supported values are "INC" or "PBLM".

Examples

Example 1

The following example adds a resolution state that applies to both incidents and problems at position 25.

emcli create_resolution_state -label="Waiting for Ticket" -position=25

Example 2

The following example adds a resolution state that applies to problems only at position 35.

emcli create_resolution_state -label="Waiting for SR" -position=35 -applies_to=PBLM

create_role

Creates a new Enterprise Manager admininistrator role.

Command-Line Format

emcli create_role
        -name="role_name"
        [-type="type_of_role"]
        [-description="description"]
        [-roles="role1;role2;..."]
        [-users="user1;user2;..."]
        [-privilege="name[;secure_resource_details]]"
        [-separator=privilege="sep_string"]
        [-subseparator=privilege="subsep_string"]

[ ] indicates that the parameter is optional

Scripting and Interactive Format

create_role
        (name="role_name"
        [,type="type_of_role"]
        [,description="description"]
        [,roles="role1;role2;..."]
        [,users="user1;user2;..."]
        [,privilege="name[;secure_resource_details]]"
        [,separator=privilege="sep_string"]
        [,subseparator=privilege="subsep_string"])

[ ] indicates that the parameter is optional

Parameters

  • name

    Role name.

  • type

    Type of role. The default value for this parameter is EM_ROLE. The other possible value is EXTERNAL_ROLE.

  • description

    Description of the role.

  • roles

    List of roles to assign to this new role. Currently, the only built-in role is PUBLIC.

  • users

    List of users to whom this role is assigned.

  • privilege

    Privilege to grant to this role. You can specify this option more than once. Note: Privileges are case-insensitive.

    secure_resource_details should be specified as:

    resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
    
  • separator

    Specify a string delimiter to use between name-value pairs for the value of the privilege option. The default separator delimiter is ";" .

  • subseparator

    Specify a string delimiter to use between name and value in each name-value pair for the value of the privilege option. The default separator delimiter is ";" .

Examples

The following examples create a role named my_new_role with the one-sentence description - "This is a new role called my_new_role". The role combines three existing roles: role1, role2, and role3. The role also has two added privileges: to view the job with ID 923470234ABCDFE23018494753091111 and to view the target host1.example.com:host. The role is granted to johndoe and janedoe.

Example 1 - Command-Line

emcli create_role
      -name="my_new_role"
      -desc="This is a new role called my_new_role"
      -roles="role1;role2;role3"
      -privilege="view_job;923470234ABCDFE23018494753091111"
      -privilege="view_target;host1.example.com:host"
      -users="johndoe;janedoe"

Example 2 - Scripting and Interactive

create_role
      (name="my_new_role"
      ,desc="This is a new role called my_new_role"
      ,roles="role1;role2;role3"
      ,privilege="view_job;923470234ABCDFE23018494753091111"
      ,privilege="view_target;host1.example.com:host"
      ,users="johndoe;janedoe")

The following examples create a role named my_external_role with a role type of EXTERNAL_ROLE and one-sentence description of "This is an external role."

Example 3 - Command-Line

emcli create_role
      -name="my_external_role"
      -type="EXTERNAL_ROLE"
      -desc="This is an external role"

Example 4 - Scripting and Interactive

create_role
      (name="my_external_role"
      ,type="EXTERNAL_ROLE"
      ,desc="This is an external role")

create_service

Creates a service to be monitored by Enterprise Manager.

Format

emcli create_service
      -name='name'
      -type='type'
      -availType=test|system
      -availOp=and|or
      [-hostName=<host_name>
      [-agentURL=<agent_url>
      [-properties='pname1|pval1;pname2|pval2;...']
      [-timezone_region=<gmt_offset>]
      [-systemname=<system_name>]
      [-systemtype=<system_type>]
      [-keycomponents='keycomp1name:keycomp1type;keycomp2name:keycomp2type;...']
      [-beacons='bcn1name:bcn1isKey;bcn2name:bcn2isKey;...']
      [-input_file="template:Template file name]"]
      [-input_file="variables:Variable file name]"]
      [-sysAvailType=<availability_type>]

[ ] indicates that the parameter is optional

Parameters

  • name

    Service name. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks.

  • type

    Service type.

  • availType

    Sets the availability to either test-based or system-based. If availability is set to test, template file, beacons, and variable are required arguments. If availability is set to system, systemname, systemtype, and keycomponents are required.

  • availOp

    Availability operator. If and, uses all key tests/components to decide availability. If or, uses any key tests/components to decide availability.

  • hostName

    Network name of the system running the Management Agent that is collecting data for this target instance.

  • agentURL

    URL of the Management Agent that is collecting data for this target instance. If you enter the host name, the Agent URL of the host is automatically entered in this field.

  • properties

    Name-value pair (that is, prop_name|prop_value) list of properties for the service instance.

  • timezone_region

    GMT offset for this target instance (-7 or -04:00 are acceptable formats).

  • systemname

    System name on which service resides.

  • systemtype

    Type of system for which you want to create the service.

  • keycomponents

    Name-type pair (that is, keycomp_name:keycomp_type) list of key components in the system that are used for the service.

  • beacons

    Name-isKey pairs that describe the beacons of the service. If isKey is set to Y, beacon is set as a key-beacon of the service. The service should have at least one key beacon if the availability is set to test-based.

  • input_file

    Template file name is the XML file that includes the template definition. Variable file defines the values for the template.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • sysAvailType

    Type of availability when the availType is system-based. Sets the availability to either system target directly or selected components of a system.

    If availability is set to 'system target directly,' the system needs to have availability[status] defined. systemname and systemtype are required parameters.

    If availability is set to 'selected components of a system,' systemname, systemtype and keycomponents are required parameters.

    If availability is set to 'system target directly,' and if the system does not have availability[status] defined, the availability set is invalid. Therefore, the only option that can be set is 'selected components of a system'.

Examples

Example 1

The following example creates a generic service named my_service with specified properties on a generic system named my_system. The availability is set as system-based, and the availability is based on system target status.

emcli create_service
      -name='my service' -type='generic_service' 
      -availType='system' -availOp='or' 
                        -sysAvailType='system target directly'
      -properties='prop1:value1; prop2:value2'
      -timezone_region='PST8PDT'
      -systemname='my system' -systemtype='generic_system'

Example 2

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'

Example 3

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_siteguard_configuration

Creates a site configuration for Site Guard. It associates the systems and their roles.

Format

emcli create_siteguard_configuration
      -primary_system_name=<name>
      -standby_system_name=<name1;name2;...>

Parameters

  • primary_system_name

    Name of the system associated with the primary site.

  • standby_system_name

    Name of the system associated with the standby system. You can specify more than one system name.

Examples

emcli create_siteguard_configuration
      -primary_system_name="BISystem1"
      -standby_system_name="BISystem2"

See Also

update_siteguard_configuration

delete_siteguard_configuration


create_siteguard_credential_association

Associates the credentials with the targets in a site.

Format

emcli create_siteguard_credential_association
      -system_name=<name>
      [-target_name=<name>]
      -credential_type=<type>
      [-credential_name=<name>]
      [-use_preferred_credential=<type>]
      -credential_owner=<owner>

[ ] indicates that the parameter is optional.

Parameters

  • system_name

    Name of the system.

  • target_name

    Name of the target.

  • credential_type

    Type of credential, which can be HostNormal, HostPrivileged, WLSAdmin, or DatabaseSysdba.

  • credential_name

    Name of the credential. If you do not specify this parameter, you need to specify the use_preferred_credential parameter.

  • use_preferred_credential

    Name of the credential. If you do not specify this parameter, you need to specify the credential_name parameter.

  • credential_owner

    Owner of the credential.

Examples

Example 1

emcli create_siteguard_credential_association
      -system_name="BISystem1"
      -credential_type="HostNormal"
      -credential_name="HOST-SGCRED"
      -credential_owner="sysman"

Example 2

emcli create_siteguard_credential_association
      -system_name="BIsystem1"
      -target_name="database-instance"
      -credential_type="HostNormal"
      -credential_name="HOST-DBCRED"
      -credential_owner="sysman"

create_siteguard_script

Associates scripts (pre-script, post-script, and storage script) with the Site Guard configuration.

Format

emcli create_siteguard_script
      -system_name=<name>
      -operation=<name>
      -script_type=<type>
      [-host_name=[<name1;name2;...>]
      -path=<path_of_script>
      [-all_hosts=true|false]
      [-role=Primary|Standby]

[ ] indicates that the parameter is optional.

Parameters

  • system_name

    Name of the system.

  • operation

    Name of the operation. Examples: Switchover, Failover, Start, or Stop.

  • script_type

    Type of script, which can be Mount, UnMount, Pre-Script, Post-Script, Failover, or Switchover.

  • host_name

    Name of the host where this script will run. You can specify this option more than once.

  • path

    Path to the script.

  • all_hosts

    Allows the script to run on all the hosts in the system. This parameter overrides the host_name.

  • role

    Configures the script based on the system role. By default, the script is configured for both primary and standby roles for a given system.

Examples

Example 1

emcli create_siteguard_script
      -system_name="BISystem1"
      -operation="Switchover"
      -script_type="Pre-Script"
      -path="/tmp/prescript"
      -all_hosts="true"
      -role="Primary"

Example 2

emcli create_siteguard_script
      -system_name="BISystem1"
      -operation="Switchover"
      -script_type="Pre-Script"
      -path="/tmp/prescript"
      -host_name="BIHOST1"
      -host_name="BIHOST2"

create_swlib_entity

Creates an entity in the software library. Upon successful creation, the entity revision appears under the specified folder on the software library home page.

Format

emcli create_swlib_entity 
      -name="entity_name" 
      -folder_id="folder_id" 
      [-type]="type_internal_id"] 
      [-subtype]="subtype_internal_id"] 
      [-desc="entity_desc"] 
      [-attr="<attr_name>:<attr value>"] 
      [-prop="<prop_name>:<prop value>"] 
      [-secret_prop="<secret_prop_name>:<secret_prop=_value>"] 
      [-note="note_text"] 

[ ] indicates that the parameter is optionalis optional

Parameters

  • name

    Name of the entity.

  • folder_id

    Identifier of the folder where the entity is to be created. The software library home page exposes the identifier for folders and entities as a custom column (Internal ID), and is hidden by default.

  • type

    Use the list_swlib_entity_types verb to identify the type.

  • subtype

    Internal identifier of the entity subtype, which defaults to the 'Generic Component' subtype for the 'Component' type. Use the list_swlib_entity_types verb to identify the subtype.

  • desc

    Description of the entity.

  • attr

    An attribute and its value, separated by a colon ( : ). To specify values for multiple attributes, repeat this option.

  • prop

    A configuration property and its value, separated by a colon ( : ). To specify values for multiple properties, repeat this option.

  • secret_prop

    A configuration property and its secret value separated by a colon ( : ). It is recommended to not specify the secret value on the command line. If omitted from the command line, the value is prompted for. To specify values for multiple properties, repeat this option.

  • note

    A note on the entity. For multiple notes, repeat this option.

Examples

Example 1

The following example creates an entity named 'myAcmeInstall' under the specified folder. The entity is of type 'Component' and subtype 'Generic Component, by default. The folder identifier value can be found on the software library home page. The software library home page exposes the identifier for folders and entities as a custom column (Internal ID), and is hidden by default.

emcli create_swlib_entity 
      -name="myAcmeInstall" 
      -folder_id= "oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"  

Example 2

The following example creates an entity named 'myAcmeInstall' under the specified folder with the specified description. The entity is of type 'Component' and subtype 'Generic Component' by default. Values for the entity attributes, viz. PRODUCT, PRODUCT_VERSION and VENDOR, are specified. The value for the configuration property named DEFAULT_HOME is specified. A note on the entity is also specified. The identifier of the newly created entity revision is printed on the standard output.

emcli create_swlib_entity 
      -name="myAcmeInstall" 
      -folder_id= "oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
       -desc="myAcmeInstall description" 
       -attr="PRODUCT:Acme" 
       -attr="PRODUCT_VERSION:3.0" 
       -attr="VENDOR:Acme Corp" 
       -prop="DEFAULT_HOME:/u01/acme3/" 
       -note="myAcmeInstall for test servers" 

create_swlib_folder

Creates a folder in the software library.

Format

emcli create_swlib_folder 
      -name="folder_name" 
      -parent_id="parent_folder_id" 
      [-desc="folder_description"] 

[ ] indicates that the parameter is optionalis optional

Parameters

  • name

    Name of the folder.

  • parent_id

    Identifier of the parent folder under which the folder is to be created. To create a folder under the root folder, specify the parent folder identifier as 'ROOT.' The software library home page exposes the identifier for folders and entities as a custom column (Internal ID) and is hidden by default.

  • desc

    Description of the folder.

Example

The following example creates a folder named 'myFolder' under the specified parent folder.

emcli create_swlib_folder
       -name="myFolder"
       -parent_id= "oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
       -desc="myFolder description"

create_system

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

Format

emcli create_system
      -name="name"
      [-type=<system>]
      [-add_members="name1:type1:key_member/non_key_member;name2:type2;..."]...
      [-separator=add_members="sep_value"]
      [-subseparator=add_members="subsep_value"]
      -timezone_region="actual_timezone_region"
      [-owner="owner"]
      [-meta_ver="meta_version_of_system_type"]
      [-is_propagating="true|false"]
      [-availability_type="ALL|ANY"]

[ ] indicates that the parameter is optionalis optional

Parameters

  • name

    Name of the system.

  • type

    System type: generic_system. Defaults to "generic_system".

  • add_members

    Add existing targets to the system. Each target is specified as a name-value pair target_name:target_type. You can specify this option more than once. key_member specifies that this target is a part of the systems availability calculation.

  • separator

    Name-value pair separator for the given argument.

  • subseparator

    Separates the name from the value for the given argument.

  • timezone_region

    Actual time zone region.

  • owner

    Owner of the system.

  • meta_ver

    Meta version of the system type. Defaults to "1.0".

  • is_propagating

    Flag to indicate if the privilege on the system will be propagated to member targets or not. The default value is false.

  • availability_type

    Availability calculation method of the system. Defining this is required if key_member is defined. ALL denotes that all key members must be up in order to mark the system as up. ANY denotes that at least one of the key members must be up in order to mark the system as up.

Examples

Example 1

The following example creates a generic system named db_system and supports backward compatibility. This system consists of two Oracle databases: emp_rec and payroll. The owner of this system is user1. The meta version of the system type is 3.0.

emcli create_system -name=db_system
      -add_members="emp_rec:oracle_database"
      -add_members="payroll:oracle_database"
      -timezone_region="PST8PDT"
      -owner="user1"

Example 2

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. The example supports backward compatibility.

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

Example 3

The following example creates a generic system named db_system1. This system consists of two Oracle databases: emp_rec and payroll. emp_rec is a key member for the system. The availability calculation method is if ANY of the key members is up, the system is up. The meta version of the system type is 3.0. This example shows the recommended method for creating a system.

emcli create_system -name=db_system1
      -add_members="emp_rec$oracle_database$key_member"
      -add_members="payroll$oracle_database"
      -subseparator=add_members="$"
      -timezone_region="PST8PDT"
      -availability_type="ANY"

create_udmmig_session

Creates a session to migrate user-defined metrics (UDMs) to metric extensions for targets.

Format

emcli create_udmmig_session
      -name=<session_name>
      -desc=<session_description>
      [-udm_choice=<specific_udm_to_convert>]*
      {-target=<type:name_of_target_to_migrate> }* 
      | {-input_file=targetList:<complete_path_to_file>};          {-template=<template_name_to_update> }* 
      | {-input_file=templateList:<complete_path_to_file>}
      [-allUdms]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the migration session to be created.

  • desc

    Description of the migration session to be created.

  • udm_choice

    Specify if the session should migrate specific UDMs. Otherwise, all UDMs are migrated.

  • target

    The type:name of the target to be updated. You can specify multiple values.

  • input_file=targetList

    Specify a file name that contains a list of targets, one per line, in the following format:

    <targetType>:<targetName>
    

    For more information about the input_file parameter see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • template

    Name of the monitoring template to update. You can specify multiple values.

  • input_file=templateList

    Specify a file name that contains a list of templates, one name per line.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • allUdms

    Forces the session to contain all UDMs from targets and templates. (The default behavior just selects those not in a session.)

Examples

Example 1

The following example creates a new session named hostsession that migrates the UDM hostudm on the target testhost.

emcli create_udmmig_session 
      -name=hostsession -desc="Convert UDMs for Host Target"  
      -udm_choice=hostudm -target=host:testhost

Example 2

The following example creates a new session named hostsession that migrates all the unconverted UDMs on the target testhost that are not in a session.

emcli create_udmmig_session 
      -name=hostsession -desc="Convert UDMs for Host Target"
      -target=host:testhost -allUdms

create_user

Creates a new Enterprise Manager administrator.

Command-Line Format

emcli create_user
        -name="name"
        -password="password"
        [-type="user_type"]
        [-roles="role1;role2;..."]
        [-email="email1;email2;..."]
        [-privilege="name[;secure-resource-details]]"
        [-separator=privilege="sep_string"]
        [-subseparator=privilege="subsep_string"]
        [-profile="profile_name"]
        [-desc="user_description"]
        [-expired="true|false"]
        [-prevent_change_password="true|false"]
        [-department="department_name"]
        [-cost_center="cost_center"]
        [-line_of_business="line_of_business"]
        [-contact="contact"]
        [-location="location"]
        [-input_file="arg_name:file_path"]

[ ] indicates that the parameter is optional

Scripting and Interactive Format

emcli create_user
        (name="name"
        ,password="password"
        [,type="user_type"]
        [,roles="role1;role2;..."]
        [,email="email1;email2;..."]
        [,privilege="name[;secure-resource-details]]"
        [,separator=privilege="sep_string"]
        [,subseparator=privilege="subsep_string"]
        [,profile="profile_name"]
        [,desc="user_description"]
        [,expired="true|false"]
        [,prevent_change_password="true|false"]
        [,department="department_name"]
        [,cost_center="cost_center"]
        [,line_of_business="line_of_business"]
        [,contact="contact"]
        [,location="location"]
        [,input_file="arg_name:file_path"])

[ ] indicates that the parameter is optional

Parameters

  • name

    Administrator name.

  • password

    Administrator password.

  • type

    Type of User. The default value of this parameter is EM_USER. Possible values for this parameter are:

    • EM_USER

    • EXTERNAL_USER

    • DB_EXTERNAL_USER

  • roles

    List of roles to grant to this administrator. Currently, the built-in roles include PUBLIC.

  • email

    List of e-mail addresses for this administrator.

  • privilege

    Privilege to grant to this administrator. You can specify this option more than once in command-line format. The original administrator privileges will be revoked. Specify <secure_resource_details> as:

    resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
    

    To retrieve the list of system privileges that do not require resource information, execute the get_supported_privileges command.

  • separator

    Specify a string delimiter to use between name-value pairs for the value of the privilege option. The default separator delimiter is a semi-colon ( ; ).

  • subseparator

    Specify a string delimiter to use between name and value in each name-value pair for the value of the privilege option. The default subseparator delimiter is a colon ( : ).

  • profile

    Database profile name. It uses DEFAULT as the default profile name.

  • desc

    User description for the user being added.

  • expired

    Use this option to expire the password immediately. The default is false.

  • prevent_change_password

    When set to true, you cannot change your own password. The default is false.

  • department

    Name of the department of the administrator.

  • cost_center

    Cost center of the administrator in the organization.

  • line_of_business

    Line of business of the administrator.

  • contact

    Contact information of the administrator.

  • location

    Location of the administrator.

  • input_file

    Allow the administrator to provide the value of any argument in a file. The format of the value will be the name_of_argument:file_path_with_file_name. You can specify this option more than once.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Examples

The following examples create an Enterprise Manager administrator named new_admin. This administrator has two privileges: the ability to view the job with ID 923470234ABCDFE23018494753091111 and the ability to view the target host1.example.com:host. The administrator new_admin is granted the PUBLIC role.

Example 1 Command-Line

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

Example 2 - Scripting and Interactive

create_user
      (name="new_admin"
      ,password="oracle"
      ,email="first.last@example.com;joe.shmoe@shmoeshop.com"
      ,roles="public"
      ,privilege="view_job;923470234ABCDFE23018494753091111"
      ,privilege="view_target;host1.example.com:host")

The following examples make User1 an Enterprise Manager user, which is already created on an external user store like the SSO server. The contents of priv_file are view_target;host1.example.com:host . User1 will have view privileges on the host1.example.com:host target.

Example 3 - Command-Line

emcli create_user
      -name="User1"
      -type="EXTERNAL_USER"
      -input_file="privilege:/home/user1/priv_file"

Example 4 - Scripting and Interactive

create_user
      (name="User1"
      ,type="EXTERNAL_USER"
      ,input_file="privilege:/home/user1/priv_file")

The following examples make User1 an Enterprise Manager user, provide a description for the user, and prevent the password from being changed. Only another super administrator can change the password. The profile is set as MGMT_ADMIN_USER_PROFILE.

Example 5 - Command-Line

emcli create_user
      -name="User1"
      -desc="This is temp hire."
      -prevent_change_password="true"
      -profile="MGMT_ADMIN_USER_PROFILE"

Example 6 - Scripting and Interactive

create_user
      (name="User1"
      ,desc="This is temp hire."
      ,prevent_change_password="true"
      ,profile="MGMT_ADMIN_USER_PROFILE")

The following examples make User1 an Enterprise Manager user, provide a description for the user, and immediately expire the password. When the user logs in the first time, he/she must change the password.

Example 7 - Command-Line

emcli create_user
      -name="User1"
      -desc="This is temp hire."
      -expire="true"

Example 8 - Scripting and Interactive

create_user
      (name="User1"
      ,desc="This is temp hire."
      ,expire="true")

The following example makes User1 an Enterprise Manager user, and provides a description, department name, cost center, line of business, contact, and location for the administrator.

Example 9 - Command-Line

emcli create_user
      -name="User1"
      -password="oracle"
      -desc="This is temp hire."
      -department="dept1"
      -cost_center="testCostCenter"
      -line_of_business="testLineOfBusiness"
      -contact="contact"
      -location="location"

Example 10 - Scripting and Interactive

emcli create_user
      (name="User1"
      ,password="oracle"
      ,desc="This is temp hire."
      ,department="dept1"
      ,cost_center="testCostCenter"
      ,line_of_business="testLineOfBusiness"
      ,contact="contact"
      ,location="location")

define_diagcheck_exclude

Defines a diagnostic check exclusion with regard to groups and checks to exclude.

Format

emcli define_diagcheck_exclude
        -target_type="type"
        -exclude_name="name"
        { [-excl_group="diag_group" ]*
          [-excl_check="diag_check" ]* | 
         -input_file=excl_def:<complete_path_to_file> }

[ ] indicates that the parameter is optionalis optional

Parameters


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

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the blackout to delete.

  • createdby

    Enterprise Manager user who created the blackout. The default is the current user. The SUPER_USER privilege is required to delete a blackout created by another user.

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_credential_set

Deletes a credential set. Only Enterprise Manager Super Administrators can delete credential sets. Out-of-box credential sets cannot be deleted.

Format

  emcli delete_credential_set        -set_name="set_name"        -target_type="ttype"

Parameters

  • set_name

    Credential set name to be deleted.

  • target_type

    Target type of the credential set.

Examples

The following example creates a credential set named Old_Credential_Set.

emcli delete_credential_set 
        -set_name=Old_Credential_Set 
        -target_type=host

delete_diag_snapshot

Deletes a specified diagnostic snapshot.

Format

emcli delete_diag_snapshot
        -name="<diag_snapshot_name>"
        [-debug]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the diagnostic snapshot to be deleted. Ensure that the diagnostic snapshot exists for the specified name.

  • debug

    Runs the verb in verbose mode for debugging purposes.

Examples

The following example deletes a diagnostic snapshot with the name of Snapshot1 from Cloud Control.

emcli delete_diag_snapshot
      -name="Snapshot1"

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the group to delete.

  • type

    Group type: group. Defaults to "group".

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 stopped or completed deployment instance. An instance can only be deleted when its status is stopped, completed, or completed with an error.

Format

emcli delete_instance 
      [-instance=<instance_guid>] 
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    Instance GUID.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

Examples

Example 1

emcli delete_instance -instance=16B15CB29C3F9E6CE040578C96093F61

Example 2

emcli delete_instance -exec=2B15CB29C3F9E6CE040578C96093F16

delete_job

Deletes a job or a set of jobs matching the filter criteria. A job cannot be deleted if any of its executions are active. All executions must be in one of the following states:

ABORTED, FAILED, COMPLETED, STOPPED, SKIPPED

Use the get_jobs verb to obtain a list of existing jobs along with their job IDs and statuses.

Format

emcli delete_job
      [-job_id="ID1;ID2;..."]
      [-name="job name pattern"]
      [-owner="job owner"]
      [-type="job type"]
      [-targets="target name:target type"]
      [-input_file=property_file:"filename"]
      [-preview]

[ ] indicates that the parameter is optional

Parameters

  • job_id

    Semi-colon ( ; ) separated list of job(s) to delete.

    NOTE: This filter cannot be used with other filters.

  • name

    Name or pattern of the job to delete. To uniquely identify the job, the current user is used.

  • owner

    Owner of the job(s).

  • type

    Job type of the job(s).

  • targets

    Target name and target type of the job(s) to be deleted.

  • input_file

    The properties for filtering jobs can be specified in "filename". Any jobs matching all the specified filter criteria are deleted. You must specify at least one filter, and the logged in administrator must have the necessary privileges on the matching jobs.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • preview

    Lists only the jobs to be deleted. In the list of options you specify, if -preview is not one of the options, jobs are deleted, and then these jobs will be listed. If -preview is one of the options, the identical list is shown, but no jobs are deleted.

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 all jobs of type "Backup."

emcli delete_job -type=Backup

Example 3

The following example stops and deletes a job named MY_JOB owned by the logged in administrator. You can use the stop and delete pattern to delete active jobs.

emcli stop_job -name=my_job
emcli delete_job -name=my_job

delete_library_job

Deletes a library job you created using the create_library_jobs command.

Format

emcli delete_library_job
      -name=<"library_job_name">
      [-owner=<"library_job_owner">]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the library job.

  • owner

    Owner of the library job if different from the current logged-in EM CLI administrator.

Examples

Example 1

The following example deletes the library job "libjob1" owned by the current logged-in Enterprise Manager administrator.

emcli delete_library_job -name=libjob1 

Example 2

The following example deletes the library job "libjob2" owned by the Enterprise Manager administrator "emadmin1."

emcli delete_library_job -name=libjob2 -owner=emadmin1 

delete_metric_promotion

Deletes a promoted metric.

Format

emcli delete_metric_promotion
      -name=<service_target_name>
      -type=<service_target_type>
      [-category=<usage/performance/business>]
      [-promotedMetricName=<promoted_metric]
      [-promotedMetricColumn=<promoted_metric_column>]
      -promotedMetricKey=<key_value_of_promoted_metric>

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the service target.

  • type

    Name of the service type.

  • category

    Defines whether the promoted metric is a usage or a performance metric of a service. This determines the promoted metric name and metric column. If you do not specify this, you must specify the promotedMetricName and promotedMetricColumn.

  • promotedMetricName

    Promoted metric name. This is optional if you specify the category .

  • promotedMetricColumn

    Promoted metric column. This is optional if you specify the category .

  • promotedMetricKey

    Determines the key value of the promoted metric. It is equivalent to the displayed name of the promoted metric in the user interface.

Examples

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

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

delete_named_credential

Deletes an existing named credential.

Format

emcli delete_named_credential 
        -cred_owner=<owner>
        -cred_name=<name>

Parameters

  • cred_owner

    Credential owner.

  • cred_name

    Required credential name. This does not support wild cards.


delete_operation_plan

Deletes the specified operation plan from a Site Guard configuration.

Format

emcli delete_operation_plan
      -name=<plan_name>

Parameters

  • name

    Name of the operation plan you want to delete.

Example

emcli delete_operation_plan
      -name="BISystem1-switchover"

delete_patches

Deletes patches from the software library.

Format

emcli delete_patches 
      -patch_name=<patch_name> 
      -release=<release_id>
      -platform=<platform_id>

Parameters

  • patch_name

    Patch number.

  • release

    Patch release ID.

  • platform

    Patch platform ID.

Example

emcli delete_patches -patch_name=13741363 -release=80112310 -platform=226

See Also


create_patch_plan
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

delete_privilege_delegation_settings

Deletes a privilege delegation setting template.

Format

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

Parameters

  • setting_names

    Name of the settings you want to delete.

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_resolution_state

Deletes an existing resolution state. You typically use this command for resolution states that are no longer used. You need to also specify an alternative resolution state in case there are any references to the state. In this case, the references are changed to this alternative state. This action might require some time.

Only a super administrator can execute this command. A success message is reported if the command is successful. An error message is reported if the deletion fails.

Note:

No notifications are sent for any incidents or problems updated in this process.

Format

emcli delete_resolution_state
      -label="label of the state to be deleted"
      -alt_res_state_label="alternative resolution state"

Parameters

  • label

    Label of the state to be deleted.

  • alt_res_state_label

    Alternative state to be used.

Examples

The following example deletes the resolution state "Waiting for SR" and replaces any references to this state with the state "Work in Progress".

emcli delete_resolution_state  -label="Waiting for SR" -alt_res_state_label="Work in Progress"

delete_role

Deletes an existing Enterprise Manager administrator role.

Format

emcli delete_role
      -name="role_name"

Parameters

  • name

    Role name.

Examples

The following example deletes the role name existing_role.

emcli delete_role -name="existing_role"

delete_siebel

Deletes one or more Siebel Enterprise instances and their associated targets, such as Siebel servers, component groups, components, work flows, and so forth.

Format

emcli delete_siebel 
      -enterprise=<Siebel_enterprise_1>,<Siebel_enterprise_2> 
      [-out_file='<output_file>'] 
      [<-debug>]

[ ] indicates that the parameter is optional

Parameters

  • enterprise

    Target name of the Siebel enterprise as seen in the Enterprise Manager console. If multiple enterprises need to be deleted at the same time, provide a comma-separated ( , ) value.

  • out_file

    Fully-qualified path of the output file. The output of the command is redirected to this file.

    If you include this option, the list of deleted targets are printed in the file. If you do not include this option, the list is printed on the console directly.

  • debug

    Executes in verbose mode and generates debug log messages in the output.

Examples

The following example deletes the Siebel Enterprise instances from Cloud Control. The output of the command is redirected to the deletion_output.txt file.

emcli delete_siebel 
      -enterprise=SBA80_ent1.oracle.com,SBA78_ent2.us.oracle.com 
      -out_file='c:\emcli\deletion_output.txt'

delete_siteguard_configuration

Deletes the Site Guard configuration. The entire configuration (scripts, credential associations, site associations, operation plans) pertaining to the specified system and all the associated standby systems are deleted.

Format

emcli delete_siteguard_configuration
      -primary_system_name=<name> | -standby_system_name=<name>

Parameters

  • primary_system_name

    Name of the primary system. Specify either primary_system_name or standby_system_name.

  • standby_system_name

    Name of the standby system.

Examples

Example 1

emcli delete_siteguard_configuartion
      -primary_system_name="BISystem1"

Example 2

emcli delete_siteguard_configuration
      -standby_system_name="BISystem2"

See Also

create_siteguard_configuration

get_siteguard_configuration


delete_siteguard_credential_association

Deletes the credential association from the Site Guard configuration.

Format

emcli delete_siteguard_credential_association
      -system_name=<name>
      [-target_name=<name>]
      -credential_type=<type>

{ } indicates that the parameter is optional

Parameters

  • system_name

    Name of the system.

  • target_name

    Name of the target.

  • credential_type

    Type of the credential, which can be HostNormal, HostPrivileged, WLSAdmin, or DatabaseSysdba.

Examples

Example 1

emcli create_siteguard_credential_association
      -system_name="BISystem1"
      -credential_type="HostNormal"
      -credential_name="HOST-SGCRED"
      -credential_owner="sysman"

Example 2

emcli create_siteguard_credential_association
      -system_name="BIsystem1"
      -target_name="database-instance"
      -credential_type="HostNormal"
      -credential_name="HOST-DBCRED"
      -credential_owner="sysman"

See Also

create_siteguard_credential_association

update_siteguard_credential_association

get_siteguard_credential_association


delete_siteguard_script

Deletes the specified script from the Site Guard configuration.

Format

emcli delete_siteguard_script
      -script_id=<script_id>

Parameters

  • script_id

    ID associated with the script.

Examples

emcli delete_siteguard_script
      -script_id="10"

See Also

create_siteguard_script

get_siteguard_scripts


delete_siteguard_script_hosts

Deletes the host or hosts associated with a given script.

Format

emcli delete_siteguard_script_hosts
      -script_id=<script_id>
      -host_name=<name1;name2;...>

Parameters

  • script_id

    ID associated with the script.

  • host_name

    Name of the host where this script will be run. You can specify this parameter more than once.

Examples

emcli delete_siteguard_script_hosts
      -script_id="10"
      -host_name="BIHOST1"

Output Columns

Step Number, Operation Name, Target Name, Target Host, and Error Mode

See Also

create_siteguard_script

add_siteguard_script_hosts


delete_sla

Deletes one or more SLAs for a target.

Format

emcli delete_sla
    -targetName=<target_name>
    -targetType=<target_type>
    -slaName=<SLA_name>

Parameters

  • targetName

    Name of the target.

  • targetType

    Type of target.

  • slaName

    Name of the SLA.

Example

The following example deletes the SLA with the name 'gold_sla' from the target.

    emcli delete_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla'

delete_system

Deletes a system.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the system to delete.

  • type

    System type: generic_system. Defaults to "generic_system".

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 Cloud Control monitoring framework. Deleting a target removes it from the Management Repository and does not physically remove the target itself.

You can use the get_targets verb to obtain a list of available targets and their respective types.

Format

emcli delete_target
      -name=<name>
      -type=<type>
      [-delete_monitored_targets]
      [-async]
      [-delete_members]

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name.

  • type

    Target type.

  • delete_monitored_targets

    Deletes the targets monitored by the specified Management Agent. This is only applicable with the oracle_emd target type.

  • async

    Deletes the target asynchronously.

  • delete_members

    Deletes all the members of the target as well.

Examples

Example 1

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

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

Example 2

The following example deletes the Agent named test.example.com:1836 and all of its monitored targets. The Agent must be marked UNREACHABLE in Enterprise Manger Cloud Control to perform this operation.

emcli delete_target
      -name="test.example.com:1836"
      -type="oracle_emd"
      -delete_monitored_targets
      -async

Example 3

The following example deletes the example_ias_farm target with the name "farm01_base_domain" and all of its members, such as domain, clusters, servers, application deployments, and so forth.

emcli delete_target
      -name="farm01_base_domain"
      -type="example_ias_farm"
      -delete_members

delete_test

Deletes a Services test along with its constituent steps and step groups.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • testname

    Name of the test.

  • testtype

    Type of test.

Example

The following example deletes an HTTP test name MyTest for the generic_service target name 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=<stepgroup_name>]

[ ] indicates that the parameter is optional

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • testname

    Name of the test.

  • testtype

    Type of test.

  • metricName

    Name of the metric.

  • metricColumn

    Name of the column.

  • beaconName

    Name of the beacon.

  • stepName

    Name of the step.

  • stepGroupName

    Name of the step group.

Example

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 the user creates are active at the time the call to delete the user is issued. This situation is considered an invalid state from which to delete a user. First, all of these active blackouts must be stopped, and a thwarted delete user call must be reissued.

Format

emcli delete_user
      -name=<user_name>
      [-new_object_owner=<user_name>]
      [-force]

[ ] indicates that the parameter is optional

Parameters

  • name

    Administrator name.

  • new_object_owner

    Name of the administrator to assign the secure objects owned by the current administrator being deleted. If you do not specify this option, the secure objects are deleted that are owned by the administrator being deleted.

  • force

    Deletes the administrator even if the administrator is currently logged in.

Examples

Example 1

The following example deletes the Enterprise Manager administrator named sysman3.

emcli delete_user -name=sysman3

Example 2

The following example deletes the Enterprise Manager administrator named user1, and assigns all the secure objects owned by user1 to user5.


deploy_bipublisher_reports

This verb deploys all of the Enterprise Manager Oracle-provided reports, or optionally, specific Enterprise Manager Plug-in reports to the BI Publisher catalog

You can also use this verb to upload a reports jar file (located on the OMS(s)'s file system. The operation does not overwrite existing BI Publisher Reports in the Enterprise Manager reports folder unless you specify the -force option.

Note:

This verb requires Enterprise Manager Super Administrator privileges.

Format

emcli deploy_bipublisher_reports
    [-force]
    [-all | -reportsjarfile=<reports_jar_file> | (-pluginid=<plugin_id>        [-pluginversion=<plugin_version>]) )
[ ] indicates that the parameter is optional

Parameters

Note:

Using -force applies to the entire operation. The absence of all parameters assumes -all.

You can specify the -all option, or -reportsjarfile option, or -pluginid option, but not all three at the same time. If you use the -pluginid option, you can also also include the -pluginversion option.

  • force

    Overwrites reports. If you use this option, all reports on the BI Publisher server are overwritten with the new copies.

  • all

    Overwrites reports. If you use this option, all reports on the BI Publisher server are overwritten with the new copies.

  • reportsjarfile

    Deploys a single Enterprise Manager reports jar file that contains one or more BI Publisher Reports. This jar file is located relative to the OMS's $ORACLE_HOME.

  • pluginid

    In addition to Enterprise Manager system reports, also deploys any subsequently loaded plug-in-based BI Publisher Reports.

  • pluginversion

    Limits the plug-ins to a specific version.

Examples

Example 1

The following example deploys all platform and plug-in Enterprise Manager Oracle-provided reports, but does not overwrite any existing reports

emcli deploy_bipublisher_reports -all

Example 2

The following example deploys only the Chargeback and Trending reports, and overwrites any existing reports.

emcli deploy_bipublisher_reports -force -pluginid=oracle.sysman.emct -pluginversion=12.1.0.3.0

deploy_plugin_on_agent

Deploys a plug-in on Management Agents. Agent names must be provided for plug-in deployment.

Note:

A plug-in can only be deployed on any Management Agent after it has been successfully deployed on the management server.

Format

emcli deploy_plugin_on_agent 
        -agent_names=<agent1;agent2>
        -plugin=<plug-in_id[:version>]
        [-discovery_only]

[ ] indicates that the parameter is optional

Parameters

  • agent_names

    Management Agents (host:port) on which the plug-in needs to be deployed.

  • plugin

    Plug-in ID and version that needs to be deployed. Version is optional, and it defaults to the latest applicable version deployed on the management server. If a later version is available but not certified on the Agent OS platform, the latest version is not picked up.

  • discovery_only

    To be used when only discovery content needs to be deployed.

Examples

Example 1

The following example deploys the latest version of oracle.sysman.db2 on Management Agent myhost1.example.com.

emcli deploy_plugin_on_agent -plugin="oracle.sysman.db2"  -agent_names="myhost1.example.com:1838"

Example 2

The following example deploys version 12.1.0.1.0 of plug-in oracle.sysman.db2 on management agent myhost1.us.oracle.com.

emcli deploy_plugin_on_agent 
      -plugin="oracle.sysman.db2:12.1.0.1.0" 
      -agent_names="myhost1.us.oracle.com:1838"

deploy_plugin_on_server

Deploys a plug-in on the Management Servers. The deployment process for some plug-ins might restart the Management Servers. If the plug-in is already deployed on one of the servers, this server is skipped. If a lower version of the plug-in is already deployed, the plug-in is upgraded. If a lower revision of the plug-in is already deployed, the new revision is applied.

Format

emcli deploy_plugin_on_server 
        -plugin=<plug-in_id>[:<version>]
        [-sys_password=<sys_password>]
        [-prereq_check]
        [-use_last_prereq_result]

[ ] indicates that the parameter is optional

Parameters

  • plugin

    ID or ID:Version of the plug-in to be deployed on the Management Servers of the form -plugin=<oracle.sysman.db:12.1.0.1.0>, where the plug-in ID (like oracle.sysman.db) is a required parameter, and the version is optional. If do not specify a version, the highest version of the plug-in that has been downloaded is considered for deployment. If multiple revisions of this plug-in version are downloaded, the highest revision is considered for deployment.

  • sys_password

    Password of the repository DBA SYS. If you do not provide this , you are prompted for the password. This is not required if you use the prereq_check .

  • prereq_check

    If you provide this option, instead of deploying the plug-in, the verb displays only a check for all the unfulfilled prerequisites for this plug-in deployment to be successful. If you do not provide this option, plug-in deployment follows a prerequisities check.

  • use_last_prereq_result

    If prerequisites checks have been performed previously for a given set of plug-ins using the -prereq_check option and no other deployment activity occurred for these plug-ins, you can use this option to skip prerequisite checks and start the deployment immediately.

Examples

Example 1

The following example deploys the latest downloaded version of Oracle Database plug-in (plug-in ID: oracle.sysman.db) on the management server.

emcli deploy_plugin_on_server 
      -plugin=oracle.sysman.db 
      -sys_password=<sys_password>

Example 2

The following example deploys the latest downloaded version of a Oracle Database plug-in (plug-in ID: oracle.sysman.db) and Oracle Fusion Middleware plug-in (oracle.sysman.emas) on the management server.

emcli deploy_plugin_on_server 
      -plugin="oracle.sysman.db;oracle.sysman.emas" 
      -sys_password=<sys password> 

Example 3

The following example deploys the Oracle Database plug-in (with version 12.1.0.2.0) and Oracle Fusion Middleware plug-in (version 12.1.0.2.0) on the management server. Since sys password has not been passed on the command line, you are prompted for it.

emcli deploy_plugin_on_server 
      -plugin="oracle.sysman.db:12.1.0.2.0;oracle.sysman.emas:12.1.0.2.0"

Example 4

The folllowing example deploys the Oracle Database plug-in (with version 12.1.0.2..0) and Oracle Fusion Middleware plug-in (12.1.0.2.0) on the management server. Since sys password has not been passed on the command line, you are prompted for it. If a lower version of both plug-ins have already been deployed, they are upgraded to 12.1.0.2.0. If a lower version of only one of the plug-ins is deployed, this generates an error, and you will have to deploy them separately.

emcli deploy_plugin_on_server 
      -plugin="oracle.sysman.db:12.1.0.2.0;oracle.sysman.emas:12.1.0.2.0"

Example 5

The following example only performs prerequisite checks on the Oracle Database plug-in and does not actually deploy the plug-in.

emcli deploy_plugin_on_server 
      -plugin=oracle.sysman.db:11.2.0.1.0 -prereq_check

describe_job

Describes a job and gets its properties for a job you have submitted from the user interface or using the create_job verb. The output can be redirected into a file and used as a template.

This verb support multi-task jobs.

Format

emcli describe_job
     -name=<"job_name">
     [-owner=<"job_owner">]
     [-verbose]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the job to describe.

  • owner

    Enterprise Manager administrator who owns this job. If not provided, the current EM CLI logged-in administrator is assumed as the owner. The logged-in Enterprise Manager administrator must have at least the view privilege to describe a job.

  • verbose

    Outputs a help template along with the properties.

Examples

Example 1

The following example describes the library job "myJob" owned by the logged-in Enterprise Manager administrator.

emcli describe_job -name=myJob

Example 2

The following example describes the library job "yourJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this job.

emcli describe_job -name=yourJob -owner=admin1

Example 3

emcli describe_job -name=EMCLI_JOB_2

# Job Name : EMCLI_JOB_2

# Current status of the job is ACTIVE.

# Job Type: OSCommand.
# This job type supports the following target types only :
# host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
target_list=myHost:host
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=hello
 
# Variable: command
# Description: Command to run on the target
variable.command=echo
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.myHost:host=NAMED:Admin1:CRED1
 
schedule.frequency=REPEAT_BY_MINUTES
schedule.startTime=2012-02-01 01:01:01.0
schedule.endTime=2051-02-01 01:01:01.0
schedule.gracePeriod=-1
schedule.months=
schedule.days=
schedule.interval=1
schedule.timezone.type=TIMEZONE_TARGET
schedule.timezone.targetIndex=1
schedule.timezone.zoneOffset=0
schedule.timezone.region=

Example 4

emcli describe_job -name=EMCLI_JOB_2 -verbose

# Job Name : EMCLI_JOB_2

# Current status of the job is ACTIVE.

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
 
# Target List. 
# In a target list, each member is specified using the target name and target type # in the fashion:
#    target_name:target_type
# To specify an element of the target list, the following notation is used:
#    job_target_list.1=target_name:target_type
# The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element.
# The target target_name:target_type should exists in EM.
# Permissible target types are: 
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
# A sample target list could be: 
# job_target_list.1=<target_name>:host
# job_target_list.2=<target_name>:host
# The target list can only contain targets of the same target type. A cluster,  # group, domain or system 
# target must not be intermixed with targets of the other target types.
 
 
# Variable List. 
# In a variable list, each member is specified in the following way: 
# Scalar variable: A variable whose value can be represented as a single string.
#    variable.variable_name=variable_value
# Here "variable" is a keyword. Variable name is the name of the variable whose  # value is being specified.
# Value is specified on the right hand side after the equal to sign.
# Vector variable: A variable whose value is represented as an array or list of  # string values.
#    variable.variable_name.1=value1
#    variable.variable_name.2=value2
# Here the numbers suffixing the variable name signify the entry number in the   # list.
# Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable.
#    variable.large_variable_name=a_very_very_big_value
 
 
# Credential List. 
# This is the list of credential usages declared by the job type. 
# Each entry takes the form: 
#    cred.credusage_name.target_details=cred_type:cred_details
# Here the prefix "cred" is a keyword signifying that this line represents a  # credential entry.
# "credusage_name" would be substituted with the name of the credential usage  # declared in the job type.
# This is followed by the target details, which take the following form:
#    target_name:target_type
# The value for this credential usage entry is specified using the type of the  # credential and its details.
# "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential.
# "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type"
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a credential set could look like:
#    cred.defaultHostCred.target1:host=SET:HostCredsNormal
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential could look like:
#    cred.defaultHostCred.target1:host=NAMED:MyNamedCredential
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential shared by EM Admin "admin1" could look like:
#    cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential
 
# Schedule.
# Specify a schedule for the job. Detailed instructions as per below:
# Frequency: Specifies the frequency of repeatedly submitting instances of this  # job.
#    scheule.frequency=Frequency_Type
# Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY,  # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS.
# If frequency is IMMEDIATE, then other schedule fields do not matter.
# Start Time: Start time for the schedule.
#    scheule.startTime=MM-DD-YYYY
# End Time: End time for the schedule.
#    scheule.endTime=MM-DD-YYYY
# Grace Period: Grace period in minutes for the schedule.
#    scheule.graceperiod=
# Months : Months for repetition. January is denoted by 0 and December by 11
#    schedule.months=0,1,2
# Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6.
#    schedule.days=0,1,2
# Timezone: Timezone information is further detailed into type, target index, zone # offset and region.
#    schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED,  # TIMEZONE_REGION_SPECIFIED.
#    schedule.timezone.targetIndex : specify the index of the target whose  # timezone is to be used.
#    schedule.timezone.zoneOffset : timezone offset.
#    schedule.timezone.region : timezone region
# Following is a complete schedule section, remove #  and populate the values for # submission:
# scheule.frequency=ONCE
# schedule.startTime=12-21-2012
# schedule.endTime=12-21-2012
# schedule.gracePeriod=10
# schedule.months=
# schedule.days=
# schedule.timezone.type=TIMEZONE_TARGET
# schedule.timezone.targetIndex=1
# schedule.timezone.zoneOffset=
# schedule.timezone.region=

job_target_list.1=adc2110610.us.oracle.com:host
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=hello
 
# Variable: command
# Description: Command to run on the target
variable.command=echo
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.adc2110610.us.oracle.com:host=NAMED:SYSMAN:CRED1
 
schedule.frequency=REPEAT_BY_MINUTES
schedule.startTime=2012-02-01 01:01:01.0
schedule.endTime=2051-02-01 01:01:01.0
schedule.gracePeriod=-1
schedule.months=
schedule.days=
schedule.interval=1
schedule.timezone.type=TIMEZONE_TARGET
schedule.timezone.targetIndex=1
schedule.timezone.zoneOffset=0
schedule.timezone.region=

describe_job_type

Describes the job type and gets its properties. The output can be redirected into a file.

This verb dumps out a properties file for a job type that supports the Job System Generic EM CLI. This file contains some documentation, a list of all required credential usages, and a list of all variables required to create a (library) job instance of the job type.

This verb support multi-task jobs.

Format

emcli describe_job_type
     -job_type=<"job_type_internal_name">
     [-verbose]

[ ] indicates that the parameter is optional

Parameters

  • job_type

    Specify the name of the job type to describe. You can use the get_job_types verb to obtain the names of all job types for which a job or library jobs can be created using EM CLI.

  • verbose

    Outputs a help template along with the properties.

Examples

Example 1

The following example describes the job type "MyJobType."

emcli describe_job_type -job_type=MyJobType

Example 2

The following example produces a property file on the console, which can be redirected to a file and used multiple times.

emcli describe_job_type -job_type=OSCommand

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=
 
# Variable: command
# Description: Command to run on the target
variable.command=
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.<target_name>:<target_type>=

Example 3

The following example with the verbose option generates a property dump with help on how to specify each individual property for the job.

emcli describe_job_type -job_type=OSCommand -verbose

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
 
# Target List. 
# In a target list, each member is specified using the target name and target type # in the fashion:
#    target_name:target_type
# To specify an element of the target list, the following notation is used:
#    job_target_list.1=target_name:target_type
# The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element.
# The target target_name:target_type should exists in EM.
# Permissible target types are:  host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
# A sample target list could be: 
# job_target_list.1=<target_name>:host
# job_target_list.2=<target_name>:host
# The target list can only contain targets of the same target type. A cluster,  # group, domain or system 
# target must not be intermixed with targets of the other target types.

# Variable List. 
# In a variable list, each member is specified in the following way: 
# Scalar variable: A variable whose value can be represented as a single string.
#    variable.variable_name=variable_value
# Here "variable" is a keyword. Variable name is the name of the variable whose  # value is being specified.
# Value is specified on the right hand side after the equal to sign.
# Vector variable: A variable whose value is represented as an array or list of  # string values.
#    variable.variable_name.1=value1
#    variable.variable_name.2=value2
# Here the numbers suffixing the variable name signify the entry number in the  # list.
# Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable.
#    variable.large_variable_name=a_very_very_big_value
 
# Credential List. 
# This is the list of credential usages declared by the job type. 
# Each entry takes the form: 
#    cred.credusage_name.target_details=cred_type:cred_details
# Here the prefix "cred" is a keyword signifying that this line represents a  # credential entry.
# "credusage_name" would be substituted with the name of the credential usage  # declared in the job type.
# This is followed by the target details, which take the following form:
#    target_name:target_type
# The value for this credential usage entry is specified using the type of the  # credential and its details.
# "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential.
# "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type"
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a credential set could look like:
#    cred.defaultHostCred.target1:host=SET:HostCredsNormal
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential could look like:
#    cred.defaultHostCred.target1:host=NAMED:MyNamedCredential
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential shared by EM Admin "admin1" could look like:
#    cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential
 
# Schedule.
# Specify a schedule for the job. Detailed instructions as per below:
# Frequency: Specifies the frequency of repeatedly submitting instances of this  # job.
#    scheule.frequency=Frequency_Type
# Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY,  # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS.
# If frequency is IMMEDIATE, then other schedule fields do not matter.
# Start Time: Start time for the schedule.
#    scheule.startTime=MM-DD-YYYY
# End Time: End time for the schedule.
#    scheule.endTime=MM-DD-YYYY
# Grace Period: Grace period in minutes for the schedule.
#    scheule.graceperiod=
# Months : Months for repetition. January is denoted by 0 and December by 11
#    schedule.months=0,1,2
# Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6.
#    schedule.days=0,1,2
# Timezone: Timezone information is further detailed into type, target index, zone # offset and region.
#    schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED,  # TIMEZONE_REGION_SPECIFIED.
#    schedule.timezone.targetIndex : specify the index of the target whose  # timezone is to be used.
#    schedule.timezone.zoneOffset : timezone offset.
#    schedule.timezone.region : timezone region
# Following is a complete schedule section, remove #  and populate the values for # submission:
# scheule.frequency=ONCE
# schedule.startTime=12-21-2012
# schedule.endTime=12-21-2012
# schedule.gracePeriod=10
# schedule.months=
# schedule.days=
# schedule.timezone.type=TIMEZONE_TARGET
# schedule.timezone.targetIndex=1
# schedule.timezone.zoneOffset=
# schedule.timezone.region=
 
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=
 
# Variable: command
# Description: Command to run on the target
variable.command=
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.<target_name>:<target_type>=

describe_library_job

Describes a library job and gets its properties. The output can be redirected into a file.

Format

emcli describe_library_job
     -name=<"job_name">
     [-owner=<"job_owner">]
     [-verbose]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the library job to describe.

  • owner

    Enterprise Manager administrator who owns this library job. If not provided, the current EM CLI logged-in administrator is assumed as the owner. The logged-in Enterprise Manager administrator must have at least the view privilege to describe a job.

  • verbose

    Outputs a help template along with the properties.

Examples

Example 1

The following example describes the library job "myLibJob" owned by the logged-in Enterprise Manager administrator.

emcli describe_library_job -name=myLibJob

Example 2

The following example describes the library job "yourLibJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this library job.

emcli describe_library_job -name=yourLibJob -owner=admin1

Example 3

emcli describe_library_job -name=MYJOB1

# Job Name : MYJOB1

# Current status of the job is ACTIVE.

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.

 
job_target_list.1=adc2110610.us.oracle.com:host
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=hello
 
# Variable: command
# Description: Command to run on the target
variable.command=echo
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.adc2110610.us.oracle.com:host=NAMED:SYSMAN:CRED1
 
schedule.frequency=REPEAT_BY_MINUTES
schedule.startTime=2012-02-01 01:01:01.0
schedule.endTime=2051-02-01 01:01:01.0
schedule.gracePeriod=-1
schedule.months=
schedule.days=
schedule.interval=1
schedule.timezone.type=TIMEZONE_TARGET
schedule.timezone.targetIndex=1
schedule.timezone.zoneOffset=0
schedule.timezone.region=

describe_patch_plan_input

Describes the input data of a patch plan.

Format

emcli describe_patch_plan_input
        -name=<name>

Parameters

  • name

    Name of a given patch plan.

Example

emcli describe_patch_plan_input -name="plan_name

See Also


create_patch_plan
delete_patches
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

describe_procedure_input

Describes the input data of a deployment procedure or a procedure configuration.

Format

emcli describe_procedure_input
      [-procedure=<procedure_GUID>]
      [-name=<procedure_name_or_procedure_conf>]
      [-owner=<procedure_owner_or_procedure_config>]
      [-parent_proc=<procedure_of_procedure_config>]

[ ] indicates that the parameter is optional

Parameters

  • procedure

    GUID of the procedure to execute.

  • name

    Name of the procedure or procedure configuration.

  • owner

    Owner of the procedure or procedure configuration.

  • parent_proc

    Procedure of the procedure configuration. This applies to describe a procedure configuration when both a procedure and a procedure configuration have the same name.

Examples

emcli describe_procedure_input -procedure=16B15CB29C3F9E6CE040578C96093F61 > describeDP.properties

diagchecks_deploy_status

Gets the status of diagnostic checks deployments against different target types.

Format

emcli diagchecks_deploy_status
        [-target_type=<type>]*

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Type of target. You can specify multiple values.


diagchecks_deploy_tglist

Gets the target list for a particular deployment type for a target type.

Format

emcli diagchecks_deploy_tgtlist
        -target_type=<type>
        -deploy_type=<CURRENT|OLDER|MISSING|ALL>
        [-show_excludes]

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Type of target. You can specify multiple values.

  • deploy_type

    Deployment type of either CURRENT, OLDER, MISSING, or ALL.

  • show_excludes

    For targets where excludes have been set, print them.


disable_audit

Disables auditing for all user operations.

Format

emcli disable_audit

Example

The following example disables auditing for all operations.

emcli disable_audit

disable_sla

Disables an SLA for a target.

Format

emcli disable_sla
    -targetName=<target_name>
    -targetType=<target_type>
    -slaName=<SLA_name>

Parameters

  • targetName

    Name of the target.

  • targetType

    Type of target.

  • slaName

    Name of the SLA.

Examples

The following example disables an SLA named 'gold_sla' for target my_service (generic_service).

    emcli disable_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla'1

disable_test

Disables monitoring of a Services test.

Format

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

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • testname

    Test name.

  • testtype

    Test type.

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_coherence

Discovers one or more Coherence clusters.

Format

emcli discover_coherence
      -input_file=coherence_discovery_file:file_path
      [-debug]

[ ] indicates that the parameter is optional

Parameters

  • input_file

    Fully-qualified path to a CSV-formatted file containing one line of details per Coherence cluster. The valid WebLogic version value is 10. The structure of the CSV file is as follows:

    <Management Node host machine name>,
              <Management Node listen port>,
              <Management Node username - optional>,
              <Management Node password - optional>,
              <Management Node service name - optional>,
              <Agent url>        
    

    For example:

    host1.companyA.com,9910,,,,https://host1.companyA.com:3872/emd/main/,
    

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • debug

    Runs the verb in verbose mode for debugging purposes.

Examples

The following example reads the my_clusters_info.csv file to determine the clusters to be added to Cloud Control.

emcli discover_coherence 
  -input_file=coherence_discovery_file:"c:\emcli\my_clusters_info.csv

discover_fa

Discovers multiple Fusion Applications domains by reading the Fusion Applications domain discovery file and saving the host-wise discovered targets to the Agents provided in the Host Agent Mapping file. If the Host Agent mapping file is not provided, the local Agent (that is, the Agent on the same host as the target) is used to save/monitor the discoverd targets as well. If a local Agent is not found, the default discovery Agent is used to save/monitor the discoverd targets as well.

Note:

Although this verb supports discovering multiple Fusion instances at one time by adding all the details in one file, it is advisable to discover each Fusion instance separately using individual EM CLI discover_fa commands run multiple times.

Format

emcli discover_fa
      -input_file=fa_domain_discovery_file:file_path
      [-input_file=host_agent_mapping_file:file_path]
      [-input_file=pf_domain_cred_mapping_file:file_path]
      [-debug]

[ ] indicates that the parameter is optional

Parameters

  • input_file=fa_domain_discovery_file

    Fully-qualified path to a CSV-formatted file containing one line of details per domain to be added. The valid WebLogic version value is 10. The structure of the CSV file is as follows:

    <WebLogic Server version>,
    <Administration Server host machine name>,
    <Administration Server listen port>,
    <Administration Server username>,
    <Administration Server password>,
    <External Parameters - optional>,
    <JMX Protocol - required only if SSL enabled>,
    <JMX Service URL - required only if SSL enabled>,
    <Unique Domain Identifier>,
    <Agent URL/>,
    <Discover Down Servers - optional - Default if not specified is false starting <PS1. Before PS1 the default for this is true>,
    <Use Same Credentials for All Domains in the Fusion Instance - optional - Default if <not specified is true>
    

    For example:

    10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_     01,https://mco01.mycompany.com:3872/emd/main/,,
    10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_     01,https://mco01.mycompany.com:3872/emd/main/,true,
    10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_     01,https://mco01.mycompany.com:3872/emd/main/,true,true
    10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_     01,https://mco01.mycompany.com:3872/emd/main/,false,true
    

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=host_agent_mapping_file

    Fully-qualified path to a CSV-formatted file containing multiple lines of host system names where Managed Servers are to be monitored, and the Agent to be used to monitor each host's Managed Servers.

    For example:

    mycompany.com,https://mco01.mycompany.com:3872/emd/main
    

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=pf_domain_cred_mapping_file

    Fully-qualified path to a CSV-formatted file containing multiple lines of WebLogic admin credentials for each domain of a fusion instance, where the credentials are different from those added in the fa_domain_discovery file.

    The same credentials are used for all the domains in a Fusion Application instance unless the credentials are overwritten in the pf_domain_cred_mapping file.

    For example:

    <UniqueKey - "<Fusion Instance       Identifier><CommonDomainDisplayName>">,<Administration Server       username>,<Administration Server password>,
    <UniqueKey - "<Fusion Instance       Identifier>-<CommonDomainDisplayName>">,<Administration Server       username>,<Administration Server password>,<Administration Server Host       Name>
    
    Example:
    fi9-FS,weblogic12,welcome1,
    fi9-PRJ,faadmin,fusionfa1,
    fi9-PRC,faadmin,fusionfa1,adcdbb05.us.oracle.com
    fi9-PRC,,,adcdbb05.us.oracle.com
    

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • debug

    Runs the verb in verbose mode for debugging purposes.

Examples

Example 1

The following example reads the my_domains_info.csv file to determine the Fusion Instances to be added to Cloud Control, reads the my_agent_mapping.csv file to determine which Agents should monitor which host's Managed Servers, and reads the my_domain_cred_mapping.csv file to determine which credentials are to be used to discover an individual product family.

emcli discover_fa 
      -input_file=fa_domain_discovery_file:c:\emcli\my_domains_info.csv 
      -input_file=host_agent_mapping_file:c:\emcli\my_agent_mapping.csv 
      -input_file=pf_domain_cred_mapping_file:c:\emcli\my_domain_cred_mapping.csv 

Example 2

emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_file:/tmp/emcli/ host_agent_mapping_file.txt -debug

Example 3

emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_filee:/tmp/emcli/ host_agent_mapping_file.txt -input_file=pf_domain_cred_mapping_file:/tmp/emcli/ pf_domain_cred_mapping_file.txt -debug

discover_gf

Discovers Multiple GlassFish Domains by reading the Domain Discovery file and saving the discovered targets of the host to the Agents provided in the Host Agent Mapping file. If the Host Agent mapping file is not provided, the local Agent (the Agent on the same host as the target) is used to save/monitor the discovered targets. If a local Agent is not found, the default discovery Agent is used to save/monitor the discovered targets.

Format

$emcli discover_gf
       -input_file=domain_discovery_file:file_path
       [-input_file=host_agent_mapping_file:file_path]
       [-debug]

[ ] indicates that the parameter is optional

Parameters

  • input_file=domain_discovery_file

    Fully-qualified path to a CSV-formatted file containing one line of details per domain to be added. The structure of the CSV file is as follows:

    <Administration Server host machine name>,
    <Administration Server listen port>,
    <Administration Server username>,
    <Administration Server password>,
    <Unique Domain Identifier>,
    <Agent url - optional >,
    <Protocol - optional >,
    <Service URL - optional>,
    <External Parameters - optional>,
    <Discover Down Servers - optional - Default if not specified is false>,\n" +
    

    For example:

    mco01.mycompany.com,4848,admin,welcome1,my_domain_01,https://mco01.mycompany.com:3872/emd/main
    mco01.mycompany.com,4848,admin,welcome1,my_domain_01,https://mco01.mycompany.com:3872/emd/main,http,,,true
    

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=host_agent_mapping_file

    Fully-qualified path to a CSV-formatted file containing multiple lines of host system names where Managed Servers are to be monitored, and the Agent to be used to monitor each host's Managed Servers. The structure of the CSV file is as follows:

    <target_host1>,<save_to_agent1>
    <target_host2>,<save_to_agent3>
    

    For example:

    mycompany.com,https://mco01.mycompany.com:3872/emd/main
    

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • debug

    Runs the verb in verbose mode for debugging purposes.

Examples

Example 1

$emcli discover_gf -input_file=domain_discovery_file:/tmp/emcli/domain_discovery_file.txt

Example 2

$emcli discover_gf -input_file=domain_discovery_file:/tmp/emcli/domain_discovery_file.txt -input_file=host_agent_mapping_file:/tmp/emcli/host_agent_mapping_file.txt -debug

discover_siebel

Discovers Siebel Enterprise instances.

Format

 emcli discover_siebel
        -input_file=enterprise_info_file:<file_path>
        [-out_file='<fully_qualified_path_of_output_file>']
        [-precheck]
        [-debug]

[ ] indicates that the parameter is optional

Parameters

  • input_file

    The input file should be in a CSV format. The structure of the CSV file is as follows:

    GATEWAY_HOST = < Gateway Server Host >,
    PORT = < Gateway Server Port - optional Default if not specified is 2320 >,
    INSTALL_DIR = < Gateway Server Install Directory - optional >,
    ENTERPRISE_NAME = < Siebel Enterprise Name >,
    SIEBEL_USERNAME = < Siebel Enterprise User Name >,
    SIEBEL_PASSWORD = < Siebel Enterprise Password >,
    DATABASE_USERNAME = < Database User Name >,
    DATABASE_PASSWORD = < Database Password >
    

    Note:

    INSTALL_DIR is a mandatory parameter for discovering Siebel version 8.2.2 and above.

    The following example shows discovery of a Siebel Enterprise (siebel) with the gateway located at host 'host1', installed at location 'Location1' and running at port '23201', with a Siebel user name and password of 'sbluser' and 'SBLpass' respectively, and a database user name and password of 'dbuser' and 'DBpass' respectively.

    GATEWAY_HOST=host1,PORT=23201,INSTALL_DIR=Location1,
    ENTERPRISE_NAME=siebel,SIEBEL_USERNAME=sbluser,
    SIEBEL_PASSWORD=SBLpass,DATABASE_USERNAME=dbuser,
    DATABASE_PASSWORD=DBpass
    

    Special cases for commas:

    • If any entry, such as a password, has a comma ( , ) you need to add it as a backslash comma ( \, ) in the CSV file. For instance, if SIEBEL_PASSWORD is we,lco,me1 the entry in the CSV file would be SIEBEL_PASSWORD = we\,lc\,ome1 .

    • If any entry, such as a password, has a backslash followed by a comma( \, ) you need to add it as as two backslashes followed by a comma( \\, ) in the CSV file. For instance, if SIEBEL_PASSWORD is we\,lco\,me1 the entry in the CSV file would be SIEBEL_PASSWORD = we\\,lc\\,ome1 .

      For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • out_file

    Command output is redirected to this file. If not specified, output is printed on the console.

  • debug

    Executes in verbose mode and generates additional debug log messages in the output. If specified, detailed output is printed.

  • precheck

    Performs a mock discovery of the Siebel enterprise by executing all of the checks and validations. This option lists the results of these steps to the user for review prior to an actual discovery. It ensures that all prerequisite are met, and discovery does not occur if prerequisites are met.

Examples

Example 1

The following example reads the my_enterprise_info.csv file to determine the Siebel Enterprise instances to be added to Cloud Control. The output of the command is redirected to the discovery_output.txt file.

  emcli discover_siebel 
        -input_file=enterprise_info_file:'c:\emcli\my_enterprise_info.csv'
        -out_file='c:\emcli\discovery_output.txt'
        -debug

Example 2

The following example is the same as the example above, except it adds the -precheck option, which confirms if the precheck is successful, or shows errors if it failed.

  emcli discover_siebel 
        -input_file=enterprise_info_file:'c:\emcli\my_enterprise_info.csv'
        -out_file='c:\emcli\discovery_output.txt'
        -debug

discover_wls

Purpose

Used to discover one or more version 8.x, 9.x, 10.x, and 12.x WebLogic Domains (along with Oracle Fusion Middleware 11g software deployed to it), and to specify which Management Agent should monitor which hosts' Managed Servers. Specifying which Management Agent should monitor which hosts' Managed Servers is a feature supported only with versions 9.x, 10.x, and 12.x of the WebLogic Server. If you want to discover version 8.x of the WebLogic Server, you cannot specify which Management Agent to monitor which hosts' Managed Servers; the Management Agent used to perform discovery automatically monitors all WebLogic Servers within the version 8.x domain.

Function

This verb discovers one or more Oracle WebLogic Server Domains. It reads a file labeled domain_discovery_file to discover WebLogic Server versions 8.x, 9.x, 10.x, and 12.x. Note that if you attempt to discover an already discovered WebLogic Server, the discovered WebLogic Server domain will be refreshed.

Requirements

To discover the WebLogic Server, the Administration Server must be up and running. After initial discovery or during refresh of domain membership, the Administration Server is not required to be up for general WebLogic Server monitoring. After initial discovery or during refresh of domain membership, the Managed Server is not required to be up for general WLS monitoring. Oracle recommends ensuring all Managed Servers to be managed by Cloud Control be up during discovery.

domain_discovery_file is required; discovery cannot occur without it. You must create the CSV (comma-separated values) formatted file before performing discovery. To save the discovered components (WebLogic Server versions 9.x, 10.x, and 12.x only) to a specific Management Agent for monitoring, the discover_wls verb reads a second file labeled host_agent_mapping_file. If host_agent_mapping_file does not exist, the Management Agent specified in domain_discovery_file that performs the actual discovery is used as the Agent that monitors all discovered targets.

Usage with generate_discovery_input Verb

The generate_discovery_input verb creates a discovery input file automatically based on the targets discovered from the automatic discovery operation. You can then use this discovery input file in conjunction with the discover_wls verb to further automate the process of promoting discovered domains as fully managed targets.

Format

emcli discover_wls
        -input_file=domain_discovery_file:file_path
        [-input_file=host_agent_mapping_file:file_path]
        [-input_file=disable_target_types_file:file_path]
        [-debug]

[ ] indicates that the parameter is optional


Parameters

  • input_file=domain_discovery_file

    Fully-qualified path to a CSV (Comma-Separated Values) formatted file that contains one line of details per domain to be added. This is valid for WebLogic Server versions 8.x, 9.x, 10.x, and 12.x. Each line has the format shown for domain_discovery_file in the "File Structures" section below.

    Note the following points about the format of domain_discovery_file:

    Parameters —

    • The order of parameters is fixed. You must provide the parameters in the same order as shown for domain_discovery_file in the "File Structures" section below.

    • If you want to use a comma ( , ) in any of the parameters provided, you must escape the comma with a backslash as shown in the following example, in which a backslash precedes the comma in the password my,pwd:

      10,domain123.xyx.us,11990,weblogic,my\,pwd,,,farm_demo,https://myco01.mycompany.com:3872/emd/main/
      

    Delimeters and Requirements —

    • Use a comma ( , ) as the delimiter.

    • Delimiters must be present even if the corresponding parameter is not provided. See the last line for domain_discovery_file in the "File Structures" section below.

    • If you want to use a comma (,) in one of the parameters provided, you must escape the comma (,) with a backslash. In the following example, the password contains a comma:

      10,mco01.mycompany.com,7001,weblogic,welco\,me1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/
      
    • If you want to use a backslash in one of the parameters provided, you must escape the backslash with another backslash. In the following example, the password contains a backslash:

      10,mco01.mycompany.com,7001,weblogic,we\,lco \ \ me1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/,true,false
      
    • The total number of tokens in each line is fixed and should be equal to 10.

    • The order of parameters is fixed. You must provide the parameters in the same order as specified in the sample file structure shown in the "File Structures" section below.

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=host_agent_mapping_file

    Fully-qualified path of the CSV (Comma-Separated Values) formatted file that contains multiple lines of host system names where managed servers are to be monitored, and specifies the Management Agent used to monitor each host's managed servers. This is only valid for WebLogic Server versions 9.x, 10.x, and 12.x. Each line has the following format:

    <Discovered_target_host_machine_name>,<Agent_URL_to_save/monitor_the_host>
    

    For example:

    myco01.mycompany.com,https://myco01.mycompany.com:3872/emd/main/
    myco02.mycompany.com,https://myco02.mycompany.com:3872/emd/main/
    myco03.mycompany.com,https://myco03.mycompany.com:3872/emd/main/
    

    Definitions for the parameters are as follows:

    • Discovered_target_host_machine_name

      Host machine with installed WebLogic Servers that need to be discovered. Use full host names, such as myco01.mycompany.com instead of myco01.

    • Agent_URL_to_save/monitor_the_host

      URL for the Management Agent to be used to monitor all discovered targets on the corresponding host.

    Delimeters and Requirements —

    • Use a comma ( , ) as the delimiter.

    • The total number of tokens in each line is fixed and should be equal to 2.

    • The order of parameters is fixed. You must provide the parameters in the same order as shown in the sample file structure shown in the "File Structures" section below.

    • <target_host1> and <save_to_agent1> are both mandatory parameters.

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=disable_target_types_file

    Fully-qualified path to a CSV (Comma-Separated Values) formatted file containing multiple lines of internal target type names that should not be discovered.

    For example:

    oracle_soa_composite
    j2ee_application
    

    If the discover_wls verb is run against a Fusion Applications WebLogic Server domain, the disabled target types can include Fusion Applications target types.

  • debug

    Runs this verb in verbose mode for debugging purposes.

File Structures

domain_discovery_file for WebLogic Server version 8.x

The following example shows the structure of a sample domain_discovery_file for WebLogic Server version 8.x. The same Management Agent is used to discover and save the targets. OPT signifies an optional parameter. The last entry shows the format when the optional parameters, Administration Server Home Directory and Trusted Keystore Filename, are not provided.

<WebLogic Server version>,
<Administration Server host machine name>,
<Administration Server listen port>,
<Administration Server username>,
<Administration Server password>,
<Trusted Keystore Filename - required only if SSL enabled>,
<Administration Server Home Directory>,
<Agent Host>,
<Agent Host username>,
<Agent Host password>

For example:

8,mco02.mycompany.com,7001,weblogic,welcome1,,/u01/wls/,mco02.mycompany.com,oracle,oracle

Definitions for the parameters are as follows for WebLogic Server version 8:

  • WebLogic Server version

    Valid value is 8. The following example shows a sample entry in domain_discovery_file to discover WebLogic Server version 8:

    8,myhost.us.mycompany.com,7001,weblogic,welcome1,,,myhost.us.mycompany.com, oracle,welcome1
    
  • Administration Server Host Machine Name

    Full host name of the WebLogic Administration Server that needs to be discovered; for example, myhost.us.mycompany.com. This is a mandatory parameter.

  • Administration Server Listen Port

    Listen port of the WebLogic Administration Server.

  • Administration Server Username

    Login user name for the WebLogic Administration Server.

  • Administration Server Password

    Login password for the WebLogic Administration Server.

  • Trusted Keystore Filename

    Absolute path of the Trusted Keystore Filename. This is required if the Administration Server's port is SSL enabled. If the Management Agent is on a different system than the WebLogic Server to be managed, you must manually copy the Trusted Keystore file to an accessible directory on the Management Agent system prior to discovery, and then use this path.

  • Administration Server Home Directory

    Absolute path of the directory where the weblogic.jar file is located. If the Management Agent is on a different system than the Administration Server, you must manually copy the weblogic.jar file (located in the <WEBLOGIC_HOME>/server/lib/ directory) to an accessible directory on the Management Agent system prior to discovery, and then use this path.

  • Agent Host

    Host name of the Management Agent used to discover and monitor the targets.

  • Agent Host Username | Agent Host Password

    Credentials of the operating system user of the Management Agent host. These credentials are used to discover any Oracle WebLogic Server domains.

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

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

<WebLogic Server version>,
<Administration Server host machine name>,
<Administration Server listen port>,
<Administration Server username>,
<Administration Server password>,
<External Parameters - optional>,
<JMX Protocol - Required only if SSL enabled>,
<JMX Service URL - Required only if SSL enabled>,
<Unique Domain Identifier>,
<Agent URL/>,
<Discover Down Servers - optional - Default if not specified is false     (starting with the Fusion Middleware Plug-in 12.1.0.3 release. Before this, the     default was true)>,
<Use Credential Store - optional - Default if not specified is false>
<Enable Refresh Job - optional - Default if not specified is false>
<Use Host Name in Service URL - optional - Default if not specified is false>

For example:

10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/,false,false

Definitions for the parameters are as follows:

  • WebLogic Server Version

    Valid values are 9, 10, or 12. The following example shows a sample entry in domain_discovery_file to discover WebLogic Server version 10:

    10,myco01.mycompany.com,7001,weblogic,welcome1,,,,soa_farm,
    https://myco02.mycompany.com:8723/emd/main/
    
  • Administration Server Host

    Full host name of the WebLogic Administration Server that needs to be discovered; for example, myco01.mycompany.com. This is a mandatory parameter.

  • Port

    Listen port of the WebLogic Administration Server.

  • Username

    Login user name for the WebLogic Administration Server.

  • Password

    Login password for the WebLogic Administration Server.

  • External Parameters

    These parameters are passed to the Java process, which connects to the Administration Server. All of these parameters must begin with -D.

  • JMX Protocol

    The Management Agent makes a JMX connection to the Administration Server to discover the domain's members. Valid values are t3, t3s, iiop, and iiops. If you do not provide a protocol, the t3 default is used.

  • JML Server URL

    Makes a JMX connection to the Administration Server. If you do not specify this parameter, it is created based on the input parameters.

  • Unique Domain Identifier

    Creates a unique target name. This parameter can contain only alphanumeric characters and the special character '_' and cannot contain any other special characters.

  • Agent URL

    URL for the Management Agent used to discover the targets. If you do not provide a value, the local Management Agent present on the target WebLogic Server is used. If a Management Agent is not found on the target WebLogic Server, an error is displayed.

  • Discover Down Servers

    If this value is true, the servers that are down are discovered. If false, the servers that are down are not discovered.

  • Use Credential Store

    If this value is set to true, the verb retrieves the WebLogic credentials from the credential store.

Examples

The following example reads the my_domains_info.csv file to determine the domains to be added to Cloud Control, and reads the my_agent_mapping.csv file to determine which Management Agents should monitor which host's managed servers.

emcli discover_wls
    -input_file=domain_discovery_file:\emcli\my_domains_info.csv
    -input_file=host_agent_mapping_file:\emcli\my_agent_mapping.csv     -debug

The following example manually redirects the output of discover_wls to a file using standard output redirect.

emcli discover_wls input_file=domain_discovery_file:"<fully_qualified_path_of_domain_discovery_file/domain_discovery_file.csv>” > /tmp/emcli/output_file.out

download_ats_test_databank_file

Downloads the specified databank file corresponding to the given ATS test. If no databank alias is specified, the command downloads all databanks for the test.

Format

emcli download_ats_test_databank_file
        -name=<target_name>
        -type=<target_type>
        -testname=<test_name>
        -testtype=<test_type>
        [-databankAlias=<databank_alias>]
        [-output_dir=<output_directory>]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the target.

  • type

    Name of the target type.

  • testname

    Name of the test.

  • testtype

    Type of test.

  • databankAlias

    Databank alias.

  • output_dir

    Output directory. If the directory does not exist, it is created.

Examples

Example 1

The following example downloads the databank corresponding to alias1 for the specified test.

emcli download_ats_test_databank_file -name="Service Name"
                                      -type="generic_service"
                                      -testname="Test Name"
                                      -testtype="OATS"
                                      -databankAlias="alias1"

Example 2

The following example downloads all databanks corresponding to the specified test.

emcli download_ats_test_databank_file -name="Service Name"
                                      -type="generic_service"
                                      -testname="Test Name"
                                      -testtype="OATS"

download_ats_test_zip

Downloads the zip bundle corresponding to the specified ATS test.

Format

emcli download_ats_test_zip
        -name=<target_name>
        -type=<target_type>
        -testname=<test_name>
        -testtype=<test_type>
        [-output_dir=<output_directory>]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the target.

  • type

    Name of the target type.

  • testname

    Name of the test.

  • testtype

    Type of test.

  • output_dir

    Output directory. If the directory does not exist, it is created.

Examples

emcli download_ats_test_zip -name="Service_Name"
                            -type="Generic_Service"
                            -testname="Test_Name"
                            -testtype="OATS"
                            -output_dir="outputDirectory"

download_update

Downloads an update.

Format

emcli download_update 
        -id="internal id" 

Parameters

  • id

    Internal identification for the update to be downloaded.

Examples

The following example submits a job to download an update, and prints the job execution ID upon submission.

emcli download_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB"

edit_sl_rule

Edits the service level rule for the specified service.

Format

emcli edit_sl_rule
        -name=<target_name>
        -type=<target_type>
        [-expSL=<expected_service_level_value>]
        [-repeatSequence=<days_repeat_sequence>]
        [-startTime=<start_time>]
        [-endTime=<end_time>]
        [-availStatesInclude=<included_availability_states>]
        [-availStatesExclude=<excluded_availability_states>]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the target.

  • type

    Type of target. Use the get_targets verb to get the target type of a target.

  • expSL

    Expected service level value, which must be any number between 0 and 100.

  • repeatSequence

    Days in which the service level rule is to be applied, separated by commas. The value should be from MON, TUE, WED, THU, FRI, SAT, SUN.

  • startTime

    Time of the day from which the service level rule is to be applied. The format should be HH:min .

  • endTime

    Time of the day until which the service level rule is to be applied. The format should be HH:min .

  • availStatesInclude

    Availability states apart from UP that are to be included while computing the service level value. The value can be BLACKOUT or UNKNOWN.

  • availStatesExclude

    Availability states apart from UP that are to be excluded while computing the service level value. The value can be BLACKOUT or UNKNOWN.

Example

emcli edit_sl_rule 
      -name="Service Name"
      -type="generic_service"
      -expSL="90.0"
      -repeatSequence="MON,TUE"
      -startTime="06:00"
      -endTime="23:00"
      -availStatesInclude="BLACKOUT"
      -availStatesExclude="UNKNOWN"

enable_audit

Enables auditing for ALL and BASIC user operations. For other operations, see the update_audit_settings verb.

Format

emcli enable_audit
      [-level=basic]

[ ] indicates that the parameter is optional

Parameters

  • level=basic

    Enables auditing for BASIC user operations.

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_sla

Enables an SLA for a target.

Format

emcli enable_sla
    -targetName=<target_name>
    -targetType=<target_type>
    -slaName=<SLA_name>
    [-now]
    [-versionStart=<MM/dd/yyyy hh:mm a>]

[ ] indicates that the parameter is optional

Parameters

  • targetName

    Name of the target.

  • targetType

    Type of target.

  • slaName

    Name of the SLA.

  • now

    Enables the SLA now, or uses versionStart for a specific time.

  • versionStart

    Specifies when the computation of the SLA should start.

Examples

Example 1

The following example immediately enables an SLA named 'gold_sla' for target my_service (generic_service).

    emcli enable_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla' -versionNum=2 -now

Example 2

The following example enables a SLA named 'gold_sla' for target my_service (generic_service). It becomes active and starts computing at '09/23/2012 3:30 PM'.

    emcli enable_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla' -versionNum=2 -versionStart='09/23/2012 3:30 PM'

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>

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • testname

    Test name.

  • testtype

    Test type.

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=<script_to_be_executed>
      -targets=<name1:type1;name2:type2;...>
      -credential_set_name=<name>
      [-input_file=<parameter_tag:script_file>]

[ ] indicates that the parameter is optional

Parameters

  • cmd

    Host_command can be any valid host command or group of host commands.

  • osscript

    OS script to be executed with the cmd parameter.

  • targets

    List of target-name, target-type pairs. The host command is executed across this list of Enterprise Manager targets. All targets must be of the type host or composite, which represents a group of targets. If it is a group, the group is expanded to extract all the host targets, and the host command is executed across these host targets.

  • credential_set_name

    The credential_set_name parameter refers to the set name of the preferred credentials stored in the Enterprise Manager repository. If this parameter is not present, HostCredsNormal is used for executing host commands. For the host target type, two credential sets exist:

    • HostCredsNormal — Default unprivileged credential set for a host target

    • HostCredsPriv — Privileged credential set for a host target

      The credential set parameter can only be specified when the override credential parameters such as username and password are not present.

      If provided, the you must fully specify the override credential parameters. For host command, username and password must be specified together.

  • input_file

    Used in conjunction with -osscript , this enables you to load the contents of an OS script. The -input_file specifies a mapping between a tag and a local file path. The tag is specified in lieu of actual osscript contents of the -osscript . The tag must not contain colons ( : ) or semi-colons ( ; ).

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

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

[ ] indicates that the parameter is optional

Parameters

  • sql

    "sql command" is a single SQL statement.

  • targets

    List of target-name, target-type pairs. The SQL command executes across this list of Enterprise Manager targets. All targets must be of the type oracle_database or composite, which represents a group of targets. If it is a group, the group expands to extract all the database targets, and the SQL command is executed across these database targets.

  • credential_set_name

    Refers to the set name of the preferred credentials stored in the Enterprise Manager repository. If this parameter is not present, the DBCredsNormal and DBHostCreds credential set is used for executing SQL commands. For each target type, several credential sets exist:

    • HostCredsNormal — Default unprivileged credential set for a host target

    • HostCredsPriv — Privileged credential set for a host target

    • DBHostCreds — Host credential set for an oracle_database target

    • DBCredsNormal — Default normal credential set for an oracle_database target

    • DBCredsSYSDBA — sysdba credential set for an oracle_database target

    You can only specify the credential_set_name parameter when the override credential parameters such as [db_|host_]username and [db_|host_]password are not present. If provided, the override credential parameters must be specified fully. For the SQL commands, db_username, db_password, db_role, host_username, and host_password must be present.

  • input_file

    Used in conjunction with the -sql option, this option enables you to load the contents of a SQL script. The -input_file option specifies a mapping between a tag and a local file path. The tag is specified in lieu of an actual SQL command for the -sql . The tag must not contain colons ( : ) or semi-colons ( ; ).

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

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

Example 3

The following example executes the SQL command against "asm:osm_instance" and ASM targets contained in the group 'grp'. The SYSASM preferred credentials are used for all the targets.

emcli execute_sql
      -sql="select * from sysman.mgmt_targets;"
      -credential_set_name="ASMCredsSYSASM"
      -targets="asm:osm_instance;grp:composite"

export_compliance_group

Exports a compliance group definition and all of its element definitions given the name, author, and version.

Format

emcli export_compliance_group
      -name=<name>
      -author=<author>
      -version=<name>
      -output_file=<file>

Parameters

  • name

    Name of the group to be exported.

  • author

    Author of the group to be exported.

  • version

    Version of the group to be exported.

  • output_file

    Name of the exported file.

Examples

Example 1

emcli export_compliance_group \
     -name="foo" \
     -author="Jonas" \
     -version="99" \
     -output_file="$HOME/reports/group.xml"

export_compliance_standard_rule

Exports a rule to the specified files.

Format

export_compliance_standard_rule
  -name=<name>
  -target_type=<target_type>
  -output_file=<file>

Parameters

  • name

    Name of the rule to be exported.

  • target_type

    Target type of the rule to be exported.

  • output_file

    Name of the exported file.

Examples

Example 1

emcli export_compliance_standard_rule \
     -name="foo" \
     -target_type="weblogic_j2eeserver" \
     -output_file="$HOME/reports/rule.xml"

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]

[ ] indicates that the parameter is optional

Parameters

  • definition name

    Masking definition name.

  • path

    Path for the file name to save the masking script. The file name is auto-generated. -path and -file are mutually exclusive. Only an absolute path is allowed.

  • file

    File name to save the masking script. The file name must include the absolute path. -path and -file are mutually exclusive.

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_metric_extension

Exports a metric extension archive file.

Format

emcli export_metric_extension
       -file_name=<metric_extension_archive_name>
       -target_type=<metric_extension_target_type>
       -name=<metric_extension_name>
       -version=<metric_extension_version>

Parameters

  • file_name

    Name of the metric extension archive file to export into.

  • target_type

    Target type of the metric extension.

  • name

    Name of the metric extension.

  • version

    Version of the metric extension to be exported.

Example

The following example creates an archive of a metric extension of a given target type, name, and version.

emcli export_metric_extension -file_name=<name of the metric extension archive> -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension>

export_report

Exports an Information Publisher 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>

Parameters

  • title

    Title of the report to export. To export copies of Oracle-provided reports, the title value should be the internal report title stored in the repository. To avoid using the internal title, make a copy of the report and provide your own custom title, then use your title to export the report.

  • owner

    The owner of the report to export. The logged-in emcli user must have view privilege for the report. Target names are not exported. The report is uniquely defined using title and owner, so both must be supplied.

  • output_file

    Name of the exported file.

Examples

 emcli export_report       -title=Maintenance_Report       -owner=SHIFT1_OPERATOR       -output_file=$HOME/reports/maint_report.xml

export_sla

Extracts the configuration details of an SLA into a local file. If you do not specify slaName and/or version, multiple SLA are exported to the same output file.

Format

emcli export_sla
    -targetName=<target_name>
    -targetType=<target_type>
    [-slaName=<SLA_name>]
    -output_file=<output_filename>

[ ] indicates that the parameter is optional

Parameters

  • targetName

    Name of the target.

  • targetType

    Type of target.

  • slaName

    Name of the SLA.

  • output_file

    Output file name of the template. If the file does not exist, it is created; if it already exists, it is overwritten. (This assumes that the extract operation was successful. If the operation fails, no files are created, and any existing files remain unchanged.)

Example

The following example creates an output file named 'service_sla.xml' that contains configuration details of the 'gold_sla' SLA for the target 'my_service'.

emcli export_sla
          -targetName='my_service' 
          -targetType='generic_service'
          -slaName='gold_sla'
          -output_file='service_sla.xml'

export_standard

Exports a standard from the repository to an XML file.

Format

emcli export_standard
      -name=<name>
      -author=<author>
      -version=<name>
      -output_file=<file>

Parameters

  • name

    Name of the standard to be exported.

  • author

    Author of the standard to be exported.

  • version

    Author of the standard to be exported.

  • output_file

    Name of the exported file.

Example

emcli export_standard \
     -name=foo \
     -author=Curly \
     -version=99 \
     -output_file=$HOME/reports/standard.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_for_exported_template>]
      [-archive]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the template. The name and target type uniquely identify a template.

  • target_type

    Target type of the template.

  • output_file

    Specifies the file to output the template. If not specified, the template prints to stdout.

  • archive

    Indicates that the template must be exported as a zip file. When a Metric Extension is included in the template, this option is required to export the template as a zip file.

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

Example 3

The following example shows that the template archive specified by name HOST_TEMP1 and target type host will be created in the test.zip file.

emcli export_template -name=HOST_TEMP1  -target_type=host -output_file=test.zip -archive

export_update

Exports a Self Update archive file from Enterprise Manager to the specified location.

Format

emcli export_update 
        -id="internal id" 
        -dir="dir" 
        -omslocal 
emcli export_update 
        -id="internal id" 
        -dir="dir" 
        -host="hostname" 
        [-credential_set_name="setname"] | -credential_name="name"            -credential_owner="owner" 

[ ] indicates that the parameter is optional

Parameters

  • id

    Internal identification for the update to be exported.

  • dir

    Complete path of the directory where the update is to be exported.

  • omslocal

    Flag specifying that the directory is accessible from the OMS.

  • host

    Target name for a host target where the update is to be exported.

  • credential_set_name

    Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set

  • credential_name

    Name of a named credential stored in the repository. You must specify this option along with the credential_owner option.

  • credential_owner

    Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.

Examples

Example 1

The following example exports the update archive file to /u01/common/. The directory must exist on the OMS host. In a multiple OMS setup, the request can be processed by any OMS, so the directory should be accessible from the OMS processing the request. This usually means that the directory must be on a shared location accessible from all OMSes.

emcli export_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 
        -dir="/u01/common/" 
        -omslocal

Example 2

The following example exports the update archive file to /u01/common/ on host host1.example.com. The host must be the managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to push the remote file.

emcli export_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 
        -dir="/u01/common/" 
        -host="host1.example.com" 
        -credential_set_name="HostCredsNormal" 

Example 3

The following example exports the update archive file to /u01/common/ on host host1.example.com. The host must be the managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to push the remote file.

emcli export_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 
        -dir="/u01/common/" 
        -host="host1.example.com" 
        -credential_name="host1_creds" 
        -credential_owner="admin1"

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 EM CLI

When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.

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

  • input_file=dest_properties

    File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.

    Format:

    Destination Host Name1;Destination Home Loc; Home Name; Scratch Loca

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=list_exclude_files

    Comma-separated list of files to exclude. This is not required if the source is a Software Library. You can use an asterisk "*" as a wildcard.

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • isSwLib

    Specifies whether it is an Oracle Home database or Software Library.

  • tryftp_copy

    Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.

  • jobname

    Name of the cloning job.

  • iasInstance

    Application Server instance.

  • clustername

    Name of the cluster to join.

  • oldIASAdminPassword

    Old Application Server administrator password.

  • newIASAdminPassword

    New Application Server administrator password.

  • oiduser

    OID administrator user.

  • oidpassword

    OID administrator password.

  • dcmpassword

    DCM schema password.

  • prescripts

    Path of the script to execute.

    Note:

    Double-quoted parameters can be passed using an escape (\) sequence. For example:
    prescripts=" <some value here>=\"some value here\" " 
    
  • run_prescripts_as_root

    Run prescripts as root. By default, this option is set to false.

  • postscripts

    Path of the script to execute.

  • run_postscripts_as_root

    Runs postscripts as root. By default, this option is set to false.

  • rootscripts

    Path of the script to execute. You can use the job system environment variables (%oracle_home%, %perl_bin%) to specify script locations.

  • swlib_component

    Path to the Software Library to be cloned. isSwLib must be true in this case.

  • source_params

    Source Oracle home information. isSwLib must be false in this case.

  • jobdesc

    Description of the job. If not specified, a default description is generated automatically.

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

  • input_file

    File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.

    Format:

    Destination Host Name1;Destination Node Name;Scratch Location;PVTIC;VirtualIP;

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • list_exclude_files

    Comma-separated list of files to exclude. Not required if the source is a Software Library. You can use an asterisk "*" as a wildcard.

  • clusternodes

    List of current nodes in the cluster.

  • clustername

    Name of the cluster to create.

  • isSwLib

    Specifies whether it is an Oracle Home database or Software Library.

  • tryftp_copy

    Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.

  • jobname

    Name of the Cloning job.

  • srchost

    Name of a host that is part of the Oracle Clusterware cluster being extended.

  • home_name

    Name of home used by all the current Oracle Clusterware cluster nodes.

  • home_location

    Home location used by all the current Oracle Clusterware cluster nodes.

  • prescripts

    Path of the script to execute.

    Note:

    Double-quoted parameters can be passed using an escape (\) sequence. For example:
    prescripts=" <some value here>=\"some value here\" " 
    
  • run_prescripts_as_root

    Run prescripts as root. By default, this option is set to false.

  • postscripts

    Path of the script to execute.

  • run_postscripts_as_root

    Run postscripts as root. By default, this option is set to false.

  • rootscripts

    Path of the script to execute. You can use the job system environment variables (%oracle_home%, %perl_bin%) to specify script locations.

  • swlib_component

    Path to the Software Library to be cloned. isSwLib must be true in this case.

  • source_params

    Source Oracle home info. isSwLib must be false in this case.

  • jobdesc

    Description of the job. If not specified, a default description is generated automatically.

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 EM CLI

When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.


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

  • input_file

    File containing information regarding the targets. Each line in the file corresponds to information regarding one destination.

    Format:

    Destination Host Name;Destination Node Name;Scratch Location;

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • list_exclude_files

    Comma-separated list of files to exclude. Not required if the source is a Software Library. You can use an asterisk "*" as a wildcard.

  • isSwLib

    Specifies whether it is an Oracle Home database or Software Library.

  • tryftp_copy

    Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.

  • jobname

    Name of the cloning job.

  • clusternodes

    Current nodes in the cluster.

  • srchost

    Name of a host that is part of the RAC cluster being extended.

  • home_name

    Name of the home used by all the current RAC cluster nodes.

  • home_location

    Home location used by all the current RAC cluster nodes.

  • prescripts

    Path of the script to execute.

    Note:

    Double-quoted parameters can be passed using an escape (\) sequence. For example:
    prescripts=" <some value here>=\"some value here\" " 
    
  • run_prescripts_as_root

    Run prescripts as root. By default, this option is set to false.

  • postscripts

    Path of the script to execute.

  • run_postscripts_as_root

    Run postscripts as root. By default, this option is set to false.

  • rootscripts

    Path of the script to execute.

  • swlib_component

    Path to the Software Library being cloned. isSwLib must be true in this case.

  • source_params

    Source Oracle home info. isSwLib must be false in this case.

  • jobdesc

    Description of the job. If not specified, a default description is generated automatically.

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 EM CLI

When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.


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

[ ] indicates that the parameter is optional

Parameters

  • templateName

    Name of the template.

  • templateType

    Type of template.

  • output_file

    Name of the output file. If the file does not exist, it will be created; if it already exists, it will be overwritten. (This is assuming the extract operation was successful; if the operation fails, no files are created, and any existing files are left unchanged.)

  • encryption_key

    Key to encrypt the file contents. The same key should be used to decrypt the file.

Example

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_discovery_input

Fusion Middleware Plug-in Release 12.1.0.6 introduced this verb to further automate the process of adding several WebLogic Domains to the Cloud Control console. You can run this verb after automatic discovery has already discovered several WebLogic Domains.

This verb creates a discovery input file automatically based on the targets discovered from the automatic discovery operation. You can then use this discovery input file in conjunction with the discover_wls verb to further automate the process of promoting discovered domains as fully managed targets. Consequently, you do not need to manually create a discovery input file to perform domain discovery from EM CLI.

Format

emcli generate_discovery_input
        -out_file=<fully_qualified_path_of_output_file>

Parameters

  • out_file

    Location where the output file will be generated. Verify that the OMS user has write permissions on the specified location. If you are invoking the verb from the EM CLI client, verify that you have read permissions on the specified location.

Examples

The following example creates the ouput file /tmp/myFile.csv.

emcli generate_discovery_input -out_file=/tmp/myFile.csv

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_name=cred_name]
      [-input_file=<parameter_tag:file_path>]
      [-script | -format=[name:<pretty|script|csv>]; 
                         [column_separator:column_sep_string]; 
                         [row_separator:row_sep_string];

[ ] indicates that the parameter is optional

Parameters

  • definition_name

    Name of the masking definition.

  • parameters

    List of name-value pairs that represent the credentials required for connecting to the database instance. The supported parameters are db_username, db_password, and db_role.

  • credential_name

    Name of the database credential. This parameter is mandatory when the db_username and db_password parameters are not specified.

  • input_file

    Used in conjunction with the 'parameters' option, this enables you to store parameter values, such as username and password, in a separate file. This specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific parameter values of the 'parameters' . The tag must not contain colons ( : ) or semi-colons ( ; ).

    For information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • script

    This is equivalent to -format='name: script'.

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

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 database credentials from the named credential DB_NC and generates the masking script.

emcli generate_masking_script
      -definition_name=mask_hr_data
      -credential_name=DB_NC

get_add_host_status

Displays the latest status of an Add Host session.

Format

emcli get_add_host_status
      -session_name="Session name"
      [-details]
      [-show_only_failed_hosts]
      [-host_name="Host name"]
      [-noheader]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:"column_sep_string"];
                 [row_separator:"row_sep_string"];
        ]

[ ] indicates that the parameter is optional.

Parameters

  • session_name

    Name of the session whose status you want to view.

  • details

    Displays additional information for the given session.

  • show_only_failed_hosts

    Displays only the hosts on which the Add Host operation failed.

  • host_name

    Displays the details of the provided host.

  • noheader

    Display tabular output without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Host, Platform Name, Initialization, Remote Prerequisite, Agent Deployment, Error

Examples

Example 1

The following example displays the add host status for the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST'

emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST 

Example 2

The following example displays the add host status for the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST', with additional information.

emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST -details 

Example 3

The following example displays the detailed status of host 'example.com' for the session 'ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT'.

emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT -host_name=example.com

Example 4

The following example displays only the failed hosts for the session 'ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT'.

emcli get_add_host_status -session_name=ADD_HOST_SYSMAN_Jun_6_2013_11:26:43_PM_PDT -show_only_failed_hosts

get_agentimage

Gets the Management Agent image for the particular platform and version provided as inputs.

Format

emcli get_agentimage
   -destination=<download_directory> 
   -platform="<platform>"
   [-version=<version>]

[ ] indicates that the parameter is optional.

Parameters

  • destination

    Directory where you want to download the Management Agent software. Ensure that you have write permission on this location.

    If the destination directory is titled with two or more words separated by a space, enclose the directory name with double-quotes. For instance, if the destination directory is titled /tmp/linuxagentimage, enter the value as -destination="/tmp/linuxagentimage"

  • platform

    Platform for which you want to download the software; this must match one of the platforms for which the software is available on the OMS host. Use the emcli get_supported_platforms command to determine this.

  • version

    Version of the Management Agent software that you want to download. If you do not specify this , the version defaults to the OMS version.

Examples

emcli get_agentimage -destination=/tmp/agtImage -platform=Linux x86 -version=12.1.0.1.0

get_agentimage_rpm

Gets the Management Agent image for the Linux platform and version provided as inputs, then converts the image as rpm.

Format

emcli get_agentimage_rpm
   -destination=<download_directory> 
   -platform=<platform>
   [-version=<version>]

[ ] indicates that the parameter is optional.

Parameters

  • destination

    Directory where you want to download the .rpm file. Ensure that you have write permission on this location.

    If the destination directory is titled with two or more words separated by a space, enclose the directory name with double-quotes. For instance, if the destination directory is titled /tmp/linuxagentimage, enter the value as -destination="/tmp/linuxagentimage"

  • platform

    Platform for which you want to download the .rpm file; this must match one of the platforms for which the software is available on the OMS host. Use the emcli get_supported_platforms command to determine this.

  • version

    Version of the Management Agent for which you want to download the .rpm file. If you do not specify this , the version defaults to the OMS version.

Examples

emcli get_agentimage_rpm -destination=/tmp -platform=Linux x86 -version=12.1.0.1.0

get_agent_properties

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

Format

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

[ ] indicates that the parameter is optional

Parameters

  • agent_name

    Name of the Management Agent target.

  • all

    Shows all Management Agent properties. By default, only basic properties appear.

  • format

    Format to display Management Agent properties. Valid values are pretty, script, and csv. By default, values are displayed in pretty format.

Examples

The following example shows all of the Management 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 Management Agent property. You can use this command if you have view privilege for the Management Agent.

Format

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

Parameters

  • agent_name

    Name of the Management Agent target.

  • name

    Name of the Management Agent property.

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_agent_upgrade_status

Shows Agent upgrade results.

Format

emcli get_agent_upgrade_status
      [-agent]
      [-job_name]
      [-status]

[ ] indicates that the parameter is optional

Parameters

  • agent

    Shows the upgrade job details of the specified Agent names or Agent name patterns separated by commas.

  • job_name

    Shows the upgrade job details of the specified job name.

  • status

    Shows the upgrade job details with the specified status.

Permutations for combinations of parameters are as follows:

No parameters — Shows <JOB NAME, JOB STATUS, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job.

-job_name only — Shows <AGENT_NAME, UPGRADE STATUS OF AGENT, UPGRADE START TIME, UPGRADE END TIME> for each Agent in the job, where job name is passed in the -job_name parameter.

-agent only — Shows <JOB NAME, UPGRADE STATUS OF AGENT IN THE JOB, UPGRADE START TIME, UPGRADE END TIME> for each job where the Agent is present and the Agent name passed in the -agent parameter.

-agent and -status only — Shows <JOB NAME, UPGRADE START TIME, UPGRADE END TIME> for each job in which the Agent and Agent upgrade status are passed in -agent and -status, respectively.

-job_name and -agent only — Shows <JOB STEP NAME, JOB STEP STATUS, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent passed in the -job_name and -agent parameters.

-job_name and -status only — Shows <AGENT_NAME, UPGRADE START TIME, UPGRADE END TIME> for each Agent in the job in which the Agent upgrade status is passed in -job_name and -status, respectively

-job_name, -agent, and -status — Shows <JOB STEP NAME, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent in which the step status is passed in -job_name , -agent , and -status, respectively

-status only — Shows <JOB NAME, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job in which job status is passed in the -status parameter.

Examples

Example 1

The following example shows the Agent upgrade job details for the Agent xyz.domain.com:1243 .

emcli get_agent_upgrade_status -agent="xyz.domain.com:1243"

Example 2

The following example shows the Agent upgrade job details for the job UPGRADE_JOB123 .

emcli get_agent_upgrade_status  -job_name="UPGRADE_JOB123"

Example 3

The following example shows the Agent upgrade job details with the status Inprogress.

emcli get_agent_upgrade_status -status="Inprogress"

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Aggregate service name.

  • type

    Aggregate service type.

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Aggregate service name.

  • type

    Aggregate service type.

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

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>]
      [-noheader]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:<column_sep_string>];
                 [row_separator:<row_sep_string>];
      ]
[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the blackout.

  • createdby

    Enterprise Manager user who created the blackout. The default is the current user. For displaying details of a blackout created using emctl, use -createdby="<SYSTEM>".

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

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>]
      [-noheader]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:<column_sep_string>];
                 [row_separator:<row_sep_string>];
      ]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the blackout.

  • createdby

    Enterprise Manager user who created the blackout. The default is the current user. For listing details of a blackout created using emctl, use -createdby="<SYSTEM>".

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

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

[ ] indicates that the parameter is optional

Parameters

  • target

    Lists blackouts for this target. When neither this nor the -hostnames option is specified, all blackouts the user has privilege to view are listed.

  • hostnames

    Lists blackouts that have a target on one of the specified hosts. The host name is just the target name part of the host target. For example, specify host.example.com, rather than host.example.com:host. When neither this nor the -target option is specified, all blackouts the user has privilege to view are listed.

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

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 Cloud Control installation. It also displays the Management Agent names whose certificates are issued by the CA(s) when you specify the -details option. The following information is retrieved from the Cloud Control repository:

  • Unique identifier of the Certificate Authority (CA) in the Cloud Control repository

  • CA description

  • CA creation date

  • CA expiration date

  • Number of Management Agents registered to this CA

  • Number of secured Management Agents not registered to any CA

Format

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

[ ] indicates that the parameter is optional

Parameters

  • ca_id

    Specifies the Certificate Authority ID.

  • details

    For each Certificate Authority, displays the list of Management Agent names whose certificates are issued by it.

Examples

The following example shows output for the CA with the ID of 2 specified.

    emcli get_ca_info -ca_id=2
 
     Info about CA with ID: 2
     CA is configured
     DN: EMAILADDRESS=Enterprise.Manager@myomshost.mycompany.com,      CN=myomshost.mycompany.com, OU=EnterpriseManager on myomshost.mycompany.com,      O=EnterpriseManager on myomshost.mycompany.com, L=EnterpriseManager on         myomshost.mycompany.com1, ST=CA, C=US, DC=com
     Serial# : 87539237298512593900
     Valid From: Mon Oct 25 17:01:15 UTC 2011
     Valid Till: Thu Oct 22 17:01:12 UTC 2020
     Number of Agents registered with CA ID 2 is 1
 
     Number of Agents to be re-secured, as OMS is secured using force_newca           : 1

Regarding the force_newca option in the last line, the output shows that a new certificate was created with the ID of 2. Two Management Agents have been re-secured to be registered with this new certificate. The OMS running on myomshost.mycompany.com has been re-secured to be registered with the new certificate created. There is still a Management Agent that needs to be secured to be registered to the new certificate. To retrieve the Management Agent name, you need to run the command "emcli get_ca_info -ca_id=2 -details," which is shown in the next example.

The following example displays the Management Agent names registered with the CA(s) for ID 2.

emcli get_ca_info -ca_id=2 -details
 
     Info about CA with ID: 2
     CA is configured
     DN: EMAILADDRESS=Enterprise.Manager@myomshost.mycompany.com,          CN=myomshost.mycompany.com, OU=EnterpriseManager on myomshost.mycompany.com,         O=EnterpriseManager on myomshost.mycompany.com, L=EnterpriseManager on         myomshost.mycompany.com2, ST=CA, C=US, DC=com
     Serial# : 87539237298512593900
     Valid From: Mon Oct 25 17:01:15 UTC 2011
     Valid Till: Thu Oct 22 17:01:12 UTC 2020
     Number of Agents registered with CA ID 2 is 1
     usagent1.mycompany.com:20872
 
     Following Agents needs to be re-secured, as OMS is secured using force_newca          :

     ukagent1.mycompany.com:1830

get_connection_mode

Gets the My Oracle Supporrt (MOS) connection mode. The two MOS connection modes are online and offline.

Format

emcli get_connection_mode

Parameters

None.

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

get_credtype_metadata

Prints credential-type information for a credential type. The verb prints credential column names. These column names should be used as parameter names for the create_named_credential and modify_named_credential verbs.

Format

emcli get_credtype_metadata 
        -auth_target_type=<ttype>
        -cred_type=<name>

Parameters

  • auth_target_type

    Authenticating target type.

  • cred_type

    Credential type.

Examples

emcli get_credtype_metadata 
          -auth_target_type=host
          -cred_type=HostCreds

get_duplicate_credential

Gets all the target-scoped named credentials that are the same as the given target-scoped named credential. Duplicate credentials are redundant. Named credentials can be managed better if reused. The same named credential can be reused for all of the usages.

Format

emcli get_duplicate_credential 
        -cred_name=<cred_name>
        [-cred_owner=<cred_owner>]

[ ] indicates that the parameter is optional

Parameters

  • cred_name

    Searches duplicates of this credential.

  • cred_owner

    Owner of the credential, which defaults to the current user.

Example

The following example gets all of the credentials that are the same as the named credential MyOracleCredential and credential owner Joe.

emcli get_duplicate_credential 
        -cred_name=MyOracleCredential
        -cred_owner=Joe

get_executions

Gets a list of executions of a submission using a submission GUID.

Format

emcli get_executions     -instance=<Instance_GUID>

Parameters

  • instance

    Displays all executions of a submission.

Output Columns

ExecutionGUID, Name, Status

Examples

emcli get_executions instance=16B15CB29C3F9E6CE040578C96093F61

get_ext_dev_kit

Downloads the Extensibility Development Kit to your local system. This verb has no parameters and only downloads a kit called edk.zip to the directory where you execute the command. After extracting the contents, you can use this kit to develop extensible components (plug-ins) of Enterprise Manager.

Format

emcli get_ext_dev_kit

Parameters

None.


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=#]
      [-noheader]
      [-expand_non_groups]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:<column_sep_string>];
                 [row_separator:<row_sep_string>];
      ]
[ ] indicates that the parameter is optional

Parameters

  • name

    Target name of the group.

  • type

    Group type: group. Defaults to group.

  • depth

    Lists target members in sub-groups to the depth specified. The default is 1. When the depth is set to 0, no group target members are listed, and only the group's existence is verified. When the depth is set to -1, all group and sub-group target members are listed; in this case no groups appear in the output. Note that a target is listed at most once, even though it can be a member of several sub-groups.

  • noheader

    Displays tabular information without column headers.

  • expand_non_groups

    Lists members of aggregates and the aggregate target. By default, only sub-group target members are listed.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

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

[ ] indicates that the parameter is optional

Parameters

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Target Name, Target Type

Example

The following example lists all groups.

emcli get_groups

get_instance_data

Downloads instance submission data.

Format

emcli get_instance_data 
        [-instance=<instance_guid>] 
        [-exec=<execution_guid>] 
        [-name=<execution name>] 
        [-owner=<execution owner>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    Instance GUID.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

Output

Instance properties data.

Examples

emcli get_instance_data -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  
        -instance=<instance_guid> 
        [-exec=<execution_guid>] 
        [-name=<execution_name>] 
        [-owner=<execution_owner>] 
        [-xml [-details] [-showJobOutput [-tailLength=<last_n_characters>]]]

[ ] indicates that the parameter is optional

Parameters

  • instance

    Display the details of a procedure instance identified by the GUID number. You can find the GUID number by using the emcli get_instances command.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

  • xml

    Shows the complete status of each of the steps in XML format.

  • details

    Displays more details for the command output. This option also requires the -xml option.

  • showJobOutput

    Shows the output or errors for the job execution steps. This option also requires the -xml option.

  • tailLength

    Limits the number of characters in the job step output or error. This option also requires the -showJobOutput option.

    <Last N Characters> is a positive non-zero number until which the characters are chosen from the end of the job step output. The system sets the maximum permissible characters to dump. If you do not provide this option, the maximum permissible characters are dumped.

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

See Also

get_instances

get_job_execution_detail


get_instances

Displays a list of procedure instances.

Tip:

See also get_procedure_types.

Format

emcli get_instances 
      [-type=<procedure_type>]

[  ] indicates that the parameter is optional

Parameters

  • type

    Displays all the procedure instances of type procedure_type.

Output Columns

Instance GUID, Execution 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

See Also

get_procedure_types


get_job_execution_detail

Displays details of a job execution.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • execution

    Specifies that the ID of the job execution (execution_id) is the job execution ID.

  • xml

    Shows the execution details as XML.

  • showOutput

    Shows the output of the steps inside the job execution. You can only use this option in conjunction with the -xml option.

  • tailLength

    Limits the display of the output to the number of characters from the end of the output. (length) is in characters. You can only use this option in conjunction with the -showOutput option. If you do not specify this option, a system-generated hard limit is enforced.

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.

Command-Line Format

emcli get_jobs
        [-name="job_name_pattern"]
        [-owner="job_owner"]
        [-job_ids="ID1;ID2;..."]
        [-targets="type1:name1;type2:name2;..."]
        [-status_ids="status1;status2;..."]
        [-noheader]
        [-script | -format=
                           [name:<pretty|script|csv>];
                           [column_separator:"column_sep_string"];
                           [row_separator:"row_sep_string"];
        ]

[ ] indicates that the parameter is optional

Scripting and Interactive Format

get_jobs
      [(name="job_name_pattern"]
      [,owner="job_owner"]
      [,job_ids="ID1;ID2;..."]
      [,targets="type1:name1;type2:name2;..."]
      [,status_ids="status1;status2;..."]
      [,noheader=True|False]
      [,script=True|False | ,format=
                 [name:<pretty|script|csv>];
                 [column_separator:"column_sep_string"];
                 [row_separator:"row_sep_string"];
      ])

[ ] indicates that the parameter is optional

Parameters

  • name

    Job name pattern to filter on.

  • owner

    Owner of the jobs to filter on.

  • job_ids

    Lists job IDs to use as the output filters.

  • targets

    Lists targets (as name-type pairs) to use as the output filters.

  • status_ids

    Lists numeric status IDs to use as the output filters.

    The numeric codes for all possible job statuses are as follows:

    • ABORTED(Error)=3

    • ACTION_REQUIRED_STATUS=22

    • COMPLETED(Successful)=5

    • EXECUTING(Running)=2

    • FAILED=4

    • INACTIVE=14

    • MISSING_CREDS_STATUS=21

    • QUEUED=15

    • REASSIGNED_STATUS=20

    • SCHEDULED=1

    • SKIPPED=18

    • STOPPED=8

    • STOP_PENDING=12

    • SUSPENDED_AGENT_DOWN=7

    • SUSPENDED_BLACKOUT=11

    • SUSPENDED_EVENT=10

    • SUSPENDED_LOCK=9

    • SUSPEND_PENDING=13

    • SUSPENDED_USER=6

    • TARGET_NOT_READY_STATUS =26

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

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

Examples

The following examples show the jobs with the specified job IDs 12345678901234567890123456789012 and 09876543210987654321098765432100:

Example 1 - Command-Line

emcli get_jobs
      -job_ids="12345678901234567890123456789012;09876543210987654321098765432100"

Example 2 - Script and Interactive

get_jobs
    (job_ids="12345678901234567890123456789012;
       09876543210987654321098765432100")

The following examples show all jobs run against a host target named mainhost.example.com that are scheduled or have completed.

Example 3 - Command-Line

emcli get_jobs
      -status_ids="1;5"
      -targets="mainhost.example.com:host"

Example 4 - Script and Interactive

get_jobs
     (status_ids="1;5", 
      targets="mainhost.example.com:host")

The following examples show all jobs run against an Oracle database target named payroll that have failed. Tabular output is generated using tabs as column separators and newlines as row separators.

Example 5 - Command-Line

emcli get_jobs
      -status_ids="4"
      -targets="payroll:oracle_database"
      -script

Example 6 - Scripting and Interactive

get_jobs
      (status_ids="4"
      ,targets="payroll:oracle_database"
      ,script=True)

The following examples list all jobs whose names start with BACKUP.

Example 7 - Command-Line

emcli get_jobs 
      -name="backup%"

Example 8 - Scripting and Interactive

emcli get_jobs
      (name="backup%")

The following examples list all jobs owned by admin1.

Example 9 - Command-Line

emcli get_jobs 
      -owner="admin1"

Example 10 - Scripting and Interactive

emcli get_jobs
      (owner="admin1")

get_job_types

Lists all the job types that can be used to create jobs, library jobs, and multi-task jobs from EM CLI.

EM CLI supports the following job types:

ASMSQLScript
ASSOCIATE_CS_FA
ASSOCIATE_DOMAIN_FA
AssociateClusterASM
BlockAgent
CoherenceCacheAddition
CoherenceNodesRefresh
Config Log Archive Locations
DbMachineDashboard
DiscoverPDBEntities
FusionMiddlewareProcessControl
GlassFishProcessControl
InstallKernelModuleJob
Log Rotation
OSCommand
OpatchPatchUpdate_PA
RMANScript
RefreshFromEMStore
RefreshFromMetalink
RefreshFusionInstance
SOABulkRecovery
SQLScript
ShutdownDB
StartDepartedCohNodes
StartDepartedCohStoreNodes
StartFusionInstance
StartupDB
StatspackPurge
StopFusionInstance
Upgrade Exalogic Systems
WebLogic Control
WebLogic Domain Discover
WebLogic Domain Refresh

Format

emcli get_job_types   [-type="job_type_pattern"]   [-target_type="target_type"]

[ ] indicates that the parameter is optional

Parameters

  • type

    Job type internal name pattern. Specify all or part of the job type name.

  • target

    Target type on which the job type will run.


get_metering_data

Gets usage details.

Format

emcli get_metering_data 
     [-start_date=<start_date_in_mmddyyyy>] 
     [-end_date=<end_date_in_mmddyyyy>]
     [-charge]
     [-cost_center=<cost_center_name>] 
     [-target_type=<target_type>
     [-target_name=<target_name>]

[ ] indicates that the parameter is optional

Parameters

  • start_date

    Report cycle start date in mmddyyyy. If you do not specify the report cycle start date, the latest report cycle is used.

  • end_date

    Report cycle end date in mmddyyyy. If you do not specify the report cycle end date, the latest report cycle is used.

  • charge

    Prints charge relation information.

  • cost_center

    Cost center name. If you do not specify the cost center name, the logged in user is used as the cost center name.

  • target_type

    If you do not specify the target type, all targets are used. Supported target types for this release are oracle_database, oracle_vm_guest, host, and weblogic_j2eeserver. This parameter is not valid without the target_name parameter.

  • target_name

    If you do not specify the target name, all targets of a given target type are used. This parameter is not valid without the target_type parameter.

Examples

Example 1

The following example shows the latest cycle usage data for the logged in user.

emcli get_metering_data 

Example 2

The following example shows usage data for the cost center cost_center_internal_name for the report cycle with a starting date of 10012011.

emcli get_metering_data     -start_date=10012011     -cost_center=cost_center_internal_name 

Example 3

The following example shows charge data for the my_target Oracle Guest VM target for cost center cost_center_internal_name for a report cycle with a starting date of 10012011.

emcli get_metering_data 
    -start_date=10012011 
    -cost_center=cost_center_internal_name 
    -target_type=oracle_vm_guest 
    -target_name=my_target 
    -charge 

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

Parameters

  • target_type

    Internal target type identifier, such as host, oracle_database, oc4j, oracle_emrep, and oracle_emd.

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_named_credential

Displays named credential details.

Command-Line Format

emcli get_named_credential 
        -cred_owner=<owner>
        -cred_name=<name>
        -out=<filename>

Scripting and Interactive Format

get_named_credential 
        (cred_owner=<owner>
        ,cred_name=<name>
        ,out=<filename>)

Parameters

  • cred_owner

    Owner of the credential.

  • cred_name

    Required credential name.

  • out

    Output file name. The same file can be used as the input properties file for create_named_credential and modify_named_credential.

Examples

The following examples display the details of the named credential NC1 owned by the current logged in user.

Example 1 - Command-Line

emcli get_named_credential 
      -cred_name=NC1

Example 2 - Scripting and Interactive

get_named_credential 
       (cred_name="NC1")

The following examples display the details of the named credential NC2 owned by the Administrator CREDS_MGR.

Example 3 - Command-Line

emcli get_named_credential 
      -cred_name=NC2 
      -cred_owner=CREDS_MGR

Example 4 - Scripting and Interactive

get_named_credential 
      (cred_name="NC2" 
      ,cred_owner="CREDS_MGR")

get_oms_config_property

Gets the property value corresponding to the specified property name.

Format

emcli get_oms_config_property 
        -property_name="propertyName"
        [-oms_name="omsName"]
        [-details]

[ ] indicates that the parameter is optional

Parameters

  • property_name

    Name of the property whose value must be retrieved.

  • oms_name

    Name of the mangaement server for which the property must be retrieved.

  • details

    Specifies details about from where the property value has been derived, and also the global and default values for the property.

Examples

Example 1

The following example retrieves the property value set for the property name "propName" from the management server myhost:1159_Management_Service.

get_oms_config_property -property_name=propName -oms_name="myhost:1159_Management_Service"

Example 2

The following example retrieves the property value set for the property name "propName" from all the management servers.

get_oms_config_property -property_name=propName 

Example 3

The following example retrieves the property value set for the property name "propName" from all the management servers with details.

get_oms_config_property -property_name=propName -details

get_oms_logging_property

Gets the property value corresponding to the specified logging property name.

Format

emcli get_oms_logging_property 
        -property_name="propertyName"
        [-oms_name="omsName"]
        [-details]

[ ] indicates that the parameter is optional

Parameters

  • property_name

    Name of the logging property whose value must be retrieved.

  • oms_name

    Name of the mangaement server for which the property must be retrieved.

  • details

    Specifies details about from where the property value has been derived, and also the global and default values for the logging property.

Examples

Example 1

The following example retrieves the property value set for the property name "propName" from the management server myhost:1159_Management_Service.

get_oms_logging_property -property_name=propName -oms_name="myhost:1159_Management_Service"

Example 2

The following example retrieves the property value set for the property name "propName" from all the management servers.

get_oms_logging_property -property_name=propName 

get_on _demand_metrics

Gets a list of metrics that can be immediately collected with the collect_metric EM CLI verb. From this list, identify the metric you are interested in under the Metric Name column, then use its corresponding Metric Internal name in the collect_metric verb.

Format

emcli get_on_demand_metrics      -target_type=type
      -target_name=name

Parameters

  • target_type

    Internal target type identifier, such as host, oracle_database, oc4j, oracle_emrep, and oracle_emd.

  • target_name

    Name of the target.

Examples

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

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

get_operation_plan_details

Provides detailed step-by-step information about the specified operation plan.

Format

emcli get_operation_plan_details
      -name="plan name"

Parameters

  • name

    Name of the operation plan.

Examples

emcli get_operation_plan_details
      -name="BISystem1-switchover"

See Also

create_operation_plan

get_operation_plans


get_operation_plans

Lists all configured operation plans.

Format

emcli get_operation_plans
      -name=<operation plan_name>
      -operation=<operation_name>

Parameters

  • name

    Name of the operation plan.

  • operation

    Name of the operation, such as switchover, failover, start, or stop.

Output Columns

Plan Name, Operation Name, Configuration GUID

Examples

emcli get_operation_plans
      -name="austin-switchover"
      -operation="switchover"

See Also

create_operation_plan

submit_operation_plan


get_patch_plan_data

Gets patch plan user-editable data.

Format

emcli get_patch_plan_data
        -name="name"

Parameters

  • name

    Name of a given patch plan.

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

Example

emcli get_patch_plan_data -name="plan_name" 

get_plugin_deployment_status

Displays the status of a specific plug-in deployment or undeployment activity as well as the list of steps.

Format

emcli get_plugin_deployment_status 
       [-plugin_id="plugin_id"]

[ ] indicates that the parameter is optional

Parameters

  • plugin_id

    ID of the plug-in for which you need to view the deployment/undeployment status. If not provided, the command shows the status of the latest plug-in being deployed, or the last one that was deployed or undeployed.

Examples

Example 1

Displays the status of the last plug-in deployment/undeployment activity.

emcli get_plugin_deployment_status

Example 2

The following example displays the status of the last deployment/undeployment activity of a specific plug-in.

emcli get_plugin_deployment_status -plugin_id=oracle.sysman.db

get_procedures

Gets a list of deployment procedures and pre-saved procedure configurations.

Tip:

See also get_procedure_types .

Format

emcli get_procedures [-type=<procedure_type>]
      [-parent_proc=<procedure_associate>]

[ ] indicates that the parameter is optional

Parameters

  • type

    Displays all the deployment procedures of type procedure_type.

  • parent_proc

    Procedure associated with procedure configurations.

Output Columns

GUID, Procedure Type, Name, Display Type, Version, Created By, Procedure Name

See Also

get_procedure_types

get_procedure_xml


get_procedure_types

Gets the list of all deployment procedure types.

Format

emcli get_procedure_types

Output Column

Procedure Type

Example

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]
      [-name=<procedure_name>]
      [-owner=<procedure_owner>]

[ ] indicates that the parameter is optional

Parameters

  • procedure

    Procedure GUID.

  • name

    Procedure name.

  • owner

    Procedure owner.

Output

Deployment procedure XML.

Examples

emcli get_procedure_xml -procedure=16B15CB29C3F9E6CE040578C96093F61 > proc.xml

get_reports

Returns a list of Information Publisher reports owned by or viewable by all users or a specified user. The output of this report is space-separated, quoted strings for the report title and owner, with each report on its own line.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • owner

    Enables listing of viewable reports that a specific Enterprise Manager owns.

Output

Space-separated quoted strings for the report title and owner, with each report on its own line.

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_resolution_states

Gets the list of existing resolution states used in managing incidents and problems. It also prints the display position of states. It does not list the fixed "New" and "Closed" resolution states.

Format

emcli get_resolution_states 

Parameters

None.

Examples

The following example shows sample output for Incident defined states of OnHold, Waiting, and Processed, and Problem defined states of OnHold and Processed.

Incident resolution states
   5     OnHold
  10     Waiting
  25     Processed
 
Problem resolution states
   5     OnHold
  25     Processed

get_retry_arguments

Get arguments of failed steps that can be retried.

Format

emcli get_retry_arguments 
      [-instance=<instance_guid>] 
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>] 
      [-stateguid=<state_guid>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    Instance GUID.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

  • stateguid

    State GUID.

Examples

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

get_retry_arguments

Get arguments of failed steps that can be retried.

Format

emcli get_retry_arguments 
      [-instance=<instance_guid>] 
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>] 
      [-stateguid=<state_guid>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    Instance GUID.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

  • stateguid

    State GUID.

Examples

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

get_signoff_agents

Shows the available Agents for sign-off.

If you do not specify any options, the command shows all Agents available for sign-off. If you specify more than one option, the command shows the union of Agents available for sign-off belonging to each option passed.

Format

emcli get_signoff_agents 
      [-agents="List_of_agents"]
      [-platforms="List_of_platforms"]
      [-versions="list_of_versions"]
      [-groups="list_of_group_names"]
      [-output_file="location_of_output_file"]

[ ] indicates that the parameter is optional

Parameters

  • agents

    List of Agents for sign-off matching Agent names or Agent names pattern separated by commas.

  • platforms

    Lists Agents available for sign-off on the specified platforms.

  • versions

    Lists Agents available for sign-off with the specified version.

  • groups

    Lists Agents available for sign-off belonging to the specified groups.

  • output_file

    Adds the Agents into the output file, which can be submitted for a clean-up job to remove old Oracle Management Agent homes and old Oracle home targets, and back up directories of upgraded Oracle Management Agents.

Examples

Example 1

The following example shows the list of Agents for clean up that match the Agents specified in the option.

emcli get_signoff_agents -agents="abc%,xyz.domain.com:1243"

Example 2

The following example shows the list of Agents for clean up that match the platform specified in the option.

emcli get_signoff_agents -platforms="Linux x86,Microsoft Windows x64 (64-bit)"

Example 3

The following example shows the list of Agents for clean up that match the versions specified in the option.

emcli get_signoff_agents -versions="12.1.0.1.0,12.1.0.2.0"

Example 4

The following example shows the list of Agents for clean up that match the group names specified in the option.

emcli get_signoff_agents -groups="GROUP1,GROUP2"

Example 5

The following example adds the list of Agents for clean up to the /scratch/agents_file.txt file.

emcli get_signoff_agents -output_file="/scratch/agents_file.txt"

get_signoff_status

Shows Agent sign-off results.

Format

emcli get_signoff_status 
      [-agent="full_agent_name"]
      [-job_name="job_name"]
      [-status="status"]

[ ] indicates that the parameter is optional

Parameters

  • agent

    Shows the sign-off job details of the specified Agent names or Agent names pattern separated by commas.

  • job_name

    Shows the sign-off job details of the specified job name.

  • status

    Shows the sign-off job details of the specified status.

Permutations for combinations of parameters are as follows:

No parameters — Shows <JOB NAME, JOB STATUS, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job.

-job_name — Shows <AGENT_NAME, STATUS OF JOB, START TIME, END TIME> for each Agent in the job, where tje job name is passed in the -job_name parameter.

-status only — Shows <JOB NAME, NUMBER OF AGENTS IN THE JOB, JOB START TIME, JOB END TIME> for each job, where the job status is passed in -status parameter.

-agent only — Shows <JOB NAME, STATUS OF JOB, START TIME, END TIME> for each job, where the Agent is present and the Agent name is passed in the -agent parameter.

-job_name and -agent only — Shows <JOB STEP NAME, JOB STEP STATUS, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent passed in -job_name , -agent parameter

-job_name, -agent, and -status — Shows <JOB STEP NAME, JOB STEP START TIME, JOB STEP END TIME> for each step in the job for the Agent having step status passed in -job_name , -agent , and -status respectively.

-job_name and -status — Shows <AGENT_NAME, START TIME, END TIME> for each Agent in the job having an Agent upgrade status passed in -job_name and -status respectively.

-agent and -status — Shows <JOB NAME, START TIME, END TIME> for each job having the Agent and clean-up status passed in -agent and -status respectively.

Examples

Example 1

The following example shows the sign-off job details for agent xyz.domain.com:1243 .

emcli get_signoff_status -agent=xyz.domain.com:1243

Example 2

The following example shows the sign-off job details with the job name cleanup_123.

emcli get_signoff_status -job_name="cleanup_123"

Example 3

The following example shows the sign-off job details with the status Success.

emcli get_signoff_status -status="Success"

get_siteguard_credential_association

Lists the credential associations configured for a system.

Format

emcli get_siteguard_credential_association
      [-system_name=<name_of_system>]
      [-target_name=<name_of_target>]
      [-credential_type=<type_of_credential>]

[ ] indicates that the parameter is optional

Parameters

  • system_name

    Name of the system.

  • target_name

    Name of the target.

  • credential_type

    Type of the credential, which can be HostNormal, HostPrivileged, WLSAdmin, or DatabaseSysdba.

Output Columns

Target Name, Credential Name, Credential Type

Examples

Example 1

emcli get_siteguard_credential_association
      -system_name="austin-system"
      -credential_type="HostNormal"

Example 2

emcli create_siteguard_credential_association
      -system_name="austin-system"
      -target_name="austin-database-instance"
      -credential_type="HostNormal"

See Also

create_siteguard_credential_association

update_siteguard_credential_association


get_siteguard_script_hosts

Lists the host or hosts associated with any script where the script is designated to run.

Format

emcli get_siteguard_script_hosts
      [-script_id=<script_id>]

[ ] indicates that the parameter is optional

Parameters

  • script_id

    ID associated with the script.

Output Columns

Host Name

Examples

emcli get_siteguard_script_hosts
      -script_id="10"

See Also

create_siteguard_script

add_siteguard_script_hosts


get_siteguard_scripts

Obtains the Site Guard scripts associated with the specified system.

Format

emcli get_siteguard_scripts
      -system_name=<system_name>
      -operation=<operation_name>
      [-script_type=<type_of_script>]
      [-role=<role_of_system>]

Parameters

  • system_name

    Name of the system.

  • operation

    Name of the operation, such as switchover, failover, start, or stop.

  • script_type

    Type of the script. For example: mount, unmount, pre-script, post-script, failover, or switchover.

  • role

    Filters the scripts based on the role associated with the system. For example: Primary or Standby.

Output Columns

Script, ID, Type, Operation, Path, Role

Examples

Example 1

emcli get_siteguard_scripts
      -system_name="BISystem1"
      -operation="Switchover"
      -script_type="Pre-Script"

Example 2

emcli get_siteguard_scripts
      -system_name="austin-system"
      -operation="Switchover"
      -script_type="Pre-Script"
      -role="Primary"

See Also

create_siteguard_script

delete_siteguard_scripts


get_supported_platforms

Lists the platforms for which the Management Agent software is available on the OMS host.

Format

emcli get_supported_platforms

Output

The output of the command appears like the following example:

--------------------------
Platform Name : Linux x86
--------------------------

get_supported_privileges

Gets the list of available privileges in Enterprise Manager based on the type specified.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • type

    Type of privileges to retrieve from Enterprise Manager. Possible values are:

    • ALL (default value)

    • SYSTEM

    • TARGET

    • JOB

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Privilege Name, Privilege Type, Resource Class, Resource GUID Column, Resource ID Columns


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

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name of the system.

  • type

    System type: generic_system. Defaults to generic_system.

  • depth

    Lists target members in sub-systems to the specified depth. When the depth is set to 0, no system target members are listed, and only the system's existence is verified. When the depth is set to -1, all system and sub-system target members are listed.

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script". In interactive and script mode, the value must be True or False.

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

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"

Parameters

  • target_type

    Target type for which you want to list user-defined property names.

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.

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

[ ] indicates that the parameter is optional

Scripting and Interactive Format

get_targets
      [(targets="[name1:]type1;[name2:]type2;..."]
      [,alerts=True|False]
      [,noheader=True|False]
      [,script=True|False | ,format=
                 [name:<pretty|script|csv>];
                 [column_separator:"column_sep_string"];
                 [row_separator:"row_sep_string"];
      ])

[ ] indicates that the parameter is optional

Parameters

  • targets=name:type

    Name or type can be either a full value or a pattern match using %. Also, name is optional, so the type can be specified alone.

  • alerts

    Shows the count of critical and warning alerts for each target. In scripting and interactive mode, the value needs to be set to either True or False.

  • noheader

    Display tabular output without column headers. In scripting and interactive mode, the value needs to be set to either True or False.

  • script

    This is equivalent to -format="name:script". In scripting and interactive mode, the value needs to be set to either True or False.

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

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

Examples

The following examples show all targets. Critical and Warning columns are not included.

Example 1 - Comand-Line

emcli get_targets

Example 2 - Scripting and Interactive

get_targets()

The following examples show all targets. Critical and Warning columns are shown.

Example 3 - Command-Line

emcli get_targets
      -alerts

Example 4 - Scripting and Interactive

get_targets
      (alerts=True)

The following examples show all oracle_database targets.

Example 5 - Command-Line

emcli get_targets
      -targets="oracle_database"

Example 6 - Scripting and Interactive

get_targets
      (targets="oracle_database")

The following examples show all targets whose type contains the string oracle.

Example 7 - Command-Line

emcli get_targets
      -targets="%oracle%"

Example 8 - Scripting and Interactive

get_targets
      (targets="%oracle%")

The following examples show all targets whose name starts with databa and type contains oracle.

Example 9 - Command-Line

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

Example 10 - Scripting and Interactive

get_targets
      (targets="databa%:%oracle%")

The following examples show status and alert information on the Oracle database named database3.

Example 11 - Command-Line

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

Example 12 - Scripting and Interactive

get_targets
      (targets="database3:oracle_database"
      ,alerts=True)

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name.

  • type

    Target type.

  • testname

    Test name.

  • testtype

    Test type.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

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

get_threshold

Obtains threshold information for a given target and metric.

Format

emcli get_threshold      -target_name="tname"      -target_type="ttype"      [-metric="metric_group"]

[ ] indicates that the parameter is optional

Parameters

  • target_name

    Name of the target associated with the threshold.

  • target_type

    Type of target associated with the threshold.

  • metric

    Metric group associated with the threshold. The default without this option is to show the threshold of all metrics.

Examples

Example 1

The following example gets the threshold data for the Load category on the host myhost.example.com.

emcli get_threshold
          -target_name="myhost.example.com"
          -target_type="host"
          -metric="Load"

Example 2

The following example gets the DiskActivitybusy threshold for the Disk Activity on the host myhost.oracle.com.

emcli get_threshold
          -target_name="myhost.oracle.com"
          -target_type="host"
          -metric="DiskActivity"

get_unsync_alerts

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

Format

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

Parameters

  • target_type

    Internal target type identifier, such as host, oracle_database, emrep, and so forth.

  • target_name

    Name of the target.

Output Column

Status

Examples

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

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

get_unused_metric_extensions

Gets a list of metric extensions deployed to Agents, but not attached to any targets.

Format

 emcli get_unused_metric_extensions

Parameters

None.


get_update_status

Gets the latest status of an update.

Format

emcli get_update_status 
        -id="internal id" 

Parameters

  • id

    Internal identification for the update.

Examples

The following example displays the latest update status.

emcli get_update_status 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 

get_upgradable_agents

Shows upgradable Agents. If you do not specify any options, the command shows all upgradable Agents. If you specify more than one option, the command shows the union of upgradable Agents belonging to each option specified.

Format

emcli get_upgradable_agents 
      [-agents="full_agent_name"]
      [-platforms="list_of_platforms"]
      [-versions="list_of_versions"]
      [-groups="list_of_group_names"]
      [-output_file="output_file_location"]

[ ] indicates that the parameter is optional

Parameters

  • agents

    Lists upgradable Agents matching Agent names or an Agent names pattern.

  • platforms

    Lists upgradable Agents on the specified platforms.

  • versions

    Lists upgradable Agents with the specified version.

  • groups

    Lists upgradable Agents belonging to the specified groups.

  • output_file

    Lists upgradable Agents and adds them to the specified file.

Examples

Example 1

The following example lists upgradable Agents matching the pattern abc% and xyz.domain.com agent.

emcli get_upgradable_agents -agents="abc%,xyz.domain.com:1243"

Example 2

The following example lists upgradable Agents on the platforms Linux x86 and Microsoft Windows x64 (64-bit).

emcli get_upgradable_agents -platforms="Linux x86,Microsoft Windows x64 (64-bit)"

Example 3

The following example lists upgradable Agents with version 12.1.0.1.0 and 12.1.0.2.0

emcli get_upgradable_agents -versions="12.1.0.1.0,12.1.0.2.0"

Example 4

The following example lists upgradable Agents belonging to groups GROUP1 and GRP2.

emcli get_upgradable_agents -groups="GROUP1,GRP2"

Example 5

The following example lists upgradable Agents and adds them to the file /scratch/agents_file.txt.

emcli get_upgradable_agents -output_file="/scratch/agents_file.txt"

grant_bipublisher_roles

Grants roles for accessing the BI Publisher catalog.

Format

emcli grant_bipublisher_roles
    (-roles="role1[;role2;...role_n]" 
    [-users="user"] 
    [-external_role="grantee_group"]) 
     
[ ] indicates that the parameter is optional

Parameters

  • roles

    Grants one or more roles to BI Publisher. Specify one or more roles separated by a semicolon.

  • users

    Users to receive the granted role.

  • external_role

    Group to assign the role.

Examples

Example 1

The following example grants one role to a group.

emcli grant_bipublisher_roles -roles="EMBIPViewer" -external_role="TESTGROUPNAME"

Example 2

The following example grants more than one role to a group.

emcli grant_bipublisher_roles -roles="EMBIPViewer;EMBIPAuthor" 
      -external_role="TESTGROUPNAME"

Example 3

The following example grants one role to a user.

emcli grant_bipublisher_roles -roles="EMBIPViewer" 
      -users="TESTUSERNAME"

Example 4

The following example grants one role to multiple users.

emcli grant_bipublisher_roles -roles="EMBIPViewer" 
      -users="TESTUSERNAME;TESTUSERNAME2" 

Example 5

The following example grants more than one role to multiple users and a group.

emcli grant_bipublisher_roles -roles="EMBIPViewer;EMBIPAuthor" 
      -external_role="TESTGROUPNAME" 
      -users="TESTUSERNAME;TESTUSERNAME2

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]
     
[ ] indicates that the parameter is optional

Parameters

  • type

    Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".

  • targets

    Targets should be specified in the following sequence:

    TargetName1;TargetName2;
    

    For example:

    -targets="database1;database2;database3;"
    

    The semi-colon ( ; ) is the target separator.

    See the "Examples" section below for information about providing arguments for the targets .

  • packs

    License packs should be specified in the following sequence:

    pack1;pack2;
    

    For example:

    -packs="db_diag;db_config;"
    

    The semi-colon ( ; ) is the pack separator.

    See the "Examples" section below for information about providing arguments for the packs .

  • file

    Specify the file name, including the complete path. For example:

    -file="/usr/admin1/db_license.txt"
    

    The file should contain the list of targets and packs according to the following cases:

    • If you only need to provide a list of targets, use the following format:

      targets=database1;database2;database3;
      
    • If you only need to provide a list of packs, use the following format:

      packs=db_diag;db_config;
      
    • If you need to provide a list of both targets and packs, use the following format:

      targets=database1;database2;database3;packs=db_diag;db_config;
      
  • displayAllMessages

    Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the command line.

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]

[ ] indicates that the parameter is optional

Parameters

  • type

    Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".

  • targets

    Targets should be specified in the following sequence:

    TargetName1;TargetName2;
    

    For example:

    -targets="database1;database2;database3;"
    

    The semi-colon ( ; ) is the target separator.

    See the "Examples" section below for information about providing arguments for the targets .

  • packs

    License packs should be specified in the following sequence:

    pack1;pack2;
    

    For example:

    -packs="db_diag;db_config;"
    

    The semi-colon ( ; ) is the pack separator.

    See the "Examples" section below for information about providing arguments for the packs .

  • file

    Specify the file name, including the complete path. For example:

    -file="/usr/admin1/db_license.txt"
    

    The file should contain the list of targets and packs according to the following cases:

    • If you only need to provide a list of targets, use the following format:

      targets=database1;database2;database3;
      
    • If you only need to provide a list of packs, use the following format:

      packs=db_diag;db_config;
      
    • If you need to provide a list of both targets and packs, use the following format:

       targets=database1;database2;database3; packs=db_diag;db_config;
      
  • displayAllMessages

    Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the cmd line.

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"
        -privilege="name[;secure_resource_details]"
        [-grant_all_targets_on_host="yes|no"]
        [-separator=privilege="sep_string"]
        [-subseparator=privilege="subsep_string"]

[ ] indicates that the parameter is optional

Parameters

  • name

    User name or role name to which privileges will be assigned.

  • privilege

    Privilege to be granted to the Enterprise Manager user or role. You can specify this parameter more than once.

    Specify secure_resource_details as:

    resource_guid|[resource_column_name1=resource_column_value1
    [:resource_column_name2=resource_column_value2]..]"
    

    Optionally, you can drop resource column names from this parameter if you provide resource information in the order described by emcli get_supported_privileges. See the "See Also" section below for more information.

  • grant_all_targets_on_host

    Indicates if the privilege needs to be granted on all targets of the host specified as part of the privilege parameter. The default value is no.

  • separator=privilege

    Specify a string delimiter to use between name-value pairs for the value of the -privilege option. The default separator delimiter is a semi-colon ( ; ).

  • subseparator=privilege

    Specify a string delimiter to use between the name and value in each name-value pair for the value of the -privilege option. The default subseparator delimiter is a colon ( : ).

Examples

Example 1

The following example grants these privileges to user1:

  • Privilege to use any beacon

  • Full control of the jobs with ID 923470234ABCDFE23018494753091111

  • Full control on the target host1.example.com:host

  • Full control on the credential cred1:user2

  • View Privilege on target with ID 123451234ABCDFE23018494753092222

emcli grant_privs
      -name="user1"
      -privilege="USE_ANY_BEACON"
      -privilege="FULL_JOB;923470234ABCDFE23018494753091111"
      -privilege="FULL_TARGET;TARGET_NAME=host1.example.com:TARGET_TYPE=host"
      -privilege="FULL_CREDENTIAL;CRED_NAME=cred1:CRED_OWNER=user2"
      -privilege="FULL_CREDENTIAL;CRED_GUID=123451234ABCDFE23018494753092222"

Example 2

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

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

Example 3

The following example grants FULL_TARGET privilege on all targets on host host1.example.com to user1.

emcli grant_privs
      -name="user1"
      -privilege="FULL_TARGET;TARGET_NAME=host1.exemple.com:TARGET_TYPE=host"
      -grant_all_targets_on_host="yes"

Example 4

The following example uses the separator and subseparator parameters to grant FULL_TARGET privilege on host1.us.oracle.com to user1.

emcli grant_privs
      -name="user1"
      -privilege="FULL_TARGET->TARGET_NAME=host1.us.oracle.com@@TARGET_TYPE=host"
      -separator=privilege="->"
      -subseparator=privilege="@@"

See Also

To see the complete list of privileges and resource column names, execute the following command:

emcli get_supported_privileges

To see the list of SYSTEM privileges, which do require resource information:

emcli get_supported_privileges -type=SYSTEM

To see the list of TARGET privileges:

emcli get_supported_privileges -type=TARGET

To see the list of JOB privileges:

emcli get_supported_privileges -type=JOB

grant_roles

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

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    User name or role name to which roles will be assigned.

  • roles

    Roles that will be granted to an Enterprise Manager user or role. You can specify this option more than once.

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]

[ ] indicates that the parameter is optional

Parameters

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. An instance cannot be ignored when it completes, completes with an error, is suspended, or is stopped.

Format

emcli ignore_instance 
      -instance=<instance_guid> 
      [exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>] 
      [-stateguid=<state_guid>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    Instance GUID.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

  • stateguid

    Comma-separated list of state GUIDs.

Example

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

import_appreplay_workload

Imports a workload metadata XML file and creates a new application replay workload object. A Workload metadata XML file, which is stored in the workload root directory, is automatically generated as part of the workload capture process. The XML file contains a pointer to the actual raw captured workload data files. If you are importing a workload captured by one Enterprise Manager system to another, make sure the workload storage location specified in the XML file is reachable and contains the workload data files.

Format

emcli  import_appreplay_workload
        -input_file=template:<input_filename>

[ ] indicates that the parameter is optional

Parameters

  • input_file

    Fully-qualified path to a workload metadata XML file. The workload XML file is automatically created during capture. However, you may need to make necessary changes to the XML file before you import. For example, you may want to change the workload name in the exported file and rename the XML file to match the workload name. You may also need to modify the storage locations to point to where the workload data files are located if you have moved the captured data files.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".


import_compliance_object

Imports a compliance object into the repository.

Format

 import_compliance_object
      -files=file1;file2;...  [-overwrite] [-deep]

[ ] indicates that the parameter is optional

Parameters

  • files

    Files to be imported.

  • overwrite

  • deep

Examples

emcli import_compliance_object
       -files=file1.xml;file2.xml -overwrite

import_masking_definition

Imports a masking definition from the specified XML file.

Format

emcli import_masking_definition
     -file=/tmp/file_name.xml

Parameters

  • file

    Path of the file containing the masking definition in XML format.

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_metric_extension

Imports a metric extension archive file.

Format

emcli import_metric_extension
        -file_name=<metric_extension_archive>
        -rename_as=<metric_extension_to_import_as>

Parameters

  • file_name

    Name of the metric extension archive file to be imported.

  • rename_as

    Imports the metric extension using the specified name, replacing the name given in the archive.

Examples

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

emcli import_metric_extension 
      -file_name=<file name> 
      -rename_as=<metric extension name>

import_report

Imports one or more Information Publisher report definitions from an XML file(s) using the title in the XML file and the currently logged-in CLI user as the owner of the report. If the report/owner already exists, the operation fails for this report with an accompanying error message. (You can override this with the -force option.) The report will be changed to a just-in-time report with the target type from the exported report.

You will need to edit schedules and access privileges using the Enterprise Manager user interface. The system enforces title/owner uniqueness, so an error occurs if a report with the same title and owner already exists.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • files

    List of path/file name(s) of XML file(s) that contain valid report definition(s).

  • force

    First delete the report (and all jobs and saved copies) if a report with the same title/owner exists.

Examples

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

import_sla

Imports an SLA configuration XML file for a target. This verb provides the functionality of creating a new SLA, creating a new version, and creating a new copy.

Note:

The XML file can only contain one SLA to be imported; that is, when export_sla has successfully exported a file when slaName and version are specified.

Note:

The target must have the metrics required by the SLA template's SLI. If the template's SLI calls for a metric not found in the target, the SLI cannot be created.

Format

emcli import_sla
      -targetName=<target name>
      -targetType=<target type>
      -input_file=slaTemplate:<input filename>
      [-slaName=<SLA name>]

[ ] indicates that the parameter is optional

Parameters

  • targetName

    Name of the target.

  • targetType

    Type of target.

  • input_file

    Name of the input file. There can only be one SLA root node in the XML document.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • slaName

    Specifying this name overrides the name contained in the SLA template XML file. This effectively creates a new SLA version series starting with version 1.

Examples

The following example creates an SLA named 'gold_sla' for the target my_service (generic_service).

    emcli import_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla' -input_file=slaTemplate:'service_sla.xml'

import_template

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

Format

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

Parameters

  • files

    Path/file name of an XML file, which contains a valid template definition. You can specify multiple files with this option by separating each file with a semi-colon ( ; ).

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"

Example 3

The following example imports a template from the template.zip file along with any metric extensions.

emcli import_template -files="template.zip"

import_update

Imports a Self Update archive file into Enterprise Manager. Upon successful import, the update is displayed on the Self Update Home in downloaded status for further action.

Format

emcli import_update
        -file="file"
        -omslocal
emcli import_update
        -file="file"
        -host="hostname"
        [-credential_set_name="setname"] | -credential_name="name"         -credential_owner="owner"

[ ] indicates that the parameter is optional

Parameters

  • file

    Complete path name of the update archive file.

  • omslocal

    Flag specifying that the file is accessible from the OMS.

  • host

    Target name for a host target where the file is available.

  • credential_set_name

    Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set

  • credential_name

    Name of a named credential stored in the repository. You must specify this along with the credential_owner .

  • credential_owner

    Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.

Examples

Example 1

The following example imports the file update1.zip. The file must be present on the OMS host. In a multiple OMS setup, any OMS can process the request, so the file should be accessible from the OMS processing the request. This usually means that the file must be kept on a shared location accessible from all OMSes.

emcli import_update 
        -file="/u01/common/update1.zip" 
        -omslocal 

Example 2

The following example imports the file update1.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to retrieve the remote file.

emcli import_update 
        -file="/u01/common/update1.zip" 
        -host="host1.example.com" 
        -credential_set_name="HostCredsNormal"

Example 3

The following example imports the file update1.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to retrieve the remote file.

emcli import_update 
        -file="/u01/common/update1.zip" 
        -host="host1.example.com" 
        -credential_name="host1_creds" 
        -credential_owner="admin1"

import_update_catalog

Imports a Self Update master catalog file when Enterprise Manager is configured in offline mode. All updates present in the catalog are processed, and the applicable updates are displayed on the Self Update Home for further action.

Format

emcli import_update_catalog 
        -file="file" 
        -omslocal 
        -file="file" 
        -host="hostname" 
        [-credential_set_name="setname"] | -credential_name="name"           -credential_owner="owner"

[ ] indicates that the parameter is optional

Parameters

  • file

    Complete path name of the self update catalog file.

  • omslocal

    Flag specifying that the file is accessible from the OMS.

  • host

    Target name for a host target where the file is available.

  • credential_set_name

    Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set

  • credential_name

    Name of a named credential stored in the repository. You must specify this along with the credential_owner option.

  • credential_owner

    Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.

Examples

Example 1

The following example imports the master catalog file p9984818_121000_Generic.zip. The file must be present on the OMS host. In a multiple OMS setup, the request can be processed by any OMS, so the file should be accessible from the OMS processing the request. This usually means that the file must be kept on a shared location accessible from all OMSes.

emcli import_update_catalog 
        -file="/u01/common/p9984818_121000_Generic.zip" 
        -omslocal

Example 2

The following example imports the master catalog file p9984818_121000_Generic.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to retrieve the remote file.

emcli import_update_catalog 
        -file="/u01/common/p9984818_121000_Generic.zip" 
        -host="host1.example.com" 
        -credential_set_name="HostCredsNormal"

Example 3

The following example imports the master catalog file p9984818_121000_Generic.zip that is present on the host host1.example.com. The host must be a managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to retrieve the remote file.

emcli import_update_catalog 
        -file="/u01/common/p9984818_121000_Generic.zip" 
        -host="host1.example.com" 
        -credential_name="host1_creds" 
        -credential_owner="admin1" 

list

Lists resource data. The maximum number of rows displayed is controlled by OMS property oracle.sysman.core.dataservice.max_fetch_rows. When the property is not set, it uses the default value of 2000.

Format

emcli list
        [-help]
        [-resource="list_resource_name"]
        [-columns="column_options"]
        [-colsize="column_sizes"]
        [-search="search_options"]
        [-bind="bind_parameters"]
        [-sql="sql"]
        [-script | -format=
                    [name:<pretty|script|csv>];
                    [column_separator:"column_sep_string"];
                    [row_separator:"row_sep_string"];
        ]
        [-noheader]

[ ] indicates that the parameter is optional

Parameters

  • help

    Lists all resource names with their descriptions. You can use this option with the -resource option to see more details about the resource.

  • resource

    Resource name for which data is displayed.

  • columns

    Specify columns as shown, separated by commas:

    -columns="colname,colname,colname"
    

    Example:

    -columns="COL1,COL3,COL5"
    

    Specify column size and width as shown below. A colon precedes the size for a given column.

    -columns="colname:colsize,colname,colname"
    

    Example:

    -columns="COL1:30,COL3,COL5"
    
  • colsize

    Resizes column widths. Most resource columns have some default widths. You can override them with this option.Example: -colsize="col1:30,col2:5"

  • search

    You can specify multiple search options. The usage is -search="ColumnName Operator 'Value'. The search value must be enclosed in quotes unless searching for null or not null.

    The following operators are supported:

    = !+ > < >= <= like

    The option also supports is null and is not null.

  • bind

    Use for resources that require specific input. The usage is -bind="Name Operator Value".

  • sql

    Specifies arbitrary SQL against views. This query is executed as MGMT_VIEW user.

  • script

    Sets the default column separator to a tab and the default row separator to a newline. You can change the column and row separator strings to change these defaults.

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

  • noheader

    Displays tabular output without column headers.

Output

When run in script mode, returns JSON output that can be easily parsed.

Exit Codes:

  • 0 — Appears when successful.

  • 1 — Appears when the list service fails to process the request.

Examples

The following examples list all resource names.

Example 1 - Command-Line

emcli list -help

Example 2 - Scripting and Interactive

list (help)

The following examples list column information about the 'Administrators' resources. They also list which columns users can search.

Example 3 - Command-Line

emcli list 
      -help
      -resource=Administrators

Example 4 - Scripting and Interactive

list 
     (help
     ,resource=Administrators)

The following examples list all data for the 'Administrators' resource.

Example 5 - Command-Line

emcli list -resource=Administrators

Example 6 - Scripting and Interactive

list (resource=Administrators)

The following examples list only user_name and user_type columns.

Example 7 - Command-Line

emcli list 
      -resource=Administrators 
      -columns="USER_NAME,USER_TYPE"

Example 8 - Scripting and Interactive

list 
      (resource=Administrators 
      ,columns="USER_NAME,USER_TYPE")

The following examples show details about SYSMAN users.

Example 9 - Command-Line

emcli list 
      -resource=Administrators 
      -columns="USER_NAME,USER_TYPE"
      -search="USER_NAME = 'SYSMAN'"

Example 10 - Scripting and Interactive

list 
      (resource=Administrators 
      ,columns="USER_NAME,USER_TYPE"
      ,search="USER_NAME = 'SYSMAN'")

list_active_sessions

Lists active sessions on all OMSes in the environment. By default, the verb prints a summary for each OMS.

Format

emcli list_active_sessions
        [-details 
        [-table] 
        [-script] 
        [-format=name:value;name:value] 
        [-noheader]]

[ ] indicates that the parameter is optional

Parameters

  • details

    Displays active user sessions on each OMS. The output format is non-tabular.

  • table

    Prints details in table format.

  • script

    Prints output that can be processed by script.

  • format

    Supports the following name/value pairs:csv — Output will be comma-separated script — Output will be in a format that can be processed by script. You can also specify row_separator and column_separator.

  • noheader

    Skips the header.

Examples

emcli list_active_sessions
    emcli list_active_sessions -details
    emcli list_active_sessions -details -table
    emcli list_active_sessions -details -table -script
    emcli list_active_sessions -details -table -script -noheader
    emcli list_active_sessions -details -table -format="name:csv"
    emcli list_active_sessions -details -table -format="name:script;row_separator:@@;column_separator:!"

list_add_host_platforms

Lists the platforms on which the Add Host operation can be performed.

Format

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

[ ] denotes that the parameter is optional

Parameters

  • all

    Displays all of the platforms, including those for which the Agent software is not available.

  • noheader

    Displays tabular output without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Platform ID, Platform Name

Examples

Example 1

The following example displays the platforms for which the agent software is available so that the Add Host operation can be performed.

emcli list_add_host_platforms

Example 2

The following example displays all of the platforms, including those for which the Agent software is not available.

emcli list_add_host_platforms -all

list_add_host_sessions

Lists all of the Add Host sessions.

Format

emcli list_add_host_sessions
        [-host_name="Host name"]
        [-session_name="Session name"]
        [-match_all]
        [-noheader]
        [-script | -format=
                    [name:<pretty|script|csv>];
                    [column_separator:"column_sep_string"];
                    [row_separator:"row_sep_string"];
        ]

[ ] denotes that the parameter is optional

Parameters

  • host_name

    Displays all of the Add Host sessions that the provided host is a part of.

  • session_name

    Displays all of the sessions that match the session name provided.

  • match_all

    Displays results that match all of the provided query criteria. By default, the results that match any of the provided query criteria are displayed.

  • noheader

    Displays tabular output without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Session Name, Deployment Type, Host, Initialization, Remote Prerequisite, Agent Deployment

Examples

Example 1

The following example displays all of the Add Host sessions.

emcli list_add_host_sessions

Example 2

The following example displays all of the Add Host sessions that the host 'example.com' was part of.

emcli list_add_host_sessions -host_name=example.com 

Example 3

The following example displays all of the Add Host sessions whose session name contains the string 'Jan_1'.

emcli list_add_host_sessions -session_name=Jan_1

Example 4

The following example displays all of the Add Host sessions that the host 'example.com' was part of, OR whose session name contains the string 'Dec_25'.

emcli list_add_host_sessions -host_name=example.com -session_name=Dec_25

Example 5

The following example displays all of the Add Host sessions that the host 'example.com' was part of, AND whose session name contains the string 'Jan_15'.

emcli list_add_host_sessions -host_name=example.com -session_name=Jan_15 -match_all

list_aru_languages

Lists ARU language information.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Language name.

  • id

    Language ID.

  • noheader

    Displays tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli list_aru_languages 
      emcli list_aru_languages -noheader 
      emcli list_aru_languages -name="language name" -format="name:pretty" 
      emcli list_aru_languages -id="language id" -format="name:script" 

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

list_aru_platforms

Lists ARU platform information.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Platform name.

  • id

    Platform ID.

  • noheader

    Displays tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli list_aru_platforms
      emcli list_aru_platforms -noheader 
      emcli list_aru_platforms -name="platform_name" -format="name:pretty" 
      emcli list_aru_platforms -id="platform id" -noheader -format="name:script"

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

list_aru_products

Lists ARU product information.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Product name.

  • id

    Product ID.

  • noheader

    Displays tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli list_aru_products 
      emcli list_aru_products -id="product id" 
      emcli list_aru_products -name="product name" 
      emcli list_aru_products -id="product id" -noheader 
      emcli list_aru_products -id="product id" -noheader -script 
      emcli list_aru_products -id="product id" -noheader  -format="name:pretty" 

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_releases
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

list_aru_releases

Lists ARU release information.

Format

emcli list_aru_releases 
        [-name="release_name" | -id="release_id" | -productId="product_id"] 
        [-noheader] 
        [-script | -format=
                           [name:<pretty|script|csv>];
                           [column_separator:"column_sep_string"]; 
                           [row_separator:"row_sep_string"]; 
        ] 

[ ] indicates that the parameter is optional

Parameters

  • name

    Release name.

  • id

    Release ID.

  • productId

    Product ID.

  • noheader

    Displays tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli list_aru_releases 
      emcli list_aru_releases -noheader 
      emcli list_aru_releases -name="release_name" -format="name:pretty" 
      emcli list_aru_releases -id="release id" -format="name:script" 
      emcli list_aru_releases -productId="product id" -noheader -format="name:csv" 

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_patch_plans
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

list_chargeback_entities

List all of the entities added into Chargeback

Format

list_chargeback_entities

See Also


add_chargeback_entity
assign_charge_plan
assign_cost_center
list_chargeback_entity_types
list_charge_plans
list_cost_centers
remove_chargeback_entity
unassign_charge_plan
unassign_cost_center

list_chargeback_entity_types

Lists all of the entity types supported by Chargeback.

Format

list_chargeback_entity_types     -[usage_mode]     -[entity_type="eType"] 

[ ] indicates that the parameter is optional

Parameters

  • usage_mode

    Lists all of the entity types supported by Chargeback and the corresponding usage modes.

  • entity_type

    Lists all of the usage modes supported for the particular entity type "eType".

Examples

Example 1

The following example lists all of the entity types supported by Chargeback.

list_chargeback_entity_types

Output:

Entity Type--------------------Entity Type Display Name 
-------------------------------------------------------------------- 
1. oracle_database--------Database Instance 
2. host-------------------------Host 

Example 2

The following example lists all of the entity types supported by Chargeback and the corresponding usage modes.

list_chargeback_entity_types -usage_mode 

Output:

Entity Type----------------Entity Type Display Name--------------------Usage Mode 
---------------------------------------------------------------------- 
1. oracle_database-------------------Database Instance-----------------------dbMetered 
2. oracle_database-------------------Database Instance-----------------------dbByService 
3. oracle_database-------------------Database Instance-----------------------cdbBypdb 
4. host---------------------------------Host---------------------------hostMetered 

Example 3

The following example lists all of the usage modes supported for the particular entity type.

list_chargeback_entity_types -entity_type="oracle_database"

Output:

Entity Type-------------------Entity Type Display Name-----------------Usage Mode 
---------------------------------------------------------------------------------- 
1. oracle_database----------Database Instance-------------------------dbMetered 
2. oracle_database----------Database Instance-------------------------dbByService 
3. oracle_database----------Database Instance-------------------------cdbBypdb 

See Also


add_chargeback_entity
assign_charge_plan
assign_cost_center
list_chargeback_entities
list_charge_plans
list_cost_centers
remove_chargeback_entity
unassign_charge_plan
unassign_cost_center

list_charge_plans

Lists the charge plans in Chargeback.

Format

list_charge_plans 
     [[-entity_type="entity_type" [-all]] 
     [-charge_plan="charge_plan_name" [-all]] 
     [-all] 

[ ] indicates that the parameter is optional

Parameters

  • entity_type

    Entity type for which the charge plans are to be listed.

  • charge_plan

    Lists details about a specific charge plan.

  • all

    Lists all active and future plans.

Examples

Example 1

The following example lists all of the charge plans in Chargeback.

list_charge_plans

Example 2

The following example lists all of the active and future charge plans in Chargeback.

list_charge_plans -all

Example 3

The following example lists all of the active charge plans that support the "eType" entity type.

list_charge_plans -entity_type="eType" 

Example 4

The following example lists all of the active and future charge plans that support the "eType" entity type.

list_charge_plans -entity_type="eType" -all 

Example 5

The following example provides details about the active version of the charge plan.

list_charge_plans -charge_plan="chargePlanName" 

Example 6

The following example provides details about the active and future versions of the charge plan.

list_charge_plans -charge_plan="chargePlanName" -all 

See Also


add_chargeback_entity
assign_charge_plan
assign_cost_center
list_chargeback_entities
list_chargeback_entity_types
list_cost_centers
remove_chargeback_entity
unassign_charge_plan
unassign_cost_center

list_cost_centers

Lists the cost centers in various formats depending on the options given.

Format

list_cost_centers 
     -[[cost_center_name="cName"] 
     -[parent] 
     -[children] 
     -[top] 
     -[leaf]] 

[ ] indicates that the parameter is optional

Parameters

  • cost_center_name

    Name of the cost center for which further details like parent/children/top/leaf should be listed.

  • parent

    Provides the parent cost center of the given cost center.

  • children

    Provides the list of child cost centers of the given cost center.

  • top

    Provides the hierarchy of the given cost center from the top.

  • leaf

    Provides the leaf nodes of the given cost center.

Examples

Example 1

The following example lists all of the cost centers.

list_cost_centers

Example 2

The following example provides the parent of the given cost centers.

list_cost_centers -cost_center_name="c11" -parent

Output:

Parent Node 
----------------- 
c1 

Example 3

The following example provides a list of all the child cost centers of the given cost center

list_cost_centers -cost_center_name="c1" -children 

Output:

Children Nodes 
--------------------- 
c11 
c12 

Example 4

The following example provides the top hierarchy of the given cost center.

list_cost_centers -cost_center_name="c111" -top 

Output:

Hierarchy 
------------- 
[c1]----->[c11]----->[c111] 

Example 5

The following example provides the leaf nodes of the given cost center.

list_cost_centers -cost_center_name="c1" -leaf 

Output:

Leaf Nodes 
--------------- 
c111 
c112 
c12 

See Also


add_chargeback_entity
assign_charge_plan
assign_cost_center
list_chargeback_entities
list_chargeback_entity_types
list_charge_plans
remove_chargeback_entity
unassign_charge_plan
unassign_cost_center

list_diagcheck_exclusions

Gets the list of diagnostic check exclusions defined for a target type.

Format

emcli list_diagcheck_exclusions
        -target_type="type"

Parameters

  • target_type

    Type of target.


list_diagchecks

Gets the list of diagnostic check exclusions defined for a target type.

Format

emcli list_diagchecks
        -target_type="type"
        [-version="<diag_version>" ]

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Type of target.

  • version

    Diagnostic version. Defaults to the latest version.


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>]
     [-adm_name=<application_data_model_filter>]
     [-target_type=<target_type_filter>]
     [-target_name=<target_name_filter>]
     [-string_match]
     [-script | -format=[name:<pretty|script|csv>];
                        [column_separator:"column_sep_string"];
                        [row_separator:"row_sep_string"];
     ]
     [-noheader]

[ ] indicates that the parameter is optional

Parameters

  • definition_name

    Masking definition name filter. This can be either a full value or a pattern match (%).

  • adm_name

    Application Data Model (ADM) name. This can be either a full value or a pattern match (%).

  • target_type

    Database target type. This can be either 'oracle_database' or 'rac_database'.

  • target_name

    Database target name. This can be either a full value or a pattern match (%).

  • string_match

    Uses an exact string match for a target_name and definition_name match.

  • script

    This option is equivalent to -format='name: script' .

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

  • noheader

    Suppresses printing of column headers.

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_named_credentials

Lists the named credentials. You can list the credentials you own or have explicit access to.

Format

emcli list_named_credentials
      [-cred_name="cred_name"] 
      [-cred_owner="cred_owner"] 
      [-script | -format=[name:<pretty|script|csv>]; 
                         [column_separator:column_sep_string]; 
                         [row_separator:row_sep_string];
      [-separator="separator:attname:charseq"] 
      [-noheader] 

[ ] indicates that the parameter is optional

Parameters

  • cred_name

    Credential name to filter the list of credentials displayed.

  • cred_owner

    Credential owner to filter the list of credentials displayed.

  • script

    This is equivalent to -format='name: script'.

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

  • separator

    Multi-value attributes use the semi-colon character as the separator. When data contains this character, you can override its value. For example:

    separator="<attributename=sep_char"
    

    ... where 'attributename' is the name of the attribute for which you want to override the separator character, and 'sepchar' is the new separator character. For example:

    separator="att=#"
    
  • noheader

    Suppresses printing of column headers in tabular output.

Exit Codes

0 if successful. A non-zero value means that verb processing was unsuccessful.

Examples

The following example lists credentials matching credential names containing 'NC'.

emcli list_named_credentials -cred_name="NC" 

list_oms_config_properties

Lists the OMS configuration properties.

Format

emcli list_oms_config_properties 
        [-oms_name="omsName"]
        [-details]

[ ] indicates that the parameter is optional

Parameters

  • oms_name

    Name of the OMS from where the properties have to be retrieved.

  • details

    Displays the details about from where the property value has been derived, and also the global and default values for the property.

Examples

Example 1

The following example lists the entire set of properties.

list_oms_config_properties 

Example 2

The following example lists all the properties set on the management server myhost:1159_Management_Service.

list_oms_config_properties -oms_name="myhost:1159_Management_Service"

list_oms_logging_properties

Lists the logging configuration properties.

Format

emcli list_oms_logging_properties 
        [-oms_name="omsName"]
        [-details]

[ ] indicates that the parameter is optional

Parameters

  • oms_name

    Name of the OMS from where the logging properties have to be retrieved.

  • details

    Displays the details about from where the property value has been derived, and also the global and default values for the logging property.

Examples

Example 1

The following example lists the entire set of logging properties.

list_oms_logging_properties 

Example 2

The following example lists all the logging properties set on the management server myhost:1159_Management_Service.

list_oms_logging_properties -oms_name="myhost:1159_Management_Service"

list_patch_plans

Lists existing patch plans. You can list all the existing patch plans and can also list the existing patch plans whose names match the specified pattern.

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Plan name used for searching patch plans. If you do not specify this parameter, the patch plan whose name is the same as the specified name, or contains the specified name string, will be listed. If you do not specify this option, all of the existing patch plans are listed.

  • noheader

    Suppresses printing of column headers.

  • script

    This option is equivalent to -format='name: script' .

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli list_patch_plans 
      emcli list_patch_plans -name="plan name" -noheader  
      emcli list_patch_plans -name="plan name" -noheader -script  
      emcli list_patch_plans -name="plan name" -noheader -format="name:pretty" 
      emcli list_patch_plans -name="plan name" -noheader       -format="name:pretty";column_separator="separator" 

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
search_patches
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

list_plugins_on_agent

Lists all of the plug-ins deployed on the management Agents.

Format

emcli list_plugins_on_agent 
           [-agent_names="agent1,agent2,agent3 " 
           [-all] 
           [-include_discovery] 

[ ] indicates that the parameter is optional

Parameters

  • agent_names

    All of the management Agents(host:port) whose deployed plug-ins need to be listed. If you do not provide any Agent names, plug-ins on all Agents are listed. String literals with a wildcard (*) expression are accepted. For example:

    emcli list_plugins_on_agent -agent_names='adc*,st*93'
    
  • all

    Lists plug-ins on all the management's Agents.

  • include_discovery

    Includes discovery components of the plug-ins. By default, discovery components of the plug-ins are ignored.

Examples

Example 1

The following example lists plug-ins on the Agent abc.example.com.

emcli list_plugins_on_agent -agent_names=abc.us.oracle.com:3872

Example 2

The following example lists plug-ins for both of the Agents as well as their discovery components.

emcli list_plugins_on_agent -agent_names= abcd.example.com:3872,efgh.example.com:3872 -include_discovery

Example 3

The following example lists plug-ins for all Agents with the name that matches one of the regular expressions adc* or st*93.

emcli list_plugins_on_agent -agent_names='adc*,st*93'

Example 4

The following example lists plug-ins for all of the management Agents.

emcli list_plugins_on_agent -all

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

[ ] indicates that the parameter is optional

Parameters

  • setting_type

    Setting type. All applicable settings are displayed if you do not specify this option.

  • noheader

    Displays tabular information without column headers.

  • script

    This is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

    emcli list_privilege_delegation_settings      -setting_type="SUDO"   

list_sla

Lists the SLA life-cycle status and version information for a target. If you specify the slaName, the command prints the summary information of the different versions. If you do not specify the slaName, the command prints all the available SLA version series for a target. When you specify the version, this commands prints only summary information for the specified version.

Format

emcli list_sla
    -targetName=<target_name>
    -targetType=<target_type>
    [-slaName=<SLA_name>]

[ ] indicates that the parameter is optional

Parameters

  • targetName

    Name of the target.

  • targetType

    Type of target.

  • slaName

    Name of the SLA.

Examples

Example 1

The following example prints the SLA information for one SLA.

    emcli list_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla' -version=2

Example 3

The following example prints the SLA information for all SLAs of a target.

    emcli list_sla          -targetName='my_service' -targetType='generic_service'

list_swlib_entities

Lists the entities in the software library based on the specified filter criteria. The results are printed in the following order:

Display Name, Revision, Description, Status, Type, Subtype, Maturity, Owner, [Folder Path, Folder Id, Entity Rev Id]

Format

emcli list_swlib_entities 
        [-name="entity_name"] 
        [-folder_id="folder_internal_id"] 
        [-desc="entity_desc"] 
        [-attr="<attr_name>:<attr_value>"] 
        [-type]="type_internal_id"] 
        [-subtype]="subtype_internal_id"] 
        [-maturity]="maturity"] 
        [-owner]="owner"] 
        [-status]="status"] 
        [-show_folder_path] 
        [-show_folder_id] 
        [-show_entity_rev_id] 

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the entity. The value specified for this option is considered for a case-insensitive match.

  • folder_id

    Internal identifier of the parent folder. The value specified for this option is considered for an exact match.

  • desc

    Description of the entity. The value specified for this option is considered for a case-insensitive match.

  • attr

    An attribute and its value, separated by a colon ( : ). For specifying values for multiple attributes, repeat the option. The value specified for this option is considered for an exact match.

    You can only use this parameter with the type parameter.

  • type

    Internal identifier of the entity type. Use the list_swlib_entity_types verb to identify the type.

  • subtype

    Internal identifier of the entity sub-type. Use the list_swlib_entity_subtypes verb to identify the sub-type.

  • maturity

    Maturity of the entity revision. Can be one of: MAT_Untested MAT_Beta MAT_Production

  • owner

    Owner of the entity revision.

  • status

    Status of the entity revision. Can be one of: STATE_Incomplete STATE_Ready STATE_Deleted

  • show_folder_path

    Enables printing of the internal path of each entity's folder.

  • show_folder_id

    Enables printing of the internal ID of each entity's folder. If specified, the value is printed after the value for show_folder_path.

  • show_entity_rev_id

    Enables printing of the internal ID of each entity. If specified, the value is printed after the value for show_folder_id.

Examples

The following example lists all folders under the specified parent folder, and also prints the internal identifier for each folder in the list.

  emcli list_swlib_entities 
        -name="myEntity"
        -type="COMP_Component"
        -attr="PRODUCT:Oracle Database"
        -show_folder_id

list_swlib_entity_subtypes

Lists the entity subtypes available in the software library for a specified entity type.

Format

emcli list_swlib_entity_subtypes 
        [-entity_type_id="type_internal_name"] 
        [-show_subtype_id] 

[ ] indicates that the parameter is optional

Parameters

  • entity_type_id

    Internal identifier of the type.

  • show_subtype_id

    Enables printing of the internal identifier for the subtype.

Examples

The following example lists all subtypes available in the software library for the type 'COMP_Component.'

emcli list_swlib_entity_subtypes 
        -entity_type_id="COMP_Component"
        -show_subtype_id

list_swlib_entity_types

Lists the entity types available in the software library.

Format

emcli list_swlib_entity_types 
        [-show_type_id] 

[ ] indicates that the parameter is optional

Parameters

  • show_type_id

    Enables printing of the internal identifier for the type.

Examples

The following example lists all of the types available in the software library.

emcli list_swlib_entity_types 
        -show_type_id

list_swlib_folders

Lists folders in the software library.

Format

emcli list_swlib_folders 
        [-parent_id="parent_folder_id"] 
        [-show_folder_path] 
        [-show_folder_id] 

[ ] indicates that the parameter is optional

Parameters

  • parent_id

    Internal identifier of the parent folder.

  • show_folder_path

    Enables printing of the internal path for the folder.

  • show_folder_id

    Enables printing of the internal identifier for the folder.

Examples

The following example lists all folders under the specified parent folder, and prints the internal identifier for each folder in the list.

emcli list_swlib_folders 
      -parent_id= "oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
      -show_folder_id
 

list_swlib_storage_locations

Lists storage locations configured in the software library.

Format

emcli list_swlib_storage_locations 
        [-type="OmsShared|OmsAgent|Http|Nfs|ExtAgent"] 

[ ] indicates that the parameter is optional

Parameters

  • type

    Type of the storage location. The default is OmsShared.

Examples

The following example lists all locations configured for storage type 'OmsAgent.'

emcli +_locations 
        -type="OmsAgent"

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

[ ] indicates that the parameter is optional

Parameters

  • target_names

    List of targets. All targets must be of the host type. Either target_names or input_file must be present.

  • input_file

    Path of the file that has the list of targets. The file should have one target name per line.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • noheader

    Display tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

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

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

list_target_property_names

Lists property names for the global properties.

Format

emcli list_target_property_names

Parameters

None.


list_templates

Lists monitoring templates and their display names.

Format

emcli list_templates
        [-target_type="target_type"]

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Template's target type. If specified, all templates defined for this target type are displayed.

Examples

Example 1

The following example lists all templates.

emcli list_templates 

Exmaple 2

The following example lists all templates defined for the host target type.

emcli list_templates -target_type="host"

list_trace

Displays the list of OMS traces for the Oracle Management System.

Format

emcli list_trace

Parameters

None.


list_unconverted_udms

Retrieves the list of UDMs that are not yet in a migration session.

Format

emcli list_unconverted_udms
      [-templates_only]

[ ] indicates that the parameter is optional

Parameters

  • templates_only

    Only lists unconverted UDMs in templates.

Examples

Example 1

The following example displays all the UDMs that are not part of a migration session.

emcli list_unconverted_udms

Exmaple 2

The following example displays all the UDMs that are in a template and not part of a migration session.

emcli list_unconverted_udms -templates_only

loader_perf

Executes a performance test to determine the network bottleneck between OMS and the Enterprise Manager repository.

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

[ ] indicates that the parameter is optional

Parameters

  • batchSize

    Batch size for the performance test. Multiple values are allowed. Default values are {14,50,1}.

  • commitSize

    Commit size for the performance test. Multiple values are allowed. Default values are {500,50,5}.

  • dataSize

    Number of records to be inserted for a test. This should be greater than and a multiple of 100. If this is not a multiple of 100, a multiple of 100 less than the given value is considered as the dataSize value. The default value is 10000.

Examples

Example 1

Display the time required to load 10,000 records for the default values of batchSize and commitSize.

emcli loader_perf

Exmaple 2

Display the time required to load 10,0000 records for a batchSize of {15,40} and a commitSize of {10,100}.

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

login

Logs into Enterprise Manager with the given credentials and sets up a session with the OMS.

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 EM CLI commands.

Tip:

See also logout.

Command-Line Format

emcli login      -username=<EM_Console_Username>      [-password=<EM_Console_Password>]      [-force]

[ ] indicates that the parameter is optional

Scripting and Interactive Format

login      (username="<EM_Console_Username>"      [,password="<EM_Console_Password>"]      [,force=True|False])

[ ] indicates that the parameter is optional

Parameters

  • username

    Enterprise Manager user name to be used by all subsequent EM CLI commands when contacting the OMS.

  • password

    Enterprise Manager user password. If you do not specify this , you are prompted for the password interactively.

    Note:

    Providing a password on the command line is insecure and should be avoided.
  • force

    Force a login even if there is an existing session. The value must be set to either True or False for scripting and interactive format.

Examples

The following examples show a login as a different user using newly specified credentials, then a subsequent login using the previous credentials.

Example 1 - Command-Line

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

Example 2 - Scripting and Interactive

logout()
login(username="new_user", password="new_user_pass")
<verb-name>
logout()
login(username="old_user", password="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.

Note:

Verbs executed after 'emcli logout' may fail with the message "Error: Session expired. Run emcli login to establish a session." You need to run the login verb to log in to EM CLI after an 'emcli logout'.

Format

emcli logout

Parameters

None.

Examples

The following example shows a login as a different user 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

merge_credentials

Merges all the references of named credentials provided in the source_credential_list into the destination_credential. The verb expects all the named credentials provided to be equivalent. You can list equivalently named credentials using the command emcli get_duplicate_credentials. All the matching duplicate credentials can be merged using the flag merge_all.

Format

emcli merge_credentials 
        -destination_credential="destination_cred_name[:destination_cred_owner]"
        [-source_credential_list="source_credential_list"]
        [-merge_all]
        [-merge_without_testing]

[ ] indicates that the parameter is optional.

Parameters

  • destination_credential

    Destination credentials to merge the references.

  • source_credential_list

    Source-named credential list.

  • merge_all

    Finds all the duplicate credentials and merges.

  • merge_without_testing

    Merges the credentials without testing the destination credential.

Examples

Example 1

The following example merges the named credentials MyOracleCredential2 and MyOracleCredential3 into MyOracleCredential1. If MyOracleCredential1 is equivalent to MyOracleCredential2 and MyOracleCredential3, all the usages of MyOracleCredential2 and MyOracleCredential3 are replaced with MyOracleCredential1.

emcli merge_credentials 
        -destination_credential="MyOracleCredential1:ADMIN1"
        -source_credential_list=           "MyOracleCredential2:ADMIN1;MyOracleCredential3:ADMIN3"

Example 2

The following example finds all the named credentials equivalent to MyOracleCredential1 and merges their usages with MyOracleCredential1.

emcli merge_credentials 
        -destination_credential=MyOracleCredential1
        -merge_all

metric_control

For the specified target type, lists the metrics whose alerts are stateless and therefore 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.

Tip:

See also clear_stateless_alerts .

Format

emcli metric_control 
         -command=command 
         -target_type=type 
         -metric_name=name

[ ] indicates that the parameter is optional

Parameters

  • command

    Can be one of the following:

    • disable_metric — Disables loading of the specified metric .

    • enable_metric — Reenables loading of the specified metric.

    • list_disabled_metrics — Lists the metrics currently disabled for loading.

    • flush_metadata_cache — Flushes the metric API metadata cache target_type.

  • target_type

    Internal target type identifier (host, oracle_database, oc4j, oracle_emrep, oracle).

  • metric_name

    Internal name of the metric (for example, load for the host target type).

Example

The following example disables the loading of the Load metric on the host target type.

emcli metric_control -command=disable_metric -target_type=host -metric_name=Load

migrate_to_lifecycle_status

Migrates to the lifecycle state from the deployment type.

Format

emcli migrate_to_lifecycle_status
        -deployment_values="value1;value2;value3
        -lifecycle_stage_values="Stage;Stage;Production

Parameters

  • deployment_values

    Deployment type values.

  • lifecycle_stage_values

    Lifecycle stage values


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

[ ] indicates that the parameter is optional

Parameters

  • name

    Aggregate service name.

  • type

    Aggregate service type.

  • add_sub_services

    Sub-services to be added.

  • del_sub_services

    Sub-services to be deleted.

  • avail_eval_func

    PL/SQL function to evaluate the availability of the aggregate service. Use [or|and] for the predefined evaluation helper function.

  • timezone_region

    Time zone region of the service.

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]

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

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

Parameters

  • targetType

    You must specify a single target type value, and it should be the same as specified in the repository.

    Note:

    Only individual target types are currently supported.
  • targetNames

    The target name should be the same as exists in the repository. All of the targets should be the same target type you specified in the targetType parameter. Use a semicolon ( ; ) to separate the names. Changes to the collection schedule will be executed for only valid target name and target type combinations. For example:

    host1;host2;host3

  • collectionName

    The collection name should be exactly the same as exists in the repository or the corresponding collections .xml file present on the Management Agent.

    Access files from the following locations to determine the collection to be modified. Select the desired collection and provide it as input to the EM CLI utility.

    • $AGENT_HOME/sysman/admin/metadata/<targetType>.xml

      This file is shipped as a part of the setup and contains information regarding the metrics for this target type.

    • $AGENT_HOME/sysman/admin/default_collection/<targetType>.xml

      This file is shipped as a part of the setup and contains the collections shipped by default.

    • $AGENT_HOME/sysman/emd/collection/<targetType_targetName>.xml

      Whenever changes have occurred for any particular target, this file is automatically generated. Collections for user-defined metrics are available in this file.

  • collectionStatus

    Enables or disables the collection. The default is Enabled. If Disabled, freqType and freqValue are ignored.

  • freqType

    You can specify one of the following values:

    Minute (default) Hour Day Week Weekly Month

    For Week, you must specify an integer value as the frequency value. For instance, if you specify freqType='WEEK' and freqValue='2', the collection occurs every two weeks.

    For Weekly, the possible values are Mon, Tue, Wed, Thu, Fri, Sat, Sun. For instance, if you specify freqType='Weekly' and freqValue='Tue;Thu;Sun', the collection occurs every Tuesday, Thursday, and Sunday of a week.

    The schedule is modified based on your selection. You do not need to specify a value (and the value will be ignored) if the collectionStatus parameter is set to Disabled.

    If you use this parameter, you must also use the freqValue parameter.

  • freqValue

    You can specify one of the following values:

    • You must specify an integer value if the freqType is any one of Minute, Hour, Day, or Week. The default value is 5.

    • For Weekly, specify one or more choices from Mon, Tue, Wed, Thu, Fri, Sat, and Sun. If the collection occurs on any particular day(s) of the week, you must specify the corresponding value(s) against the Weekly option.

    • For Monthly, specify one or more choices from 1...31 or Last. If the collection occurs on any particular date(s) in a month, you must specify the corresponding value(s) against the Monthly option.

    You do not need to specify a value (and the value will be ignored) if the collectionStatus parameter is set to Disabled.

    If you use this parameter, you must also use the freqType parameter.

  • preview

    Provides a preview of the changes that would occur if this verb is executed. The default value for this option is Y (Yes), whether you specify the option or not. If you specify N, the changes to the collection schedule are executed for both the repository and Management Agent.

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

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

[ ] indicates that the parameter is optional

Scripting and Interactive Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name of the group to modify.

  • type

    Group type: group. Defaults to group.

  • add_targets

    Targets to add, each specified as target_name:target_type. You can specify this option more than once for command-line format.

  • delete_targets

    Targets to delete, each specified as target_name:target_type. You can specify this option more than once for command-line format.

  • privilege_propagation

    Enables or disables the privilege propagation flag for the group. Converts the normal group to a privilege propagating group and vice versa.

  • drop_existing_grants

    Drops the existing grants on a group during privilege propagation conversion. This parameter is only applicable with the privilege_propagation parameter. The default value is yes.

Examples

The following examples modify group db2_group by adding database database:oracle_database and deleting database database2:oracle_database from the group.

Example 1 - Command-Line

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

Example 2 - Scripting and Interactive

modify_group
      (name="db2_group", 
       add_targets="database:oracle_database", 
       delete_targets="database2:oracle_database")

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

Example 3 - Command-Line

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

Example 4 - Scripting and Interactive

modify_group
       (name="my_hosts", 
        add_targets="yourhost.example.com:host")

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

Example 5 - Command-Line

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

Example 6 - Scripting and Interactive

modify_group
      (name="my_group", 
       add_targets="group_a:group;database:oracle_database",
       delete_targets="nogroup:group")

The following examples convert group my_group to privilege propagating, ignores if already converted, and drops all of its existing grants.

Example 7 - Command-Line

emcli modify_group 
          -name=my_group
          -privilege_propagation=true

Example 8 - Scripting and Interactive

modify_group
       (name="my_group", 
        privilege_propagation="true")

The following examples convert group my_group to non-privilege propagating, ignores if already converted, and retains all of its existing grants on my_group.

Example 9 - Command-Line

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

Example 10 - Scripting and Interactive

modify_group
       (name="my_group", 
        privilege_propagation="false", 
        drop_existing_grants="no")

modify_incident_rule

Enables or disables a specific incident rule or rule set. (Updates all rules in the rule set.)

Format

emcli modify_incident_rule
      -action=enable|disable 
      -type=ruleset|rule 
      -rule_set_name=<name_of_rule_set>
      [-owner=<owner_of_rule_set>]
      [-rule_name=<name_of_rule>]

[ ] indicates that the parameter is optional

Parameters

  • action

    Action to be performed. Supported actions are enable and disable.

  • type

    Disables a specific rule or the entire rule set.

  • rule_set_name

    Name of the rule set to which you would like to apply the action.

  • owner

    Owner of the rule set. If multiple rule sets exist with same name, the rule set owner is used to identify the rule set.

  • rule_name

    Name of the specific rule to which the action will apply.

Examples

Example 1

The following example enables 'rule set 1' and all child rules.

emcli modify_incident_rule -action='enable' -type='ruleset' -rule_set_name='rule set 1' 

Example 2

The following example disables 'rule set 1' and all child rules.

emcli modify_incident_rule -action='disable' -type='ruleset' -rule_set_name='rule set 1' 

Example 3

The following example enables a single rule named 'rule 1' within 'rule set 1'.

emcli modify_incident_rule -action='enable' -type='rule' -rule_set_name='rule set 1' -rule_name='rule 1' 

Example 4

The following example disables a single rule named 'rule 1' within 'rule set 1'.

emcli modify_incident_rule -action='disable' -type='rule' -rule_set_name='rule set 1' -rule_name='rule 1' 

modify_lifecycle_stage_name

Changes the life-cycle stage name. Only super users can run this command.

The Lifecycle Status property of the target has special semantics. The property does priority processing of events related to the target. Therefore, events from mission-critical targets have a higher priority than events from development targets. If you change the name, make sure to use a name that reflects its corresponding priority, because the same priority continues to be maintained regardless of the name change.

Format

emcli modify_lifecycle_stage_name
      -name="current_name"
      -new_name="new_name"

Parameters

  • name

    Current life-cycle stage name. The available list in the order of decreasing priority is:

    • MissionCritical

    • Production

    • Stage

    • Test

    • Development

  • new_name

    New life-cycle stage name. The new name is not translated into your locale and will be displayed as is. The new name should only contain alpha characters.

    When you change the existing name to a new name, all existing targets are updated with the new property value. For instance, if name=MissionCritical and new_name=Production, all existing targets are updated with Production.

Examples

emcli modify_lifecycle_stage_name
      -name="Test"
      -new_name="Test_staging"

modify_monitoring_agent

Changes the Agents configured to monitor targets in a WebLogic Domain.

Format

emcli modify_monitoring_agent        -target_name=<target_name>        [-target_type=weblogic_domain]        [-assign_local_agent]        -debug        
[ ] indicates that the parameter is optional

Parameters

  • target_name

    Complete target name of domain to be modified.

  • target_type

    Default value is weblogic_domain, and is the only valid target type.

  • assign_local_agent

    Globally assigns each target in the WebLogic Domain, such as WebLogic Server, to be monitored by the Agent installed on each target's host. That is, after running the verb with this option, each target in the domain is monitored by its local Agent. The local Agent is assigned if a local Agent is found. Otherwise, the monitoring Agent of the target is not changed.

  • debug

    Runs the verb in verbose mode for debugging purposes.

Examples

The following example changes the Agents configured to monitor targets in a WebLogic Domain.

emcli modify_monitoring_agent 
      -target_name=/prod_my_domain/my_domain 
      -assign_local_agent

modify_named_credential

Updates an existing named credential. You can provide input parameters using command line arguments or an input properties file. It also supports the input_file tag for passwords and parameter values.

Format

 emcli modify_named_credential         -cred_name=<name>        -new_cred_name<name>        -cred_type=<credential_type>        -cred_scope=<credential_scope>        -cred_desc=<credential_description>        -target_name=<target_name>        -target_type=<target_type>
        -test 
        -test_target_name=<test_target_name>
        -test_target_type=<test_target_type>
        -input_file=<tag|value>        -properties_file=<filename>        -attributes=<p1:v1;p2:v2;...>
        -remove_old_attributes

Parameters

  • cred_name

    Credential name, such as MyBackUpCreds. This is required if you do not use the properties_file option.

  • new_cred_name

    New credential name.

  • cred_type

    Credential type.

  • cred_scope

    Possible values are global instance. The default is global.

  • cred_desc

    Credential description.

  • target_name

    This is required when cred_scope is instance.

  • target_type

    This is required when cred_scope is instance.

  • test

    Use this parameter to test the credential before saving.

  • test_target_name

    Use this parameter to supply the target name to test a global credential. This is mandatory when the scope is global and the test option is used.

  • test_target_type

    Use this parameter to supply the target type to test a global credential. This is mandatory when the scope is global and the test option is used.

  • input_file

    Use this option to supply sensitive property values from the file.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • properties_file

    Use this option to pass all parameters from the file. Values given on the command line take precedence.

  • attributes

    Specify credential columns as follows:

    colname:colvalue;colname:colvalue
    

    You can change the separator value using -separator=attributes=<newvalue>, and you can change the subseperator value using -subseparator=attributes=<newvalue>.

  • remove_old_attributes

    Unsets all existing credential column values.

Examples

Example 1

The following example updates credentials to foo and bar:

emcli modify_named_credential
        -cred_name=NC1
        -attributes="HostUserName:foo;HostPassword:bar"

Example 2

The following example updates the password to bar:

emcli modify_named_credential         -cred_name=NC1         -attributes="HostPassword:bar"

Example 3

The following example reads the password from the mypasswordfile.txt file.

emcli modify_named_credential
        -cred_name=NC1 
        -attributes="HostUserName:foo;HostPassword:tag"
        -input_file="tag:mypasswordfile.txt"

Example 4

The following example prompts for the password from standard input:

emcli modify_named_credential 
        -cred_name=NC1 
        -attributes="HostUserName:foo;HostPassword:"

Example 5

The following example specifies prop1.txt as a multi-line Java properties file, in which each line contains a parameter=value format. You can provide the password in the same file or not specify it. If not specified, you are prompted for it.

emcli modify_named_credential
        -properties_file=prop1.txt

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

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name of the group to modify.

  • type

    Redundancy Group type: generic_redundancy_group. Defaults to generic_redundancy_group.

  • add_targets

    Targets to add, each specified as target_name:target_type. You can specify this option more than once.

  • delete_targets

    Targets to delete, each specified as target_name:target_type. You can specify this option more than once.

  • owner

    Owner of the redundancy group.

Examples

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

emcli modify_red_group -name=Servers
      -add_targets=HTTP_Server1:generic_apache
      -delete_targets=Server5:generic_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=<status_value>]
        [-privilege_propagation=true|false]        [-drop_existing_grants=yes|no]

[ ] indicates that the parameter is optional

Parameters

  • redundancyGroupName

    Name of the redundancy group.

  • owner

    Valid owner to be specified.

  • memberTargetType

    Target type of the constituent member targets. You need to specify this parameter if you specify either add_targets or delete_targets.

  • add_targets

    Member targets to be added to this redundancy group.

  • delete_targets

    Member targets to be deleted from this redundancy group.

  • group_status_criterion

    This option and the next two calculate the status of the Redundancy Group. Consequently, you need to specify all three options together. If this is not to be a capacity group, you need to specify the following combination:

    -group_status_criterion='NUMBER' -group_status_tracked='UP'  -group_status_value='1']
    
  • group_status_tracked

    See the option above.

  • group_status_value

    See the group_status_criterion .

    You can specify any value between 1 and 100 if -group_status_criterion= "PERCENTAGE", or any value between 1 and the number of targets present if -group_status_criterion="NUMBER".

  • privilege_propagation

    Enables or disables the privilege propagation flag for the group. Converts the normal group to a privilege-propagating group and vice versa.

  • drop_existing_grants

    Drops the existing grants on a group during privilege propagation conversion. This parameter is only applicable with the privilege_propagation parameter. The default value is yes.

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_resolution_state

Modifies an existing resolution state that describes the state of incidents or problems. Only super administrators can execute this command. You need to specify the updated label as well as the updated position. The position can be between 2 and 98, and cannot be in use by another resolution state.

You can also optionally indicate that the state should apply to both incidents and problems. A success message is reported if the command is successful. An error message is reported if the change fails.

Format

emcli modify_resolution_state
        -label="old_label_of_state"
        -new_label="new_label_for_display"
        -position="new_display_position"
        [-applies_to=BOTH]

[ ] indicates that the parameter is optional

Parameters

  • label

    Old label of the state to be modified.

  • new_label

    End-user visible label of the state. The label cannot exceed 32 characters.

  • position

    Position of this state within the overall list of states. This is used when displaying the list of states in the user interface. The position can be between 2 and 98.

    It is recommended that you set the position with sufficient gaps to facilitate moving states around. For example, if you set the positions to 5, 10, and 15 instead of 2, 3, and 4, it is easier to move a state from position 15 to 9, for instance, in contrast to the latter scheme, in which you would have to move all states to provide space for the reordering.

  • applies_to

    Indicates that the state is applicable for incidents and problems. The only supported value is "BOTH."

Examples

Example 1

The following example updates the resolution state with the old label "Waiting for TT" with the new label "Waiting for Ticket," and if necessary, changes the position to 25.

emcli modify_resolution_state  -label="Waiting for TT" -new_label="Waiting for Ticket" -position=25

Example 2

The following example updates the resolution state with the old label "SR Waiting" with the new label "Waiting for SR," and if necessary, changes the position to 35. It also makes the state applicable to incidents and problems.

emcli modify_resolution_state  -label="SR Waiting" -new_label="Waiting for SR" -position=35 -applies_to=BOTH

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[;secure-resource-details]]"
      [-separator=privilege="sep_string"]
      [-subseparator=privilege="subsep_string"]
      [-users="user1;user2;..."]

[ ] indicates that the parameter is optional

Parameters

  • name

    Role name.

  • description

    Replaces the description of the role.

  • roles

    Replaces the list of roles assigned to this existing role. Currently, the only built-in role is PUBLIC.

  • privilege

    Replaces privileges granted to this role. You can specify this option more than once. Specify <secure_resource_details> as:

    resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
    
  • separator

    Specify a string delimiter to use between name-value pairs for the value of the -privilege option. The default separator delimiter is a semi-colon ( ; ).

  • subseparator

    Specify a string delimiter to use between name and value in each name-value pair for the value of the -privilege option. The default subseparator delimiter is a colon ( : ).

  • users

    Replaces the list of users to whom this role is assigned.

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:key_member|non_key_member;name2:type2;..."]... 
              [-separator=add_members="sep_value"] 
              [-subseparator=add_members="subsep_value"] 
         [-delete_members="name1:type1;name2:type2;..."]... 
              [-separator=delete_members="sep_value"] 
              [-subseparator=delete_members="subsep_value"] 
         [-owner="new_owner"] 
         [-privilege_propagation=true|false] 
         [-drop_existing_grants=yes|no] 
         [-availability_type="ALL/ANY"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name of the system to modify.

  • type

    System type: generic_system. Defaults to generic_system.

  • add_members

    Targets to add, each specified as target_name:target_type. You can specify this more than once. key_member specifies that this target is a part of the systems availability calculation. non_key_member specifies that this target is not a part of the systems availability calculation.

  • delete_members

    Member targets to be removed from the system, each specified as target_name:target_type. You can specify this option more than once.

  • owner

    New owner of the system.

  • privilege_propagation

    Enables or disables the privilege propagation flag for the group. Converts the normal group to a privilege propagating group and vice versa.

  • drop_existing_grants

    Drops existing grants on a group when conversion occurs in privilege propagation nature. This parameter is only applicable with the privilege_propagation parameter. The default value is yes.

  • availability_type

    Availability calculation method of the system. Defining this is required if key_member is defined. ALL denotes that all key members must be up in order to establish the system as UP. ANY denotes that at least one of the key members must be up in order to establish the system as UP.

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

Example 4

The following example modifies system db2_system by adding database database1 as a key member, adding databases database2 and database3 as non-key members, and deleting database4 and database5. The availability computation is impacted, since database1 is now part of the availability computation for the db2_system. If database4 and database5 were key members, they are no longer part of the availability computation for the db2_system.

Specifying separator and subseparator is optional. Separator defaults to ; and subseparator defaults to : .

emcli modify_system -name=db2_system -type=generic_system 
  [add_members=database1:oracle_database:key_member,database2:oracle_database] 
     [separator=add_members=","] 
     [subseparator=add_members=":"] 
  [add_members=database3:oracle_database:non_key_member]
  [delete_members=database4:oracle_database,database5:oracle_database]
     [separator=delete_members=","] 
     [subsrparator=delete_members=":]"

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]

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name.

  • type

    Target type.

  • properties

    Name-value pair list of properties for the target instance. The "name"(s) are identified in the target-type metadata definition. They must appear exactly as they are defined in that file. Metadata files are located in $AGENT_ORACLE_HOME/sysman/admin/metadata.

    Note:

    This verb does not support setting global target properties. It is recommended that you use set_target_property_values to set target properties.
  • separator=properties

    Specifies a string delimiter to use between name-value pairs for the value of the -properties option. The default separator delimiter is ";".

  • subseparator=properties

    Specifies a string delimiter to use between name and value in each name-value pair for the value of the -properties option. The default subseparator delimiter is ":".

  • credentials

    Monitoring credentials (name-value pairs) for the target instance. The "name"(s) are identified in the target-type metadata definition as credential properties. They must appear exactly as they are defined in that file. Metadata files are located in $AGENT_ORACLE_HOME/sysman/admin/metadata.

  • input_file

    Used in conjunction with the -credentials option, this option enables you to store specific target monitoring credential values, such as passwords, in a separate file. The -input_file option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific monitoring credentials of the -credentials option. The tag must not contain colons ( : ) or semi-colons ( ; ).

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • display_name

    Sets the target display name.

  • on_agent

    Propagates changes to the Management Agent collecting this target's metrics.

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_threshold

Edits threshold settings for a given target and metric

Format

emcli modify_threshold
        -target_name="tname"
        -target_type="ttype"
        [-metric="met"]
        [-column="col"]
        [-key_columns="val1;val2;..."]
        [-warning_threshold="warn"]
        [-critical_threshold="crit"]
        [-occurrences="occur"]
        [-prevent_override="0 or 1"]
        [-force]
        [-input_file="FILE:cli_input.txt"]

[ ] indicates that the parameter is optional

Parameters

  • target_name

    Name of the target associated with the threshold.

  • target_type

    Type of target associated with the threshold.

  • metric

    Metric category associated with the threshold.

  • column

    Metric column associated with the threshold.

  • key_columns

    Values of the key columns associated with the threshold. If you do not specify this option for a key-based metric, an EM CLI occurs.

  • warning_threshold

    New warning threshold value. Specify " " for no warning threshold. If warning and critical thresholds are incoherent depending on the comparison operator, an EM CLI error occurs .Use -force to save the provided thresholds.To keep the previous value (if any), omit this option.

  • critical_threshold

    New critical threshold value. Specify " " for no warning threshold. If warning and critical thresholds are incoherent depending on the comparison operator, an EM CLI error occurs .Use -force to save the provided thresholds.To keep the previous value (if any), omit this option.

  • occurrences

    Number of times a threshold can be violated before causing an alert. To keep the previous value (if any), omit this option.

  • prevent_override

    Prevents thresholds modification of this metric from future Apply Template operations on this target. Periodic Apply Template operations are submitted on targets managed by Administration Groups, which can override the metric thresholds you set if the prevent_override flag is not set.

    An error occurs if prevent_override is not set in database, you have not provided prevent_override, and the target is managed by Administration Groups. To continue without using prevent_override, use -force.To keep the previous value (if any), omit this option.

  • force

    Saves the provided thresholds incase recommended in previous error messages.

  • input_file

    Provides threshold details for multiple metrics in a text file.Do not provide metric, column, key_columns, warning_threshold, critical_threshold, occurrences and prevent_override in this command when using the input_file option.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

    You can provide the details for multiple metrics in the input file as shown:

            START_RECORD 1
            metric , Filesystems
            column , available
            key_columns , ab;cd;
            warning_threshold , 15
            critical_threshold , 50
            occurrences , 3
            prevent_override , 1
            END_RECORD 1
     
            START_RECORD 2
            metric , Load
            column , cpuUtil
            warning_threshold , 15
            critical_threshold , 50
            occurrences , 3
            prevent_override , 1  
            END_RECORD 2
    
    

    To set the thresholds for the "Al Others" key, provide the details as shown:

            START_RECORD 1
            metric , Filesystems
            column , available
            key_columns , ;
            warning_threshold , 15
            critical_threshold , 50
            occurrences , 1
            END_RECORD 1
    

Examples

Example 1

The following example sets the critical threshold value to "0" for the Load metric, and the cpuUtil column on the host "myhost.example.com". The warning threshold value and response action (if any) remain unchanged.

emcli modify_threshold
          -target_name="myhost.example.com"
          -target_type="host"
          -metric="Load"
          -column="cpuUtil"
          -critical_threshold="0"
          -prevent_override="0"
          -force

Example 2

The following example sets the DiskActivitybusy threshold for the DiskActivitydevice called sd0 on the host myhost.example.com.

emcli modify_threshold
          -target_name="myhost.example.com"
          -target_type="host"
          -metric="DiskActivity"
          -column="DiskActivitybusy"
          -key_columns="sd0;"
          -warning_threshold="55"
          -critical_threshold="65"
          -occurrences="3"

Example 3

The following example sets the sessions.active threshold for the name my_module and the oc4j_ear my_ear on the oc4j myOC4J.example.com.

emcli modify_threshold
          -target_name="myOC4J"
          -target_type="oc4j"
          -metric="oc4j_web_module_rollup"
          -column="session.active"
          -key_columns="my_module;my_ear;"
          -warning_threshold="1000"
          -critical_threshold="2000"
          -occurrences="4"
          -force

Example 4

The following example uses emcli_input.txt for metric and threshold details.

emcli modify_threshold
          -target_name="myOC4J"
          -target_type="oc4j"
          -input_file="FILE:/home/emcli_input.txt"

Example 5

The following example uses emcli_input.txt for metric and threshold details, and the -force option for all the metrics provided in the input file.

emcli modify_threshold
          -target_name="myOC4J"
          -target_type="oc4j"
          -input_file="FILE:/home/emcli_input.txt"
          -force

modify_user

Modifies an existing Enterprise Manager administrator.

Format

emcli modify_user
        -name="name"
        [-type="type_of_user"]
        [-password="password"]
        [-roles="role1;role2;..."]
        [-email="email1;email2;..."]
        [-privilege="name[;secure_resource_details]]"
        [-separator=privilege="sep_string"]
        [-subseparator=privilege="subsep_string"]
        [-profile="profile_name"]
        [-desc="user_description"]
        [-expired="true|false"]
        [-prevent_change_password="true|false"]
        [-department="department_name"]
        [-cost_center="cost_center"]
        [-line_of_business="line_of_business"]
        [-contact="contact"]
        [-location="location"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Administrator name.

  • type

    Converts the type of user from a repository user to an external user and vice versa. Possible values for this parameter are EM_USER or EXTERNAL_USER.

  • password

    Replaces the administrator password with the specified password.

  • roles

    Replaces current roles with the specified list of Enterprise Manager roles to grant to this administrator. Currently, the built-in roles include PUBLIC.

  • email

    Replaces current email addresses for this administrator with the specified list. To delete all email addresses for this administrator, specify an empty string.

  • privilege

    Privilege to grant to this administrator. You can specify this option more than once. The original administrator privileges will be revoked. Specify <secure_resource_details> as:

    resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
    

    To retrieve the list of system privileges that do not require resource information, execute the get_supported_privileges command.

  • profile

    Database profile name. When not passed, this value is not altered.

  • desc

    User description

  • expired

    True immediately expires the password. The default is false.

  • prevent_change_password

    True prevents a user from updating his/her password. The default is false.

  • department

    Department name of the administrator.

  • cost_center

    Cost center of the administrator in the organization.

  • line_of_business

    Line of business of the administrator.

  • contact

    Contact information for the administrator.

  • location

    Location of the administrator.

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@example.com and joe.shmoe@shmoeshop.com.

emcli modify_user
      -name="new_admin"
      -password="oracle"
      -email="first.last@example.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=""

modify_virtual_platform

Modifies the Oracle Virtual Platform target's monitoring agent, fail-over agent, or the monitoring credentials. Only the properties of the target needing modification must be specified when modifying a target of that type. For all of the parameters not passed, the existing values are retained.

Format

emcli modify_virtual_platform 
       -name="target_name"
       -agent="agent_target_name"
       [-failover_agent="failover_agent_target_name"]
       -credentials="property_name1:property_value1;property_name2:            property_value2;..."
               [-wait_for_completion=true|false]
               [-wait_for_completion_timeout=<time_in_minutes>]
       [-separator=credentials="separator_for_key_value_pairs"]
               [-subseparator=credentials="separator_for_key_value_pair"]
       [-input_file="FILE:file_path"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Target name of the Oracle Virtual Platform to modify.

  • agent

    Target name of the primary agent used to monitor the Oracle Virtual Platform and related targets.

  • failover_agent

    Target name of the failover agent used to monitor the Oracle Virtual Platform and related targets.

  • credentials

    Monitoring credentials (name-value pairs) for the target instance. The "names" are defined in the target type metadata definition as credential properties. Metadata files are located at $AGENT_HOME/sysman/admin/metadata.

    See the examples for details on various options.

  • wait_for_completion

    Flag to indicate if the CLI is going to wait for the submitted job to finish. The default value is false. If the value is true, the progress of the job is printed on the command line as and when the addition of Oracle Virtual Platform(s) Succeeds/Fails.

  • wait_for_completion

    Flag to indicate if the CLI is going to wait for the submitted job to finish. The default value is false. If the value is true, the CLI waits and prints the job output on the command line when the modification of Oracle Virtual Platform(s) Succeeds/Fails.

  • wait_for_completion_timeout

    Time in minutes after which CLI stops waiting for the job to finish. This parameter is honored only if the value for parameter wait_for_completion is true. A negative or zero value does not wait for the job to finish.

    See the examples for details.

  • separator=credentials

    Custom separator for the credential key value pairs. Specify a string delimiter to use between name-value pairs for the values of the -credentials option. The default separator delimiter is ";".

    For more information about the separator parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • subseparator=credentials

    Custom separator for a key value pair. Specify a string delimiter to use between name and value in each name-value pair for the values of the -credentials option. The default subseparator delimiter is ":".

    For more information about the subseparator parameters see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file

    File path with a credential secret value. Optionally use in conjunction with the -credentials option. You can use this option to set specific target monitoring credential values, such as passwords or SSH keys, in a separate file.

    This option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific -credentials property values.

Examples

Example 1

The following example modifies the primary monitoring Agent of the Oracle Virtual Platform to the specified Agent target.

emcli modify_virtual_platform -name=exampletarget -agent=example.com:1838

Example 2

The following example modifies the primary monitoring Agent to a specified Agent target, and the failover agent to none.

emcli modify_virtual_platform -name=exampletarget -agent=example.com:1828 -failover_agent="" 

Example 3

The following example modifies the Oracle Virtual Platform's credentials with root user host credentials. The value of the property "OVSUsername" is used for the user name and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are collected (true) or not (false) when monitoring. The password is passed at the command line.

emcli modify_virtual_platform
           -credentials='type:DMOvsBasicCreds;PrivilegeType:none;
               privilegedUser:true;OVSUsername:root;OVSPassword:mypassword'

Example 4

The following example modifies the Oracle Virtual Platform's credentials with root user host credentials. The value of the property "OVSUsername" is used for the user name and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are collected (true) or not (false) when monitoring. The password of the root user is read from the input file "password.txt".

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsBasicCreds;PrivilegeType:none;
          privilegedUser:true;OVSUsername:root;OVSPassword:PWD_FILE'
      -input_file='PWD_FILE:password.txt

Example 5

The following example modifies the Oracle Virtual Platform's credentials with Unix Sudo user host credentials. The value of the property "PrivilegeCommand" is used to execute the Sudo command. %RUN_AS% and %COMMAND% are replaced with the user and the command to be executed by Sudo command. The value of the property "EnablePseudoTerminal" indicates if Sudo requires (true) a tty terminal or not (false). The password is passed at the command line.

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsBasicCreds;PrivilegeType:sudo;
          privilegedUser:true;RunAs:root;
          PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
          EnablePseudoTerminal:false;OVSUsername:root;OVSPassword:mypassword'

Example 6

The following example modifies the Oracle Virtual Platform's credentials with Unix PowerBroker user host credentials. The value of the property "PrivilegeCommand" is used to execute the PowerBroker command. %RUN_AS% and %COMMAND% are replaced by the user and the command to be executed by PowerBroker. The value of the property "PowerBrokerProfile" is used as the PowerBroker profile. The value of the property "PowerBrokerPasswordPrompt" is used as the PowerBroker password prompt. The password is passed at the command line.

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsBasicCreds;PrivilegeType:powerbroker;
         RunAs:root;privilegedUser:true;OVSUsername:root;OVSPassword:mypassword;
         PrivilegeCommand:/usr/bin/pbrun -l -u %RUN_AS% %COMMAND%;
         PowerBrokerProfile:profile;PowerBrokerPasswordPrompt:myprompt'

Example 7

The following example modifies the Oracle Virtual Platform's credentials with a Unix Sudo user who requires SSH key Passphrase-less based authentication. The SSH private key, SSH public key, and password are read from input files.

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsSshKeyCreds;PrivilegeType:sudo;
          privilegedUser:true;RunAs:root;
          PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
          EnablePseudoTerminal:false;
          SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;
          OVSUsername:sudoer1;OVSPassword:PWD_FILE' 
      -input_file='PRIVATE_KEY:id_dsa' 
      -input_file='PUBLIC_KEY:id_dsa.pub' 
      -input_file='PWD_FILE:password' 

Example 8

The following example modifies the Oracle Virtual Platform's credentials with a Unix PowerBroker user who requires SSH key Passphrase-less based authentication. The SSH private key, SSH public key, and password are read from input files.

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsSshKeyCreds;PrivilegeType:powerbroker;
          privilegedUser:true;RunAs:root;
          PrivilegeCommand:/usr/bin/pbrun -l -u %RUN_AS% %COMMAND%;
          PowerBrokerProfile:profile;PowerBrokerPasswordPrompt:myprompt;
          SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;
          OVSUsername:myuser;OVSPassword:PWD_FILE' 
          -input_file='PRIVATE_KEY:id_dsa' 
          -input_file='PUBLIC_KEY:id_dsa.pub' 
          -input_file='PWD_FILE:password'  

Example 9

The following example modifies the Oracle Virtual Platform's credentials with non- privileged user host credentials. The virtualization metrics for the added target will not be monitored. The password is specified at the prompt.

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsBasicCreds;privilegedUser:false;
          OVSUsername:simpleton;OVSPassword:password'

package_fa_problem

This verb accomplishes the following tasks:

  • Packages a Fusion Applications problem by reading details from a pre-written input file.

  • Optionally attaches metrics, custom dumps, and reports by reading details from pre-written heap dumps and database AWR (Automatic Workload Repository) files.

  • Uploads the finalized package to Oracle Support and reports the number of the draft Service Request created for the package if no SR is supplied.

Format

emcli package_fa_problem
      -input_file=incident_packaging_file:file_path
      [-input_file=heap_dumps_file:file_path]
      [-input_file=db_awr_file:file_path]

[ ] indicates that the parameter is optional

Parameters

  • input_file=incident_packaging_file

    Fully-qualified path to a CSV formatted file containing one line of details for the Fusion Applications problem to be packaged.

    The structure of the CSV file is as follows:

    <Full target name>,
    <Target type>,
    <Problem key>,
    <Host credential name - for using named credentials only>,
    <Host username - for using new credentials only>,
    <Host password - for using new credentials only>,
    <Target credential name - for using named credentials only>,
    <Target username - for using new credentials only>,
    <Target password - for using new credentials only>,
    <Boolean for adding host metrics - optional - default is true>,
    <Boolean for adding WebLogic metrics - optional - default is true>,
    <Boolean for adding JVM dump - optional - default is true>,
    <Boolean for adding heap dumps - optional - default is false>,
    <Boolean for adding Automatic Workload Repository (AWR) reports - optional - default is false>,
    <My Oracle Support username>,
    <My Oracle Support password>,
    <Service Request (SR) number - required if no CSI given>,
    <Customer Support Identifier (CSI) - required if no SR number given>
    

    For example:

    /HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,,username,2cool,,FAadmin,fusionfa1,,,,,,GENERIC@oracle.com,,3-6586541801
    /HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,HOST_CREDS,,,WLS_CREDS,,,false,false,false,true,true,GENERIC@oracle.com,,,15427437
    /HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,,,,,,,,false,,,true,GENERIC@oracle.com,,3-6586541801
    

    Note the following points about the format of incident_packaging_file:

    • The delimiter used is a comma ( , ).

    • The order of parameters is fixed. You must provide the parameters in the same order as specified above in the sample file structure.

    • Delimiters must be present even if the corresponding parameter is not provided.

    • If you want to use a comma in one of the parameters provided, you must escape the comma with a backslash, as shown in the following example in which the password has a comma:

      /HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,,username,2cool,,FAadmin,fusion\,fa1,,,,,,GENERIC@oracle.com,,3-6586541801
      
    • If you want to use a backslash in one of the parameters provided, you must escape the backslash with a backslash, as shown in the following example in which the password has a comma:

      /HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,,username,2cool,,FAadmin,fusion\ \fa1,,,,,,GENERIC@oracle.com,,3-6586541801
      

      For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=heap_dumps_file

    Fully qualified path to a CSV formatted file containing multiple lines of fully qualified paths to heap dump files to be included in the package. The files whose locations are provided in the file are added as heap dumps to the package.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=db_awr_file

    Fully-qualified path to a CSV formatted file containing multiple lines of databases and the credentials used to generate reports for the package. The AWR reports generated by the databases provided in the file are added to the package, assuming that the credentials, if needed, are provided and valid.

    The structure of the CSV file is as follows:

    <Database name as used in EM>,
    <credential name - for using named credential only>,
    <username - for using new credential only>,
    <password - for using new credential only>,
    <role - optional, for using new credential only>
    

    For example:

    Oemrep_database (preferred credentials set in Enterprise Manager)
    Oemrep_database,MY_DB_CREDS
    Oemrep_database,,sysman,sysman
    Oemrep_database,,sysman,sysman,normal
    

    Note the following points about the format of db_awr_file:

    • The delimiter used is a comma ( , ).

    • The order of parameters is fixed. You must provide the parameters in the same order as specified above in the sample file structure.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

Examples

Example 1

The following example shows a fully-qualified path to a CSV formatted file containing one line of details for the Fusion Applications problem to be packaged.

/HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,,username,2cool,,FAadmin,fusionfa1,,,,,,GENERIC@oracle.com,, 3-6586541801
/HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,HOST_CREDS,,, WLS_CREDS,,,false,false,false,true,true,GENERIC@oracle.com,,,15427437
/HCMDomain/Server_1/SetupApp,fusion_apps_j2ee_app,Other-1,,,,,,,,false,,,true,GENERIC@oracle.com,,3-6586541801

Example 2

The following example shows a fully-qualified path to a CSV formatted file containing multiple lines of databases and the credentials used to generate reports for the package.

Oemrep_database (preferred credentials set in Enterprise Manager)
Oemrep_database,MY_DB_CREDS
Oemrep_database,,sysman,sysman
Oemrep_database,,sysman,sysman,normal

provision

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

Format

emcli provision
      -image="path_to_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"]

[ ] indicates that the parameter is optional

Parameters

  • image

    Path to the image (includes the image name). This is the image used for provisioning.

  • network

    Path name of the network profile.

  • bootserver

    Name of the boot server.

    Format: hostName:Directory Path

  • stageserver

    Name of the stage server. hostName:Directory Path.

  • Stgcredentials

    User name of the stage server.

  • schedule

    Time when provisioning should be scheduled. This is a string argument that contains multiple name-value pairs separated by `;'. This is used to schedule the provisioning operation. "type" can be `immediate' or `onetime'. If "type" is not immediate, the other values are expected in the Time Zone: string, which is a timezone ID of the format:

    zone Sign TwoDigitHours:Minutes

    zone: Time zone ID (GMT, PDT, and so forth)

    Sign: one of "+ -"

    TwoDigitHours: Digit Digit

    Minutes: Digit Digit

    Digit: One of 0 1 2 3 4 5 6 7 8 9

    Startdt: Date string of the format: MM/DD/YY

    Starttm: Time string of the format: HH:MM

  • resettimeout

    Reset timeout for the hardware server in minutes.

  • target

    Target hardware server is specified using the hardware label type.

  • input_file

    File containing configuration properties.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • assignment

    Name of the assignment.

  • desc

    Assignment description. The description is automatically generated if not specified.

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"

publish_change_request_ccc

Sends change request data to the Change Management Connector, and data processed into the Configuration Change Console. Some of the properties (such as connector_guid, target, and facet) are to be specified as part of customization. All of the data should be able to be mapped to the data required in publishChangeRequest.xsd after XSLT.

Format

emcli publish_change_request_ccc
    -connector_guid="ConnectorGUID"
    -change_id="change_ID" 
    -last_modified_date="last_modified_date"
    -properties_list="list_of_Change_Management_specific_properties"
    -date_format="Date_format_in_Change_Management_System"

Parameters

  • connector_guid

  • change_id

  • last_modified_date

  • properties_list

    Specify all relevant properties of the Change Management System required for CCC to process a change request.

    The properties are name,value pairs to be specified as prop_name1=value1;prop_name2=value2 with no quotes for values.

    prop_name and values cannot contain the equals sign (=) or semi-colons (;).

  • date_format

    Specify a date format in the Change Management System:

    MM/dd/yyyy hh:mm:ss if the date field in change management is "09/14/2011 5:38:24 AM"


publish_event

Publishes a user-reported event to Enterprise Manager. This event is published as an event of the "User-reported event" class. Only users with Manage Target privilege can publish these events for a target. An error message is reported if the publish fails.

After an event is published with a severity other than CLEAR (see below), end-users with appropriate privileges can manually clear the event from the user interface, or you can publish a new event using a severity level of CLEAR and the same details to report clearing of the underlying situation.

Format

emcli publish_event
        -target_name="target_name"
        -target_type="target_type_internal_name"
        -message="message_for_event"
        -severity="severity_level"
        -name="event_name"
        [-key="sub_component_name"
        [-context="name1=value1;name2=value2;.."]
        [-separator=context="alt._pair_separator"]
        [-subseparator=context="alt._name-value_separator"]

[ ] indicates that the parameter is optional

Parameters

  • target_name

    Target name.

  • target_type

    Target type name.

  • message

    Message to associate for the event. The message cannot exceed 4000 characters.

  • severity

    Numeric severity level to associate for the event. The supported values for severity level are as follows:

    "CLEAR"
    "MINOR_WARNING"
    "WARNING"
    "CRITICAL"
    "FATAL"
  • name

    Name of the event to publish. The event name cannot exceed 128 characters.

    This is indicative of the nature of the event. Examples include "Disk Used Percentage," "Process Down," "Number of Queues," and so on. The name must be repeated and identical when reporting different severities for the same sequence of events. This should not have any identifying information about a specific event; for example, "Process xyz is down." To identify any specific components within a target that the event is about, see the key below.

  • key

    Name of the sub-component within a target this event is related to. Examples include a disk name on a host, name of a tablespace, and so forth. The key cannot exceed 256 characters.

  • context

    Additional context that can be published for a given event. This is a series of strings of format name:value separated by a semi-colon. For example, it might be useful to report the percentage size of a disk when reporting space issues on the disk. You can override the default separator ":" by using the subseperator , and the pair separator ";" by using the separator .

    The context names cannot exceed 256 characters, and the values cannot exceed 4000 characters.

  • separator

    Set to override the default ";" separator. You typically use this option when the name or the value contains ";". Using "=" is not supported for this option.

  • subseparator

    Set to override the default ":" separator between the name-value pairs. You typically use this option when the name or value contains ":". Using "=" is not supported for this .

Examples

Example 1

The following example publishes a warning event for "my acme target" indicating that a HDD restore failed, and the failure related to a component called the "Finance DB machine" on this target.

emcli publish_event  -target_name="my acme target" -target_type="oracle_acme" 
-name="HDD restore failed" -key="Finance DB machine" -message="HDD restoration
failed due to corrupt disk" -severity=WARNING

Example 2

The following example publishes a minor warning event for "my acme target" indicating that a HDD restore failed, and the failure related to a component called the "Finance DB machine" on this target. It specifies additional context indicating the related disk size and name using the default separators. Note the escaping of the \ in the disk name using an additional "\".

emcli publish_event  -target_name="my acme target" -target_type="oracle_acme" 
-name="HDD restore failed" -key="Finance DB machine" -message="HDD restoration
failed due to corrupt disk" -severity=MINOR_WARNING -context="disk size":800GB\;"disk name":\\uddo0111245

Example 3

The following example publishes a critical event for "my acme target" indicating that a HDD restore failed, and the failure was related to a component called the "Finance DB machine" on this target. It specifies additional context indicating the related disk size and name. It uses alternate separators, because the name of the disk includes the ":" default separator.


emcli publish_event  -target_name="my acme target" -target_type="oracle_acme" 
-name="HDD restore failed" -key="Finance DB machine" -message="HDD restoration
failed due to corrupt disk" -severity=CRITICAL -context="disk size"^800GB\;"disk name"^\\sdd1245:2 -subseparator=context=^

publish_metric_extension

Publishes a metric extension for use by all administrators. The metric extension must currently be a deployable draft.

Format

emcli publish_metric_extension
       -target_type=<metric_extension_target_type>
       -name=<metric_extension_name>
       -version=<metric_extension_version>

Parameters

  • target_type

    Target type of the metric extension.

  • name

    Name of the metric extension.

  • version

    Version of the metric extension to be published.

Example

The following example publishes a metric extension of a given target type, name, and version.

emcli publish_metric_extension -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension>

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
       -target_type=database target type
       [-parameters=name1:value1;name2:value2;...]
       [-credential_name=credential_name]
       [-input_file=parameter_tag:file_path]

[ ] indicates that the parameter is optional

Parameters

  • definition_name

    Masking definition name.

  • target_name

    New database target name with which to associate the masking definition.

  • target_type

    New database target type with which to associate the masking definition.

  • parameters

    List of name-value pairs that represent the credentials required for connecting to the database instance. The supported parameters are db_username, db_password, and db_role.

  • credential_name

    Name of the database credential. This parameter is mandatory when the db_username and db_password parameters are not specified.

  • input_file

    Used in conjunction with the parameters option, this option enables you to store parameter values, such as username and password, in a separate file. This option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific parameter values for the parameters . The tag must not contain colons ( : ) or semi-colons ( ; ).

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

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

refer_swlib_entity_files

Refers one or more files from an entity revision in the software library.

Format

emcli refer_swlib_entity_files 
        -entity_rev_id="entity_rev_id" 
        -file="<relative_file_path>[;<new_file_name>]" | [-removefile="<existing_            file_name>"] 
        -refer_storage="<storage_location_name>;<storage_type>" 
        [-use_latest_revision]

[ ] indicates that the parameter is optional

Parameters

  • entity_rev_id

    Identifier of the entity revision. The Software Library home page exposes the identifier for folders and entities as a custom column (Internal ID) and is hidden by default.

  • file

    Relative path of the file to be referred from the specified storage location. The file name stored in the software library is defaulted to the name of the file being referred. You can optionally specify a different file name, separated by a semi-colon ( ; ).

  • removefile

    Name of the file to be removed. This is an existing file carried forward from the specified entity revision.Alternatively, you can specify the following values:

    ALL — Remove all existing files (no carry forward).
    NONE — Retain all carried forward files.
    
    

    The default is NONE.

  • refer_storage

    The storage location and type for referring to files, separated by a semi-colon ( ; ). The location specified must be in 'active' status. The storage type can be Http, Nfs, or ExtAgent.

  • use_latest_revision

    Indicates that the latest revision of the entity be used instead of the revision identified by entity_rev_id.

Example

The following example refers the file 'scripts/perl/script1.pl' in the HTTP reference file location 'myScripts' from the entity revision identified. The file name associated will be 'new_script.pl'. The identifier of the updated revision is output.

emcli refer_swlib_entity_files 
        -entity_rev_id="oracle:defaultService:em:provisioning:1:cmp:          COMP_Component:SUB_Generic:B1B1880C6A8C62AAE040548C42832D14:0.1"
        -file="scripts/perl/script1.pl;new_script.pl"
        -refer_storage="myScripts;Http"
        -use_latest_revision

refresh_coherence

Refreshes one or more Coherence clusters.

Format

emcli refresh_coherence        -input_file=coherence_refresh_file:file_path        [-debug]

[ ] indicates that the parameter is optional

Parameters

Examples

The following example reads the my_clusters_name.csv file to determine the clusters to be refreshed to Cloud Control, and then refreshes them.

emcli refresh_coherence 
  -input_file=coherence_refresh_file:c:\emcli\my_clusters_names.csv 

refresh_wls

Enables/disables a refresh for one or more Oracle WebLogic Server Domains (target type --> weblogic_domain). This verb reads a file labeled domain_refresh_file in order to refresh the WebLogic Server. The domain_refresh_file is required; refresh cannot occur without it. You must create the file prior to performing refresh.

Format

emcli refresh_wls
        -input_file=domain_refresh_file:file_path
        [-debug]

[ ] indicates that the parameter is optional

Parameters

  • input_file

    Fully-qualified path of the CSV(Comma-Separated Values) file that contains multiple lines of the Target name and Refresh action (Enable/Disable refresh of the WLS domains/farms to be refreshed).

    Note the following advisory information about the format of domain_refresh_file:

    • The target name should be the fully-qualified name of the domain target.

    • Every target is treated as type weblogic_domain.

    • Valid values of the refresh option are "E", "D", and "R". "E" enables a refresh for the WLS Domain, "D" disables the refresh for the WLS Domain, and "R" removes targets that are deleted from the WebLogic Domain.

    • A comma ( , ) is used as the delimiter.

    • The total number of tokens in each line is fixed, and should be equal to 2.

    • The order of parameters is fixed. You must provide the parameters in the same order as specified below in the sample file structure for domain_refresh_file:

         /Farm01_base_domain/base_domain,D
              /Farm02_base_domain/base_domain,E
              /Farm03_base_domain/base_domain,R
      

      The first entry disables the refresh for target /Farm01_base_domain/base_domain, the second entry enables a refresh for target /Farm02_base_domain/base_domain, and the third entry removes targets from Enterprise Manager that are deleted from /Farm03_base_domain/base_domain.

      For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • debug

    Runs the verb in verbose mode for debugging purposes.

Example

$emcli refresh_wls 
          -input_file=domain_refresh_file:/tmp/refresh/emcli/              domain_refresh_file.csv -debug

reimport_swlib_metadata

Re-imports software library metadata from the OMS and deployed plug-in Oracle Homes. Any Oracle-owned entity with missing files is restored to the corresponding upload storage location.

Format

emcli reimport_swlib_metadata 

Parameters

None.


relocate_targets

Moves all of the collections and blackouts for targets from the source Agent to the destination Agent, and makes the destination Agent the monitoring Agent for these targets in Enterprise Manager.

Format

emcli relocate_targets 
       -src_agent=<source_agent_target_name>
       -dest_agent=<dest_agent_target_name>
       -target_name=<name_of_target_to_be_relocated>
       -target_type=<type_of_target_to_be_relocated>
       -copy_from_src
       -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>]*
       [-ignoreRelatedTargets]
       [-noHostColumnUpdate]
       [-ignoreTimeSkew=yes]
       [-force=yes]

[ ] indicates that the parameter is optional

Note:

To relocate a composite target, you must specify the input_file:dupTargets , and you cannot combine -target_type or -target_name.

Modes

There are two modes for this verb:

  • Create Mode

    This mode creates a list of targets on the destination Management Agent that already exists and is monitored by the source Management Agent in Enterprise Manager. It moves all the collections and blackouts for these targets from the source Management Agent to the destination Management Agent, and makes the destination Agent the monitoring Agent for these targets in Enterprise Manager.

    emcli relocate_targets -src_agent=<source_agent>
          -dest_agent=<destination_agent>
          -input_file=dupTarget:<complete_path_to_file>;
          [-ignoreTimeSkew=yes]
    

    Tip:

    See the Examples section for more samples of the create mode.
  • Exist Mode

    In this mode, the target also exists at the destination.

    emcli relocate_targets
          -src_agent=<source_agent_target_name>
          -dest_agent=<destination_agent_target_name>
          -target_name=<target_name>
          -target_type=<target_type>
          [-ignoreTimeSkew=yes]
          [-force=yes]
    

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.

Parameters

  • src_agent

    Management Agent currently monitoring the targets. If srcAgent is not known, enter currentOwner as the argument.

  • dest_agent

    Management Agent that should monitor the targets.

  • target_name

    Name of the target that needs to be moved.

  • target_type

    Type of target that needs to be moved.

  • changed_param

    The value of the propName property in the target should be changed to propValue.

  • input_file=dupTargets

    Takes a file name that contains all the targets and its properties as seen in targets.xml. The contents of the file must have the same format as targets.xml.

    To relocate a composite target, you must specify the input_file:dupTargets, and you cannot combine -target_type or -target_name.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • input_file=moveTargets

    Takes a file name that contains a list of targets, one per line, in the following format:

    <targetType>:<targetName>[;<propName>=<propValue>]*
    ;lkj;lkj;lkj
    

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • copy_from_src

    Copies target properties from the source Agent.

  • ignoreTimeSkew

    If specified, the target is relocated, ignoring the time skew between the source and destination Agent.

  • ignoreRelatedTargets

    Moves related targets when not specified. Specified to move onlhy the targets on the command line.

  • noHostColumnUpdate

    Preserves the host of the relocated tartet when specified. Otherwise, the host is updated to be the new Agent's host.

  • force

    If the command is executed with the -force=yes switch, the composite target is automatically relocated with its related targets. If the command is executed without this switch, an error message appears if it is a composite target.

Output

Output message of the command execution.

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]

Example 3

The following example creates a list of targets on the destination Agent that already exists and is monitored by the source Agent in Enterprise Manager.

emcli relocate_targets 
        -src_agent=<source agent>
        -dest_agent=<destination agent>
        {-ignoreTimeSkew=yes}
        -input_file=dupTarget:<complete file path>;

Example 4

The following exampole 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
        {-ignoreRelatedTargets}
        {-noHostColumnUpdate}
        {-ignoreTimeSkew=yes}
        [-changed_param=<Propname>:<Value>]*

Example 5

The following 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>
        {-ignoreTimeSkew=yes}
        -input_file=moveTargets:<complete file path>;

remove_beacon

Removes a beacon from the monitoring set of beacons.

Format

emcli remove_beacon
      -name=<target_name>
      -type=<target_type>
      -bcnName=<beacon_name>

[ ] indicates that the parameter is optional

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • bcnName

    Beacon name to remove.

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_chargeback_entity

Removes the given entity from Chargeback.

Format

remove_chargeback_entity 
     -entity_name="eName" 
     -entity_type="eType" 
     -[ entity_guid="entity guid" ] 

[ ] indicates that the parameter is optional

Parameters

  • entity_name

    Name of the entity to be removed from Chargeback.

  • entity_type

    Type of entity to be removed from Chargeback.

  • entity_guid

    guid of the entity to be removed to Chargeback.

    When more than one entity is active in Chargeback with the given entity name and entity type, the command lists all such entities with additional details such as creation date, parent entity name, entity guid, and so forth to choose the correct entity. Select the correct entity from the given list and execute the command again with entity guid as the parameter instead of entity name and entity type.

Examples

The following example removes "db1", an oracle_database entity, from Chargeback.

emcli remove_chargeback_entity -entity_name="db1" -entity_type="oracle_database" 

See Also


add_chargeback_entity
assign_charge_plan
assign_cost_center
list_chargeback_entities
list_chargeback_entity_types
list_charge_plans
list_cost_centers
unassign_charge_plan
unassign_cost_center

remove_service_system_assoc

Removes the system for a given service.

Format

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

Parameters

  • name

    Service name.

  • type

    Service type.

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_swlib_storage_location

Removes a storage location from the software library. The alternate storage location where the existing files need to be migrated should also be specified. For upload file storage types, OMS shared and the OMS Agent file system, a job is submitted to perform the migration of files, subsequent to which the location is removed. For these upload file storage types, the alternate location need not be of the same storage type, which is not the case for locations of referenced file storage types.

Format

emcli remove_swlib_storage_location 
        -name="src_location_name" 
        -type="OmsShared|OmsAgent|Http|Nfs|ExtAgent" 
        -migrate_to_loc="dest_location_name" 
        [-migrate_to_type="OmsShared|OmsAgent|Http|Nfs|ExtAgent"] 

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the storage location to be removed.

  • type

    Type of storage location, which can be one of:

    OmsShared
    OmsAgent
    Http
    Nfs
    ExtAgent
    
  • migrate_to_loc

    Name of the alternate storage location where existing files need to be migrated.

  • migrate_to_type

    Type of the alternate storage location, which can be one of:

    OmsShared
    OmsAgent
    Http
    Nfs
    ExtAgent
    

    The default is the storage type of the location being removed.

    Note:

    This option can be different from the type option specified only for OmsShared and OmsAgent storage types. For all other storage types, migrating files across storage types is not supported, and therefore, type and migrate_to_type (if specified) must be the same.

Examples

Example 1

The following example removes an OMS shared file system storage location named 'myOMSSharedLocation' and migrates all of its files to another OMS shared file system storage location named 'myNewOMSSharedLocation'. A job is submitted for performing the file migration. The location being removed will be moved to 'Inactive' status during file migration and subsequently removed.

emcli remove_swlib_storage_location 
        -name="myOMSSharedLocation" 
        -type="OmsShared"
        -migrate_to_loc="myNewOMSSharedLocation" 

Example 2

The following example removes an OMS shared file system storage location named 'myOMSSharedLocation' and migrates all of its files to an OMS Agent file system storage location named 'myNewAGTLocation'. A job is submitted for performing the file migration. The location being removed will be moved to 'Inactive' status during file migration and subsequently removed.

emcli remove_swlib_storage_location         -name="myOMSSharedLocation"         -type="OmsShared"        -migrate_to_loc="myNewAGTLocation"         -migrate_to_type="OmsAgent" 

Example 3

The following example removes an HTTP storage location named 'myHTTPLocation' and migrates all of its files to another HTTP storage location named 'myNewHTTPLocation'.

emcli remove_swlib_storage_location 
        -name="myHTTPLocation" 
        -type="Http"
        -migrate_to_loc="myNewHTTPLocation" 

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"

Parameters

  • target_type

    Target type for which you want to remove this property. To remove this property from all target types for which it is defined, you can specify the "*" wildcard character.

  • property

    Name of the property you want to remove. Property names are case-sensitive. You cannot remove the following Oracle-provided target properties:

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

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"

remove_update

Removes an update.

Format

emcli remove_update 
        -id="internal id" 

Parameters

  • id

    Internal identification for the update to be removed.

Examples

The following example submits a job to remove the update, and prints the job execution ID upon submission.

emcli remove_update 
      -id="914E3E0F9DB98DECE040E80A2C5233EB" 

rename_target

Renames the repository-side target.

Format

emcli rename_target
      -target_type=<type1>
      -target_name=<old_target1>
      -new_target_name=<new_target1>

Parameters

  • target_type

    Target type of the target being renamed.

  • target_name

    Existing name of the target.

  • new_target_name

    New name of the target.

Examples

The following example renames the repository-side target.

emcli rename_target 
      -target_type="oracle_em_service"
      -target_name="TestService1"
      -new_target_name="NewTestService1"

reschedule_instance

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

Format

emcli reshedule_instance
      -instance=<instance_guid>
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>]
      -schedule=
          start_time:yyyy/MM/dd HH:mm;
          [tz:<java_timezone_ID>];
          [grace_period:xxx]

[ ] indicates that the parameter is optional

Parameters

  • instance

    GUID of the instance to execute.

  • exec

    Execution GUID.

  • name

    Execution name.

  • owner

    Execution owner.

  • schedule

    Schedule for the procedure instance:

    • start_time — When the procedure should start.

    • tz — Optional time zone ID.

    • grace_period — Optional grace period in minutes.

Examples

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

resecure_agent

Resecures a Management Agent already secured. This verb requires operator privilege or full privilege on the Management Agent.

Format

emcli resecure_agent
        -agent_name="agent_target_name"
        -registration_pwd="registration_password"
        [-host_username="agent_host_username" -host_pwd="agent_host_password"]
        [-credential_name="credential_name"]
        [-credential_setname="credential_setname_of_agent"]

[ ] indicates that the parameter is optional

Parameters

  • agent_name

    Name of the Management Agent target.

  • registration

    Registration password to securely communicate with OMS.

  • host_username

    User name of the OS user (on the host) who owns the Management Agent.

  • host_pwd

    Password of the OS user (on the host) who owns the Management Agent.

  • credential_name

    Name of the saved credential.

  • credential_setname

    Name of the credential set of the Management Agent. Example: "HostCreds".

Examples

Example 1

emcli resecure_agent -agent_name="agent.example.com:1234"
                           -registration_pwd="test_pwd"
                           -host_username="test_user"
                           -host_pwd="test"

Example 2

emcli resecure_agent -agent_name="agent.example.com:1234"
                           -registration_pwd="test_pwd"
                           -credential_name="MyMachineCredential"

Example 3

emcli resecure_agent -agent_name="agent.example.com:1234"
                           -registration_pwd="test_pwd"
                           -credential_setname="HostCreds"

restart_agent

Restarts a Management Agent. This verb requires operator privilege or full privilege on the Management Agent.

Format

emcli restart_agent
        -agent_name="agent_target_name"
        [-host_username="agent_host_username" -host_pwd="agent_host_password"]
        [-credential_name="credential_name"]
        [-credential_setname="credential_setname_of_agent"]

[ ] indicates that the parameter is optional

Parameters

  • agent_name

    Name of the Management Agent target.

  • host_username

    User name of the OS user (on the host) who owns the Management Agent.

  • host_pwd

    Password of the OS user (on the host) who owns the Management Agent.

  • credential_name

    Name of the saved credential.

  • credential_setname

    Name of the credential set of the Management Agent. Example: "HostCreds".

Examples

Example 1

emcli restart_agent -agent_name="agent.example.com:1234"
                           -host_username="test_user"
                           -host_pwd="test"

Example 2

emcli restart_agent -agent_name="agent.example.com:1234"
                           -credential_name="MyMachineCredential"

Example 3

emcli restart_agent -agent_name="agent.example.com:1234"
                           -credential_setname="HostCreds"

resume_instance

Resumes a suspended deployment instance.

Format

emcli resume_instance
      -instance=<instance_guid>
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    GUID of the instance.

  • exec

    GUID of the execution.

  • name

    Name of the execution.

  • owner

    Owner of the execution.

Examples

emcli resume_instance -instance=16B15CB29C3F9E6CE040578C96093F61

resume_job

Resumes a job or set of jobs. Resumes job executions on any of the targets scheduled to start within the beginning and ending time window.

Note:

Suspend and resume operate either at the job or the execution level, but not both. If job executions were previously suspended, they must be resumed by execution matching. If a job was suspended, it must be resumed by job matching; it is not be possible to resume it by executions.

Format

emcli resume_job
   [-name="job_name_pattern"]
   [-owner="job_owner"]
   [-type="job_type"]
   [-targets="target_name:target_type"]
   [-input_file=property_file:"filename"]
   [-preview]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name or pattern of the job(s) to resume.

  • owner

    Owner of the job(s).

  • type

    Job type of the job(s).

  • targets

    Target name and target type of the job(s).

  • input_file

    Specify the filtering properties of the file in "filename."

    Any jobs matching all the specified filter criteria are resumed. You must specify at least one filter, and the logged in administrator must have the necessary privileges on the matching jobs.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • preview

    Only lists the jobs that would be resumed.

Examples

Example 1

The following example resumes a job named MYJOB.

emcli resume_job -name=MyJob

Example 2

The following example resumes all jobs owned by User1.

emcli resume_job -owner=User1

Example 3

The following example resumes all jobs of type Backup whose name starts with BK.

emcli resume_job -name=BK% -type=Backup

Example 4

The following example resumes all jobs on db target orcl_123.

emcli resume_job -targets=orcl_123:oracle_database

Example 5

The following example resumes jobs or job executions matching search criteria in suspend_prop.txt.

resume_job -input_file=property_file:/tmp/suspend_prop.txt

If the same file is used for both suspend and for resume, the set of jobs or executions resumed should overlap, but might not be identical. The criteria may match more or fewer jobs or executions than previously.


retry_add_host

Retries a failed add host session.

Format

emcli retry_add_host
        -session_name="session_name"
        -retry_using_same_inputs | -update_inputs_and_retry"
        [-host_names="host_names"]
        [-platform="platform_id"]
        [-installation_base_directory="installation_base_directory"]
        [-credential_name="credential_name"]
        [-credential_owner="credential_owner"]
        [-instance_directory="instance_directory"]
        [-port="agent_port"]
        [-deployment_type="type_of_agent_deployment"]
        [-privilege_delegation_setting="privilege_delegation_setting"]
        [-additional_parameters="parameter1 parameter2 ..."]
        [-source_agent="source_agent"]
        [-master_agent="master_agent"]
        [-preinstallation_script="preinstallation_script"]
        [-preinstallation_script_on_oms]
        [-preinstallation_script_run_as_root]
        [-postinstallation_script="postinstallation_script"]
        [-postinstallation_script_on_oms]
        [-postinstallation_script_run_as_root]
        [-wait_for_completion]

[ ] indicates that the parameter is optional

Parameters

  • session_name

    Name of the session you want to retry.

  • retry_using _same_inputs

    Retries the Add Host session using the same inputs.

  • update_inputs_and_retry

    Updates the inputs and retries the Add Host session.

  • host_names

    Names of the hosts where the Agents need to be installed, separated by a semicolon.

  • platform

    ARU platform ID of the hosts where the Agent needs to be installed.

  • installation_base_directory

    Directory where you want to install the Agent. Provide this parameter in double-quotes if it is an MS-DOS/Windows style path.

  • credential_name

    Named credential to be used for installing the Agent.

  • credential_owner

    Owner of the named credential.

  • instance_directory

    Instance directory of the Agent. Provide this parameter in double-quotes if it is an MS-DOS/Windows style path.

  • port

    Port on which the Agent should communicate with the OMS.

  • deployment_type

    Type of Agent deployment, which can be FRESH, CLONE, or SHARED. By default, it is the deployment type of the failed session you want to retry.

  • privilege_delegation_setting

    Privilege delegation setting you want to use for installing an Agent and running the root script.

  • additional_parameters

    Additional parameters you want to use for installing an Agent.

  • source_agent

    Source Agent you want to use for installing a cloned Agent.

  • master_agent

    Master Agent you want to use for installing a shared Agent.

  • preinstallation_script

    Script you want to run before installing the Agent. Provide this parameter in double-quotes if it is an MS-DOS/Windows style path.

  • preinstallation_script_run_as_root

    Use this option if you want to run the pre-installation script as the root user.

  • preinstallation_script_on_oms

    Use this option if the pre-installation script resides on the OMS host.

  • postinstallation_script

    Script you want to run after installing the Agent. Provide this parameter in double-quotes if it is an MS-DOS/Windows style path.

  • postinstallation_script_on_oms

    Use this option if the post-installation script resides on the OMS host.

  • postinstallation_script_run_as_root

    Use this option if you want to run the post-installation script as the root user.

  • wait_for_completion

    Runs the Add Host operation synchronously.

Examples

Example 1

The following example retries the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' using the same inputs.

emcli retry_add_host session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -retry_using_same_inputs

Example 2

The following example retries the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' by updating the input port to 5678.

emcli retry_add_host session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -update_inputs_and_retry -port=5678

retry_instance

Retries a failed instance or failed step.

Format

emcli retry_instance       [-instance=<instance_guid>]
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>]
      [-stateguid=<state_guid>]

[ ] indicates that the parameter is optional

Parameters

  • instance

    GUID of the instance.

  • exec

    GUID of the execution.

  • name

    Name of the execution.

  • owner

    Owner of the execution.

  • stateguid

    Comma-separated list of state GUIDs.

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

[ ] indicates that the parameter is optional

Parameters

  • exec_id

    ID of the job execution to be retried. Use the get_jobs verb to obtain specific job execution IDs.

  • noheader

    Displays tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

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_bipublisher_roles

Revokes roles for accessing the BI Publisher catalog.

Format

emcli revoke_bipublisher_roles 
      (-roles="role1[;role2;...role_n]" 
      [-users="user"] 
      [-external_role="group"]) 

[ ] indicates that the parameter is optional

Parameters

  • roles

    Revokes one or more roles from the BI Publisher. Specify one or more roles separated by a semicolon.

  • users

    Users to revoke the granted role.

  • external_role

    Name of the external group to apply the revocation.

Examples

Example 1

The following example revokes one role from a group.

emcli revoke_bipublisher_roles -roles="EMBIPViewer" -external_role="TESTGROUPNAME"

Example 2

The following example revokes more than one role from a group.

emcli revoke_bipublisher_roles -roles="EMBIPViewer;EMBIPAuthor" 
      -external_role="TESTGROUPNAME"

Example 3

The following example revokes one role from a user.

emcli revoke_bipublisher_roles -roles="EMBIPViewer" 
      -users="TESTUSERNAME"

Example 4

The following example revokes one role from multiple users.

emcli revoke_bipublisher_roles -roles="EMBIPViewer" 
      -users="TESTUSERNAME;TESTUSERNAME2" 

Example 5

The following example revokes more than one role from multiple users and a group.

emcli revoke_bipublisher_roles -roles="EMBIPViewer;EMBIPAuthor" 
      -external_role="TESTGROUPNAME" 
      -users="TESTUSERNAME;TESTUSERNAME2

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]

[ ] indicates that the parameter is optional

Parameters

  • type

    Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".

  • targets

    Targets should be specified in the following sequence:

    TargetName1;TargetName2;
    

    For example:

    -targets="database1;database2;database3;"
    

    The semi-colon ( ; ) is the target separator.

    See the "Examples" section below for information about providing arguments for the targets .

  • packs

    License packs should be specified in the following sequence:

    pack1;pack2;
    

    For example:

    -packs="db_diag;db_config;"
    

    The semi-colon ( ; ) is the pack separator.

    See the "Examples" section below for information about providing arguments for the pack .

  • file

    Specify the file name, including the complete path. For example:

    -file="/usr/admin1/db_license.txt"
    

    The file should contain the list of targets and packs according to the following cases:

    • If you only need to provide a list of targets, use the following format:

      targets=database1;database2;database3;
      
    • If you only need to provide a list of packs, use the following format:

      packs=db_diag;db_config;
      
    • If you need to provide a list of both targets and packs, use the following format:

       targets=database1;database2;database3; packs=db_diag;db_config;
      
  • displayAllMessages

    Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the command line.

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]

[ ] indicates that the parameter is optional

Parameters

  • type

    Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".

  • targets

    Targets should be specified in the following sequence:

    TargetName1;TargetName2;
    

    For example:

    -targets="database1;database2;database3;"
    

    The semi-colon ( ; ) is the target separator.

    See the "Examples" section below for information about providing arguments for the targets .

  • packs

    License packs should be specified in the following sequence:

    pack1;pack2;
    

    For example:

    -packs="db_diag;db_config;"
    

    The semi-colon ( ; ) is the pack separator.

    See the "Examples" section below for information about providing arguments for the packs.

  • file

    Specify the file name, including the complete path. For example:

    -file="/usr/admin1/db_license.txt"
    

    The file should contain the list of targets and packs according to the following cases:

    • If you only need to provide a list of targets, use the following format:

      targets=database1;database2;database3;
      
    • If you only need to provide a list of packs, use the following format:

      packs=db_diag;db_config;
      
    • If you need to provide a list of both targets and packs, use the following format:

       targets=database1;database2;database3; packs=db_diag;db_config;
      
  • displayAllMessages

    Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the command line.

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"
        [-privilege="name[;secure-resource-details]]"
        [-separator=privilege="sep_string"]
        [-subseparator=privilege="subsep_string"]

[ ] indicates that the parameter is optional

Parameters

  • name

    User name or role name from which privileges will be revoked.

  • privilege

    Privilege to grant to this administrator. You can specify this option more than once. The original administrator privileges will be revoked. Specify <secure_resource_details> as:

    resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
    
  • separator

    Specify a string delimiter to use between name-value pairs for the value of the -privilege option. The default separator delimiter is a semi-colon ( ; ).

  • subseparator

    Specify a string delimiter to use between name and value in each name-value pair for the value of the -privilege option. The default subseparator delimiter is a colon ( : ).

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 Enterprise Manager role Role1:

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

revoke_roles

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

Format

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

[ ] indicates that the parameter is optional

Parameters

  • name

    User name or role name from which roles will be revoked.

  • roles

    Roles, which will be revoked from the Enterprise Manager user or role. You can specify this option more than once.

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>

Parameters

  • name

    Service target name.

  • type

    Service target type.

Examples

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

run_prechecks

Submits the pre-check operation for any given operation plan.

Format

emcli run_prechecks
      -operation_plan=<operation_plan_name>

Parameters

  • operation_plan

    Name of the operation plan.

Examples

emcli run_prechecks
      -operation_plan="BISystem1-switchover"

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>

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • promotedMetricName

    Promoted metric name.

  • promotedColumn

    Promoted metric type.

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]

[ ] indicates that the parameter is optional

Parameters

  • definition_name

    Masking definition name.

  • path

    Path for the file name to save the masking script. File name is automatically generated. The path and file options are mutually exclusive. Only an absolute path is allowed.

  • file

    File name to save the masking script. The file name must include the absolute path. Either the path or file option must be specified.

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

save_metric_extension_draft

Save a deployable draft of a metric extension. The metric extension must currently be in an editable state. Once saved as a draft, the metric extension is no longer editable.

Format

emcli save_metric_extension_draft
       -target_type=<metric_extension_target_type>
       -name=<metric_extension_name>
       -version=<metric_extension_version>

Parameters

  • target_type

    Target type of the metric extension.

  • name

    Name of the metric extension.

  • version

    Version of the metric extension to be saved to the draft.


save_procedure_input

Configures a deployment procedure for execution.

Format

emcli save_procedure_input
        [-name="procedure_configuration_name"]
        [-owner="procedure_configuration_owner"]
        [-procedure="procedure_guid"]
        -input_file="file_path\file_name"
        [-grants="access_levels_for_users"]
        [-schedule=
            start_time:yyyy/MM/dd HH:mm;
            tz:{java timezone ID};
            grace_period:xxx;
        ]
        [-notification="procedure status"]

[ ] indicates that the parameter is optional

Parameters

  • name

    Name of the configuration for the procedure.

  • owner

    Owner of the Procedure configuration.

  • procedure

    GUID of the procedure to execute.

  • input_file

    GUID of the procedure to execute. The file_path should point to a file containing the data property file.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • grants

    Specifies users and their corresponding access levels as a string of user:privilege pairs, each separated by a semi-colon ( ; ). The user is an Enterprise Manager user name, and the privilege is either VIEW_JOB or FULL_JOB.

    See the example below.

  • schedule

    Schedule for the deployment procedure. If not specified, the procedure is executed immediately.

    • start_time — When the procedure should start.

    • tz — Optional timezone ID.

    • grace_period — Optional grace period in minutes.

  • notification

    Status of the procedure.

Example

emcli save_procedure_input
    -name=configProcedure -procedure=16B15CB29C3F9E6CE040578C96093F61 
    -input_file=/home/data.properties -grants="user1:VIEW_JOB;user2:FULL_JOB"  
    -schedule="start_time:2011/8/21 21:23;tz:America/New_York;grace_period:60" 
    -notification="scheduled, action required, running"

search_patches

Searches patches from the ARU site or software library with the specified search criteria.

Format

emcli search_patches
        [-swlib] 
        [-patch_name="patch_name"] 
        [-product="product_id" [-include_all_products_in_family]] 
        [-release="release_id"] 
        [-platform="platform_id" | -language="language_id"]
        [-type="patch | patchset"] 
        [-noheader]
        [-script | -xml | -format=
                                  [name:<pretty|script|csv>];
                                  [column_separator:"column_sep_string"]; 
                                  [row_separator:"row_sep_string"];
        ] 

[ ] indicates that the parameter is optional

Parameters

  • swlib

    Searches patches in the software library if this parameter is provided, whether the current connection mode is online or offline.

  • patch_name

    Patch name, number, or Sun CR ID. This option is only valid in Simple Search mode. If you provide this option, the Simple Search mode is enabled. If the options specific to Advanced Search mode are provided along with this option, they will not take effect.

  • product

    Patch product/product family ID. Run the command "emcli list_aru_products" to search the product ID.

  • include_all_products_in_family

    Takes the specified product ID as a product family ID and includes all products in this product family while searching patches. This option is valid only when you provide the 'product' option.

  • release

    Patch release ID. Run the command "emcli list_aru_releases" to search for the release ID.

  • platform

    Patch platform ID. Run the command "emcli list_aru_platforms" to search for the platform ID.

  • language

    Patch language ID. Run the command "emcli list_aru_languages" to search for the language ID.

  • type

    Patch type.

  • noheader

    Displays tabular information without column headers.

  • script

    This option is equivalent to -format="name:script".

  • xml

    Displays the patch information in XML format.

  • format

    Format specification (default is -format="name:pretty").

    • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

    • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

    • format="name:csv" sets the column separator to a comma and the row separator to a newline.

    • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

    • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli search_patches -patch_name=6880880  -platform=226 -swlib 

emcli search_patches -patch_name=6880880  -platform=226 -language=0 -xml 

emcli search_patches -product=9480  -release=80102030  -platform=226 -type=patch -format=name:pretty

emcli search_patches -product=9480  -release=80102030 type=patch -xml 

emcli search_patches -product=9480  -release=80102030 -script

emcli search_patches -product=9480 -release=80102030 type=patchset -format=name:csv 

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
set_connection_mode
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

secure_agent

Secures an Agent.

Format

emcli secure_agent
        -agent_name="agent_target_name"
        -registration_pwd="registration_password"
        [-host_username ="agent_host_username" -host_pwd="agent_host_password"]
        [-credential_name ="credential_name"]
        [-credential_setname ="credential_setname_of_agent"]

[ ] incicates that the paramter is optional

Parameters

  • agent_name

    Name of the Agent target.

  • regustration_pwd

    Registration password to secure the communication with OMS.

  • host_username

    User name of the OS user (on the host) who owns the Agent.

  • host_pwd

    Password of the OS user (on the host) who owns the Agent.

  • credential_name

    Name of the saved credential.

  • credential_setname

    Name of the credential set of the Agent. Example: "HostCreds".

Examples

Example 1

emcli secure_agent -agent_name="agent.example.com:1234"
                   -registration_pwd="test_pwd"
                   -host_username="test_user"
                   -host_pwd="test"

Example 2

emcli secure_agent -agent_name="agent.example.com:1234"
                   -registration_pwd="test_pwd"
                   -credential_name="MyMachineCredential"

Example 3

emcli secure_agent -agent_name="agent.example.com:1234"
                   -registration_pwd="test_pwd"
                   -credential_setname="HostCreds"

secure_agents

Secures Agents by providing a list of Agent names, a group name, and input file. If a group name is provided, Enterprise Manager resolves this to a list of Agents that monitor targets in this group. You can also provide an Agent list with an input file to this EM CLI command. For all of these options, you must provide either a user name or password, or the user must have been configured with preferred credentials on Agent targets. This verb submits a job with the list of Agents and the credentials provided as input, and outputs the Job Name and Job ID that you can use to track the status of the job.

This verb also calculates the list of Agents to resecure by filtering out invalid Agents, Agents that are not secure, 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 CA, but you can disable this particular filter by using the -disable_ca_check option .

Format

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

[ ] incicates that the paramter is optional

Parameters

  • agt_names

    Semicolon-separated list of Agent names.

  • agt_names_file

    Absolute path of file containing list of Agent names, each on a new line.

  • group_name

    Identifies the list of Agents to secure. Enterprise Manager resolves the list of Agents that monitor (not just members of the group) the list of targets in the group.

  • use_pref_creds

    Uses preferred credentials configured for the Agent to execute the secureAgent job.

  • username

    User name to execute the secureAgent job at the Agent.

  • password

    User password to execute the secureAgent job at the Agent.

  • disable_ca_check

    Disables the check to verify if the Agents are secured with the latest CA.

Examples

emcli secure_agents -agt_names="agent_host1:1831;agent_host2:3872" -use_pref_creds

emcli secure_agents -agt_names="agent_host1:1831;agent_host2:3872" -username=oracleagt

emcli secure_agents -agt_names_file=/tmp/agents_list.txt -use_pref_creds

emcli secure_agents -agt_names_file=/tmp/agents_list.txt -username=oracleagt

set_agent_property

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

Format

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

[ ] indicates that the parameter is optional

Parameters

  • agent_name

    Name of the Management Agent target.

  • name

    Name of the Management Agent property you want to modify.

  • value

    New value for the Management Agent property.

  • new

    Denotes whether this is a new Agent property being added.

Examples

Example 1

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

Example 2

The following example sets the value of new property 'newprop' in emd.properties to 15.

emcli set_agent_property -agent_name="agent.example.com:1234"
         -name=newprop
         -value=15
         -new

set_availability

Changes the availability definition of a given service.

Format

  emcli set_availability        -name=<target_name>        -type=<target_type>        -availType=TESTS|SYSTEM|SUB_SERVICE        -availOp=and|or
        [-sysAvailType=SYSTEM_TARGET_DIRECTLY|SELECTED_COMPONENTS_OF_A_SYSTEM] 
        [-keycomponents=<'keycomp1name:keycomp1type;
          keycomp2name:keycomp2type;...'>]

Parameters

  • name

    Service target name.

  • type

    Service target type. Aggregate services target type are also supported. Use the get_targets verb to get the target type of a target.

  • availType

    Type of availability. Switches the availability to either test-based, system-based, or subservice-based. SUB_SERVICE is supported only for aggregate services.

  • availOp

    If and, it uses all key tests/components to decide availability.

    If or, it uses any key tests/components to decide availability.

  • sysAvailType

    Type of availability when the availType is system-based. Sets the availability to either SYSTEM_TARGET_DIRECTLY or SELECTED_COMPONENTS_OF_A_SYSTEM .

    • If availability is set to 'system target directly', the system associated with the service needs to define availability[status], systemname, and systemtype are required arguments.

    • If availability is set to 'selected components of a system', systemname, systemtype, and keycomponents are required arguments.

    • If availability is set to 'system target directly', and if availability[status] is not defined, the availability set is invalid. Therefore, the only option that can be set is 'selected components of a system'.

  • keycomponents

    Name-type pair (that is, keycomp_name:keycomp_type) list of key components in the system used for the service.

Examples

Example 1

The following example sets the availability of 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 service MyTarget to be based on any key-test.

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

Example 3

The following example sets the availability of service MyTarget to be based on any key components of a system.

emcli set_availability -name='MyTarget' -type='generic_service' 
                       -availType='system' -availOp='or'
                       -keycomponents='database:oracle_database; host1:host'

Example 4

The following example sets the availability of service MyTarget to be based on system targets availability.

emcli set_availability -name='MyTarget' -type='generic_service' 
                       -availType='system' -availOp='and'
                       -sysAvailType='system target directly' 
emcli set_availability -name='MyTarget' -type='generic_service' 
                       -availType='system' -availOp='and'
                       -sysAvailType='selected components of a system' 
                       -keycomponents='database:oracle_database; host1:host'
emcli set_availability -name='MyTarget' -type='generic_service' 
                       -availType='system' -availOp='or'
                       -sysAvailType='selected components of a system' 
                       -keycomponents='database:oracle_database; host1:host'

set_connection_mode

Sets the new MOS connection mode.

Format

emcli set_connection_mode 
        -mode="online | offline"

Examples

emcli set_connection_mode -mode="offline"

emcli set_connection_mode -mode="online" 

See Also


create_patch_plan
delete_patches
describe_patch_plan_input
get_connection_mode
get_patch_plan_data
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_patch_plans
search_patches
set_patch_plan_data
show_patch_plan
submit_patch_plan

upload_patches

Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:

http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB

set_credential

Sets preferred credentials for given users.

Note:

This command does not support the COLLECTION credential sets.

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]

[ ] indicates that the parameter is optional

Parameters

  • target_type

    Type of target. This must be "host" if the -oracle_homes parameter is specified.

  • target_name

    Name of the target. Omit this argument to set enterprise preferred credentials. This must be the host name if the -oracle_homes parameter is specified.

  • credential_set

    Credential set affected.

  • user

    Enterprise Manager user whose credentials are affected. If omitted, the current user's credentials are affected.

  • columns

    Name and new value of the column(s) to set. Every column of the credential set must be specified. Alternatively, a tag from the -input_file argument can be used so that the credential values are not seen on the command line. You can specify this argument more than once.

  • input_file

    Path of the file that has the -columns argument(s). This is used to hide passwords. Each path must be accompanied by a tag referenced in the -columns parameter. You can specify this option more than once.

    For more information about the input_file parameter, see Section 4.2, "-input_file, -separator, and -subseparator Syntax Guidelines".

  • oracle_homes

    Name of Oracle homes on the target host. Credentials will be added/updated for all specified homes.

    Note: The list of columns and the credential sets 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.

  • monitoring

    Flag indicating that credentials affected are monitoring credentials. If omitted, the credentials affected are preferred credentials. Monitoring credentials require specifying the target_name option.

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 this example, FILE1 is a tag 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

Example 3

In this example, the contents of the passwordFile: is username:joe;password:newPass;role:newRole

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_default_pref_cred

Sets a named credential as a default preferred credential. If you decide to use preferred credentials for an Enterprise Manager operation and preferred credentials are not set for the target, the default credentials for this target type that you set are used. Default credentials are set at the target-type level.

Format

emcli set_default_pref_cred 
        -set_name="set_name"
        -target_type="ttype"
        -credential_name="cred_name"
        [-credential_owner ="owner]"
        [-test] 
        [-test_target_name="test_target_name"]

[ ] indicates that the parameter is optional

Parameters

  • set_name

    Sets the preferred credential for this credential set.

  • target_type

    Target type for the credential set.

  • credential_name

    Name of the credential.

  • credential_owner

    Owner of the credential. This defaults to the currently logged-in user.

  • test

    Tests the credential before setting it as the default credential.

  • test_target_name

    Tests the target name if the global credential is set as the default preferred credential.

Examples

Example 1

The following example sets the named credential MyHostCredentials as the default preferred credential for the target type host as HostCredsNormal.

emcli set_default_pref_credential 
        -set_name=HostCredsNormal
        -target_type=host
        -credential_name=MyHostCredentials
        -credential_owner="Joe"

Example 2

The following example sets the named credential MyHostCredentials as the default preferred credential for the target type host as HostCredsNormal. The command tests the named credential MyHostCredentials against server1.example.com before setting it as a default preferred credential.

emcli set_default_pref_cred 
        -set_name=HostCredsNormal
        -target_type=host
        -credential_name=MyHostCredential
        -credential_owner="Joe"
        -test
        -test_target_name=server1.example.com

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]

[ ] indicates that the parameter is optional

Parameters

  • name

    Service target name.

  • type

    Service target type.

  • beacons

    Names of beacons to set as key (or non-key).

  • tests

    Names and types of tests to set as key (or non-key).

  • removeKey

    If specified, the mode is (remove key); that is, the specified tests and beacons will