Table of Contents
- Title and Copyright Information
- Preface
- 1 EM CLI Overview and Concepts
- 2 Downloading and Deploying EM CLI
-
3
Using EM CLI
- Using Command-line EM CLI
-
Using EM CLI in Interactive or Script Mode
- Jython Interpreter
- Script and Interactive Mode Syntax
- Interactive Mode — Connecting to an Oracle Management Server (OMS)
- Examples of Standard, Interactive, and Script Verb Invocations
- Writing and Running the First Script
- Invoking an EM CLI Verb Programatically
- Error Exception Handling
- Utility Functions
- Extending EM CLI with Python Libraries
- Selected Use Cases
- Advanced Script Examples
- Using the Generic 'List' Verb
- Using the Registered Clients Page
- 4 Advanced EM CLI Script Examples
-
5
Verb Reference
-
Verb Categories
- Basic Operational Verbs
- Account Management Verbs - Oracle Database
- Add Host Verbs
- Application Data Model Verbs
- Agent Administration Verbs
- Agent Recovery Verbs
- Agent Upgrade Verbs
- Application Data Models Verbs
- Audit Settings Verbs
- Auto Service Request (ASR) Verbs
- AWR Warehouse Verbs
- Bare Metal Provisioning Verbs
- Big Data Appliance Verbs
- Blackout Verbs
- Cloud Framework (CFW) Verbs
- Chargeback Verbs
- Clean Coherence Cluster Verbs
- Connector Verbs
- Cost Center Management Verbs
- Credential Verbs
- Credential Verbs - Oracle Database
- Custom Plug-in Update Verbs
- Data Guard Verbs
- Database High Availibility Verbs
- Database Lifecycle Management Verbs
- Database Machine Targets Customer Support Identifier (CSI) Assignment Verbs
- Database Replay Verbs
- Data Subset Verbs
- DBaaS Verbs
- Deployment Procedure Verbs
- Diagchecks Verbs
- Diagnostic Snapshots Verbs
- Discover and Push to Agents Verbs
- Discovery Prechecks Verbs
- Event and Incident Verbs
- Exadata Database Machine Verbs
- Execute Command Verbs
- Fusion Middleware Diagnostic Advisor Verbs
- Fusion Middleware Provisions Verbs
- Generic Middleware Provisioning Verbs
- Gold Agent Image Verbs
- Group Verbs
- Incident Rules Verbs
- Installation Verbs
- Internal Metrics Verbs
- Java EE Application Component Verbs
- JBoss Target Management Group
- Job Verbs
- Latest Configurations Verbs
- Licensing Verbs
- Log Management Verbs
- Masking Verbs
- Metric Collection and Alerts Verbs
- Metric Data Loading Verbs
- Metric Verbs
- Monitoring Template Verbs
- Notification Verbs
- OMS Configuration Properties
- OMS CPU Activity Report Verbs
- OMS Plug-in Deployment Verbs
- Oracle Database as Service (DBaaS) Verbs
- Package Fusion Application Problem Verbs
- Ping Subsytem Verbs
- Platform as a Service (PaaS) Verbs
- Prerequisite Check Verbs
- Privilege Delegation Settings Verbs
- Provisioning Hardware Verbs
- Reconfig Job Verbs
- Redundancy Group Verbs
- Refresh Coherence Verbs
- Refresh WLS Domain Verbs
- Report Import/Export Verbs
- Resource Verbs
- Saved Configurations Verbs
- Secure Communication Verbs
- Self Update Verbs
- Services Verbs
- Server-generated Alert Metric Verbs
- Siebel Verbs
- SiteGuard Verbs
- Software Library Verbs
- Self Service Application (SSA) Verbs
- Storage Management Framework Verbs
- Switch EM Monitoring Agent for Cluster Target Verbs
- System Verbs
- Target Data Verbs
- Tenant Administrative Verbs
- Toaster Verbs
- Trace Verbs
- Transparent Data Encryption
- Upgrade Database Job Verbs
- User Administration Verbs
- User Session Administration Verbs
- Websphere MQ Verbs
- WebSphere Target Management Verbs
- Zero Data Loss Recovery Appliance Verbs
-
EM CLI Verbs
- activate_mda_finding_types
- add_beacon
- add_blackout_reason
- add_chargeback_entity
- add_chef_cookbook
- add_cloud_db_target
- add_comment_to_event
- add_comment_to_problem
- add_comment_to_incident
- add_engr_sys_patches
- add_forwarders_for_paas_agent
- add_proxy
- add_siteguard_aux_hosts
- add_siteguard_script_credential_params
- add_siteguard_script_hosts
- add_swlib_storage_location
- add_target
- add_target_property
- add_target_to_rule_set
- add_to_target_properties_master_list
- add_virtual_platform
- allocate_quota
- apply_diagcheck_exclude
- apply_privilege_delegation_setting
- apply_template
- apply_template_tests
- apply_update
- argfile
- assign_charge_plan
- assign_compliance_ca
- assign_cost_center
- assign_csi_at_target_level
- assign_csi_for_dbmachine_targets
- assign_test_to_target
- associate_cs_group_targets
- associate_cs_targets
- associate_target_to_adm
- associate_user_profile
- awrwh_add_src_db
- awrwh_list_src_dbs
- awrwh_reconfigure
- awrwh_reconfigure_src
- awrwh_remove_src_db
- backup_database
- bareMetalProvisioning
- cancel_cloud_service_requests
- change_ruleset_owner
- change_service_system_assoc
- change_target_owner
- clean_down_members
- cleanup_config_extension
- cleanup_cs_target_associations
- cleanup_dbaas_requests
- clear_compliance_ca
- 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
- collect_metric
- compare_sla
- complete_post_pdb_relocation
- config_compare
- configure_db_ha
- 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_compare_check
- create_config_onetimecompare
- create_cost_centers
- create_credential_set
- create_custom_plugin_update
- create_database
- create_database_size
- create_dbaas_quota
- create_dbprofile
- create_diag_snapshot
- create_dynamic_group
- create_far_sync
- create_fmw_domain_profile
- create_fmw_home_profile
- create_gold_agent_image
- create_group
- create_inst_media_profile
- create_jeeappcom
- create_job
- create_job_from_library
- create_library_job
- create_mw_profile
- create_named_credential
- create_operation_plan
- create_organizational_entity
- create_paas_zone
- cleanup_dbaas_requests
- create_partition_profile
- 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_standby_database
- create_swlib_directive_entity
- create_swlib_entity
- create_swlib_folder
- create_system
- create_tenant
- create_user
- create_user_profile
- data_transfer
- db_clone_management
- db_cloud_maintenance
- db_software_maintenance
- dbimport
- deactivate_mda_finding_types
- define_diagcheck_exclude
- delete_assoc
- delete_bda_cluster
- delete_blackout
- delete_charge_item
- delete_chef_cookbook
- delete_cloud_service_instances
- delete_cloud_user_objects
- delete_compare_check
- delete_config_compare_template
- delete_config_onetimecompare
- delete_config_search
- delete_credential_set
- delete_custom_plugin_update
- delete_database
- delete_database_size
- delete_dbaas_quota
- delete_dbprofile
- delete_diag_snapshot
- delete_fmw_profile
- delete_from_target_properties_master_list
- delete_gold_agent_image
- delete_group
- delete_incident_record
- delete_instance
- delete_job
- delete_library_job
- delete_metric_promotion
- delete_mw_profile
- delete_named_credential
- delete_operation_plan
- delete_oracle_database
- delete_oracle_restart
- delete_paas_zone
- delete_patch_plans
- delete_pluggable_database
- delete_pool verb
- delete_privilege_delegation_settings
- delete_procedure
- delete_proxy
- delete_resolution_state
- delete_role
- delete_saved_config
- delete_saved_onetimecomparison
- delete_service_template
- delete_siebel
- delete_siteguard_aux_host
- delete_siteguard_configuration
- delete_siteguard_credential_association
- delete_siteguard_lag
- delete_siteguard_script
- delete_siteguard_script_hosts
- delete_sla
- delete_swlib_entity
- delete_system
- delete_target
- delete_tenant
- delete_test
- delete_test_threshold
- delete_patches
- delete_PDB_Profiles
- delete_user
- delete_user_profile
- deploy_plugin_on_agent
- deploy_plugin_on_server
- deregister_forwarder_agents
- describe_dbprofile_input
- describe_engr_sys_targets
- describe_fmw_profile
- describe_job
- describe_job_type
- describe_library_job
- describe_patch_plan_input
- describe_procedure_input
- deploy_jvmd usage
- dg_change_protection_mode
- dg_configure_fsfo
- dg_configure_observers
- dg_convert_standby
- dg_convert_standby_to_cluster
- dg_failover
- dg_remove_configuration
- dg_remove_standby_database
- dg_switchover
- dg_verify_config
- diagchecks_deploy_status
- diagchecks_deploy_tglist
- diagnose_awr
- disable_audit
- disable_config_history
- disable_mda_finding_types_for_targets
- disable_sla
- disable_snapclone
- disable_target
- disable_test
- disassociate_user_profile
- discover_bda_cluster
- discover_cloudera_cluster
- discover_coherence
- discover_db
- discover_fa
- discover_gf
- discover_jboss
- discover_siebel
- discover_was
- discover_wls
- discover_wmq
- discover_workloads
- download_ats_test_databank_file
- download_ats_test_zip
- download_update
- dump_activity_list
- edit_dbprofile
- edit_sl_rule
- edit_storage_ceiling
- em_asr_asset_actcred
- em_asr_asset_activation_details
- em_asr_asset_activation_job
- em_asr_asset_exclude_list
- em_asr_asset_include_list
- em_asr_deregister
- em_asr_register
- em_asr_xsl_upload
- jvm_configchange
- jvmpool_configchange
- scaledown_domain
- enable_audit
- enable_config_history
- enable_forwarder_agents
- enable_mda_finding_types_for_targets
- enable_metric_data_load
- enable_or_disable_event_correlation_rule
- enable_sla
- enable_snapclone
- enable_target
- enable_test
- execute_hostcmd
- execute_sql
- export_adm
- export_admin_group
- export_charge_plans
- export_compliance_group
- export_compliance_standard_rule
- export_config_compare_result
- export_config_onetimecompare
- export_config_search
- export_config_compare_template
- export_custom_charge_items
- export_facet
- export_incident_rule_set
- export_jobs
- export_latest_config
- export_masking_definition
- export_metric_extension
- export_report
- export_saved_config
- export_sla
- export_standard
- export_subset_definition
- export_swlib_cache_files
- export_template
- export_update
- extend_as_home
- extract_template_tests
- fix_compliance_state
- fmw_discovery_prechecks
- generate_activity_report
- generate_discovery_input
- generate_downtime_contact
- generate_masking_script
- generate_subset
- generate_ui_trace_report
- get_accesspoints
- get_add_host_status
- get_agent_properties
- get_agent_property
- get_agent_unsubscribe_status
- get_agent_update_status
- get_agent_upgrade_status
- get_agentimage
- get_agentimage_rpm
- get_aggregate_service_info
- get_aggregate_service_members
- get_best_implementer
- 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_compliance_rule_ca
- get_compliance_rule_violation_event
- get_config_history_searches
- get_config_onetimecomparisons
- get_config_searches
- get_config_templates
- get_connection_mode
- get_credtype_metadata
- get_db_account
- get_db_profile
- get_db_sys_details_from_dbname
- get_dbaas_quota
- get_dbaas_request_settings
- get_duplicate_credentials
- get_engr_sys_patching_logs
- get_executions
- get_ext_dev_kit
- get_gold_agent_image_activity_status
- get_gold_agent_image_details
- get_group_members
- get_groups
- get_instance_data
- get_instance_status
- get_instances
- get_internal_metric
- get_job_execution_detail
- get_job_types
- get_jobs
- get_mda_engine_status
- get_metering_data
- get_metrics_for_stateless_alerts
- get_named_credential
- get_not_updatable_agents
- 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_organizational_hierarchy
- get_paas_zone_detail
- get_patch_plan_data
- get_plugin_deployment_status
- get_pool_allowed_placement_constraints
- get_pool_capacity
- get_pool_detail
- get_pool_filtered_targets
- get_procedure_types
- get_procedure_xml
- get_procedures
- get_reports
- get_resolution_states
- get_retry_arguments
- get_runtime_data
- get_sample_migration_xml
- get_saved_configs
- get_service_template_detail
- get_service_templates
- get_signoff_agents
- get_signoff_status
- 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_swlib_entity_details
- 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_updatable_agents
- get_upgradable_agents
- grant_license_no_validation
- grant_license_with_validation
- grant_privs
- grant_roles
- help
- ignore_instance
- import_adm
- import_admin_group
- import_appreplay_workload
- import_charge_plans
- import_compliance_object
- import_config
- import_config_compare_template
- import_config_search
- import_custom_charge_items
- import_custom_plugin_update
- import_incident_rule_set
- import_jobs
- import_masking_definition
- import_metric_extension
- import_replays
- import_report
- import_sla
- import_subset_definition
- import_subset_dump
- import_swlib_cache_files
- import_template
- import_update
- import_update_catalog
- import_workloads
- lcm_operations
- list
- list_active_sessions
- list_add_host_platforms
- list_add_host_sessions
- list_adms
- list_agents_on_gold_image
- list_allowed_pairs
- list_assoc
- list_charge_item_candidates
- list_charge_plans
- list_chargeback_entities
- list_chargeback_entity_types
- list_compliance_rules
- list_compliance_rules_ca
- list_cost_centers
- list_cs_rules
- list_custom_plugin_updates
- list_database_sizes
- list_dbprofiles
- list_diagcheck_exclude_applies
- list_diagcheck_exclusions
- list_diagchecks
- list_fmw_profiles
- list_gold_agent_image_activities
- list_gold_agent_images
- list_gold_agent_imageversions
- emcli list_gold_image_subscribed_agent
- list_internal_metrics
- list_masking_definitions
- list_mda_finding_types
- list_mda_properties
- list_mw_profiles
- 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_Pluggable_Database_Profiles
- cleanup_dbaas_requests
- list_prerequisites
- list_privilege_delegation_settings
- list_target_properties_master_list_values
- list_prov_parameters
- list_proxies
- list_siebel_enterprises
- list_siebel_servers
- list_sla
- list_standards
- 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_targets_having_property_value
- list_templates
- list_trace
- lock_user_account
- login
- logout
- manage_incident
- manage_storage_access
- manage_agent_partnership
- manage_ra
- merge_credentials
- metric_control
- migrate_db
- migrate_noncdb_to_pdb
- migrate_to_lifecycle_status
- modify_aggregate_service
- modify_collection_schedule
- modify_group
- modify_incident_rule
- modify_lifecycle_stage_name
- modify_metric_data_load_limits
- modify_metric_data_load_whitelist
- modify_proxy
- 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_user_profile
- modify_virtual_platform
- package_fa_problem
- pdb_backup
- pdb_clone_management
- promote_gold_agent_image
- provision
- provision_mw_profile
- 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_jboss_domain
- refresh_jboss_partition
- refresh_was
- refresh_wls
- refresh_wmq
- register_forwarder_agents
- register_hybridgateway_agents
- register_storage
- reimport_swlib_metadata
- relocate_bda_target
- relocate_pdb
- relocate_targets
- relocate_wls
- remove_association_cs_group_targets
- remove_beacon
- remove_chargeback_entity
- remove_cs_target_association
- remove_metric_data_load_limits
- remove_mos_credentials
- remove_service_system_assoc
- remove_storage
- remove_swlib_storage_location
- remove_target_from_rule_set
- remove_target_property
- remove_update
- rename_service_template
- rename_target
- rename_targets_property_value
- reschedule_instance
- resecure_agent
- restart_agent
- resume_instance
- resume_job
- resyncAgent
- resync_swlib_cache
- resync_target
- retry_add_host
- retry_instance
- retry_job
- revoke_license_no_validation
- revoke_license_with_validation
- revoke_privs
- revoke_quota
- revoke_roles
- rollback_listener
- run_avail_diag
- run_auto_discovery
- run_config_history
- run_config_search
- run_fa_diagnostics
- run_mda_health_check
- run_prechecks
- run_prerequisites
- run_promoted_metric_diag
- save_latest_config
- save_masking_script
- save_metric_extension_draft
- save_procedure_input
- schedule_siteguard_health_checks
- search_patches
- secure_agent
- secure_agents
- send_system_broadcast
- set_agent_property
- set_availability
- set_awr_cred
- set_config_history_retention_period
- set_connection_mode
- set_credential
- set_db_service_properties
- set_default_pref_cred
- set_default_privilege_delegation_setting
- set_engr_sys_patching_options
- set_gold_agent_update
- set_key_beacons_tests
- set_logging_property
- set_metric_promotion
- set_monitoring_credential
- set_mos_credentials
- 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
- show_bda_clusters
- show_applicable_engr_sys_operations
- show_applicable_engr_sys_patches
- show_audit_settings
- show_credential_set_info
- show_credential_type_info
- show_engr_sys_operation_status
- show_engr_sys_patchable_targets
- show_engr_sys_patching_history
- show_engr_sys_targets
- show_operations_list
- show_patch_plan
- show_patch_readme
- show_proxy
- signoff_agents
- stage_gold_agent_image
- stage_swlib_entity_files
- stage_swlib_entity_files_local
- start_agent
- start_mda_engine
- start_replay
- status
- stop_agent
- stop_blackout
- stop_engr_sys_maintenance
- stop_instance
- stop_job
- stop_mda_engine
- stop_siteguard_health_checks
- submit_add_host
- submit_engr_sys_maintenance
- submit_job
- submit_masking_job
- submit_operation_plan
- submit_patch_plan
- submit_procedure
- subscribe_agents
- subscribeto_rule
- suppress_compliance_rule_violations
- suppress_incident
- suppress_problem
- suppress_recommended_patch
- suspend_instance
- suspend_job
- switch_cluster_agent
- switch_database
- switch_gi
- switch_swlib_oms_agent_storage
- sync
- sync_alerts
- sync_beacon
- sync_pdb
- synchronize_storage
- tde
- test_named_credential
- test_privilege_delegation_setting
- test_proxy
- trace
- trace_set_property
- trigger_compliance_ca
- unassign_charge_plan
- unassign_cost_center
- undeploy_diagchecks
- undeploy_plugin_from_agent
- undeploy_plugin_from_server
- unsecure_agent
- unsubscribe_agents
- unsuppress_incident
- unsuppress_problem
- update_and_retry_step
- update_agents
- update_audit_settings
- update_credential_set
- update_database_size
- update_db_account_status
- update_db_password
- update_dbaas_quota
- update_dbaas_request_settings
- update_diagchecks
- update_host_password
- update_mda_properties
- update_monitoring_creds_from_agent
- update_operation_plan
- update_organizational_entity
- update_paas_zone
- update_password
- 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_directive_entity
- update_swlib_entity
- update_target_password
- update_tenant_owner
- update_tenant_state
- update_ticket_status
- upgrade_agents
- upgrade_database
- upload_ats_test_databank_file
- upload_catalog
- upload_compliance_standard
- upload_jeeappcomp_file
- upload_patches
- upload_swlib_entity_files
- use_target_properties_master_list
- validate_server_generated_alerts
- verify_adm
- verify_swlib
- verify_updates
- version
- view_redundancy_group
- query_suppressed_recommendations
- -input_file Syntax Guidelines
- Overriding the Separator and Subseparator
-
Verb Categories
- 6 Error Code Reference
- A Sample Scripts