2 Verb Reference

EM CLI Verbs

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

abort_udmmig_session

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• session_id

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

• input_file

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

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

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

Examples

Example 1

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

emcli abort_udmmig_session -session_id=<sessionId>

Example 2

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

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

add_beacon

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

Format

emcli add_beacon
      -name=target_name
      -type=target_type
      -bcnName=beacon_name
      [-dontSetKey]

[ ] indicates that the parameter is optional

Parameters

• name

  Service target name.

• type

  Service target type.

• bcnName

  Beacon name to add.

• dontSetKey

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

Example

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

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

add_siteguard_script_hosts

Adds a host to the Site Guard configuration scripts.

Format

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

Parameters

• script_id

  ID associated with the script.

• host_name

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

Examples

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

See Also

create_siteguard_script

get_siteguard_script_hosts

add_swlib_storage_location

Adds a storage location in the software library.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the storage location.

• path

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

• type

  Type of storage location. The default is OmsShared.

• host

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

• credential_set_name

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

  • HostCredsNormal: Default unprivileged credential set

  • HostCredsPriv: Privileged credential set

• credential_name

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

• credential_owner

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

Examples

Example 1

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

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

Example 2

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

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

add_target

Adds a target to be monitored by Enterprise Manager. The target type specified is checked on the Management Agent for existence and for required properties, such as user name and password for host target types, or log-in credentials for database target types. You must specify any required properties of a target type when adding a new target of this type.

For oracle_database target types, you must specify Role with the monitoring credentials. If the Role is Normal, the UserName must be dbsnmp. Otherwise, the Role must be SYSDBA, and UserName can be any user with SYSDBA privileges.

Format

emcli add_target
      -name="name"
      -type="type"
      -host="hostname"
      [-properties="pname1:pval1;pname2:pval2;..."]
      [-separator=properties="sep_string"]
      [-subseparator=properties="subsep_string"]
      [-credentials="userpropname:username;pwdpropname:password;..."]
      [-input_file="parameter_tag:file_path"]
      [-display_name="display_name"]
      [-groups="groupname1:grouptype1;groupname2:grouptype2;..."]
      [-timezone_region="gmt_offset"]
      [-monitor_mode="monitor_mode"]
      [-instances="rac_database_instance_target_name1:target_type1;..."]

[ ] indicates that the parameter is optional

Parameters

• name

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

• type

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

• host

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

• properties

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

  Note:

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

• separator=properties

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

• 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 ":".

• 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 ( ; ).

• 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 or 1. 0 Indicates a single Agent monitored target. 1 indicates that the target is monitored by more than one Agent, with one Agent as the master (collecting data) at any given point in time. Consequently, you should always set this option to 1 for a RAC database, since it is a multi-agent target.

• instances

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

Examples

Example 1

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

emcli add_target
      -name="database"
      -type="oracle_database"
      -host="myhost.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 an oracle_database target with the name "database." This example illustrates the use of the input_file to camouflage the credentials. The password is actually in a file named at_pwd_file. The input_file argument is used to replace PWD_FILE with the contents of the at_pwd_file in the credentials argument.

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

Example 3

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

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

Example 4

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

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

add_target_property

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

Format

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

Parameters

• target_type

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

• property

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

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

Examples

Example 1

The following example adds the Owner Name property for all targets of type oracle_database.

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

Example 2

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

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

analyze_unconverted_udms

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

Format

emcli analyze_unconverted_udms 
      [-session_id=<sessionId>]

[ ] indicates that the parameter is optional

Parameters

• session_id

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

Examples

Example 1

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

emcli analyze_unconverted_udms 

Example 2

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

emcli list_unconverted_udms -session_id=<sessionId>

apply_diagcheck_exclude

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• target_type

  Type of target.

• exclude_name

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

• target_name

  Target names to apply the exclusion to.

apply_privilege_delegation_setting

Activates Sudo or PowerBroker settings for specified targets.

Format

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

[ ] indicates that the parameter is optional

Parameters

• setting_name

  Name of the setting you want to apply.

• target_names

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

  • All targets must be of the same type.

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

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

• target_type

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

• input_file

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

• force

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

Examples

Example 1

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

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

Example 2

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

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

Example 3

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

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

apply_template

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

Format

emcli apply_template
        -name="template_name"
        -targets="tname1: ttype1;tname2: ttype2;..."
        [-copy_flags="0" or "1" or "2"]
        [-replace_metrics="0" or "1"]
        [-input_file="FILE1:file_name"]

[ ] indicates that the parameter is optional

Parameters

• name

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

• targets

  The targets should be specified in the following sequence:

  TargetName1:TargetType1;TargetName2:TargetType2

  For example:

  db1:oracle_database;my db group:composite

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

• copy_flags

  This applies only for metrics with multiple thresholds.

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

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

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

• replace_metrics

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

• input_file

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

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

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

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

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

    credListType:all;
    usr_name:joe1;passwrd:pass1;
    

  • Each UDM uses its own credentials for all targets. For example:

    credListType:perUDM;
    udm_name:UDM1;usr_name:joe1;passwrd:pass1;
    udm_name:UDM2;usr_name:joe2;passwrd:pass2;
    

  • Each UDM uses different credentials for different targets. For example:

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

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

Examples

Example 1

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

For composite targets, the template is only applied to member targets that belong to the target type for which the template is applicable. Since the copy_flags is not specified, the default ("Apply threshold settings for monitored objects common to both template and target") is meant.

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

Example 2

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

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

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

Example 3

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

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

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

Example 4

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

For composite targets, the template is applied only to member targets that belong to the target type for which the template is applicable. In this case, since the copy_flags option is specified as "1", the threshold settings on the target will be duplicated. Furthermore, the credentials needed for the UDMs are present in the file /usr/vmotamar/db_credentials.txt.

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

Example 5

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

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

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

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

apply_template_tests

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

Format

emcli apply_template_tests
      -targetName=target_name
      -targetType=target_type
      -input_file=template:template_filename
      [-input_file=variables:<variable_filename>]
      [-input_file=atsBundleZip:<ats_bundle_zip_filename>]
      [-useBundleDatabankFile]
      [-useFirstRowValues]
      [-input_file=atsBundleZip:<ats_bundle_zip_filename>]
      [-overwriteExisting=all | none | <test1>:<type1>;<test2>:<type2>;...]
      [-encryption_key=key]

[ ] indicates that the parameter is optional

Parameters

• targetName

  Target name.

• targetType

  Target type.

• input_file=template

  Name of the input file containing the test definitions.

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

• input_file=atsBundleZip

  Name of the ATS bundle zip defined in the template.

• useBundleDatabankFile

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

• useFirstRowValues

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

• overwriteExisting

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

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

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

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

• encryption_key

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

Examples

You must have the following privileges to perform these examples:

• Operator privilege on the target.

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

Example 1

The following example applies the test definitions contained in the file my_template.xml into the Generic Service target my_target, using the key my_password to decrypt the file contents. If tests with names my_website or my_script exist on the target, they are overwritten by the test definitions in the file.

emcli apply_template_tests
      -targetName='my_target' -targetType='generic_service'
      -input_file=template:'my_template.xml' -encryption_key='my_password'
      -overwriteExisting='my_website:HTTP;my_script:OS'

Example 2

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

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

argfile

Executes one or more EM CLI verbs, where both verbs and the associated arguments are contained in an ASCII file. argfile enables you to use verbs with greater flexibility. For example, when specifying a large list of targets to be blacked out (create_blackout verb), you can use the argfile verb to input the target list from a file.

Multiple EM CLI verb invocations are permitted in this file. You should separate each verb invocation with a new line.

Format

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

Parameters

• delim

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

assign_csi_for_dbmachine_targets

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

Format

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

Parameters

• target_name

  Name of the database system target.

• csi

  Customer Support Identifier (CSI) to be assigned.

• mos_id

  My Oracle Support (MOS) user ID.

Example

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

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

assign_test_to_target

Assigns a test-type to a target-type. If a test-type t is assigned to target-type T, all targets of type T can be queried with tests of type t.

Format

emcli assign_test_to_target
      -testtype=test-type_to_be_assigned
      -type=target_type
      [-tgtVersion]=version_of_target_type

[ ] indicates that the parameter is optional

Parameters

• testtype

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

• type

  Service target type.

• tgtVersion

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

Examples

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

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

bareMetalProvisioning

Assigns a test-type to a target-type. If a test-type t is assigned to target-type T, all targets of type T can be queried with tests of type t.

Format

emcli bareMetalProvisioning
       [-input_file="config_properties:input_XML"]

[ ] indicates that the parameter is optional

Parameters

• input_file

  Input XML file confirming to the XSD for BMP.

Example

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

change_service_system_assoc

Changes the system that hosts a given service.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Service name.

• type

  Service type.

• systemname

  System on which the service resides.

• systemtype

  System type.

• keycomponents

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

Example

The following example changes the system for a generic service named my service to a generic system named my system with specified key components.

emcli change_service_system_assoc
      -name='my service' -type='generic_service'
      -systemname='my system' -systemtype='generic_system'
      -keycomponents='database:oracle_database; mytestbeacon:oracle_beacon'

change_target_owner

Changes the owner of the target.

Format

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

[ ] indicates that the parameter is optional

Parameters

• target

  Target name and target type to change the owner.

• owner

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

• new_owner

  New owner name of the target.

Example

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

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

clear_credential

Clears preferred or monitoring credentials for given users.

Format

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

[ ] indicates that the parameter is optional

Parameters

• target_type

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

• target_name

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

• credential_set

  Credential set affected.

• user

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

• oracle_homes

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

Examples

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

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

clear_default_pref_credential

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

Format

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

Parameters

• set_name

  Clears the default preferred credential for this credential set.

• target_type

  Target type for the credential set.

Examples

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

emcli clear_default_pref_cred 
        -set_name=HostCredsNormal
        -target_type=host

clear_monitoring_credential

Clears the monitoring credential set for the target.

Format

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

Parameters

• set_name

  Clears the monitoring credential for this credential set.

• target_name

  Clears the preferred credential for this target.

• target_type

  Target type for the target/credential set.

Examples

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

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

clear_preferred_credential

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

Format

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

Parameters

• set_name

  Sets the preferred credential for this credential set.

• target_name

  Clears the preferred credential for this target.

• target_type

  Target type for the target/credential set.

Examples

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

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

clear_privilege_delegation_setting

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• host_names

  Names of the hosts.

• input_file

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

• force

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

Examples

Example 1

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

Example 2

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

Example 3

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

clear_stateless_alerts

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

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

Format

emcli clear_stateless_alerts        -older_than=number_in_days        -target_type=target_type        -target_name=target_name        [-include_members]        [-metric_internal_name=target_type_metric:metric_name:metric_column]        [-unacknowledged_only]        [-ignore_notifications]        [-preview]

[ ] indicates that the parameter is optional

Parameters

• older_than

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

• target_type

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

• target_name

  Name of the target.

• include_members

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

• metric_internal_name

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

• unacknowledged_only

  Only clear alerts if they are not acknowledged.

• ignore_notifications

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

• preview

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

Examples

The following example clears alerts generated from the database alert log over a week old. In this example, no notifications are sent when the alerts are cleared.

emcli clear_stateless_alerts -older_than=7 -target_type=oracle_database -tar  get_name=database -metric_internal_name=oracle_database:alertLog:genericErrStack -ignore_notifications

collect_metric

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

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

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• target_name

  Name of the target.

• target_type

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

• metric_name

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

• collection_name

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

Examples

Example 1

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

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

Example 2

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

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

Example 3

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

emcli collect_metric -target_type=oracle_database -target_name=database -collection=MySQLUDM

compare_sla

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• input_file=sla1

  File name for the first XML file.

• input_file=sla2

  File name for the second XML file.

• 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

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

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

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

diff sla1_compare.dif sla2_compare.dif

confirm_instance

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• instance

  Instance GUID.

• exec

  Execution GUID.

• name

  Execution name.

• owner

  Execution owner.

• stateguid

  Comma-separated list of state GUIDs.

Examples

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

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

convert_to_cluster_database

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• sourceTargetName

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

• sysdbaCreds

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

• hostCreds

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

• newOracleHome

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

• racConfigType

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

• nodeList

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

• serverPoolList

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

• databaseArea

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

• recoveryArea

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

• listenerPort

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

Examples

Example 1

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

Example 2

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

Example 3

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

create_aggregate_service

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

Format

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

[ ] indicates that the parameter is optionalis optional

Parameters

• name

  Aggregate service name.

• type

  Aggregate service type.

• add_sub_services

  Sub-services list.

• avail_eval_func

  PL/SQL function to evaluate the availability of the aggregate service. Use [or|and] for a predefined evaluate helper function.

• timezone_region

  Time zone region of the service.

Examples

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

create_blackout

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

Format

