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.
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
AWR Warehouse Verbs
Bare Metal Provisioning Verbs
BI Publisher Reports Verbs
Big Data Appliance
Blackout Verbs
CFW Verbs
Chargeback Verbs
Clean Coherence Cluster Verbs
Cloning Verbs
Compliance Verbs
Configuration Association History
Configuration Data
Configuration Compare
Connector Verbs
Cost Center Management Verbs
Credential Verbs
Credential Verbs - Oracle Database
Custom Plug-in Update Verbs
Data Guard Verbs
Database Lifecycle Management Verbs
Database Machine Targets Customer Support Identifier (CSI) Assignment Verbs
Database Profile Job 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
Auto Service Request (ASR) Verbs
Event and Incident 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
Patch Verbs
Ping Subsytem Verbs
Platform as a Service (PaaS) Verbs
Pluggable Database Job Verbs
Prerequisite Check Verbs
Privilege Delegation Settings Verbs
Provisioning 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
Software Maintenance Verbs
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
User-defined Metrics (UDM) Migration Verbs
Upgrade Database Job Verbs
User Administration Verbs
User Session Administration Verbs
Websphere MQ Verbs
WebSphere Target Management Verbs
This option enables you to provide an argument to be specified in a file. For example:
emcli xyzverb -input_file="arg1:file1.txt" -input_file="arg2:file2.txt"
This string literally translates to:
emcli xyzverb -arg1=<contents of file1.txt> -arg2=<contents of file2.txt>
emcli xyzverb -input_file="name:/tmp/b1.txt" -input_file="type:/tmp/b2.txt" -input_file="bcnName:/tmp/b3.txt"
This example makes User1 an Enterprise Manager user, which is already created on an external user store like the SSO server. The contents of priv_file are view_target;host1.example.com:host. User1 will have view privileges on the host1.example.com:host target.
emcli create_user
-name="User1"
-type="EXTERNAL_USER"
-input_file="privilege:/home/user1/priv_file"
For most job verbs, you can specify all of the needed properties in a property file. You can also provide a few properties on the command line. Properties set on the command line override values set in the file.
The property file consists of name=value pairs. For example, put the following into myFile.txt:
name=MY JOB 1
type=OSCommand
description=this is a test job
target_list=target1:host
variable.default_shell_command=ls -l
schedule.frequency=IMMEDIATE
... then run:
emcli create_job -input_file=property_file:myFile.txt
This creates an OS Command job called "MY JOB 1" using preferred credentials.
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
This example creates a property file template for an OS Command job. This lists the properties allowed by this job type, including all required and optional variables. Variables marked as deprecated should be avoided.
emcli describe_job_type [-verbose] -type=OSCommand > myPropFile.txt
Not all verbs allow separator and subseparator to be overridden. The semi-colon ( ; ) and colon ( : ) are respectively the default separator and subseparator. The separator is used for arguments that take multiple values, and subseparator is used when the value itself has multiple values. You can override either one of them or both.
The syntax is:
separator=<option_for_which_separator_has_to_be_applied>="separator_value"
As an example of using the separator and subseperator to create a group containing database2 and database3, the command could be:
emcli create_group -name="tstgrp" -add_targets="database2:oracle_database; database3:oracle_database"
Using this command as the basis for modification, these examples show overrides of separator and/or subseperator:
emcli create_group -name="tstgrp1" -add_targets="database2:oracle_database, database3:oracle_database" -separator=add_targets="," emcli create_group -name="tstgrp2" -add_targets="database2&oracle_database, database3&oracle_database" -separator=add_targets="," -subseparator=add_targets="&" emcli create_group -name="tstgrp3" -add_targets="database2&oracle_database; database3&oracle_database" -subseparator=add_targets="&"
The following sections provide descriptions, formats, and options for all EM CLI verbs. Some of the verbs also contain one or more examples.
Aborts the migration of user-defined metrics (UDMs) to metric extensions in a session.
Format
emcli abort_udmmig_session
-session_id=<sessionId>
[-input_file=specific_tasks:<complete_path_to_file>]
[ ] indicates that the parameter is optional
Options
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 -input_file Syntax Guidelines.
Example
This example aborts the specified migration session. The UDM is returned to the unconverted list.
emcli abort_udmmig_session -session_id=<sessionId>
Activates the specified MDA finding types. A finding type can have status 'N' (new), 'A' (active), or 'I' (inactive). Only those finding types that are currently inactive, for example, status 'I', will be activated. For others the previous status is retained.
Format
emcli activate_mda_finding_types [-finding_types="<list of finding types>"] [-separator=finding_types="separator_for_finding_types_values"] [ ] indicates that the parameter is optional.
Options
finding_types
List of finding types. The default separator to be used is ';'.
separator=finding_types
Indicates the custom separator used for the list of finding types. This option is mandatory if any other character apart from ‘;' is used as a separator in the finding types list.
Example
The following example activates multiple finding types with a custom separator:
emcli activate_mda_finding_types
-finding_types="oracle.sysman.emas.wls_gc_overhead$oracle.sysman.emas.wls_heap_config"
-separator=finding_types="$"
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
Options
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
This 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'
Adds a new blackout reason. Only Super Administrators can perform this action.
Format
emcli add_blackout_reason -name="<blackout reason>"
Example
This example adds the blackout reason "Testing Purposes."
emcli add_blackout_reason -name="Testing Purposes"
Adds the given entity to Chargeback.
Format
add_chargeback_entity
-entity_name="eName"
-entity_type="eType"
-usage_mode="uMode"
Options
entity_name
Name of the entity to be added to Chargeback.
entity_type
Type of entity to be added to Chargeback.
usage_mode
Usage mode by which it should be added to Chargeback. You can see the usage modes for a particular entity type by entering list_chargeback_entity_types -entity_type.
Adds a software library component and directives for a chef cookbook. If more than one software library storage location is configured, the default storage location is used. Use this verb once for each cookbook.
Format
emcli add_chef_cookbook
-name="component_name"
-folder_name="swlib_folder_name"
-filename="filename"
-recipe_names="recipe_name11;recipe_name2;..."
Options
name
The software library component name
recipe_names
Cookbook recipe names. The recipe names are semi-colon separated. A directive will be created for each recipe.
folder_name
The software library folder where the component and directives will be saved.
filename
Name of the cookbook file. It must be in tar, gzip format. The cookbook name must be the "base" of the filename. For example, if the cookbook is named 'cookie', then the cookbook filename must be cookie.tar.gz.
Example
The following example creates a custom software library component and directives for a new chef cookbook. Entities are created in a sub folder of the MyComponents folder.
emcli add_chef_cookbook
-name=chef_component
-recipe_names="start;stop;install"
-folder_name="MyComponents folder"
-filename="mysql.tar.gz"
Adds a comment to a specified event.
Format
emcli add_comment_to_event
-event_id="event ID"
-comment="text"
Options
event_id
ID of the event to which the comment is to be added.
comment
Comment text.
Example
The following command adds the comment "Working on this" to an event with the ID 2.
emcli -add_comment_to_event -event_id="2" -comment="Working on this"
Adds a comment to a specified incident.
Format
emcli add_comment_to_incident
-incident_id="Incident ID"
-comment="text"
Options
incident_id
ID of the incident to which a comment is to be added.
comment
Comment text.
Example
The following example adds the comment "Working on this" to an incident with the ID 2.
emcli -add_comment_to_incident -incident_id="2" -comment="Working on this"
Adds a system patch for performing a patching operation at the component level, on a specific target, or on a list of targets specified in the target file.
Format
emcli add_engr_sys_patches
-system_target_name="target_name"
-system_target_type="target_type"
-target_name="target_name" -target_type="target_type" -patch_composite_id="patch_composite_id" | -input_file=data:"target list specified in file"
Options
system_target_name
Specifies the engineered system target name.
system_target_type
Specifies the engineered system target type.
target_name
Specifies the target name.
target_type
Specifies the target type.
input_file
Specifies the path of the file that contains the inputs for setting up the patching options.
The following is an example of an input file to add patches for targets:
target.0.target_name=slcm12adm01.example.com target.0.target_type=oracle_exadata target.0.sys_patch.patch_id=19893788 target.0.sys_patch.release_id=9800371121010 target.0.sys_patch.platform_id=226 target.0.sys_patch.language_id=0 target.1.target_name=slcm12adm02.example.com target.1.target_type=oracle_exadata target.1.sys_patch.patch_id=20093789 target.1.sys_patch.release_id=9800371121010 target.1.sys_patch.platform_id=226 target.1.sys_patch.language_id=0
The following is an example of an input file to add patches for a component:
component.type=Oracle Infiniband Switch component.sys_patch.patch_id=19893788 component.sys_patch.release_id=9800371121010 component.sys_patch.platform_id=226 component.sys_patch.language_id=0
patch_composite_id
Specifies the patch composite ID. The format of the patch composite ID must follow p<patchID>_<ReleaseID>_<PlatformID>_<LanguageID>.
Example
The following example adds patches for the member target clusteradm0102.example.com:cluster of the engineered system DB Machine slcm12.example.com:oracle_dbmachine, using the inputs specified in /tmp/property.prop:
emcli add_engr_sys_patches
-system_target_name="DB Machine slcm12.example.com"
-system_target_type="oracle_dbmachine"
-input_file=data:"/tmp/property.prop"
Adds forwarders for a given PaaS agent.
Format
emcli add_forwarders_for_paas_agent
-paas_agent_name="paas_agent_name"
-agent_list="agent_list"
Options
paas_agent_name
Agent name of the hybrid agent.
agent_list
Forwarder agent list separated by a space.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example forwards paas_agent_1 and paas_agent_2 to paas_agent:
emcli add_forwarders_for_paas_agent -paas_agent_name=<paas_agent> -agent_list="paas_agent_1,paas_agent_2"
Adds a user defined value for the global target property, Lifecycle. An error appears if the same lifecycle stage name already exists.
Format
emcli add_lifecycle_stage_name
-name="New Life Cycle Stage Name"
[ ] indicates that the parameter is optional. Delete if the verb has no optional parameters
Options
name
The lifecycle stage name to be added. Only letters, numbers or the underscore character can be used in the name.
Example
The following example adds the name "NewLifecycleSage2"for the global target property, Lifecycle.
emcli add_lifecycle_stage_name -name="NewLifecycleStage"
Adds a proxy which mediates the https traffic from Oracle Management Server to the Management Agent. Note that this proxy is modeled as an oracle_em_proxy target type. Management Agents can be associated with the proxy in two ways:
1) Using Management Agent names.
2) Using patterns for Management Agent names.
Currently, the oracle_em_proxy target type proxies are supported only for the traffic from Oracle Management Server to the Management Agent. For traffic in the reverse direction (i.e. from the Management Agent to Oracle Management Server), proxy settings can be specified in the corresponding Management Agent's emd.properties file.
Format
emcli add_proxy
-name="<name>"
-host="<host>"
-port=<port>
-protocol=<http | https>
[-named_credential="<credential name>"]
[-agents="<name1>,<name2>,..."]
-agent_patterns="<name pattern1>,<name pattern2>,..."]
[-excluded_agent_patterns="<name pattern1>,<name pattern2>,..."]
-oms_agent="<name>"
[ ] indicates that the parameter is optional.
Options
name
Unique name identifying a proxy.
host
Hostname of a machine where the proxy is set up.
port
Port on the proxy host offering the proxy service.
protocol
Protocol used by the traffic which the proxy mediates. The valid values of this option are http or https.
named_credential
Name of the Named Credential to be used for authentication with the proxy.
agents
Comma separated list of the names of Management Agents which the proxy mediates for. The backslash character (\) can be used as an escape character. If the Management Agent with the given name does not exist, it is ignored.
agent_patterns
Comma separated list of patterns for the names of Management Agents which the proxy mediates for. Pattern can use two wildcard characters:Asterisks (*) for one or more characters.Question mark (?) for a single character.Backslash (/) for an escape character.
excluded_agent_patterns
Comma separated list of patterns for the names of Management Agents which need to be excluded from the names of Management Agents identified by Management Agent name patterns associated with the proxy (using the -agent_patterns option). These patterns can also use the same wildcard characters that apply to the -agent_patterns option.
oms_agent
Name of Management Agent set up on Oracle Management Server.
parameter_1
Sentence fragment describing the parameter.
Example
The following example adds a new proxy using the options name, host, port, and protocol. In this example, the Management Agents are in the form "host<id>.<domain>.oracle.com:3535" , where 'id' is a 3 digit number ranging from 000 to 999, and domain with values "in", "us", "uk", or "fr". In such a deployment, this proxy is associated with host000 and host001 from the "us" domain and host100 to host179 from all the domains.
emcli add_proxy
-name="us-proxy-4"
-host="www-proxy-4.us.mycompany.com"
-port=80
-protocol=http
-agents="host000.mycompany.com:3535,host001.mycompany.com:3535"
-agent_patterns="host1*"
-excluded_agent_patterns="host18*,host19*"
-oms_agent="slc02pgw.mycompany.com:1838"
Associates new auxiliary hosts with the system. An auxiliary host can be any host that is not part of the system but is managed by Enterprise Manager Cloud Control. These hosts can be used to execute any script. Any other targets running on this host will not be part of Site Guard operation plan(s).
Format
emcli add_siteguard_aux_hosts
-system_name="name_of_the_system"
-host_name="name_of_the_auxiliary_host"
[ ] indicates that the parameter is optional
Options
system_name
Name of the system.
host_name
Name of the auxiliary host that the current user needs to add. This host must be managed by Enterprise Manager Cloud Control.
Example
This example associates auxiliary hosts host1.domain.com and host2.domain.com that are part of austin-system to the system:
emcli add_siteguard_aux_hosts
-system_name="austin-system"
-host_name="host1.domain.com;host2.domain.com"
Adds a named credential as a parameter for a Site Guard script. The values of user name and password of this credential can be accessed within the script.
Format
emcli add_siteguard_script_credential_params -script_id="Id associated with the script" -credential_name="name of the credential" [-credential_owner="credential owner"] [ ] indicates that the parameter is optional.
Options
script_id
The script ID.
credential_name
The name of the credential.
credential_owner
The owner of the credential. This option does not need to be specified if the owner of the credential is same as the logged in user.
Example
The following command adds a script ID and credential name to the siteguard script where the credential owner is SG_ADMIN.
emcli add_siteguard_script_credential_params
-script_id="2"
-credential_name="NAMED_CREDENTIAL_Y"
-credential_owner="SG_ADMIN"
Adds a host to the Site Guard configuration scripts.
Format
emcli add_siteguard_script_hosts
-script_id=<script_id>
-host_name=<name1;name2;...>
Options
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.
Example
The following example adds the host1.domain.com host to the Site Guard configuration script with the ID 10.
emcli add_siteguard_script_hosts
–script_id="10"
–host_name ="host1.domain.com"
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
Options
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 option 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 requiredoption 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 option is required for storage types OmsAgent and ExtAgent. This option must be specified together with the credential_owner option.
credential_owner
Owner of a named credential stored in the repository. This option is required for storage types OmsAgent and ExtAgent. This option must be specified together with the credential_name option.
Example
This example adds an OMS Agent File system storage location named myOMSAgtLocation for the path /u01/swlib' on host 'fs1.us.acme.com. The named credential MyAcmeCreds owned by ACME_USER is used for reading/writing files from this location.
emcli add_swlib_storage_location
-name="myOMSAgtLocation"
-path="/u01/swlib"
-type="OmsAgent"
-host="fs1.us.acme.com"
-credential_name="MyAcmeCreds"
-credential_owner="ACME_USER"
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. t db instance targets,You must use the instances option to specify DB instances before adding the cluster database.
Standard Mode
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;..."]
[-monitoring_creds="HostCredsPriv;host;HostCreds;HostUserName;foo;..."] [-access_point_name="ap_name"] [-access_point_type="ap_type"]
[ ] indicates that the parameter is optional
Server Discovery
Use the following syntax for server discovery:
emcli add_target
-name=${TARGET_NAME}
-type=oracle_si_server_map
-host=${AGENT_HOST}
-access_point_name=${TARGET_NAME_AP}
-access_point_type='oracle_si_server_ilom'
-properties='dispatch.url=ilom-ssh://${TARGET_IP}:22'
-subseparator=properties='='
-monitoring_creds='ilom_creds_set;oracle_si_server_ilom;ilom_
creds;username:${USERNAME};password:${PASSWORD}'
-monitoring_creds='ssh_creds_set;oracle_si_server_ilom;ssh_
creds;username:${USERNAME};userpass:${PASSWORD}'
Options
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 option, see -input_file Syntax Guidelines.
subseparator=properties
Specifies a string delimiter to use between the name and value in each name-value pair for the value of the -properties option. The default subseparator delimiter is ":".
For more information about the subsepator option, see -input_file Syntax Guidelines.
credentials
Monitoring credentials (name-value pairs) for the target instance. The "name"(s) are identified in the target-type metadata definition as credential properties. The credentials must be specified exactly as they are defined in the target's metadata file. Metadata files are located in $AGENT_HOME/sysman/admin/metadata.
input_file
Used in conjunction with the -credentials option, this enables you to store specific target monitoring credential values, such as passwords, in a separate file. The -input_file specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific monitoring credentials of the -credentials option. The tag must not contain colons ( : ) or semi-colons ( ; ).
For more information about the input_file option, see -input_file Syntax Guidelines.
display_name
Target name displayed in the Enterprise Manager Cloud Control console.
groups
Name-value pair list of the groups to which this target instance belongs. Follows the format of groupname:grouptype;groupname2:grouptype2.
timezone_region
GMT offset for this target instance. (-7 or -04:00 are acceptable formats.)
monitor_mode
Either 0, 1, or 2. The default is 0. 1 specifies OMS mediated monitoring, and 2 specifies Agent mediated monitoring.
instances
Name-value pair list of RAC database instances that the RAC database target has. Database instance targets must be added before trying to add the cluster database.
force
Forces the target to be added even if the target with the same name exists. Updates the properties of the target with your latest input.
timeout
Time in seconds for the command to wait to add the target to the Agent. The default is 10 minutes.
monitoring_creds
Sets a monitoring credential set for this target.
Separator=monitoring_creds
Specify a string delimiter to use between name-value pairs for the value of the -monitoring_creds option. The default separator delimiter is ";".
subseparator=monitoring_creds
Specify a string delimiter to use between name and value in each name-value pair for the value of the -monitoring_creds option. The default subseparator delimiter is ":".
access_point_name
Name of the access point target to be added which is tagged to given server target.
access_point_type
Type of the access point target to be added which is tagged to given server target.
Example
Example 1
The following example adds an oracle_database target with the name "database." Note how the credentials are specified. The names 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 names. The example uses the base minimum of required credentials and properties for the database target.
emcli add_target
-name="database"
-type="oracle_database"
-host="myhost.us.example.com"
-credentials="UserName:dbsnmp;password:dbsnmp;Role:Normal"
-properties="SID:semcli;Port:15091;OracleHome:/oracle;
MachineName:smpamp-example.com"
-groups="Group1:group;Group2:group"
Example 2
The following example adds a standalone Oracle HTTP Server.
Emcli add_target
-host=test.mycompany.com
-name=test13c
-type=oracle_apache
-properties=
"OracleHome->/scratch/smariswa/test13c|ConfigPath->/scratch/user1/test13c/user_projects/domains/test1213_domain/config/fmwconfig/components/OHS/ohs1|EMTargetType->oracle_apache|OracleInstance->na|compVersion->na|LifeCycleMBeanName->na|OPMNMBeanName->na| monMode->na|ProxyMBeanObjectName->na|ServerNames->na|CanonicalPath-> /instance1/ohs1/|HTTPMachine->blr2201947.mycompany..com|HTTPPort->7778|version->13.1|NMUser->weblogic|NMPwd->welcome1" -separator=properties="|" -subseparator=properties="->"
Example 3
The following example adds an oracle_database target with the name "database." Note how the credentials are specified. The names 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 names. The example uses the base minimum of required credentials and properties for the database target.
emcli add_target
-name="database"
-type="oracle_database"
-host="myhost.us.example.com"
-credentials="UserName:dbsnmp;password:dbsnmp;Role:Normal"
-properties="SID:semcli;Port:15091;OracleHome:/oracle;
MachineName:smpamp-example.com"
-groups="Group1:group;Group2:group"
Example 4
The following example discovers the server ILOM_SPARC at the target IP 10.133.245.231 using the user root and the password admin123:
emcli add_target
-name=ILOM_SPARC
-type=oracle_si_server_map
-host=`hostname`.mycompany.com
-access_point_name='ILOM_SPARC_AP'
-access_point_type='oracle_si_server_ilom'
-properties='dispatch.url=ilom-ssh://10.133.245.231:22'
-subseparator=properties='='
-monitoring_creds='ilom_creds_set;oracle_si_server_ilom;ilom_
creds;username:root;password:admin123'
-monitoring_creds='ssh_creds_set;oracle_si_server_ilom;ssh_
creds;username:root;userpass:admin123'
Adds a new target property for a given target type. All targets of this target type will have this new target property.
Format
emcli add_target_property
-target_type="target_type"
-property="prop_name"
Options
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
Example
This example adds the Owner Name property for all targets of type oracle_database.
emcli add_target_property -target_type="oracle_database" -property="Owner Name"
Adds a target to an enterprise rule set.
Privilege Requirements: A Super Administrator can add a target to any enterprise rule set except for predefined (out-of-box) rule sets supplied by Oracle.Only the owner or co-author of a rule set can add a target to it.
Format
emcli add_target_to_rule_set
-rule_set_name="rule set name"
-target_name="target name"
-target_type="internal name for the target type. For example, host"
[-rule_set_owner=<ruleset owner>]
[ ] indicates that the parameter is optional
Options
rule_set_name
Name of an enterprise rule set. This option only applies to rule sets that are associated with a list of targets.
target_name
Name of the target to be added.
target_type
Target type of the target to be added. For example, host.
rule_set_owner
Optionally, you can specify the owner of the rule set.
Example
This example adds the host target myhost.com to a rule set named rules. This rule set is owned by the administrator sysman.
emcli add_target_to_rule_set -rule_set_name='rules' -target_name='myhost.com' -target_type='host' -rule_set_owner='sysman'
Adds the property to the property master list.
Format
Standard Mode
emcli add_to_target_properties_master_list
-property_name="null"
-property_value="null"
Interactive or Script Mode
emcli add_to_target_properties_master_list(
property_name="null"
,property_value="null"
)
Options
property_name
The name of the property to be added.
property_value
The value of the property to be added.
Exit Codes
Enter exit codes, if available, or delete if no exit codes. For example:
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
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
Options
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" option 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 option is honored only if the value for the wait_for_completion option 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 option, see -input_file Syntax Guidelines.
subseparator=credentials
Custom separator for a key value pair. Specify a string delimiter to use between name and value in each name-value pair for the values of the -credentials option. The default separator delimiter is ":".
For more information about the subseparator option, see -input_file Syntax Guidelines.
input_file
Optionally use in conjunction with the -credentials option. You can use this option to set specific target monitoring credential values, such as passwords or SSH keys, in a separate file.
This option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific -credentials property values.
Examples
Example 1
This example adds an Oracle Virtual Platform with a Unix Sudo user who requires SSH key Passphraseless-based authentication. The SSH private key, SSH public key, and password are read from input files.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsSshKeyCreds;PrivilegeType:sudo;privilegedUser:true;
RunAs:root;PrivilegeCommand:/usr/bin/sudo -S -u %RUN_AS% %COMMAND%;
EnablePseudoTerminal:false;SshPrivateKey:PRIVATE_KEY;
SshPublicKey:PUBLIC_KEY;OVSUsername:sudoer1;OVSPassword:PWD_FILE'
-input_file='PRIVATE_KEY:id_dsa'
-input_file='PUBLIC_KEY:id_dsa.pub'
-input_file='PWD_FILE:password'
Example 2
This example adds an Oracle Virtual Platform with a Unix PowerBroker user who requires SSH key Passphraseless based authentication. The SSH private key, SSH public key, and password are read from input files.
emcli add_virtual_platform
-name=example.com
-agent=example.com:1838
-credentials='type:DMOvsSshKeyCreds;PrivilegeType:powerbroker;
privilegedUser:true;RunAs:root;PrivilegeCommand:
/usr/bin/pbrun -l -u %RUN_AS% %COMMAND%;
PowerBrokerProfile:profile;PowerBrokerPasswordPrompt:myprompt;
SshPrivateKey:PRIVATE_KEY;SshPublicKey:PUBLIC_KEY;
OVSUsername:myuser;OVSPassword:PWD_FILE'
-input_file='PRIVATE_KEY:id_dsa'
-input_file='PUBLIC_KEY:id_dsa.pub'
-input_file='PWD_FILE:password'
Allocates quota to an assignee.
Format
Interactive or Script Mode
emcli allocate_quota
assignee_name="assignee name"
assignee_type="assignee type"
[quota="quota"]
Options
assignee_name
The name of the assignee to whom the quota will be allocated.
assignee_type
The type of assignee. Valid values are: Tenant, User_Profile, or User.
quota
The quota that will be allocated for the assigned user. Quota allocations can be defined:
at the entity level.
on a quota assignable object if the selected entity supports quota allocation on objects. When quota is allocated on an object, all quota related computations will be done in the context of that object.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example allocates quota on a quota assignable object.
emcli allocate_quota
-assignee_name=T1
-assignee_type=tenant
-quota=Component1:Entity1;0.1:Gb;object_name=OBJ1:object_type=type1
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
Options
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.
Example
This example lists matches for all unconverted UDMs in the specified migration session.
emcli list_unconverted_udms -session_id=<sessionId>
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
Options
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.
Activates Sudo or PowerBroker settings for specified targets.
Standard Mode
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
Interactive or Script Mode
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
Options
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 option, see -input_file Syntax Guidelines.
force
If yes, the operation continues and ignores any invalid targets. The default is no.
Examples
Example 1
This example applies a privilege setting named sudo_setting. This setting applies to targets of type host, and it is being applied to host1, host2, and so forth.
emcli apply_privilege_delegation_setting
-setting_name=sudo_setting
-target_type=host
-target_names="host1;host2;"
Example 2
This example applies a privilege setting named sudo_setting. This setting applies to targets of type host, and it is being applied to host1, host2, and so forth. The force flag indicates that the setting is applied to all valid targets, and invalid targets are ignored.
emcli apply_privilege_delegation_setting
-setting_name=sudo_setting
-target_type=host
-target_names="host1;host2;"
-force=yes
Applies a monitoring template to a list of specified targets. The options 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
Options
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 option 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 option, see -input_file Syntax Guidelines.
Examples
Example 1
This example applies a monitoring template named my_db_template. This template applies to targets of type oracle_database, and it is being applied to db1 , which is of type oracle_database, and my_db_group, which is of type composite.
For composite targets, the template is only applied to member targets that belong to the target type for which the template is applicable. Since the copy_flags is not specified, the default ("Apply threshold settings for monitored objects common to both template and target") is meant.
emcli apply_template
-name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
Example 2
This example applies the monitoring template named my_db_template. This template is applicable to targets of type oracle_database. This command applies this template to two targets: target db1 of type oracle_database and target my_db_group of type composite.
For composite targets, the template is applied only to the member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as "1", the template is superimposed on the target. All keys in the template are copied to the target, and any extra keys present in the target are deleted. The credentials needed for the UDMs are present in file /usr/user/db_credentials.txt.
The replace_metrics flag set to 1 denotes that the thresholds of the metrics present in the target, but not in the template, are set to NULL. That is, these metrics in the target are not monitored, and therefore, no alert is raised for them.
emcli apply_template -name="my_db_template"
-targets="db1:oracle_database;my_db_group:composite"
-copy_flags="1" -replace_metrics="1" -input_file=
"FILE1:/usr/user/db_credentials.txt"
Applies the variables and test definitions from the file(s) into a repository target.
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
Options
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 option, see -input_file Syntax Guidelines.
input_file=variables
Name of the input file containing the variable definitions. If this attribute is not specified, the variables are extracted from the same file containing the test definitions.
The variables file format is as follows:
<variables xmlns="template"> <variable name="<name1>" value="<value1>"/> <variable name="<name2>" value="<value2>"/> ... </variables>
For more information about the input_file option, see -input_file Syntax Guidelines.
input_file=atsBundleZip
Name of the ATS bundle zip defined in the template.
For more information about the input_file option, see -input_file Syntax Guidelines.
useBundleDatabankFile
If you specify this option, the bundle databank files are used.
useFirstRowValues
If you specify this option, the first row values are used.
overwriteExisting
Specifies which tests should be overwritten in case they already exist on the target. The possible values are:
'none' (default): None of the existing tests on the target will be overwritten.
'all': If a test with the same name exists on the target, it will be overwritten with the test definition specified in the template file.
<test1>:<type1>;<test2>:<type2>;...: If any of the tests with names <test1>, <test2>, and so forth exist on the target, they are overwritten with the definition in the template file.
encryption_key
Optional key to decrypt the file contents. This key should be the same as the one used to encrypt the file.
swlibURN
Loads the software library entity through an URN. The respective entity data such as OATZ zip file and Zip File Name will be associated to the new service test. Either this option or the -swlibPath option 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 option or the -swlibURN option 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
This example applies the test definitions contained in the file my_template.xml into the Generic Service target my_target, using the key my_password to decrypt the file contents. If tests with names my_website or my_script exist on the target, they are overwritten by the test definitions in the file.
emcli apply_template_tests
-targetName='my_target' -targetType='generic_service'
-input_file=template:'my_template.xml' -encryption_key='my_password'
-overwriteExisting='my_website:HTTP;my_script:OS'
Example 2
This example applies the test definitions contained in file my_template.xml into the Web Application target my_target using the variable values specified in file my_variables.xml. If any tests in the target have the same name as tests specified in the template file, they are overwritten.
emcli apply_template_tests
-targetName='my_target' -targetType='website'
-input_file=template:'my_template.xml' -input_file=variables:
'my_variables.xml'
-overwriteExisting='all'
Applies an update.
Format
emcli apply_update
-id="internal id"
Options
id
Internal identification for the update to be applied.
Example
This example submits a job to apply an update, and prints the job execution ID upon submission.
emcli apply_update
-id="914E3E0F9DB98DECE040E80A2C5233EB"
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
Options
delim
String used as a delimiter between two verbs in the argument file. The default delimiter is a newline character.
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
Options
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
This 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"
Triggers a corrective action for a specified rule.
Format
emcli assign_compliance_ca
-rule_iname="<rule_internal_name>"
-target_type="<target_type>"
-ca_name="<correction_action_name>"
Options
rule_iname
Internal name of the compliance standard rule. Rule internal names are available in the MGMT$CS_RULE_ATTRS view.
target_type
Target type associated with the compliance standard rule.
ca_name
Name of the corrective action.
Example
The following example assigns the my_action corrective action to the my_rule compliance standard rule which is located in the host target.
emcli assign_compliance_ca
-rule_iname="my_rule"
-target_type="host"
-ca_name="my_action"
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
Options
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
This 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"
Assigns or updates the Customer Support IDentifier (CSI) to the given target name and type.
Format
emcli assign_csi_at_target_level
-target_name="Target_name"
-target_type="Target_type"
-csi="Customer_Support_IDentifier_value"
-mos_id="My_Oracle_Support_ID"
Options
target_name
Name of the Cloud Control target.
target_type
Type of Cloud Control target
csi
Customer Support Identifier value to be assigned.
mos_id
My Oracle Support (MOS) user ID.
Example
emcli assign_csi_at_target_level
-target_name="myhost.us.example.com"
-target_type="oracle_example_type"
-csi=12345678
-mos_id="abc@xyz.com"
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"
Options
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
This 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
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
Options
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.
Example
This 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'
Associates the specified compliance standard with the specified groups of targets for test mode or normal mode. Test mode is applicable only for drift and consistency compliance standards.
Format
emcli associate_cs_group_targets
-cs_iname="<internal_name_of_standard>"
-author="<author>"
-version="<version>"
(-group_names="<group_name_list>" | -group_names_file="<file_name>)"
Options
cs_iname
Internal name of the compliance standard.
author
Author of the compliance standard.
version
Version of the compliance standard.
group_names
Comma separated list of group names.
group_names_file
Name of the file that contains the group names. The group names can be either comma-separated values or in a file where the group names are listed on separate lines. Examples are:
-group_names_file=group1,group2,group3
-group_names_file="group.txt" where group.txt contains the following lines:
Note: Use either group_names or group_names_file.
Example
The following example creates associations for the second version of the security standard, authored by Jones, for the groups named tgt_grp1 and tgt_grp2.
emcli associate_cs_group_targets
-cs_iname="security_standard"
-author="Jones"
-version="2"
-group_names="tgt_grp1,tgt_grp2"
Associates the specified standard with the listed targets.
Note: When the standard is provided by Oracle, the <std_name> is the standard internal name.
Format
associate_cs_targets -name="<std_name>" -version="<std_version>" -author="<author_name>" -target_list="<target_name>[,<target_name>,<group_name>:Group]*" -target_list_file="<file_name>" [ ] indicates that this option is optional
Options
name
Name of the standard.
version
Version of the standard.
author
Author of the standard. When the standard is provided by Oracle, the <std_name> is the standard internal name, for example, sysman.
target_list
Name of the target. This option is useful when a compliance standard is to be associated with one or a small number of targets. Targets are separated by commas. When providing a group target, it should be appended with ":Group". Examples are:
-target_list="slc0host"
-target_list="slc0host,slc-host01"
-target_list="slc0host,host_grps:Group"
target_list_file
Name of the file that contains the list of targets. The targets can be either comma-separated values or in a file where the targets are listed on separate lines. Examples are:
-target_list_file=slc0host,slc0host1,slc0host02
-target_list_file="slc0host.txt" Where slc0host.txt contains the following lines:
slc0host
slc0host01
slc0host02
Note: Use either the target_list option or the target_list_file option.
Examples
Example 1
The following example specifies the target_list.
emcli associate_cs_targets -name="secure configuration for host" -version="1" -author="sysman" -target_list="host1,host2,group1:Group"
Example 2
The following example specifies the target_list_file.
emcli associate_cs_targets -name="secure configuration for host" -version="1" -author="sysman" -target_list_file="file with target name list"
Associates a target to an existing Application Data Model.
Format
emcli associate_target_to_adm
-adm_name=<application_data_model_name>
-target_name=<target_name>
-target_type=<target_type>
[ ] indicates that the parameter is optional
Options
adm_name
Application Data Model name to which the target will be associated.
target_name
Application Data Model name to which the target will be associated.
target_type
Type of target that will be associated with the Application Data Model.
Output
Success/error messages
Example
This example associates target test_database to the Application Data Model named Sample_ADM.
emcli associate_target_to_adm -adm_name=Sample_ADM -target_name=test_database
-target_type=oracle_pdb
Associates a user profile with a set of users.
Format
Standard Mode
emcli associate_user_profile
-name="profile name"
-users="users to be associated"
Interactive or Script Mode
emcli associate_user_profile(
name="profile name",
users="users to be associated" )
Options
name
Identifies the name of the user profile.
users
Identifies the name of the users with whom the user profile is to be associated.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
This example associates the profile1 user profile with users user1 and user2.
emcli associate_user_profile
-name="profile1"
-users=user1;user2
Adds a database to the AWR Warehouse.Prerequisites:
AWR Warehouse should be configured.
The database being added cannot be:
A PDB
An instance of a RAC database
The AWR Warehouse
Preferred host and database credentials should already be set for the database being added.
The database user should be a DBA.
The database user should have execute privilege on SYS.DBMS_SWRF_INTERNAL.
Format
emcli awrwh_add_src_db -target_name=<Target Database> -target_type=<Target Database Type>
Options
target_name
Name of existing target database.
target_type
Type of target. The possible values for target type are oracle_database and rac_database.
Output
Success / Error message
Example
The following example adds target database sample_database to the AWR Warehouse:
emcli awrwh_add_src_db -target_name=sample_database -target_type=oracle_database
Lists all the source databases uploading to the AWR Warehouse. Enterprise Manager Super Administrators can view all databases uploading to the AWR Warehouse. Enterprise Manager Administrators can only view databases added by themselves or databases on which they have view privileges.Prerequisites:AWR Warehouse should be configured.
Format
emcli awrwh_list_src_dbs[-all | -dbs_with_no_recent_uploads][-script | -format=[name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"];][-noheader]
Options
all
Sentence fragment describing the option.
dbs_with_no_recent_uploads
Lists all source databases with no recent uploads.
script
This option is equivalent to -format='name: script'
format
Format specification (default is -format="name: pretty"). Use the following commands for alternate formats:
-format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.
-format="name:script" sets the default column separator to a tab and the default row separator to a newline.
-format="name:csv" sets the column separator to a comma and the row separator to a newline.
noheader
Column headers would not be printed if this option is specified.
Output
Lists databases uploading to AWR Warehouse
Examples
The following example lists all the source databases uploading to the AWR Warehouse.
Example 1
The following example lists all the source databases uploading to the AWR Warehouse.
emcli awrwh_list_src_dbs
Example 2
The following example lists all the source databases uploading to the AWR Warehouse without the column headers.
emcli awrwh_list_src_dbs
-noheader
Removes an existing database from the AWR Warehouse.Prerequisites:
AWR Warehouse should be configured
Database specified should be uploading to the AWR Warehouse
Format
emcli awrwh_remove_src_db
-target_name=<Target Database>
-target_type=<Target Database Type>
Options
target_name
Name of existing target database.
target_type
Type of target. The possible values for target type are 'oracle_database' and 'rac_database'.
Output
Success / Error
Example
The following example removes target database sample_database from the AWR Warehouse.
emcli awrwh_remove_src_db -target_name=sample_database -target_type=oracle_database
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
Options
input_file
Input XML file confirming to the XSD for bare metal provisioning. See below for a detailed XML file used to provision BMP.
For more information about the input_file option, see -input_file Syntax Guidelines.
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>myhost.us.example.com</HostName> <BootableMac>aa:bb:cc:dd:ee:ff</BootableMac> --> <!-- If TargetType is Subnet: replace <MACAddress> with following <SubnetIP>10.244.177.252</SubnetIP> <SubnetMask>255.255.252.0</SubnetMask> --> </TargetInfo> <!-- If TargetType is RE_IMAGE: <HostTargetsPreferredCredSetName>cred1<.HostTargetsPreferredCredSetName> Specify the preferred credentials name to be used for accessing the EM Host targetse to be Re-imaged. --> <StageServer>myhost.us.example.com</StageServer> <!--Specify the Stage Server host name. For ex : myhost.mydomain.com--> <StageStorage>/scratch/stage</StageStorage> <!--Specify the Stage Storage on the stage server. For ex : /scratch/stage--> <StageServerPreferredCredSetName>Cred1</StageServerPreferredCredSetName> <!--Specify the preferred credentials name to be used for accessing the stage server.--> <StageServerPrereqs>false</StageServerPrereqs> <!--Specify if the pre-requisties check should be run on the stage server before starting the provisioning.--> <BootServer>myhost.us.example.com</BootServer> <!--Specify the Boot Server host name. For ex : myhost.mydomain.com--> <BootServerPreferredCredSetName>Cred1</BootServerPreferredCredSetName> <!--Specify the preferred credentials name to be used for accessing the boot server.--> <BootServerPrereqs>false</BootServerPrereqs> <!--Specify if the pre-requisties check should be run on the boot server before starting the provisioning.--> <DhcpServer>myhost.us.example.com</DhcpServer> <!--Specify the Dhcp Server host name. This is required only if DHCP automation is required. For ex : myhost.mydomain.com Note : Dhcp automation is supported only for the MAC and RE_IMAGE provisioning types.--> <DhcpServerPreferredCredSetName>Cred1</DhcpServerPreferredCredSetName> <!--Specify the preferred credentials name to be used for accessing the Dhcp server.--> <DhcpServerPrereqs>false</DhcpServerPrereqs> <!--Specify if the pre-requisties check should be run on the Dhcp server before starting the provisioning.--> <RpmRepository>oelrepos</RpmRepository> <!--Specify the RPM repository name to be used for provisioning operation. For ex : OEL4U8repos--> <RootPassword>password</RootPassword> <!--Specify the root password for the provisioned machines.--> <TimeZone>Africa/Algiers</TimeZone> <!--Specify the time zone for the provisioned machines.--> <AgentInstallUser>oraem</AgentInstallUser> <!--Specify the user name for installing EM agent on the provisioned machines. For ex : oraem--> <AgentInstallGroup>dba</AgentInstallGroup> <!--Specify the agent installation user's group for installing EM agent on the provisioned machines. For ex : dba--> <AgentBaseInstallationDirectory>/var/lib/oracle/agent12g</AgentBaseInstallationDirectory> <!--Specify a directory for installing EM agent on the provisioned machines. For ex : /var/lib/oracle/agent12g--> <OracleInventoryLocation>/var/lib/oracle/oraInventory</OracleInventoryLocation> <!--Specify a directory for storing oracle installed product's inventory on the provisioned machines. For ex : /var/lib/oracle/oraInventory--> <AgentRegistrationPassword>password</AgentRegistrationPassword> <!--Specify agent registration password for installing EM agent on the provisioned machines.--> <AgentRpmUrl>http://myhost.us.example.com/oracle-agt.12.1.0.0.1-i386.rpm</AgentRpmUrl> <!--Specify a http URL for fetching agent RPM. This is not mandatory if the agent rom is already placed at the staged location--> <ReferenceAnaconda/> <!--Specify a reference anaconda as a string. It will be used to capture properties like Keyboard, mouse. If not provided they will be defaulted to default values.--> <PackageList>@base</PackageList> <!--Specify the package list to be installed on the provisioned machines.--> <ACPI>off</ACPI> <!--Specify the ACPI value for the provisioned machines. Supported values are : on, off--> <ParaVirtualizedKernel>false</ParaVirtualizedKernel> <!--Specify if the provisioned machines should be booted with paravirtualized kernels.--> <PostInstallScript>%post echo "post" </PostInstallScript> <!--This section provides the option of adding commands to be run on the system once the installation is complete. This section must start with the %post command.--> <FirstBootScript>#!/bin/sh # chkconfig: 345 75 25 # description: Bare Metal Provisioning First boot service # </FirstBootScript> <!--This section provides the option of adding commands to run on the system when it boots for the first time after installation.--> <RequireTTY>false</RequireTTY> <!--Specify if tty is required on the provisioned machines.--> <SeLinux>Disabled</SeLinux> <!--Specify the SELinux configuration for the provisioned machines. Supported values are : Disabled, Enforcing, Permissive--> <MountPointSettings/> <!--Specify /etc/fstab settings for the provisioned machines.--> <NISSettings/> <!--Specify /etc/yp.conf settings for the provisioned machines.--> <NTPSettings/> <!--Specify /etc/ntp.conf settings for the provisioned machines.--> <KernelParameterSettings/> <!--Specify /etc/inittab settings for the provisioned machines.--> <FirewallSettings/> <!--Specify the firewall settings for the provisioned machines.--> <HardDiskProfiles> <!--Specify the Hard Disk profiles for the provisioned machines.--> <HardDiskConfiguration> <!--Specify the hard disk configuration details--> <DeviceName>hda</DeviceName> <!--Specify the device name for the disk. For ex : hda,hdb--> <Capacity>10000000</Capacity> <!--Specify the disk capacity in MB. For ex : 1024--> </HardDiskConfiguration></HardDiskProfiles><PartitionConfigurations> <!--Specify the partition configurations for the provisioned machines.--> <PartitionConfiguration> <!--Specify the partition configuration details.--> <MountPoint>/</MountPoint> <!--Specify the mount point for the partition. For ex : /, /root--> <DeviceName>hda</DeviceName> <!--Specify the disk name on which this partition has to be configured. For ex : hda,hdb--> <SystemDeviceName>/dev/hda1</SystemDeviceName> <!--For ex : /dev/hda1--> <FileSystemType>ext3</FileSystemType> <!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap, Raid, LVM--> <Size>4096</Size> <!--Specify the size in MB for this partition. For ex : 5120--> </PartitionConfiguration></PartitionConfigurations><RaidConfigurations> <!--Specify the RAID configurations for the provisioned machines.--> <RaidConfiguration> <!--Specify the RAID configuration details--> <MountPoint>raid.100</MountPoint> <!--Specify the raid id . For ex : raid.100--> <RaidLevel>0</RaidLevel> <!--Specify the RAID Level for this raid device. Supported RAID Levels are : Raid 0, Raid 1, Raid 5, Raid 6--> <Partitions>/dev/hda1,/dev/hda2</Partitions> <!--Specify the raid partitions for this raid device as a csv string. For ex : /dev/hda1, /dev/hda2--> <FileSystemType>ext3</FileSystemType> <!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap, LVM--> </RaidConfiguration></RaidConfigurations><LogicalVolumeGroups> <!--Specify the Logical Volume Groups for the provisioned machines.--> <LogicalVolumeGroup> <!--Specify the logical volume group configuration details--> <GroupName>LVG1</GroupName> <!--Specify the Logical group name. For ex : mygrp--> <Partitions>/dev/hda1</Partitions> <!--Specify the partitions that take part in this logical volume group as a csv string. For ex : /dev/hda1, /dev/hda2--> <Raids>raid.100</Raids> <!--Specify the RAIDs that take part in this logical volume group as a csv string. For ex : raid.100, raid.200--> </LogicalVolumeGroup></LogicalVolumeGroups><LogicalVolumes> <!--Specify the Logical Volumes for the provisioned machines.--> <LogicalVolume> <!--Specify the logical volume configuration details.--> <MountPoint>/u01</MountPoint> <!--Specify the mount point for this logical volume. For ex : /, /root--> <LogicalVolumeName>LV1</LogicalVolumeName> <!--Specify the logial volume name. For ex : myvols--> <LogicalGroupName>LVG1</LogicalGroupName> <!--Specify the logical group name where this volume should be created. For ex : mygrp--> <FileSystemType>ext3</FileSystemType> <!--Specify the File System type for this partition. Supported file system types are : ext2, ext3, ocfs2, swap--> <Size>4096</Size> <!--Specify the size in MB for this partition. For ex : 5120--> </LogicalVolume></LogicalVolumes></DeployedImage>
Cancels scheduled cloud service request(s) initiated by the specified user. Note that only scheduled requests can be cancelled.
Format
emcli cancel_cloud_service_requests
-user="username"
[-family="family"]
[-ids="id1;id2..."]
[ ] indicates that the parameter is optional
Options
user
Name of the user who initiated the requests.
family
Service family name to use to filter cloud requests.
ids
List of Request IDs to use to filter cloud requests. Separate each ID with a semicolon ( ; ).
Examples
Example 1
This example cancels all scheduled cloud requests owned by user1.
emcli cancel_cloud_service_requests
-user="user1"
Example 2
This example cancels all cloud requests owned by user1 and belonging to the family1 service family.
emcli cancel_cloud_service_requests
-user="user1"
-family="family1"
Assigns the ownership of an enterprise rule set to a new owner.
Privilege Requirements:
The new owner must have the following privileges:
Edit Enterprise Rule set on the rule set.
If specific targets are selected in the rule set, the new user must have View Target privilege on those targets.
If some of the rules either creates or updates incidents, the new user must have Manage Target Event privilege on those targets as well.
Format
emcli change_ruleset_owner
-rule_set_name='rule set name'
-rule_set_owner=<rule set owner>
-new owner=<new owner>
Options
rule_set_name
Name of an enterprise rule set. This option only applies to rule sets that are associated with a list of targets.
rule_set_owner
Current owner of the rule set.
new_owner
New owner of the rule set.
Example
The following example removes USER1 as the owner of rule set "My rule set" and assigns USER2 as the new owner.
emcli change_ruleset_owner -rule_set_name 'My rule set' -rule_set_owner USER1 - new_owner USER2
Adds a comment to a specified problem.
Format
emcli add_comment_to_problem
-problem_id="Problem ID"
-comment="text"
Options
problem_id
ID of the problem to which a comment is to be added.
comment
Comment verbiage.
Example
The following command adds the comment "Working on this" to a problem with the ID 2.
emcli -add_comment_to_problem -problem_id="2" -comment="Working on this"
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
Options
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
This example changes the system for a generic service named my service to a generic system named my system with specified key components.
emcli change_service_system_assoc
-name='my service' -type='generic_service'
-systemname='my system' -systemtype='generic_system'
-keycomponents='database:oracle_database; mytestbeacon:oracle_beacon'
Changes the owner of the target.
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
Options
target
Target name and target type to change the owner.
owner
Name of the existing owner of the target. The default value for this option is the currently logged in user.
new_owner
New owner name of the target.
Example
This 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"
Removes all members of a Coherence cluster whose status is down including the node and cache targets.
Format
emcli clean_down_members
-coherence_cluster_name:<Coherence Cluster Target Name> [-debug]
Options
coherence_cluster_name
Fully qualified name of the Coherence cluster target.
debug
Runs the verb in verbose mode for debugging purposes.
Example
This example deletes all members whose status is down in the TestCluster target.
emcli clean_down_members
-coherence_cluster_name:"TestCluster"
Cleans up requests from the host and Enterprise Manager. Depending on the options specified, this verb:
Cleans up all failed requests from a pool.
Cleans up all requests from a pool.
Cleans up failed requests for a specific user.
Cleans up all requests for a specific user.
Format
emcli help cleanup_dbaas_requests
emcli cleanup_dbaas_requests [-ids="<request id>"] [-pool_name="<pool name>" -pool_type="
<database|schema|pluggable_database>"
[-user="<SSA user name>"]
[-all]]
[ ] indicates that the parameter is optional.
Options
ids
Request ID to be used for filtering Cloud requests, separated by semicolons( ; ).
pool_name
Name of the pool from which requests must be cleaned up.
pool_type
Type of pool. Enter one of the following values:
For database pools: database
For schema pools: schema
For pluggable database pools: pluggable_database
user
User name to be used for filtering requests for deletions.
all
If specified, cleans up all requests (successful and failed), cancels the requests that are in a scheduled state, and leaves the requests that are in progress as is. If this option is not specified, cleanup is performed on failed requests only.
Note:
The ids and pool_name options cannot be used together.
Examples
Example 1
This example performs a cleanup of all requests, both failed and successful. This process essentially resets the pool.
emcli cleanup_dbaas_requests -pool_name="database_pool" -pool_type="database" -all
Example 2
This example performs a cleanup of all requests (failed and successful) for a specific user. This option is useful in cases where the user is no longer in the system and the administrator wants to clean up all of the service instances owned by this user.
emcli cleanup_dbaas_requests -pool_name="database_pool" -pool_type="database" -all -user="SSA_USER"
Clears all corrective actions for a specified compliance standard rule and target type.
Format
emcli clear_compliance_ca
-rule_iname="<rule_internal_name>"
-target_type="<target_type>"
Options
rule_iname
Internal name of the compliance standard rule from which all corrective actions are being removed. The compliance standard rule internal names are available in the MGMT$CS_RULE_ATTRS view.
target_type
Target type associated with the compliance standard rule.
Example
The following example clears all corrective actions associated with the my_rule compliance standard rule located on the host target.
emcli clear_compliance_ca
-rule_iname="my_rule"
-target_type="host"
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
Options
target_type
Type of target, which must be "host" if you specify the oracle_homes option.
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 option.
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.
Example
The following example clears the credential set DBCredsNormal with the user admin1 for the myDB target.
emcli clear_credential
-target_type=oracle_database
-target_name=myDB
-credential_set=DBCredsNormal
-user=admin1
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"
Options
?set_name
Clears the default preferred credential for this credential set.
target_type
Target type for the credential set.
Example
This 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
Clears the default privilege delegation settings for a specified platform.
Format
Standard Mode
emcli clear_default_privilege_delegation_setting
-platform_list="PLATFORM_DEFAULT"
Interactive or Script Mode
clear_default_privilege_delegation_setting(
platform_list="PLATFORM_DEFAULT"
)
[ ] indicates that the parameter is optional
Options
platform_list
Comma-separated list of platforms for which default privilege delegation settings are removed. Supported platforms: Linux, HP-UX, SunOS, and AIX.
Exit Codes
0 on success. A non-zero value means verb processing was not successful.
Example
This example clears the default privilege delegation setting for Linux, HP-UX, SunOS, and AIX platforms.
emcli clear_default_privilege_delegation_setting -platform_list="Linux,HP-UX,SunOS,AIX"
Clears the monitoring credential set for the target.
Format
emcli clear_monitoring_credential
-set_name="set_name"
-target_name="target_name"
-target_type="ttype"
Options
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.
Example
This 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
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"
Options
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.
Example
This 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
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
Options
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 option, see -input_file Syntax Guidelines.
force
If set to yes, invalid and unreachable targets are ignored and the setting is removed from all valid and up targets. If set to no, invalid and down targets raise an error. The default is no.
Example
The following example force clears the privilege delegation setting from the host listed in the file.text input file.
emcli clear_privilege_delegation_setting
-input_file="FILE:/home/user/file.txt"
-force=yes
Clears problems matching the specified criteria (problem key, target type, and age). Only users with Manage Target privilege can clear the problems for a target. When a problem is cleared, the underlying incidents and events are also cleared.
By default, the problem notification is not sent out. You can override this by specifying the send_notification option. Clearing the underlying incidents and events does not send out a notification.
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
Options
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 optiondoes not require any value.
preview
Gets the number of problems that the command would clear.
Examples
Example 1
This example clears ORA-600 problems across all databases that have occurred (based on the occurrence date of the first incident) for at least 3 days.
emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database" -older_than="3"
Example 2
This example sends applicable notifications when the problem clears. By default, a notification is not sent for the cleared problems.
emcli clear_problem -problem_key="ORA-600" -target_type="oracle_database" -older_than="3" - send_notification
Clears the stateless alerts associated with the specified target. Only a user can clear these stateless alerts; the Enterprise Manager Agent does not automatically clear these alerts. To find the metric internal name associated with a stateless alert, use the get_metrics_for_stateless_alerts verb.
You cannot use this command to clear stateless alerts associated with diagnostic incidents. You can only clear these alerts in the Enterprise Manager console by clearing their associated Incident or Problem.
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
Options
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).
Example
This example clears alerts generated from the database alert log over a week old. In this example, no notifications are sent when the alerts are cleared.
emcli clear_stateless_alerts -older_than=7 -target_type=oracle_database -tar get_name=database -metric_internal_name=oracle_database:alertLog:genericErrStack -ignore_notifications
Clones the specified Application Server Oracle Home or S/W Library component from the target host to specified destinations. For a Portal and Wireless installation, the OID user and password are also needed. For a J2EE instance connected to only a DB-based repository, a DCM Schema password is needed.
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
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"]
[ ] indicates 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 option, see -input_file Syntax Guidelines.
list_exclude_files
Comma-separated list of files to exclude. Not required if the source is software lib. "*" can be used as a wild card.
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
ryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the cloning job.
iasInstance
Name of instance.
isIas1013
Specifies whether this is a 10.2.3 Ias home.
oldoc4jpassword
Old OC4j password. (Required for 10.1.3 Ias homes.)
oc4jpassword
New OC4J password. (Required for 10.1.3Ias homes.)
oldIASAdminPassword
Old Application Server administrator password. (Not required for 10.1.3 Ias homes.)
newIASAdminPassword
New Application Server administrator password. (Not required for 10.1.3 Ias homes.)
oiduser
OID admin user.
oidpassword
OID admin password.
dcmpassword
DCM schema password.
prescripts
Path of script to execute.
Note:
Double-quoted options 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.
Example
emcli clone_as_home
-input_file="dest_properties:/home/destinations.txt"
-list_exclude_files="centralagents.lst"
-isSwLib="false"
-tryftp_copy="false"
-jobname="clone as home"
-iasInstance="asinstancename"
-isIas1013="false"
-oldIASAdminPassword="oldpassword"
-newIASAdminPassword="newpassword"
-prescripts="/home/abc/myscripts"
-run_prescripts_as_root="true"
-rootscripts="%oracle_home%/root.sh"
-source_params="TargetName:host.domain.com;HomeLoc=/home/oracle/appserver1;
HomeName=oracleAppServer1;ScratchLoc=/tmp"
Creates an Oracle Clusterware cluster given a source Clusterware home location or a Clusterware S/W Library component for specified destination nodes.
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"]
[ ] indicates 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 option, see -input_file Syntax Guidelines.
list_exclude_files
Comma-separated list of files to exclude. Not required if the source is software lib. An asterisk "*" can be used as a wildcard.
isSwLib
Specifies whether it is an Oracle Home database or Software Library.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using emcli from the command line.
jobname
Name of the cloning job.
home_name
Name of the home to use for all homes in the Oracle Clusterware cluster.
home_location
Location of the home to use for all homes in the Oracle Clusterware cluster.
clustername
Name of the cluster to create.
isWindows
Specify whether the cloning source is on a Windows Platform. This option only applies for creating CRS cloning from a Gold Image source. The default value is false.
ocrLoc
Oracle Cluster Registry Loaction.
vdiskLoc
Voting disk location.
prescripts
Path of the script to execute.
Note:
Double-quoted options 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.
Example
emcli clone_crs_home -input_file="dest_properties:crs.prop" -isSwLib="true" -tryftp_copy="true" -jobname="crs cloning job2" -home_name="cloneCRS1" -home_location="/scratch/scott/cloneCRS1 " -clustername="crscluster" -ocrLoc="/scratch/shared/ocr" -vdiskLoc="/scratch/shared/vdisk" -postscripts="%perlbin%/perl%emd_root%/admin/scripts/cloning/samples/ post_crs_ create.pl ORACLE_HOME=%oracle_home%" -run_postscripts_as_root="true" -rootscripts="%oracle_home%/root.sh" -swlib_component="path:Components/crscomp;version:.1"
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
Clones a database.
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"
[ ] indicates 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 options.
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 Recovery 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 option 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 option 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 option 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 option 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 option 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.
Example
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"
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"]
[ ] indicates 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 option, see -input_file Syntax Guidelines.
list_exclude_files
Comma-separated list of files to exclude. This is not required if the source is software lib. "*" can be used as a wild card.
isSwLib
Specifies whether the source is an Oracle Home database or Software Library.
isRac
Specifies whether cloning in RAC mode. If the isRac option is true, a RAC cluster is created. If the isRac option is true, the home name and location of the RAC cluster are needed.
tryftp_copy
Try FTP to copy or not. You should set the FTP copy option to false when using EM CLI from the command line.
jobname
Name of the cloning job.
home_name
Name of the home to use when creating a RAC cluster.
home_location
Location of the home to use when creating a RAC cluster.
prescripts
Path of the script to execute.
Note:
Double-quoted options 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.
Example
emcli clone_database_home
-input_file="dest_properties:clonedestinations"
-list_exclude_files="*.log,*.dbf,sqlnet.ora,tnsnames.ora,listener.ora"
-isSwLib="false"
-isRac="false"
-tryftp_copy="false"
-jobname="clone database home"
-prescripts="/home/joe/myScript"
-run_prescripts_as_root="true"
-rootscripts="%oracle_home%/root.sh"
-source_params="TargetName:host.domain.com;HomeLoc=/oracle/database1; HomeName=OUIHome1;ScratchLoc=/tmp"
Passing Variables Through EM CLI
When working with variables such as %perlbin% or %oracle_home%, EM CLI passes variable values from the current local environment instead of the variables themselves. To pass variables through an EM CLI command, as might be the case when using the -prescripts or -postscripts options, you can place the EM CLI command in a batch file and replace all occurrences of % with %%.
Performs an immediate collection and threshold evaluation of a set of metrics associated with the specified internal metric name. Metric data collection and threshold evaluation occur asynchronously to the EM CLI call.
You typically use this command when you believe you have resolved an open metric alert or error and would like to clear the event by immediately collecting and reevaluating the metric. This command applies to most metrics except server-generated database metrics.
Use the get_on_demand_metrics verb to see a complete list of supported metrics for a given target.
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
Options
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 optiononly 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
This example immediately collects and evaluates thresholds for the user-defined metric called MyUDM:
emcli collect_metric -target_type=host -target_name=hostname.example.com -collection=MyUDM
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
Options
input_file=sla1
File name for the first XML file.
For more information about the input_file option, see -input_file Syntax Guidelines.
input_file=sla2
File name for the second XML file.
For more information about the input_file option, see -input_file Syntax Guidelines.
dir
The default is the current directory. If you need to specify another directory, use this option for the output files sla1_compare.dif and sla2_compare.dif.
Example
This example compares two SLAs as defined in sla1.xml and sla2.xml, and outputs sla1_compare.dif and sla2_compare.dif in the current directory.
emcli compare_sla
-input_file=sla1:sla1.xml -input_file=sla2:sla2.xml
You can use a standard diff tool to diff the files, such as This example for Linux:
diff sla1_compare.dif sla2_compare.dif
Note:
This verb is applicable only for database versions 12.2 (and above).Note:
When a pluggable database of version 12.2 (and above) is relocated in maximum availability mode, the source pluggable database target still continues to exist in Enterprise Manager after the successful relocation. In the Maximum Availability mode, the existing client connections is redirected by the source CDB's listener to the relocated PDB. To facilitate this connection redirection, the source pluggable database exists in mounted state. Eventually, after all the client connect descriptors are migrated by the user manually to point to the relocated pluggable database, the source can be removed. This verb should be run only on the source pluggable database target to remove it and also to delete the pluggable database from backend.Format
emcli complete_post_pdb_relocation
-pdb_target_name="source pluggable database target name"
-input_file="path of the input file"
[ ] indicates that the parameter is optional.
Options
pdb_target_name
Name of the source pluggable database target.
input_file
SRC_CDB_CRED = SYSDBA source container database credentials (format - CRED_NAME:OWNER)
SRC_HOST_CRED = Source container database host credentials (format - CRED_NAME:OWNER)
Example
Example 1
This example completes the post relocation actions to delete the source pluggable database "SICDB_GEN", which was relocated to another container database in the maximum availability mode.
emcli complete_post_pdb_relocation
-pdb_target_name="SICDB_GEN"
-input_file=data:/u01/post_relocate.props
Submits the configuration comparison job.
Format
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="SYSMAN"
-job_name="Test Compare Job"
[-schedule=
{
start_time:yyyy/MM/dd HH:mm;
tz:{java timezone ID};
frequency:interval/weekly/monthly/yearly;
repeat:#m|#h|#d|#w;
months:#,#,...;
days:#,#,...;
end_time:yyyy/MM/dd HH:mm;
grace_period:;
}]
[-template_id="18"]
[-job_description="Test Description"]
[-mapping_display="Tree"]
[-email_address]
[-save_mode="save_all|save_only_diffs"]
[ ] indicates that the parameter is optional
Options
target_type
Target type on which the comparison job is being submitted. The value should be the internal name. To get the internal name, execute the following EM CLI command:
emcli get_target_types
first_config
Name of the first configuration, which can be either the latest configuration or a saved configuration of a target. If submitting the latest configuration, provide the target name. If submitting a saved configuration, the format should be:
"target_name|saved_configuration_name(which is the "name" field from the output of "emcli get_saved_configs"
second_config
Names of the second and subsequent configurations, which can contain one or more latest configurations and/or one or more saved configurations of one or more targets. Multiple configurations can be specified, separated by a comma. If the latest configuration needs to be submitted, provide the target name. If the saved configuration needs to be submitted, then the format should be:
"target_name|saved_configuration_name(which is the "name" field from the output of "emcli get_saved_configs"
job_name
Name of the comparison job.
schedule
Schedule with which the comparison job must be scheduled. If the schedule option is not provided, the comparison job runs immediately.
start_time - Time when comparison job has to start executing. The format is "yyyy/MM/dd HH:mm"
tz - Timezone ID (optional)
frequency - Valid values are once/interval/weekly/monthly/yearly. (optional)
If frequency is set to interval, repeat must be specified.
If frequency is set to weekly or monthly, days must be specified.
If frequency is set to yearly, both days and months must be specified.
repeat - Frequency with which the comparison job must be repeated. (Required only if frequency is set to interval.)
days - Comma-separated list of days. (Required only if frequency is weekly, monthly, or yearly.) Example: "repeat=1d"
If frequency is weekly, then the valid range is 1 to 7 inclusive.
If frequency is monthly or yearly, then the valid range is 1 to 30 inclusive.
months - Comma-separated list of months. (Required only if frequency is yearly). Valid range is 1 to 12 inclusive.
end_time - End time for comparison job executions. (optional). If it is not specified, the comparison job runs indefinitely. The format is "yyyy/MM/dd HH:mm"
grace_period - grace period in minutes (optional)
template_id
ID of the template. The value is an integer.
job_description
Description of the comparison job.
mapping_display
Can be either "tree" or "table." The default value is "tree". This option is only for composite targets. Note: When "template_id" is specified, do not specify mapping_display.
email_address
Email address to which notification mail is to be sent, if differences are found.
save_mode
Tells the comparison engine whether to save all the results or only the differences. Valid inputs are "save_all" and "save_only_diffs". The save_only_diffs option saves the differences to the Management Repository. Otherwise, all the comparison results are saved. The default value is "save_only_diffs".
Checking the Job Status:
Once submitted, the comparison job's status can be viewed by issuing the following EM CLI command:
emcli get_jobs -name="jobName"
Aborting the Job:
Once submitted, the comparison job can be aborted by issuing the following EM CLI command:
emcli stop_job -name="jobName"
Examples
Example 1
This example compares the latest configuration of one target to the latest configurations of multiple targets. All the comparison results will be saved.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database","Test_Database"
-job_name="Test Job" -template_id="18"
-save_mode="save_all"
Example 2
This example compares the latest configuration with the saved configuration specifying a start_time.
emcli config_compare
-target_type="oracle_database"
-first_config="Test Database"
-second_config="Test Database|Test Database|oracle_
database|20140101224530","Test_Database" -job_name="Test Job"
-schedule="start_time:2014/06/10 15:45"
Configures high availability (HA) settings for database targets. This verb has multiple subcommands that perform different HA-related operations. The available subcommands are mentioned in detail as follows:
configure_db_ha -configureRABackup
Note:
Databases specified here must be enrolled as protected databases with the Recovery Appliance.Format
emcli configure_db_ha –configureRABackup
–ra_target_name="<Recovery Appliance target name>"
–ra_user="<Recovery Appliance database user name>"
(
(–target_name="<database target name" –target_type="oracle_database|rac_database")
| input_file="<full pathname of input file>"
)
[–db_cred="<database named credential>"]
[–db_host_cred="<database host named credential>"]
[–enable_redo_ship]
[–force_backup_module_install]
[–staging_directory=”<full pathname where Backup Module will be staged on database hosts>”]
[–schedule=
{
start_time:yyyy/MM/dd HH:mm;
tz:{java timezone ID};
frequency:interval/weekly/monthly/yearly;
repeat:#m|#h|#d|#w;
months:#,#,...;
days:#,#,...;
end_time:yyyy/MM/dd HH:mm;
grace_period:;
}]
[ ] indicates that the parameter is optional.
Options
ra_target_name
The target name of the Recovery Appliance that the specified databases will be configured to send backups to.
ra_user
The Recovery Appliance database user that will be used by all the specified databases to send backups and redo to the Recovery Appliance. This must be a virtual private catalog user, not the Recovery Appliance administrator user.
target_name
The target name of a single-instance or cluster database that will be configured to send backups to the Recovery Appliance. A multi-database operation can be performed by using the –input_file option instead of –target_name/–target_type.
target_type
The type of the target specified by –target_name, either a single–instance database (oracle_database) or a cluster database (rac_database).
input_file
target.0.target_name=<database #1 target name> target.0.target_type=oracle_database|rac_database target.0.db_cred=<database named credential for database #1> target.0.db_host_cred=<database host named credential for database #1> target.1.target_name=<database #1 target name> target.1.target_type=oracle_database|rac_database target.1.db_cred=<database named credential for database #2> target.1.db_host_cred=<database host named credential for database #2>
db_cred
Note:
If the -input_file option is used, this option can be optionally overridden for individual databases.db_host_cred
Note:
If the -input_file option is used, this option can be optionally overridden for individual databases.enable_redo_ship
Enables real-time redo transport to the Recovery Appliance from all specified target databases.
force_backup_module_install
Installs the version of the Recovery Appliance Backup Module stored in the Enterprise Manager Software Library into the Oracle Homes of the specified target databases, even if an existing Backup Module has already been installed in the Oracle Homes. Since this option overwrites any existing Backup Module, select this option only if the Backup Module version in the Software Library is at the same or later version than the version installed on all the specified target databases. If this flag is not specified, the Backup Module will be installed only if there is no existing Backup Module present in the Oracle Home.
staging_directory
The directory where the Backup Module installation files will be staged on the database hosts. This directory must exist on all hosts. A temporary subdirectory will be created in this location, then deleted after the installation of the Backup Module and/or file system backup agent is complete. The default directory is <Agent installation root>/EMStage.
Example 1
The following example configures a single-instance database “Finance” to send backups and ship redo to the Recovery Appliance “Chicago ZDLRA”. It does not install the Backup Module in the Oracle Home of each database if the Backup Module is already present. This example uses named database and host credentials:
emcli configure_db_ha –configureRABackup –ra_target_name="Chicago ZDLRA"
–ra_user="rauser1" –target_name="Finance" –target_type="oracle_database"
–db_cred="DB_USER" –db_host_cred="DB_HOST_USER" –enable_redo_ship
Example 2
The following example configures a cluster database “Finance” to send backups to the Recovery Appliance “Chicago ZDLRA” without shipping redo. It performs a forced installation of the Backup Module in the Oracle Home of each cluster database instance. This example uses preferred database and host credentials:
emcli configure_db_ha –configureRABackup -ra_target_name="Chicago ZDLRA"
–ra_user="rauser1" –target_name="Finance" –target_type="rac_database"
–force_backup_module_install
Example 3
The following example configures multiple databases specified in the input file “/tmp/dblist” to send backups and ship redo to the Recovery Appliance “Chicago ZDLRA”. It performs a forced installation of the Backup Module in the Oracle Home of each database. The backup module installation files are staged in a custom directory location (/tmp/stage). This example uses named database and database host credentials:
emcli configure_db_ha –configureRABackup –ra_target_name="Chicago ZDLRA"
–ra_user="rauser1" –input_file="target_list:/tmp/dblist"
–db_cred=”DB_USER” –db_host_cred="DB_HOST_USER" –enable_redo_ship
–force_backup_module_install –staging_directory=”/tmp/stage"
Example 4
The following example configures the databases specified in the input file “/tmp/dblist” to send backups and ship redo to the Recovery Appliance “Chicago ZDLRA”. It does not install the Backup Module if it is already present . The example uses global named database and host credentials. The operation is scheduled for a future time as specified:
emcli configure_db_ha –configureRABackup –ra_target_name="Chicago ZDLRA" –ra_user="rauser1" –input_file="target_list:/tmp/dblist" –db_cred="DB_USER" –db_host_cred="DB_HOST_USER" –enable_redo_ship -schedule="start_time:2016/06/28 18:31;tz:PST;"
configure_db_ha -confgureCloudBackup
Configures one or more databases to send backups to Database Backup Cloud Service.
Format
emcli configure_db_ha –configureCloudBackup
(
(–target_name="<database target name>" –target_type="oracle_database|rac_database")
| input_file="<full pathname of input file>"
)
[–cloud_account="<Database Backup Cloud Service account name>"]
[–db_cred="<database named credential>"]
[–db_host_cred="<database host named credential>"]
[–force_backup_module_install]
[–staging_directory=”<full pathname where Backup Module will be staged on database host>"]
[-schedule=
{
start_time:yyyy/MM/dd HH:mm;
tz:{java timezone ID};
frequency:interval/weekly/monthly/yearly;
repeat:#m|#h|#d|#w;
months:#,#,...;
days:#,#,...;
end_time:yyyy/MM/dd HH:mm;
grace_period:;
}]
[ ] indicates that the parameter is optional.
Options
target_name
The target name of a single-instance or cluster database. A multi-database operation can be performed by using the –input_file option instead of –target_name/–target_type.
target_type
The type of the target specified by –target_name, either a single–instance database (oracle_database) or a cluster database (rac_database).
input_file
The file containing the information for each database that is to be configured. This option is an alternative to –target_name/–target_type. The target_name and target_type lines are required for each database. The db_cred and db_host_cred lines are optional; if these are present for a database, they override the command-line named credential settings (if any) for that database. The format of the file is as follows:
target.0.target_name=<database #1 target name> target.0.target_type=oracle_database|rac_database target.0.db_cred=<database named credential for database #1> target.0.db_host_cred=<database host named credential for database #1> target.1.target_name=<database #1 target name> target.1.target_type=oracle_database|rac_database target.1.db_cred=<database named credential for database #2> target.1.db_host_cred=<database host named credential for database #2>
cloud_account
The name of a cloud account configured under the Enterprise Manager Hybrid Cloud Setup console. All the information that is needed to connect to the Backup Service will be obtained from this account and its associated Backup Service settings, including the service name, identity domain, username, password, and container (optional). If this argument is not specified, the global cloud account settings configured in the Database Backup Cloud Service Settings page will be used. (This argument is applicable only if the Hybrid Cloud Setup console has been used to configure accounts and Backup Service settings).
db_cred
Note:
If the -input_file option is used, this option can be optionally overridden for individual databases.db_host_cred
Note:
If the -input_file option is used, this option can be optionally overridden for individual databases.force_backup_module_install
Install the version of the Oracle Database Cloud Backup Module stored in the Enterprise Manager Software Library into the Oracle Homes of the specified target databases, even if an existing Backup Module has already been installed in the Oracle Homes. Since this option overwrites any existing Backup Module, select this option only if the Backup Module version in the Software Library is at the same or later version than the version installed on all the specified target databases. If this flag is not specified, the Backup Module will be installed only if there is no existing Backup Module present in the Oracle Home.
staging_directory
The directory where the Backup Module installation files will be staged on the database hosts. This directory must exist on all hosts. A temporary subdirectory will be created in this location, then deleted after the installation of the Backup Module and/or file system backup agent is complete. The default directory is <Agent installation root>/EMStage.
Example 1
The following example configures a single-instance database “Finance” to send backups to Database Backup Cloud Service. It does not install the Backup Module if the module is already installed. This example uses named database and host credentials:
emcli configure_db_ha –configureCloudBackup
–target_name="Finance" –target_type="oracle_database"
–db_cred="DB_USER" –db_host_cred="DB_HOST_USER"
Example 2
The following example configures a cluster database “Finance” to send backups to Database Backup Cloud Service. It performs a forced installation of the Backup Module in the Oracle Home of each cluster database instance. This example uses preferred database and host credentials:
emcli configure_db_ha –configureCloudBackup
–target_name="Finance" –target_type="rac_database"
–force_backup_module_install
Example 3
The following example configures the databases specified in the input file “/tmp/dblist” to send backups to Database Backup Cloud Service. It performs a forced installation of the Backup Module in the Oracle Home of each database. The backup module installation files are staged in a custom directory location (/tmp/stage). This example uses named database and database host credentials.
emcli configure_db_ha –configureCloudBackup
–input_file="target_list:/tmp/dblist"
-db_cred=”DB_USER” –db_host_cred="DB_HOST_USER" –force_backup_module_install
–staging_directory=”/tmp/stage"
configure_db_ha -installSoftware
Installs the Recovery Manager (RMAN) backup module in the Oracle Homes or installs the Recovery Appliance file system backup agent on the hosts of one or more databases.
Format
emcli configure_db_ha –installSoftware
(
(–target_name="<database target name>" –target_type="oracle_database|rac_database")
| input_file="<full pathname of input file>"
)
(
(–install_backup_module –module_type=”ra|cloud” [–force_backup_module_install]
[–db_host_cred="<database host named credential>"])
| (–install_fs_agent [–fs_agent_host_cred=”<host named credential>”]
[–fs_agent_install_directory=”<full pathname of OSB client installation directory>”])
)
[–staging_directory=”<full pathname where Backup Module and file system backup agent installation will be staged on database hosts>”]
[–schedule=
{
start_time:yyyy/MM/dd HH:mm;
tz:{java timezone ID};
frequency:interval/weekly/monthly/yearly;
repeat:#m|#h|#d|#w;
months:#,#,...;
days:#,#,...;
end_time:yyyy/MM/dd HH:mm;
grace_period:;
}]
Options
target_name
The target name of a single-instance or cluster database that is configured to send backups to a Recovery Appliance or Oracle Cloud. You can perform a multi-database operation by using the –input_file option instead of –target_name/–target_type.
target_type
The type of the target specified by –target_name, either a single–instance database (oracle_database) or a cluster database (rac_database).
input_file
The input file that contains information for each database that is configured. This option is an alternative to –target_name/–target_type. The target_name and target_type lines are required for each database. The db_cred and db_host_cred lines are optional; if these are present for a database, they override the command-line named credential settings (if any) for that database. The following format is used while installing a backup module with the –install_backup_module option:
target.0.target_name=<database #1 target name> target.0.target_type=oracle_database|rac_database target.0.db_host_cred=<database host named credential for database #1> target.1.target_name=<database #1 target name> target.1.target_type=oracle_database|rac_database target.1.db_host_cred=<database host named credential for database #2>
target.0.target_name=<database #1 target name> target.0.target_type=oracle_database|rac_database target.0.fs_agent_host_cred=<host named credential for the host(s) of database #1> target.1.target_name=<databse #1 target name> target.1.target_type=oracle_database|rac_database target.1.fs_agent_host_cred=<host named credential for the host(s) of database #2>
install_backup_module
Installs the version of the Backup Module (of the type specified by the –module_type argument) stored in the Enterprise Manager software library in the Oracle Homes of the specified target databases. By default, the module will be installed if there is no existing module in the database Oracle Home, unless the –force_backup_module_install flag is specified. This module cannot be specified in combination with –install_osb_client.
module_type
The type of RMAN backup module to be installed. The possible values are: ra – Recovery Appliance Backup Module and cloud – Oracle Database Cloud Backup Module
force_backup_module_install
Installs a version of the Recovery Appliance Backup Module stored in the Enterprise Manager Software Library into the Oracle Homes of the specified target databases, even if an existing Backup Module has already been installed in the Oracle Homes. Since this option overwrites any existing Backup Module, select this option only if the Backup Module version in the Software Library is at the same or later version than the version installed on all the specified target databases. If this flag is not specified, the Backup Module will be installed only if there is no existing Backup Module present in the Oracle Home.
db_host_cred
Note:
If the -input_file option is used, this option can be optionally overridden for individual databases.install_fs_backup_agent
Installs the file system backup agent on all hosts of the specified target databases.
fs_agent_host_cred
The name of an existing Enterprise Manager host privileged named credential (not a database host credential) that can be used to perform the file system backup agent installation on all the hosts of the specified target databases. The credential should specify the root user or a user with root privilege delegation. If this argument is not specified, preferred credentials for the host targets associated with the databases is used. If multiple databases are specified, this should be a global named credential.
fs_agent_install_directory
The directory where the file system backup agent is installed on all database hosts. The directory must exist on all the hosts. The default directory is /usr/local/oracle/backup.
staging_directory
The directory where the Backup Module files and the file system backup agent installation files will be staged on the database hosts. This directory must exist on all hosts. A temporary subdirectory will be created in this location, then removed after the installation of the Backup Module and/or file system backup agent is complete. The default directory is <Agent installation root>/EMStage.
Example 1
The following example installs the Recovery Appliance Backup in the Oracle Home of one single-instance database “Finance”. It does not install the Backup Module if the module is already installed. This example uses named database and host credentials:
emcli configure_db_ha –installSoftware
–target_name="Finance" –target_type="oracle_database" –db_host_cred="DB_HOST_USER"
-install_backup_module –module_type=”ra”
Example 2
The following example installs the Oracle Database Cloud Backup Module in the Oracle Home of one RAC database “Finance”. It performs a forced installation if the module is already installed. This example uses named database host credentials:
emcli configure_db_ha –installSoftware
–target_name="Finance" –target_type="rac_database"
–install_backup_module –module_type=”cloud” –force_backup_module_install –db_host_cred="DB_HOST_USER"
Example 3
The following example installs the Recovery Appliance file system backup agent on all cluster database nodes of one cluster database “Finance” in a non-default location. This example uses privileged host credentials:
emcli configure_db_ha –installSoftware
–target_name="Finance" –target_type="rac_database"
–install_osb_client –osb_install_directory=”/usr/local/osb12”
–osb_host_cred=”HOST_PRIV_CRED”
Example 4
The following example installs the Recovery Appliance Backup Module in the Oracle Homes of multiple databases specified in the input file “/tmp/dblist”. It performs a forced installation if the module is already installed. This example uses preferred database host credentials. The operation scheduled for a future time as specified:
emcli configure_db_ha –installSoftware
–input_file="target_list:/tmp/dblist" –install_backup_module
–module_type=”ra” -force_backup_module_install
-schedule="start_time:2016/06/28 18:31;tz:PST;"
Example 5
The following example installs the Recovery Appliance file system backup agent on all hosts of multiple databases specified in an input file “/tmp/dblist”, in the default location. This example uses preferred privileged host credentials. The file system backup agent installation files are staged in a custom directory location (/tmp/stage):
emcli configure_db_ha –installSoftware –input_file="target_list:/tmp/dblist"
–install_osb_client –staging_directory=”/tmp/stage"
Creates a Database as a Service (DBaaS) target for Oracle Public Cloud.
Format
emcli config_db_service_target
-database_unique_name="database unique name"
-service_grp_name="service group name"
-cloud_service_name="cloud service name"
-operation="operation to be performed"
-schema_name="schema name"
-tablespace_name="tablespace name"
[-subscription_id="subscription ID"]
[-customer_name="customer name"]
[-csi_number="CSI number"]
[-connection_service_name="connection service name"]
[-cloud_service_version="cloud service version"]
[-l_o_b="line of business"]
Options
database_unique_name
Identifies the DBName property of a database target on which the DBaaS target will be based.
service_grp_name
Identifies the DBaaS target service group name. The DBaaS target name will be service_grp_name_cloud_service_name.
cloud_service_name
Identifies the Oracle Public Cloud service name.
operation
Identifies the operation to be performed on the DBaaS target (for example, "create").
schema_name
Identifies the name of the schema associated with the DBaaS target.
tablespace_name
Identifies the name of the tablespace associated with the DBaaS target.
subscription_id
Provides a value for the Cost Center property of a DBaaS target.
customer_name
Provides a customer point of contact for the DBaaS target.
csi_number
Identifies the Customer Support Identifier (CSI) of the DBaaS target.
connection_service_name
Identifies the name of the Database Service associated with the DBaaS Target.
cloud_service_version
Shows the Oracle Public Cloud Service version of the DBaaS target.
l_o_b
Identifies the Line of Business (LOB) of the DBaaS target.
Exit Codes
0 On success Non-zero value means verb processing was not successful.
Example
Creates a new Database as a Service (DBaaS) target (db_serv1). Specifies the schema, tablespace name, and connection service name. The new DBaaS target is based on a Database target using db.example.com as the DBName property:
emcli config_db_service_target
-database_unique_name="db.example.com"
-service_grp_name="db"
-cloud_service_name="serv1"
-operation="Create"
-schema_name="HR"
-tablespace_name="SYSTEM"
-connection_service_name="nservice1"
Configures Log Archive Locations for the root target and its children. To configure Log Archive Location for a target, you should know the configuration parameters, like host name, from where the log archive files are accessible, the credentials to access the host, and the location of the log archive files.
Format
emcli configure_log_archive_locations
-root_target_name="<target_name>"
-root_target_type="<target_type>"
[-archive_config_file="<target_archive_config_file_location>"]
[-no_update]
[-debug]
[ ] indicates that the parameter is optional.
Options
root_target_name
Name of the root target. A configurable tree target hierarchy will be created with this root target. Example root targets are WebLogic Domain and Fusion Application Instance.
root_target_type
Target type of the root target name.
archive_config_file
Location of the archive config file. Every line in this file should contain the following 7 fields in the same order.
target_name,target_type,host_target_name,host_cred_type,host_cred_name or new_cred_user_name,new_cred_password,archive_dir_location
target_name
If this target is part of the root hierarchy, then this target and it's children will be updated with the archive parameters specified.
target_type
Target type of the above target.
host_target_name
Host name from where archive location is accessible. The Management Agent monitoring this target should have Oracle Fusion Middleware plug-in release 12.1.0.4 or later installed.
host_cred_type
Credential type. Possible values are preferred_credentials or named_credentials or new_credentials.
host_cred_name
Credential set name for preferred_credentials type or Named credential name for named_credentials type.
new_cred_user_name
New credential user name for new_credentials type.
new_cred_password
New credential password for new_credentials type.
archive_dir_location
Directory location where log archive files available.
no_update
If this flag is provided, targets which are already configured with the archive properties, will not be updated again.
debug
Runs the verb in verbose mode for debugging purposes.
Example
The following example configures Log Archive Locations for Fusion Instance target and its children.
emcli configure_log_archive_locations
-root_target_name=fa1
-root_target_type=fusion_apps_instance
-archive_config_file=/scratch/config.txt
Sample Archive Config File:
In the case of new credentials:
fa1,fusion_apps_instance,adc123.oracle.com,new_credentials,user1,pwd1,/scratch/fa1
In the case of preferred credentials:
fa1,fusion_apps_instance,adc123.oracle.com,preferred_credentials,credential_set1,,/scratch/fa1
(Because this is preferred credentials, ',,' means the new_cred_password field is not valid and therefore skipped.)
Configures the limit of Apply lag and Transport lag for all or selected databases of the system.
Format
emcli configure_siteguard_lag
[-system_name="name_of_the_system"]
[-target_name="name_of_the_target_database"]
[-property_name="lag_type"]
[-value="max_limit_in_seconds"]
[ ] indicates that the parameter is optional.
Options
system_name
Name of the system on which lag limits need to be configured.
target_name
Name of the database on which lag limits need to be configured.
property_name
Name of the lag property to be configured. Valid values are ApplyLag and TransportLag.
value
Limit of the lag. These values are specified in seconds.
Example
This example configures the Apply lag limit of 1000 seconds on all of the databases of austin-system:
emcli configure_siteguard_lag
-system_name="austin-system"
-property_name="ApplyLag"
-value="1000"
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
Options
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'
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
Options
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
This example continues the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' to the next phase of deployment on all hosts.
emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -continue_all_hosts
Example 2
This example continues the session 'ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' synchronously to the next phase of deployment only on hosts on which the current phase was successful.
emcli continue_add_host -session_name='ADD_HOST_SYSMAN_Dec_17_2012_2:02:28_AM_PST' -continue_ignoring_failed_hosts -wait_for_completion
Converts a single-instance database to a Real Application Cluster (RAC) database.
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
Options
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
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
Options
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 option, see -input_file Syntax Guidelines.
See below for an example of an XML file for this option.
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 options.
If availability is set to SELECTED_COMPONENTS_OF_A_SYSTEM, -systemname, -systemtype and -keycomponents are required options.
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.
Example
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"
XML for input_file Example
The following sample XML file creates a service test of name 'EM Console Service Test' and of type 'Web Transaction'. It defines some properties, such as readTimeout, Collection Interval, and so forth under the <properties> section, which are related to this service test.
This service test has defined step information under <mgmt_bcn_step_with_props>. The name of the step is '1.Access Logout page'. The URL to be monitored under this step is https://myhost.in.domain.com:14513/em/console/logon/logoff?event=load, which is defined under the properties section of the step.
This XML file also defines some threshold levels for this service test on the transaction level under <txn_thresholds>. For the metric avg_response_time, it states that if the metric value is greater than 6000.0, raise a warning alert, and if the metric value is greater than 12000.0, raise a critical alert.
<?xml version = '1.0' encoding = 'UTF-8'?> <transaction-template template_type="aggregate_service" xmlns="template">
<variables>
<variable name="HOST1" value="myhost.in.domain.com"/>
<variable name="PORT1" value="14513"/>
<variable name="PROTOCOL1" value="https"/>
</variables>
<transactions>
<mgmt_bcn_transaction>
<mgmt_bcn_txn_with_props>
<mgmt_bcn_txn description="Test for checking the availability of EM Console/Website" is_representative="true" name="EM Console Service Test" monitoring="true" txn_type="HTTP"/>
<properties>
<property name="readTimeout" num_value="120000.0" prop_type="2" encrypt="false"/>
<property name="certValidationMode" string_value="1" prop_type="1" encrypt="false"/>
<property name="maxDownloadSize" num_value="1.0E8" prop_type="2" encrypt="false"/>
<property name="sensitiveValuesProtection" string_value="0" prop_type="1" encrypt="false"/>
<property name="failureStringModes" string_value="regularText" prop_type="1" encrypt="false"/>
<property name="UserAgent" string_value="Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1) OracleEMAgentURLTiming/3.0" prop_type="1" encrypt="false"/>
<property name="successStringModes" string_value="regularText" prop_type="1" encrypt="false"/>
<property name="variablesModes" string_value="urlEncode" prop_type="1" encrypt="false"/>
<property name="content" string_value="0" prop_type="1" encrypt="false"/>
<property name="AcceptLanguage" string_value="en" prop_type="1" encrypt="false"/>
<property name="connectionTimeout" num_value="120000.0" prop_type="2" encrypt="false"/>
<property name="useCache" string_value="yes" prop_type="1" encrypt="false"/>
<property name="stringValidationMode" string_value="1" prop_type="1" encrypt="false"/>
<property name="granularity" string_value="transaction" prop_type="1" encrypt="false"/>
<property name="numThreads" num_value="4.0" prop_type="2" encrypt="false"/>
<property name="retries" num_value="1.0" prop_type="2" encrypt="false"/>
<property name="timeout" num_value="300000.0" prop_type="2" encrypt="false"/>
<property name="retryInterval" num_value="5000.0" prop_type="2" encrypt="false"/>
</properties>
<per_bcn_properties/>
</mgmt_bcn_txn_with_props>
<steps_defn_with_props>
<mgmt_bcn_step_with_props>
<mgmt_bcn_step step_number="1" name="1.Access Logout page" step_type="HTTP"/>
<properties>
<property name="req_mode" num_value="1.0" prop_type="2" encrypt="false"/>
<property name="http_method" string_value="G" prop_type="1" encrypt="false"/>
<property name="url" string_value="{PROTOCOL1}://{HOST1}:{PORT1}/em/console/logon/logoff?event=load" prop_type="1" encrypt="false"/>
</properties>
</mgmt_bcn_step_with_props>
</steps_defn_with_props>
<stepgroups_defn/>
<txn_thresholds>
<mgmt_bcn_threshold warning_threshold="6000.0" warning_operator="0" critical_threshold="12000.0" critical_operator="0" num_occurrences="1">
<mgmt_bcn_threshold_key metric_name="http_response" metric_column="avg_response_time"/>
</mgmt_bcn_threshold>
<mgmt_bcn_threshold warning_threshold="0.0" warning_operator="1" critical_threshold="0.0" critical_operator="1" num_occurrences="1">
<mgmt_bcn_threshold_key metric_name="http_response" metric_column="status"/>
</mgmt_bcn_threshold>
</txn_thresholds>
<step_thresholds/>
<stepgroup_thresholds/>
</mgmt_bcn_transaction>
</transactions>
</transaction-template>
Creates target association instances.
Format
Standard Mode
emcli create_assoc
-assoc_type="association type"
-source="source"
-dest="destination_target"
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
Interactive (Script) Mode
create_assoc(
assoc_type="association type"
,source="source"
,dest="destination_target"
[,separator="separator:attribute_name:character"]
[,subseparator="subseparator:attribute_name:character"]
)
[ ] indicates that the parameter is optional.
Options
source_type
Source target type.
source
Source target.
dest
Destination target.
separator
By default, multi-value input attributes use a semicolon ( ; ) as a separator. Specifying this option overrides the default separator value.
Example: separator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new separator character.Example: separator="att=#"
subseparator
By default, multi-value input attributes use a colon ( : ) as a subseparator. Specifying this option overrides the default subseparator value.
Example: subseparator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character and sep_char is the new subseparator character.Example: separator="att=#"
Note:
The name and owner options must be used together.
Exit Codes
0 indicates that the verb processing was successful.
Non-zero values indicate that the verb processing was not successful.
Example
This example creates an association of type cluster_contains from target "abc_cluster:cluster" to targets "def.oracle.com:host" and "ghi.oracle.com:host":
emcli create_assoc
-assoc_type="cluster_contains"
-source="abc_cluster:cluster"
-dest="def.oracle.com:host;ghi.oracle.com:host"
For a list of allowed pairs, enter emcli list_allowed_pairs .
Creates a scheduled blackout to suspend any data collection activity on one or more monitored targets.
Format
emcli create_blackout
-name="name"
-add_targets="name1:type1;name2:type2;..."...
-reason="reason"
[-description="description"]
[-notification_only]
[-is_sla_required]
[-jobs_allowed]
[-propagate_targets]
[-full_blackout_all_hosts]
[-dep_services_all]
-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
Options
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 option 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.
notification_only
When this option is specified, by default a notification blackout for planned maintenance is created on the selected targets. Blackout duration is excluded from Availability(%) calculations.
is_sla_required
When this option is specified, the notification blackout is created for unplanned maintenance. Blackout duration is considered for Availability(%) calculations.
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.
full_blackout_all_hosts
When this option is specified, full blackout is enabled on all hosts included in this blackout. A full blackout places the host and all targets on the host (including the agent) under blackout. The propagate_targets option is implicitly enabled on selecting this option.
dep_services_all
When this option is specified, all of the dependent targets of the targets selected for blackout will also be blacked out.
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 option 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 option, this option determines which timezone to use for the blackout schedule. Otherwise, it is ignored. It defaults to "GMT".
Examples
Example 1
This example creates blackout b1 for the specified target (database2) to start immediately and last for 30 minutes.
emcli create_blackout -name=b1 -add_targets=database2:oracle_database
-schedule="duration::30"
-reason="good reason1"
Example 2
This example creates blackout b1 for the specified targets (database2 and database3) to start at 2007-08-24 22:30 and last for 30 minutes. The timezone is the timezone for the database2 target.
emcli create_blackout -name=b1
-add_targets="database2:oracle_database;database3:oracle_database
-schedule="frequency:once;start_time:07-08-24 22:30;duration::30;tzinfo:target:tzoffset:1"
-reason="good reason4"
Creates a custom entity type for an Enterprise Manager target type for which there is no current Chargeback support. There can be only one custom entity type for the specified Enterprise Manager target type.
Format
emcli create_charge_entity_type
-target_type="target_type"
Options
target_type
Name of the custom entity type.
Example
The following example creates a new Chargeback entity type named oracle_apache for the Enterprise Manager Apache target type:
emcli create_charge_entity_type
-target_type="oracle_apache"
Creates a custom charge item for Chargeback based on the properties specified in the referenced file.
Format
emcli create_charge_item
-input_file="property_file:filename"
Options
The option [-input_file] is the full path of a file that contains the item properties. The following properties can be defined in the file:
target_type
Target type to which the charge item applies.
source_data_type
Source data type. Valid values are metric, config, and property.
item_name
Name of the item.
metric_group
Metric group name as listed in list_item_candidates. This is a required property if source_data_type=metric.
metric_column
Metric column name as listed in list_item_candidates. This is a required property if source_data_type=metric.
config_view
Config view name as listed in list_item_candidates. This is a required property if source_data_type=config.
config_key
Config key name as listed in list_item_candidates. This is a required property if source_data_type=config.
config_column
Config column name as listed in list_item_candidates. This is a required property if source_data_type=config.
config_data_source
Data source of configuration metric. This is a required property if source_data_type=config.
property
Property name as listed in list_item_candidates. This is a required property if source_data_type=property.
item_displayname
Item display name.
unit
Unit display name.
aggregation_type
Type of aggregation to use for this item. Applicable only if data type=number. Valid values are sum and avg. Default value is avg.
is_config_condition
Item used conditionally in a charge plan. Valid values are 0, 1. Default value is 0.
item_category
Category of item. Default value is instance. Valid values are cpu, storage, memory, network, and instance.
data_type
Valid values are string and number. The default value is string for config and property types, and number for metric type.
Examples
Example 1
This example creates a metric custom charge item that bases charges on the average total of processes on a particular host:
emcli create_charge_item -input_file="property_file:/home/user/property_file"
Contents of /home/user/property_file:
target_type=host
source_data_type=metric
item_name=total_proc
metric_group=Load
metric_column=noOfProcs
item_displayname=Total Processes
unit=process
aggregation_type=avg
item_category=instance
data_type=number
Example 2
This example creates a configuration custom charge item that can charge different rates for various usage charge items based on the instance region:
emcli create_charge_item -input_file="property_file:/home/user/property_file"
Contents of /home/user/property_file:
target_type=oracle_database
source_data_type=config
item_name=custom_config
config_view=myCustomCCS
config_key=region
config_column=country
config_data_source=regionList.txt
item_display_name=Region of Instance
item_category=instance
data_type=string
Creates a new cloned database.
Format
emcli create_clone
-inputFile="File containing properties required for cloning a database"
Options
inputFile
The location and name of the file containing the properties required for cloning the database.
Example
The following example creates a cloned database using the options contained in the /u01/files/create_clone.props file:
emcli create_clone -inputFile=/u01/files/create_clone.props
Creates a comparison check for the specified template and target type.
Format
There are three forms of the EM CLI create_compare_check command:
Latest comparison:
emcli create_compare_check
-name="<check_name>"
-template="<template_name>"
-target_type="<target_type>"
-compare_type="L<ATEST>"
-target_name="<target_name>"
Saved comparison:
emcli create_compare_check
-name="<check_name>"
-template="<template_name>"
-target_type="<target_type>"
-compare_type="S<AVED>"
-saved_guid="<saved_guid>"
Consistency comparison:
emcli create_compare_check
-name="<check_name>"
-template="<template_name>"
-target_type="<target_type>"
-compare_type="C<ONSISTENCY>"
Options
name
Name of the comparison check being created.
template
Name of the template being used as the baseline for the comparison.
target_type
Target type associated with the template.
compare_type
Type of comparison. Values are:
L or LATEST
S or SAVED
C or CONSISTENCY
target_name
Name of the target.
saved_guid
Name of the saved comparison.
Example
The following example creates the mycheck1 comparison check using the 'Database Instance Template'. The check is against the Oracle database target my_target. The comparison type is L for latest.
emcli create_compare_check
-name="mycheck1"
-template="Database Instance Template"
-target_type="oracle_database"
-compare_type="L"
-target_name="my_target"
Creates a one-time comparison for the specified template and target type.
Format
There are three forms of the create_config_onetimecompare command:
Latest comparison:
emcli create_config_onetimecompare
-name="<check_name>"
-template_name="<template_name>"
-target_type="<target_type>"
-compare_type="L"
-ref_target_name="<target_name>"
-dest_target_list="<comma_separated_list_of_target_names>"
Saved comparison:
emcli create_config_onetimecompare
-name="<check_name>"
-template_name="<template_name>"
-target_type="<target_type>"
-compare_type="S"
-saved_config_name=<saved_config_name>
-dest_target_list="<comma_separated_list_of_target_name>" | -dest_saved_config_list="<comma_separated_list_of_saved_configuration>"
Consistency comparison
emcli create_config_onetimecompare
-name="<check_name>"
-template_name="<template_name>"
-target_type="<target_type>"
-compare_type="C"
-ref_target_name="<target_name>"
Options
name
Name of the one-time comparison.
template_name
Comparison Template name to be used for the one time comparison.
target_type
Target type of the one-time comparison.
compare_type
Comparison type:
L for latest comparison
S for saved comparison
C for consistency comparison
ref_target_name
Reference target name of the one-time comparison.
dest_target_list
Comma separated list of destination target names of the one-time comparison. Can be used with the dest_saved_config_list option when the comparison type is "S".
saved_config_name
Saved configuration name of the target.
dest_saved_config_list
Comma separated list of destination saved configuration names. Can be used with the dest_target_list option when the comparison type is "S".
Examples
Example 1
The following example creates a one-time comparison for the Latest compare type.
emcli create_config_onetimecompare
-name="my_check"
-template_name="my_template"
-target_type="host"
-compare_type="L"
-ref_target_name="target_name"
-dest_target_list="target1,target2,target3"
Example 2
The following example creates a one-time comparison for the Saved compare type.
emcli create_config_onetimecompare
-name="my_check"
-template_name="my_template"
-target_type="host"
-compare_type="S"
-saved_config_name="saved_config"
-dest_target_list="target1,target2,target3"
Creates one or more cost centers and associates them with respective organizational entities.
Standard Mode
emcli create_cost_centers
cost-centers="cost center name,entity name"[;"cost center name,entity name";…]
[-tenant_name="tenant name"]
[ ] indicates that the parameter is optional.
Interactive or Script Mode
create_cost_centers
(cost-centers="cost center name,entity name"[;"cost center name,entity name";…]
[,tenant_name="tenant name"])
[ ] indicates that the parameter is optional.
Options
cost_centers
Specifies one or more cost centers to create and associate with organizational entities, which may be a line-of-business or a department. The organizational entity must already exist. Use a comma to separate the cost center name from the entity name.
tenant_name
Specifies the name of the tenant to which the organizational entity associated with the cost center belongs. Default is the tenant of the logged-in user.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Examples
Example 1
The following example creates two cost centers, receivables and payables, both associated with the accounting department.
emcli create_cost_centers
-cost_centers="receivables,accounting;payables,accounting"
Example 2
The following example creates two cost centers, coders and testers, the former associated with the development department and the latter associated with the QA department. The organizational entities belong to the engineering tenant.
emcli create_cost_centers
-cost_centers="coders,development;testers,QA"
-tenant_name="engineering"
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
Options
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.
Example
This 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"
Creates a custom plug-in update using a plug-in that is already deployed to a Management Agent. Includes all of the patches that were applied to the source plug-in. Use this in place of Oracle-supplied plug-in versions for all subsequent plug-in deployments on any Management Agent.
Format
emcli create_custom_plugin_update
-agent_name="agent_name"
-plugin_id="plugin_id"
[-overwrite]
[ ] indicates that the parameter is optional.
Options
agent_name
Management Agent (host:port) on which the plug-in and its patches are deployed.
plugin_id
ID of the plug-in that should be used for creating the custom plug-in update. To view a list of plug-ins deployed on a Management Agent, run 'emcli list_plugins_on_agent'.
overwrite
Overwrites and updates an existing custom plug-in update, if a custom plug-in update already exists for that plug-in in the repository. If not provided, the new custom plug-in update is not created for that plug-in. Applies only for subsequent plug-in deployments. Does not automatically redeploy on the Management Agents where the source plug-in was previously deployed. To redeploy on such Management Agents, run 'emcli redeploy_plugin_on_agent'.
Examples
Example 1
The following example creates a custom plug-in update for the oracle.sysman.db plug-in that is already deployed on the Management Agent named host.example.com. If a custom plug-in update already exists for the oracle.sysman.db plug-in, then the command does not overwrite it, and therefore, does not create a new custom plug-in update.
emcli create_custom_plugin_update
-agent_name="host.example.com"
-plugin_id="oracle.sysman.db"
Example 2
The following example creates a custom plug-in update for the oracle.sysman.db plug-in, which is already deployed on the Management Agent named host.example.com, by overwriting and updating the custom plug-in update that already exists for the oracle.sysman.db plug-in in the repository.
emcli create_custom_plugin_update
-agent_name="host.example.com"
-plugin_id="oracle.sysman.db"
-overwrite
Creates a database.
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="path_and_display_name_of_the_software_library_entity"
-hostCreds="named_credential_for_OS_user"
-sysCreds="named_credential_for_SYS_user"
-systemCreds="named_credential_for_SYSTEM_user"
-dbsnmpCreds="named_credential_for_DBSNMP_user"
[-sid="database_system_identifier"]
[-racConfigType="RAC_configuration_type"]
[-nodeList="comma-separated_node_names"]
[-serverPoolList="comma-separated_list_of_server_pools"]
[-newServerPool="new_server_pool_name_and_cardinality"]
[-racOneServiceName="service_name_for_RAC_one-node_database"]
[-templateInSwlib="TRUE|FALSE"]
[-templateStageLocation="temporary_directory_on_agent_side"]
[-storageType="FS|ASM"]
[-dataFileLocation="Location_of_data_files "]
[-recoveryAreaLocation="Fast_Recovery_Area_location "]
[-enableArchiving]
[-useOMF]
[-listeners="comma-separated_list_of_listeners_database"]
[-newListener="new_listener_and_port"]
[ ] indicates that the parameter is optional
Options
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 option.
hostTargets
Comma-separated list of host targets where a single-instance database needs to be created. This is a mandatory option 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 option for RAC and RACONE databases.
oracleHome
Oracle home of the host targets or cluster target. The Oracle home should be present in all of the targets.
gdbName
Global database name of the database.
templateName
Fully-qualified path and display name of the software library entity.
hostCreds
Named host credentials of the user who owns the Oracle Home installation.
sysCreds
Named database credentials to be used to create the SYS user.
systemCreds
Named database credentials to be used to create the SYSTEM user.
dbsnmpCreds
Named database credentials to be used to create the DBSNMP user.
sid
Database system identifier., which can be a maximum length of 12 for SINGLE_INSTANCE, 8 otherwise. This should be alphanumeric, with the first character being an alpha character.
racConfigType
RAC configuration type. Valid values are:
POLICY_MANAGED
ADMIN_MANAGED
The default is ADMIN_MANAGED if not provided.
nodeList
List of valid node names for ADMIN_MANAGED RAC databases. If not provided, all the nodes for the given cluster target are used.
serverPoolList
Comma-separated list of server pool names for POLICY_MANAGED RAC databases.
newServerPool
Note:
You can either use serverPoolList or newServerPool, but not both. For newServerPool, cardinality is mandatory and should be a positive integer greater than 0.
racOneServiceName
Service name for the RAC One Node database.
templateInSwlib
Boolean value stating whether the template is from the software library. Valid values are TRUE if the template is from the software library, otherwise FALSE. The default is FALSE if you do not provide this option.
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 option 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=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 2
emcli create_database -oracleHome=/u01/app/oracle/product/11.2.0/dbhome_2 -gdbName=testdbee -hostCreds=cluster_named
-sysCreds=sys -systemCreds=system -dbsnmpCreds=dbsnmp -templateName=/u01/app/oracle/product/11.2.0/
dbhome_2/assistants/dbca/templates/General_Purpose.dbc
-dbType=RAC -cluster=cluster1 -racConfigType=POLICY_MANAGED -newServerPool=sp1:2
Specify a database size that overrides values specified in the service template.
Format
emcli create_database_size -name="<size name>" -description="<size description>" [-attributes="cpu:<number of cores>;memory:<memory in GB>;processes:<max number of processes>;storage:<Total Storage in GB allocated to database>;"] [-source_type="Profile Source"] [ ] indicates that the parameter is optional.
Note: Use one or more attributes to specify the database size. The different attributes must be separated by a semicolon (; ). Attributes specified using the database_size verb override values specified in the service template.
Options
name
Creates a name for the database size.
description
Creates a description for the database size.
attributes
Defines the database size. Attributes must be separated by a semicolon(;). You can specify values for the following attributes:
cpu: Total number of cpu cores.
memory: Total maximum in GB.
processes: Total number of processes that can simultaneously connect to the database.
storage: Total storage that is allocated to the database (in GB)
Example
The following example creates a database size named Small with a maximum of four CPUs, 50 GB of storage, and 4 GB of memory.
emcli create_database_size
-name=Small
-description="Small size database"
-attributes="cpu:4;storage:50;memory:4"
-source_type="weblogic_domain"
Creates a database quota for an SSA user role.
Format
emcli create_dbaas_quota
-role_name="<SSA user role name>"
-databases="<number of database requests>"
-schema_services="<number of schema service requests>"
-pluggable_databases="<number of Pluggable database service requests>"
-memory="<memory(GB)>"
-storage="<storage(GB)>"
[ ] indicates that the parameter is optional.
Options
role_name
Name of the SSA user role for which the quota is to be created.
databases
Number of database service requests allowed. For example, for 10 requests enter:
-databases="10"
schema_services
Number of schema service requests allowed. For example, for 10 requests enter:
-schema_services="10"
pluggable_databases
Number of pluggable database service requests allowed. For example, for 10 requests enter:
-pluggable_databases="10"
memory
Amount of memory usage allowed. For example, for 10 GB enter:
-memory="10"
storage
Amount of storage usage allowed. For example, for 10 GB enter:
-storage="10"
Example
This example assigns the quota for the role My Role:
emcli create_dbaas_quota
-role_name="My Role"
-databases="10"
-schema_services="10"
-pluggable_databases="10"
-memory="99"
-storage="99"
Creates a new database profile.
Format
emcli create_dbprofile
-input_file=data:"file:path"
[-schedule=
[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{timezone ID}];
[grace_period:xxx];
]
[-purge_policy=DAYS|SNAPSHOTS: number]
[ ] indicates that the parameter is optional.
Options
input_file
A property file which completely describes the type of profile that will be created and the options used.
schedule
frequency: Frequency type with which the Database Profile will be created. It can be interval (in minutes), weekly, monthly or yearly
start_time: Denotes the starting time of Database Profile Component creation in the format yy-MM-dd HH:mm
end_time: Denotes the end time of Database Profile Component Creation Repetition in the format yy-Mm-dd HH:mm
repeat: Repetition rate at which Database Profile will be created. If the frequency is interval, then repeat will be in minutes
months: Number of months after which repetition of Database Profile Component Creation will occur
days: Number of days after which repetition of Database Profile Component Creation will occur
tz: Time Zone ID for example tz:America/New_York
grace_period: A period of time in minutes that defines the maximum permissible delay when attempting to create a Databasse Profile. If the job system cannot start the execution within a time period equal to the scheduled time + grace period, it will set the create Database Profile to be skipped.By default, grace period is indefinite
purge_policy
You can purge the collected data based on number of days or count of snapshots. If you do not specify purge_policy, it is defaulted to NONE. Allowed values: DAYS, SNAPSHOT
DAYS specify the number of days after which the data component should be purged.
SNAPSHOT specify the count or number of data components, after which older data will be purged
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example creates a new database profile based on the property file "profile.txt" with the specified schedule and purge policy.
emcli create_dbprofile -input_file="data:/tmp/profile.txt" -schedule="frequency:interval;start_time:14-10-05 05:30;end_time:14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York" -purge_policy=DAYS:2
Creates a diagnostic snapshot for specified targets.
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
Options
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 options 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
This example creates a snapshot for EMGC_DOMAIN and EMGC_OMS1 targets with offline logs. The target types (weblogic_domain and weblogic_j2eeserver) belong to the Oracle Diagnostic Logging (ODL) diagnostic type.
emcli create_diag_snapshot
–name=wls_snapshot
–desc= “Snapshot for Weblogic Domains and Server"
–start_date="2012/10/02 10:30"
-end_date="2012/10/03 22:30"
–targets="weblogic_domain:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN;
weblogic_j2eeserver: /EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1"
Example 2
This example creates a snapshot for the weblogic_j2eeserver target type with offline logs. You can filter the target types on top of the target list.
emcli create_diag_snapshot
–name=wls_snapshot
–desc=“Snapshot for Weblogic Domains and Server"
–start_date="2012/10/02 10:30"
-end_date="2012/10/03 22:30"
–targets="weblogic_domain:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN;
weblogic_j2eeserver:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1;
weblogic_j2eeserver:/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_ADMIN_SERVER"
-diag_type_odl_target_types="weblogic_j2eeserver"
-diag_type_odl_offline_logs=true
Creates a Fusion Middleware provisioning profile from a WebLogic Domain.
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
Options
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
This example creates a WebLogic Domain profile for the specified schedule from the given WebLogic Domain target using preferred credentials.
emcli create_fmw_domain_profile
-name="BitlessDomainProfile"
-ref_target="/Farm01_base_domain/base_domain"
-description="A domain profile without software bits"
-schedule="start_time:2014/6/21 21:23;tz:America/New_York;grace_period:60"
Example 2
This example immediately creates a WebLogic Domain plus Oracle Home from the given WebLogic Domain target using given named credentials.
emcli create_fmw_domain_profile
-name="DomainProfileWithBits"
-ref_target="/Farm01_base_domain/base_domain"
-oh_cred="MY_HOST_CRED:SYSMAN"
-includeOh
Creates a Fusion Middleware provisioning profile from an Oracle Home.
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
Options
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
This example creates a profile on the specified schedule from the given Oracle Home target using preferred credentials.
emcli create_fmw_home_profile
-name="OhProfile1"
-ref_target="/Farm01_base_domain/base_domain"
-description="An Oracle Home profile"
-schedule="start_time:2014/6/21 21:23;tz:America/New_York;grace_period:60"
Example 2
This example immediately creates a profile from the given Oracle Home target using given named credentials.
emcli create_fmw_home_profile
-name="OhProfile2"
-ref_target="WebLogicServer_10.3.6.0_myhost.mycompany.com_5033"
-oh_cred="MY_HOST_CRED:SYSMAN"
Creates a Management Agent gold image using the specified source Management Agent or by importing an already created image from another Enterprise Management System.
Format
emcli create_gold_agent_image
-image_name="gold_image_name"
-version_name="gold_image_version_name"
-source_agent|-import_location="source_agent|import_location"
[-gold_image_description="gold_image_description"]
[-working_directory="working_directory_location"]
[-config_properties= " agent_configuration_properties"]
[ ] indicates that the parameter is optional.
Options
image_name
Specifies the gold image name to which the created Management Agent gold image must be added.
version_name
Specifies the version name of the Management Agent gold image.
source_agent
Specifies the Management Agent that must be used as the source to create the Management Agent gold image. To view a list of the Management Agents that can be used as a source to create a gold image, run emcli get_targets -target="oracle_emd".
import_location
Specifies the location where gold agent image software is staged for creating the gold agent image version and is accessible from all OMSes.
gold_image_description
Provides a description of the Management Agent gold image.
working_directory
Specifies the working directory that must be used to create the Management Agent gold image. The default working directory is $AGENT_INSTANCE_HOME/install.
config_properties
Specifies the Management Agent configuration properties separated by ";" that must be captured while creating the Management Agent gold image.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Examples
Example 1
The following example creates a Management Agent gold image OPC_AGI_DB_JUL_13, using example.com:3872 as the source Management Agent, and adds the gold image version to the gold image OPC_DB_MONITORING:
emcli create_gold_agent_image
-source_agent=example.com:3872 -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING
Example 2
The following example creates a Management Agent gold image OPC_AGI_DB_JUL_13, using example.com:3872 as the source Management Agent, /tmp as the working directory, and adds the gold image version to the gold image OPC_DB_MONITORING:
emcli create_gold_agent_image
-source_agent=example.com:3872 -version_name=OPC_AGI_DB_JUL_13 -image_name=OPC_DB_MONITORING -working_directory=/tmp
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.
Standard Mode
emcli create_group
-name="name"
[-type=<group>]
[-add_targets="name1:type1;name2:type2;..."]...
[-is_propagating="true/false"]
[ ] indicates that the parameter is optional
Interactive or Script Mode
create_group
(name="name"
[,type=<group>]
[,add_targets="name1:type1;name2:type2;..."]...
[,is_propagating="true/false"])
[ ] indicates that the parameter is optional
Options
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 Standard Mode.
is_propagating
Flag that indicates whether or not privilege on the group will be propagated to member targets. The default is false.
Example
This example creates a database-only group named db_group. This group consists of two Oracle databases: emp_rec and payroll.
emcli create_group
-name=db_group
-add_targets="emp_rec:oracle_database"
-add_targets="payroll:oracle_database"
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.
Standard Mode
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
Options
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
This example uploads the installation media file for the WebLogic Server to the Software Library from the given location on the given host. Preferred host credentials will be used to access the files.
emcli create_inst_media_profile
-name="WebLogic1036Installer"
-host="myhost.mycompany.com"
-description="WebLogic Server 10.3.6.0 installer"
-version="10.3.6.0"
-platform="Generic"
-files="WebLogic:/u01/media/weblogic/wls1036_generic.jar"
Example 2
This example uploads the installation media files for SOA and the WebLogic Server to the Software Library from the given location on the given host. The provided named credentials are used to access the files.
emcli create_inst_media_profile
-name="SOA+WLSInstaller"
-host="myhost.mycompany.com"
-description="SOA 11.1.1.7.0 and WebLogic Server 10.3.6.0 installer"
-version="11.1.1.7.0"
-platform="Generic"
-host_cred="MY_HOST_CRED:SYSMAN"
-files="WebLogic:/u01/media/weblogic/
wls1036_generic.jar;SOA:/u01/media/soa/soa1.zip,/u01/media/soa/soa2.zip"
Creates a Java EE Application Component in the software library. On successful creation, the entity revision is displayed under the specified folder in the software library.
This entity has not been uploaded yet, use the verb upload_jeeappcomp_file to upload it to the software library.
Format
emcli create_jeeappcomp
-name="entity_name"
-folder_id="folder_id"
[-desc="entity_desc"]
[-attr="<attr name>:<attr value>"]
[-prop="<prop name>:<prop value>"]
[-secret_prop="<secret prop name>:<secret prop value>"]
[-note="note text"]
[ ] indicates that the parameter is optional
Options
name
Name of the entity.
folder_id
ID of the folder where the entity will be created. The Software Library Home page exposes the identifier for folders and entities as a custom column called Internal ID. By default, this column is hidden.
desc
A short description about the entity. The new description is visible to all existing revisions.
attr
A name:value pair for specifying the attributes of an entity. It is represented as "attr_name:attr_value". For specifying values for multiple attributes, repeat the -attr option.
prop
A name:value pair for specifying the configuration properties of an entity. It is represented as prop_name:prop_value. For specifying values for multiple properties, repeat the option.
secret_prop
A name:value pair for specifying the configuration property and its secret value. Do not provide the secret value on the command line. Instead, enter the property name and press the Enter key. Provide the secret value when you are prompted for it.
note
Information related to the entity such as changes being made to the entity or modification history that you want to track.
Examples
Example 1
Creates a Java EE Application component called "myJeeAppComp' in the folder identified by folder_id. You can find the folder ID using the custom column called Internal ID available on the Software Library home page. Note that this column is hidden by default.
emcli create_jeeappcomp
-name="myJeeAppComp"
folder_ id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
+E34
Example 2
Creates entity named 'myJeeAppComp' in the folder identified by folder_id with a short description about the entity. Entity attributes such as PRODUCT, PRODUCT_VERSION, and VENDOR are specified. Value for the DEFAULT_HOME configuration property is also specified. A note that includes information related to the entity is included.
The identifier of the newly created entity revision will be printed on the standard output.
emcli upload_jeeappcomp_file
emcli create_jeeappcomp
-name="myJeeAppComp"
folder_id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
-desc="myJeeAppComp description"
-attr="PRODUCT:JEEApp"
-attr="PRODUCT_VERSION:3.0"
-attr="VENDOR:Vendor"
-prop="DEFAULT_HOME:/u01/myJeeAppComp3/"
-note="myJeeAppComp for test servers"
Creates and schedules a job. This verb supports multi-task jobs.
Note:
EM CLI permits OS Script jobs to be run against database targets by setting the targetType property for -input_file in the create_job verb. For example:
targetType=oracle_database
You can set other target types similarly.
EM CLI supports the following job types:
ASMSQLScript ASSOCIATE_CS_FA ASSOCIATE_DOMAIN_FA AssociateClusterASM BlockAgent CoherenceCacheAddition CoherenceNodesRefresh Config Log Archive Locations DbMachineDashboard DiscoverPDBEntities FusionMiddlewareProcessControl GlassFishProcessControl InstallKernelModuleJob Log Rotation OSCommand OpatchPatchUpdate_PA RMANScript RefreshFromEMStore RefreshFromMetalink RefreshFusionInstance SOABulkRecovery SQLScript ShutdownDB StartDepartedCohNodes StartDepartedCohStoreNodes StartFusionInstance StartupDB StatspackPurge StopFusionInstance Upgrade Exalogic Systems WebLogic Domain Discover WebLogic Domain Refresh WLSTScript
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
Options
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 option, see -input_file Syntax Guidelines.
Example
This 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"
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
Options
lib_job_name
Library job to use as a template.
owner
Owner of the job. When this option 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 option, see -input_file Syntax Guidelines.
appendtargets
Appends targets in the property file to existing targets in the library job. Otherwise, library job targets are overwritten by targets in the property file if they are specified.
Examples
Example 1
This 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
This example creates a job named MYJOB2 based on the library job MYLIBJOB1. Properties in /tmp/myjob1_prop.txt will override library job settings.
emcli create_job_from_library -lib_job_name=MYLIBJOB1 -name=MyJob2 -input_file=property_file:/tmp/myjob1_prop.txt
Creates a library job. This verb supports multi-task jobs.
Format
emcli create_library_job
[-name="job_name"]
[-type="job_type"]
-input_file=property_file:"filename"
[ ] indicates that the parameter is optional
Options
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 option, see -input_file Syntax Guidelines.
Example
This 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"
Creates a non-Oracle Middleware Provisioning Profile using the provided archive and properties.
Examples of non-Oracle middleware include Apache Tomcat, JBoss, etc.
For Oracle Middleware Provisioning Profile, refer to other verbs such as create_fmw_domain_profile or create_fmw_home_profile.
Format
emcli create_mw_profile
-input_file=propertiesXml:"Properties XML"
-host="Host Target Name"
[-host_cred="Host Credentials"]
[-location="Software Library Location"]
[-input_file=parameters:"Provisioning Options"]
-files=
Archive1,
Archive2,
Script1,
Script2
[ ] indicates that the parameter is optional.
Options
input_file
An XML file describing the characteristics of the profile. It also contains a list of commands that can be executed to provision from the profile.
host
Name of the host target where all files are stored including the archives and, if required, any scripts required during provisioning.
host_cred
Named credentials used to access the reference host. This option is not mandatory. To pass the credential option, enter a name:value pair in the following format:
credential_name:credential_owner
Where:
credential_name is the name of the named credential.
credential_owner is the credentials of the Oracle home owner on the administration server host.
If no named credential is provided, the preferred host credential for the host target will be used.
location
The software library location for the profile. This option is not mandatory. The default is: Middleware Provisioning/Generic Profiles.
input_file:properties
A properties file listing values for all of the parameters required by the commands listed in the profile properties. This is an optional parameter as the same can be provided during provisioning as well.
files
List of files that must be uploaded to the software library. These files are passed in the format file1,file2. All of the files necessary for provisioning from this profile should be provided.
Example
The following example uploads the archives and the provisioning scripts to the software library from the host myhost.example.com. The profile is created using the named credentials specified.
emcli create_mw_profile
-input_file=propertiesXml:"/u11/myprofile/properties.xml"
-host="myhost.mycompany.com"
-host_cred="MY_HOST_CRED:SYSMAN"
-location="My Stuff/Profiles/Middleware"
-files="/u11/myprofile/binaries.zip,/u11/myprofile/
configuration.zip,/u11/myprofile/cloneBinaries.sh,/u11/myprofile/cloneConfig.sh"
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.
Standard Mode
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;...>
Interactive or Script Mode
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;...>)
Options
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 -input_file Syntax Guidelines.
input_bfile
Use this to supply binary property values from the file.
For more information about the input_file parameter, see -input_file Syntax Guidelines.
properties_file
Use this to pass all parameters from the file. Values given on the command line take precedence.
attributes
Specify credential columns as follows:
colname:colvalue;colname:colvalue
You can change the separator value using -separator=attributes=<newvalue>, and you can change the subseperator value using -subseparator=attributes=<newvalue>.
For more information about the separator and subseperator parameters, see -input_file Syntax Guidelines.
Examples
Example 1
This example create a HostCreds named credential with username foo and password bar:
emcli create_named_credential
-cred_name=NC1
-auth_target_type=host
-cred_type=HostCreds
-attributes="HostUserName:foo;HostPassword:bar"
Example 2
This example creates a privilege delegation credential with the user name foo, password bar, privilege delegation type SUDO, and RUNAS user root:
emcli create_named_credential
-cred_name=NC1
-auth_target_type=host
-cred_type=HostCreds
-attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:SUDO;RUNAS:root"
To use Powerbroker attributes, the string should be:
-attributes="HostUserName:foo;HostPassword:bar;PDPTYPE:POWERBROKER;RUNAS:root; PROFILE:EMGC
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"
Options
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
Creates an organizational entity, which can be either a department or a line-of-business. A department is typically a division within an organization that refers to a specific responsibility. A line-of-business, or LOB, generally describes the products or services offered by a business.
You can also create cost centers when creating an organizational entity. A cost center is the smallest segment of an organization for which costs can be collected and reported.
Standard Mode
emcli create_organizational_entity
-entity_name="entity name"
-entity_type="entity type"
[-parent_entity_name="parent entity name"]
[-tenant_name="tenant name"]
[-cost_centers="cost centers"[;"cost centers"...]]
[-separator=argument_name="separator_value"])
[ ] indicates that the parameter is optional.
Interactive or Script Mode
create_organizational_entity
(entity_name="entity name"
,entity_type="department|lob"
[,parent_entity_name="parent entity name"]
[,tenant_name="tenant name"]
[,cost_centers="cost centers"[;"cost centers"...]]
[,separator=argument_name="separator_value"])
[ ] indicates that the parameter is optional.
Options
entity_name
Name of the organizational entity to be created.
entity_type
Type of entity to be created. Value is either department or lob.
parent_entity_name
Specifies a parent of the organizational entity being created. The parent must already exist and can be either a department or LOB, regardless of the type being created. Default is no parent.
tenant_name
Specifies the name of the tenant to which the organizational entity being created belongs. Default is the tenant of the logged-in user.
cost_centers
Specifies one or more cost centers to create and associate with the organizational entity being created. Default is no cost centers. You can create cost centers and associate them independently, using the create_cost_centers verb.
separator
Overrides the separator for multi-value input arguments, which is a semicolon (;). For information about overriding the separator or subseparator, see "Overriding the Separator and Subseparator".
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Examples
Example 1
The following example creates a department named finance with three cost centers, C1, C2, C3.
emcli create_organizational_entity
-entity_name="finance"
-entity_type="department"
-cost_centers="c1;c2;c3"
Example 2
The following example creates a department named finance with three cost centers, C1, C2, C3, where the separator is changed to a comma (,).
emcli create_organizational_entity
-entity_name="finance"
-entity_type="department"
-cost_centers="c1,c2,c3"
-separator=cost_centers=","
Creates a PaaS Infrastructure Zone.
Format
emcli create_paas_zone
-name="<PaaS Zone name>"
-credential="<global named credential>"
[-hosts="<Host1,Host2,Host3...>"]
[-ovm_zones="<OVMZone1,OVMZone2,OVMZone3...>"]
[-roles="<ssaRole1,ssaRole2,..>"]
[-description="<PaaS Zone description>"]
[-cpu_utilization="<value between 1 and 100>"]
[-memory_utilization="<value between 1 and 100>"]
[ ] indicates that the parameter is optional.
Options
name
Name of the PaaS Infrastructure Zone to be created.
credential
Global named credentials to be used for provisioning in this PaaS Infrastructure Zone. The credentials should be the same for all hosts. A cloud administrator can only use the named credentials that they own.
hosts
A comma-separated list of the host targets to be added as members of this Paas Infrastructure Zone.
ovm_zones
Comma-separated list of the Oracle Virtual Machine (OVM) Zone targets to be added as members of this Paas Infrastructure Zone. You must add at least one host or OVM Zone target for a PaaS Infrastructure Zone to be created.
roles
Comma-separated list of SSA roles that can access this PaaS Infrastructure Zone. A PaaS Infrastructure Zone can be made available to a restricted set of users through the use of roles. The SSA roles should already be created before executing this EM CLI command.
description
Description of the PaaS Infrastructure Zone.
cpu_utilization
Placement policy constraints enable the cloud administrator to set maximum ceilings for any host in the PaaS Infrastructure Zone. This constraint restricts the maximum resource consumption for the host members in a PaaS Infrastructure Zone. For example, a production PaaS Infrastructure Zone might limit CPU utilization to 80%, whereas a development PaaS Infrastructure Zone might allow up to 95 percent utilization. The service instance will be provisioned on the first host that satisfies the placement constraints. The value entered must be between 1 and 100. If not specified, the default value of 80% is used.
memory_utilization
Placement policy constraint for the PaaS Infrastructure Zone that restricts the percent of memory used. The value entered must be between 1 and 100. If not specified, the default value of 80% is used.
Example
This example creates a Paas Infrastructure Zone with the name My PaaS Zone:
emcli create_paas_zone
-name="My PaaS Zone"
-credential="ZoneNamedCredentials"
-hosts="host1.mycompany.com, host2.mycompany.com"
-roles="SSA_USER_ROLE"
-description="This is a test PaaS Zone"
-cpu_utilization="85"
-memory_utilization="75"
Format
emcli create_partition_profile
-name="Profile Name"
-ref_target="Reference Target Name"
-partition_name="Partition Name"
[-oh_cred="Oracle Home Owner Credentials"]
[-wls_cred="WebLogic Administrator Credentials"]
[-schedule=start_time:yyyy/MM/dd HH:mm;
[tz:{java timezone ID}];
[grace_period:xxx]; ]
[-workDir="Working Directory Location"]
[ ] indicates that the parameter is optional.
Options
name
Name of the WebLogic Domain Partition Profile.
ref_target
Name of the reference WebLogic Domain target from which the partition will be exported.
partition_name
Name of the partition from which the profile will be created.
oh_cred
Named credential used to access the reference host. This is an optional parameter. To pass the credential parameter, enter a name: value pair in the following format:
credential_name:credential_owner
Credential_name is the name of the named credential.
Note:
All the operations will be performed on the Administration Server host.
If no named credential is provided, the preferred host credentials for the Oracle home target will be used.
wls_cred
Named credential used to access the Administration Server.
This is an optional parameter. To pass the credential parameter, enter a name: value pair in the following format:
credential_name:credential_owner
Credential_name is the name of the named credential.
Note:
If no named credential is provided, the preferred Administrator credentials for the domain target will be used.
schedule
Specify when to run the deployment procedure. If no value is entered, by default, the procedure runs immediately. To schedule a procedure, provide:
start_time: when the procedure should start.
tz: the timezone id.
grace_period: grace period in minutes.
workDir
Specify the working directory to be used. This is an optional parameter
Example 5-1 Examples
A WebLogic Domain Partition profile called HRPartitionProfile is created using the partition HRPartition from the domain base_domain at the specified schedule.
No credentials were specified, so the preferred credentials are used.
emcli create_fmw_domain_profile -name="HRPartitionProfile" -ref_target="/Farm01_base_domain/base_domain" -partition_name="HRPartition" -description="A partition profile for human resources" -schedule="start_time:2016/6/21 21:23;tz:America/New_York;grace_period:60" -workDir="/u01/mytemp"
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
Options
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 -input_file Syntax Guidelines.
impact_other_targets
Action to take when other targets are impacted while adding the patches to the plan. Possible values for this option 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 option are:
ignore_all_warnings — Ignore all warnings. cancel — Cancel the plan creation.
See Also
Also see Patching Using EMCLI in the Enterprise Manager Lifecycle Management Administrator's Guide:
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"
You can use the following sample input file to create a patch plan with two patches:
patch.0.patch_id=4518443
patch.0.release_id=80102010
patch.0.platform_id=226
patch.0.language_id=0
patch.0.target_name=orclws
patch.0.target_type=oracle_database
patch.1.patch_id=4424952
patch.1.release_id=80102030
patch.1.platform_id=46
patch.1.language_id=0
patch.1.target_name=arac
patch.1.target_type=rac_database
Creates a software pool.
Format
emcli create_pool
-name="<software pool name>"
-target_type="<software pool target type>"
-paas_zone="<Paas Infrastructure Zone of software pool>"
-members="<Member1, Member2...>"
[-description="<software pool description>"]
[-placement_constraints="<constraint1=value1, constraint2=value2...>"]
[-member_constraints="<constraint1=value1, constraint2=value2>"]
[-properties="<property1=value1, property2=value2>"]
[ ] indicates that the parameter is optional.
Options
name
Name of the software pool to be created.
target_type
Target type of the software pool to be created, for example "mwaas_zone" for the middleware Pool, "oracle_cloud_zone" for the database pool, and "schaas_pool" for schema pool.
paas_zone
Name of PaaS Infrastructure Zone in which the software pool is to be created.
members
Comma-separated list of targets to be added as members of the software pool. The targets to be added must satisfy the member constraints specified.
description
Description of the software pool.
placement_constraints
Comma-separated key-value pairs of the placement constraints that enable the self-service administrator to set maximum ceilings for resource utilization. This ability provides protection for the members of the software pool in terms of resource consumption. For example, a production software pool might enforce more conservative limits, whereas a development software pool might enforce more liberal limits.
member_constraints
Comma-separated key-value pairs that restrict the addition of member targets to a software pool with a set criteria. Execute "emcli get_pool_allowed_member_constraints -target_type=<Target type>" to retrieve the list of allowed possible member constraints for a pool target type.
properties
Comma-separated key-value pairs for additional properties that must be specified based on the pool target type.
Example
The following example creates the My Pool software pool:
emcli create_pool
-name="My Pool"
-target_type="mwaas_zone"
-paas_zone="My PaaS Zone"
-members="MyMember"
-description="This is a test Pool"
-placement_constraints="MAX_INSTANCES=20"
-member_constraints="VERSION=10.3.5.0"
Creates a pluggable database.
Format
emcli create_pluggable_database
-cdbTargetName="Specify the CDB target name for creating new PDB"
-cdbTargetType="Specify the CDB target type - oracle_database, rac_database"
-cdbHostCreds="Specify the host credentials on which the CDB target is located. (owner:name)"
[-cdbTargetCreds="Specify the credentials of container database on which the new PDB will be created. (owner:name)"]
-pdbName="Specify a name for the new PDB"
-sourceType="Type of pdb to be created - DEFAULT, UNPLUGGED_PDB, CLONE, PROFILE"
[-sourcefromSWLIB="If -sourceType is 'UNPLUGGED_PDB', specify if the dump location is SWLIB or not."]
[-pdbTemplateInSWLIB="If -sourceFromSWLIB, specify the URN of pdb template component in SWLIB."]
[-sourcePDBTempStagingLocation="Specify fully qualified location for staging temporary files. If not specified it will be defaulted to to "C:\Temp" in case of Windows and "\tmp" otherwise."]
[-unpluggedPDBType="If -sourceType is 'UNPLUGGED_PDB', specify pdb dump type - ARCHIVE, RMAN, XML."]
[-sourcePDBArchiveLocation="If -unpluggedPDBType=ARCHIVE, this is fully qualified archive location"]
[-sourcePDBMetadataFile="If -unpluggedPDBType=RMAN or XML, this is fully qualified path of the source PDB metadata file"]
[-sourcePDBDatabackup="If -unpluggedPDBType=RMAN, this is fully qualified path of the source PDB datafile"]
[-moveDatafiles="If -unpluggedPDBType=XML, this will move the source PDB datafiles to the destination"]
[-excludeStandbys="If -unpluggedPDBType=XML and if 'moveDatafiles' is specified, this will exclude the new PDB from standby CDBs"]
[-sourcePDBName="If -sourceType is 'CLONE', specify the name of an existing PDB which is a valid em target"]
[-sourceCDBCreds="If -sourceType is 'CLONE', specify the credentials of container database on which the -sourcePDBName is present. (owner:name)"]
[-pdbAdminCreds="Name of pdb credentials with admin role. (owner:name)"]
[-useOMF="Specifies that the datafiles can be stored in OMF location"]
[-sameAsSource="Specifies that the datafiles of new PDB can be stored in the same location as that of source CDB"]
[-newPDBFileLocation="Specify the storage location for datafiles of the created PDB."]
[-createAsClone="If -sourceType is 'UNPLUGGED_PDB' and if 'createAsClone' is specified, the PDB will be created as clone."]
[-lockAllUsers="If -sourceType is 'UNPLUGGED_PDB' and if 'lockAllUsers' is specified, all PDB users of the new PDB will be locked."]
[-noUserTablespace="Specifies that the new DEFAULT PDB will not be created with USERS tablespace."]
[-useSnapClone="If -sourceType is 'CLONE', specify if Snap Clone should be used for cloning"]
[-sourceCDBHostCreds="If -sourceType is 'CLONE' and -useSnapClone is specified, this is the host credentials for the source container database. (owner:name)"]
[-mountPointPrefix="If -sourceType is 'CLONE' and -useSnapClone is specified, this is the mount point prefix for the clone volumes"]
[-writableSpace="If -sourceType is 'CLONE' and -useSnapClone is specified, this is the writable space in GB for the clone volumes"]
[-saveProfile="If -sourceType is 'CLONE' and -useSnapClone is specified, -saveProfile allows the created snapshot to be saved as profile"]
[-profileName="If -saveProfile is specified, -profileName is required"]
[-profileLocation="If -saveProfile is specified, -profileLocation is required"]
[-profileURN="If -sourceType is 'PROFILE', -profileURN is required"]
[-privHostCreds="If -sourceType is 'CLONE' and -useSnapClone is specified, this is the privileged host credentials to mount the volumes at the specified locations. (owner:name)"]
[ ] indicates that the parameter is optional
Options
cdbTargetName
Target container database for which pluggable database is to be created. It should be a valid target on enterprise manager.
cdbTargetType
Type of target container database.
cdbHostCreds
Credentials for the host on which the target container database is located. This is the name of the credentials saved in enterprise manager. To specify a credential owned by an user other than the current, use the form (owner:name).
cdbTargetCreds
Credentials for the container database on which the new PDB will be created. This is the name of the credentials stored in enterprise manager.
pdbName
Pluggable database name to be created. This works as a prefix in case of multiple pluggable database creation and will be suffixed with sequence number to generate pdb name <pdbname>#
numOfPdbs
Total number of pluggable databases to be created. The maximum number of new pluggable databases that are allowed in a given container database is 252 . If not specified, the default value is 1.
sourceType
DEFAULT: This will create a pluggable database from seed pluggable database
UNPLUGGED_PDB: This will create a pluggable database from existing dump of an unplugged database like Archive, RMAN file set, or from XML
CLONE: This will create a pluggable database from an existing pluggable database
PROFILE: This will create a pluggable database from an existing PDB profile
sourceFromSWLIB
If the -sourceType is specified as 'UNPLUGGED_PDB' and the dump is available in software library, this flag must be set.
pdbTemplateInSWLIB
If the -sourceFromSWLIB, specify the valid URN of the pdb template in Software Library.
sourcePDBTempStagingLocation
Specify fully qualified location for staging temporary files. If not specified, the default location is "C:\Temp" in case of Windows and "\tmp" otherwise. Files are deleted after the operation.
unpluggedPDBType
ARCHIVE: This will create a pluggable database from existing PDB archive
RMAN: This will create a pluggable database from existing PDB RMAN file set
XML: This will create a pluggable database from the metadata file
sourcePDBArchiveLocation
If the -unpluggedPDBType is specified as ARCHIVE, this is the fully qualified location of PDB archive.
sourcePDBMetadataFile
If the -unpluggedPDBType is specified as RMAN or XML, this is the fully qualified location of the metadata file.
sourcePDBDatabackup
If the -unpluggedPDBType is specified as RMAN, this is the fully qualified location of datafile backup.
moveDatafiles
This parameter is applicable only if the parameter -unpluggedPDBType is specified as XML. This option indicates that the datafiles of the source pluggable database should be moved to the destination datafiles location.
excludeStandbys
This parameter is applicable only if the parameter -unpluggedPDBType is specified as XML and if 'moveDatafiles' is indicated. This option will exclude the new pluggable database from all standby container databases (STANDBYS=NONE).
sourcePDBName
If -sourceType is specified as clone, this specifies the name of the pluggable database from which the new pluggable database will be cloned from. This has to be a valid target in enterprise manager.
sourceCDBCreds
If -sourceType is specified as clone, provide the credentials for the container database on which the -sourcePDBName is present. This is the name of the credentials stored in enterprise manager.
useOMF
Destination of the datafiles for the new pluggable database will be the OMF location. This is valid only if the source CDB is OMF.
sameAsSource
Destination of the datafiles for the new pluggable database will be same as CDB. In case of multi PDB creation this option is invalid.
newPDBFileLocation
Destination of the datafiles for the new pluggable database.
pdbAdminCreds
New pluggable database admin credentials. This is a mandatory parameter, if the source of new pluggable database is DEFAULT, for other options, it is optional.
createAsClone
This flag specifies whether the new pluggable database should be created as clone, if the -sourcePDBType is specified as 'UNPLUGGED_PDB' and is used by default in case of multiple pluggable database creation.
lockAllUsers
This flag specifies whether all the users should be locked in case of -sourcePDBType being 'UNPLUGGED_PDB'.
noUserTablespace
This flag specifies whether new DEFAULT PDB should be created without USER tablespace. This is applied only if the -sourceType is DEFAULT.
useSnapClone
This flag specifies whether Snap Clone can be used for cloning the PDB. This is applied only if the -sourceType is CLONE.
sourceCDBHostCreds
This is the host credentials to get storage information of the source container database. This is applied only if the -sourceType is CLONE and -useSnapClone is specified.
mountPointPrefix
This is the mount point prefix for the clone volumes. This is applied only if the -sourceType is CLONE and -useSnapClone is specified.
writableSpace
This is the writable space in GB for the clone volumes. This is applied only if the -sourceType is CLONE and -useSnapClone is specified.
saveProfile
This allows the snapshot created for the source PDB to be saved as a profile. This is applied only if the -sourceType is CLONE and -useSnapClone is specified.
profileName
This specifies the name of the profile to be created. This is applied only if -saveProfile is specified.
profileLocation
This specifies the location under software library where the created profile will be saved. This is applied only if -saveProfile is specified.
profileURN
This specifies the URN of the profile from which PDB will be created. This is applied only if the -sourceType is PROFILE.
privHostCreds
This is the privileged host credentials to mount the volumes at the specified locations. This is applied only if the -sourceType is CLONE and -useSnapClone is specified.
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=1
-sourceType=CLONE
-cdbHostCreds=SYSMAN:HOST_CREDS
-cdbTargetCreds=SYSMAN:DBSNMP
-sourcePDBName=source_pdb
-sourceCDBCreds=CDB_SYS_CREDS
-useSnapClone
-srcCDBHostCreds=SYS
-mountPointPrefix=/mount/point/prefix -writableSpace=1
-sourcePDBTempStagingLocation=/tmp
-privHostCreds=HOST_SUDO
-saveProfile -profileName=PROFILENAME
-profileLocation=MyProfiles
Example 3
emcli create_pluggable_database
-cdbTargetName=database
-cdbTargetType=oracle_database
-pdbName=pdb -numOfPdbs=1
-sourceType=PROFILE
-cdbHostCreds=HOST_CREDS
-cdbTargetCreds=DBSNMP
-mountPointPrefix=/mount/point/prefix
-writableSpace=1
-sourcePDBTempStagingLocation=/tmp
-privHostCreds=HOST_SUDO -profileURN=oracle:defaultService:em:provisioning:1:PROFILE:URN:RANDOM:0.1
Example 4
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
Example 5
emcli create_pluggable_database
-cdbTargetName=database
-cdbTargetType=oracle_database
-cdbHostCreds=HOST_CREDS
-cdbTargetCreds=CDB_SYS_CREDS
-pdbName=pdb
-sourceType=CLONE
-sourcePDBName=source_pdb
-sourceCDBCreds=CDB_SYS_CREDS
-useSnapClone -srcCDBHostCreds=HOST_CREDS
-mountPointPrefix=/oracle -writableSpace=1
-sourcePDBTempStagingLocation=/tmp
-privHostCreds=ROOT_CREDS
Creates a privilege delegation setting template to apply later. You must create at least one setting to use the apply_privilege_delegation_setting verb.
Standard Mode
emcli create_privilege_delegation_setting
-setting_name="name"
-setting_type="ttype"
[-settings="setting"]
[-separator=settings=";"]
[-subseparator=settings=","]
[ ] indicates that the parameter is optional
Interactive or Script Mode
create_privilege_delegation_setting
(setting_name="name"
,setting_type="ttype"
[,settings="setting"]
[,separator=settings=";"]
[,subseparator=settings=","])
[ ] indicates that the parameter is optional
Options
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 -input_file Syntax Guidelines.
subseparator
Separator inserted between the name and value in each name-value pair for the given name. The default value is a semi-colon ( ; ).
For more information about the input_file parameter, see -input_file Syntax Guidelines.
Examples
Example 1
These examples create a setting named sudo_setting. The setting is of type SUDO, and the Sudo path used is /usr/local/bin/sudo. Sudo arguments are:
-S -u %RUNAS% %COMMAND%
emcli create_privilege_delegation_setting
-setting_name=sudo_setting
-setting_type=SUDO
-settings="SETTINGS:/usr/local/bin/sudo -S -u %RUNAS% %COMMAND%"
Example 2
This example creates a setting named pb_setting. The setting is of type POWERBROKER, and the PowerBroker path used is /etc/pbrun. Arguments are:
%RUNAS% %PROFILE% %COMMAND%
emcli create_privilege_delegation_setting
-setting_name="pb_setting"
-setting_type="POWERBROKER"
-settings="SETTINGS,/etc/pbrun %RUNAS% %PROFILE% %COMMAND%"
-separator="settings=;"
-subseparator="settings=,"
Creates a retroactive blackout on given targets and updates their availability. Only Enterprise Manager Administrators with OPERATOR privilege on the target can perform this action. The retroactive blackout feature needs to be enabled from the user interface to use this command.
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
Options
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
This example creates a retroactive blackout on Oemrep_Database and updates the target's availability record from 2013-09-20 12:12:12 UTC to 2013-09-20 12:15:00 UTC as the blackout.
emcli create_rbk -reason="Testing"
-add_targets="Oemrep_Database:oracle_database"
-schedule="start_time:2013-09-20 12:12:12;end_time:2013-09-20
12:15:00;tzregion:UTC"
Example 2
This example creates a retroactive blackout for all targets on host example.company.com and updates their availability records from 2013-09-20 12:12:12 UTC to 2013-09-20 12:15:00 UTC as the blackout.
emcli create_rbk -reason="Testing"
-add_targets="example.company.com:host"
-schedule="start_time:2013-09-20 12:12:12;end_time:2013-09-20
12:15:00;tzregion:UTC"
-propagate_targets
Defines a redundancy group name and its members. After you create the redundancy group, you can edit it from the Enterprise Manager Cloud Control console to configure charts to be displayed for redundancy group members.
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
Options
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
This 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"
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
Options
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 optionand 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
This example creates a redundancy group with the name 'redGrp1' and with listener, listener2, listener3 as its member targets. The status is calculated as the redundancy group being up if 55 percent of its member targets are up.
emcli create_redundancy_group -redundancyGroupName='redGrp1' -memberTargetType='oracle_listener' -memberTargetNames='listener;listener2;listener3' -group_status_criterion='PERCENTAGE' -group_status_tracked='UP' -group_status_value='55'
Example 2
This example creates a 'redGrp1' redundancy group with listener, listener2, and listener3 as its member targets and time zone as PST8PDT. The status is calculated as the redundancy group being up if two of its member targets are up.
emcli create_redundancy_group -redundancyGroupName='redGrp1'
-memberTargetType='oracle_listener'
-memberTargetNames='listener;listener2;listener3'
-timezone_region='PST8PDT'
-group_status_criterion='NUMBER'
-group_status_tracked='UP'
-group_status_value='2'
Creates a new resolution state that describes the state of incidents or problems. Only super administrators can execute this command. The new state is always added between the New and Closed states. You need to specify the exact position of this state in the overall list of states by using the position option. The position can be between 2 and 98.
The state is applicable by default to both incidents and problems. You can use the applies_to option to indicate that the state is applicable only to incidents or problems. A success message is reported if the command is successful. An error message is reported if the create fails.
Format
emcli create_resolution_state
-label="label_for_display"
-position="display_position"
[-applies_to="INC|PBLM"]
[ ] indicates that the parameter is optional
Options
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
This example adds a resolution state that applies to both incidents and problems at position 25.
emcli create_resolution_state -label="Waiting for Ticket" -position=25
Example 2
This example adds a resolution state that applies to problems only at position 35.
emcli create_resolution_state -label="Waiting for SR" -position=35 -applies_to=PBLM
Creates a new Enterprise Manager admininistrator role.
Standard Mode
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
Interactive or Script Mode
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
Options
name
Role name.
type
Type of role. The default value for this option is EM_ROLE. Other possible values for this parameter are EM_ROLE and 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. If the role must be granted with the WITH_ADMIN option, include the <subseparator:>WITH_ADMIN option.
privilege
Privilege to grant to this role. You can specify this option more than once. Note: Privileges are case-insensitive.
Specify <secure_resource_details> as follows:
resource_guid|[resource_column_name1=resource_column_value1[:resource_column_name2=resource_column_value2]..]"
To get the list of SYSTEM privileges, which do not require resource information, execute the following emcli command:
emcli get_supported_privileges -type=SYSTEM
To get the complete list of privileges and resource column names, execute the following emcli command:
emcli get_supported_privileges
To get the list of target type privileges, execute the following emcli command:
emcli get_supported_privileges -type=TARGET
To get the list of job privileges, execute the following emcli command:
emcli get_supported_privileges -type=JOB
separator
Specify a string delimiter to use between name-value pairs for the value of the privilege option. The default separator delimiter is ";" .
For example: separator="<attribute_name=sep_char>"
where attribute_name is the name of the attribute for which you want to override the separator character and sep_char is the new separator character: separator="att=#"
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 ";" .
For example: subseparator="<attribute_name=sep_char>"
where attribute_name is the name of the attribute for which you want to override the separator character and sep_char is the new subseparator character: subseparator="att=#"
For information about overriding the separator or subseparator, see "Overriding the Separator and Subseparator".
Examples
These examples create a role named my_new_role with the one-sentence description - "This is a new role called my_new_role". The role combines three existing roles: role1, role2, and role3. The role also has two added privileges: to view the job with ID 923470234ABCDFE23018494753091111 and to view the target host1.example.com:host. The role is granted to johndoe and janedoe.
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")
These examples create a role named my_external_role with a role type of EXTERNAL_ROLE and one-sentence description of "This is an external role."
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")
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
Options
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 -input_file Syntax Guidelines.
sysAvailType
Type of availability when the availType is system-based. Sets the availability to either system target directly or selected components of a system.
If availability is set to 'system target directly,' the system needs to have availability[status] defined. systemname and systemtype are required parameters.
If availability is set to 'selected components of a system,' systemname, systemtype and keycomponents are required parameters.
If availability is set to 'system target directly,' and if the system does not have availability[status] defined, the availability set is invalid. Therefore, the only option that can be set is 'selected components of a system'.
Examples
Example 1
This example creates a generic service named my_service with specified properties on a generic system named my_system. The availability is set as system-based, and the availability is based on system target status.
emcli create_service
-name='my service' -type='generic_service'
-availType='system' -availOp='or'
-sysAvailType='system target directly'
-properties='prop1:value1; prop2:value2'
-timezone_region='PST8PDT'
-systemname='my system' -systemtype='generic_system'
Example 2
This example creates a generic service named my_service with specified properties on a generic system named my system with specified key components. The availability is set as system-based.
emcli create_service
-name='my_service' -type='generic_service'
-availType='system' -availOp='or'
-properties='prop1:value1; prop2:value2'
-timezone_region='PST8PDT'
-systemname='my system' -systemtype='generic_system'
-keycomponents='database:oracle_database; mytestbeacon:oracle_beacon'
Creates a service template.
Format
emcli create_service_template
-name="<service template>"
-service_family="<service family>"
-service_type="<service type>"]
-pool_target_type="target type of software pools"
-software_pools="<SwPool1,SwPool2,SwPool3,...>"
[-roles="<SsaRole1,SsaRole2,..>"]
[-description="<service template description>"]
[-input_file="data:<service executable metadata file>"]
[ ] indicates that the parameter is optional.
Options
name
Name of the service template to be created.
service_family
Service family for which the service template is being created, for example DBAAS for database, MWAAS for middleware.
service_type
Service type for which the service template is being created, for example PhysicalWLS for a physical middleware service template.
pool_target_type
Target type of the software pools to be associated with the service template.
software_pools
Comma-separated list of software pools to be associated with the service template.
roles
Comma-separated list of SSA roles that can access this service template. A service template can be made available to a restricted set of users through the use of roles. The SSA roles should already be created before executing this EM CLI command.
description
Description of the service template.
input_file
Contains configuration and profile data in JSON format that will be required for setting values of procedure configuration variables. For example:
input_file="data:executable.json"
Example
This example creates the service template My Service Template:
emcli create_service_template
-name="Middleware service template August"
-service_family="MWAAS"
-service_type="PhysicalWLS"
-pool_target_type="mwaas_zone"
-software_pools="MyPoolOH"
-roles="SSA_USER_ROLE"
-description="Middleware small instance service template."
-input_file="data:executable.json"
Creates a site configuration for Site Guard. It associates the systems and their roles.
Format
emcli create_siteguard_configuration
-primary_system_name=<name>
-standby_system_name=<name1;name2;...>
Options
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"
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.
Options
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 option, you need to specify the use_preferred_credential parameter.
use_preferred_credential
Name of the credential. If you do not specify this option, 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"
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.
Options
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 optionoverrides 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"
Note:
Since create_standby is deprecated, use create_standby_database instead.Format
emcli create_standby
-source_db_target_name="<standby database target name>"
-source_db_target_type="oracle_database|rac_database"
-dest_oracle_sid="<standby instance name>"
-spname="<standby database unique name>"
[-source_db_creds_name="primary database credential name"]
[-source_host_creds_name="primary database host credential name"]
[-dest_host_creds_name="standby database host credential name"]
[-asm_inst_creds_name="asm instance credential name"]
[-dest_host_name="standby host name"]
[-dest_oracle_home="standby database oracle home"]
[-dest_target_name="standby database target name"]
[-use_duplicate=\"Yes|No\"]
[-source_staging_area="primary staging directory"]
[-storage_type="storage type"]
[-dest_db_database_area="standby database files location"]
[-dest_db_recovery_area="standby database fast recovery area"]
[-dest_listener_selection="standby database listener selection"]
[-dest_listener_name="standby database listener name"]
[-dest_listener_port="standby database listener port"]
[-stby_type="standby type"]
[-use_broker=\"Yes|No\"]
[-use_sys_dba_monitoring_creds="use sys dba monitoring creds"]
[-dest_staging_area="standby staging directory"]
[-configure_with_oracle_restart]
Options
source_db_target_name
Primary database Enterprise Manager target name source. Can either be a single-instance database or a cluster database instance.
source_db_target_type
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
dest_oracle_sid
Standby database instance name.
spname
Standby database unique name.
source_db_creds_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
source_host_creds_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
dest_host_creds_name
Standby database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
asm_inst_creds_name
ASM instance named credential.
dest_host_name
Standby database host name. Default is primary host name.
dest_oracle_home
Standby database Oracle Home location. Default is primary database Oracle Home location.
dest_target_name
Standby database Enterprise Manager target name. Default is standby database unique name.
use_duplicate
Database files moved directly to clone the database host by the Recovery Manager(RMAN). Default is yes.
source_staging_area
Staging area used to store the backup of a primary database. This option is applicable only when use_duplicate is not set.
storage_type
Standby database storage type.
FILE_SYSTEM: Standby database files are in a regular file system.
ASM_STORAGE: Standby database uses Automatic Storage Management (ASM).
Default is FILE_SYSTEM.
dest_db_database_area
Standby database files Oracle-managed files (OMF) location. Can be a regular file system (if storage_type is FILE_SYSTEM) or an ASM diskgroup (if storage_type is ASM_STORAGE).
dest_db_recovery_area
Standby database fast recovery area.
dest_listener_selection
Standby database listener selection.
GRID_INFRA: Uses the Grid Infrastructure Home listener.
DEST_DB_HOME: Uses the listener from the standby database Oracle Home.
Default is GRID_INFRA.
dest_listener_name
Standby database listener name. This option is applicable only if dest_listener_selection is set to DEST_DB_HOME.
If not specified, default value is the first existing TCP listener found in the standby database Oracle Home. Note that if dest_listener_name is specified, then dest_listener_port must also be specified.
dest_listener_port
Standby database listener port. This option is applicable only if dest_listener_selection is set to DEST_DB_HOME. Note that if dest_listener_port is specified, then dest_listener_name must also be specified.
stby_type
Type of the standby database to be created.
PHYSICAL
LOGICAL
Default is PHYSICAL.
use_broker
Uses Data Guard broker to manage the Data Guard configuration. Default is yes.
use_sys_dba_monitoring_creds
Uses SYSDBA credentials to monitor the standby database. Default is no.
dest_staging_area
Staging area used to store the backup files transferred from the primary host. This option is applicable only when use_duplicate is not set.
configure_with_oracle_restart
If the destination host has Oracle Restart configured, it configures the standby database with Oracle Restart. When required, Oracle Restart automatically starts the standby database. Default is no.
Examples
Example 1
The following command creates a standby database with the unique name “database1" generated from the backup of a primary single-instance database named “Database".
emcli create_standby
-source_db_target_name="database"
-source_db_target_type="oracle_database"
-dest_oracle_sid="database1"
-spname="database1"
Example 2
The following command creates a standby database with the unique name "database1" generated from the backup of a cluster database named "primary". The standby database uses SYSDBA credentials for monitoring and uses Data Guard broker to manage the Data Guard configuration.
emcli create_standby
-source_db_target_name="primary"
-source_db_target_type="rac_database"
-dest_oracle_sid="database1"
-spname="database1"
-use_broker="Yes"
-use_sys_dba_monitoring_creds="Yes"
Creates a standby database generated from a backup of a primary database.
Format
emcli create_standby_database
-source_db_target_name="<standby database target name>"
-source_db_target_type="oracle_database|rac_database"
-dest_oracle_sid="<standby instance name>"
-spname="<standby database unique name>"
[-source_db_creds_name="<primary database credential name>"]
[-source_host_creds_name="<primary database host credential name>"]
[-dest_host_creds_name="<standby database host credential name>"]
[-asm_inst_creds_name="<asm instance credential name>"]
[-dest_host_name="<standby host name>"]
[-dest_oracle_home="<standby database oracle home>"]
[-dest_target_name="<standby database target name>"]
[-use_duplicate=\"Yes|No\"]
[-source_staging_area="<primary staging directory>"]
[-storage_type="<storage type>"]
[-dest_db_database_area="<standby database files location>"]
[-dest_db_recovery_area="<standby database fast recovery area>"]
[-dest_listener_selection="<standby database listener selection>"]
[-dest_listener_name="<standby database listener name>"]
[-dest_listener_port="<standby database listener port>"]
[-stby_type="<standby type>"]
[-use_broker=\"Yes|No\"]
[-use_sys_dba_monitoring_creds]
[-dest_staging_area="<standby staging directory>"]
[-configure_with_oracle_restart]
Options
source_db_target_name
Primary database Enterprise Manager target name source. Can either be a single-instance database or a cluster database instance.
source_db_target_type
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
dest_oracle_sid
Standby database instance name.
spname
Standby database unique name.
source_db_creds_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
source_host_creds_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
dest_host_creds_name
Standby database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
asm_inst_creds_name
ASM instance named credential.
dest_host_name
Standby database host name. Default is primary host name.
dest_oracle_home
Standby database Oracle Home location. Default is primary database Oracle Home location.
dest_target_name
Standby database Enterprise Manager target name. Default is standby database unique name.
use_duplicate
Database files moved directly to clone the database host by the Recovery Manager(RMAN). Default is yes.
source_staging_area
Staging area used to store the backup of a primary database. This option is applicable only when use_duplicate is not set.
storage_type
Standby database storage type.
FILE_SYSTEM: Standby database files are in a regular file system.
ASM_STORAGE: Standby database uses Automatic Storage Management (ASM).
Default is FILE_SYSTEM.
dest_db_database_area
Standby database files Oracle-managed files (OMF) location. Can be a regular file system (if storage_type is FILE_SYSTEM) or an ASM diskgroup (if storage_type is ASM_STORAGE).
dest_db_recovery_area
Standby database fast recovery area.
dest_listener_selection
Standby database listener selection.
GRID_INFRA: Uses the Grid Infrastructure Home listener.
DEST_DB_HOME: Uses the listener from the standby database Oracle Home.
Default is GRID_INFRA.
dest_listener_name
Standby database listener name. This option is applicable only if dest_listener_selection is set to DEST_DB_HOME.
If not specified, default value is the first existing TCP listener found in the standby database Oracle Home. Note that if dest_listener_name is specified, then dest_listener_port must also be specified.
dest_listener_port
Standby database listener port. This option is applicable only if dest_listener_selection is set to DEST_DB_HOME. Note that if dest_listener_port is specified, then dest_listener_name must also be specified.
stby_type
Type of the standby database to be created.
PHYSICAL
LOGICAL
Default is PHYSICAL.
use_broker
Uses Data Guard broker to manage the Data Guard configuration. Default is yes.
use_sys_dba_monitoring_creds
Uses SYSDBA credentials to monitor the standby database. Default is no.
dest_staging_area
Staging area used to store the backup files transferred from the primary host. This option is applicable only when use_duplicate is not set.
configure_with_oracle_restart
If the destination host has Oracle Restart configured, it configures the standby database with Oracle Restart. When required, Oracle Restart automatically starts the standby database. Default is no.
Examples
Example 1
The following command creates a standby database with the unique name “database1" generated from the backup of a primary single-instance database named “Database".
emcli create_standby_database
-source_db_target_name="database"
-source_db_target_type="oracle_database"
-dest_oracle_sid="database1"
-spname="database1"
Example 2
The following command creates a standby database with the unique name "database1" generated from the backup of a cluster database named "primary". The standby database uses SYSDBA credentials for monitoring and uses Data Guard broker to manage the Data Guard configuration.
emcli create_standby_database
-source_db_target_name="primary"
-source_db_target_type="rac_database"
-dest_oracle_sid="database1"
-spname="database1"
-use_broker="Yes"
-use_sys_dba_monitoring_creds="Yes"
Creates an entity of the Directive type in the Software Library. On successful creation, the entity revision appears in the specified folder on the Software Library Home page.
Format
emcli create_swlib_directive_entity
-name="entity_name"
-folder_id="folder_id"
-arg="[<arg prefix>;]<arg prop name>[;<arg suffix>]"
[-shell_type]="<shell type>"
[-run_privileged]
[-file="<abs/relative file path>[;<new file name>]"
[-upload_storage="<storage location name>;<storage type>"] | [-refer_ storage="<storage location name>;<storage type>"]
[-credential_set_name="setname"] | [-credential_name="name" -credential_owner="owner"]
[-desc="entity_desc"]
[-attr="<attr name>:<attr value>"]
[-note="note text"]
[-show_entity_rev_guid]
[-show_cmd_line_and_exit]
[ ] indicates that the parameter is optional.
Parameters
name
Name of the entity.
folder_id
Folder ID where the entity is created. The Software Library Home page exposes the ID for folders and entities as a custom column (Internal ID). However, this is hidden by default.
arg
Command line argument property name, specified optionally with a prefix and/or a suffix. To specify multiple arguments, repeat the option.
shell_type
Shell type can be one of the following:
SUB_Exec - Specified in the script
SUB_PSUB_Bash - Basherl - Perl
Defaults to SUB_Perl.
run_privileged
This is an option to specify whether the directive should be executed with privileged credentials or not. This is executed with normal credentials by default.
file
If -upload_storage is specified, it is the absolute path of the file that is uploaded. If -refer_storage is specified, it is the relative path of the file that is referred from the storage location specified. File name stored in the Software Library after the file is upload is defaulted to the name of the file being uploaded/referred. A different file name can be specified, optionally, separated by ';'. The first file specified in the command line will be defaulted as the main file and will be executed when the directive is run.
host
Target name of the host where the files are available. This should be used in conjunction with the -upload_storage option.
credential_set_name
The set name of the preferred credential stored in the Management Repository for the host target. This can be one of the following:
HostCredsNormal - default unprivileged credential set
HostCredsPriv - privileged credential set
credential_name
Named credential stored in the Management Repository. This option must be specified along with the -credential_owner option. This must be used in conjunction with the -upload_storage option.
credential_owner
Owner of a named credential stored in the Management Repository. This option must be specified along with the -credential_name option. This must be used in conjunction with the -upload_storage option.
upload_storage
Destination storage location and type for the upload, separated by ';'. The location specified must be in the 'active' status. Defaulted to storage type and location of the first upload location configured for Software Library. The storage type can be one of the following:
OmsShared (OMS Shared File System)
OmsAgent (OMS Agent File System)
refer_storage
Storage location and type for referring to files, separated by ';'. The location specified must be in the 'active' status. The storage type can be one of the following:
http
NFS
ExtAgent
If specified, this option takes precedence over -upload_storage option.
desc
Description of the entity. The new description is visible to all existing revisions.
attr
Attribute and its value is separated by ':'. To specify multiple attributes, repeat the option.
note
A note about the entity. Repeat the option for multiple notes.
show_entity_rev_guid
Option to enable printing of the internal GUID of the new entity revision or not.
show_cmd_line_and_exit
Option to enable printing of the command line and exiting without creating a new entity revision or not.
Examples
Example 1
The following example creates a directive entity named 'myAcmeInstall' in the specified folder. The directive has one argument with a '-home' prefix and the argument value is of the 'oh_home' property. It has two script files associated with it, the first one is defaulted as the main file. The main file is executed when the directive is executed. Also, the mymodule.pm file content is saved by the name 'common.pm'. The files are accessible locally by the emcli process owner. The folder ID value can be found on the Software Library Home page. The Software Library Home page exposes the ID for folders and entities as a custom column (Internal ID). However, this is hidden by default.
emcli create_swlib_directive_entity
-name="myAcmeInstall"
-folder_ id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
-arg="-home :oh_home"
-shell_type=SUB_Perl
-file=/u01/scripts/myscript.pl
-file=/u01/scripts/mymodule.pm;common.pm
Example 2
The following example creates a directive entity named 'myAcmeInstall' in the specified folder. The directive has one argument with a '-home' prefix and the argument value is of the 'oh_home' property. It has two script files associated with it, the first one is defaulted as the main file. The main file is executed when the directive is executed. Also, the mymodule.pm file content is saved by the name 'common.pm'. The files are retrieved from the host 'fs1.us.acme.com' using the credential identified as 'MyAcmeCreds' owned by 'ACME_USER'. The folder ID value can be found on the Software Library Home page. The Software Library Home page exposes the ID for folders and entities as a custom column (Internal ID). However, this is hidden by default.
emcli create_swlib_directive_entity
-name="myAcmeInstall"
-folder_id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"id="oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
-arg="-home :oh_home"
-shell_type=SUB_Perl
-file=/u01/scripts/myscript.pl
-file=/u01/scripts/mymodule.pm;common.pm
-host="fs1.us.acme.com"
-credential_name="MyAcmeCreds"
-credential_owner="ACME_USER
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
Options
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
This example creates an entity named 'myAcmeInstall' under the specified folder. The entity is of type 'Component' and subtype 'Generic Component, by default. The folder identifier value can be found on the software library home page. The software library home page exposes the identifier for folders and entities as a custom column (Internal ID), and is hidden by default.
emcli create_swlib_entity
-name="myAcmeInstall"
-folder_id=
"oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
Example 2
This example creates an entity named 'myAcmeInstall' under the specified folder with the specified description. The entity is of type 'Component' and subtype 'Generic Component' by default. Values for the entity attributes, viz. PRODUCT, PRODUCT_VERSION and VENDOR, are specified. The value for the configuration property named DEFAULT_HOME is specified. A note on the entity is also specified. The identifier of the newly created entity revision is printed on the standard output.
emcli create_swlib_entity
-name="myAcmeInstall"
-folder_id=
"oracle:defaultService:em:provisioning:1:cat:B13B3B7B086458CFE040E80A19AA560C"
-desc="myAcmeInstall description"
-attr="PRODUCT:Acme"
-attr="PRODUCT_VERSION:3.0"
-attr="VENDOR:Acme Corp"
-prop="DEFAULT_HOME:/u01/acme3/"
-note="myAcmeInstall for test servers"
Creates a folder in the software library.
Format
emcli create_swlib_folder
-name="folder_name"
-parent_id="parent_folder_id"
[-desc="folder_description"]
[ ] indicates that the parameter is optionalis optional
Options
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
This 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"
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.
A database system contains a primary database and related targets such as Listener and Automatic Storage Management. It also includes standby databases and their related targets if the database is in a Data Guard configuration. Database systems cannot be created for standby databases.
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
Options
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.
Output
Success / Error. If you attempt to create a standby database, you will receive the following message:
Operation not supported for given system type.
Examples
Example 1
This example creates a generic system named db_system and supports backward compatibility. This system consists of two Oracle databases: emp_rec and payroll. The owner of this system is user1. The meta version of the system type is 3.0.
emcli create_system -name=db_system
-add_members="emp_rec:oracle_database"
-add_members="payroll:oracle_database"
-timezone_region="PST8PDT"
-owner="user1"
Example 2
This example creates a generic system named db_system1. This system consists of two Oracle databases: emp_rec and payroll. emp_rec is a key member for the system. The availability calculation method is if ANY of the key members is up, the system is up. The meta version of the system type is 3.0. This example shows the recommended method for creating a system.
emcli create_system -name=db_system1
-add_members="emp_rec$oracle_database$key_member"
-add_members="payroll$oracle_database"
-subseparator=add_members="$"
-timezone_region="PST8PDT"
-availability_type="ANY"
Creates a new tenant in Enterprise Manager.
Format
Standard Mode
emcli create_tenant
-name="name"
-description="description"
-owner_name="owner_name"
[-owner_password="owner_password"]
[-owner_type="owner_type"]
[-namespace="namespace"]
[ ] indicates that the parameter is optional
Interactive or Script Mode
emcli create_tenant(
name="name"
,description="description"
,owner_name="owner_name"
[,owner_password="owner_password"]
[,owner_type="owner_type"]
[,namespace="namespace"]
)
[ ] indicates that the parameter is optional
Options
name
The name of the tenant.
description
Description of the tenant.
owner_name
The tenant owner name.
owner_type
The type of owner. EM_USER is the default owner type. Other possible values are EM_USER and EXTERNAL_USER.
namespace
The namespace for the tenant.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example creates a tenant by name my_tenant with john_doe as the tenant owner.
emcli create_tenant
-name=my_tenant
-description="This is the tenant description."
-owner_name=john.doe
-owner_password=pw
-owner_type=EM_USER
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
Options
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 -input_file Syntax Guidelines.
template
Name of the monitoring template to update. You can specify multiple values.
input_file=templateList
Specify a file name that contains a list of templates, one name per line.
For more information about the input_file parameter, see -input_file Syntax Guidelines.
allUdms
Forces the session to contain all UDMs from targets and templates. (The default behavior just selects those not in a session.)
Examples
Example 1
This example creates a new session named hostsession that migrates the UDM hostudm on the target testhost.
emcli create_udmmig_session
-name=hostsession -desc="Convert UDMs for Host Target"
-udm_choice=hostudm -target=host:testhost
Example 2
This example creates a new session named hostsession that migrates all the unconverted UDMs on the target testhost that are not in a session.
emcli create_udmmig_session
-name=hostsession -desc="Convert UDMs for Host Target"
-target=host:testhost -allUdms
Creates a new Enterprise Manager administrator.
Standard Mode
emcli create_user
-name="name"[-password="password"][-type="type of user"]
[-roles="role1;role2;..."]
{-email="email1;email2;..."]
[-privilege="name[;secure-resource-details]]"]
[-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"]
[-external_user_id="external_user_id"]
[-tenant="tenant"]
[-like="like"]
[-input_file="FILE:file_path"]
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
[ ] indicates that the parameter is optional
Interactive or Script Mode
create_user(
name="name"
[,password="password"]
[,type="type of user"]
[,roles="role1;role2;..."]
[,email="email1;email2;..."]
[,privilege="name[;secure-resource-details]]"]
[,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"]
[,external_user_id="external_user_id"]
[,tenant="tenant"]
[,like="like"]
[,input_file="FILE:file_path"]
[,separator="separator:attribute_name:character"]
[,subseparator="subseparator:attribute_name:character"] )
[ ] indicates that the parameter is optional
Options
name
Administrator name.
password
Administrator password.
type
Type of user. The default value of this option is EM_USER. Possible values for this option are:
EM_USER
EXTERNAL_USER
DB_EXTERNAL_USER
roles
List of roles to grant to this administrator. Currently, the built-in roles include PUBLIC.
List of e-mail addresses for this administrator.
privilege
Privilege to grant to this administrator. You can specify this option more than once. 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, which do not require resource information, execute the following emcli command:
emcli get_supported_privileges -type=SYSTEM
To retrieve the complete list of privileges and resource column names, execute the following command:
emcli get_supported_privileges
To retrieve the list of TARGET privileges, execute the following emcli command:
emcli retrieve -type=TARGET
To retrieve the list of job privileges, execute the following emcli command:
emcli get_supported_privileges -type=JOB
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
Valid values are true or false. 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.
external_user_id
External user ID of the administrator..
tenant
Tenant name of the administrator.
like
Create like another user.
input_file
Reads the contents of a file and passes as property value.
For more information about the input_file parameter, see -input_file Syntax Guidelines.
separator
By default, multi-value input attributes use a semicolon ( ; ) as a separator. Specifying this option overrides the default separator value.
Example: separator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new separator character.Example: separator="att=#"
subseparator
By default, multi-value input attributes use a colon ( : ) as a subseparator. Specifying this option overrides the default subseparator value.
Example: subseparator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new subseparator character.Example: separator="att=#"
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Examples
These examples create an Enterprise Manager administrator named new_admin. This administrator has two privileges: the ability to view the job with ID 923470234ABCDFE23018494753091111 and the ability to view the target host1.example.com:host. The administrator new_admin is granted the PUBLIC role.
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")
These examples make User1 an Enterprise Manager user, which is already created on an external user store like the SSO server. The contents of priv_file are view_target;host1.example.com:host . User1 will have view privileges on the host1.example.com:host target.
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")
Creates a user profile.
Format
Standard Mode
emcli create_user_profile
-name="profile name"
[-description="profile desc"]
[-users="users to be associated"]
[ ] indicates that the parameter is optional
Interactive or Script Mode
create_user_profile(
name="profile name"
[,description="profile desc"]
[,users="users to be associated"]
)
[ ] indicates that the parameter is optional
Options
name
The name of the user profile to be created.
description
Description of the user profile to be created.
users
The names of the users with whom the user profile is to be associated.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example creates a new user profile by name profile1.
emcli create_user_profile
-name="profile1"
-description=test profile
-users=user1;user2
Transfers data from source to target.
Format
emcli data_transfer -inputFile="File containing properties required for transferring data"
Options
inputFile
Location of file containing properties required for transferring data. The mandatory properties required for this job are:
SOURCE_LOCATION = Location of the data at the source host.
SRC_HOST = Source host containing the data.
SRC_HOST_CREDS = Credentials for the host on which the data is located. If the source host is on OPC, this should be Host SSH Credentials.
DEST_HOST = Destination host where the data should be copied to.
DEST_HOST_CREDS = Credentials for the host where the data will be copied to. If the destination host is on OPC, this should be Host SSH Credentials.
DEST_LOCATION = Location on the destination host where the data should be copied.
Example
The following example transfers data from the source to the target contained in the data_transfer.props file:
emcli data_transfer
-input_file=data:/u01/files/data_transfer.props
Format
Verb for database clone life cycle mangement.
emcli db_clone_management -createFullClone -createTestMaster -createCloneDB -createSnapClone -createSnapshotClone -cloneToCloud -enableTestMaster -disableTestMaster -refreshDatabase -deleteDatabase -listClones -listTestMasters -listDatabaseBackups -listDatabaseSnapshots [-target_name="database target name" -target_type="database target type" -clone_type="clone_type" -input_file="path of input file" -print_properties="print properties for input file"]
[ ] indicates an optional parameter.
Options
-createFullClone
Create a full clone database.
-createTestMaster
Create a Test Master database.
-CreateCloneDB
Create a CloneDB database.
-createSnapClone
Create a Snap Clone database.
-createSnapshotClone
Create an Exadata Sparse Clone database.
-cloneToCloud
Clone a database to Oracle Cloud
-enableTestMaster
Enable a database as Test Master.
-refreshDatabase
Refresh a database from its source.
-deleteDatabase
Delete a database and remove the target from Enterprise Manager.
-listClones
List the clones of a database.
-listTestMasters
List Test Master databases.
-listDatabaseBackups
List RMAN backup and image profiles of a database.
-listDatabaseSnapshots
List Snapshot Profiles of a database.
-target_name
Name of the database target. This mandates the presence of -target_type.
-target_type
oracle_database for a Single Instance database.
rac_database for a RAC database.
-clone_type
LIVE to perform a live clone
POINT_IN_TIME to perform a prior point in time clone.
-input_file
Path of the file containing input properties.
-print_properties
Print the input properties required for database clone procedures. This mandates the presence of -target_name and -target_type.
-usage
Option to show detailed usage of the verb.
Example 5-2 Example Title
(Optional) Enter an example to illustrate your reference here.
Performs database Cloud maintenance tasks.
db_cloud_maintenance -activateSoftware
Activates the new software of the pool.
Format
emcli db_cloud_maintenance -activateSoftware
-pool_name= "pool_name"
-pool_type= "pool_type" l
[-force= "force" ]
[ ] indicates that the parameter is optional.
Options
pool_name
The name of the pool.
pool_type
The type of the pool.
force
Forcibly activates new members.
Example
The following example forcibly activates new members and activates new software for the Oracle Cloud Zone pool with the name POOL.
emcli db_cloud_maintenance -activateSoftware
-pool_name=POOL
-pool_type=oracle_cloud_zone
-force=true
db_cloud_maintenance -performOperation
Performs a named operation on a specified pool.
Format
emcli db_cloud_maintenance -performOperation
-name= "name"
-description= "description"
-purpose= "purpose"
-pool_name= "pool_name"
-pool_type= "pool_type"
[-start_schedule= "start_schedule"]
[-end_schedule= "end_schedule" ]
[-input_file= "data:input_file" ]
[-target_type= "target_type" ]
[-target_list= "target_list" ]
[ ] indicates that the parameter is optional.
Options
name
The name of the operation.
description
The description of the operation.
purpose
The purpose of the operation. The possible values are: UPDATE_DB, UPDATE_RACDB, UPDATE_GI, DEPLOY_DB_SOFTWARE, DEPLOY_GI_SOFTWARE, DEPLOY_RAC_SOFTWARE, ROLLBACK_DB, ROLLBACK_GI, ROLLBACK_RACDB, and CLEANUP_SOFTWARE.
pool_name
The name of the pool.
pool_type
The type of the pool.
start_schedule
The scheduled start time. The format for start_schedule is yyyy-MM-dd HH:mm:ss, for example start_schedule="2013-11-11 12:15:30". The default start time is immediate.
end_schedule
The scheduled end time. The format for end_schedule is yyyy-MM-dd HH:mm:ss, for example end_schedule="2014-11-11 22:30:00". The default end time is indefinite.
input_file
Input data for the maintenance action, for example input_file="data:~/input_files/data.
For more information about the input_file parameter, see -input_file Syntax Guidelines.
target_type
The default target type is identified based on the purpose. For example, if the purpose is DEPLOY_DB, then the default target type becomes oracle_home.
target_list
A comma separated list of targets. The target list is the list of entities based on the target type that is selected. For example, if target_type=rac_database target_list,then the target list is "rac1.example.com,rac2.example.com". The default target_list is based on the purpose. For example if the purpose is DEPLOY_DB, the default target list becomes the list of Oracle homes present in the pool.
Example
The following example performs the Update RAC Database operation for the Oracle Cloud Zone pool with the name POOL.
emcli -performOperation
-name="Update RAC Database "
-description="Update RAC database Instance"
-purpose="UPDATE_RACDB"
-start_schedule="start_time:2014/09/01 00:00"
-end_schedule="start_time:2014/09/01 13:00"
-pool_name="POOL NAME"
-pool_type=oracle_cloud_zone
-target_type=rac_database
-target_list="rac1.example.com"
Performs database software maintenance tasks.
db_software_maintenance -createSoftwareImage
Creates a new software image for the specified the Oracle home. The createSoftwareImage verb either takes data from a text file or uses the getInputVariableList command.
Format
emcli db_software_maintenance -createSoftwareImage
[-data= "data"] [-getInputVariableList= "getInputVariableList"]
[ ] indicates that the parameter is optional.
Options
data
The path of the txt input file.
getInputVariableList
Provides the list of variables to be specified in the input file.
Example 1
To get the list of all of the parameters to be passed inside the data file, run the following command:
emcli db_software_maintenance -createSoftwareImage
-getInputVariableList=true
Example 2
The following example creates a new image and a version.
emcli db_software_maintenance -createSoftwareImage
-data="input_file=data:"/home/user/input_rac"
In this example, the contents of the input_rac file are:
IMAGE_NAME=DbGoldImage
IMAGE_DESCRIPTION=Gold Image for 11g db
REF_TARGET_NAME=ORACLE_HOME
IMAGE_SWLIB_LOC=Oracle Home Provisioning Profiles/11.2.0.3.0/linux_x64
REF_HOST_CREDENTIALS=ZONE_CREDS:TESTSUPERADMIN
WORKING_DIRECTORY=/tmp
STORAGE_TYPE_FOR_SWLIB=OmsShared
STORAGE_NAME_FOR_SWLIB=swlib
VERSION_NAME=Version1
db_software_maintenance -createImage
Creates a new image.
Format
emcli db_software_maintenance -createImage
-image_name= "image_name"
-description= "description"
-type= "type"
-target_type= "target_type"
-version= "version"
-platform_id= "platform_id"
-status= "status"
Options
image_name
The name of the image.
description
The description of the image.
type
The type of the image, for example SWLIB if the image version will be in the Software Library.
target_type
The target type of the image. For example, if the image is being created to manage single instance Oracle Database then the target type is 'oracle_database.
version
The RDBMS version of the product, for example 11.2.0.4.0.
platform_id
The platform id, for example 226 for Linux x86_64.
status
The image status, for example PRODUCTION.
Example
The following example creates a new image with the name GI_11204.
emcli db_software_maintenance -createImage
-image_name="GI_11204"
-description="GI_11204"
-type="SWLIB"
-target_type=cluster -version=11.2.0.4.0
-platform_id=226 -status=PRODUCTION
db_software_maintenance -createVersion
Creates a new version in an existing image using an existing software library component.
Format
emcli db_software_maintenance -updateVersionStatus
-version_name= "version_name"
-image_id= "image_id"
-external_id= "external_id"
-status= "status"
Options
version_name
The name of the version.
image_id
The ID of the image.
external_id
The external ID of the version. For example, it will be the Uniform Resource Name (URN) of the Software Library gold image.
status
The status of the version, for example DRAFT, ACTIVE, CURRENT, RESTRICTED.
Example
The following example creates a version, Version1.
emcli db_software_maintenance -createVersion
-version_name="Version1"
-image_id="01B5F14FD57D7B89E05313B2F00A739F"
-external_id="oracle:defaultService:em:provisioning:1:cmp:COMP
Component:SUB_OracleDB:0191172464DD36B6E05313B2F00AB90A:0.1"
-status=CURRENT
db_software_maintenance -subscribeTarget
Creates new target or modifies the target subscription.
Format
emcli db_software_maintenance -subscribeTarget
-target_name= "target_name"
-target_type= "target_type"
-[parent_target_name= "parent_target_name"]
-[parent_target_type= "parent_target_type"]
-image_id= "image_id"
-[version_id= "version_id'
[ ] indicates that the parameter is optional.
Options
target_name
The name of the target.
target_type
The target type.
parent_target_name
The parent target name.
parent_target_type
The parent target type.
image_id
The image id.
version_id
The version id.
Example
The following example modifies the Oracle Cloud Zone target with the name POOL NAME.
emcli db_software_maintenance -subscribeTarget
-target_name="POOL NAME"
-target_type=oracle_cloud_zone
-image_id=FE55AD7AB28974EFE04313B2F00AD4A0
db_software_maintenance -updateVersionStatus
Updates the version status of the image.
Format
emcli db_software_maintenance -updateVersionStatus
[-version_id= "version_id"] -status= "status"
[ ] indicates that the parameter is optional.
Options
version_id
The version id.
status
The status of the version, for example DRAFT, ACTIVE, CURRENT, RESTRICTED.
Example
The following example updates the version of the image with the version ID 02A635AOD8D904A4E05362F3E40ADFD8 to CURRENT.
emcli db_software_maintenance -updateVersionStatus
-version_id=02A635AOD8D904A4E05362F3E40ADFD8
-status=CURRENT
db_software_maintenance -getImages
Returns the list of images present in system.
Format
emcli db_software_maintenance -getImages
Example
The following example returns a list of images present in system.
emcli db_software_maintenance -getImages
db_software_maintenance -deleteImage
Deletes an image.
Format
emcli db_software_maintenance -deleteImage
-image_id= "image_id" [-force= "force"]
[ ] indicates that the parameter is optional.
Options
image_id
The ID of the image to be deleted.
force
Deletes forcibly even if the image has subscribed targets.
Example
The following example deletes the image with the ID 01B5F14FD57D7B89E05313B2F00A739F.
emcli db_software_maintenance -deleteImage
-image_id="01B5F14FD57D7B89E05313B2F00A739F
db_software_maintenance -unsubscribeTarget
Unsubscribes the specified target.
Format
emcli db_software_maintenance -subscribeTarget
-target_name= "target_name"
-target_type= "target_type"
-image_id= "image_id"
[-version_id= "version_id']
[ ] indicates that the parameter is optional.
Options
target_name
The name of the target.
target_type
The target type.
image_id
The image id.
Example
The following example unsubscribes the Oracle Cloud Zone target with the name POOL NAME and the image ID FE55AD7AB28974EFE04313B2F00AD4A0.
emcli db_software_maintenance -unsubscribeTarget
-target_name="POOL NAME"
-target_type=oracle_cloud_zone
-image_id=FE55AD7AB28974EFE04313B2F00AD4A0
db_software_maintenance -searchImage
Searches the image based on the filters provided. Use '%' for wildcards.
Format
emcli db_software_maintenance -searchImage
[-name_pattern= "name_pattern"]
[-version_pattern= "version_pattern"]
[-description_pattern= "description_pattern"]
[-owner= "owner"]
[-target_type= "target_type"]
[-platform_id= "platform_id"]
[ ] indicates that the parameter is optional.
Options
name_pattern
The name pattern.
version_pattern
The version pattern.
description_pattern
The description pattern.
version_pattern
The version pattern.
target_type
The target type.
platform_id
The platform id, for example 226 for Linux x86_64.
Example 1
The following example searches the database image for names that contain GI.
emcli db_software_maintenance -searchImage
-name_pattern="%GI%"
Example 2
The following example searches the database image for the Linux x86_64 platform (platform id 226).
emcli db_software_maintenance -searchImage
-platform_id="226"
db_software_maintenance -getTargetSubscriptions
Returns a list of subscriptions for the specified target.
Format
emcli db_software_maintenance -getTargetSubscriptions
-target_name= "target_name" Target name
-target_type= "target_type" Target type
[-image_type= "image_type" Image type]
[ ] indicates that the parameter is optional.
Options
target_name
The name of the target.
target_type
The target type.
image_type
The image type.
Example
The following example returns a list of subscriptions for the Oracle Cloud Zone target with the name POOL NAME.
emcli db_software_maintenance -getTargetSubscriptions
-target_name="POOL NAME"
-target_type="oracle_cloud_zone"
db_software_maintenance -getVersions
Returns a list of the versions for the specified image.
Format
emcli db_software_maintenance -getVersions
-image_id= "image_id"
[-version_status= "version_status"]
[ ] indicates that the parameter is optional.
Options
image_id
The name of the image.
version_status
The status filter for the version.
Example
The following example returns a list of versions for the image with theID 01B5F14FD57D7B89E05313B2F00A739F.
emcli db_software_maintenance -getVersions
-image_id="01B5F14FD57D7B89E05313B2F00A739F"
-version_status=CURRENT
db_software_maintenance -getImageSubscriptions
Returns the list of subscribed targets.
Format
emcli db_software_maintenance -getImageSubscriptions
-image_id= "image_id"
Options
image_id
The ID of the image.
Example
The following example returns a list of targets for the image with the ID ID01B5F14FD57D7B89E05313B2F00A739F.
emcli db_software_maintenance -getImageSubscriptions
-image_id="01B5F14FD57D7B89E05313B2F00A739F"
db_software_maintenance -performOperation
Creates a new database software maintenance operation. The subcommand –performOperation is further divided into different set of commands. The available commands are mentioned in details as follows:
-performOperation –Deploy
The deploy command automatically uses the current version of the subscribed image while creating the new Oracle Home.
emcli db_software_maintenance -performOperation -name="Deploy
-1120407 GI Home" -purpose=DEPLOY_GI_SOFTWARE
-target_type=input_file -target_list="CLUSTER1"
-normal_credential="NC_HOST_CREDS:TESTSUPERADMIN"
-privilege_credential="HOST_PRIV:TESTSUPERADMIN"
-inputfile="data:/usr/oracle/deploy.txt"
Options
name
This is the unique name of the operation.
purpose
DEPLOY_DB_SOFTWARE
DEPLOY_GI_SOFTWARE
traget_type
The type of target on which this operation is being performed.
target_list
This is a comma separated list of targets that need to be patched.
normal_credential
This must be entered in the format <Named Credential: Credential Owner> where:
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
privilege_credential
This must be entered in the format <Named Credential: Credential Owner> where:
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
These credentials are used to run scripts as root.
start_schedule
The date on which the stage and deploy is to be started if it is to be started in the future.
Format: "start_time:yyyy/mm/dd HH:mm"
Note:
This is an optional parameter. If no date is provided, the fleet operation will start immediately.Input_file
This file contains the following entries:
NEW_ORACLE_HOME_LIST= <path of new Oracle home>
This is the location where the new Oracle Home will be installed on all the hosts. The Credential Owner must have read / write access to this location.
workingDir=<Name of temp directory>
dispatchLoc=<Dispatch location>
This is the location where all scripts will be staged on the host. These scripts will be executed as a “root” user.
SKIP_PREREQUISITE_CHECKS=<true|false>- The default value is false.
SKIP_CVU_CHECK=<true|false>- The default value is false.
PREREQS_ONLY=<true|false>- The default value is false. This can be used to detect any errors during pre-requisites checks. The actual deployment will not happen when the value is set to “true”.
Note:
This verb submits a procedure which must be completed before you can proceed with the next steps.Example
Deploy Container Databases:
emcli db_software_maintenance -performOperation -purpose="DEPLOY_CDB" -target_name="<>CDB Name that is being patched" -target_type="<target type> -name="Operation Name” -description="Operation description" -db_prefix | db_name ="<DB Name prefix or DB name>" –normal_credential="<credential name>" –privilege_credential="<credential name>" –database_credential="SYSDBA credential name>"
If you are using existing container:
emcli db_software_maintenance -performOperation -purpose="ATTACH_CDB"-target_name="<CDB Name that is being patched>" -target_type="<target type>" -name="Operation Name” -description="Operation description" -destinationCDB ="<Container database to which PDBs will be migrated>" –normal_credential="<credential name>" –privilege_credential=”<credential name>" –database_credential="<SYSDBA credential name>"
-performOperation –Update
The Update command is further used for different set of actions as follows:
Migrating the Listeners
If there are listeners running from the database home, use the following verb to migrate them to the parallel Oracle Home, you can use this command to migrate the listeners running from Oracle database homes. Grid Infrastructure homes are automatically migrated during the GI update process.
Format
emcli db_software_maintenance -performOperation -name="Update
Listener" -purpose=migrate_listener -target_type=oracle_database
-target_list="DB1" -normal_credential="NC_HOST_CREDS:SYSMAN"
-privilege_credential="HOST PRIV:SYSMAN" start_schedule
Options
name
This is the unique name of the operation.
purpose
MIGRATE_LISTENER
traget_type
The type of target on which this operation is being performed. This can be "rac_database" for RAC and "oracle_database" for single instance databases.
target_list
This is a comma separated list of targets which are to be migrated.
normal_credential
This must be entered in the format <Named Credential: Credential Owner> where:
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
privilege_credential
This must be entered in the format <Named Credential: Credential Owner> where:
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
These credentials are used to run scripts as root.
start_schedule
The date on which the stage and deploy is to be started if it is to be started in the future.
Format: "start_time:yyyy/mm/dd HH:mm"
Note:
This is an optional parameter. If no date is provided, the fleet operation will start immediately.Updating the Database / Cluster
After the stage and deploy operations are completed, the grid infrastructure instances should be migrated to the newly deployed Grid Infrastructure Homes.
Format
emcli db_software_maintenance -performOperation -name="Update Cluster" -purpose=UPDATE_GI -target_type=cluster -target_list= CLUSTER1 -normal_credential="NC_HOST_CREDS:SYSMAN" privilege_credential="HOST PRIV:SYSMAN" [-rolling=<true/false]
Options
name
This is the unique name of the operation.
purpose
There are standard purposes that can be performed by Fleet Operations which can be:
UPDATE_DB for single instance and SIHA
UPDATE_RACDB for RAC database and RAC one-node
UPDATE_GI for cluster
target_type
The type of target being provided in this operation which can "rac_database" or "single instance" database.
target_list
This is a comma separated list of targets which need to be patched.
Targets of homogenous types are supported in a single fleet operation.
normal_credential
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
privilege_credential
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
These credentials are used to run scripts as root.
rolling
This is an optional flag with the default value as true. The update procedure works in "Rolling Patch" mode by default but you can override this if necessary.
start_schedule
The date on which the stage and deploy is to be started if it is to be started in the future.
Format: "start_time:yyyy/mm/dd HH:mm"
Note:
This is an optional parameter. If no date is provided, the fleet operation will start immediately.input_file
This is an optional parameter. The parameters that can be specified here is : workingDir: = <Name of temp directory>
Node Wise RAC Database / Cluster Update
A cluster update always requires that all the RAC database instances running on that node be shut down during the switch process of the cluster instance. Hence, a cluster update followed by a RAC database updates results in an instance getting restarted twice.
There may be several situations where the administrator may require more control over the switch process. For example, the administrator may choose to perform a node-wise update of the cluster and RAC databases in order to avoid multiple restarts of the database instances. The administrator may also need to perform node specific pre-post steps.
Switch the cluster instance.
Leave the RAC database instances shutdown.
emcli db_software_maintenance -performOperation -name="Update
Cluster" -purpose=UPDATE_GI -target_type=cluster -
target_list= CLUSTER1 -
normal_credential="NC_HOST_CREDS:SYSMAN" -
privilege_credential="HOST_PRIV:SYSMAN" - rolling=true -
node_list="host1.us.oracle.com" –startupDatabase=false
Switch all the RAC database instances on the same node.
This step will switch the instances RACDB_112_1 and RACDB_121_1 to the new home and will restart the same.
For example, consider RAC databases RACDB_112 and RACDB_121 are running on this cluster. The instances RACDB_112_1 and RACDB_121_1 running on this specific node will continue to remain shut down after the cluster instance is switched.
Format
emcli db_software_maintenance -performOperation -name="Update
RAC DB" -purpose=UPDATE_RACDB -target_type=rac_database -
target_list= RACDB -normal_credential="NC_HOST_CREDS:SYSMAN" -
privilege_credential="HOST_PRIV:SYSMAN" -rolling=true -
node_list="host1.us.oracle.com"
Options
name
This is the unique name of the operation.
purpose
There are standard purposes that can be performed by Fleet Operations which can be:
UPDATE_DB for single instance and SIHA
UPDATE_RACDB for RAC database and RAC one-node
UPDATE_GI for cluster
target_type
The type of target being provided in this operation which can "rac_database" or "single instance" database.
target_list
This is a comma separated list of targets which need to be patched.
Targets of homogenous types are supported in a single fleet operation.
A unique list of hosts based on this target list is displayed and start stage of Oracle Home software on those hosts.
If targets running from the same Oracle home are provided in this list, the stage and deploy operation will be launched only once and not for all targets.
normal_credential
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
privilege_credential
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
These credentials are used to run scripts as root.
node_list
This is a comma separated list of hosts on which the instances need to be updated.
Note:
This is an optional parameter. If no date is provided, the fleet operation will start immediately.-performOperation –Rollback
This command is used to switch the database back to the previous Oracle home after the Update operation has been completed.
Format
emcli db_software_maintenance -performOperation -name="Rollback
RAC DB" -purpose=ROLLBACK_RACDB -target_type=rac_database -
target_list= RACDB -normal_credential="NC_HOST_CREDS:SYSMAN" -
privilege_credential="HOST_PRIV:SYSMAN" [-rolling=true/false]
[-node_list="host1.us.oracle.com"]
Options
name
This is the unique name of the operation.
purpose
There are standard purposes that can be performed by Fleet Operations which cane be:
ROLLBACK_DB
ROLLBACK_RACDB
ROLLBACK_GI
target_type
The type of target being provided in this operation which can "rac_database" or "oracle_database”.
target_list
This is a comma separated list of targets which need to be patched.
Targets of homogenous types are supported in a single fleet operation.
A unique list of hosts based on this target list is displayed and start stage of Oracle home software on those hosts.
If targets running from the same Oracle home are provided in this list, the stage and deploy operation will be started only once and not for all targets.
normal_credential
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
<Named Credential>: Named credential for the host where new Oracle home will be deployed.
<Credential Owner>: The Enterprise Manager user who owns this Named Credential.
These credentials are used to run scripts as root.
non_rolling
By default, rollback is performed on all nodes. If the non_rolling back flag is enabled, you can select the list of nodes (using the node_list command) that are to be rolled back.
rolling
By default rollback is performed in rolling fashion. This flag is used when the current Oracle home has patches that were applied in non-rolling mode (OJVM) and need to be rolled back.
node_list
This is a comma separated list of hosts on which the instances need to be updated.
For example: If RACDB is running on a 4 node cluster host1, host2, host3, and host4 and you choose to update the instances in only 2 hosts at a time, the value of this parameter needs to be specified as node_list="host1, host2".
db_software_maintenance -getSubscriptionsForContainer
Returns the subscriptions for the container target, for example database pool.
Format
emcli db_software_maintenance -getSubscriptionsForContainer
-image_id= "image_id"
-target_name= "target_name"
-target_type= "target_type"
Options
image_id
The image id.
target_name
The name of the target in Oracle Enterprise Manager.
target_type
The target type.
Example
The following example returns the subscriptions for the Oracle Cloud Zone target with the name POOL NAME and the image ID FE55AD7AB28974EFE04313B2F00AD4A0.
emcli db_software_maintenance -getSubscriptionsForContainer
-target_name="POOL NAME"
-target_type=oracle_cloud_zone
-image_id=FE55AD7AB28974EFE04313B2F00AD4A0
Imports data from export dumps to the database target specified.
Format
emcli dbimport -inputFile="File containing properties for importing data to a database"
Options
inputFile
Location of the file containing properties required for importing data to the database.
Example
The following example imports data from export dumps to the database target specified in the dbimport.props file:
emcli dbimport
-inputFile=/u01/files/dbimport.props
Deactivates the specified MDA finding types. A finding type can have status 'N' (new), 'A' (active), or 'I' (inactive). Only those finding types that are currently active, for example, status 'A', will be deactivated. For others the previous status is retained. Once deactivated, no new targets will be enabled for the finding type, nor will analysis runs be scheduled for the inactive finding type.
Format
emcli deactivate_mda_finding_types [-finding_types="<list of finding types>"] [-separator=finding_types="separator_for_finding_types_values"] [ ] indicates that the parameter is optional.
Options
finding_types
List of finding types. The default separator to be used is ';'.
separator=finding_types
Indicates the custom separator used for the list of finding types. This option is mandatory if any other character apart from ‘;' is used as a separator in the finding types list.
Examples
Example 1
The following example deactivates a single finding type:
emcli deactivate_mda_finding_types
-finding_types="oracle.sysman.emas.wls_gc_overhead"
Example 2
The following example deactivates multiple finding types:
emcli deactivate_mda_finding_types
-finding_types="oracle.sysman.emas.wls_gc_overhead;oracle.sysman.emas.wls_heap_config"
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
Options
target_type
Type of target.
exclude_name
Name to use for the exclusion.
excl_group
Group of diagchecks to exclude.
excl_check
Name of diagcheck to exclude.
input_file
For information about the input_file parameter, see -input_file Syntax Guidelines.
Deletes target association instances.
Format
Standard Mode
emcli delete_assoc
-assoc_type="association type"
-source="target_name:target_type"
-dest="target_name1:target_type1[;target_name2:target_type2..]"
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
Interactive (Script) Mode
delete_assoc(
assoc_type="association type"
,source="target_name:target_type"
,dest="target_name1:target_type1[;target_name2:target_type2..]"
[,separator="separator:attribute_name:character"
[,subseparator="subseparator:attribute_name:character"] )
[ ] indicates that the parameter is optional.
Options
assoc_type
Association type.
source
Target name and target type of the source target.
dest
Target name and target type of the destination targets.
separator
By default, multi-value input attributes use a semicolon ( ; ) as a separator. Specifying this option overrides the default separator value.
Example: separator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new separator character.Example: separator="att=#"
subseparator
By default, multi-value input attributes use a colon ( : ) as a subseparator. Specifying this option overrides the default subseparator value.
Example: subseparator="<attribute_name=sep_char>" where attribute_name is name of the attribute for which you want to override the separator character, and sep_char is the new subseparator character.Example: separator="att=#"
Exit Codes
0 indicates that the verb processing was successful.
Non-zero values indicate that the verb processing was not successful.
Example
This example deletes associations of type cluster_contains from target "abc_cluster:cluster" to targets "def.oracle.com:host" and "ghi.oracle.com:host":
emcli delete_assoc
-assoc_type="cluster_contains"
-source="abc_cluster:cluster"
-dest="def.oracle.com:host;ghi.oracle.com:host"
Deletes the specified Hadoop cluster target and all its children. If this is the last cluster in the BDA target, also deletes the BDA target and all its children.
If Hadoop clusters are spread across multiple racks, performs deletions across the BDA rack. If other clusters exist within the BDA rack, relocates any shared targets before deleting the Hadoop cluster target.
Format
emcli delete_bda_cluster
-cluster="cluster_name"
Options
cluster
Name of the cluster to be deleted.
Examples
The following example deletes the acme cluster target and all of its children. If acme is the last cluster in the BDA rack, deletes the rack and all of its children. If there are other clusters in the rack, relocates shared targets before deleting the cluster.
emcli delete_bda_cluster
-cluster="acme"
Deletes a blackout that has already ended or has been fully stopped. You cannot delete a blackout that is either in progress or currently scheduled. You must first run stop_blackout.
Format
emcli delete_blackout
-name="name"
[-createdby="blackout_creator"]
[-emd_url="emd_url"]
[ ] indicates that the parameter is optional
Options
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. For blackouts created via emctl, -createdby="<SYSTEM>" should be specified.
emd_url
The emd_url of the agent through which emctl blackout was created. This is a mandatory parameter for blackouts created through emctl.
Examples
Example 1
This example deletes blackout backup_monthly created by the current user.
emcli delete_blackout
-name=backup_monthly
Example 2
This example deletes the blackout black_2015-04-14 04:45:10 which was created via emctl for the given unique name.
emcli delete_blackout
-name="black_2015-04-14 04:45:10"
-createdby="<SYSTEM>"
-emd_url="https://myhost.company.com:1234/emd/main/"
Deletes the custom charge item from Chargeback.
Format
emcli delete_charge_item
-target_type="target_type"
-item_name="item_name"
Options
target_type
Target type associated with the custom charge item.
item_name
Name of the custom charge item to be deleted.
Examples
Example 1
This example deletes a custom charge item named total_proc associated with the host target type:
emcli delete_charge_item
-target_type="host"
-item_name="total_proc"
Example 2
This example deletes a custom charge item named custom_config associated with the Oracle Database target type:
emcli delete_charge_item
-target_type="oracle_database"
-item_name="custom_config"
Deletes a software library component and directives for a chef cookbook. Use this verb once for each cookbook.
Format
emcli delete_chef_cookbook
-name="component_name"
-folder_name="swlib_folder_name"
Options
name
The software library component name
folder_name
The software library folder where the component and directives were saved.
Example
The following example deletes a custom software library component and directives for a chef cookbook.
emcli delete_chef_cookbook
-name=component
-folder_name="MyComponents"
Deletes the cloud service instances based on the specified filter.
Format
emcli delete_cloud_service_instances
-user="username"
[-family="family"]
[-type="service type"]
[ ] indicates that the parameter is optional
Options
user
Identifies the name of the user to be used for filtering the service instances that are to be deleted.
family
Identifies the service family name to use to filter cloud requests.
type
Identifies the Service Type to be used for filtering the service instances that are to be deleted.
Examples
Example 1
This example deletes all cloud instances that are owned by a specified user (user1) and belong to a specified service family (family1):
emcli delete_cloud_service_instances -user="user1" -family="family1"
Example 2
This example deletes all cloud instances that are owned by a specified user (user1), belong to a specified service family (family1), and belong to a specified service type (type1):
emcli delete_cloud_service_instances -user="user1" -family="family1" -type="type1"
Deletes cloud user objects including cloud service instances and requests.
Format
emcli delete_cloud_user_objects
-user="username"
[-purge]
[-force]
[ ] indicates that the parameter is optional
Options
user
Identifies the name of the user to be used for filtering user objects.
purge
Sets a flag to purge the completed cloud service requests. Default is false unless this option is used.
force
Sets a flag to attempt to cancel In Progress requests. Depending on the job state, there may be some manual cleanup required.
USE WITH CAUTION. There is no way to undo the operation once started.
Examples
Example 1
Delete all cloud objects owned by a specified user (user1) and cancel all scheduled requests:
emcli delete_cloud_user_objects -user="user1"
Example 2
Delete all cloud objects owned by a specified user (user1), cancel all scheduled requests, and purge all completed requests:
emcli delete_cloud_user_objects -user="user1" -purge
Deletes a comparison check for the specified target type. The latest comparison check is deleted.
Format
emcli delete_compare_check
-name="<check_name>"
-target_type="<target_type>"
Options
name
Name of the comparison check being deleted.
target_type
Target type in which the comparison check is being deleted.
Example
The following example deletes the check_deployment_my_target comparison check from the host target.
emcli delete_compare_check
-name="check_deployment_my_target"
-target_type="host"
Deletes the specified configuration comparison template from the repository.
Format
emcli delete_config_compare_template -template_name="<template_name>"
Options
template_name
Name of the configuration comparison template.
Example
The following example deletes the configuration comparison template with template_name "Host Template"
emcli delete_config_compare_template
-template_name="Host Template"
Deletes the saved one-time comparison from the repository.
Format
emcli delete_config_onetimecompare
-name="<comparison_name>"
Options
name
Name of the saved configuration comparison.
Example
The following example deletes the saved one-time comparison from the repository with the name "cmp_host1".
emcli delete_config_onetimecompare
-name="cmp_host1"
Deletes the saved configuration search from the repository.
Format
emcli delete_config_search
-name="saved_search_name"
[-search_type="Latest/History"]
[ ] indicates that the parameter is optional.
Options
name
The name of saved search.
search_type
The saved search type, either Latest or History. This is an optional parameter with Latest as default value.
Example
The following example deletes the saved search 'search_07_15-2015':
emcli delete_config_search -name="search_07_15_2015"
-search_type="Latest"
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"
Options
set_name
Credential set name to be deleted.
target_type
Target type of the credential set.
Examples
This example deletes a credential set named Old_Credential_Set.
emcli delete_credential_set
-set_name=Old_Credential_Set
-target_type=host
Deletes the custom plug-in update for a plug-in. All subsequent plug-in deployments will use the latest applicable version or revision available with Enterprise Manager Self Update.
Does not automatically redeploy to Management Agents on which this custom plug-in update was previously deployed. Applies only to subsequent plug-in deployments.
Format
emcli delete_custom_plugin_update
-plugin="<plugin_id>:<plugin_version>:<plugin_revision>"
Options
plugin
ID, version, and revision of the plug-in. To view the version and revision of a plug-in, run 'emcli list_custom_plugin_updates'.
Example
The following example deletes the custom plug-in update of the 12.1.0.2.0 version of the oracle.sysman.db2 plug-in.
emcli delete_custom_plugin_update -plugin="oracle.sysman.db2:12.1.0.2.0"
Deletes a database and target from Oracle Enterprise Manager.
Format
emcli delete_database
-inputFile="File containing properties required for deleting a database"
Options
inputFile
The location and name of the file containing the properties required for deleting the database.
Example
The following example deletes a database using the parameters contained in the /u01/files/delete_database.props file:
emcli delete_database -inputFile=/u01/files/delete_database.props
Deletes the database size created with the create_database_size verb.
Format
emcli delete_database_size
-name="<Existing size name>"
Options
name
The name of the existing database size.
Example
The following example deletes the database size names Small.
emcli delete_database_size
-name=Small
Deletes the database quota for an SSA user role.
Format
emcli delete_dbaas_quota
-role_name="<SSA user role name>"
[ ] indicates that the parameter is optional.
Options
role_name
Name of the SSA user role for which the quota is to be deleted.
Example
This example deletes the quota for My Role:
emcli delete_dbaas_quota
-role_name="My Role"
Deletes an existing database profile component.
Format
emcli delete_dbprofile -comp_loc="Database Profile component location and name in software library" [-version="Database Profile component version name"] [ ] indicates that the parameter is optional.
Options
comp_loc
Combination of database profile component location and name.
version
Database profile component version name.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example deletes Database profile component with the profile name "RMAN_Profile", version "RMAN_Backup_10_04_14_12_40_PM" and location "Database Provisioning Profiles/11.2.0.4.0/linux_x64".
emcli delete_dbprofile -comp_loc="Database Provisioning Profiles/11.2.0.4.0/linux_x64/RMAN_Profile" -version="RMAN_Backup_10_04_14_12_40_PM"
Deletes a specified diagnostic snapshot.
Format
emcli delete_diag_snapshot
-name="<diag_snapshot_name>"
[-debug]
[ ] indicates that the parameter is optional
Options
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
This example deletes a diagnostic snapshot with the name of Snapshot1 from Cloud Control.
emcli delete_diag_snapshot
-name="Snapshot1"
Deletes a Fusion Middleware provisioning profile from software library.
Format
emcli delete_fmw_profile
-location="Profile Location"
-source="source"
-dest="association type"
[-separator="separator:attribute_name:character"]
[-subseparator="subseparator:attribute_name:character"]
[ ] indicates that the parameter is optional.
Options
location
The complete software library path to the profile. Use the list_fmw_profiles verb to identify the complete path.
Note:
The name and owner parameters must be used together.
Example
The following example deletes the Fusion Middleware profile "MyProfile" from software library.
emcli delete_fmw_profile -location="Fusion Middleware Provisioning/Profiles/MyProfile"
Deletes a property from the target properties master list.
Format
Standard Mode
emcli delete_from_target_properties_master_list
-property_name="null"
-property_value="null"
Interactive or Script Mode
delete_from_target_properties_master_list( property_name="null" ,property_value="null" ) [ ] indicates that the parameter is optional. Delete if the verb has no optional parameters
Options
property_name
The name of the property to delete.
property_value
The value of the property to delete.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Deletes a Management Agent gold image version.
Format
emcli delete_gold_agent_image
-version_name="gold_image_version_name_to_delete"
Options
version_name
Management Agent gold image version that you want to delete.
Example
The following example deletes the Management Agent gold image OPC_AGI_DB_JUL_13.
emcli delete_gold_agent_image -version_name=OPC_AGI_DB_JUL_13
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
Options
name
Name of the group to delete.
type
Group type: group. Defaults to "group".
Examples
Example 1
This example removes the group payroll_group that consists of database target types.
emcli delete_group -name=payroll_group
Example 2
This example removes the group my_hosts that consists of host target types.
emcli delete_group -name=my_hosts
Deletes one or more open incidents based on the provided IDs, up to a maximum of 20 incidents. This removes any association with the underlying events and annotates them accordingly. Incident deletion does not remove the actual underlying events: These events will remain open.
Privilege Requirements: Only users with Manage Incident privilege can delete the incident.By default, incidents that have workflow attributes (such as Escalation, Priority, Resolution Status, Acknowledgement, Owner Assignment, or Suppression) set to non-default values will not be deleted unless the -force option is used.Closed incidents, diagnostic (ADR) incidents, and incidents with tickets created cannot be deleted.The status of each incident deletion is displayed upon command execution.
Format
emcli delete_incident_record
-incident_number_list="Comma-separated list of incident numbers"
[-force]
[-preview]
[ ] indicates that the parameter is optional
Options
incident_number_list
Comma-separated list of incident numbers (up to 20) to be deleted.
force
Deletes incidents without checking for their non-default workflow values.
preview
Displays whether or not specified incidents (by incident number) can be deleted.
Examples
Example 1
This example displays whether or not incidents 173, 1886, 32, 5, and 853 can be deleted.
The command output is shown below.
emcli delete_incident_record -incident_number_list="173,1886,32,5,853" -preview ========= RESULTS ========= => Incident 173 can be deleted. => Incident 1886 can only be deleted using the -force option, as one or more incident workflow attributes have been been used. => Incident 32 cannot be deleted because there is ticket attached with the incident. => Incident 5 cannot be deleted because user AdminX does not have at least a manage incident privilege. => Incident 853 can be deleted.
Example 2
This example deletes incidents 178, 1886, and 853 without checking for non-default incident workflow values. The command output is shown below.
emcli delete_incident_record -incident_number_list="173,1886,853" -force ========= RESULTS ========= => Incident 173 has been successfully deleted. => Incident 1886 has been successfully deleted. => Incident 853 has been successfully deleted.
Deletes a stopped or completed deployment instance. An instance can only be deleted when its status is stopped, completed, or completed with an error.
Format
emcli delete_instance
[-instance=<instance_guid>]
[-exec=<execution_guid>]
[-name=<execution_name>]
[-owner=<execution_owner>]
[ ] indicates that the parameter is optional
Options
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
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
Options
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 -input_file Syntax Guidelines.
preview
Lists only the jobs to be deleted. In the list of options you specify, if -preview is not one of the options, jobs are deleted, and then these jobs will be listed. If -preview is one of the options, the identical list is shown, but no jobs are deleted.
Examples
Example 1
This example deletes an existing job with the job ID 12345678901234567890123456789012.
emcli delete_job -job_id=12345678901234567890123456789012
Example 2
This example stops and deletes a job named MY_JOB owned by the logged in administrator. You can use the stop and delete pattern to delete active jobs.
emcli stop_job -name=my_job emcli delete_job -name=my_job
Deletes a library job you created using the create_library_jobs command.
Format
emcli delete_library_job
-name=<"library_job_name">
[-owner=<"library_job_owner">]
[ ] indicates that the parameter is optional
Options
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
This example deletes the library job "libjob1" owned by the current logged-in Enterprise Manager administrator.
emcli delete_library_job -name=libjob1
Example 2
This example deletes the library job "libjob2" owned by the Enterprise Manager administrator "emadmin1."
emcli delete_library_job -name=libjob2 -owner=emadmin1
Deletes a promoted metric.
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
Options
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
This 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
Deletes a non-Oracle Middleware Provisioning Profile from software library.
Examples of non-Oracle middleware include Apache Tomcat, JBoss, etc.
For Oracle Middleware Provisioning Profile, refer to other verbs such as delete_fmw_domain_profile or delete_fmw_home_profile.
Format
emcli delete_mw_profile
-location="Profile Location"
Options
location
Complete software library path to the Profile. Use list_mw_profiles to know the complete path.
Examples
The following example deletes the profile named 'MyProfile':
emcli delete_mw_profile
-location="Middleware Provisioning/Generic Profiles/MyProfile"
Deletes an existing named credential.
Format
emcli delete_named_credential
-cred_owner=<owner>
-cred_name=<name>
Options
cred_owner
Credential owner.
cred_name
Required credential name. This does not support wild cards.
Deletes the specified operation plan from a Site Guard configuration.
Format
emcli delete_operation_plan
-name=<plan_name>
Options
name
Name of the operation plan you want to delete.
Example
emcli delete_operation_plan
-name="BISystem1-switchover"
De-configures and deletes Oracle Database.
Format
emcli delete_oracle_database
-input_file=data:"absolute file path"
[-instances|-software|-all]
[-schedule=
[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{timezone ID}];
[grace_period:xxx]
]
[ ] indicates that the parameter is optional.
Options
software
Deletes the empty SIDB home.
listeners
Deletes or de-configures listeners running from the oracle home.
all
Deletes the instances, listeners, and the software home.
input_file
Property file that contains necessary parameters to perform de-configure and delete Oracle Database. Use "emcli describe_input -oracle_database" command to get the list of properties for performing cleanup operation.
schedule
frequency: Frequency type with which the Oracle Restart is removed. It can be interval (in minutes), weekly, monthly, or yearly
start_time: Denotes the starting time of Cleanup Oracle Restart in the format yy-MM-dd HH:mm
end_time: Denotes the end time of Cleanup Oracle Restart in the format yy-Mm-dd HH:mm
repeat: Repetition rate at Cleanup Oracle Restart. If the frequency is interval, then repeat will be in minutes
months: Number of months after which repetition of Cleanup Oracle Restart will occur
days: Number of days after which repetition of Cleanup Oracle Restart will occur
tz: Time Zone ID
Examples
Example 1
This example cleans the Oracle Database Instances based on property file "deletesiha.txt" with the specified schedule.
emcli delete_oracle_database -instances
-input_file="data:/tmp/deletesidb.txt"
-schedule="frequency:interval;start_time:15-10-27 05:30;end_time:14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York"
Example 2
This example cleans the Oracle Database based on property file "deletesiha.txt".
emcli delete_oracle_database -all
-input_file="data:/tmp/deletesiha.txt"
De-configures and deletes Oracle Restart (SIHA).
Format
emcli delete_oracle_restart
-input_file=data:"absolute file path"
[-instances|-software|-all]
[-schedule=
[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{timezone ID}];
[grace_period:xxx]
]
[ ] indicates that the parameter is optional.
Options
instances
De-configures the Oracle Restart (SIHA) instance only.
software
Deletes the empty Oracle Restart (SIHA) home.
all
De-configures and Delete Oracle Restart (SIHA) home.
input_file
Property file that contains necessary parameters to perform de-configure and delete Oracle Restart. Use "emcli describe_input -oracle_restart" command to get the list of properties for performing cleanup operation.
schedule
frequency: Frequency type with which the Oracle Restart is removed. It can be interval (in minutes), weekly, monthly, or yearly
start_time: Denotes the starting time of Cleanup Oracle Restart in the format yy-MM-dd HH:mm
end_time: Denotes the end time of Cleanup Oracle Restart in the format yy-Mm-dd HH:mm
repeat: Repetition rate at Cleanup Oracle Restart. If the frequency is interval, then repeat will be in minutes
months: Number of months after which repetition of Cleanup Oracle Restart will occur
days: Number of days after which repetition of Cleanup Oracle Restart will occur
tz: Time Zone ID
Examples
Example 1
This example cleans the Oracle Restart Instances based on property file "deletesiha.txt" with the specified schedule.
emcli delete_oracle_restart -instances
-input_file="data:/tmp/deletesiha.txt"
-schedule="frequency:interval;start_time:15-10-27 05:30;end_time:14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York"
Example 2
This example cleans the Oracle Restart based on property file "deletesiha.txt".
emcli delete_oracle_restart -all
-input_file="data:/tmp/deletesiha.txt"
Deletes a PaaS Infrastructure Zone. A PaaS Infrastructure Zone cannot be deleted if an existing software pool is associated with it.
Format
emcli delete_paas_zone
-name="<name of PaaS Zone>
[ ] indicates that the parameter is optional.
Options
name
Name of the existing PaaS Infrastructure Zone.
Example
This example deletes the PaaS Infrastructure Zone with the name My PaaS Zone:
emcli delete_paas_zone
-name="My PaaS Zone"
Deletes patch plans.
Format
emcli delete_patch_plans
-name="plan_names"
[ ] indicates that the parameter is optional
Options
name
Specifies the names of the patch plans that you want to delete. Use a comma as a separator if you want to specify multiple patch plans for this option.
Examples
The following example deletes the patch plans plan_1, plan_2, and plan_3:
emcli delete_patch_plans -name="plan_1,plan_2,plan_3"
Deletes patches from the software library.
Format
emcli delete_patches
-patch_name=<patch_name>
-release=<release_id>
-platform=<platform_id>
Options
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
Also see Patching Using EM CLI in the Enterprise Manager Lifecycle Management Administrator's Guide:
Deletes pluggable databases (PDBs).
Format
emcli delete_pluggable_database
-cdbTargetName="CDB_of_target_PDBs"
-cdbTargetType="CDB_target_type"
-cdbHostCreds="CDB_host_credentials"
-cdbTargetCreds="CDB_target_credentials"
-pdbName="PDB_names"
[-cdbHostPrivCreds="CDB_host_privileged_credentials"]
[-ignoreStorageWarnings]
[ ] indicates that the parameter is optional.
Options
cdbTargetName
Target container database (CDB) that contains the PDBs that you want to delete. Ensure that the target CDB you specify is a valid target in Enterprise Manager.
cdbTargetType
Database type of the target CDB, which can be oracle_database, rac_database, and so on.
cdbHostCreds
Credentials for the host on which the target CDB is located.
cdbTargetCreds
Credentials for the target CDB.
pdbName
Names of the PDBs that you want to delete. Ensure that you separate the names using a comma.
cdbHostPrivCreds
Privileged credentials for the host on which the Snap Clone storage mount points are located. Note that this option is required only if you are deleting PDBs that were created using Snap Clone.
ignoreStorageWarnings
Ignore any storage warnings that may be generated while deleting PDBs that were created using Snap Clone.
Examples
This example deletes the test_pdb PDB, which is a part of test_CDB, an Oracle single-instance CDB, using HOST_CREDS as the CDB host credentials and DB_CREDS as the CDB target credentials:
emcli delete_pluggable_database -cdbTargetName=test_database -cdbTargetType=oracle_database -pdbName=test_pdb -cdbHostCreds=HOST_CREDS -cdbTargetCreds=DB_CREDS
Deletes a software pool. A software Pool cannot be deleted if there is an existing service template associated with it.
Format
emcli delete_pool
-name="<software pool name>"
-target_type="<software pool target type>"
[ ] indicates that the parameter is optional.
Options
name
The name of the existing software pool.
target_type
The target type of the existing software pool.
Example
The following example deletes the software pool My Pool:
emcli delete_pool
-name="My Pool"
-target_type="mwaas_zone"
Deletes a privilege delegation setting template.
Format
emcli delete_privilege_delegation_settings
-setting_names="setting_name1;setting_name2;setting_name3;"
Options
setting_names
Name of the settings you want to delete.
Example
This 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
Deletes a deployment procedure. If the purge option is used, the procedure is deleted permanently. Otherwise, it is moved to the recycle bin.
Format
emcli delete_procedure
[-procedure={procedure guid}]
[-name={procedure name}]
[-owner={procedure owner}]
[-purge]
Parameters
procedure
The procedure GUID.
name
The procedure name.
owner
The procedure owner.
Note:
The name and owner parameters must be used together.
purge
Deletes the procedure permanently.
Example
The following example permanently deletes the procedure 16B15CB29C3F9E6CE040578C96093F61.
emcli delete_procedure -procedure=16B15CB29C3F9E6CE040578C96093F61
-purge
Deletes a HTTP(S) proxy identified by the specified name.
Syntax
emcli delete_proxy
-name="<name>"
Options
-name
Name identifying the proxy.
Example
The following command deletes a proxy with the "us-proxy-1" name.
emcli delete_proxy
-name="us-proxy-1"
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"
Options
label
Label of the state to be deleted.
alt_res_state_label
Alternative state to be used.
Examples
This 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"
Deletes an existing Enterprise Manager administrator role.
Format
emcli delete_role
-name="role_name"
Options
name
Role name.
Examples
This example deletes the role name existing_role.
emcli delete_role -name="existing_role"
Deletes a saved target configuration.
Format
emcli delete_saved_config
-name="saved config name"
[-target_type="host"]
[-target_name="test_host"]
[ ] indicates that the parameter is optional.
Parameters
name
The name of the saved configuration to delete.
target_type
The target type of the configuration to delete. The value should be the internal name. This is an optional parameter.
target_name
The name of the target of the configuration to delete. This is an optional parameter.
Examples
Example 1
The following command delete the saved configuration with the name "saved config name":
emcli delete_saved_config
-name="saved config name"
Example 2
The following command deletes the saved configuration for host target type with the name "test_host":
emcli delete_saved_config
-target_type="host"
-target_name="test_host"
Deletes a saved target configuration.
Format
emcli delete_saved_onetimecomparison
-name="saved config name"
[-target_type="host"]
[-target_name="test_host"]
[ ] indicates that the parameter is optional.
Options
name
The name of the saved configuration to delete.
target_type
The target type of the configuration to delete. The value should be the internal name. This option is not mandatory.
target_name
The name of the target of the configuration to delete. This option is not mandatory.
Examples
Example 1
The following command delete the saved configuration with the name "saved config name":
emcli delete_saved_onetimecomparison
-name="saved config name"
Example 2
The following command deletes the saved configuration for host target type with the name "test_host":
emcli delete_saved_onetimecomparison
-target_type="host"
-target_name="test_host"
Deletes a service template.
Format
emcli delete_service_template
-name="<service template name>"]
-service_family="<service family name>"]
[ ] indicates that the parameter is optional.
Options
name
Name of the existing service template.
service_family
Service family to which the service template belongs; for example, DBAAS for database and MWAAS for middleware.
Example
This example deletes the service template with name template2 and service family MWAAS:
emcli delete_service_template
-name="Middleware service Template August"
-service_family="MWAAS"
Deletes one or more Siebel Enterprise instances and their associated targets, such as Siebel servers, component groups, components, work flows, and so on.
Format
emcli delete_siebel
-enterprise=<Siebel_enterprise_1>,<Siebel_enterprise_2>
[-out_file='<output_file>']
[<-debug>]
[ ] indicates that the parameter is optional
Options
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
This 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.example.com,SBA78_ent2.us.example.com
-out_file='c:\emcli\deletion_output.txt'
Deletes an auxiliary host associated with the system.
Format
emcli delete_siteguard_aux_host
-system_name="name_of_the_system"
[-host_name="name_of_the_auxiliary_host"]
[ ] indicates that the parameter is optional
Options
system_name
Name of the system whose auxiliary host you want to delete.
host_name
Name of the auxiliary host that you want to delete. If not specified, all auxiliary hosts associated with the system will be deleted.
Examples
Example 1
This example deletes the auxiliary host host1.domain.com associated with austin-system:
emcli delete_siteguard_aux_host
-system_name="austin-system"
-host_name="host1.domain.com"
Example 2
This example deletes the auxiliary host host2.domain.com associated with austin-system:
emcli delete_siteguard_aux_host
-system_name="austin-system"
-host_name="host2.domain.com"
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>
Options
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"
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
Options
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"
Updates the limit for Apply lag and Transport lag for all or selected databases of the system.
Format
emcli delete_siteguard_lag
[-system_name="name_of_the_system"]
[-target_name="name_of_the_database"]
[-property_name="lag_type"]
[ ] indicates that the parameter is optional
Options
system_name
Name of the system whose lag limit property you want to update.
target_name
Name of the target database whose lag limit property you want to update.
property_name
Name of the lag property. Valid values for this option are ApplyLag and TransportLag.
Examples
Example 1
This example deletes the ApplyLag property on all of the databases configured on austin-system:
emcli delete_siteguard_lag
-system_name="austin-system"
-property_name="ApplyLag"
Example 2
The following example deletes the TransportLag property on the database OID-db configured on austin-system:
emcli delete_siteguard_lag
-system_name="austin-system"
-target_name="OID_db"
-property_name="TransportLag"
Deletes the specified script from the Site Guard configuration.
Format
emcli delete_siteguard_script
-script_id=<script_id>
Options
script_id
ID associated with the script.
Examples
emcli delete_siteguard_script
-script_id="10"
Deletes the host or hosts associated with a given script.
Format
emcli delete_siteguard_script_hosts
-script_id=<script_id>
-host_name=<name1;name2;...>
Options
script_id
ID associated with the script.
host_name
Name of the host where this script will be run. You can specify this option 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
Deletes one or more SLAs for a target.
Format
emcli delete_sla
-targetName=<target_name>
-targetType=<target_type>
-slaName=<SLA_name>
Options
targetName
Name of the target.
targetType
Type of target.
slaName
Name of the SLA.
Example
This example deletes the SLA with the name 'gold_sla' from the target.
emcli delete_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla'
Deletes a system.
Format
emcli delete_system
-name="name"
[-type=<generic_system>]
[ ] indicates that the parameter is optional
Options
name
Name of the system to delete.
type
System type: generic_system. Defaults to "generic_system".
Examples
This example deletes the system my_system.
emcli delete_system -name=my_system
Deletes a specified target from the Enterprise Manager Cloud Control monitoring framework. Deleting a target removes it from the Management Repository and does not physically remove the target itself.
You can use the get_targets verb to obtain a list of available targets and their respective types.
Format
emcli delete_target
-name=<name>
-type=<type>
[-delete_monitored_targets]
[-async]
[-delete_members]
[ ] indicates that the parameter is optional
Options
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
This example deletes the Agent named test.example.com:1836 and all of its monitored targets. The Agent must be marked UNREACHABLE in Enterprise Manger Cloud Control to perform this operation.
emcli delete_target
-name="test.example.com:1836"
-type="oracle_emd"
-delete_monitored_targets
-async
Example 2
This example deletes the example_ias_farm target with the name "farm01_base_domain" and all of its members, such as domain, clusters, servers, application deployments, and so forth.
emcli delete_target
-name="farm01_base_domain"
-type="example_ias_farm"
-delete_members
Deletes an Enterprise Manager tenant.
Format
Standard Mode
emcli delete_tenant
-name="tenant name"
Interactive Mode
emcli delete_tenant (name="tenant_name")
Options
name
Identifies the name of the tenant to be deleted.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example deletes the my_name tenant.
emcli delete_tenant -name="my_tenant"
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
Options
name
Service target name.
type
Service target type.
testname
Name of the test.
testtype
Type of test.
Example
This 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'
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
Options
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"
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
Options
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
This example deletes the Enterprise Manager administrator named sysman3.
emcli delete_user -name=sysman3
Example 2
This example deletes the Enterprise Manager administrator named user1, and assigns all the secure objects owned by user1 to user5.
Deletes a user profile.
Format
Standard Mode
emcli delete_user_profile
-name="profile name"
Interactive or Script Mode
create_user_profile(
name="profile name"
)
Options
name
The name of the user profile to be deleted.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example deletes the profile (profile1) of the current tenant.
emcli delete_user_profile
-name="profile1"
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
Options
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
This example deploys all platform and plug-in Enterprise Manager Oracle-provided reports, but does not overwrite any existing reports
emcli deploy_bipublisher_reports -all
Example 2
This example deploys only the Chargeback and Trending reports, and overwrites any existing reports.
emcli deploy_bipublisher_reports -force -pluginid=oracle.sysman.emct -pluginversion=12.1.0.3.0
Deploys Self Update Enterprise Manager reports to the BI Publisher catalog. To deploy all reports in a folder, specify the -folder option. To deploy a single report, use the -folder and -report options. To deploy all Self Update reports, use the -all option.
The deploy operation will not overwrite existing BI Publisher reports in the BI Publisher catalog unless the -force option is given.
Format
emcli deploy_bipublisher_selfupdates
[-force]
-all | (-folder=<folder> [-report=<reportname>])
[ ] indicates that the parameter is optional.
Options
force
Overwrites any existing reports in the BI Publisher catalog with the copy being deployed.
all
Deploys all Self Update reports.
folder
Limits the reports deployed to the specified folder. By default, all reports in the folder are deployed unless the -report option is also specified.
report
Deploys a single, specified report. The -folder parameter must be specified when using the -report parameter.
Examples
Example 1
The following example deploys all Self Update reports to the Compliance Reports folder:
emcli deploy_bipublisher_selfupdates -folder="Compliance Reports"
Example 2
The following example deploys only the Self Update report named Consolidation Report located in the Compliance Reports folder and overwrites any existing report.
emcli deploy_bipublisher_selfupdates -force -folder="Compliance Reports" -report="Consolidation Report"
Deploys a plug-in on Management Agents. Agent names must be provided for plug-in deployment.
Note:
A plug-in can only be deployed on any Management Agent after it has been successfully deployed on the management server.
Format
emcli deploy_plugin_on_agent
-agent_names=<agent1;agent2>
-plugin=<plug-in_id[:version>]
[-discovery_only]
[ ] indicates that the parameter is optional
Options
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
This example deploys the latest version of oracle.sysman.db2 on Management Agent myhost1.example.com.
emcli deploy_plugin_on_agent -plugin="oracle.sysman.db2" -agent_names="myhost1.example.com:1838"
Example 2
This example deploys version 12.1.0.1.0 of plug-in oracle.sysman.db2 on management agent myhost1.us.example.com.
emcli deploy_plugin_on_agent
-plugin="oracle.sysman.db2:12.1.0.1.0"
-agent_names="myhost1.us.example.com:1838"
Deploys a plug-in on the Management Servers. The deployment process for some plug-ins might restart the Management Servers. If the plug-in is already deployed on one of the servers, this server is skipped. If a lower version of the plug-in is already deployed, the plug-in is upgraded. If a lower revision of the plug-in is already deployed, the new revision is applied.
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
Options
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
This example deploys the latest downloaded version of Oracle Database plug-in (plug-in ID: oracle.sysman.db) on the management server.
emcli deploy_plugin_on_server
-plugin=oracle.sysman.db
-sys_password=<welcome>
Example 2
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"
Takes a list of agents and deregisters each agent as a forwarding agent.
Format
emcli deregister_forwarder_agents
-agent_list="agent_list"
[ ] indicates that the parameter is optional.
Options
agent_list
List of agents that need to be deregistered as forwarders. The agents must be separated by space.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example deregisters agent1 and agent2 as forwarding agents.
emcli deregister_forwarder_agents
-agent_list="agent1 agent2..."
Lists and describes all database profile creation input variables.
Format
emcli describe_dbprofile_input [-data_mode={EXPORT/DBCA_TEMPLATE/RMAN/STORAGE_SNAPSHOT}]
[ ] indicates that the parameter is optional.
Options
data_mode
Data mode for which the database profile needs to be submitted.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example lists all input variables required for creating a snapshot database profile.
emcli describe_dbprofile_input -data_mode=STORAGE_SNAPSHOT
Lists all the components of an engineered system target discovered in Enterprise Manager.
Format
emcli describe_engr_sys_targets
-system_target_name="system_target_name"
-system_target_type="system_target_type"
[-component_type="component_type"]
[ ] indicates that the parameter is optional.
Options
system_target_name
Specifies the engineered system target name.
system_target_type
Specifies the engineered system target type.
component_type
Specifies the engineered system component target type.
Examples
Example 1
The following example displays all the components of the engineered system "DB Machine slcm12.example.com":"oracle_dbmachine":
emcli describe_engr_sys_targets
-system_target_name="DB Machine slcm12.example.com"
-system_target_type="oracle_dbmachine"
Example 2
The following example displays the Oracle Infiniband Switches targets of the engineered system "DB Machine slcm12.example.com":"oracle_dbmachine":
emcli describe_engr_sys_targets
-system_target_name="DB Machine slcm12.example.com"
-system_target_type="oracle_dbmachine"
-component_type="Oracle Infiniband Switch"
Provides a description of the Fusion Middleware provisioning profile from the software library.
Format
emcli describe_fmw_profile
-location="Profile Location"
Options
location
The complete software library path to the profile. Use the list_fmw_profiles verb to identify the complete path.
Note:
The name and owner parameters must be used together.
Example
The following example displays a description of the Fusion Middleware profile "MyProfile" from software library.
emcli describe_fmw_profile -location="Fusion Middleware Provisioning/Profiles/MyProfile"
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
Options
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
Example1
This example describes the library job "yourJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this job.
emcli describe_job -name=yourJob -owner=admin1
Example 2
emcli describe_job -name=EMCLI_JOB_2 -verbose # Job Name : EMCLI_JOB_2 # Current status of the job is ACTIVE. # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # Target List. # In a target list, each member is specified using the target name and target type # in the fashion: # target_name:target_type # To specify an element of the target list, the following notation is used: # job_target_list.1=target_name:target_type # The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element. # The target target_name:target_type should exists in EM. # Permissible target types are: host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # A sample target list could be: # job_target_list.1=<target_name>:host # job_target_list.2=<target_name>:host # The target list can only contain targets of the same target type. A cluster, # group, domain or system # target must not be intermixed with targets of the other target types. # Variable List. # In a variable list, each member is specified in the following way: # Scalar variable: A variable whose value can be represented as a single string. # variable.variable_name=variable_value # Here "variable" is a keyword. Variable name is the name of the variable whose # value is being specified. # Value is specified on the right hand side after the equal to sign. # Vector variable: A variable whose value is represented as an array or list of # string values. # variable.variable_name.1=value1 # variable.variable_name.2=value2 # Here the numbers suffixing the variable name signify the entry number in the # list. # Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable. # variable.large_variable_name=a_very_very_big_value # Credential List. # This is the list of credential usages declared by the job type. # Each entry takes the form: # cred.credusage_name.target_details=cred_type:cred_details # Here the prefix "cred" is a keyword signifying that this line represents a # credential entry. # "credusage_name" would be substituted with the name of the credential usage # declared in the job type. # This is followed by the target details, which take the following form: # target_name:target_type # The value for this credential usage entry is specified using the type of the # credential and its details. # "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential. # "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type" # A sample entry for a target target1:host for credential usage defaultHostCred # for a credential set could look like: # cred.defaultHostCred.target1:host=SET:HostCredsNormal # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential could look like: # cred.defaultHostCred.target1:host=NAMED:MyNamedCredential # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential shared by EM Admin "admin1" could look like: # cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential # Schedule. # Specify a schedule for the job. Detailed instructions as per below: # Frequency: Specifies the frequency of repeatedly submitting instances of this # job. # scheule.frequency=Frequency_Type # Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY, # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS. # If frequency is IMMEDIATE, then other schedule fields do not matter. # Start Time: Start time for the schedule. # scheule.startTime=MM-DD-YYYY # End Time: End time for the schedule. # scheule.endTime=MM-DD-YYYY # Grace Period: Grace period in minutes for the schedule. # scheule.graceperiod= # Months : Months for repetition. January is denoted by 0 and December by 11 # schedule.months=0,1,2 # Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6. # schedule.days=0,1,2 # Timezone: Timezone information is further detailed into type, target index, zone # offset and region. # schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED, # TIMEZONE_REGION_SPECIFIED. # schedule.timezone.targetIndex : specify the index of the target whose # timezone is to be used. # schedule.timezone.zoneOffset : timezone offset. # schedule.timezone.region : timezone region # Following is a complete schedule section, remove # and populate the values for # submission: # scheule.frequency=ONCE # schedule.startTime=12-21-2012 # schedule.endTime=12-21-2012 # schedule.gracePeriod=10 # schedule.months= # schedule.days= # schedule.timezone.type=TIMEZONE_TARGET # schedule.timezone.targetIndex=1 # schedule.timezone.zoneOffset= # schedule.timezone.region= job_target_list.1=myhost.us.example.com:host # Variable: args # Description: Options of the command to run on the target variable.args=hello # Variable: command # Description: Command to run on the target variable.command=echo # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.myhost.us.example.com:host=NAMED:SYSMAN:CRED1 schedule.frequency=REPEAT_BY_MINUTES schedule.startTime=2012-02-01 01:01:01.0 schedule.endTime=2051-02-01 01:01:01.0 schedule.gracePeriod=-1 schedule.months= schedule.days= schedule.interval=1 schedule.timezone.type=TIMEZONE_TARGET schedule.timezone.targetIndex=1 schedule.timezone.zoneOffset=0 schedule.timezone.region=
Describes the job type and gets its properties. The output can be redirected into a file.
This verb dumps out a properties file for a job type that supports the Job System Generic EM CLI. This file contains some documentation, a list of all required credential usages, and a list of all variables required to create a (library) job instance of the job type.
This verb support multi-task jobs.
Format
emcli describe_job_type
-job_type=<"job_type_internal_name">
[-verbose]
[ ] indicates that the parameter is optional
Options
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
This example produces a property file on the console, which can be redirected to a file and used multiple times.
emcli describe_job_type -job_type=OSCommand # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # Variable: args # Description: Options 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 2
This example with the verbose option generates a property dump with help on how to specify each individual property for the job.
emcli describe_job_type -job_type=OSCommand -verbose # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # Target List. # In a target list, each member is specified using the target name and target type # in the fashion: # target_name:target_type # To specify an element of the target list, the following notation is used: # job_target_list.1=target_name:target_type # The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element. # The target target_name:target_type should exists in EM. # Permissible target types are: host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. # A sample target list could be: # job_target_list.1=<target_name>:host # job_target_list.2=<target_name>:host # The target list can only contain targets of the same target type. A cluster, # group, domain or system # target must not be intermixed with targets of the other target types. # Variable List. # In a variable list, each member is specified in the following way: # Scalar variable: A variable whose value can be represented as a single string. # variable.variable_name=variable_value # Here "variable" is a keyword. Variable name is the name of the variable whose # value is being specified. # Value is specified on the right hand side after the equal to sign. # Vector variable: A variable whose value is represented as an array or list of # string values. # variable.variable_name.1=value1 # variable.variable_name.2=value2 # Here the numbers suffixing the variable name signify the entry number in the # list. # Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable. # variable.large_variable_name=a_very_very_big_value # Credential List. # This is the list of credential usages declared by the job type. # Each entry takes the form: # cred.credusage_name.target_details=cred_type:cred_details # Here the prefix "cred" is a keyword signifying that this line represents a # credential entry. # "credusage_name" would be substituted with the name of the credential usage # declared in the job type. # This is followed by the target details, which take the following form: # target_name:target_type # The value for this credential usage entry is specified using the type of the # credential and its details. # "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential. # "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type" # A sample entry for a target target1:host for credential usage defaultHostCred # for a credential set could look like: # cred.defaultHostCred.target1:host=SET:HostCredsNormal # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential could look like: # cred.defaultHostCred.target1:host=NAMED:MyNamedCredential # A sample entry for a target target1:host for credential usage defaultHostCred # for a named credential shared by EM Admin "admin1" could look like: # cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential # Schedule. # Specify a schedule for the job. Detailed instructions as per below: # Frequency: Specifies the frequency of repeatedly submitting instances of this # job. # scheule.frequency=Frequency_Type # Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY, # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS. # If frequency is IMMEDIATE, then other schedule fields do not matter. # Start Time: Start time for the schedule. # scheule.startTime=MM-DD-YYYY # End Time: End time for the schedule. # scheule.endTime=MM-DD-YYYY # Grace Period: Grace period in minutes for the schedule. # scheule.graceperiod= # Months : Months for repetition. January is denoted by 0 and December by 11 # schedule.months=0,1,2 # Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6. # schedule.days=0,1,2 # Timezone: Timezone information is further detailed into type, target index, zone # offset and region. # schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED, # TIMEZONE_REGION_SPECIFIED. # schedule.timezone.targetIndex : specify the index of the target whose # timezone is to be used. # schedule.timezone.zoneOffset : timezone offset. # schedule.timezone.region : timezone region # Following is a complete schedule section, remove # and populate the values for # submission: # scheule.frequency=ONCE # schedule.startTime=12-21-2012 # schedule.endTime=12-21-2012 # schedule.gracePeriod=10 # schedule.months= # schedule.days= # schedule.timezone.type=TIMEZONE_TARGET # schedule.timezone.targetIndex=1 # schedule.timezone.zoneOffset= # schedule.timezone.region= # Variable: args # Description: Options of the command to run on the target variable.args= # Variable: command # Description: Command to run on the target variable.command= # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.<target_name>:<target_type>=
Describes a library job and gets its properties. The output can be redirected into a file.
Format
emcli describe_library_job
-name=<"job_name">
[-owner=<"job_owner">]
[-verbose]
[ ] indicates that the parameter is optional
Options
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
This example describes the library job "yourLibJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this library job.
emcli describe_library_job -name=yourLibJob -owner=admin1
Example 2
emcli describe_library_job -name=MYJOB1 # Job Name : MYJOB1 # Current status of the job is ACTIVE. # Job Type: OSCommand. # This job type supports the following target types only : host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver. job_target_list.1=myhost.us.example.com:host # Variable: args # Description: Options of the command to run on the target variable.args=hello # Variable: command # Description: Command to run on the target variable.command=echo # Credential Usage: defaultHostCred # Description: cred.defaultHostCred.myhost.us.example.com:host=NAMED:SYSMAN:CRED1 schedule.frequency=REPEAT_BY_MINUTES schedule.startTime=2012-02-01 01:01:01.0 schedule.endTime=2051-02-01 01:01:01.0 schedule.gracePeriod=-1 schedule.months= schedule.days= schedule.interval=1 schedule.timezone.type=TIMEZONE_TARGET schedule.timezone.targetIndex=1 schedule.timezone.zoneOffset=0 schedule.timezone.region=
Describes the input data of a patch plan.
Format
emcli describe_patch_plan_input
-name=<name>
Options
name
Name of a given patch plan.
Example
emcli describe_patch_plan_input -name="plan_name
See Also
Also see "Patching Using EM CLI" in the Enterprise Manager Lifecycle Management Administrator's Guide:
http://docs.oracle.com/cd/E24628_01/em.121/e27046/emcli.htm#BABDEGHB
Describes the input data of a deployment procedure or a procedure configuration.
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
Options
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
Changes the Data Guard protection mode of a primary database.
Format
emcli dg_change_protection_mode
-new_protection_mode="maximum_protection|maximum_availability|maximum_performance"
-primary_target_name="<primary target name>"
-primary_target_type="oracle_database|rac_database"
-standby_target_name="<standby target name>"
-standby_target_type="oracle_database|rac_database"
[-primary_db_creds_name="<primary database credential name>"]
[-primary_host_creds_name="<primary database host credential name>"]
[-standby_db_creds_name="<standby database credential name>"]
[-standby_host_creds_name="<standby database host credential name>"]
Options
new_protection_mode
Type of the new protection mode. Allowed values:
maximum_protection: Maximum Protection
maximum_availability: Maximum Availability
maximum_performance: Maximum Performance
primary_target_name
Primary database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
primary_target_type
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
standby_target_name
Standby database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
standby_target_type
Standby database target type. Specify oracle_database for single instance, or rac_database for cluster.
primary_db_cred_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
primary_host_cred_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
standby_db_cred_name
Named credential of a standby database for a user with a SYSDBA role or a SYSDG role.
Default value: Preferred credentials will be used.
standby_host_cred_name
Standby database host named credential for an operating system user who can access the standby database Oracle Home. Default is to use preferred credential.
Example
The following example changes the Data Guard protection mode to a maximum performance mode from the primary cluster database named "database" to a standby cluster database named "database".
emcli dg_change_protection_mode
-new_protection_mode="max_protection"
-primary_target_name="database"
-primary_target_type="oracle_database"
-stby_target_name="database"
-stby_target_type="oracle_database"
Configures Data Guard fast-start failover between the specified primary and standby databases.
Format
emcli dg_configure_fsfo
-operation= "enable | disable | edit"
-primary_target_name="primary target name"
-primary_target_type="oracle_database|rac_database"
-standby_target_name="standby target name"
-standby_target_type="oracle_database|rac_database"
[-primary_db_cred_name="primary database credential name"]
[-primary_host_cred_name="primary database host credential name"]
[-standby_db_cred_name="standby database credential name"]
[-standby_host_cred_name="standby database host credential name"]
[-observer_host_name="observer host name"]
[-observer_oracle_home="observer oracle home"]
[-observer_host_cred_name="observer host credential name"]
[-alternate_observer_host_name="alternate observer host name"]
[-alternate_observer_oracle_home="alternate observer oracle home"]
[-alternate_observer_host_cred_name="alternate observer host credential name"]
[-failover_threshold="failover threshold"]
[-lag_limit="lag limit"]
[-failover_conditions="failover_conditions"]
[-auto_reinstate_primary="no automatic reinstate primary"]
[-auto_shutdown_primary="no automatic shutdown primary"]
[-swap_jobs="swap jobs"]
[-swap_thresholds="swap thresholds"]
[ ] indicates that the parameter is optional.
Options
operation
Operation to be performed on the fast-start failover, as follows:
enable: enable fast-start failover.
disable: disable fast-start failover and stop the observer.
edit: make changes to the original parameter set. For example, you can change the fast-start failover designated standby database, adjust the thresholds, start or restart the observer process, and so forth. Effectively, aside from the primary target values, whatever parameter-value pairs you specify get updated. So, to change the standby database, you would specify all required parameters, changing the name of the standby target name, in addition to any other changes you want to make to optional values.
primary_target_name
Primary database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
primary_target_type
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
standby_target_name
Standby database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
standby_target_type
Standby database target type. Specify oracle_database for single instance, or rac_database for cluster.
primary_db_cred_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
primary_host_cred_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
standby_db_cred_name
Standby database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
standby_host_cred_name
Standby database host named credential for an operating system user who can access the standby database Oracle Home. Default is to use preferred credential.
observer_host_name
Discovered host where Enterprise Manager will start the observer. Default is none.
observer_oracle_home
Oracle Home on the observer host, if specified Default is none.
observer_host_cred_name
Observer host named credential for an operating system user who can access the observer Oracle Home.
alternate_observer_host_name
Discovered host where Enterprise Manager will start the alternate observer if the main observer becomes inaccessible and cannot be restarted. Default is none.
alternate_observer_oracle_home
Oracle Home on the alternate observer host, if specified, where Enterprise Manager will start the alternate observer if necessary. Default is none.
alternate_observer_host_cred_name
Alternate observer host named credential for an operating system user who can access the alternate observer Oracle Home.
failover_threshold
Amount of time in seconds the primary database must be out of contact with the observer and the standby database before a fast-start failover is initiated. Default is 30 seconds.
lag_limit
Amount of time in seconds the standby database is allowed to fall behind the primary database, beyond which a fast-start failover will not be allowed. Default is 30 seconds.
failover_conditions
A comma separated list of failover conditions, that if detected on the primary database, trigger a fast-start failover.
1: Corrupted Controlfile
2: Corrupted Dictionary
3: Inaccessible Logfile
4: Stuck Archiver
5: Datafile Offline
Default is 1, 2, 5
auto_reinstate_primary
Controls whether the observer will automatically reinstate the former primary database once contact is re-established after the former primary database is restarted. Does not control reinstate behavior for failovers caused by an error condition. Default is yes.
auto_shutdown_primary
Controls whether the primary database will shut itself down if it independently discerns that a fast-start failover may have occurred, but cannot verify it due to network isolation from the observer and the standby database. Does not control shutdown behavior for failovers caused by an error condition. Default is yes.
swap_jobs
Specifies that scheduled jobs on either the primary or standby database that are of a transferable type (Backup, RMAN Script, and SQL Script) will be moved to the other database after Enterprise Manager detects a fast-start failover. Default is not enabled.
swap_threshold
Specifies that monitoring settings will be swapped between the primary and standby databases after Enterprise Manager detects a fast-start failover. Default is not enabled.
Examples
Example 1
The following example enables a fast-start failover where the primary target is a single-instance database named dbprimary and the standby target is a single-instance database named dbstandby, with no automatic reinstatement of the former primary database when contact is re-established.
emcli dg_configure_fsfo
-operation="enable"
-primary_target_name="dbprimary"
-primary_target_type="oracle_database"
-standby_target_name="dbstandby"
-standby_target_type="oracle_database"
-auto_reinstate_primary="no"
Example 2
The following example edits a fast-start failover for the primary target single-instance database named dbprimary, changing the standby target to a single-instance database named dbalternate. It also changes the lag limit to 60 seconds and the failover threshold to 40 seconds.
emcli dg_configure_fsfo
-operation="edit"
-primary_target_name="dbprimary"
-primary_target_type="oracle_database"
-standby_target_name="dbalternate"
-standby_target_type="oracle_database"
-lag_limit="60"
-failover_threshold="40"
Converts a physical standby database to snapshot standby database, and vice-versa.
Format
emcli dg_convert_standby
-standby_target_name=""
-standby_target_type="oracle_database|rac_database"
[-standby_db_creds_name=""]
[-standby_host_creds_name=""]
[ ] indicates that the parameter is optional.
Options
standby_target_name
Standby database Enterprise Manager target name. It can be either a single-instance database or a cluster database.
standby_target_type
Standby database target type. The following values are allowed:
oracle_database: Single instance database
rac_database: Cluster database
standby_db_creds_name
Standby database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used.
standby_host_creds_name
Standby database host named credential for an operating system user who can access the standby database Oracle Home. Default Value: Preferred credentials will be used.
Examples
The following example converts the physical standby “database” to snapshot standby database.
emcli dg_convert_standby
-standby_target_name="database"
-standby_target_type="oracle_database"
Performs a Data Guard failover from a primary database to a standby database.
Format
emcli dg_failover
-primary_target_name="<primary target name>"
-primary_target_type="oracle_database|rac_database"
-standby_target_name="<standby target name>"
-standby_target_type="oracle_database|rac_database"
[-primary_db_creds_name="<primary database credential name>"]
[-primary_host_creds_name="<primary database host credential name>"]
[-standby_db_creds_name="<standby database credential name>"]
[-standby_host_creds_name="<standby database host credential name>"]
[-swap_jobs]
[-swap_thresholds]
[-immediate]
Options
primary_target_name
Primary database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
primary_target_type
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
standby_target_name
Standby database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
standby_target_type
Standby database target type. Specify oracle_database for single instance, or rac_database for cluster.
primary_db_creds_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
primary_host_creds_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
standby_db_creds_name
Standby database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
standby_host_creds_name
Standby database host named credential for an operating system user who can access the standby database Oracle Home. Default is to use preferred credential.
swap_jobs
Specifies that scheduled jobs on either the primary or standby database that are of a transferable type (Backup, RMAN Script, and SQL Script) will be moved to the other database after Enterprise Manager detects a fast-start failover. Default is not enabled.
swap_thresholds
Specifies that monitoring settings will be swapped between the primary and standby databases after Enterprise Manager detects a fast-start failover. Default is not enabled.
immediate
Specifies an immediately failover without waiting for all the available redo data to be applied on the standby database. This is the fastest way to failover. However, data may be lost. Without this option, a complete failover will be performed minimizing the data loss. Oracle recommends a complete failover. Default is not enabled.
Examples
Example 1
The following command performs a complete failover from a single-instance primary database named "database" to a cluster standby database named "database1".
emcli dg_failover
-primary_target_name="database"
-primary_target_type="oracle_database"
-standby_target_name="database1"
-standby_target_type="oracle_database"
Example 2
The following command performs an immediate from a cluster primary database named "primary" to a cluster standby database named "standby".
emcli dg_failover
-primary_target_name="primary"
-primary_target_type="rac_database"
-standby_target_name="standby"
-standby_target_type="rac_database"
-immediate
Removes the Data Guard configuration determined from the member database that is a part of the Data Guard configuration.
Format
emcli dg_remove_configuration
-member_target_name="<target name>"
-member_target_type="oracle_database|rac_database"
[-member_db_creds_name="<member database credential name>"]
[-member_host_creds_name="<mamber database host credential name>"]
[-preserve_redo_dests]
[ ] indicates that the parameter is optional.
Options
member_target_name
Enterprise Manager target name of the member database that is a part of the Data Guard configuration. This can be either a single-instance database or a cluster database.
member_target_type
Database target type of the member database that is a part of the Data Guard configuration. The following values are allowed:
oracle_database: Single instance database
rac_database: Cluster database
member_db_creds_name
Database named credential for a user with SYSDBA or SYSDG role of the member database that is a part of the Data Guard configuration. Default Value: Preferred credentials will be used.
member_host_creds_name
Database host named credential for an operating system user who can access the member database Oracle Home. Default Value: Preferred credentials will be used.
preserve_redo_dests
Preserve all archived log destinations configured on the primary database after the Data Guard broker configuration is removed. Redo continues to be shipped to the standby databases. Default Value: Not enabled
Examples
Example 1
The following example removes the dataguard configuration determined from member database named database.
emcli dg_remove_configuration
-member_target_name="database"
-member_target_type="oracle_database"
Example 2
The following example removes the dataguard configuration determined from member database named primary, and the redo continues to be shipped to the standby database.
emcli dg_remove_configuration
-member_target_name="primary"
-member_target_type="rac_database" -preserve_redo_dests
Removes a standby database from a Data Guard configuration.
Format
emcli dg_remove_standby_database
-primary_target_name="<primary target name>"
-primary_target_type="oracle_database|rac_database"
-standby_target_name="<standby target name>"
-standby_target_type="oracle_database|rac_database"
[-primary_db_creds_name="<primary database credential name>"]
[-primary_host_creds_name="<primary database host credential name>"]
[-standby_db_creds_name="<standby database credential name>"]
[-standby_host_creds_name="<standby database host credential name>"]
[-preserve_redo_dests]
[ ] indicates that the parameter is optional.
Options
primary_target_name
Primary database Enterprise Manager target name. This can be either a single-instance database or a cluster database.
primary_target_type
Primary database target type. The following values are allowed:
oracle_database: Single instance database
rac_database: Cluster database
standby_target_name
Standby database Enterprise Manager target name. This can be either a single-instance database or a cluster database.
standby_target_type
oracle_database: Single instance database
rac_database: Cluster database
primary_db_creds_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used.
primary_host_creds_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default Value: Preferred credentials will be used.
standby_db_creds_name
Standby database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used.
standby_host_creds_name
Standby database host named credential for an operating system user who can access the standby database Oracle Home. Default Value: Preferred credentials will be used.
preserve_redo_dests
Preserve the archived log destination configured on the primary database for this standby database after it is removed from the Data Guard broker configuration. Redo will continue to be shipped to this standby database. Default Value: Not enabled.
Examples
Example 1
The following example removes the standby database named database from the dataguard configuration.
emcli dg_remove_standby_database
-primary_target_name="database"
-primary_target_type="oracle_database" -standby_target_name="database1"
-standby_target_type="oracle_database"
Example 2
The following example removes the standby database named standby from the dataguard configuration, and the redo continues to be shipped to this standby database.
emcli dg_remove_standby_database
-primary_target_name="primary"
-primary_target_type="rac_database" -standby_target_name="standby"
-standby_target_type="rac_database" -preserve_redo_dests
Performs a Data Guard switchover between a primary database and a standby database.
Format
emcli dg_switchover
-primary_target_name="<primary target name>"
-primary_target_type="oracle_database|rac_database"
-standby_target_name="<standby target name>"
-standby_target_type="oracle_database|rac_database"
[-primary_db_creds_name="<primary database credential name>"]
[-primary_host_creds_name="<primary database host credential name>"]
[-standby_db_creds_name="<standby database credential name>"]
[-standby_host_creds_name="<standby database host credential name>"]
[-swap_jobs]
[-swap_thresholds]
Options
primary_target_name
Primary database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
primary_target_type
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
standby_target_name
Standby database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
standby_target_type
Standby database target type. Specify oracle_database for single instance, or rac_database for cluster.
primary_db_creds_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
primary_host_creds_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
standby_db_creds_name
Standby database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
standby_host_creds_name
Standby database host named credential for an operating system user who can access the standby database Oracle Home. Default is to use preferred credential.
swap_jobs
Specifies that scheduled jobs on either the primary or standby database that are of a transferable type (Backup, RMAN Script, and SQL Script) will be moved to the other database after Enterprise Manager detects a fast-start failover. Default is not enabled.
swap_thresholds
Specifies that monitoring settings will be swapped between the primary and standby databases after Enterprise Manager detects a fast-start failover. Default is not enabled.
Examples
Example 1
The following command performs a switchover between a primary cluster database named "database" and a standby cluster database named "database1".
emcli dg_switchover
-primary_target_name="database"
-primary_target_type="oracle_database"
-standby_target_name="database1"
-standby_target_type="oracle_database"
Example 2
The following command performs a switchover between a cluster primary database named "primary" and a cluster standby database named "standby". The scheduled jobs and the monitoring settings on "primary" will be moved to "standby" after the switchover is complete.
emcli dg_switchover
-primary_target_name="primary"
-primary_target_type="rac_database"
-standby_target_name="standby"
-standby_target_type="rac_database"
-swap_jobs
-swap_thresholds
Verifies the health of the Data Guard configuration of a primary database and performs the following checks:
- Obtains detailed status information from Data Guard broker for each database.
- Verifies that the redo transport is functioning between the primary and standby databases.
- Verifies the proper configuration of the standby redo log files.
- Verifies that the Data Guard broker properties are consistent with underlying database properties.
- Verifies the status of the Agents for all databases.
- Verifies that the preferred credentials are set for all databases.
When the verification process ends, the following fixes are performed automatically:
- Resolves inconsistencies between broker and database properties.
- Creates standby redo log files for any databases when needed.
Format
emcli dg_verify_config
-primary_target_name="<primary target name>"
-primary_target_type="oracle_database|rac_database"
[-primary_db_creds_name="<primary database credential name>"]
[-primary_host_creds_name="<primary database host credential name>"]
[-reset_inconsistent_props="broker|database"]
[-create_srls]
[-verify_only]
Options
primary_target_name
Primary database Enterprise Manager target name. Can be either a single-instance database or a cluster database.
primary_target_typ
Primary database target type. Specify oracle_database for single instance, or rac_database for cluster.
primary_db_creds_name
Primary database named credential for a user with SYSDBA or SYSDG role. Default is to use preferred credential.
primary_host_creds_name
Primary database host named credential for an operating system user who can access the primary database Oracle Home. Default is to use preferred credential.
reset_inconsistent_props
Resets the inconsistent properties to the broker or the database values. Allowed values:
broker
database
Default is broker.
create_srls
Creates standby redo log files for any database that either have none or do not have the proper number and/or sizes. The files will be created as Oracle-managed files (OMF) for any databases that are configured with OMF.
verify_only
Runs a verification. Neither resolves automatically inconsistent properties nor creates standby redo log files.
Examples
Example 1
The following command verifies the health and resolves inconsistent properties of the cluster primary database named "database".
emcli dg_verify_config
-primary_target_name="database"
-primary_target_type="oracle_database"
Example 2
The following command only verifies the health of the cluster primary database named "primary".
emcli dg_verify_config
-primary_target_name="primary"
-primary_target_type="rac_database"
-verify_only
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
Options
target_type
Type of target. You can specify multiple values.
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
Options
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.
Disables auditing for all user operations.
Format
emcli disable_audit
Example
This example disables auditing for all operations.
emcli disable_audit
Disables configuration history computation for a target type.
Format
emcli disable_config_history
-target_type="{target type|'*'}"
Options
target_type
Target type for which the configuration history is being disabled. The value should be the internal name or "*" to indicate all target types.
Examples
Example 1
This example disables configuration history computation for the host target type.
emcli disable_config_history -target_type="host"
Example 2
This example disables configuration history computation for all target types.
emcli disable_config_history -target_type="*"
Disables the specified MDA finding types for the specified targets. The finding types are disabled for a target only if the finding is applicable for the specified target type and the EM CLI user has permissions on the target.
Format
emcli disable_mda_finding_types_for_targets [-finding_types="<list of finding types>"]
[-targets="<list of targets and their target types>"]
[ ] indicates that the parameter is optional.
Options
finding_types
List of finding types. The default separator to be used is ';'.
targets
List of targets with their target types. The default separator to be used is ';'.
Examples
Example 1
The following example disables a single finding type on a single target:
emcli disable_mda_finding_types_for_targets
-finding_types="oracle.sysman.emas.wls_gc_overhead"
-targets="/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1:weblogic_j2eeserver"
Example 2
The following example disables multiple finding types on multiple targets:
emcli disable_mda_finding_types_for_targets
-finding_types="oracle.sysman.emas.wls_gc_overhead;oracle.sysman.emas.wls_heap_config"
-targets="/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1:weblogic_j2eeserver;/test_base_domain/base_domain/MS1:weblogic_j2eeserver"
Disables an SLA for a target.
Format
emcli disable_sla
-targetName=<target_name>
-targetType=<target_type>
-slaName=<SLA_name>
Options
targetName
Name of the target.
targetType
Type of target.
slaName
Name of the SLA.
Examples
This 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
Disables the Snap Clone feature for a database.
Format
Standard Mode
emcli disable_snapclone
-db_name="<database name>"
Interactive or Script Mode
disable_snapclone(
db_name="<database name>"
)
[ ] indicates that the parameter is optional.
Options
db_name
Name of the database.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example disables the Snap Clone feature for the database testmstr:
emcli disable_snapclone
-db_name="testmstr"
Disables the target on both the Management Repository and Management Agent side.
Syntax
emcli disable_target
-type="target_type1"
-name="target_name1"
-agent="agent_name1"
[-ignore_invalid_target]
[ ] indicates that the parameter is optional.
Options
-type=target_type1
Target type of the target being disabled.
-name=target_name1
Name of the target. You can use the percentage character (%) as a wild character to disable all targets of a specified type on a specified Management Agent.
-agent=agent_name1
Name of the Management Agent on which the target has to be disabled.
-ignore_invalid_target
When specified, the process ignores invalid targets.
Examples
Example 1
The following command disables the target on the Management Agent and OMS and it fails if the target is invalid.
emcli disable_target
-type="oracle_em_service"
-name="TestService"
-agent="TestAgent"
Example 2
The following command disables all the targets of "oracle_em_service" type on the "TestAgent" Management Agent both on the OMS and Management Agent side. It ignores invalid targets.
emcli disable_target
-type="oracle_em_service"
-name="%"
-agent="TestAgent"
-ignore_invalid_target
Disables monitoring of a Services test.
Format
emcli disable_test
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
Options
name
Service target name.
type
Service target type.
testname
Test name.
testtype
Test type.
Examples
This 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'
Removes the association between a user profile and a set of users.
Format
Standard Mode
emcli disassociate_user_profile
-name="profile name"
-users="users to be disassociated"
Interactive or Script Mode
emcli disassociate_user_profile(
name="profile name";
[,description="profile desc"]
[,users="users to be associated"]
[,included_profiles="profile to be included"]
)
Options
name
The name of the user profile that is to be disassociated.
users
The users from whom the profile is to be disassociated.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example disassociates the profile1 user profile from user1 and user2.
emcli disassociate_user_profile
-name=profile1
-users="user1";"user2"
Performs Big Data discovery for the specified host. Can be used for new discovery or for rediscovery of the latest configuration changes.
Format
emcli discover_bda_cluster
-hostname="host_name"
-host_credential="host_named_cred"
-ilom_credential="ilom_named_cred"
-infiniband_credential="ibswitch_named_cred"
-cloudera_credential="cloudera_named_cred"
-snmp_string="SNMP_community_string"
Options
hostname
The name of host in the Big Data Network.
host_credential
Named credentials for the oracle OS account that owns a Management Agent home.
ilom_credential
Named credentials for the root OS account on an Oracle Integrated Lights Out Manager (Oracle ILOM) server in the Big Data Network.
infiniband_credential
Named credentials for the nm2user OS account on an InfiniBand switch in the Big Data Network.
cloudera_credential
Named credentials for the admin account of the Cloudera Manager that manages the CDH cluster.
snmp_string
SNMP community string for PDU and Cisco switch traps. The read-only string is public.
Example
The following example performs BDA cluster discovery on the host named acme101.com. If the cluster already exists, updates the latest configuration.
emcli discover_bda_cluster
-hostname="acme101.com"
-host_credential="HOST_CRED"
-ilom_credential="ILOM_CRED"
-infiniband_credential="IB_CRED"
-cloudera_credential="CM_CRED"
-snmp_string="public"
Discovers the Hadoop cluster for the specified Cloudera Manager host. Can also be used for rediscovery of the latest cluster configuration changes.
Format
emcli discover_cloudera_cluster
-hostname = "host_name"
-cloudera_credential = "cloudera_named_cred"
-host_credential = "host_named_cred"
Options
hostname
Name of one of the hosts that form the cluster.
cloudera_credential
Named credentials for the Cloudera Manager managing the cluster.
host_credential
Named credentials for the specified host.
Example
The following example discovers the Hadoop cluster that includes a host named acme101.com, using the provided named credentials:
emcli discover_bda_cluster
-hostname="acme101.com"
-cloudera_credential="CM_CRED"
-host_credential="HOST_CRED"
Discovers one or more non-managed Coherence clusters (Managed Coherence clusters are discovered as part of the WLS domain discovery process).
Format
emcli discover_coherence
-input_file=coherence_discovery_file:file_path
[-debug]
[ ] indicates that the parameter is optional
Options
input_file
Fully-qualified path to a CSV-formatted file containing one line of details per Coherence cluster. 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 -input_file Syntax Guidelines.
debug
Runs the verb in verbose mode for debugging purposes.
Examples
This 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
Discovers and adds or promotes single instance, Real Application Cluster (RAC) and pluggable databases along with their associated targets, according to the preferences provided in the input file.
Format
Standard Mode
emcli discover_db
-db_discovery_file="db_discovery_file"
[-debug]
[-promote]
[-add_missing_cluster]
[-check]
Interactive or Script Mode
discover_db(
ddb_discovery_file="db_discovery_file"
[,debug=True/False]
[,promote=True/False]
[,add_missing_cluster=True/False]
[,check=True/False]
)
[ ] indicates that the parameter is optional.
Options
db_discovery_file
This file contains the preferences required to add a database.The file must organized into blocks, with each block specific to a particular host or cluster. Each input block includes lines for a host or cluster name, database credentials, and the target type. Optionally, each input block can include discovery hints such as discovery time-out and database status.
Input blocks are separated by an empty line.
Database credentials are given as database name/credentials (user name, password, role) pairs.
If you want to specify common database credentials for all of the databases on a given host, then '*' can be specified instead of the database name.
Specify the database target type as follows:
rac_database in case of a RAC database
oracle_database in case of a single instance database.
Specify ASM credentials as follows:
asm_creds=Username,Password,Role
To add targets to groups, specify the group names separated by commas as follows:
group_names=Group Name 1,Group Name 2,Group Name 3
The names of targets to be added or promoted can include a prefix or a suffix, as follows:
db_name_prefix=Prefix pattern
db_name_suffix=Suffix pattern
The target properties (global or user added properties) can be saved by specifying the input as follows:
global_props=Property 1 Name: Property 1 Value, Property 2 Name: Property 2 Value
user_added_props=Property 1 Name: Property 1 Value, Property 2 Name: Property 2 Value
The structure of the input file when the host name is provided is as follows:
<host_name=Host Machine Name>
<db_creds=Target Name:Username,Password,Role>
<target_type=Target Type -optional>
<discovery_hints - optional>
<asm_creds=Username,Password,Role -optional>
<group_names=Group Name 1,Group Name 2,Group Name 3 -optional>
<db_name_prefix=Prefix pattern -optional>
<db_name_suffix=Suffix pattern -optional>
<global_props=Property 1 Name: Property 1 Value -optional>
<user_added_props=Property 1 Name: Property 1 Value -optional>
The structure of the Input file when the cluster name is provided is as follows:
<cluster_name=Name of the Cluster>
<db_creds=Target Name:Username,Password,Role>
<target_type=Target Type -optional>
<discovery_hints - optional>
<asm_creds=Username,Password,Role -optional>
<group_names=Group Name 1,Group Name 2,Group Name 3 -optional>
<db_name_prefix=Prefix pattern -optional>
<db_name_suffix=Suffix pattern -optional>
<global_props=Property 1 Name: Property 1 Value -optional>
<user_added_props=Property 1 Name: Property 1 Value -optional>
-----------------
cluster_name=slc00dsno-cls
db_creds=db1:sys,oracle,SYSDBA
db_creds=db2:sys,welcome,SYSDBA
target_type=oracle_database
asm_creds=sys,oracle,SYSDBA
group_names=group1,group2
cluster_name=slc00dtfg-r
db_creds=*:sys,oracle,SYSDBA
target_type=rac_database
db_status=up
db_name_prefix=prefix_
db_name_suffix=_suffix
global_props=Comment:Test,Contact:4444,Cost Center:CC
For example, the contents of the file can be (2 blocks of input in the file):
-----------------
host_name=slc00dsn.mycompany.com
db_creds=db1:sys,oracle,SYSDBA
db_creds=db2:sys,welcome,SYSDBA
target_type=oracle_database
asm_creds=sys,oracle,SYSDBA
group_names=group1,group2
host_name=slc00dtf.mycompany.com
db_creds=*:sys,oracle,SYSDBA
target_type=rac_database
db_status=up
db_name_prefix=prefix_
db_name_suffix=_suffix
global_props=Comment:Test,Contact:4444,Cost Center:CC
debug
Specifies if debug is on or off.
promote
Promotes targets obtained from auto discovery.
add_missing_cluster
Adds the cluster in case the mentioned host is valid and the corresponding cluster is not added.
check
Runs discovery and shows the results. It does not add the targets.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example discovers a database target and promotes it:
emcli discover_db
-input_file=db_discovery_file:/emcli/test.txt <-debug> <-promote> <-add_missing_cluster> <-check>
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
Options
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 Options - 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 -input_file Syntax Guidelines.
input_file=host_agent_mapping_file
Fully-qualified path to a CSV-formatted file containing multiple lines of host system names where Managed Servers are to be monitored, and the Agent to be used to monitor each host's Managed Servers.
For example:
mycompany.com,https://mco01.mycompany.com:3872/emd/main
For information about the input_file parameter, see -input_file Syntax Guidelines.
input_file=pf_domain_cred_mapping_file
Fully-qualified path to a CSV-formatted file containing multiple lines of WebLogic admin credentials for each domain of a fusion instance, where the credentials are different from those added in the fa_domain_discovery file.
The same credentials are used for all the domains in a Fusion Application instance unless the credentials are overwritten in the pf_domain_cred_mapping file.
For example:
<UniqueKey - "<Fusion Instance
Identifier><CommonDomainDisplayName>">,<Administration Server
username>,<Administration Server password>,
<UniqueKey - "<Fusion Instance
Identifier>-<CommonDomainDisplayName>">,<Administration Server
username>,<Administration Server password>,<Administration Server Host
Name>
Example:
fi9-FS,weblogic12,welcome1,
fi9-PRJ,faadmin,fusionfa1,
fi9-PRC,faadmin,fusionfa1,myhost.us.example.com
fi9-PRC,,,myhost.us.example.com
For information about the input_file parameter, see -input_file Syntax Guidelines.
debug
Runs the verb in verbose mode for debugging purposes.
Examples
Example 1
This example reads the my_domains_info.csv file to determine the Fusion Instances to be added to Cloud Control, reads the my_agent_mapping.csv file to determine which Agents should monitor which host's Managed Servers, and reads the my_domain_cred_mapping.csv file to determine which credentials are to be used to discover an individual product family.
emcli discover_fa
-input_file=fa_domain_discovery_file:c:\emcli\my_domains_info.csv
-input_file=host_agent_mapping_file:c:\emcli\my_agent_mapping.csv
-input_file=pf_domain_cred_mapping_file:c:\emcli\my_domain_cred_mapping.csv
Example 2
emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_filee:/tmp/emcli/ host_agent_mapping_file.txt -input_file=pf_domain_cred_mapping_file:/tmp/emcli/ pf_domain_cred_mapping_file.txt -debug
Discovers Multiple GlassFish Domains by reading the Domain Discovery file and saving the discovered targets of the host to the Agents provided in the Host Agent Mapping file. If the Host Agent mapping file is not provided, the local Agent (the Agent on the same host as the target) is used to save/monitor the discovered targets. If a local Agent is not found, the default discovery Agent is used to save/monitor the discovered targets.
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
Options
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 Options - 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 -input_file Syntax Guidelines.
input_file=host_agent_mapping_file
Fully-qualified path to a CSV-formatted file containing multiple lines of host system names where Managed Servers are to be monitored, and the Agent to be used to monitor each host's Managed Servers. The structure of the CSV file is as follows:
<target_host1>,<save_to_agent1> <target_host2>,<save_to_agent3>
For example:
mycompany.com,https://mco01.mycompany.com:3872/emd/main
For information about the input_file parameter, see -input_file 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
Discovers a JBoss target in Oracle Enterprise Manager. JBoss targets include JBoss JEE servers, JBoss application servers, JBoss domains, and JBoss partitions (for example, jboss_jeeserver, jboss_app_server , jboss_domain or jboss_partition).
For additional information on how to use the discover_jboss EM CLI verb, refer to Oracle Enterprise Manager Command Line Interface documentation available on the Oracle Technology Network.
Format
emcli discover_jboss
-host
-version
-port
-agent
-auth_type
[-username]
[-password]
[-debug]
[ ] indicates that the parameter is optional.
Options
host
Fully qualified name of the JBoss host in the case of a standalone/JBoss 6 target or fully qualified name of the JBoss Domain Controller in the case of a domain based discovery.
version
JBoss target version (only versions 6 and 7 are allowed).
port
HTTP management port/JMX connector port.
agent
Monitoring Agent.
auth_type
JBoss authentication type (digest_authentication, basic_authentication, or none). Digest authentication is not allowed for JBoss 6 targets.
username
JBoss host user name.
password
JBoss host password.
debug
Runs the verb in verbose mode for debugging purposes.
Examples
Example 1
The following example discovers JBoss targets of version 7 in Oracle Enterprise Manager.
emcli discover_jboss
-host=host1.example.com
-version=7
-port=1234
-agent=host1.example.com:31453
-auth_type=digest_authentication
-username=jboss
-password=jboss123
Example 2
The following example discovers JBoss targets of version 6 in Oracle Enterprise Manager.
emcli discover_jboss
-host=host1.example.com
-version=6
-port=1234
-agent=host1.example.com:31453
-auth_type=none
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
Options
input_file
The input file should be in a CSV format. The structure of the CSV file is as follows:
GATEWAY_HOST = < Gateway Server Host >, PORT = < Gateway Server Port - optional Default if not specified is 2320 >, INSTALL_DIR = < Gateway Server Install Directory - optional >, ENTERPRISE_NAME = < Siebel Enterprise Name >, SIEBEL_USERNAME = < Siebel Enterprise User Name >, SIEBEL_PASSWORD = < Siebel Enterprise Password >, DATABASE_USERNAME = < Database User Name >, DATABASE_PASSWORD = < Database Password >
Note:
INSTALL_DIR is a mandatory parameter for discovering Siebel version 8.2.2 and above.
This example shows discovery of a Siebel Enterprise (siebel) with the gateway located at host 'host1', installed at location 'Location1' and running at port '23201', with a Siebel user name and password of 'sbluser' and 'SBLpass' respectively, and a database user name and password of 'dbuser' and 'DBpass' respectively.
GATEWAY_HOST=host1,PORT=23201,INSTALL_DIR=Location1, ENTERPRISE_NAME=siebel,SIEBEL_USERNAME=sbluser, SIEBEL_PASSWORD=SBLpass,DATABASE_USERNAME=dbuser, DATABASE_PASSWORD=DBpass
Special cases for commas:
If any entry, such as a password, has a comma ( , ) you need to add it as a backslash comma ( \, ) in the CSV file. For instance, if SIEBEL_PASSWORD is we,lco,me1 the entry in the CSV file would be SIEBEL_PASSWORD = we\,lc\,ome1 .
If any entry, such as a password, has a backslash followed by a comma( \, ) you need to add it as as two backslashes followed by a comma( \\, ) in the CSV file. For instance, if SIEBEL_PASSWORD is we\,lco\,me1 the entry in the CSV file would be SIEBEL_PASSWORD = we\\,lc\\,ome1 .
For information about the input_file parameter, see -input_file Syntax Guidelines.
out_file
Command output is redirected to this file. If not specified, output is printed on the console.
debug
Executes in verbose mode and generates additional debug log messages in the output. If specified, detailed output is printed.
precheck
Performs a mock discovery of the Siebel enterprise by executing all of the checks and validations. This option lists the results of these steps to the user for review prior to an actual discovery. It ensures that all prerequisite are met, and discovery does not occur if prerequisites are met.
Examples
Example 1
This example reads the my_enterprise_info.csv file to determine the Siebel Enterprise instances to be added to Cloud Control. The output of the command is redirected to the discovery_output.txt file.
emcli discover_siebel
-input_file=enterprise_info_file:'c:\emcli\my_enterprise_info.csv'
-out_file='c:\emcli\discovery_output.txt'
-debug
Example 2
This example is the same as the example above, except it adds the -precheck option, which confirms if the precheck is successful, or shows errors if it failed.
emcli discover_siebel
-input_file=enterprise_info_file:'c:\emcli\my_enterprise_info.csv'
-out_file='c:\emcli\discovery_output.txt'
-debug
Discovers an IBM Websphere target in Oracle Enterprise Manager. Targets include an IBM Webshpere cell or an IBM Websphere JEE server (for example,websphere_cell or websphere_jeeserver).
For additional information on how to use the discover_was EM CLI verb, refer to Oracle Enterprise Manager Command Line Interface documentation available on the Oracle Technology Network.
Format
emcli discover_was -host -port -version -key_file -dir -agent [-username] [-password] [-debug] [ ] indicates that the parameter is optional.
Options
host
Fully qualified name of the host where the WebSphere Application Server is running.
version
Websphere Application Server version. Versions 6.0, 6.1, 7.0, 8.0 or 8.5 are allowed.
port
SOAP connector port of the server.
key_file
The absolute path of the Monitoring Agent Trust file. This option is required if the port is SSL enabled.
dir
The absolute path of the directory where Deployment Manager is installed. For remote discovery, specify the path of the directory on the Agent Host where the required jar files have been copied.
agent
Monitoring Agent.
username
Websphere host username if security is enabled
password
Websphere host password if security is enabled.
debug
Runs the verb in verbose mode for debugging purposes.
Examples
Example 1
The following example discovers targets in an IBM Websphere cell.
emcli discover_was
-host=host1.example.com
-version=8.5
-port=1234
-key_file=/path/to/monitoring/agent/trust/store/file
-dir=/to/websphere/server/install/home
-agent=host1.example.com:12345
-username=was
-password=was123
Example 2
The following example discovers a standalone IBM Websphere application server.
emcli discover_was
-host=host1.example.com
-version=8.5
-port=1234
-key_file=/path/to/monitoring/agent/trust/store/file
-dir=/path/to/websphere/server/install/home
-agent=host1.example.com:12345
-username=was
-password=was123
Note:
The following Weblogic Server versions are supported in Enterprise Manager 13.2:
12.2.1.x, 12.1.3.x, 12.1.2.x
10.3.6.x, 10.3.5.x, 10.3.4.x, 10.3.3.x, 10.3.2.x, 9.2.x
The information in this section applies only to these versions.
Purpose
Used to discover one or more WebLogic Domains (along with Oracle Fusion Middleware 11g and 12c software deployed to it), and to specify which Management Agent should monitor which hosts' Managed Servers.
Function
This verb discovers one or more Oracle WebLogic Server Domains. It reads a file labeled domain_discovery_file to discover WebLogic Server. 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 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]
[-input_file=global_target_props_file:file_path]
[-debug]
[ ] indicates that the parameter is optional
Options
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. 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:
Options —
The order of parameters is fixed. You must provide the parameters in the same order as shown for domain_discovery_file in the "File Structures" section below.
If you want to use a comma ( , ) in any of the parameters provided, you must escape the comma with a backslash as shown in This example, in which a backslash precedes the comma in the password my,pwd:
10,domain123.xyx.us,11990,weblogic,my\,pwd,,,farm_demo,https://myco01.mycompany.com:3872/emd/main/
Delimeters and Requirements —
Use a comma ( , ) as the delimiter.
Delimiters must be present even if the corresponding parameter is not provided. See the last line for domain_discovery_file in the "File Structures" section below.
If you want to use a comma (,) in one of the parameters provided, you must escape the comma (,) with a backslash. In This example, the password contains a comma:
10,mco01.mycompany.com,7001,weblogic,welco\,me1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/
If you want to use a backslash in one of the parameters provided, you must escape the backslash with another backslash. In This example, the password contains a backslash:
10,mco01.mycompany.com,7001,weblogic,we\,lco \ \ me1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/,true,false
<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>
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 -input_file Syntax Guidelines.
input_file=host_agent_mapping_file
Fully-qualified path of the CSV (Comma-Separated Values) formatted file that contains multiple lines of host system names where managed servers are to be monitored, and specifies the Management Agent used to monitor each host's managed servers. 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 -input_file Syntax Guidelines.
input_file=disable_target_types_file
Fully-qualified path to a CSV (Comma-Separated Values) formatted file containing multiple lines of internal target type names that should not be discovered.
For example:
oracle_soa_composite j2ee_application
If the discover_wls verb is run against a Fusion Applications WebLogic Server domain, the disabled target types can include Fusion Applications target types.
global_target_props_file
Fully qualified path to a CSV formatted file containing target properties. The structure of the file is as follows:
<Administration Server host machine name>,
<Administration Server listen port>,
<Comment>,
<Contact>,
<Cost Center>,
<Department>,
<Life Cycle Status. Valid Values: None, Mission Critical, Production, Staging, Test, Development>,
<Line Of Business>,
<Location>,
<Apply to all targets - true/false. Default is false>
To set global properties for a domain specified in a discovery input file, the administration server host and administration server port specified in the global properties file should match host and port specified in domain discovery input file.
debug
Runs this verb in verbose mode for debugging purposes.
File Structures
domain_discovery_file for WebLogic Server versions
This example shows the structure of a sample domain_discovery_file for WebLogic Server. OPT signifies an optional parameter. The last entry shows the format when optional parameters External Options, JMX Protocol, JMX Service URL, Management Agent URL, Node Manager Username, and Node Manager Password are not provided.
<WebLogic Server version>, <Administration Server host machine name>, <Administration Server listen port>, <Administration Server username>, <Administration Server password>, <External Options - 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>, <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> <Node Manager Username> - optional - Default if not specified is the Administration Server Username> <Node Manager Password> - optional - Default if not specified is the Administration Server password>
For example:
10,mco01.mycompany.com,7001,weblogic,welcome1,,,,my_farm_01,https://mco01.mycompany.com:3872/emd/main/,false,false,NodeUsername,NodePassword
Definitions for the parameters are as follows:
WebLogic Server Version
Valid values are 9, 10, or 12. This example shows a sample entry in domain_discovery_file to discover WebLogic Server version 10:
10,myco01.mycompany.com,7001,weblogic,welcome1,,,,soa_farm, https://myco02.mycompany.com:8723/emd/main/
Administration Server Host
Full host name of the WebLogic Administration Server that needs to be discovered; for example, myco01.mycompany.com. This is a mandatory parameter.
Port
Listen port of the WebLogic Administration Server.
Username
Login user name for the WebLogic Administration Server.
Password
Login password for the WebLogic Administration Server.
External Options
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 Service URL
Makes a JMX connection to the Administration Server. If you do not specify this option, it is created based on the input parameters.
Unique Domain Identifier
Creates a unique target name. This option 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.
Discover App Versions
Optional - Default if not specified is true
If only the active version of the app is needed, then set it to false.
Enable Refresh Job
Optional - Default if not specified is false
If you would like to perform a daily job to refresh the domain discovery, then set this to true.
Use Host Name in Service URL
Optional - Default if not specified is false
Create Incident for Discovery Failure
Optional - Default if not specified is false
Node Manager Username
Optional - Default if not specified is Administration Server Username
If you would like the Node Manager discovered as a target to be monitored, then username/password are required.
Node Manager Password
Optional - Default if not specified is Administration Server Password
Examples
This example reads the my_domains_info.csv file to determine the domains to be added to Cloud Control, and reads the my_agent_mapping.csv file to determine which Management Agents should monitor which host's managed servers.
emcli discover_wls
-input_file=domain_discovery_file:\emcli\my_domains_info.csv
-input_file=host_agent_mapping_file:\emcli\my_agent_mapping.csv
-debug
This example manually redirects the output of discover_wls to a file using standard output redirect.
emcli discover_wls input_file=domain_discovery_file:"<fully_qualified_path_of_domain_discovery_file/domain_discovery_file.csv>" > /tmp/emcli/output_file.out
Discovers an IBM Websphere MQ target in Oracle Enterprise Manager. IBM Websphere MQ targets include an individual IBM Websphere MQ target or IBM Websphere MQ clusters (for example, wmq_cluster or wmq).
Format
emcli discover_wmq
-host
-port
-username
-jarpath
[-channel]
-agent
[-disc_pref]
-password
[-debug]
[ ] indicates that the parameter is optional.
Options
host
Fully qualified name of the host or the IP address of the host on which the Webshpere MQ Queue Manager is running.
port
TCP/IP listener port of the Websphere MQ Queue Manager.
username
User name of the user who has access to the Websphere MQ Queue Manager.
jarpath
The absolute path of the required jar files wherein each of them should be separated by colon in case of Linux and semicolon in case of Windows.
channel
The name of the Server Connection Channel to be used for monitoring. The Server Connection Channel should be of type SVRCONN, for example: SYSTEM.DEF.SVRCONN.
agent
Monitoring Agent.
disc_pref
The value of discovery preference should be set to 'true' if the discovery has to be restricted to a single Websphere MQ Queue Manager. If it is not specified it is considered as false.
password
Websphere MQ password if security is enabled.
debug
If specified, runs the verb in verbose mode for debugging purposes.
Examples
Example 1
The following example discovers IBM Websphere MQ targets by specifying jarpath for Linux in Oracle Enterprise Manager.
emcli discover_wmq -host=host1.example.com -port=1416 -username=mqm -jarpath=/install/home/com.ibm.mq.commonservices.jar:/install/home/com.ibm.mq.headers.jar:/install/home/com.ibm.mq.jar:/install/home/com.ibm.mq.jmqi.jar:/install/home/com.ibm.mq.pcf.jar:/install/home/connector.jar -channel=SYSTEM.DEF.SVRCONN -agent=host1.example.com:12345 -password=admin
Example 2
The following example discovers IBM Websphere MQ targets by specifying jarpath for Windows in Oracle Enterprise Manager.
emcli discover_wmq -host=host1.example.com -port=1416 -username=mqm -jarpath=/install/home/com.ibm.mq.commonservices.jar;/install/home/com.ibm.mq.headers.jar;/install/home/com.ibm.mq.jar;/install/home/com.ibm.mq.jmqi.jar;/install/home/com.ibm.mq.pcf.jar;/install/home/connector.jar -channel=SYSTEM.DEF.SVRCONN -agent=host1.example.com:12345 -password=admin
Describes the captures (and replays) contained in a directory.
Output Columns: Entity Name, Database Name, Start Time, Status.
Sample XML File:
<?xml version="1.0" encoding="UTF-8"?>
<cliImportData xmlns="http://xmlns.oracle.com/sysman/db/dbreplay">
<targetName>database</targetName>
<targetType>oracle_database</targetType>
<dbHostName>host.example.com</dbHostName>
<dbCredRef>
<credName>testDB121</credName>
<credOwner>sysman</credOwner>
</dbCredRef>
<dbHostCredRef>
<credName>testDBHost121</credName>
<credOwner>sysman</credOwner>
</dbHostCredRef>
<directoryPath>/storage/dbr/copyDir_task4Caps</directoryPath>
<consolidatedDirectory>true</consolidatedDirectory>
</cliImportData>
Format - Standard Mode
emcli discover_workloads [-input_file="template:<input file path>"] [-include_replays] [-format="[name:<pretty|script|csv>];[column_separator:"column_sep_string"];[row_separator:"row_sep_string"]"]
Format - Interactive or Script Mode
discover_workloads( [input_file="template:<input file path>"] [,include_replays=True/False] [,format="[name:<pretty|script|csv>];[column_separator:"column_sep_string"];[row_separator:"row_sep_string"]"] ]
Options
input_file
Fully qualified path to an XML file containing parameters for the verb.
include_replays
Describes the replays, in addition to the captures, that are contained in a directory.
format
Specifies how the output is formatted. The default value is "name:pretty". You can use this option in the following ways:
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 in the output. You can override the column and row separator strings with your own values.
format="name:script;column_separator:<column_sep_string>" Causes the verb output to be column-separated by <column_sep_string>. Rows are separated by the newline character.
format="name:script;row_separator:<row_sep_string>" Causes the verb output to be row-separated by <row_sep_string>. Columns are separated by the tab character.
format="name:script;column_separator:<column_sep_string>;row_separator:<row_sep_string>" Causes the verb output to be column-separated by <column_sep_string> and row-separated by <row_sep_string>.
format="name:csv" Sets the default column separator to a comma and the default row separator to a newline in the output.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Examples
Example 1 - Standard Mode
The following example describes the captures and replays contained in a directory.
emcli discover_workloads -include_replays -input_file=template:/storage/xml/import4Captures.xml
Example 2 - Interactive or Script Mode
The following example describes the captures and replays contained in a directory.
discover_workloads(include_replays=True, input_file="template:/storage/xml/import4Captures.xml" )
Example 3 - Standard Mode
The following example describes only the captures contained in a directory.
emcli discover_workloads -input_file=template:/storage/xml/import4Captures.xml
Example 4 - Interactive or Script Mode
The following example describes only the captures contained in a directory.
discover_workloads(input_file="template:/storage/xml/import4Captures.xml" )
See Also
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
Options
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
This example downloads the databank corresponding to alias1 for the specified test.
emcli download_ats_test_databank_file -name="Service Name"
-type="generic_service"
-testname="Test Name"
-testtype="OATS"
-databankAlias="alias1"
Example 2
This example downloads all databanks corresponding to the specified test.
emcli download_ats_test_databank_file -name="Service Name"
-type="generic_service"
-testname="Test Name"
-testtype="OATS"
Downloads the zip bundle corresponding to the specified ATS test.
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
Options
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"
Downloads an update.
Format
emcli download_update
-id="internal id"
Options
id
Internal identification for the update to be downloaded.
Examples
This example submits a job to download an update, and prints the job execution ID upon submission.
emcli download_update
-id="914E3E0F9DB98DECE040E80A2C5233EB"
Prints the list of all current activities.
Format
emcli dump_activity_list
Edits the schedule and purge policy of an existing database profile.
Format
emcli edit_dbprofile
-comp_loc="Database Profile component location in software library"
[-schedule= [NONE]|[frequency:interval|weekly|monthly|yearly];
start_time:yy-MM-dd HH:mm;
end_time:yy-MM-dd HH:mm;
[repeat:#m];
[months:#,#,#,...];
[days:#,#,#,...];
[tz:{java timezone ID}];
[grace_period:xxx];
]
[-purge_policy= DAYS|SNAPSHOTS: number]
[ ] indicates that the parameter is optional.
Options
comp_loc
A combination of the database profile location and name.
schedule
frequency: The frequency type with which the databse profile will be created. It can be an interval (in minutes), weekly, monthly, or yearly.
start_time: Denotes the start time of Database Profile Component Creation in the format yy-MM-dd HH:mm.
end_time: Denotes the end time of Database Profile Component Creation Repetition in the format yy-MM-dd HH:mm
repeat: The repetition rate at which database profile will be created. If the frequency is an interval, then repeat is in minutes.
months: The number of months after which the repetition of Database Profile Component Creation will occur.
days: The number of days after which repetition of Database Profile Component Creation will occur.
tz: The time zone ID, for example tz:America/New_York.
grace_period: A period of time in minutes that defines the maximum permissible delay when attempting to create a databasse profile. If the job system cannot start the execution within a time period equal to the scheduled time plus the grace period, it will set the create database profile to be skipped. By default, the grace period is indefinite.
purge_policy
You can purge the collected data based on a specified number of days (DAYS) or a count of snapshots (SNAPSHOT). If the purge_policy parameter is not specified, then it is defaulted to NONE.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example edits the schedule and purge policy database profile RMAN_Profile with the location Database Provisioning Profiles/11.2.0.4.0/linux_x64.
emcli edit_dbprofile -comp_loc="Database Provisioning Profiles/11.2.0.4.0/linux_x64/RMAN_Profile"
-schedule="frequency:interval;start_time:14-10-05 05:30;end_time:
14-10-12 05:23;repeat:30;grace_period:60;tz:America/New_York"
-purge_policy=DAYS:2
Edits the service-level rule for the specified service.
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
Options
name
Identifies the target name.
type
Identifies the target type. Use emcli get_targets to get the target type.
expSL
Specifies the expected service-level rule. Values must be any number between 0 and 100.
repeatSequence
Specifies the days in which the service-level rule is to be applied. Identify the days value from these comma-separated values: MON, TUE, WED, THU, FRI, SAT, SUN.
startTime
Specifies the time of day that the application of the service-level rule is to begin. Enter the time format as: HH:min
endTime
Specifies the time of day that the application of the service-level rule is to end. Enter the time format as: HH:min
availStatesInclude
Specifies the availability states (apart from UP) that are to be included while computing the service-level rule. Values are: BLACKOUT|UNKNOWN
availStatesExclude
Specifies the availability states (apart from UP) that are to be excluded while computing the service-level rule. Values are: BLACKOUT|UNKNOWN
Examples
Example 1
Update the MyService service-level rule to begin at 6 a.m. on Mondays and Tuesdays:
emcli edit_sl_rule
-name="MyService"
-type="generic_service"
-expSL="90.0"
-repeatSequence="MON,TUE"
-startTime="06:00"
-endTime="23:00"
-availStatesInclude="BLACKOUT"
-availStatesExclude="UNKNOWN"
Sets the storage ceiling for a storage pool.
Format
Standard Mode
emcli edit_storage_ceiling
-storage_name="<storage name>"
-pool_name="<pool name>"
-storage_ceiling="<storage ceiling in GB>"
Interactive or Script Mode
edit_storage_ceiling(
storage_name="<storage name>"
,pool_name="<pool name>"
,storage_ceiling="<storage ceiling in GB>"
)
[ ] indicates that the parameter is optional.
Options
storage_name
Name of the storage.
pool_name
Name of the storage pool.
storage_ceiling
Storage Ceiling to be set on the storage pool.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example sets the storage ceiling for a storage pool sunzfs1:
edit_storage_ceiling
-storage_name="sunzfs1"
-pool_name="pool-01"
-storage_ceiling="100"
Adds or removes an activation credential for an Oracle Auto Service Request (ASR) target.
Format
Standard Mode
emcli em_asr_asset_actcred
[-targetName="Target Name"]
[-targetType="Target Type"]
[-mosid="MOS user name"]
[-passwd="MOS user password"]
Interactive or Script Mode
em_asr_asset_actcred(
[,targetName="Target Name"]
[,targetType="Target Type"]
[,mosid="MOS user name"]
[,passwd="MOS user password"]
)
[ ] indicates that the parameter is optional.
Options
targetName
Identifies the target name.
targetType
Identifies the target type.
mosid
Valid My Oracle Support (MOS) user name.
passwd
MOS user password.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Assigns the global activation credentials. User will be prompted to enter their MOS user password.
Standard Mode
emcli em_asr_asset_actcred
-add -mosid="MOS_user_name"
Interactive or Script Mode
em_asr_asset_actcred(add=True,
mosid="MOS_user_name"
)
Example 2
Assigns the target activation credentials. User will be prompted to enter their MOS user password.
Standard Mode
emcli em_asr_asset_actcred
-targetName="ASR_target1"
-targetType="host"
-mosid="MOS_user_name"
Interactive or Script Mode
em_asr_asset_actcred(
targetName="ASR_target1",
targetType="host",
mosid="MOS_user_name"
)
Downloads a CSV file with activation details about all Oracle Auto Service Request (ASR) targets.
Format
Standard Mode
emcli em_asr_asset_activation_details
Interactive or Script Mode
em_asr_asset_activation_details()
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Manages the Oracle Auto Service Request (ASR) activation job. Use this verb to show the job status, start the job, or reschedule it.
Note:
Only the Enterprise Manager super user can perform this operation.
Format
Standard Mode
emcli em_asr_asset_activation_job
[-start]
[-rescheduleNow]
Interactive or Script Mode
em_asr_register(
[start=True/False]
[,rescheduleNow=True/False]
)
[ ] indicates that the parameter is optional.
Options
start
Starts the activation job to run daily (including today) at the current time, if not started.
rescheduleNow
Reschedules the activation job to run daily (including today) at the current time, if it is already scheduled.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Shows the status of the activation job:
Standard Mode
emcli em_asr_asset_activation_job
Interactive or Script Mode
em_asr_asset_activation_job()
Example 2
Starts an activation job, if not already scheduled. An error is returned if the activation job is already scheduled.
Standard Mode
emcli em_asr_asset_activation_job
-start
Interactive or Script Mode
em_asr_asset_activation_job(
start=True
)
Adds or removes targets to or from the Oracle Auto Service Request (ASR) exclude list.
Format
Standard Mode
emcli em_asr_asset_exclude_list
[-add]
[-remove]
[-all]
[-targetName="Target Name"]
[-targetType="Target Type"]
Interactive or Script Mode
em_asr_asset_exclude_list(
[add=True/False]
[,remove=True/False]
[,all=True/False]
[,targetName="Target Name"]
[,targetType="Target Type"]
[ ] indicates that the parameter is optional.
Options
add
Adds ASR targets to the exclude list.
remove
Removes ASR targets from the exclude list.
all
Sets a flag to select all eligible ASR targets.
targetName
Identifies the target name.
targetType
Identifies the target type.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Adds a specific target to the Oracle ASR exclude list:
Standard Mode
emcli em_asr_asset_exclude_list
-add
-targetName="ASR_target1"
-targetType="host"
Interactive or Script Mode
em_asr_asset_exclude_list(
add=True,
targetName="ASR_target1",
targetType="host"
)
Example 2
Removes all targets from the Oracle ASR exclude list:
Standard Mode
emcli em_asr_asset_exclude_list
-remove
-all
Interactive or Script Mode
em_asr_asset_exclude_list(
remove=True,
all=True
)
Adds or removes target to or from the Oracle Auto Service Request (ASR) include list.
Format
Standard Mode
emcli em_asr_asset_include_list
[-add]
[-remove]
[-all]
[-targetName="Target Name"]
[-targetType="Target Type"]
Interactive or Script Mode
em_asr_asset_include_list(
[add=True/False]
[,remove=True/False]
[,all=True/False]
[,targetName="Target Name"]
[,targetType="Target Type"]
[ ] indicates that the parameter is optional.
Options
add
Adds targets to the Oracle ASR include list.
remove
Removes targets from the Oracle ASR include list.
all
Sets a flag to select all eligible ASR targets.
targetName
Identifies the target name.
targetType
Identifies the target type.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Adds all targets to the Oracle ASR include list:
Standard Mode
emcli em_asr_asset_include_list
-add
-all
Interactive or Script Mode
em_asr_asset_include_list(
add=True,
all=True
)
Example 2
Removes all targets from the Oracle ASR include list:
Standard Mode
emcli em_asr_asset_include_list
-remove
-all
Interactive or Script Mode
em_asr_asset_include_list(
remove=True,
all=True
)
Removes the Oracle Auto Service Request (ASR) registration and incident rules associated with Oracle ASR.
Note:
Only the Enterprise Manager super user can perform this operation.
Format
Standard Mode
emcli em_asr_deregister
[-all]
-default
Interactive or Script Mode
em_asr_deregister(
[all]
,default
)
[ ] indicates that the parameter is optional.
Options
all
Removes all Oracle ASR user registration and incident rules associated with Oracle ASR.
default
Removes only the Oracle ASR user registration associated with Oracle ASR.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Removes the Oracle ASR user registration and incident rules:
emcli em_asr_deregister
-all
Example 2
Removes only the Oracle ASR user registration:
emcli em_asr_deregister
-default
Enables Oracle Auto Service Request (ASR) functionality in Enterprise Manager. My Oracle Support (MOS) credentials are used to activate any new asset discovered for ASR.
Note:
Only the Enterprise Manager super user can perform this operation.
Format
Standard Mode
emcli em_asr_register
-mosid="My Oracle Support (MOS) user name"
[-passwd = <My Oracle Support (MOS) user password>]
[-dontStartJob = <Do not start activation job as part of registration>]
Interactive or Script Mode
em_asr_register(
mosid="mosid"
[,passwd = <My Oracle Support (MOS) user password>]
[,dontStartJob = <Do not start activation job as part of registration>]
)
[ ] indicates that the parameter is optional.
Options
mosid
Valid My Oracle Support (MOS) user name.
passwd
MOS user password.
dontStartJob
Flag to tell if activation job should not be started.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Enables ASR and starts the activation job:
emcli em_asr_register
-mosid="user1@123.com"
Example 2
Enables ASR but do not start the activation job:
emcli em_asr_register
-mosid="user1@123.com"
-dontStartJob
Uses an XSL file location and content to generate a create, update, or close service request (SR) message for Oracle Auto Service Request (ASR) as input and updates it to the OMS.
Note:
Only the Enterprise Manager super user can perform this operation.
Format
Standard Mode
emcli em_asr_xsl_upload
-input_file="xsl_file:<full filepath>"
Interactive or Script Mode
em_asr_xsl_upload(
input_file="xsl_file:<full filepath>"
)
Options
input_file
The full path of the XSL template file.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
Example 1
Uploads an XSL file to the OMS:
emcli em_asr_xsl_upload
-input_file="xsl_file:/tmp/scratch/myfile1.xsl"
Performs TDE operations on a given target database.
Format
emcli tde
-target_name="target_name"
-target_type="target_type"
-operation="operation"
-connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "DBNamedCreds:unamedcreds" or "DBCredsOwner:ucredsowner;DBNamedCreds:unamedcreds"
[-wallet_password="wallet_password"]
[-wallet_new_password="new_wallet_password"]
[-wallet_location="wallet_location"]
[-keystore_type ="HSM"]
[-keystore_status ="open"]
[-tablespace="tablespace"]
[-backup_id="new_backup_101"]
[-backup_location="\scratch\oracle\wallet\"]
[-algorithm="algorithm"]
[-master_key_tag="NEW MASTER KEY"]
[-keep="yes/no" default "no" ]
[-encrypted="yes/no" default "no" ]
[-validate_only="yes/no" default "no"]
[ ] indicates that the parameter is optional.
Options
target_name
The name of the target.
target_type
The type of the target. The default value for this argument is oracle_database. The possible values are: oracle_database and rac_database.
operation
The name of the tde operation. It is case sensitive. The following operations are supported in tde: rekey, open_keystore, close_keystore, make_tablespace_offline, make_tablespace_online, encrypt_tablespace_online, decrypt_tablespace_online, rekey_tablespace_online, finish_tablespace_online, encrypt_tablespace_offline, and decrypt_tablespace_offline.
master_key_tag
From 12.1 database version, the administrator can provide tag to identify the master key with rekey operation. This is an optional parameter, by default "NEW MASTER KEY" would be used as the TAG.
connect_as
This option enables the user to change the password of a different user without logging in as that user. It should be specified in any of following formats: -- "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" and -- "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds". If this is not specified, the password will be changed by self.
wallet_password
In the context of rekey, close, and open operation, wallet password is required to perform the TDE wallet management operation.
wallet_new_password
In the context of change password operation, new wallet password is required to change password.
wallet_location
In the context of TDE wallet management operation, wallet location is required to identify the wallet.
keystore_type
In the context of list_databases operation, keystore_type option can be used to filter the result.
keystore_status
In the context of list_databases operation, keystore_status option can be used to filter the result.
backup_location
In the context of TDE keystore backup operation, backup keystore location is optional, if this input is not provided, then the current keystore location would be used to store the backed up keystore file.
backup_id
In the context of TDE keystore backup operation, backup keystore id is optional, if this input is not provided, then the current server timestamp would be used as the backup id.
tablespace
In the context of TDE operation, Tablespace name is required to perform encrypt, decrypt, and rekey on given tablespace name.
algorithm
In the context of TDE operation, the encryption algorithm is required to perform encryption and rekey on the given tablespace.
keep
Yes- Keep the old datafiles.
No- do not keep the old datafiles.
Note:
On execution (Wallet Management operations: rekey, open, and close), you will be prompted to enter the wallet_password in non-echo mode.Examples
Example 1
The following example tries to close the TDE wallet target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=close -wallet_password=Testing_1234 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 2
The following example tries to open the TDE wallet target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=open -wallet_password=Testing_1234 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 3
The following example tries to rekey the master key on target tdeEnabledDatabase:
emcli tde
-target_name=tdeEnabledDatabase
-target_type=oracle_database
-operation=rekey
-master_key_tag="new_rekey_101"
-wallet_password=Testing_1234
-connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 4
The following example tries to backup the keystore. Backup ID and location are optional arguments. By default the backup location of the keystore would be in the current keystore location and the backup id would be the current server timestamp. The backup_keystore operation is supported starting from 12.1 database version.
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=backup_keystore -backup_id="new_backup_101" -backup_location="\scratch\oracle\wallet\" -wallet_password=Testing_1234 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 5
The following example tries to change keystore password. The change_keystore_password operation is supported starting from 12.1 database version.
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=change_keystore_password -wallet_password=Testing_1234 -wallet_new_password=Testing#4321 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 6
The following example fetch keystore details for the given target.
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=keystore_details -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 7
The following example make the tablespace go online on the target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=make_tablespace_online -tablespace=EXAMPLE_TS_1 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 8
The following example encrypt tablespace using online feature on the target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=encrypt_tablespace_online -tablespace=EXAMPLE_TS_1 -algorithm=AES256 -keep=yes -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 9
The following example rekey tablespace using online feature on the target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=rekey_tablespace_online -tablespace=EXAMPLE_TS_1 -algorithm=AES192 -keep=yes -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 10
The following example decrypt tablespace using online feature on the target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=decrypt_tablespace_online -tablespace=EXAMPLE_TS_1 -keep=yes -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 11
The following example uses finish operation to finish the previously run online tablespace operation that has run into issues:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=finish_tablespace_online -tablespace=EXAMPLE_TS_1 -algorithm=AES192 -keep=yes -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Note:
Offline feature is supported only on target database version 11.2.0.4, 12.1, and 12.2.Example 12
The following example make the tablespace go offline on the target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=make_tablespace_offline -tablespace=EXAMPLE_TS_1 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 13
The following example encrypt tablespace using offline feature on the target tdeEnabledDatabase.
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=encrypt_tablespace_offline -tablespace=EXAMPLE_TS_1 -algorithm=AES256 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 14
The following example decrypt tablespace using offline feature on the target tdeEnabledDatabase:
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=decrypt_tablespace_offline -tablespace=EXAMPLE_TS_1 -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 15
The following example list tablespaces for a given target.
emcli tde -target_name=tdeEnabledDatabase -target_type=oracle_database -operation=list_tablespaces -encrypted=yes/no -connect_as= "DBUserName:uname;DBPassword:upassword[;DBRole:SYSDBA]" or "[DBCredsOwner:ucredsowner;]DBNamedCreds:unamedcreds"
Example 16
The following example list databases with TDE details. Target name, target type, keystore type, and keystore status are the optional filter arguments that can be used to further refine the result.
emcli tde -target_name=TargetDBName -target_type=oracle_database -operation=list_databases -keystore_type=HSM/WALLET/OKV -keystore_status=open/closed/unknown/not_configured
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
Options
level=basic
Enables auditing for BASIC user operations.
Examples
Example 1
This example enables auditing for all operations.
emcli enable_audit
Example 2
This example enables auditing for LOGIN, LOGOUT, DB_LOGIN, and DB_LOGOUT.
emcli enable_audit -level=basic
Enables configuration history computation for a target type.
Format
emcli enable_config_history -target_type="{target type|'*'}"
Options
target_type
Target type for which the configuration history is being enabled. The value should be the internal name or "*" to indicate all target types.
Examples
Example 1
This example enables configuration history computation for the host target type.
emcli enable_config_history -target_type="host"
Example 2
This example enables configuration history computation for all target types.
emcli enable_config_history -target_type="*"
Takes a list of agents and marks each agent as a forwarder agent.
Format
emcli enable_forwarder_agents
-agent_list="agent_list"
[ ] indicates that the parameter is optional.
Options
agent_list
List of agents that need to be registered as forwarders. The agents must be separated by space.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example enables agent1 and agent2 as forwarding agents.
emcli enable_forwarder_agents
-agent_list="agent1 agent2..."
Enables the specified MDA finding types for the specified targets. The finding types are enabled for a target only if the finding is applicable for the specified target type, and the EM CLI user has permissions on the target.
Format
emcli enable_mda_finding_types_for_targets
[-targets="<list of targets and their target types >"]
[-finding_types="<list of finding types>"]
[ ] indicates that the parameter is optional.
Options
targets
List of targets and their target types.
finding_types
List of finding types.
Examples
Example 1
The following example enables a single finding type on a single target:
emcli enable_mda_finding_types_for_targets
-finding_types="oracle.sysman.emas.wls_gc_overhead"
-targets="/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1:weblogic_j2eeserver"
Example 2
The following command enables multiple finding types on multiple targets:
emcli enable_mda_finding_types_for_targets
-finding_types="oracle.sysman.emas.wls_gc_overhead;oracle.sysman.emas.wls_heap_config"
-targets="/EMGC_EMGC_DOMAIN/EMGC_DOMAIN/EMGC_OMS1:weblogic_j2eeserver;/test_base_domain/base_domain/MS1:weblogic_j2eeserver"
Reenables the metric data loading for targets or metrics where data loading was disabled due to a quarantine process.
This verb supports bulk operation for the following cases:
All metrics of specified targets for a specified target type
Specified metrics of all targets for a specified target type
Format
emcli enable_metric_data_load
[-target_type="host"]
[-targets="host1;host2;"]
[-metrics="Load;Filesystems;"]
[ ] indicates that the parameter is optional.
Options
-target_type
Target type that you are reenabling metric data loading for. If you want to perform the operation on all targets, then skip this option.
-targets
Semicolon separated list of targets for a specified target type. You must use the target_type option with this option. If you want to perform the operation on all targets for a specified target type, then skip this option.
-metrics
Semicolon separated list of metrics for a specified target type. You must use the target_type option with this option. If you want to perform the operation on all metrics for the specified target type, then skip this option.
Examples
Example 1
The following command reenables the metric data loading for all metrics of all the host targets.
emcli enable_metric_data_load
-target_type="host"
Example 2
The following command reenables the metric data loading for all metrics of the myhost1.example.com and myhost2.example.com host targets.
emcli enable_metric_data_load
-target_type="host"
-targets="myhost1.example.com;myhost2.example.com;"
Enables or disables an event correlation rule.
Format
enable_or_disable_event_correlation_rule
-rule_name="event correlation rule name"
-enable=true/false
Options
rule_name
Event correlation rule name.
enable
Enable a rule by setting the value to true or disable the rule by setting the value to false.
Example
The following command enables the event correlation rule add_event_to_incident.
enable_or_disable_event_correlation_rule
-rule_name="add_event_to_incident" -enable=true
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
Options
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
This example immediately enables an SLA named 'gold_sla' for target my_service (generic_service).
emcli enable_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla' -versionNum=2 -now
Example 2
This example enables a SLA named 'gold_sla' for target my_service (generic_service). It becomes active and starts computing at '09/23/2012 3:30 PM'.
emcli enable_sla
-targetName='my_service' -targetType='generic_service'
-slaName='gold_sla' -versionNum=2 -versionStart='09/23/2012 3:30 PM'
Enables the Snap Clone feature for a database.
Format
Standard Mode
emcli enable_snapclone
-db_name="<database name>"
Interactive or Script Mode
enable_snapclone(
db_name="<database name>"
)
[ ] indicates that the parameter is optional.
Options
db_name
Name of the database.
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example enables the Snap Clone feature for the database testmstr:
emcli enable_snapclone
-db_name="testmstr"
Enables the target on both the Management Repository and Management Agent side.
Syntax
emcli enable_target
-type="target_type1"
-name="target_name1"
-agent="agent_name1"
[-ignore_invalid_target]
[ ] indicates that the parameter is optional.
Options
-type=target_type1
Target type of the target being enabled.
-name=target_name1
Name of the target. You can use the percentage character (%) as a wild character to enable all targets of a specified type on a specified Management Agent.
-agent=agent_name1
Name of the Management Agent on which the target has to be enabled.
-ignore_invalid_target
When specified, the process ignores invalid targets.
Examples
Example 1
The following command enables the target on the Management Agent and OMS and raises an error if the target is invalid.
emcli enable_target
-type="oracle_em_service"
-name="TestService"
-agent="TestAgent"
Example 2
The following command enables all the targets of this type on the "TestAgent" Management Agent both on the OMS and Management Agent side. It ignores invalid targets.
emcli enable_target
-type="oracle_em_service"
-name="%"
-agent="TestAgent"
-ignore_invalid_target
Enables monitoring of a Services test. It pushes the Service test collection to all the beacons.
Format
emcli enable_test
-name=<target_name>
-type=<target_type>
-testname=<test_name>
-testtype=<test_type>
Options
name
Service target name.
type
Service target type.
testname
Test name.
testtype
Test type.
Examples
This 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'
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
Options
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 option 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 -input_file Syntax Guidelines.
Examples
Example 1
This example executes the host command ls -l; against the target stach.example.com:host and host targets contained in the group grp. The stored HostCredsPriv preferred credentials are used for all the targets.
emcli execute_hostcmd
-cmd="ls -l;"
-credential_set_name="HostCredsPriv"
-targets="stach.example.com:host;grp:composite"
Example 2
This example loads the contents of the script /scratch/dba_scripts/shellscript.sh into the value of -osscript and executes it against target reference.example.com:host and host targets contained in the group grp. The stored HostCredsNormal preferred credentials are used for all the targets.
emcli execute_hostcmd
-cmd="/bin/sh -s"
-osscript="FILE"
-input_file="FILE:/scratch/dba_scripts/shellscript.sh"
-credential_set_name="HostCredsNormal"
-targets="reference.example.com:host;grp:composite"
Executes a SQL command across a set of targets.
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
Options
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 option 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 -input_file Syntax Guidelines.
Examples
Example 1
This example executes the SQL command select * from sysman.mgmt_targets; against the target database:oracle_database and database targets contained in the group grp. The stored SYSDBA preferred credentials are used for all the targets.
emcli execute_sql
-sql="select * from sysman.mgmt_targets;"
-credential_set_name="DBCredsSYSDBA"
-targets="database:oracle_database;grp:composite"
Example 2
This example loads the contents of the script /scratch/dba_scripts/enterprise_schema.sql into the value of -sql, and executes it against target database:oracle_database and database targets contained in the group grp. The stored SYSDBA preferred credentials are used for all the targets.
emcli execute_sql
-sql="FILE"
-input_file="FILE:/scratch/dba_scripts/enterprise_schema.sql"
-credential_set_name="DBCredsSYSDBA"
-targets="database:oracle_database;grp:composite"
Exports an Application Data Model to the specified directory with the specified file name.
Format
emcli export_adm
-adm_name=<application_data_model_name>
[-directory=<directory_path>]
[-file_name=<file_name>]
[ ] indicates that the parameter is optional
Options
adm_name
Application data name that will be exported.
directory
Directory where the Application Data Model is to be exported. If the directory is not specified, the file is saved in the current directory.
file_name
Name of the file where the Application Data Model will be exported. If the file name is not specified, the default file name is the same as the specified Application Data Model name. If the file name does not have an extension, '.xml' is the default extension.
Output
Success/error messages.
Examples
Example 1
This example exports the Application Data Model Sample_ADM to the sample_adm.xml file.
emcli export_adm
-directory=/home/user
-adm_name=Sample_ADM
-file_name=sample_adm.xml
Exports the Administration group hierarchy.
Format - Standard Mode
emcli export_admin_group
Format - Interactive or Script Mode
export_admin_group()
Exit Codes
0 if successful. A non-zero value indicates that verb processing was unsuccessful.
Example
The following example creates an admin group with one level - Lifecycle status (with all 5 values).
ade:[ system_23 ] [system@sys01apq emgc]$ emcli export_admin_group
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AdminGroup>
<groupList>
<parent>ADMGRP0</parent>
<child>Deve-Grp</child>
<level>1</level>
<propertyValuePair>orcl_gtp_lifecycle_status:Development</propertyValuePair>
</groupList>
<groupList>
<parent>ADMGRP0</parent>
<child>MC-Grp</child>
<level>1</level>
<propertyValuePair>orcl_gtp_lifecycle_status:MissionCritical</propertyValuePair>
</groupList>
<groupList>
<parent>ADMGRP0</parent>
<child>Prod-Grp</child>
<level>1</level>
<propertyValuePair>orcl_gtp_lifecycle_status:Production</propertyValuePair>
</groupList>
<groupList>
<parent>ADMGRP0</parent>
<child>Stag-Grp</child>
<level>1</level>
<propertyValuePair>orcl_gtp_lifecycle_status:Stage</propertyValuePair>
</groupList>
<groupList>
<parent>ADMGRP0</parent>
<child>Test-Grp</child>
<level>1</level>
<propertyValuePair>orcl_gtp_lifecycle_status:Test</propertyValuePair>
</groupList>
<levelList>
<levelNumber>1</levelNumber>
<levelProperty>orcl_gtp_lifecycle_status</levelProperty>
<propertyValues>Development</propertyValues>
<propertyValues>MissionCritical</propertyValues>
<propertyValues>Production</propertyValues>
<propertyValues>Stage</propertyValues>
<propertyValues>Test</propertyValues>
</levelList>
<rootNode>ADMGRP0</rootNode>
</AdminGroup>
emcli awrwh_add_src_db -target_name=sample_database -target_type=oracle_database
Exports charge plan metadata to an XML file.
Format
emcli export_charge_plans
[-charge_plan="plan_name"[-entity_type = chargeback_entity_type]]
[-start_date=ddmmyyyy]
-file=file_name
[ ] indicates that the parameter is optional
Options
charge_plan
Name of the charge plan to be exported. If this option is not specified, all charge plan metadata is exported.
entity_type
Name of the Chargeback entity type whose charge plan is to be exported. If this option is not specified, all entity type charge rates in the charge plan are exported.
start_date
Start date of the report cycle whose charge plan metadata is to be exported. The start date value must be in ddmmyyyy format. If this option is not specified, the start date of the current report cycle is used.
file
Absolute path to which to export the metadata.
Examples
Example 1
This example exports metadata of the host entity type associated with charge plan Plan A, if active in the current report cycle, to the file /home/plans.xml:
emcli export_charge_plans
-charge_plan="Plan A"
-entity_type=host
-file=/home/plans.xml
Example 2
This example exports metadata of charge plan Plan A, if active in the report cycle starting on 01062014, to the file /home/plans.xml:
emcli export_charge_plans
-charge_plan="Plan A"
-start_date=01062014
-file=/home/plans.xml
Exports a compliance group definition and all of its element definitions given the name, author, and version.
Format
emcli export_compliance_group
-name=<name>
-author=<author>
-version=<name>
-output_file=<file>
Options
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"
Exports a rule to the specified files.
Format
export_compliance_standard_rule -name=<name> -target_type=<target_type> -output_file=<file>
Options
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"
Exports the comparison result to a file.
Format
emcli export_config_compare_result
-compare_check_name="<check_name>"
-filename="<path_to_zip_file>"
[-result_format="<S|L>"]
[-content="<D|A>"]
[ ] indicates that the parameter is optional.
Options
compare_check_name
Name of the comparison check.
filename
Output zip file with the absolute path.
result_format
Providing "S" exports the results in side-by-side format. Providing "L" exports the results in list format. Default value is "S".
content
Exports only differences if the value is "D". Exports all results if the value is "A". Default value is "D".
Examples
Example 1
The following example exports the results of comparison check with name "test check" to the file "TestReport.zip". Exports differences only, in side-by-side format.
emcli export_config_compare_result
-compare_check_name="test check"
-filename="/tmp/TestReport.zip"
Example 2
The following example exports the results of comparison check with name "test check" to the file "TestReport.zip" . Exports differences only, in list format.
emcli export_config_compare_result
-compare_check_name="test check"
-filename="/tmp/TestReport.zip"
-result_format="L"
Exports the saved one-time comparison result from the repository to a zip file.
Format
emcli export_config_onetimecompare
-filename="<name_of_output_zip_file>"
-name="<comparison_name>"
[-result_format="<S|L>"]
[-content="<D|A>"]
[ ] indicates that the parameter is optional.
Options
filename
Output zip file with absolute path.
name
Name of the saved one-time comparison.
result_format
Providing "S" exports the results in side-by-side format. Providing "L" exports the results in list format. Default value is "S".
content
Exports only differences if the value is "D". Exports all results if the value is "A". Default value is "D".
Example
The following example exports the saved one-time comparison result from the repository to the "/tmp/TestReport.zip" output file with the name "cmp_host1".
emcli export_config_onetimecompare
-filename="/tmp/TestReport.zip"
-name="cmp_host1"
Exports the saved configuration search to an XML file.
Format
emcli export_config_search
-name="<Configuration Search UI Name>"
-output_file="<XML file name>"
Options
name
Display name of the configuration search. It is a mandatory parameter.
output_file
The name of the xml file with an absolute path. It is a mandatory parameter.
Example
The following example exports the configuration to the testSearch.xml file:
emcli export_config_search -name="testSearch"
-output_file="/tmp/testSearch.xml"
Exports the comparison template to a file with the name provided as the argument to "filename".
Format
emcli export_config_compare_template
-template_id="<id_of_template>"
-filename="<name_of_xml_file>"
Options
template_id
Identifier of the comparison template to be exported.
filename
Output XML file with absolute path.
Example
The following example exports the comparison template with the identifier "1" to the file "TestHost.xml".
emcli export_config_compare_template
-template_id="1"
-output_file="/tmp/TestHost.xml"
Exports user-defined charge item metadata to the specified XML file.
Format
emcli export_custom_charge_items
-entity_type="entity_type"
-file=output_file
Options
entity_type
Name of the entity whose charge item metadata you want to export.
file
Full path of the file to which to write user-defined charge items associated with the specified entity type.
Examples
This example writes user-defined charge item metadata associated with the host entity type to the myhost.xml file in the home directory:
emcli export_custom_charge_items
-entity_type="host"
-file=/home/myhost.xml
Exports a real-time monitoring facet to the specified file.
Format
emcli export_facet
-name="<name>"
-target_type="<target_type>"
-entity_type="<entity_type>"
-output_file="<file>"
Options
Name
Name (internal) of the facet to be exported.
target_type
Target type (internal) of the facet to be exported. To see all target types available for your environment, check the $AGENT_HOME/sysman/admin/metadata directory. A metadata file (XML file) exists for each target type.
entity_type
Entity type (internal) of the facet to be exported, for example, osfile, osprocess, osuser, and so on.
output_file
Name of the exported file.
Example
The following example exports the foo facet to the $HOME/reports/facet.xml file.
emcli export_facet
-name="foo"
-target_type="host"
-entity_type="osfile"
-output_file="$HOME/reports/facet.xml"
Exports an incident rule set from list of enterprise rule set(s).
Note:
Oracle-supplied out-of-box rule sets cannot be exported.
Privilege Requirements
Any user can export an enterprise rule set.
Format
emcli export_incident_rule_set
-rule_set_name=<rule set name>
[-rule_set_owner=<ruleset owner>]
-export_file=<export file >
[ ] indicates that the parameter is optional.
Options
rule_set_name
Name of an enterprise rule set.
rule_set_owner (Optional)
The owner of the rule set.
export_file
XML file name along with the file path for the exported rule set.
If the filename is specified within directory, this option will create the file with the specified rule set name in that directory.
Example
This command exports an enterprise rule set named TEST_RULESET owned by sysman to an XML file (TEST_RULESET.xml) located in the tmp directory (/tmp/TEST_RULESET.xml).
emcli export_incident_rule_set -rule_set_name=TEST_RULESET -rule_set_owner=sysman -export_file="/tmp/"
Exports all matching job definitions in Enterprise Manager, including Corrective Actions. System jobs and nested jobs are excluded.
Format
emcli export_jobs -export_file=<zip_file_name>" [-name="job_name1;job_name2;..."] [-type="job_type1;job_type2;..."] [-targets="tname1:ttype1;tname2:ttype2;..."] [-owner="owner1;owner2;..."] [-preview] [ ] indicates that the parameter is optional
Options
export_file
Zip file name to be created.
name
Job name pattern to be used for filtering. Semicolon-separated job names can be provided. When filtering by a single value, wildcard char(% or _) can also be used. Wildcard "%"matches one or more characters. "_"(underscore) matches exactly one character.
type
Job type pattern to be used for filtering. Semicolon-separated job types can be provided. When filtering by sa ingle value, wildcard chars(% or _) can be used.
targets
Target name, type pattern to be used for filtering. Semicolon-separated target names and types can be provided. When filtering by a single value, wildcard chars(% or _) can be used.
owner
Owner of the jobs to be used for filtering. Semicolon-separated job owners can be provided.
preview
Jobs in the Enterprise Manager site matching the filter criteria are shown to stdout. Jobs are not exported to any file.
Output Columns
Success/Error messages.
Examples
Example 1
This example exports job definitions for jobs MYJOB1 and MYJOB2 to job_data.zip:
emcli export_jobs -name=MYJOB1;MYJOB2 -export_file=jobsdata.zip
Example 2
This example exports job definitions for any jobs owned by user name starting with ADMIN.
emcli export_jobs -owner=ADMIN% -export_file=jobsdata.zip
Exports the latest configuration to a file with name provided as an argument "output_file".
Format
emcli export_latest_config
-target_type="host"
-target_name="test_host"
[-export_members="true"]
[-output_file="ExportConfig.zip"]
Options
target_type
Target type where the configuration is saved. Default is internal name.
target_name
Target name.
export_members
Exports the target members.
True
False
Default is false.
output_file
Output zip file with an absolute path.
Example
The following example exports the latest configuration to a host file named "test_host" to the file "ExportConfig.zip". The target members are not exported.
emcli export_latest_config -target_type="host"
-target_name="test_host"
-export_members="false"
-output_file="ExportConfig.zip"
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
Options
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
This example exports the masking definition mask_hr_data to an XML file at the specified path:
emcli export_masking_definition
-definition_name=mask_hr_data
-path=/tmp/
Example 2
This example exports the masking definition mask_hr_data to an XML file named abc.xml:
emcli export_masking_definition
-definition_name=mask_hr_data
-file=/tmp/abc.xml
Exports a metric extension archive file.
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>
Options
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
This example creates an archive of a metric extension of a given target type, name, and version.
emcli export_metric_extension -file_name=<name of the metric extension archive> -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension>
Exports an Information Publisher report definition and all of its element definitions given its title and owner.
Format
emcli export_report
-title=<report_title>
-owner=<report_owner>
-output_file=<file>
Options
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
Exports a saved target configuration.
Format
emcli export_saved_config
-name="saved config name"
[-output_file="ExportConfig.zip"]
[ ] indicates that the options is not mandatory.
Options
name
The name of the saved configuration to delete.
output_file
Output zip file with an absolute path. This is an optional parameter.
Examples
The following command exports the saved configuration with the name "blr2201989.idc.oracle.com|host|20141210130723" to the file "ExportConfig.zip": :
emcli export_saved_config
-name="blr2201989.idc.oracle.com"
-output_file="ExportConfig.zip"
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
Options
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
This 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'
Exports a standard from the repository to an XML file.
Format
emcli export_standard
-name=<name>
-author=<author>
-version=<name>
-output_file=<file>
Options
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
Exports the specified subset definition as an XML file at the specified directory location.
Format
emcli export_subset_definition -subset_name=<subset_definition_name> [-file_name=<file_name>] [-directory=<directory_path>] [ ] indicates that the parameter is optional
Options
subset_name
Subset definition name to export.
file_name
File name to save the exported file. If you do not specify the file name, it is saved under the subset definition name. If it is specified without an extension, '.xml' is used as the default extension.
directory
Directory location to save the exported file. If you do not specify a directory, the file is saved in the current directory.
Output
Export success or error message.
Examples
Example 1
This example exports a subset definition with the name HR_Subset as XML in the current directory.
emcli export_subset_definition -subset_name=HR_Subset
Example 2
This example exports a subset definition with the name HR_Subset as XML with the name HR_Subset_Export at the directory path /scratch/subset.
emcli export_subset_definition -directory=/scratch/subset -subset_name=HR_Subset -file_name=HR_Subset_Export
Exports Software Library entity files from a compressed file to a file system location on a host target.
Format
emcli export_swlib_cache_files
-dest_dir_path="dest_dir_path"
-zip_file_name="zip_file_name"
-dest_host_name="dest_host_name"
-urn_file_entry="urn_file_entry"
-dest_host_tmp_dir="dest_host_tmp_dir"
-credential_set_name="setname"] | [-credential_name="name" -credential_owner="owner"]
Parameters
dest_dir_path
Location on the host where the compressed file is created.
zip_file_name
Name of the compressed file created.
dest_host_name
Name of the host target on which the compressed file is created.
urn_file_entry_file
File on the emcli client host which contains identifier of the entity revision followed by # followed by file name. If the identifier is not followed by #, all file entries of the entity revision will be exported.
dest_host_tmp_dir
Directory on the destination host in which temporary files are created for export.
credential_set_name
The set name of the preferred credential stored in the Management Repository for the host target. It can be one of the following:
HostCredsNormal - default unprivileged credential set
HostCredsPriv - privileged credential set
credential_name
Named credential stored in the Management Repository. This option must be specified along with the -credential_owner option.
credential_owner
Owner of a named credential stored in the Management Repository. This option must be specified along with the -credential_name option.