Go to main content
1/12
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
What's Changed in this Guide?
1
EM CLI Overview and Concepts
1.1
Overview
1.2
EM CLI Modes of Operation
1.2.1
Standard Command-line Mode
1.2.2
Interactive mode
1.2.3
Script Mode
1.3
EM CLI Architecture
2
Downloading and Deploying EM CLI
2.1
EM CLI Installation
2.2
Downloading and Deploying the EM CLI Client
2.2.1
Requirements
2.2.2
Downloading and Deploying the EMC CLI Client for Standard EM CLI
2.2.3
Downloading and Deploying the EM CLI Client with the Script Option
2.2.4
Using EM CLI With Shared Directories
2.3
Getting Started with EM CLI
2.3.1
Using Basic Operational Verbs
2.3.1.1
Using Commands in Standard Mode
2.3.1.2
Using Commands in Interactive Mode
2.3.1.3
Calling a Script
2.3.2
Connecting the EM CLI Client to OMS
2.3.3
Configuring an HTTP Proxy Environment
2.3.4
Configuring Log File Settings for EM CLI
2.3.4.1
Log File Locations
2.3.4.2
Log File Location and Log Level
2.4
Security and Authentication
2.4.1
HTTPS Trusted Certificate Management
2.4.2
Secure EM CLI Clients
2.4.3
Secure Mode for the EM CLI Setup
2.5
Format Option Availability for Output Data Verbs
3
Using EM CLI
3.1
Using Command-line EM CLI
3.2
Using EM CLI in Interactive or Script Mode
3.2.1
Jython Interpreter
3.2.2
Script and Interactive Mode Syntax
3.2.3
Interactive Mode — Connecting to an Oracle Management Server (OMS)
3.2.4
Examples of Standard, Interactive, and Script Verb Invocations
3.2.5
Writing and Running the First Script
3.2.6
Invoking an EM CLI Verb Programatically
3.2.6.1
Accessing Verb Invocation Responses
3.2.6.2
JSON Processing
3.2.7
Error Exception Handling
3.2.8
Utility Functions
3.2.9
Extending EM CLI with Python Libraries
3.2.10
Selected Use Cases
3.3
Advanced Script Examples
3.3.1
Changing Lifecycle Status Properties
3.3.1.1
Script Analysis
3.3.1.2
Script Output
3.3.2
Changing Your Database Password
3.3.2.1
Script Analysis
3.3.2.2
Script Output
3.3.3
Promoting Discovered Targets
3.3.3.1
Script Analysis
3.3.3.2
Script Output
3.4
Using the Generic 'List' Verb
3.4.1
Selected list Verb Use Cases
3.4.1.1
Listing Registered Resources
3.4.1.2
Searching for Data
3.4.1.3
Registering Resources with the Bind Parameter
3.4.1.4
Listing with End-user Defined SQL
3.5
Using the Registered Clients Page
3.5.1
Accessing the Page
3.5.2
Deleting an Entry from the Table
4
Advanced EM CLI Script Examples
4.1
Changing Lifecycle Status Properties
4.1.1
Script Analysis
4.1.2
Script Output
4.2
Changing Your Database Password
4.2.1
Script Analysis
4.2.2
Script Output
4.3
Promoting Discovered Targets
4.3.1
Script Analysis
4.3.2
Script Output
5
Verb Reference
5.1
Verb Categories
5.2
-input_file Syntax Guidelines
5.2.1
-input_file Syntax
5.2.2
-input_file for Jobs
5.3
Overriding the Separator and Subseparator
EM CLI Verbs
abort_udmmig_session
add_beacon
add_blackout_reason
add_chargeback_entity
add_forwarders_for_paas_agent
add_siteguard_aux_hosts
add_siteguard_script_credential_params
add_siteguard_script_hosts
add_swlib_storage_location
delete_siteguard_aux_host
add_target
add_target_property
add_target_to_rule_set
add_virtual_platform
analyze_unconverted_udms
apply_diagcheck_exclude
apply_privilege_delegation_setting
apply_template
apply_template_tests
apply_update
argfile
assign_charge_plan
assign_cost_center
assign_csi_at_target_level
assign_csi_for_dbmachine_targets
assign_test_to_target
associate_cs_targets
associate_target_to_adm
bareMetalProvisioning
cancel_cloud_service_requests
change_service_system_assoc
change_target_owner
cleanup_dbaas_requests
clear_credential
clear_default_pref_credential
clear_default_privilege_delegation_setting
clear_monitoring_credential
clear_preferred_credential
clear_privilege_delegation_setting
clear_problem
clear_stateless_alerts
clone_as_home
clone_crs_home
clone_database
clone_database_home
collect_metric
compare_sla
config_compare
config_db_service_target
configure_log_archive_locations
configure_siteguard_lag
confirm_instance
continue_add_host
convert_to_cluster_database
create_aggregate_service
create_assoc
create_blackout
create_charge_entity_type
create_charge_item
create_clone
create_credential_set
create_custom_plugin_update
create_database
create_database_size
create_dbprofile
create_dbaas_quota
create_dbprofile
create_diag_snapshot
create_fmw_domain_profile
create_fmw_home_profile
create_group
create_inst_media_profile
create_jeeappcom
create_job
create_job_from_library
create_library_job
create_named_credential
create_operation_plan
create_paas_zone
create_patch_plan
create_pool
create_pluggable_database
create_privilege_delegation_setting
create_rbk
create_red_group
create_redundancy_group
create_resolution_state
create_role
create_service
create_service_template
create_siteguard_configuration
create_siteguard_credential_association
create_siteguard_script
create_swlib_entity
create_swlib_folder
create_system
create_udmmig_session
create_user
data_transfer
dbimport
db_cloud_maintenance
db_software_maintenance
define_diagcheck_exclude
delete_assoc
delete_bda_cluster
delete_blackout
delete_charge_item
delete_cloud_service_instances
delete_cloud_user_objects
delete_credential_set
delete_custom_plugin_update
delete_database
delete_database_size
delete_dbaas_quota
delete_dbprofile
delete_diag_snapshot
delete_fmw_profile
delete_group
delete_incident_record
delete_instance
delete_job
delete_library_job
delete_metric_promotion
delete_named_credential
delete_operation_plan
delete_patch_plans
delete_paas_zone
delete_patches
delete_pluggable_database
delete_pool verb
delete_privilege_delegation_settings
delete_resolution_state
delete_role
delete_service_template
delete_siebel
delete_siteguard_configuration
delete_siteguard_credential_association
delete_siteguard_lag
delete_siteguard_script
delete_siteguard_script_hosts
delete_sla
delete_system
delete_target
delete_test
delete_test_threshold
delete_user
delete_pluggable_database
deploy_bipublisher_reports
deploy_bipublisher_selfupdates
deploy_plugin_on_agent
deploy_plugin_on_server
deregister_forwarder_agents
describe_dbprofile_input
describe_fmw_profile
describe_job
describe_job_type
describe_library_job
describe_patch_plan_input
describe_procedure_input
diagchecks_deploy_status
diagchecks_deploy_tglist
disable_audit
disable_config_history
disable_sla
disable_test
discover_bda_cluster
discover_cloudera_cluster
discover_coherence
discover_fa
discover_gf
discover_siebel
discover_wls
download_ats_test_databank_file
download_ats_test_zip
download_update
dump_activity_list
edit_dbprofile
edit_sl_rule
enable_audit
enable_config_history
enable_forwarder_agents
enable_sla
enable_test
execute_hostcmd
execute_sql
export_adm
export_charge_plans
export_compliance_group
export_compliance_standard_rule
export_custom_charge_items
export_jobs
export_masking_definition
export_metric_extension
export_report
export_sla
export_standard
export_subset_definition
export_template
export_update
extend_as_home
extend_crs_home
extend_rac_home
extract_template_tests
fix_compliance_state
fmw_discovery_prechecks
generate_activity_report
generate_discovery_input
generate_ui_trace_report
generate_masking_script
generate_subset
generate_ui_trace_report
get_add_host_status
get_agentimage
get_agentimage_rpm
get_agent_properties
get_agent_property
get_agent_upgrade_status
get_aggregate_service_info
get_aggregate_service_members
get_blackout_details
get_blackout_reasons
get_blackout_targets
get_blackouts
get_ca_info
get_cloud_service_instances
get_cloud_service_requests
get_cloud_user_objects
get_config_searches
get_config_templates
get_connection_mode
get_credtype_metadata
get_dbaas_quota
get_dbaas_request_settings
get_db_sys_details_from_dbname
get_duplicate_credentials
get_executions
get_ext_dev_kit
get_group_members
get_groups
get_instance_data
get_instance_status
get_instances
get_internal_metric
get_job_execution_detail
get_jobs
get_job_types
get_metering_data
get_metrics_for_stateless_alerts
get_named_credential
get_oms_config_property
get_oms_inventory
get_oms_logging_property
get_on _demand_metrics
get_onetime_registration_token
get_operation_plan_details
get_operation_plans
get_paas_zone_detail
get_patch_plan_data
get_pool_allowed_placement_constraints
get_pool_capacity
get_pool_detail
get_pool_filtered_targets
get_plugin_deployment_status
get_procedures
get_procedure_types
get_procedure_xml
get_reports
get_resolution_states
get_retry_arguments
get_runtime_data
get_saved_configs
get_service_template_detail
get_service_templates
get_signoff_agents
get_signoff_status
get_siteguard_aux_hosts
get_siteguard_credential_association
get_siteguard_health_checks
get_siteguard_lag
get_siteguard_script_credential_params
get_siteguard_script_hosts
get_siteguard_scripts
get_supported_platforms
get_supported_privileges
get_system_members
get_target_properties
get_target_types
get_targets
get_test_thresholds
get_threshold
get_unsync_alerts
get_unused_metric_extensions
get_update_status
get_upgradable_agents
grant_bipublisher_roles
grant_license_no_validation
grant_license_with_validation
grant_privs
grant_roles
help
ignore_instance
import_adm
import_appreplay_workload
import_charge_plans
import_compliance_object
import_custom_charge_items
import_custom_plugin_update
import_jobs
import_masking_definition
import_metric_extension
import_report
import_sla
import_subset_definition
import_subset_dump
import_template
import_update
import_update_catalog
list
list_active_sessions
list_add_host_platforms
list_add_host_sessions
list_adms
list_allowed_pairs
list_aru_languages
list_aru_platforms
list_aru_products
list_aru_releases
list_assoc
list_chargeback_entities
list_chargeback_entity_types
list_charge_item_candidates
list_charge_plans
list_cost_centers
list_custom_plugin_updates
list_database_sizes
list_dbprofiles
list_diagchecks
list_diagcheck_exclude_applies
list_diagcheck_exclusions
list_fmw_profiles
list_internal_metrics
list_masking_definitions
list_named_credentials
list_oms_config_properties
list_oms_logging_properties
list_patch_plans
list_patches_in_custom_plugin_update
list_plugins_on_agent
list_plugins_on_server
list_prerequisites
list_privilege_delegation_settings
list_siebel_enterprises
list_siebel_servers
list_sla
list_subset_definitions
list_swlib_entities
list_swlib_entity_subtypes
list_swlib_entity_types
list_swlib_folders
list_swlib_storage_locations
list_target_privilege_delegation_settings
list_target_property_names
list_templates
list_trace
list_unconverted_udms
login
logout
manage_agent_partnership
merge_credentials
metric_control
migrate_noncdb_to_pdb
migrate_to_lifecycle_status
modify_aggregate_service
modify_collection_schedule
modify_group
modify_incident_rule
modify_lifecycle_stage_name
modify_monitoring_agent
modify_named_credential
modify_red_group
modify_redundancy_group
modify_resolution_state
modify_role
modify_system
modify_target
modify_threshold
modify_user
modify_virtual_platform
package_fa_problem
pdb_backup
pdb_clone_management
provision
publish_change_request_ccc
publish_event
publish_metric_extension
reassoc_masking_definition
redeploy_plugin_on_agent
refer_swlib_entity_files
refresh_coherence
refresh_database
refresh_dbprofile
refresh_fa
refresh_wls
register_forwarder_agents
reimport_swlib_metadata
relocate_bda_target
relocate_targets
remove_beacon
remove_chargeback_entity
remove_cs_target_association
remove_service_system_assoc
remove_swlib_storage_location
remove_target_from_rule_set
remove_target_property
remove_update
rename_service_template
rename_target
reschedule_instance
resecure_agent
restart_agent
resume_instance
resume_job
retry_add_host
retry_instance
retry_job
revoke_bipublisher_roles
revoke_license_no_validation
revoke_license_with_validation
revoke_privs
revoke_roles
run_avail_diag
run_config_seaches
run_fa_diagnostics
run_prechecks
run_prerequisites
run_promoted_metric_diag
save_masking_script
save_metric_extension_draft
save_procedure_input
schedule_siteguard_health_checks
search_patches
secure_agent
secure_agents
set_agent_property
set_availability
set_config_history_retention_period
set_connection_mode
set_credential
set_db_service_properties
set_default_pref_cred
set_default_privilege_delegation_setting
set_key_beacons_tests
set_logging_property
set_metric_promotion
set_monitoring_credential
set_oms_property
set_patch_plan_data
set_preferred_credential
set_properties
set_reverse_ping_interval
set_standby_agent
set_target_property_value
set_test_threshold
setup
setup_bipublisher
show_bda_clusters
show_audit_settings
show_credential_set_info
show_credential_type_info
show_operations_list
show_patch_plan
signoff_agents
stage_swlib_entity_files
start_agent
status
stop_agent
stop_blackout
stop_instance
stop_job
stop_siteguard_health_checks
submit_add_host
submit_job
submit_masking_job
submit_operation_plan
submit_patch_plan
submit_procedure
subscribeto_rule
suspend_instance
suspend_job
switch_swlib_oms_agent_storage
sync
sync_alerts
sync_beacon
test_named_credential
test_privilege_delegation_setting
trace
trace_set_property
udmmig_list_matches
udmmig_request_udmdelete
udmmig_retry_deploys
udmmig_session_details
udmmig_submit_metricpicks
udmmig_summary
udmmig_update_incrules
unassign_charge_plan
unassign_cost_center
undeploy_diagchecks
undeploy_plugin_from_agent
undeploy_plugin_from_server
unregister_bipublisher
unsecure_agent
update_and_retry_step
update_audit_settings
update_credential_set
update_database_size
update_db_password
update_diagchecks
update_host_password
update_monitoring_creds_from_agent
update_operation_plan
update_dbaas_quota
update_dbaas_request_settings
update_paas_zone
update_password
upload_jeeappcomp_file
update_pool
update_procedure_input
update_service_template
update_siebel
update_siteguard_configuration
update_siteguard_credential_association
update_siteguard_lag
update_siteguard_script
update_swlib_entity
update_target_password
update_ticket_status
upgrade_agents
upgrade_database
upload_ats_test_databank_file
upload_patches
upload_swlib_entity_files
validate_server_generated_alerts
verify_adm
verify_swlib
verify_updates
version
view_redundancy_group
6
Error Code Reference
6.1
EM CLI Infrastructure Errors
6.2
OMS Connection Errors
6.3
File-fed Option Errors
6.4
Built-in Verb Errors
A
Sample Scripts
Index
Scripting on this page enhances content navigation, but does not change the content in any way.