emcli create_blackout
      -name="name"
      -add_targets="name1:type1;name2:type2;..."...
      -reason="reason"
      [-description="description"]
      [-jobs_allowed]
      [-propagate_targets]
      -schedule=
         frequency:once|interval|weekly|monthly|yearly];
         duration:[HH...][:mm...];
         [start_time:yy-MM-dd HH:mm];
         [end_time:yy-MM-dd HH:mm];
         [repeat:#m|#h|#d|#w];
         [months:#,#,...];
         [days:#,#,...];
         [tzinfo:specified|target|repository]
         [tzoffset:#|[-][HH][:mm]]
         [tzregion:...]

[ ] indicates that the parameter is optional

Constraints on schedule arguments:

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

Parameters

• name

  Name of the blackout to create.

• add_targets

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

• reason

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

• description

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

• jobs_allowed

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

• propagate_targets

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

• schedule

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

• schedule=frequency

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

• schedule=duration

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

• schedule=start_time

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

• schedule=end_time

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

• schedule=repeat

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

• schedule=months

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

• schedule=days

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

• schedule=tzinfo

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

• schedule=tzoffset

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

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

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

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

Examples

Example 1

The following example creates blackout b1 for the specified target (database2) to start immediately and last for 30 minutes.

emcli create_blackout -name=b1 -add_targets=database2:oracle_database
      -schedule="duration::30"
      -reason="good reason1"

Example 2

The following example creates blackout b1 for all targets on myhost to start immediately and last until 2007-04-26 05:00 (in the timezone America/New_York).

emcli create_blackout -name=b1 -add_targets=myhost:host
      -propagate_targets -jobs_allowed
      -schedule="end_time:2007-04-26 05:00;tzinfo:specified;         tzregion:America/New_York"
      -reason="good reason2"

Example 3

The following example creates blackout b1 for all targets in group mygroup to start immediately and last until 2007-04-26 05:00 (in the timezone America/New_York). No jobs are allowed to run during the blackout.

emcli create_blackout -name=b1 -add_targets=mygroup:group
      -schedule="end_time:2007-04-26 05:00;tzinfo:specified;         tzregion:America/New_York"
      -reason="good reason3"

Example 4

The following example creates blackout b1 for the specified targets (database2 and database3) to start at 2007-08-24 22:30 and last for 30 minutes. The timezone is the timezone for the database2 target.

emcli create_blackout -name=b1
      -add_targets="database2:oracle_database;database3:oracle_database
      -schedule="frequency:once;start_time:07-08-24 22:30;duration::30;tzinfo:target:tzoffset:1"
      -reason="good reason4"

Example 5

The following example creates blackout b1 for the specified targets (database2 and database3) to start at 2007-08-24 22:30 and last for 30 minutes. The timezone is the timezone for the database3 target.

emcli create_blackout -name=b1 -add_targets=database2:oracle_database
      -add_targets=database3:oracle_database
      -schedule="frequency:once;start_time:07-08-24 22:30;duration::30;tzinfo:target;tzoffset:2"
      -reason="good reason5"

Example 6

The following example creates blackout b2 for the specified target (database2) to start at 2007-08-25 03:00 and every day thereafter, and to last 2 hours each time. The timezone is the repository timezone.

emcli create_blackout -name=b2 -add_targets=database2:oracle_database
      -schedule="frequency:interval;start_time:2007-08-25 03:00;duration:2;repeat=1d"
      -reason="good reason"

Example 7

The following example creates blackout b2 for the specified target (database2) to start immediately and every 2 days thereafter (until 06-12-31 23:59), and to last 2 hours 5 minutes each time. The timezone is the repository timezone.

emcli create_blackout -name=b2 -add_targets=database2:oracle_database
      -schedule="frequency:interval;duration:2:5;end_time:06-12-31 23:59;repeat=2d;tzinfo:repository"
      -reason="another good reason"

Example 8

The following example creates blackout b4 for all targets on myhost and otherhost to start every Sunday through Thursday at the current time. The blackout will last 1 hour each time.

emcli create_blackout -name=b4 -add_targets="myhost:host;otherhost:host"
      -propagate_targets
      -schedule="frequency:weekly;duration:1:;days:1,2,3,4,5"
      -reason="very good reason"

Example 9

The following example creates blackout b5 for all targets within group mygroup to start on the 15th and last day of each month at time 22:30 and last until 2011-11-24 (2011-11-15 will be the actual last blackout date). The blackout will last 1 hour 10 minutes each time. Jobs are allowed to run during the blackouts.

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

Example 10

The following example creates blackout b6 for the specified target (database2) to start at 13:30 on the following dates of each year: 03-02, 04-22, 09-23. The blackout will last 2 hours each time. Jobs are not allowed to run during the blackouts.

emcli create_blackout -name=b6 -add_targets=database2:oracle_database
      -propagate_targets
      -schedule="frequency:yearly;duration:2;start_time:07-08-24 13:30:months=3,4,9;days:2,22,23"
      -reason="most excellent reason"

create_credential_set

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• set_name

  Credential set name to be created.

• target_type

  Target type of the new credential set.

• supported_cred_types

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

• monitoring

  Creates a monitoring credential set.

• auth_target_type

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

• description

  Description of the credential set.

Examples

The following example creates a new credential set named New_Credential_Set.

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

create_database

Creates a database.

Format

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

[ ] indicates that the parameter is optional

Parameters

• dbType

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

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

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

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

  RAC and RACONE require the use of the cluster parameter.

• hostTargets

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

• cluster

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

• oracleHome

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

• gdbName

  Global database name of the database.

• templateName

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

• hostCreds

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

• sysCreds

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

• systemCreds

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

• dbsnmpCreds

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

• sid

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

• racConfigType

  RAC configuration type. Valid values are:

  • POLICY_MANAGED

  • ADMIN_MANAGED

  The default is ADMIN_MANAGED if not provided.

• nodeList

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

• serverPoolList

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

• newServerPool

  Note:

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

• racOneServiceName

  Service name for the RAC One Node database.

• templateInSwlib

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

• templateStageLocation

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

• storageType

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

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

  • ASM for Automatic Storage Management.

• dataFileLocation

  Location of the data files.

• recoveryAreaLocation

  Fast Recovery Area location.

• enableArchiving

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

• useOMF

  Indicates whether to use Oracle Managed Files.

• listeners

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

• newListener

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

Examples

Example 1

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

Example 2

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

Example 3

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

Example 4

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

create_group

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the group.

• type

  Group type: group. Defaults to "group".

• add_targets

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

• is_propagating

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

Examples

Example 1

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

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

Example 2

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

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

Example 3

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

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

create_job

Creates and schedules a job.

EM CLI has only been certified for submitting OS Script and SQL Script jobs. EM CLI does not allow OS Script jobs to be run against database targets. The Enterprise Manager Cloud Control console, however, does allow this.

Format

emcli create_job
     -name=<job_name>
     -job_type=<job_type>
     -input_file="property_file:<filename>"

Parameters

• name

  Name of the job.

• job_type

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

• input_file

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

Example

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

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

create_library_job

Creates a library job.

Format

emcli create_library_job
     -name=<job_name>
     -job_type=<job_type>
     -input_file="property_file:<filename>"

Parameters

• name

  Name of the job.

• job_type

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

• input_file

  Provide the file name to load the properties for creating 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.

Example

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

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

create_named_credential

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

Format

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

Parameters

• cred_name

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

• auth_target_type

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

• cred_type

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

• cred_scope

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

• cred_desc

  Credential description.

• target_name

  This is required when cred_scope is instance.

• target_type

  This is required when cred_scope is instance.

• test

  Use this to test the credential before saving.

• test_target_name

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

• test_target_type

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

• input_file

  Use this to supply sensitive property values from the file.

• input_bfile

  Use this to supply binary property values from the file.

• 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 sub-separator value using -subseparator=attributes=<newvalue>.

Examples

Example 1

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

The following example creates a privilege delegation credential with 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

Example 3

The following example reads the password from the mypasswordfile.txt file.

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

Example 4

The following example prompts for the password from standard input:

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

Example 5

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

emcli create_named_credential
        -properties_file=prop1.txt

Example 6

The following example shows output for various credential types.

emcli show_credential_type_info -target_type=host

Target Type   Cred Type Name  Cred Type Column Name    Key Column
host          HostCreds       HostPassword             No       
                              HostUserName             Yes      
              HostSSHCreds    SSH_PUB_KEY              No       
                              SSH_PVT_KEY              No       
                              USERNAME                 Yes      
              ProvisionCreds  InstallPassword          No       
                              InstallUserName          Yes      
                              OMSRegistrationPassword  No       
                              ProvCompPasswd           No       
              WBEMCreds       WBEMPassword             No       
                              WBEMUserName             Yes  

create_operation_plan

Creates an operational plan for the Oracle Site Guard operation.

Format

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

Parameters

• primary_system_name

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

• standby_system_name

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

• system_name

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

• operation

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

• name

  Name of the operation plan.

• role

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

Examples

Example 1

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

Example 2

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

See Also

emcli get_operation_plans and emcli submit_operation_plan

create_patch_plan

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the setting.

• input_file

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

• impact_other_targets

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

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

• problems_assoc_patches

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

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

See Also

upload_patches

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

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

Examples

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

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

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

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

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

create_privilege_delegation_setting

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• setting_name

  Name of the setting.

• 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 ( ; ).

• subseparator

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

Examples

Example 1

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

-S-u %RUNAS%%COMMAND%

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

Example 2

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

%RUNAS%%PROFILE%%COMMAND%;PASSWORD_PROMPT_STRING Password:

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

For more examples, see the online help.

create_red_group

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

Format

emcli create_red_group
      -name="name"
      [-type=<generic_redundancy_group>]
      -add_targets="name1:type1;name2:type2;..."...
      [-owner=<redundancy_group_owner>]
      [-timezone_region=<actual_timezone_region>]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the redundancy group.

• type

  Redundancy group type. Defaults to generic_redundancy_group.

• add_targets

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

• owner

  Owner of the redundancy group.

• timezone_region

  Time zone region of this redundancy group.

Example

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

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

create_redundancy_group

Creates a redundancy group.

Format

emcli create_redundancy_group        -redundancyGroupName="redGrpName"        -memberTargetType="tType"        -memberTargetNames="tName1;tName2"        [-group_status_criterion=NUMBER|PERCENTAGE]        [-group_status_tracked=UP|DOWN]        [-group_status_value=<group_status_value>]        [-timezone_region=<valid_time_zone_region>]
        [is_propagating=true|false]

[ ] indicates that the parameter is optional

Parameters

• redundancyGroupName

  Name of the redundancy group.

• memberTargetType

  Target type of the constituent member targets.

• memberTargetNames

  Member targets for this redundancy group.

• group_status_criterion

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

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

• group_status_tracked

  See the parameter above.

• group_status_value

  See the group_status_criterion parameter.

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

• timezone_region

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

  SELECT TZNAME FROM V$TIMEZONE_NAMES
  

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

• is_propagating

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

Examples

Example 1

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

emcli create_redundancy_group -redundancyGroupName='redGrp1'          -memberTargetType='oracle_listener'          -memberTargetNames='listener;listener2;listener3'          -group_status_criterion='PERCENTAGE'          -group_status_tracked='UP'          -group_status_value='55'

Example 2

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

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

create_resolution_state

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

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• label

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

• position

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

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

• applies_to

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

Examples

Example 1

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

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

Example 2

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

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

create_role

Creates a new Enterprise Manager admininistrator role.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Role name.

• type

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

• description

  Description of the role.

• roles

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

• users

  List of users to whom this role is assigned.

• privilege

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

  secure_resource_details should be specified as:

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

• separator

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

• subseparator

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

Examples

Example 1

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

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

Example 2

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

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

create_service

Creates a service to be monitored by Enterprise Manager.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

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

• type

  Service type.

• availType

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

• availOp

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

• hostName

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

• agentURL

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

• properties

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

• timezone_region

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

• systemname

  System name on which service resides.

• systemtype

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

• keycomponents

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

• beacons

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

• input_file

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

• sysAvailType

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

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

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

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

Examples

Example 1

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

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

Example 2

The following example creates a generic service named my_service with specified properties on a generic system named my system with specified key components. The availability is set as system-based.

emcli create_service
      -name='my_service' -type='generic_service'
      -availType='system' -availOp='or'
      -properties='prop1:value1; prop2:value2'
      -timezone_region='PST8PDT'
      -systemname='my system' -systemtype='generic_system'
      -keycomponents='database:oracle_database; mytestbeacon:oracle_beacon'

Example 3

The following example creates a generic service named my_service with specified properties with tests defined in mytests.xml, and beacons MyBeacon as the key beacon and MyOtherBeacon as a non-key beacon. Availability is set as test-based.

emcli create_service
      -name='my_service' -type='generic_service'
      -availType='test' -availOp='or'
      -properties='prop1:value1; prop2:value2'
      -timezone_region='PST8PDT'
      -input_file='template:mytests.xml'
      -beacons='MyBeacon:Y;MyOtherBeacon:N'

create_siteguard_configuration

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

Format

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

Parameters

• primary_system_name

  Name of the system associated with the primary site.

• standby_system_name

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

Examples

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

See Also

update_siteguard_configuration

delete_siteguard_configuration

create_siteguard_credential_association

Associates the credentials with the targets in a site.

Format

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

[ ] indicates that the parameter is optional.

Parameters

• system_name

  Name of the system.

• target_name

  Name of the target.

• credential_type

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

• credential_name

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

• use_preferred_credential

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

• credential_owner

  Owner of the credential.

Examples

Example 1

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

Example 2

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

create_siteguard_script

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

Format

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

[ ] indicates that the parameter is optional.

Parameters

• system_name

  Name of the system.

• operation

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

• script_type

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

• host_name

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

• path

  Path to the script.

• all_hosts

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

• role

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

Examples

Example 1

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

Example 2

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

create_swlib_entity

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

Format

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

[ ] indicates that the parameter is optionalis optional

Parameters

• name

  Name of the entity.

• folder_id

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

• type

  Use the list_swlib_entity_types verb to identify the type.

• subtype

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

• desc

  Description of the entity.

• attr

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

• prop

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

• secret_prop

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

• note

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

Examples

Example 1

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

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

Example 2

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

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

create_swlib_folder

Creates a folder in the software library.

Format

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

[ ] indicates that the parameter is optionalis optional

Parameters

• name

  Name of the folder.

• parent_id

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

• desc

  Description of the folder.

Example

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

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

create_system

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

Format

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

[ ] indicates that the parameter is optionalis optional

Parameters

• name

  Name of the system.

• type

  System type: generic_system. Defaults to "generic_system".

• add_members

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

• separator

  Name-value pair separator for the given argument.

• subseparator

  Separates the name from the value for the given argument.

• timezone_region

  Actual time zone region.

• owner

  Owner of the system.

• meta_ver

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

• is_propagating

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

• availability_type

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

Examples

Example 1

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

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

Example 2

The following example creates a generic system named my_system that consists of an oracle database (database2), listener (dblistener), and host (mymachine.myco.com). The owner of this system is the logged-in user. The meta version of the system type is 1.0. The example supports backward compatibility.

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

Example 3

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

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

create_udmmig_session

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the migration session to be created.

• desc

  Description of the migration session to be created.

• udm_choice

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

• target

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

• input_file

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

  <targetType>:<targetName>
  

• template

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

• input_file

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

• allUdms

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

Examples

Example 1

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

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

Example 2

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

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

create_user

Creates a new Enterprise Manager administrator.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Administrator name.

• password

  Administrator password.

• type

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

  • EM_USER

  • EXTERNAL_USER

  • DB_EXTERNAL_USER

• roles

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

• email

  List of e-mail addresses for this administrator.

• privilege

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

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

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

• separator

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

• subseparator

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

• profile

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

• desc

  User description for the user being added.

• expired

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

• prevent_change_password

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

• department

  Name of the department of the administrator.

• cost_center

  Cost center of the administrator in the organization.

• line_of_business

  Line of business of the administrator.

• contact

  Contact information of the administrator.

• location

  Location of the administrator.

• input_file

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

Examples

Example 1

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

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

Example 2

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

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

Example 3

The following example makes User1 an Enterprise Manager user, provides a description for the user, and prevents the password from being changed. Only another super administrator can change the password. The profile is set as MGMT_ADMIN_USER_PROFILE.

emcli create_user
      -name="User1"
      -desc="This is temp hire."
      -prevent_change_password="true"
      -profile="MGMT_ADMIN_USER_PROFILE"

Example 4

The following example makes User1 an Enterprise Manager user, provides a description for the user, and immediately expires the password. When the user logs in the first time, he/she must change the password.

emcli create_user
      -name="User1"
      -desc="This is temp hire."
      -expire="true"

Example 5

The following example makes User1 an Enterprise Manager user, and provides a description, department name, cost center, line of business, contact, and location for the administrator.

emcli create_user
      -name="User1"
      -password="oracle"
      -desc="This is temp hire."
      -department="dept1"
      -cost_center="testCostCenter"
      -line_of_business="testLineOfBusiness"
      -contact="contact"
      -location="location"

define_diagcheck_exclude

Defines a diagnostic check exclusion with regard to groups and checks to exclude.

Format

emcli define_diagcheck_exclude
        -target_type="type"
        -exclude_name="name"
        { [-excl_group="diag_group" ]*
          [-excl_check="diag_check" ]* | 
         -input_file=excl_def:<complete_path_to_file> }

[ ] indicates that the parameter is optionalis optional

Parameters

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

delete_blackout

Deletes a blackout that has already ended or has been fully stopped. You cannot delete a blackout that is either in progress or currently scheduled. You need to first run stop_blackout.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the blackout to delete.

• createdby

  Enterprise Manager user who created the blackout. The default is the current user. The SUPER_USER privilege is required to delete a blackout created by another user.

Examples

Example 1

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

emcli delete_blackout -name=backup_monthly

Example 2

The following example deletes blackout db_maintenance that was created by Enterprise Manager administrator sysadmin2. The current user must either be user sysadmin2 or a user with the SUPER_USER privilege.

emcli delete_blackout -name=db_maintenance -createdby=sysadmin2

delete_credential_set

Deletes a credential set. Only Enterprise Manager Super Administrators can delete credential sets. Out-of-box credential sets cannot be deleted.

Format

emcli delete_credential_set        -set_name="set_name"        -target_type="ttype"

Parameters

• set_name

  Credential set name to be deleted.

• target_type

  Target type of the credential set.

Examples

The following example creates a credential set named Old_Credential_Set.

emcli delete_credential_set 
        -set_name=Old_Credential_Set 
        -target_type=host

delete_group

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the group to delete.

• type

  Group type: group. Defaults to "group".

Examples

Example 1

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

emcli delete_group -name=payroll_group

Example 2

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

emcli delete_group -name=my_hosts

Example 3

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

emcli delete_group -name=my_group

delete_instance

Deletes a stopped or completed deployment instance. An instance can only be deleted when its status is stopped, completed, or completed with an error.

Format

emcli delete_instance 
      [-instance=<instance_guid>] 
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>]

[ ] indicates that the parameter is optional

Parameters

• instance

  Instance GUID.

• exec

  Execution GUID.

• name

  Execution name.

• owner

  Execution owner.

Examples

Example 1

emcli delete_instance -instance=16B15CB29C3F9E6CE040578C96093F61

Example 2

emcli delete_instance -exec=2B15CB29C3F9E6CE040578C96093F16

delete_job

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

Format

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

Parameters

• job_id

  Job ID of the job to delete.

• name

  Name of the job to delete. To uniquely identify the job, the current user is used.

Examples

Example 1

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

emcli delete_job -job_id=12345678901234567890123456789012

Example 2

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

emcli delete_job -name=my_job

delete_library_job

Deletes a library job you created using the create_library_jobs command.

Format

emcli delete_library_job
      -name=<library_job_name>
      [-owner=<library_job_owner>]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the library job.

• owner

  Owner of the library job if different from the current logged-in EM CLI administrator.

Examples

Example 1

The following example deletes the library job "libjob1" owned by the current logged-in Enterprise Manager administrator.

emcli delete_library_job -name=libjob1 

Example 2

The following example deletes the library job "libjob2" owned by the Enterprise Manager administrator "emadmin1."

emcli delete_library_job -name=libjob2 -owner=emadmin1 

delete_metric_promotion

Deletes a promoted metric.

Format

emcli delete_metric_promotion
      -name=<service_target_name>
      -type=<service_target_type>
      [-category=<usage/performance/business>]
      [-promotedMetricName=<promoted_metric]
      [-promotedMetricColumn=<promoted_metric_column>]
      -promotedMetricKey=<key_value_of_promoted_metric>

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the service target.

• type

  Name of the service type.

• category

  Defines whether the promoted metric is a usage or a performance metric of a service. This determines the promoted metric name and metric column. If you do not specify this, you must specify the promotedMetricName and promotedMetricColumn.

• promotedMetricName

  Promoted metric name. This is optional if you specify the category .

• promotedMetricColumn

  Promoted metric column. This is optional if you specify the category .

• promotedMetricKey

  Determines the key value of the promoted metric. It is equivalent to the displayed name of the promoted metric in the user interface.

Examples

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

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

delete_named_credential

Deletes an existing named credential.

Format

emcli delete_named_credential 
        -cred_owner=<owner>
        -cred_name=<name>

Parameters

• cred_owner

  Credential owner.

• cred_name

  Required credential name. This does not support wild cards.

delete_operation_plan

Deletes the specified operation plan from a Site Guard configuration.

Format

emcli delete_operation_plan
      -name=<plan_name>

Parameters

• name

  Name of the operation plan you want to delete.

Example

emcli delete_operation_plan
      -name="BISystem1-switchover"

delete_patches

Deletes patches from the software library.

Format

emcli delete_patches 
      -patch_name=<patch_name> 
      -release=<release_id>
      -platform=<platform_id>

Parameters

• patch_name

  Patch number.

• release

  Patch release ID.

• platform

  Patch platform ID.

Example

emcli delete_patches -patch_name=13741363 -release=80112310 -platform=226

See Also

upload_patches

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

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

delete_privilege_delegation_settings

Deletes a privilege delegation setting template.

Format

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

Parameters

• setting_names

  Name of the settings you want to delete.

Example

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

emcli delete_privilege_delegation_settings
        -setting_names="sudo_setting1;sudo_setting2;pbSetting1

delete_resolution_state

Deletes an existing resolution state. You typically use this command for resolution states that are no longer used. You need to also specify an alternative resolution state in case there are any references to the state. In this case, the references are changed to this alternative state. This action might require some time.

Only a super administrator can execute this command. A success message is reported if the command is successful. An error message is reported if the deletion fails.

Format

emcli delete_resolution_state
      -label="label of the state to be deleted"
      -alt_res_state_label="alternative resolution state"

Parameters

• label

  Label of the state to be deleted.

• alt_res_state_label

  Alternative state to be used.

Examples

The following example deletes the resolution state "Waiting for SR" and replaces any references to this state with the state "Work in Progress".

emcli delete_resolution_state  -label="Waiting for SR" -alt_res_state_label="Work in Progress"

delete_role

Deletes an existing Enterprise Manager administrator role.

Format

emcli delete_role
      -name="role_name"

Parameters

• name

  Role name.

Examples

The following example deletes the role name existing_role.

emcli delete_role -name="existing_role"

delete_siteguard_configuration

Deletes the Site Guard configuration. The entire configuration (scripts, credential associations, site associations, operation plans) pertaining to the specified system and all the associated standby systems are deleted.

Format

emcli delete_siteguard_configuration
      -primary_system_name=<name> | -standby_system_name=<name>

Parameters

• primary_system_name

  Name of the primary system. Specify either primary_system_name or standby_system_name.

• standby_system_name

  Name of the standby system.

Examples

Example 1

emcli delete_siteguard_configuartion
      -primary_system_name="BISystem1"

Example 2

emcli delete_siteguard_configuration
      -standby_system_name="BISystem2"

See Also

create_siteguard_configuration

get_siteguard_configuration

delete_siteguard_credential_association

Deletes the credential association from the Site Guard configuration.

Format

emcli delete_siteguard_credential_association
      -system_name=<name>
      [-target_name=<name>]
      -credential_type=<type>

{ } indicates that the parameter is optional

Parameters

• system_name

  Name of the system.

• target_name

  Name of the target.

• credential_type

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

Examples

Example 1

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

Example 2

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

See Also

create_siteguard_credential_association

update_siteguard_credential_association

get_siteguard_credential_association

delete_siteguard_script

Deletes the specified script from the Site Guard configuration.

Format

emcli delete_siteguard_script
      -script_id=<script_id>

Parameters

• script_id

  ID associated with the script.

Examples

emcli delete_siteguard_script
      -script_id="10"

See Also

create_siteguard_script

get_siteguard_scripts

delete_siteguard_script_hosts

Deletes the host or hosts associated with a given script.

Format

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

Parameters

• script_id

  ID associated with the script.

• host_name

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

Examples

emcli delete_siteguard_script_hosts
      -script_id="10"
      -host_name="BIHOST1"

Output Columns

Step Number, Operation Name, Target Name, Target Host, and Error Mode

See Also

create_siteguard_script

add_siteguard_script_hosts

delete_sla

Deletes one or more SLAs for a target.

Format

emcli delete_sla
    -targetName=<target_name>
    -targetType=<target_type>
    -slaName=<SLA_name>

Parameters

• targetName

  Name of the target.

• targetType

  Type of target.

• slaName

  Name of the SLA.

Example

The following example deletes the SLA with the name 'gold_sla' from the target.

emcli delete_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla'

delete_system

Deletes a system.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the system to delete.

• type

  System type: generic_system. Defaults to "generic_system".

Examples

The following example deletes the system my_system.

emcli delete_system -name=my_system

delete_target

Deletes a specified target from the Enterprise Manager Cloud Control monitoring framework. Deleting a target removes it from the Management Repository and does not physically remove the target itself.

You can use the get_targets verb to obtain a list of available targets and their respective types.

Format

emcli delete_target
      -name=<name>
      -type=<type>
      [-delete_monitored_targets]
      [-async]
      [-delete_members]

[ ] indicates that the parameter is optional

Parameters

• name

  Target name.

• type

  Target type.

• delete_monitored_targets

  Deletes the targets monitored by the specified Management Agent. This is only applicable with the oracle_emd target type.

• async

  Deletes the target asynchronously.

• delete_members

  Deletes all the members of the target as well.

Examples

Example 1

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

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

Example 2

The following example deletes the Agent named test.example.com:1836 and all of its monitored targets. The Agent must be marked UNREACHABLE in Enterprise Manger Cloud Control to perform this operation.

emcli delete_target
      -name="test.example.com:1836"
      -type="oracle_emd"
      -delete_monitored_targets
      -async

Example 3

The following example deletes the example_ias_farm target with the name "farm01_base_domain" and all of its members, such as domain, clusters, servers, application deployments, and so forth.

emcli delete_target
      -name="farm01_base_domain"
      -type="example_ias_farm"
      -delete_members

delete_test

Deletes a Services test along with its constituent steps and step groups.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Service target name.

• type

  Service target type.

• testname

  Name of the test.

• testtype

  Type of test.

Example

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

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

delete_test_threshold

Deletes a test threshold.

Format

emcli delete_test_threshold
      -name=<target_name>
      -type=<target_type>
      -testname=<test_name>
      -testtype=<test_type>
      -metricName=<metric_name>
      -metricColumn=<metric_column>
      [-beaconName=<beacon_name>]
      [-stepName=<step_name>]
      [-stepGroupName=<stepgroup_name>]

[ ] indicates that the parameter is optional

Parameters

• name

  Service target name.

• type

  Service target type.

• testname

  Name of the test.

• testtype

  Type of test.

• metricName

  Name of the metric.

• metricColumn

  Name of the column.

• beaconName

  Name of the beacon.

• stepName

  Name of the step.

• stepGroupName

  Name of the step group.

Example

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

delete_user

Deletes an existing Enterprise Manager administrator.

When a user is deleted, all jobs the user creates are stopped and deleted. Also, any blackouts the user creates are deleted. However, a user cannot be deleted if any blackouts the user creates are active at the time the call to delete the user is issued. This situation is considered an invalid state from which to delete a user. First, all of these active blackouts must be stopped, and a thwarted delete user call must be reissued.

Format

emcli delete_user
      -name=<user_name>
      [-new_object_owner=<user_name>]
      [-force]

[ ] indicates that the parameter is optional

Parameters

• name

  Administrator name.

• new_object_owner

  Name of the administrator to assign the secure objects owned by the current administrator being deleted. If you do not specify this option, the secure objects are deleted that are owned by the administrator being deleted.

• force

  Deletes the administrator even if the administrator is currently logged in.

Examples

Example 1

The following example deletes the Enterprise Manager administrator named sysman3.

emcli delete_user -name=sysman3

Example 2

The following example deletes the Enterprise Manager administrator named user1, and assigns all the secure objects owned by user1 to user5.

deploy_bipublisher_reports

Deploys the Enterprise Manager system reports to a configured and running BI Publisher server. By default, all installed reports are deployed. Alternatively, you can restrict the deployment to certain plug-ins.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 -force.

Format

emcli deploy_bipublisher_reports
    [-force]
    [-pluginid=<plugin_id>]
    [-pluginversion=<plugin_version>]
    [-reportsjarfile=<reports_jar_file>]

[ ] indicates that the parameter is optional

Parameters

• force

  Overwrites reports. If you use this option, all reports on the BI Publisher server are overwritten with the new copies.

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

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

Examples

Example 1

emcli deploy_bipublisher_reports -force

Example 2

The following example deploys the upgraded Chargeback and Trending reports shipping with Enterpise Manager 12cR2 (12.1.0.2).

emcli deploy_bipublisher_reports -pluginid=oracle.sysman.emct -pluginversion=12.1.0.3.0

deploy_plugin_on_agent

Deploys a plug-in on Management Agents. Agent names must be provided for plug-in deployment.

Format

emcli deploy_plugin_on_agent 
        -agent_names=<agent1;agent2>
        -plugin=<plug-in_id[:version>]
        [-discovery_only]

[ ] indicates that the parameter is optional

Parameters

• agent_names

  Management Agents (host:port) on which the plug-in needs to be deployed.

• plugin

  Plug-in ID and version that needs to be deployed. Version is optional, and it defaults to the latest applicable version deployed on the management server. If a later version is available but not certified on the Agent OS platform, the latest version is not picked up.

• discovery_only

  To be used when only discovery content needs to be deployed.

Examples

Example 1

The following example deploys the latest version of oracle.sysman.db2 on Management Agent myhost1.example.com.

emcli deploy_plugin_on_agent -plugin="oracle.sysman.db2"  -agent_names="myhost1.example.com:1838"

Example 2

The following example deploys version 12.1.0.1.0 of plug-in oracle.sysman.db2 on management agent myhost1.us.oracle.com.

emcli deploy_plugin_on_agent 
      -plugin="oracle.sysman.db2:12.1.0.1.0" 
      -agent_names="myhost1.us.oracle.com:1838"

deploy_plugin_on_server

Deploys a plug-in on the Management Servers. The deployment process for some plug-ins might restart the Management Servers. If the plug-in is already deployed on one of the servers, this server is skipped. If a lower version of the plug-in is already deployed, the plug-in is upgraded. If a lower revision of the plug-in is already deployed, the new revision is applied.

Format

emcli deploy_plugin_on_server 
        -plugin=<plug-in_id>[:<version>]
        [-sys_password=<sys_password>]
        [-prereq_check]
        [-use_last_prereq_result]

[ ] indicates that the parameter is optional

Parameters

• plugin

  ID or ID:Version of the plug-in to be deployed on the Management Servers of the form -plugin=<oracle.sysman.db:12.1.0.1.0>, where the plug-in ID (like oracle.sysman.db) is a required parameter, and the version is optional. If do not specify a version, the highest version of the plug-in that has been downloaded is considered for deployment. If multiple revisions of this plug-in version are downloaded, the highest revision is considered for deployment.

• sys_password

  Password of the repository DBA SYS. If you do not provide this , you are prompted for the password. This is not required if you use the prereq_check .

• prereq_check

  If you provide this option, instead of deploying the plug-in, the verb displays only a check for all the unfulfilled prerequisites for this plug-in deployment to be successful. If you do not provide this option, plug-in deployment follows a prerequisities check.

• use_last_prereq_result

  If prerequisites checks have been performed previously for a given set of plug-ins using the -prereq_check option and no other deployment activity occurred for these plug-ins, you can use this option to skip prerequisite checks and start the deployment immediately.

Examples

Example 1

The following example deploys the latest downloaded version of Oracle Database plug-in (plug-in ID: oracle.sysman.db) on the management server.

emcli deploy_plugin_on_server 
      -plugin=oracle.sysman.db 
      -sys_password=<sys_password>

Example 2

The following example deploys the latest downloaded version of a Oracle Database plug-in (plug-in ID: oracle.sysman.db) and Oracle Fusion Middleware plug-in (oracle.sysman.emas) on the management server.

emcli deploy_plugin_on_server 
      -plugin="oracle.sysman.db;oracle.sysman.emas" 
      -sys_password=<sys password> 

Example 3

The following example deploys the Oracle Database plug-in (with version 12.1.0.2.0) and Oracle Fusion Middleware plug-in (version 12.1.0.2.0) on the management server. Since sys password has not been passed on the command line, you are prompted for it.

emcli deploy_plugin_on_server 
      -plugin="oracle.sysman.db:12.1.0.2.0;oracle.sysman.emas:12.1.0.2.0"

Example 4

The folllowing example deploys the Oracle Database plug-in (with version 12.1.0.2..0) and Oracle Fusion Middleware plug-in (12.1.0.2.0) on the management server. Since sys password has not been passed on the command line, you are prompted for it. If a lower version of both plug-ins have already been deployed, they are upgraded to 12.1.0.2.0. If a lower version of only one of the plug-ins is deployed, this generates an error, and you will have to deploy them separately.

emcli deploy_plugin_on_server 
      -plugin="oracle.sysman.db:12.1.0.2.0;oracle.sysman.emas:12.1.0.2.0"

Example 5

The following example only performs prerequisite checks on the Oracle Database plug-in and does not actually deploy the plug-in.

emcli deploy_plugin_on_server 
      -plugin=oracle.sysman.db:11.2.0.1.0 -prereq_check

describe_job

Describes a job and gets its properties for a job you have submitted using the create_job verb. The output can be redirected into a file and used as a template.

Format

emcli describe_job
     -name=<job_name>
     [-owner=<job_owner>]
     [-verbose]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the job to describe.

• owner

  Enterprise Manager administrator who owns this job. If not provided, the current EM CLI logged-in administrator is assumed as the owner. The logged-in Enterprise Manager administrator must have at least the view privilege to describe a job.

• verbose

  Outputs a help template along with the properties.

Examples

Example 1

The following example describes the library job "myJob" owned by the logged-in Enterprise Manager administrator.

emcli describe_job -name=myJob

Example 2

The following example describes the library job "yourJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this job.

emcli describe_job -name=yourJob -owner=admin1

Example 3

emcli describe_job -name=EMCLI_JOB_2

# Job Name : EMCLI_JOB_2

# Current status of the job is ACTIVE.

# Job Type: OSCommand.
# This job type supports the following target types only :
# host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
job_target_list.1=adc2110610.us.oracle.com:host
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=hello
 
# Variable: command
# Description: Command to run on the target
variable.command=echo
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.adc2110610.us.oracle.com:host=NAMED:SYSMAN:CRED1
 
schedule.frequency=REPEAT_BY_MINUTES
schedule.startTime=2012-02-01 01:01:01.0
schedule.endTime=2051-02-01 01:01:01.0
schedule.gracePeriod=-1
schedule.months=
schedule.days=
schedule.interval=1
schedule.timezone.type=TIMEZONE_TARGET
schedule.timezone.targetIndex=1
schedule.timezone.zoneOffset=0
schedule.timezone.region=

Example 4

emcli describe_job -name=EMCLI_JOB_2 -verbose

# Job Name : EMCLI_JOB_2

# Current status of the job is ACTIVE.

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
 
# Target List. 
# In a target list, each member is specified using the target name and target type # in the fashion:
#    target_name:target_type
# To specify an element of the target list, the following notation is used:
#    job_target_list.1=target_name:target_type
# The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element.
# The target target_name:target_type should exists in EM.
# Permissible target types are: 
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
# A sample target list could be: 
# job_target_list.1=<target_name>:host
# job_target_list.2=<target_name>:host
# The target list can only contain targets of the same target type. A cluster,  # group, domain or system 
# target must not be intermixed with targets of the other target types.
 
 
# Variable List. 
# In a variable list, each member is specified in the following way: 
# Scalar variable: A variable whose value can be represented as a single string.
#    variable.variable_name=variable_value
# Here "variable" is a keyword. Variable name is the name of the variable whose  # value is being specified.
# Value is specified on the right hand side after the equal to sign.
# Vector variable: A variable whose value is represented as an array or list of  # string values.
#    variable.variable_name.1=value1
#    variable.variable_name.2=value2
# Here the numbers suffixing the variable name signify the entry number in the   # list.
# Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable.
#    variable.large_variable_name=a_very_very_big_value
 
 
# Credential List. 
# This is the list of credential usages declared by the job type. 
# Each entry takes the form: 
#    cred.credusage_name.target_details=cred_type:cred_details
# Here the prefix "cred" is a keyword signifying that this line represents a  # credential entry.
# "credusage_name" would be substituted with the name of the credential usage  # declared in the job type.
# This is followed by the target details, which take the following form:
#    target_name:target_type
# The value for this credential usage entry is specified using the type of the  # credential and its details.
# "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential.
# "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type"
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a credential set could look like:
#    cred.defaultHostCred.target1:host=SET:HostCredsNormal
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential could look like:
#    cred.defaultHostCred.target1:host=NAMED:MyNamedCredential
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential shared by EM Admin "admin1" could look like:
#    cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential
 
# Schedule.
# Specify a schedule for the job. Detailed instructions as per below:
# Frequency: Specifies the frequency of repeatedly submitting instances of this  # job.
#    scheule.frequency=Frequency_Type
# Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY,  # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS.
# If frequency is IMMEDIATE, then other schedule fields do not matter.
# Start Time: Start time for the schedule.
#    scheule.startTime=MM-DD-YYYY
# End Time: End time for the schedule.
#    scheule.endTime=MM-DD-YYYY
# Grace Period: Grace period in minutes for the schedule.
#    scheule.graceperiod=
# Months : Months for repetition. January is denoted by 0 and December by 11
#    schedule.months=0,1,2
# Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6.
#    schedule.days=0,1,2
# Timezone: Timezone information is further detailed into type, target index, zone # offset and region.
#    schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED,  # TIMEZONE_REGION_SPECIFIED.
#    schedule.timezone.targetIndex : specify the index of the target whose  # timezone is to be used.
#    schedule.timezone.zoneOffset : timezone offset.
#    schedule.timezone.region : timezone region
# Following is a complete schedule section, remove #  and populate the values for # submission:
# scheule.frequency=ONCE
# schedule.startTime=12-21-2012
# schedule.endTime=12-21-2012
# schedule.gracePeriod=10
# schedule.months=
# schedule.days=
# schedule.timezone.type=TIMEZONE_TARGET
# schedule.timezone.targetIndex=1
# schedule.timezone.zoneOffset=
# schedule.timezone.region=

job_target_list.1=adc2110610.us.oracle.com:host
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=hello
 
# Variable: command
# Description: Command to run on the target
variable.command=echo
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.adc2110610.us.oracle.com:host=NAMED:SYSMAN:CRED1
 
schedule.frequency=REPEAT_BY_MINUTES
schedule.startTime=2012-02-01 01:01:01.0
schedule.endTime=2051-02-01 01:01:01.0
schedule.gracePeriod=-1
schedule.months=
schedule.days=
schedule.interval=1
schedule.timezone.type=TIMEZONE_TARGET
schedule.timezone.targetIndex=1
schedule.timezone.zoneOffset=0
schedule.timezone.region=

describe_job_type

Describes the job type and gets its properties. The output can be redirected into a file.

This verb dumps out a properties file for a job type that supports the Job System Generic EM CLI. This file contains some documentation, a list of all required credential usages, and a list of all variables required to create a (library) job instance of the job type.

Format

emcli describe_job_type
     -job_type=<job_type_internal_name>
     [-verbose]

[ ] indicates that the parameter is optional

Parameters

• job_type

  Specify the name of the job type to describe. You can use the get_job_types verb to obtain the names of all job types for which a job or library jobs can be created using EM CLI.

• verbose

  Outputs a help template along with the properties.

Examples

Example 1

The following example describes the job type "MyJobType."

emcli describe_job_type -job_type=MyJobType

Example 2

The following example produces a property file on the console, which can be redirected to a file and used multiple times.

emcli describe_job_type -job_type=OSCommand

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=
 
# Variable: command
# Description: Command to run on the target
variable.command=
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.<target_name>:<target_type>=

Example 3

The following example with the verbose option generates a property dump with help on how to specify each individual property for the job.

emcli describe_job_type -job_type=OSCommand -verbose

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
 
 
# Target List. 
# In a target list, each member is specified using the target name and target type # in the fashion:
#    target_name:target_type
# To specify an element of the target list, the following notation is used:
#    job_target_list.1=target_name:target_type
# The suffix "1" after the key word "job_target_list" signifies that the entry is # for the first element.
# The target target_name:target_type should exists in EM.
# Permissible target types are:  host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.
# A sample target list could be: 
# job_target_list.1=<target_name>:host
# job_target_list.2=<target_name>:host
# The target list can only contain targets of the same target type. A cluster,  # group, domain or system 
# target must not be intermixed with targets of the other target types.

# Variable List. 
# In a variable list, each member is specified in the following way: 
# Scalar variable: A variable whose value can be represented as a single string.
#    variable.variable_name=variable_value
# Here "variable" is a keyword. Variable name is the name of the variable whose  # value is being specified.
# Value is specified on the right hand side after the equal to sign.
# Vector variable: A variable whose value is represented as an array or list of  # string values.
#    variable.variable_name.1=value1
#    variable.variable_name.2=value2
# Here the numbers suffixing the variable name signify the entry number in the  # list.
# Large variable: A variable whose value is exceptionally large. Syntax is similar # to a scalar variable.
#    variable.large_variable_name=a_very_very_big_value
 
# Credential List. 
# This is the list of credential usages declared by the job type. 
# Each entry takes the form: 
#    cred.credusage_name.target_details=cred_type:cred_details
# Here the prefix "cred" is a keyword signifying that this line represents a  # credential entry.
# "credusage_name" would be substituted with the name of the credential usage  # declared in the job type.
# This is followed by the target details, which take the following form:
#    target_name:target_type
# The value for this credential usage entry is specified using the type of the  # credential and its details.
# "cred_type" can take either "SET" or "NAMED" as its value, depending on whether # the credential is a credential set or a named credential.
# "cred_details" can specify either the name of a credential set or the name of a # named credential based on the "cred_type"
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a credential set could look like:
#    cred.defaultHostCred.target1:host=SET:HostCredsNormal
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential could look like:
#    cred.defaultHostCred.target1:host=NAMED:MyNamedCredential
# A sample entry for a target target1:host for credential usage defaultHostCred  # for a named credential shared by EM Admin "admin1" could look like:
#    cred.defaultHostCred.target1:host=NAMED:admin1:MyNamedCredential
 
# Schedule.
# Specify a schedule for the job. Detailed instructions as per below:
# Frequency: Specifies the frequency of repeatedly submitting instances of this  # job.
#    scheule.frequency=Frequency_Type
# Frequency type could be either of IMMEDIATE, ONCE, WEEKLY, MONTHLY, YEARLY,  # REPEAT_BY_MINUTES, REPEAT_BY_HOURS, REPEAT_BY_DAYS, REPEAT_BY_WEEKS.
# If frequency is IMMEDIATE, then other schedule fields do not matter.
# Start Time: Start time for the schedule.
#    scheule.startTime=MM-DD-YYYY
# End Time: End time for the schedule.
#    scheule.endTime=MM-DD-YYYY
# Grace Period: Grace period in minutes for the schedule.
#    scheule.graceperiod=
# Months : Months for repetition. January is denoted by 0 and December by 11
#    schedule.months=0,1,2
# Days: Days of the week for repetition. Sunday is denoted by 0 and Saturday by 6.
#    schedule.days=0,1,2
# Timezone: Timezone information is further detailed into type, target index, zone # offset and region.
#    schedule.timezone.type: either of TIMEZONE_TARGET, TIMEZONE_SPECIFIED,  # TIMEZONE_REGION_SPECIFIED.
#    schedule.timezone.targetIndex : specify the index of the target whose  # timezone is to be used.
#    schedule.timezone.zoneOffset : timezone offset.
#    schedule.timezone.region : timezone region
# Following is a complete schedule section, remove #  and populate the values for # submission:
# scheule.frequency=ONCE
# schedule.startTime=12-21-2012
# schedule.endTime=12-21-2012
# schedule.gracePeriod=10
# schedule.months=
# schedule.days=
# schedule.timezone.type=TIMEZONE_TARGET
# schedule.timezone.targetIndex=1
# schedule.timezone.zoneOffset=
# schedule.timezone.region=
 
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=
 
# Variable: command
# Description: Command to run on the target
variable.command=
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.<target_name>:<target_type>=

describe_library_job

Describes a library job and gets its properties. The output can be redirected into a file.

Format

emcli describe_library_job
     -name=<job_name>
     [-owner=<job_owner>]
     [-verbose]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the library job to describe.

• owner

  Enterprise Manager administrator who owns this library job. If not provided, the current EM CLI logged-in administrator is assumed as the owner. The logged-in Enterprise Manager administrator must have at least the view privilege to describe a job.

• verbose

  Outputs a help template along with the properties.

Examples

Example 1

The following example describes the library job "myLibJob" owned by the logged-in Enterprise Manager administrator.

emcli describe_library_job -name=myLibJob

Example 2

The following example describes the library job "yourLibJob" owned by the Enterprise Manager administrator "admin1". The logged-in Enterprise Manager administrator has view privilege on this library job.

emcli describe_library_job -name=yourLibJob -owner=admin1

Example 3

emcli describe_library_job -name=MYJOB1

# Job Name : MYJOB1

# Current status of the job is ACTIVE.

# Job Type: OSCommand.
# This job type supports the following target types only :
host,j2ee_application,metadata_repository,oracle_apache,oracle_apm,oracle_beacon,oracle_csa_collector,oracle_database,oracle_emd,oracle_emrep,oracle_home,oracle_ias_farm,oracle_oms,oracle_oms_console,oracle_oms_pbs,weblogic_domain,weblogic_j2eeserver.

 
job_target_list.1=adc2110610.us.oracle.com:host
 
# Variable: args
# Description: Parameters of the command to run on the target
variable.args=hello
 
# Variable: command
# Description: Command to run on the target
variable.command=echo
 
# Credential Usage: defaultHostCred
# Description: 
cred.defaultHostCred.adc2110610.us.oracle.com:host=NAMED:SYSMAN:CRED1
 
schedule.frequency=REPEAT_BY_MINUTES
schedule.startTime=2012-02-01 01:01:01.0
schedule.endTime=2051-02-01 01:01:01.0
schedule.gracePeriod=-1
schedule.months=
schedule.days=
schedule.interval=1
schedule.timezone.type=TIMEZONE_TARGET
schedule.timezone.targetIndex=1
schedule.timezone.zoneOffset=0
schedule.timezone.region=

describe_patch_plan_input

Describes the input data of a patch plan.

Format

emcli describe_patch_plan_input
        -name=<name>

Parameters

• name

  Name of a given patch plan.

Example

emcli describe_patch_plan_input -name="plan_name

See Also

upload_patches

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

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

describe_procedure_input

Describes the input data of a deployment procedure or a procedure configuration.

Format

emcli describe_procedure_input
      [-procedure=<procedure_GUID>]
      [-name=<procedure_name_or_procedure_conf>]
      [-owner=<procedure_owner_or_procedure_config>]
      [-parent_proc=<procedure_of_procedure_config>]

[ ] indicates that the parameter is optional

Parameters

• procedure

  GUID of the procedure to execute.

• name

  Name of the procedure or procedure configuration.

• owner

  Owner of the procedure or procedure configuration.

• parent_proc

  Procedure of the procedure configuration. This applies to describe a procedure configuration when both a procedure and a procedure configuration have the same name.

Examples

emcli describe_procedure_input -procedure=16B15CB29C3F9E6CE040578C96093F61 > describeDP.properties

diagchecks_deploy_status

Gets the status of diagnostic checks deployments against different target types.

Format

emcli diagchecks_deploy_status
        [-target_type=<type>]*

[ ] indicates that the parameter is optional

Parameters

• target_type

  Type of target. You can specify multiple values.

diagchecks_deploy_tglist

Gets the target list for a particular deployment type for a target type.

Format

emcli diagchecks_deploy_tgtlist
        -target_type=<type>
        -deploy_type=<CURRENT|OLDER|MISSING|ALL>
        [-show_excludes]

[ ] indicates that the parameter is optional

Parameters

• target_type

  Type of target. You can specify multiple values.

• deploy_type

  Deployment type of either CURRENT, OLDER, MISSING, or ALL.

• show_excludes

  For targets where excludes have been set, print them.

disable_audit

Disables auditing for all user operations.

Format

emcli disable_audit

Example

The following example disables auditing for all operations.

emcli disable_audit

disable_sla

Disables an SLA for a target.

Format

emcli disable_sla
    -targetName=<target_name>
    -targetType=<target_type>
    -slaName=<SLA_name>

Parameters

• targetName

  Name of the target.

• targetType

  Type of target.

• slaName

  Name of the SLA.

Examples

The following example disables an SLA named 'gold_sla' for target my_service (generic_service).

emcli disable_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla'1

disable_test

Disables monitoring of a Services test.

Format

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

Parameters

• name

  Service target name.

• type

  Service target type.

• testname

  Test name.

• testtype

  Test type.

Examples

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

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

discover_coherence

Discovers one or more Coherence clusters.

Format

emcli discover_coherence
      -input_file=coherence_discovery_file:file_path
      [-debug]

[ ] indicates that the parameter is optional

Parameters

• input_file

  Fully-qualified path to a CSV-formatted file containing one line of details per Coherence cluster. The valid WebLogic version value is 10. The structure of the CSV file is as follows:

  <Management Node host machine name>,
            <Management Node listen port>,
            <Management Node username - optional>,
            <Management Node password - optional>,
            <Management Node service name - optional>,
            <Agent url>        
  

  For example:

  host1.companyA.com,9910,,,,https://host1.companyA.com:3872/emd/main/,
  

• debug

  Runs the verb in verbose mode for debugging purposes.

Examples

The following example reads the my_clusters_info.csv file to determine the clusters to be added to Cloud Control.

emcli discover_coherence 
  -input_file=coherence_discovery_file:"c:\emcli\my_clusters_info.csv

discover_fa

Discovers multiple Fusion Applications domains by reading the Fusion Applications domain discovery file and saving the host-wise discovered targets to the Agents provided in the Host Agent Mapping file. If the Host Agent mapping file is not provided, the local Agent (that is, the Agent on the same host as the target) is used to save/monitor the discoverd targets as well. If a local Agent is not found, the default discovery Agent is used to save/monitor the discoverd targets as well.

Format

emcli discover_fa
      -input_file=fa_domain_discovery_file:file_path
      [-input_file=host_agent_mapping_file:file_path]
      [-input_file=pf_domain_cred_mapping_file:file_path]
      [-debug]

[ ] indicates that the parameter is optional

Parameters

• input_file=fa_domain_discovery_file

  Fully-qualified path to a CSV-formatted file containing one line of details per domain to be added. The valid WebLogic version value is 10. The structure of the CSV file is as follows:

  <WebLogic Server version>,
  <Administration Server host machine name>,
  <Administration Server listen port>,
  <Administration Server username>,
  <Administration Server password>,
  <External Parameters - al>,
  <JMX Protocol - required only if SSL enabled>,
  <JMX Service URL - required only if SSL enabled>,
  <Unique Domain Identifier>,
  <Agent url - al>,
  <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 - al - 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
  

• 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
  

• input_file=pf_domain_cred_mapping_file

  Fully-qualified path to a CSV-formatted file containing multiple lines of WebLogic admin credentials for each domain of a fusion instance, where the credentials are different from those added in the fa_domain_discovery file.

  The same credentials are used for all the domains in a Fusion Application instance unless the credentials are overwritten in the pf_domain_cred_mapping file.

  For example:

  <UniqueKey - "<Fusion Instance       Identifier><CommonDomainDisplayName>">,<Administration Server       username>,<Administration Server password>,
  <UniqueKey - "<Fusion Instance       Identifier>-<CommonDomainDisplayName>">,<Administration Server       username>,<Administration Server password>,<Administration Server Host       Name>
  
  Example:
  fi9-FS,weblogic12,welcome1,
  fi9-PRJ,faadmin,fusionfa1,
  fi9-PRC,faadmin,fusionfa1,adcdbb05.us.oracle.com
  fi9-PRC,,,adcdbb05.us.oracle.com
  

• debug

  Runs the verb in verbose mode for debugging purposes.

Examples

Example 1

The following example reads the my_domains_info.csv file to determine the Fusion Instances to be added to Cloud Control, reads the my_agent_mapping.csv file to determine which Agents should monitor which host's Managed Servers, and reads the my_domain_cred_mapping.csv file to determine which credentials are to be used to discover an individual product family.

emcli discover_fa 
      -input_file=fa_domain_discovery_file:c:\emcli\my_domains_info.csv 
      -input_file=host_agent_mapping_file:c:\emcli\my_agent_mapping.csv 
      -input_file=pf_domain_cred_mapping_file:c:\emcli\my_domain_cred_mapping.csv 

Example 2

emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_file:/tmp/emcli/ host_agent_mapping_file.txt -debug

Example 3

emcli discover_fa -input_file=fa_domain_discovery_file:/tmp/emcli/ domain_discovery_file.txt -input_file=host_agent_mapping_filee:/tmp/emcli/ host_agent_mapping_file.txt -input_file=pf_domain_cred_mapping_file:/tmp/emcli/ pf_domain_cred_mapping_file.txt -debug

discover_wls

Purpose

Used to discover one or more version 7.x, 8.x, 9.x, and 10.x WebLogic Domains (along with Oracle Fusion Middleware 11g software deployed to it), and to specify which Management Agent should monitor which hosts' Managed Servers. Specifying which Management Agent should monitor which hosts' Managed Servers is a feature supported only with versions 9.x and 10.x of WebLogic Server. If you want to discover version 7.x or 8.x of WebLogic Server, you cannot specify which Management Agent to monitor which hosts' Managed Servers; the Management Agent used to perform discovery automatically monitors all WebLogic Servers within the version 7.x or 8.x domain.

Function

This verb discovers one or more Oracle WebLogic Server Domains. It reads a file labeled domain_discovery_file to discover WebLogic Server versions 7.x, 8.x, 9.x, and 10.x. Note that if you attempt to discover an already discovered WebLogic Server, the discovered WebLogic Server domain will be refreshed.

Requirements

To discover the WebLogic Server, the Administration Server must be up and running. After initial discovery or during refresh of domain membership, the Administration Server is not required to be up for general WebLogic Server monitoring. After initial discovery or during refresh of domain membership, the Managed Server is not required to be up for general WLS monitoring.

domain_discovery_file is required; discovery cannot occur without it. You must create the CSV (comma-separated values) formatted file before performing discovery. To save the discovered components (WebLogic Server versions 9.x and 10.x only) to a specific Management Agent for monitoring, the discover_wls verb reads a second file labeled host_agent_mapping_file. If host_agent_mapping_file does not exist, the Management Agent specified in domain_discovery_file that performs the actual discovery is used as the Agent that monitors all discovered targets.

https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&id= 412431.1

Format

emcli discover_wls
        -input_file=domain_discovery_file:file_path
        [-input_file=host_agent_mapping_file:file_path]
        [-debug]

[ ] indicates that the parameter is optional

Parameters

• input_file=domain_discovery_file

  Fully-qualified path of the CSV (Comma-Separated Values) formatted file that contains one line of details per domain to be added. This is valid for WebLogic Server versions 7.x, 8.x, 9.x, and 10.x. Each line has the format shown for domain_discovery_file in the "File Structures" section below.

  Note the following points about the format of domain_discovery_file:

  Parameters —

  • The order of parameters is fixed. You must provide the parameters in the same order as shown for domain_discovery_file in the "File Structures" section below.

  • If you want to use a comma ( , ) in any of the parameters provided, you must escape the comma with a backslash as shown in the following example, in which a backslash precedes the comma in the password my,pwd:

    10,domain123.xyx.us,11990,weblogic,my\,pwd,,,farm_demo,https://myco01.mycompany.com:3872/emd/main
    

  Delimeters —

  • Use a comma ( , ) as the delimiter.

  • The total number of delimiters in each line is fixed and should be equal to 9 for WebLogic Server versions 7.x, 8.x, 9.x, and 10.x.

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

• input_file=host_agent_mapping_file

  Fully-qualified path of the CSV (Comma-Separated Values) formatted file that contains multiple lines of host system names where managed servers are to be monitored, and specifies the Management Agent used to monitor each host's managed servers. This is only valid for WebLogic Server versions 9.x and 10.x. Each line has the following format:

  <Discovered_target_host_machine_name>,<Agent_URL_to_save/monitor_the_host>
  

  For example:

  myco01.mycompany.com,https://myco01.mycompany.com:3872/emd/main
  myco02.mycompany.com,https://myco02.mycompany.com:3872/emd/main
  myco03.mycompany.com,https://myco03.mycompany.com:3872/emd/main
  

  Definitions for the parameters are as follows:

  • Discovered_target_host_machine_name

    Host machine with installed WebLogic Servers that need to be discovered. Use full host names, such as myco01.mycompany.com instead of myco01.

  • Agent_URL_to_save/monitor_the_host

    URL for the Management Agent to be used to monitor all discovered targets on the corresponding host.

  Note the following points about the format of host_agent_mapping_file:

  • Use a comma ( , ) as the delimiter.

  • The total number of delimeters in each line is fixed and should be equal to 1.

  • The order of parameters is fixed. You must provide the parameters in the same order as shown in the sample file structure in the "File Structures" section below. Discovered_target_host_machine_name and Agent_URL_to_save/monitor_the_host are both mandatory parameters.

• debug

  Runs this verb in verbose mode for debugging purposes.

File Structures

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

The following example shows the structure of a sample domain_discovery_file for WebLogic Server versions 7.x and 8.x. The same Management Agent is used to discover and save the targets. OPT signifies an optional parameter. The last entry shows the format when the optional parameters, Administration Server Home Directory and Trusted Keystore Filename, are not provided.

<WebLogic Server version>,<Administration Server Host>,<port>,<Administration Server Username>,<password>,<Trusted Keystore Filename - OPT>,<Administration Server Home Directory - OPT>,<Agent Host>,<Agent Host username>,<Agent Host password>

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

• WebLogic Server version

  Valid values are 7 or 8. The following example shows a sample entry in domain_discovery_file to discover WebLogic Server version 8:

  8,myhost.us.mycompany.com,7001,weblogic,welcome1,,,myhost.us.mycompany.com, oracle,welcome1
  

• Administration Server Host

  Full host name of the WebLogic Administration Server that needs to be discovered; for example, myhost.us.mycompany.com. This is a mandatory parameter.

• port

  Listen port of the WebLogic Administration Server.

• Administration Server Username

  Login user name for the WebLogic Administration Server.

• password

  Login password for the WebLogic Administration Server.

• Trusted Keystore Filename

  Absolute path of the Trusted Keystore Filename. This is required if the Administration Server's port is SSL enabled. If the Management Agent is on a different system than the WebLogic Server to be managed, you must manually copy the Trusted Keystore file to an accessible directory on the Management Agent system prior to discovery, and then use this path.

• Administration Server Home Directory

  Absolute path of the directory where the weblogic.jar file is located. If the Management Agent is on a different system than the Administration Server, you must manually copy the weblogic.jar file (located in the <WEBLOGIC_HOME>/server/lib/ directory) to an accessible directory on the Management Agent system prior to discovery, and then use this path.

• Agent Host

  Host name of the Management Agent used to discover and monitor the targets.

• Agent Host Username | Password

  Credentials of the operating system user of the Management Agent host. These credentials are used to discover any Oracle WebLogic Server domains.

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

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

<WebLogic Server version>,<Administration Server Host>,<port>,<username>, <password>,<External Parameters - OPT>,<JMX Protocol - OPT>, <JMX Service URL - OPT>,<Unique Domain Identifier>,<Agent URL -OPT>,<Discover Down Servers - optional - Default if not specified is false (Starting PS1). Before PS1 default was true>,<Use Credential Store - optional - Default if not specified is false>

Definitions for the parameters are as follows:

• WebLogic Server version

  Valid values are 9 or 10. The following example shows a sample entry in domain_discovery_file to discover WebLogic Server version 10:

  10,myco01.mycompany.com,7001,weblogic,welcome1,,,,soa_farm,
  https://myco02.mycompany.com:8723/emd/main
  

• Administration Server Host

  Full host name of the WebLogic Administration Server that needs to be discovered; for example, myco01.mycompany.com. This is a mandatory parameter.

• port

  Listen port of the WebLogic Administration Server.

• username

  Login user name for the WebLogic Administration Server.

• password

  Login password for the WebLogic Administration Server.

• External Parameters

  These parameters are passed to the Java process, which connects to the Administration Server. All of these parameters must begin with -D.

• JMX Protocol

  The Management Agent makes a JMX connection to the Administration Server to discover the domain's members. Valid values are t3, t3s, iiop, and iiops. If you do not provide a protocol, the t3 default is used.

• JML Server URL

  Makes a JMX connection to the Administration Server. If you do not specify this parameter, it is created based on the input parameters.

• Unique Domain Identifier

  Whatever you specify is used as the name for the Oracle Fusion Middleware Farm target type within Cloud Control. This must be a unique name across all farms that Oracle Enterprise Manager Cloud Control manages. The characters ' / ' , '' are not allowed.

• Agent URL

  URL for the Management Agent used to discover the targets. If you do not provide a value, the local Management Agent present on the target WebLogic Server is used. If a Management Agent is not found on the target WebLogic Server, an error is displayed.

• Discover Down Servers

  If this value is true, the servers that are down are discovered. If false, the servers that are down are not discovered.

• Use Credential Store

  If this value is set to true, the verb retrieves the WebLogic credentials from the credential store.

Examples

The following example reads the my_domains_info.csv file to determine the domains to be added to Cloud Control, and reads the my_agent_mapping.csv file to determine which Management Agents should monitor which host's managed servers.

emcli discover_wls
    -input_file=domain_discovery_file:\emcli\my_domains_info.csv
    -input_file=host_agent_mapping_file:\emcli\my_agent_mapping.csv     -debug

The following example manually redirects the output of discover_wls to a file using standard output redirect.

emcli discover_wls input_file=domain_discovery_file:"<fully_qualified_path_of_        domain_discovery_file/domain_discovery_file.csv>” > /tmp/emcli/output_file.out

download_ats_test_databank_file

Downloads the specified databank file corresponding to the given ATS test. If no databank alias is specified, the command downloads all databanks for the test.

Format

emcli download_ats_test_databank_file
        -name=<target_name>
        -type=<target_type>
        -testname=<test_name>
        -testtype=<test_type>
        [-databankAlias=<databank_alias>]
        [-output_dir=<output_directory>]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the target.

• type

  Name of the target type.

• testname

  Name of the test.

• testtype

  Type of test.

• databankAlias

  Databank alias.

• output_dir

  Output directory. If the directory does not exist, it is created.

Examples

Example 1

The following example downloads the databank corresponding to alias1 for the specified test.

emcli download_ats_test_databank_file -name="Service Name"
                                      -type="generic_service"
                                      -testname="Test Name"
                                      -testtype="OATS"
                                      -databankAlias="alias1"

Example 2

The following example downloads all databanks corresponding to the specified test.

emcli download_ats_test_databank_file -name="Service Name"
                                      -type="generic_service"
                                      -testname="Test Name"
                                      -testtype="OATS"

download_ats_test_zip

Downloads the zip bundle corresponding to the specified ATS test.

Format

emcli download_ats_test_zip
        -name=<target_name>
        -type=<target_type>
        -testname=<test_name>
        -testtype=<test_type>
        [-output_dir=<output_directory>]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the target.

• type

  Name of the target type.

• testname

  Name of the test.

• testtype

  Type of test.

• output_dir

  Output directory. If the directory does not exist, it is created.

Examples

emcli download_ats_test_zip -name="Service_Name"
                            -type="Generic_Service"
                            -testname="Test_Name"
                            -testtype="OATS"
                            -output_dir="outputDirectory"

enable_audit

Enables auditing for ALL and BASIC user operations. For other operations, see the update_audit_settings verb.

Format

emcli enable_audit
      [-level=basic]

[ ] indicates that the parameter is optional

Parameters

• level=basic

  Enables auditing for BASIC user operations.

Examples

Example 1

The following example enables auditing for all operations.

emcli enable_audit

Example 2

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

emcli enable_audit -level=basic

enable_sla

Enables an SLA for a target.

Format

emcli enable_sla
    -targetName=<target_name>
    -targetType=<target_type>
    -slaName=<SLA_name>
    [-now]
    [-versionStart=<MM/dd/yyyy hh:mm a>]

[ ] indicates that the parameter is optional

Parameters

• targetName

  Name of the target.

• targetType

  Type of target.

• slaName

  Name of the SLA.

• now

  Enables the SLA now, or uses versionStart for a specific time.

• versionStart

  Specifies when the computation of the SLA should start.

Examples

Example 1

The following example immediately enables an SLA named 'gold_sla' for target my_service (generic_service).

emcli enable_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla' -versionNum=2 -now

Example 2

The following example enables a SLA named 'gold_sla' for target my_service (generic_service). It becomes active and starts computing at '09/23/2012 3:30 PM'.

emcli enable_sla
          -targetName='my_service' -targetType='generic_service'
          -slaName='gold_sla' -versionNum=2 -versionStart='09/23/2012 3:30 PM'

enable_test

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

Format

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

Parameters

• name

  Service target name.

• type

  Service target type.

• testname

  Test name.

• testtype

  Test type.

Examples

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

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

execute_hostcmd

Executes a host command across a set of targets.

Format

emcli execute_hostcmd
      -cmd=<host_command"
      -osscript=<script_to_be_executed>
      -targets=<name1:type1;name2:type2;...>
      -credential_set_name=<name>
      [-input_file=<parameter_tag:script_file>]

[ ] indicates that the parameter is optional

Parameters

• cmd

  Host_command can be any valid host command or group of host commands.

• osscript

  OS script to be executed with the cmd parameter.

• targets

  List of target-name, target-type pairs. The host command is executed across this list of Enterprise Manager targets. All targets must be of the type host or composite, which represents a group of targets. If it is a group, the group is expanded to extract all the host targets, and the host command is executed across these host targets.

• credential_set_name

  The credential_set_name parameter refers to the set name of the preferred credentials stored in the Enterprise Manager repository. If this parameter is not present, HostCredsNormal is used for executing host commands. For the host target type, two credential sets exist:

  • HostCredsNormal — Default unprivileged credential set for a host target

  • HostCredsPriv — Privileged credential set for a host target

    The credential set parameter can only be specified when the override credential parameters such as username and password are not present.

    If provided, the you must fully specify the override credential parameters. For host command, username and password must be specified together.

• input_file

  Used in conjunction with -osscript , this enables you to load the contents of an OS script. The -input_file specifies a mapping between a tag and a local file path. The tag is specified in lieu of actual osscript contents of the -osscript . The tag must not contain colons ( : ) or semi-colons ( ; ).

Examples

Example 1

The following example executes the host command ls -l; against the target stach.example.com:host and host targets contained in the group grp. The stored HostCredsPriv preferred credentials are used for all the targets.

emcli execute_hostcmd
      -cmd="ls -l;"
      -credential_set_name="HostCredsPriv"
      -targets="stach.example.com:host;grp:composite"

Example 2

The following example loads the contents of the script /scratch/dba_scripts/shellscript.sh into the value of -osscript and executes it against target reference.example.com:host and host targets contained in the group grp. The stored HostCredsNormal preferred credentials are used for all the targets.

emcli execute_hostcmd
      -cmd="/bin/sh -s" 
      -osscript="FILE"
      -input_file="FILE:/scratch/dba_scripts/shellscript.sh"
      -credential_set_name="HostCredsNormal"
      -targets="reference.example.com:host;grp:composite"

execute_sql

Executes a SQL command across a set of targets.

Format

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

[ ] indicates that the parameter is optional

Parameters

• sql

  "sql command" is a single SQL statement.

• targets

  List of target-name, target-type pairs. The SQL command executes across this list of Enterprise Manager targets. All targets must be of the type oracle_database or composite, which represents a group of targets. If it is a group, the group expands to extract all the database targets, and the SQL command is executed across these database targets.

• credential_set_name

  Refers to the set name of the preferred credentials stored in the Enterprise Manager repository. If this parameter is not present, the DBCredsNormal and DBHostCreds credential set is used for executing SQL commands. For each target type, several credential sets exist:

  • HostCredsNormal — Default unprivileged credential set for a host target

  • HostCredsPriv — Privileged credential set for a host target

  • DBHostCreds — Host credential set for an oracle_database target

  • DBCredsNormal — Default normal credential set for an oracle_database target

  • DBCredsSYSDBA — sysdba credential set for an oracle_database target

  You can only specify the credential_set_name parameter when the override credential parameters such as [db_|host_]username and [db_|host_]password are not present. If provided, the override credential parameters must be specified fully. For the SQL commands, db_username, db_password, db_role, host_username, and host_password must be present.

• input_file

  Used in conjunction with the -sql option, this option enables you to load the contents of a SQL script. The -input_file option specifies a mapping between a tag and a local file path. The tag is specified in lieu of an actual SQL command for the -sql . The tag must not contain colons ( : ) or semi-colons ( ; ).

Examples

Example 1

The following example executes the SQL command select * from sysman.mgmt_targets; against the target database:oracle_database and database targets contained in the group grp. The stored SYSDBA preferred credentials are used for all the targets.

emcli execute_sql
      -sql="select * from sysman.mgmt_targets;"
      -credential_set_name="DBCredsSYSDBA"
      -targets="database:oracle_database;grp:composite"

Example 2

The following example loads the contents of the script /scratch/dba_scripts/enterprise_schema.sql into the value of -sql, and executes it against target database:oracle_database and database targets contained in the group grp. The stored SYSDBA preferred credentials are used for all the targets.

emcli execute_sql
      -sql="FILE"
      -input_file="FILE:/scratch/dba_scripts/enterprise_schema.sql"
      -credential_set_name="DBCredsSYSDBA"
      -targets="database:oracle_database;grp:composite"

Example 3

The following example executes the SQL command against "asm:osm_instance" and ASM targets contained in the group 'grp'. The SYSASM preferred credentials are used for all the targets.

emcli execute_sql
      -sql="select * from sysman.mgmt_targets;"
      -credential_set_name="ASMCredsSYSASM"
      -targets="asm:osm_instance;grp:composite"

export_compliance_group

Exports a compliance group definition and all of its element definitions given the name, author, and version.

Format

emcli export_compliance_group
      -name=<name>
      -author=<author>
      -version=<name>
      -output_file=<file>

Parameters

• name

  Name of the group to be exported.

• author

  Author of the group to be exported.

• version

  Version of the group to be exported.

• output_file

  Name of the exported file.

Examples

Example 1

emcli export_compliance_group \
     -name="foo" \
     -author="Jonas" \
     -version="99" \
     -output_file="$HOME/reports/group.xml"

export_compliance_standard_rule

Exports a rule to the specified files.

Format

export_compliance_standard_rule
  -name=<name>
  -target_type=<target_type>
  -output_file=<file>

Parameters

• name

  Name of the rule to be exported.

• target_type

  Target type of the rule to be exported.

• output_file

  Name of the exported file.

Examples

Example 1

emcli export_compliance_standard_rule \
     -name="foo" \
     -target_type="weblogic_j2eeserver" \
     -output_file="$HOME/reports/rule.xml"

export_masking_definition

Exports a masking definition in XML format.

Format

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

[ ] indicates that the parameter is optional

Parameters

• definition name

  Masking definition name.

• path

  Path for the file name to save the masking script. The file name is auto-generated. -path and -file are mutually exclusive. Only an absolute path is allowed.

• file

  File name to save the masking script. The file name must include the absolute path. -path and -file are mutually exclusive.

Output Columns

Success/Error messages.

Examples

Example 1

The following example exports the masking definition mask_hr_data to an XML file at the specified path:

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

Example 2

The following example exports the masking definition mask_hr_data to an XML file named abc.xml:

emcli export_masking_definition
      -definition_name=mask_hr_data
      -file=/tmp/abc.xml

export_metric_extension

Exports a metric extension archive file.

Format

emcli export_metric_extension
       -file_name=<metric_extension_archive_name>
       -target_type=<metric_extension_target_type>
       -name=<metric_extension_name>
       -version=<metric_extension_version>

Parameters

• file_name

  Name of the metric extension archive file to export into.

• target_type

  Target type of the metric extension.

• name

  Name of the metric extension.

• version

  Version of the metric extension to be exported.

Example

The following example creates an archive of a metric extension of a given target type, name, and version.

emcli export_metric_extension -file_name=<name of the metric extension archive> -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension>

export_report

Exports an Information Publisher report definition and all of its element definitions given its title and owner.

Format

emcli export_report
      -title=<report_title>
      -owner=<report_owner>
      -output_file=<file>

Parameters

• title

  Title of the report to export.

• owner

  The owner of the report to export. The logged-in emcli user must have view privilege for the report. Target names are not exported. The report is uniquely defined using title and owner, so both must be supplied.

• output_file

  Name of the exported file.

Examples

emcli export_report       -title=Maintenance_Report       -owner=SHIFT1_OPERATOR       -output_file=$HOME/reports/maint_report.xml

export_sla

Extracts the configuration details of an SLA into a local file. If you do not specify slaName and/or version, multiple SLA are exported to the same output file.

Format

emcli export_sla
    -targetName=<target_name>
    -targetType=<target_type>
    [-slaName=<SLA_name>]
    -output_file=<output_filename>

[ ] indicates that the parameter is optional

Parameters

• targetName

  Name of the target.

• targetType

  Type of target.

• slaName

  Name of the SLA.

• output_file

  Output file name of the template. If the file does not exist, it is created; if it already exists, it is overwritten. (This assumes that the extract operation was successful. If the operation fails, no files are created, and any existing files remain unchanged.)

Example

The following example creates an output file named 'service_sla.xml' that contains configuration details of the 'gold_sla' SLA for the target 'my_service'.

emcli export_sla
          -targetName='my_service' 
          -targetType='generic_service'
          -slaName='gold_sla'
          -output_file='service_sla.xml'

export_standard

Exports a standard from the repository to an XML file.

Format

emcli export_standard
      -name=<name>
      -author=<author>
      -version=<name>
      -output_file=<file>

Parameters

• name

  Name of the standard to be exported.

• author

  Author of the standard to be exported.

• version

  Author of the standard to be exported.

• output_file

  Name of the exported file.

Example

emcli export_standard \
     -name=foo \
     -author=Curly \
     -version=99 \
     -output_file=$HOME/reports/standard.xml

export_template

Exports a monitoring template and also exports UDMs in the template. You can export a template to the file system in the form of an XML file, or you can print it on standard output in XML form.

Format

emcli export_template
      -name=<name>
      -target_type=<target_type>
      [-output_file=<file_for_exported_template>]
      [-archive]

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the template. The name and target type uniquely identify a template.

• target_type

  Target type of the template.

• output_file

  Specifies the file to output the template. If not specified, the template prints to stdout.

• archive

  Indicates that the template must be exported as a zip file. When a Metric Extension is included in the template, this option is required to export the template as a zip file.

Examples

Example 1

The following example shows that template XML specified by name HOST_TEMP1 and target type host will be output to the screen.

emcli export_template -name=HOST_TEMP1 -target_type=host

Example 2

The following example shows that template XML specified by name HOST_TEMP1 and target type host will be created in the test.xml file.

emcli export_template -name=HOST_TEMP1 -target_type=host -output_file=test.xml

Example 3

The following example shows that the template archive specified by name HOST_TEMP1 and target type host will be created in the test.zip file.

emcli export_template -name=HOST_TEMP1  -target_type=host -output_file=test.zip -archive

export_update

Exports a Self Update archive file from Enterprise Manager to the specified location.

Format

emcli export_update 
        -id="internal id" 
        -dir="dir" 
        -omslocal 
emcli export_update 
        -id="internal id" 
        -dir="dir" 
        -host="hostname" 
        [-credential_set_name="setname"] | -credential_name="name"            -credential_owner="owner" 

[ ] indicates that the parameter is optional

Parameters

• id

  Internal identification for the update to be exported.

• dir

  Complete path of the directory where the update is to be exported.

• omslocal

  Flag specifying that the directory is accessible from the OMS.

• host

  Target name for a host target where the update is to be exported.

• credential_set_name

  Set name of the preferred credential stored in the repository for the host target. Can be one of the following: HostCredsNormal — Default unprivileged credential set HostCredsPriv — Privileged credential set

• credential_name

  Name of a named credential stored in the repository. You must specify this option along with the credential_owner option.

• credential_owner

  Owner of a named credential stored in the repository. You must specify this option along with the credential_name option.

Examples

Example 1

The following example exports the update archive file to /u01/common/. The directory must exist on the OMS host. In a multiple OMS setup, the request can be processed by any OMS, so the directory should be accessible from the OMS processing the request. This usually means that the directory must be on a shared location accessible from all OMSes.

emcli export_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 
        -dir="/u01/common/" 
        -omslocal

Example 2

The following example exports the update archive file to /u01/common/ on host host1.example.com. The host must be the managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The preferred unprivileged credentials for host host1.example.com are used to push the remote file.

emcli export_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 
        -dir="/u01/common/" 
        -host="host1.example.com" 
        -credential_set_name="HostCredsNormal" 

Example 3

The following example exports the update archive file to /u01/common/ on host host1.example.com. The host must be the managed host target in Enterprise Manager, and the Management Agent on this host must be up and running. The named credentials "host1_creds" owned by user "admin1" are used to push the remote file.

emcli export_update 
        -id="914E3E0F9DB98DECE040E80A2C5233EB" 
        -dir="/u01/common/" 
        -host="host1.example.com" 
        -credential_name="host1_creds" 
        -credential_owner="admin1"

extract_template_tests

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

Format

emcli extract_template_tests
      -templateName=<template_name>
      -templateType=<template_type>
      -output_file=<output_filename>
      [-encryption_key=<key>]

[ ] indicates that the parameter is optional

Parameters

• templateName

  Name of the template.

• templateType

  Type of template.

• output_file

  Name of the output file. If the file does not exist, it will be created; if it already exists, it will be overwritten. (This is assuming the extract operation was successful; if the operation fails, no files are created, and any existing files are left unchanged.)

• encryption_key

  Key to encrypt the file contents. The same key should be used to decrypt the file.

Example

The following example creates a file named my_template.xml containing the variable values and test definitions of the Web Application template my_template. The file contents are encrypted using the key my_password.

emcli extract_template_tests
      -templateName=my_template -templateType=website
      -output_file=my_template.xml -encryption_key=my_password

generate_masking_script

Generates a masking script for the given masking definition.

Format

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

[ ] indicates that the parameter is optional

Parameters

• definition_name

  Name of the masking definition.

• parameters

  List of name-value pairs that represent the credentials required for connecting to the database instance. The supported parameters are db_username, db_password, and db_role.

• credential_name

  Name of the database credential. This parameter is mandatory when the db_username and db_password parameters are not specified.

• input_file

  Used in conjunction with the 'parameters' option, this enables you to store parameter values, such as username and password, in a separate file. This specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific parameter values of the 'parameters' . The tag must not contain colons ( : ) or semi-colons ( ; ).

• script

  This is equivalent to -format='name: script'.

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

Output

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

Examples

Example 1

The following example generates a script for the masking definition named mask_hr_data:

emcli generate_masking_script
      -definition_name=mask_hr_data
      -parameters=db_username:system;db_password:password;db_role:NORMAL

Example 2

The following example generates a script for the masking definition named mask_hr_data. The database password is read from the pwd.txt file.

emcli generate_masking_script
      -definition_name=mask_hr_data
      -parameters=PWD_FILE
      -input_file=PWD_FILE:pwd.txt

Example 3

The following example reads the database credentials from the named credential DB_NC and generates the masking script.

emcli generate_masking_script
      -definition_name=mask_hr_data
      -credential_name=DB_NC

get_agentimage

Gets the Management Agent image for the particular platform and version provided as inputs.

Format

emcli get_agentimage
   -destination=<download_directory> 
   -platform="<platform>"
   [-version=<version>]

[ ] indicates that the parameter is optional.

Parameters

• destination

  Directory where you want to download the Management Agent software. Ensure that you have write permission on this location.

  If the destination directory is titled with two or more words separated by a space, enclose the directory name with double-quotes. For instance, if the destination directory is titled /tmp/linuxagentimage, enter the value as -destination="/tmp/linuxagentimage"

• platform

  Platform for which you want to download the software; this must match one of the platforms for which the software is available on the OMS host. Use the emcli get_supported_platforms command to determine this.

• version

  Version of the Management Agent software that you want to download. If you do not specify this , the version defaults to the OMS version.

Examples

emcli get_agentimage -destination=/tmp -platform=Linux_x86 -version=12.1.0.1.0

get_agentimage_rpm

Gets the Management Agent image for the Linux platform and version provided as inputs, then converts the image as rpm.

Format

emcli get_agentimage_rpm
   -destination=<download_directory> 
   -platform=<platform>
   [-version=<version>]

[ ] indicates that the parameter is optional.

Parameters

• destination

  Directory where you want to download the .rpm file. Ensure that you have write permission on this location.

  If the destination directory is titled with two or more words separated by a space, enclose the directory name with double-quotes. For instance, if the destination directory is titled /tmp/linuxagentimage, enter the value as -destination="/tmp/linuxagentimage"

• platform

  Platform for which you want to download the .rpm file; this must match one of the platforms for which the software is available on the OMS host. Use the emcli get_supported_platforms command to determine this.

• version

  Version of the Management Agent for which you want to download the .rpm file. If you do not specify this , the version defaults to the OMS version.

Examples

emcli get_agentimage_rpm -destination=/tmp -platform=Linuxx86 -version=12.1.0.1.0

get_agent_properties

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• agent_name

  Name of the Management Agent target.

• all

  Shows all Management Agent properties. By default, only basic properties appear.

• format

  Format to display Management Agent properties. Valid values are pretty, script, and csv. By default, values are displayed in pretty format.

Examples

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

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

get_agent_property

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

Format

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

Parameters

• agent_name

  Name of the Management Agent target.

• name

  Name of the Management Agent property.

Examples

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

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

get_aggregate_service_info

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

Format

emcli get_aggregate_service_info
      -name=<name>
      -type=<type>
      [-noheader]
      [-script|-format=
               [name:<pretty|script|csv>];
               [column_separator:<sep_string>];
               [row_separator:<row_sep_string>]
      ]

[ ] indicates that the parameter is optional

Parameters

• name

  Aggregate service name.

• type

  Aggregate service type.

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli get_aggregate_service_info -name=My_Name
      -type=aggregate_service

get_aggregate_service_members

Gets sub-services of an aggregate service instance.

Format

emcli get_aggregate_service_members
      -name=<name>
      -type=<type>
      [-noheader]
      [-script|-format=
                      [name:<pretty|script|csv>];
                      [column_separator:<sep_string>];
                      [row_separator:<row_sep_string>]
      ]

[ ] indicates that the parameter is optional

Parameters

• name

  Aggregate service name.

• type

  Aggregate service type.

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

emcli get_aggregate_service_members -name=My_Name
      -type=aggregate_service

get_blackout_details

Gets detailed information for a specified blackout.

Format

emcli get_blackout_details
      -name=<name>
      [-createdby=<blackout_creator>]
      [-noheader]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:<column_sep_string>];
                 [row_separator:<row_sep_string>];
      ]
[ ] indicates that the parameter is optional

Parameters

• name

  Name of the blackout.

• createdby

  Enterprise Manager user who created the blackout. The default is the current user.

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

Output Columns

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

Examples

Example 1

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

emcli get_blackout_details -name=blackout1

Example 2

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

emcli get_blackout_details -name=blackout1 -createdby=joe

get_blackout_reasons

Lists all blackout reasons, one per line.

Format

emcli get_blackout_reasons

Examples

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

emcli get_blackout_reasons

get_blackout_targets

Lists targets for a specified blackout.

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  Name of the blackout.

• createdby

  Enterprise Manager user who created the blackout. The default is the current user.

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

Output Columns

Target Name, Target Type, Status, Status ID

Examples

Example 1

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

emcli get_blackout_targets -name=blackout1

Example 2

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

emcli get_blackout_targets -name=blackout1 -createdby=joe

get_blackouts

Lists all blackouts or just those for a specified target or one or more hosts. Only the blackouts the user has privilege to view are listed.

Format

emcli get_blackouts
      [-target=<name1:type1> | -hostnames=<host1;host2;...>]
      [-noheader]
      [-script | -format=
                        [name:<pretty|script|csv>];
                        [column_separator:<column_sep_string>];
                        [row_separator:<row_sep_string>];
      ]

[ ] indicates that the parameter is optional

Parameters

• target

  Lists blackouts for this target. When neither this nor the -hostnames option is specified, all blackouts the user has privilege to view are listed.

• hostnames

  Lists blackouts that have a target on one of the specified hosts. The host name is just the target name part of the host target. For example, specify host.example.com, rather than host.example.com:host. When neither this nor the -target option is specified, all blackouts the user has privilege to view are listed.

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format="name:script;column_separator:<column_sep_string>" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • format="name:script;row_separator:<row_sep_string>" row-separates the verb output by <row_sep_string>. Columns are separated by the tab character.

Output Columns

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

Examples

Example 1

The following example shows all blackouts with some details.

emcli get_blackouts

Example 2

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

emcli get_blackouts -target=database2:oracle_database

Example 3

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

emcli get_blackouts -hostnames=myhost.example.com

Example 4

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

emcli get_blackouts -hostnames=myhost.example.com
-hostnames=yourhost.example.com

get_ca_info

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

• Unique identifier of the Certificate Authority (CA) in the Cloud Control repository

• CA description

• CA creation date

• CA expiration date

• Number of Management Agents registered to this CA

• Number of secured Management Agents not registered to any CA

Format

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

[ ] indicates that the parameter is optional

Parameters

• ca_id

  Specifies the Certificate Authority ID.

• details

  For each Certificate Authority, displays the list of Management Agent names whose certificates are issued by it.

Examples

The following example shows output for the CA with the ID of 2 specified.

emcli get_ca_info -ca_id=2
 
     Info about CA with ID: 2
     CA is configured
     DN: EMAILADDRESS=Enterprise.Manager@myomshost.mycompany.com,      CN=myomshost.mycompany.com, OU=EnterpriseManager on myomshost.mycompany.com,      O=EnterpriseManager on myomshost.mycompany.com, L=EnterpriseManager on         myomshost.mycompany.com1, ST=CA, C=US, DC=com
     Serial# : 87539237298512593900
     Valid From: Mon Oct 25 17:01:15 UTC 2011
     Valid Till: Thu Oct 22 17:01:12 UTC 2020
     Number of Agents registered with CA ID 2 is 1
 
     Number of Agents to be re-secured, as OMS is secured using force_newca           : 1

Regarding the force_newca option in the last line, the output shows that a new certificate was created with the ID of 2. Two Management Agents have been re-secured to be registered with this new certificate. The OMS running on myomshost.mycompany.com has been re-secured to be registered with the new certificate created. There is still a Management Agent that needs to be secured to be registered to the new certificate. To retrieve the Management Agent name, you need to run the command "emcli get_ca_info -ca_id=2 -details," which is shown in the next example.

The following example displays the Management Agent names registered with the CA(s) for ID 2.

emcli get_ca_info -ca_id=2 -details
 
     Info about CA with ID: 2
     CA is configured
     DN: EMAILADDRESS=Enterprise.Manager@myomshost.mycompany.com,          CN=myomshost.mycompany.com, OU=EnterpriseManager on myomshost.mycompany.com,         O=EnterpriseManager on myomshost.mycompany.com, L=EnterpriseManager on         myomshost.mycompany.com2, ST=CA, C=US, DC=com
     Serial# : 87539237298512593900
     Valid From: Mon Oct 25 17:01:15 UTC 2011
     Valid Till: Thu Oct 22 17:01:12 UTC 2020
     Number of Agents registered with CA ID 2 is 1
     usagent1.mycompany.com:20872
 
     Following Agents needs to be re-secured, as OMS is secured using force_newca          :

     ukagent1.mycompany.com:1830

get_connection_mode

Gets the My Oracle Supporrt (MOS) connection mode. The two MOS connection modes are online and offline.

Format

emcli get_connection_mode

Parameters

None.

See Also

upload_patches

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

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

get_credtype_metadata

Prints credential-type information for a credential type. The verb prints credential column names. These column names should be used as parameter names for the create_named_credential and modify_named_credential verbs.

Format

emcli get_credtype_metadata 
        -auth_target_type=<ttype>
        -cred_type=<name>

Parameters

• auth_target_type

  Authenticating target type.

• cred_type

  Credential type.

Examples

emcli get_credtype_metadata 
          -auth_target_type=host
          -cred_type=HostCreds

get_duplicate_credential

Gets all the target-scoped named credentials that are the same as the given target-scoped named credential. Duplicate credentials are redundant. Named credentials can be managed better if reused. The same named credential can be reused for all of the usages.

Format

emcli get_duplicate_credential 
        -cred_name=<cred_name>
        [-cred_owner=<cred_owner>]

[ ] indicates that the parameter is optional

Parameters

• cred_name

  Searches duplicates of this credential.

• cred_owner

  Owner of the credential, which defaults to the current user.

Example

The following example gets all of the credentials that are the same as the named credential MyOracleCredential and credential owner Joe.

emcli get_duplicate_credential 
        -cred_name=MyOracleCredential
        -cred_owner=Joe

get_executions

Gets a list of executions of a submission using a submission GUID.

Format

emcli get_executions     -instance=<Instance_GUID>

Parameters

• instance

  Displays all executions of a submission.

Output Columns

ExecutionGUID, Name, Status

Examples

emcli get_executions instance=16B15CB29C3F9E6CE040578C96093F61

get_ext_dev_kit

Downloads the Extensibility Development Kit to your local system. This verb has no parameters and only downloads a kit called edk.zip to the directory where you execute the command. After extracting the contents, you can use this kit to develop extensible components (plug-ins) of Enterprise Manager.

Format

emcli get_ext_dev_kit

Parameters

None.

get_group_members

Lists the members of the specified group.

Note that targets are only listed once, even though they can be in more than one sub-group of the group.

Format

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

Parameters

• name

  Target name of the group.

• type

  Group type: group. Defaults to group.

• depth

  Lists target members in sub-groups to the depth specified. The default is 1. When the depth is set to 0, no group target members are listed, and only the group's existence is verified. When the depth is set to -1, all group and sub-group target members are listed; in this case no groups appear in the output. Note that a target is listed at most once, even though it can be a member of several sub-groups.

• noheader

  Displays tabular information without column headers.

• expand_non_groups

  Lists members of aggregates and the aggregate target. By default, only sub-group target members are listed.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Target Name, Target Type

Examples

Example 1

The following example lists the databases in group db2_group.

emcli get_group_members -name=db2_group

Example 2

The following example verifies that group my_hosts:group exists.

emcli get_group_members -name=my_hosts -depth=0

Example 3

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

emcli get_group_members -name=my_group -depth=-1

Example 4

The following example lists the unique targets in group my_group:group and its sub-groups/aggregates. The aggregate targets are also listed.

emcli get_group_members -name=my_group -depth=-1 -expand_non_groups

get_groups

Lists all groups.

Format

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

[ ] indicates that the parameter is optional

Parameters

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Target Name, Target Type

Example

The following example lists all groups.

emcli get_groups

get_instance_data

Downloads instance submission data.

Format

emcli get_instance_data 
        [-instance=<instance_guid>] 
        [-exec=<execution_guid>] 
        [-name=<execution name>] 
        [-owner=<execution owner>]

[ ] indicates that the parameter is optional

Parameters

• instance

  Instance GUID.

• exec

  Execution GUID.

• name

  Execution name.

• owner

  Execution owner.

Output

Instance properties data.

Examples

emcli get_instance_data -instance=16B15CB29C3F9E6CE040578C96093F61 > data.xml

get_instance_status

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

Format

emcli get_instance_status  
        -instance=<instance_guid> 
        [-exec=<execution_guid>] 
        [-name=<execution_name>] 
        [-owner=<execution_owner>] 
        [-xml [-details] [-showJobOutput [-tailLength=<last_n_characters>]]]

[ ] indicates that the parameter is optional

Parameters

• instance

  Display the details of a procedure instance identified by the GUID number. You can find the GUID number by using the emcli get_instances command.

• exec

  Execution GUID.

• name

  Execution name.

• owner

  Execution owner.

• xml

  Shows the complete status of each of the steps in XML format.

• details

  Displays more details for the command output. This option also requires the -xml option.

• showJobOutput

  Shows the output or errors for the job execution steps. This option also requires the -xml option.

• tailLength

  Limits the number of characters in the job step output or error. This option also requires the -showJobOutput option.

  <Last N Characters> is a positive non-zero number until which the characters are chosen from the end of the job step output. The system sets the maximum permissible characters to dump. If you do not provide this option, the maximum permissible characters are dumped.

Output Columns

GUID, Procedure Type, Instance Name, Status

Examples

Example 1

The following example shows procedure details in CSV format:

emcli get_instance_status -guid=12345678901234567890123456789012

Example 2

The following example shows details in XML format:

emcli get_instance_status -guid=16B15CB29C3F9E6CE040578C96093F61 -xml -details

Example 3

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

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

Example 4

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

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

See Also

get_instances

get_job_execution_detail

get_instances

Displays a list of procedure instances.

Format

emcli get_instances 
      [-type=<procedure_type>]

[  ] indicates that the parameter is optional

Parameters

• type

  Displays all the procedure instances of type procedure_type.

Output Columns

Instance GUID, Execution GUID, Procedure Type, Instance Name, Status

Examples

Example 1

The following example lists all procedure instances:

emcli get_instances

Example 2

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

emcli get_instances -type=PatchOracleSoftware

See Also

get_procedure_types

get_job_execution_detail

Displays details of a job execution.

Format

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

[ ] indicates that the parameter is optional

Parameters

• execution

  Specifies that the ID of the job execution (execution_id) is the job execution ID.

• xml

  Shows the execution details as XML.

• showOutput

  Shows the output of the steps inside the job execution. You can only use this option in conjunction with the -xml option.

• tailLength

  Limits the display of the output to the number of characters from the end of the output. (length) is in characters. You can only use this option in conjunction with the -showOutput option. If you do not specify this option, a system-generated hard limit is enforced.

Examples

Example 1

The following example shows the details in CSV format:

emcli get_job_execution_detail -execution=1234567890123456789012345678901

Example 2

The following example shows the details in XML format:

emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml

Example 3

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

emcli get_job_execution_detail -execution=12345678901234567890123456789012 -xml -showOutput

Example 4

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

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

get_jobs

Lists existing jobs.

Format

emcli get_jobs
      [-job_ids=<ID1;ID2;...>]
      [-targets=<type1:name1;type2:name2;...>]
      [-status_ids=<status1;status2;...>]
      [-noheader]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:<column_sep_string>];
                 [row_separator:<row_sep_string>];
      ]

[ ] indicates that the parameter is optional

Parameters

• job_ids

  Lists job IDs to use as the output filters.

• targets

  Lists targets (as name-type pairs) to use as the output filters.

• status_ids

  Lists numeric status IDs to use as the output filters.

  The numeric codes for all possible job statuses are as follows:

  • SCHEDULED=1

  • EXECUTING(Running)=2

  • ABORTED(Failed Initialization)=3

  • FAILED=4

  • COMPLETED(Successful)=5

  • SUSPENDED_USER=6

  • SUSPENDED_AGENT_DOWN=7

  • STOPPED=8

  • SUSPENDED_LOCK=9

  • SUSPENDED_EVENT=10

  • SUSPENDED_BLACKOUT=11

  • STOP_PENDING=12

  • SUSPEND_PENDING=13

  • INACTIVE=14

  • QUEUED=15

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

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

Examples

Example 1

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

emcli get_jobs
      -job_ids=12345678901234567890123456789012, 09876543210987654321098765432100

Example 2

The following example shows all jobs run against a host target named mainhost.example.com that are scheduled or have completed.

emcli get_jobs
      -status_ids=1,5
      -targets=mainhost.example.com:host

Example 3

The following example shows all jobs run against an Oracle database target named payroll that have failed. Tabular output is generated using tabs as column separators and newlines as row separators.

emcli get_jobs
      -status_ids=4
      -targets=payroll:oracle_database
      -script

get_job_types

Lists all the job types that can be used to create jobs and library jobs from EM CLI.

Format

emcli get_job_types

Parameters

None.

get_metering_data

Displays named credential details.

Format

emcli get_metering_data 
     [-start_date=<start_date_in_mmddyyyy>] 
     [-end_date=<end_date_in_mmddyyyy>]
     [-charge]
     [-cost_center=<cost_center_name>] 
     [-target_type=<target_type>
     [-target_name=<target_name>]

[ ] indicates that the parameter is optional

Parameters

• start_date

  Report cycle start date in mmddyyyy. If you do not specify the report cycle start date, the latest report cycle is used.

• end_date

  Report cycle end date in mmddyyyy. If you do not specify the report cycle end date, the latest report cycle is used.

• charge

  Prints charge relation information.

• cost_center

  Cost center name. If you do not specify the cost center name, the logged in user is used as the cost center name.

• target_type

  If you do not specify the target type, all targets are used. Supported target types for this release are oracle_database, oracle_vm_guest, host, and weblogic_j2eeserver. This parameter is not valid without the target_name parameter.

• target_name

  If you do not specify the target name, all targets of a given target type are used. This parameter is not valid without the target_type parameter.

Examples

Example 1

The following example shows the latest cycle usage data for the logged in user.

emcli get_metering_data 

Example 2

The following example shows usage data for the cost center cost_center_internal_name for the report cycle with a starting date of 10012011.

emcli get_metering_data     -start_date=10012011     -cost_center=cost_center_internal_name 

Example 3

The following example shows charge data for the my_target Oracle Guest VM target for cost center cost_center_internal_name for a report cycle with a starting date of 10012011.

emcli get_metering_data 
    -start_date=10012011 
    -cost_center=cost_center_internal_name 
    -target_type=oracle_vm_guest 
    -target_name=my_target 
    -charge 

get_metrics_for_stateless_alerts

For the specified target type, lists the metrics whose alerts are stateless and thus can be manually cleared. Both the metric name and metric internal name are provided in the output of this command. To clear the stateless alerts associated with the specified metric, use the clear_stateless_alerts verb.

Format

emcli get_metrics_for_stateless_alerts      -target_type=type

Parameters

• target_type

  Internal target type identifier, such as host, oracle_database, oc4j, oracle_emrep, and oracle_emd.

Examples

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

emcli get_metrics_for_stateless_alerts -target_type=oracle_database

get_named_credential

Displays named credential details.

Format

emcli get_named_credential 
        -cred_owner=<owner>
        -cred_name=<name>
        -out=<filename>

Parameters

• cred_owner

  Owner of the credential.

• cred_name

  Required credential name.

• out

  Output file name. The same file can be used as the input properties file for create_named_credential and modify_named_credential.

Examples

Example 1

The following example displays the details of the named credential NC1 owned by the current logged in user.

emcli get_named_credential -cred_name=NC1

Example 2

The following example displays the details of the named credential NC2 owned by the Administrator CREDS_MGR.

emcli get_named_credential -cred_name=NC2 -cred_owner=CREDS_MGR

get_oms_config_property

Gets the property value corresponding to the specified property name.

Format

emcli get_oms_config_property 
        -property_name="propertyName"
        [-oms_name="omsName"]
        [-details]

[ ] indicates that the parameter is optional

Parameters

• property_name

  Name of the property whose value must be retrieved.

• oms_name

  Name of the mangaement server for which the property must be retrieved.

• details

  Specifies details about from where the property value has been derived, and also the global and default values for the property.

Examples

Example 1

The following example retrieves the property value set for the property name "propName" from the management server myhost:1159_Management_Service.

get_oms_config_property -property_name=propName -oms_name="myhost:1159_Management_Service"

Example 2

The following example retrieves the property value set for the property name "propName" from all the management servers.

get_oms_config_property -property_name=propName 

Example 3

The following example retrieves the property value set for the property name "propName" from all the management servers with details.

get_oms_config_property -property_name=propName -details

get_oms_logging_property

Gets the property value corresponding to the specified logging property name.

Format

emcli get_oms_logging_property 
        -property_name="propertyName"
        [-oms_name="omsName"]
        [-details]

[ ] indicates that the parameter is optional

Parameters

• property_name

  Name of the logging property whose value must be retrieved.

• oms_name

  Name of the mangaement server for which the property must be retrieved.

• details

  Specifies details about from where the property value has been derived, and also the global and default values for the logging property.

Examples

Example 1

The following example retrieves the property value set for the property name "propName" from the management server myhost:1159_Management_Service.

get_oms_logging_property -property_name=propName -oms_name="myhost:1159_Management_Service"

Example 2

The following example retrieves the property value set for the property name "propName" from all the management servers.

get_oms_logging_property -property_name=propName 

get_on _demand_metrics

Gets a list of metrics that can be immediately collected with the collect_metric EMCLI verb. From this list, identify the metric you are interested in under the Metric Name column, then use its corresponding Metric Internal name in the collect_metric verb.

Format

emcli get_on_demand_metrics      -target_type=type
      -target_name=name

Parameters

• target_type

  Internal target type identifier, such as host, oracle_database, oc4j, oracle_emrep, and oracle_emd.

• target_name

  Name of the target.

Examples

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

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

get_operation_plan_details

Provides detailed step-by-step information about the specified operation plan.

Format

emcli get_operation_plan_details
      -name="plan name"

Parameters

• name

  Name of the operation plan.

Examples

emcli get_operation_plan_details
      -name="BISystem1-switchover"

See Also

create_operation_plan

get_operation_plans

get_operation_plans

Lists all configured operation plans.

Format

emcli get_operation_plans
      -name=<operation plan_name>
      -operation=<operation_name>

Parameters

• name

  Name of the operation plan.

• operation

  Name of the operation, such as switchover, failover, start, or stop.

Output Columns

Plan Name, Operation Name, Configuration GUID

Examples

emcli get_operation_plans
      -name="austin-switchover"
      -operation="switchover"

See Also

create_operation_plan

submit_operation_plan

get_patch_plan_data

Gets patch plan user-editable data.

Format

emcli get_patch_plan_data
        -name="name"

Parameters

• name

  Name of a given patch plan.

See Also

upload_patches

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

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

Example

emcli get_patch_plan_data -name="plan_name" 

get_plugin_deployment_status

Displays the status of a specific plug-in deployment or undeployment activity as well as the list of steps.

Format

emcli get_plugin_deployment_status 
       [-plugin_id="plugin_id"]

[ ] indicates that the parameter is optional

Parameters

• plugin_id

  ID of the plug-in for which you need to view the deployment/undeployment status. If not provided, the command shows the status of the latest plug-in being deployed, or the last one that was deployed or undeployed.

Examples

Example 1

Displays the status of the last plug-in deployment/undeployment activity.

emcli get_plugin_deployment_status

Example 2

The following example displays the status of the last deployment/undeployment activity of a specific plug-in.

emcli get_plugin_deployment_status -plugin_id=oracle.sysman.db

get_procedures

Gets a list of deployment procedures and pre-saved procedure configurations.

Format

emcli get_procedures [-type=<procedure_type>]
      [-parent_proc=<procedure_associate>]

[ ] indicates that the parameter is optional

Parameters

• type

  Displays all the deployment procedures of type procedure_type.

• parent_proc

  Procedure associated with procedure configurations.

Output Columns

GUID, Procedure Type, Name, Display Type, Version, Created By, Procedure Name

See Also

get_procedure_types

get_procedure_xml

get_procedure_types

Gets the list of all deployment procedure types.

Format

emcli get_procedure_types

Output Column

Procedure Type

Example

The following example lists all procedure types:

emcli get_procedure_types

get_procedure_xml

Gets the deployment procedure XML file. XML is printed on standard output.

Format

emcli get_procedure_xml 
      -procedure=[procedure_guid]
      [-name=<procedure_name>]
      [-owner=<procedure_owner>]

[ ] indicates that the parameter is optional

Parameters

• procedure

  Procedure GUID.

• name

  Procedure name.

• owner

  Procedure owner.

Output

Deployment procedure XML.

Examples

emcli get_procedure_xml -procedure=16B15CB29C3F9E6CE040578C96093F61 > proc.xml

get_reports

Returns a list of Information Publisher reports owned by or viewable by all users or a specified user. The output of this report is space-separated, quoted strings for the report title and owner, with each report on its own line.

Format

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

[ ] indicates that the parameter is optional

Parameters

• owner

  Enables listing of viewable reports that a specific Enterprise Manager owns.

Output

Space-separated quoted strings for the report title and owner, with each report on its own line.

Examples

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

emcli get_reports
“report A”,”username1”
“report 1”,”username2”
“example report 2”,”username2

get_resolution_states

Gets the list of existing resolution states used in managing incidents and problems. It also prints the display position of states. It does not list the fixed "New" and "Closed" resolution states.

Format

emcli get_resolution_states 

Parameters

None.

Examples

The following example shows sample output for Incident defined states of OnHold, Waiting, and Processed, and Problem defined states of OnHold and Processed.

Incident resolution states
   5     OnHold
  10     Waiting
  25     Processed
 
Problem resolution states
   5     OnHold
  25     Processed

get_retry_arguments

Get arguments of failed steps that can be retried.

Format

emcli get_retry_arguments 
      [-instance=<instance_guid>] 
      [-exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>] 
      [-stateguid=<state_guid>]

[ ] indicates that the parameter is optional

Parameters

• instance

  Instance GUID.

• exec

  Execution GUID.

• name

  Execution name.

• owner

  Execution owner.

• stateguid

  State GUID.

Examples

emcli get_retry_arguments -instance=16B15CB29C3F9E6CE040578C96093F61

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

get_siteguard_configuration

Provides the Site Guard configuration.

Format

emcli get_siteguard_configuration
      [-primary_system_name=<name_of_primary_system>]
      [-standby_system_name=<name_of_standby_system}]

[ ] indicates that the parameter is optional

Parameters

• primary_system_name

  Name of the primary system.

• standby_system_name

  Name of the standby system.

Output Columns

Primary System, Standby System(s)

Examples

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

get_siteguard_credential_association

Lists the credential associations configured for a system.

Format

emcli get_siteguard_credential_association
      [-system_name=<name_of_system>]
      [-target_name=<name_of_target>]
      [-credential_type=<type_of_credential>]

[ ] indicates that the parameter is optional

Parameters

• system_name

  Name of the system.

• target_name

  Name of the target.

• credential_type

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

Output Columns

Target Name, Credential Name, Credential Type

Examples

Example 1

emcli get_siteguard_credential_association
      -system_name="austin-system"
      -credential_type="HostNormal"

Example 2

emcli create_siteguard_credential_association
      -system_name="austin-system"
      -target_name="austin-database-instance"
      -credential_type="HostNormal"

See Also

create_siteguard_credential_association

update_siteguard_credential_association

get_siteguard_script_hosts

Lists the host or hosts associated with any script where the script is designated to run.

Format

emcli get_siteguard_script_hosts
      [-script_id=<script_id>]

[ ] indicates that the parameter is optional

Parameters

• script_id

  ID associated with the script.

Output Columns

Host Name

Examples

emcli get_siteguard_script_hosts
      -script_id="10"

See Also

create_siteguard_script

add_siteguard_script_hosts

get_siteguard_scripts

Obtains the Site Guard scripts associated with the specified system.

Format

emcli get_siteguard_scripts
      -system_name=<system_name>
      -operation=<operation_name>
      [-script_type=<type_of_script>]
      [-role=<role_of_system>]

Parameters

• system_name

  Name of the system.

• operation

  Name of the operation, such as switchover, failover, start, or stop.

• script_type

  Type of the script. For example: mount, unmount, pre-script, post-script, failover, or switchover.

• role

  Filters the scripts based on the role associated with the system. For example: Primary or Standby.

Output Columns

Script, ID, Type, Operation, Path, Role

Examples

Example 1

emcli get_siteguard_scripts
      -system_name="BISystem1"
      -operation="Switchover"
      -script_type="Pre-Script"

Example 2

emcli get_siteguard_scripts
      -system_name="austin-system"
      -operation="Switchover"
      -script_type="Pre-Script"
      -role="Primary"

See Also

create_siteguard_script

delete_siteguard_scripts

get_supported_platforms

Lists the platforms for which the Management Agent software is available on the OMS host.

Format

emcli get_supported_platforms

Output

The output of the command appears like the following example:

--------------------------
Platform Name : Linux x86
--------------------------

get_supported_privileges

Gets the list of available privileges in Enterprise Manager based on the type specified.

Format

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

[ ] indicates that the parameter is optional

Parameters

• type

  Type of privileges to retrieve from Enterprise Manager. Possible values are:

  • ALL (default value)

  • SYSTEM

  • TARGET

  • JOB

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

Privilege Name, Privilege Type, Resource Class, Resource GUID Column, Resource ID Columns

get_system_members

Lists the members of the specified system.

Format

emcli get_system_members
      -name="name"
      [-type=<generic_system>]
      [-depth=#  (default 1)]
      [-noheader]
      [-script | -format=
            [name:<pretty|script|csv>];
            [column_separator:"column_sep_string"];
            [row_separator:"row_sep_string"];
      ]

[ ] indicates that the parameter is optional

Parameters

• name

  Target name of the system.

• type

  System type: generic_system. Defaults to generic_system.

• depth

  Lists target members in sub-systems to the specified depth. When the depth is set to 0, no system target members are listed, and only the system's existence is verified. When the depth is set to -1, all system and sub-system target members are listed.

• noheader

  Displays tabular information without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

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

Examples

Example 1

The following example lists the databases in system db2_system.

emcli get_system_members -name=db2_system

Example 2

The following example verifies that system my_system:generic_system exists.

emcli get_system_members -name=my_system -depth=0

Example 3

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

emcli get_system_members -name=my_system -depth=-1

get_target_properties

Lists all the property names for the target type provided.

Format

emcli get_target_properties
         -target_type="target_type"

Parameters

• target_type

  Target type for which you want to list user-defined property names.

Examples

emcli get_target_properties -target_type="host"

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

get_targets

Gets status and alert information for targets.

Format

emcli get_targets
      [-targets="[name1:]type1;[name2:]type2;..."]
      [-alerts]
      [-noheader]
      [-script | -format=
                 [name:<pretty|script|csv>];
                 [column_separator:"column_sep_string"];
                 [row_separator:"row_sep_string"];
      ]

[ ] indicates that the parameter is optional

Parameters

• targets=name:type

  Name or type can be either a full value or a pattern match using %. Also, name is optional, so the type can be specified alone.

• alerts

  Shows the count of critical and warning alerts for each target.

• noheader

  Display tabular output without column headers.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Output Columns

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

Examples

Example 1

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

emcli get_targets

Example 2

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

emcli get_targets
      -alerts

Example 3

The following example shows all oracle_database targets.

emcli get_targets
      -targets="oracle_database"

Example 4

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

emcli get_targets
      -targets="%oracle%"

Example 5

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

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

Example 6

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

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

get_test_thresholds

Shows test thresholds.

Format

emcli get_test_thresholds      -name=<target_name>      -type=<target_type>      -testname=<test_name>      -testtype=<test_type>      [-script|-format=               [name:"pretty|script|csv"];               [column_separator:"sep_string"];               [row_separator:"row_sep_string"]
      ]

[ ] indicates that the parameter is optional

Parameters

• name

  Target name.

• type

  Target type.

• testname

  Test name.

• testtype

  Test type.

• script

  This is equivalent to -format="name:script".

• format

  Format specification (default is -format="name:pretty").

  • format="name:pretty" prints the output table in a readable format not intended to be parsed by scripts.

  • format="name:script" sets the default column separator to a tab and the default row separator to a newline. The column and row separator strings can be specified to change these defaults.

  • format="name:csv" sets the column separator to a comma and the row separator to a newline.

  • format=column_separator:"column_sep_string" column-separates the verb output by <column_sep_string>. Rows are separated by the newline character.

  • row_separator:"row_sep_string" row-separates the verb output by <row_sep_string>. Rows are separated by the tab character.

Examples

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

get_unsync_alerts

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

Format

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

Parameters

• target_type

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

• target_name

  Name of the target.

Output Column

Status

Examples

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

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

get_unused_metric_extensions

Gets a list of metric extensions deployed to Agents, but not attached to any targets.

Format

emcli get_unused_metric_extensions

Parameters

None.

grant_license_no_validation

Grants licenses on a set of user-specified packs, or all packs to a set of user-specified targets, or all targets belonging to the input licensable target type.

For 11g database targets, you cannot enable or disable the Database Diagnostic and Tuning Packs through the user interface. You need to set the control_management_pack_access initialization parameter to manage your licenses. For information about this parameter, see the Enterprise Database Management chapter of Oracle Enterprise Manager Licensing Information.

Format

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

Parameters

• type

  Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".

• targets

  Targets should be specified in the following sequence:

  TargetName1;TargetName2;
  

  For example:

  -targets="database1;database2;database3;"
  

  The semi-colon ( ; ) is the target separator.

  See the "Examples" section below for information about providing arguments for the targets .

• packs

  License packs should be specified in the following sequence:

  pack1;pack2;
  

  For example:

  -packs="db_diag;db_config;"
  

  The semi-colon ( ; ) is the pack separator.

  See the "Examples" section below for information about providing arguments for the packs .

• file

  Specify the file name, including the complete path. For example:

  -file="/usr/admin1/db_license.txt"
  

  The file should contain the list of targets and packs according to the following cases:

  • If you only need to provide a list of targets, use the following format:

    targets=database1;database2;database3;
    

  • If you only need to provide a list of packs, use the following format:

    packs=db_diag;db_config;
    

  • If you need to provide a list of both targets and packs, use the following format:

    targets=database1;database2;database3;packs=db_diag;db_config;
    

• displayAllMessages

  Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the command line.

Examples

Example 1 and Example 2 below grant licenses to specific packs for specific targets. In order to know which target types and pack names you can pass as arguments, you can use the view named mgmt_license_view to see a list of licensable targets, their target types, and the list of packs licensed on them.

To obtain this information, do the following:

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

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

   target_type=<oracle_database>
   

The following example shows pack names for an Oracle database you specify as the target type.

PACK_NAME
-------------------
db_config
provisioning
db_sadm
db_tuning
db_diag
provisioning_db
db_chgmgt
 
7 rows selected.

Based on this information, to grant a license to the database1 target for the db_chgmgt pack, you would enter the following command:

emcli grant_license_no_validation -type="oracle_database" -targets="database1" -packs="db_chgmgt"

The only limitation of mgmt_license_view is that it only lists the packs for a target type where the pack is granted to at least one target of that type. That is, if the pack is not granted to any target of that type, mgmt_license_view cannot provide any information.

Example 1

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

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

Example 2

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

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

Example 3

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

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

Example 4

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

emcli grant_license_no_validation -type="oracle_database"

Example 5

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

emcli grant_license_no_validation -type="oracle_database"          -file="/usr/admin1/db_license.txt"             targets=database1;database2;database3;                   packs=db_diag;db_config;

... where the content of the "/usr/admin1/license/db_license.txt" file is as follows:

targets=database1;database2;database3;
packs=db_diag;db_config;

grant_license_with_validation

Grants licenses on a set of user-specified packs, or all packs to a set of user-specified targets, or all targets belonging to the input licensable target type as per business rules.

For 11g database targets, you cannot enable or disable the Database Diagnostic and Tuning Packs through the user interface. You need to set the control_management_pack_access initialization parameter to manage your licenses. For information about this parameter, see the Enterprise Database Management chapter of Oracle Enterprise Manager Licensing Information.

Format

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

[ ] indicates that the parameter is optional

Parameters

• type

  Target type as it exists in the database. Names cannot contain colons ( : ), semi-colons ( ; ), or any leading or trailing blanks. You can specify only one target type at a time; for example, -type="oracle_database".

• targets

  Targets should be specified in the following sequence:

  TargetName1;TargetName2;
  

  For example:

  -targets="database1;database2;database3;"
  

  The semi-colon ( ; ) is the target separator.

  See the "Examples" section below for information about providing arguments for the targets .

• packs

  License packs should be specified in the following sequence:

  pack1;pack2;
  

  For example:

  -packs="db_diag;db_config;"
  

  The semi-colon ( ; ) is the pack separator.

  See the "Examples" section below for information about providing arguments for the packs .

• file

  Specify the file name, including the complete path. For example:

  -file="/usr/admin1/db_license.txt"
  

  The file should contain the list of targets and packs according to the following cases:

  • If you only need to provide a list of targets, use the following format:

    targets=database1;database2;database3;
    

  • If you only need to provide a list of packs, use the following format:

    packs=db_diag;db_config;
    

  • If you need to provide a list of both targets and packs, use the following format:

    targets=database1;database2;database3; packs=db_diag;db_config;
    

• displayAllMessages

  Displays all messages. Only error messages are displayed by default. "=value" is not allowed on the cmd line.

Examples

Example 1 and Example 2 below grant licenses to specific packs for specific targets. In order to know which target types and pack names you can pass as arguments, you can use the view named mgmt_license_view to see a list of licensable targets, their target types, and the list of packs licensed on them.

To obtain this information, do the following:

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

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

   target_type=<oracle_database>
   

The following example shows pack names for an Oracle database you specify as the target type.

PACK_NAME
-------------------
db_config
provisioning
db_sadm
db_tuning
db_diag
provisioning_db
db_chgmgt
 
7 rows selected.

Based on this information, to grant a license to the database1 target for the db_chgmgt pack, you would enter the following command:

emcli grant_license_with_validation -type="oracle_database" -targets="database1" -packs="db_chgmgt"

The only limitation of mgmt_license_view is that it only lists the packs for a target type where the pack is granted to at least one target of that type. That is, if the pack is not granted to any target of that type, mgmt_license_view cannot provide any information.

Example 1

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

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

Example 2

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

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

Example 3

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

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

Example 4

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

emcli grant_license_with_validation -type="oracle_database"

Example 5

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

emcli grant_license_with_validation -type="oracle_database"          -file="/usr/admin1/db_license.txt"             targets=database1;database2;database3;                   packs=db_diag;db_config;

where the content of the "/usr/admin1/license/db_license.txt" file is as follows:

targets=database1;database2;database3;
packs=db_diag;db_config;

grant_privs

Grants the privileges to the existing Enterprise Manager user or Enterprise Manager Role.

Format

emcli grant_privs
        -name="username"
        -privilege="name[;secure_resource_details]"
        [-grant_all_targets_on_host="yes|no"]
        [-separator=privilege="sep_string"]
        [-subseparator=privilege="subsep_string"]

[ ] indicates that the parameter is optional

Parameters

• name

  User name or role name to which privileges will be assigned.

• privilege

  Privilege to be granted to the Enterprise Manager user or role. You can specify this parameter more than once.

  Specify secure_resource_details as:

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

  Optionally, you can drop resource column names from this parameter if you provide resource information in the order described by emcli get_supported_privileges. See the "See Also" section below for more information.

• grant_all_targets_on_host

  Indicates if the privilege needs to be granted on all targets of the host specified as part of the privilege parameter. The default value is no.

• separator=privilege

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

• subseparator=privilege

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

Examples

Example 1

The following example grants these privileges to user1:

• Privilege to use any beacon

• Full control of the jobs with ID 923470234ABCDFE23018494753091111

• Full control on the target host1.example.com:host

• Full control on the credential cred1:user2

• View Privilege on target with ID 123451234ABCDFE23018494753092222

emcli grant_privs
      -name="user1"
      -privilege="USE_ANY_BEACON"
      -privilege="FULL_JOB;923470234ABCDFE23018494753091111"
      -privilege="FULL_TARGET;TARGET_NAME=host1.example.com:TARGET_TYPE=host"
      -privilege="FULL_CREDENTIAL;CRED_NAME=cred1:CRED_OWNER=user2"
      -privilege="FULL_CREDENTIAL;CRED_GUID=123451234ABCDFE23018494753092222"

Example 2

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

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

Example 3

The following example grants FULL_TARGET privilege on all targets on host host1.example.com to user1.

emcli grant_privs
      -name="user1"
      -privilege="FULL_TARGET;TARGET_NAME=host1.exemple.com:TARGET_TYPE=host"
      -grant_all_targets_on_host="yes"

Example 4

The following example uses the separator and subseparator parameters to grant FULL_TARGET privilege on host1.us.oracle.com to user1.

emcli grant_privs
      -name="user1"
      -privilege="FULL_TARGET->TARGET_NAME=host1.us.oracle.com@@TARGET_TYPE=host"
      -separator=privilege="->"
      -subseparator=privilege="@@"

See Also

To see the complete list of privileges and resource column names, execute the following command:

emcli get_supported_privileges

To see the list of SYSTEM privileges, which do require resource information:

emcli get_supported_privileges -type=SYSTEM

To see the list of TARGET privileges:

emcli get_supported_privileges -type=TARGET

To see the list of JOB privileges:

emcli get_supported_privileges -type=JOB

grant_roles

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

Format

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

[ ] indicates that the parameter is optional

Parameters

• name

  User name or role name to which roles will be assigned.

• roles

  Roles that will be granted to an Enterprise Manager user or role. You can specify this option more than once.

Examples

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

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

help

Shows a summary of all verbs or command-line help for individual EM CLI verbs.

Format

emcli help [verbname]

[ ] indicates that the parameter is optional

Parameters

None.

Examples

Example 1

The following example provides an overview for all available verbs:

emcli help

Example 2

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

emcli help add_target

ignore_instance

Ignores a failed step. An instance cannot be ignored when it completes, completes with an error, is suspended, or is stopped.

Format

emcli ignore_instance 
      -instance=<instance_guid> 
      [exec=<execution_guid>] 
      [-name=<execution_name>] 
      [-owner=<execution_owner>] 
      [-stateguid=<state_guid>]

[ ] indicates that the parameter is optional

Parameters

• instance

  Instance GUID.

• exec

  Execution GUID.

• name

  Execution name.

• owner

  Execution owner.

• stateguid

  Comma-separated list of state GUIDs.