Metric Extension Command Line Verbs
Metric extensions can be manipulated outside the UI via the Enterprise Manager Command Line Interface (EM CLI). Two categories of verbs are available:
-
Metric Extension Verbs
-
export_metric_extension: Export a metric extension to an archive file
-
get_unused_metric_extensions: Get a list of unused metric extensions.
-
import_metric_extension: Import a metric extension archive file.
-
publish_metric_extension: Publish a metric extension for use by all administrators.
-
save_metric_extension_draft: Save a deployable draft of a metric extension.
-
-
User-defined Metric Migration Verbs
-
abort_udmmig_session: Abort (partially) user-defined metric migration session.
-
analyze_unconverted_udms: Analyze the unconverted user-defined metrics.
-
create_udmmig_session: Create a user-defined metric migration session.
-
list_unconverted_udms: List the user-defined metrics that are not yet in a migration session.
-
udmmig_list_matches: List the matching metrics per user-defined metric in a specific user-defined metric migration session.
-
udmmig_request_udmdelete: Request deletion of user-defined metrics from targets.
-
udmmig_retry_deploys: Retry deployment of metric extensions to targets.
-
udmmig_session_details: Retrieve the details of a specific user-defined metric migration session.
-
udmmig_submit_metricpicks: Select the metrics to replace user-defined metrics in a session.
-
udmmig_summary: Summarize the status of all user-defined metric migration sessions.
-
udmmig_update_incrules: Update user-defined metric incident rules to include replacement metric references.
-
Metric Extension Verbs
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> Description: Export a metric extension archive file. Options: -file_name=<file name> The name of the metric extension archive file to export into. -target_type=<target type> Target type of the metric extension. -name=<name> Name of the metric extension. -version=<version> Version of the metric extension to be exported. emcli get_unused_metric_extensions Description: Get a list of metric extensions that are deployed to agents but not attached to any targets. emcli import_metric_extension -file_name=<name of the metric extension archive> -rename_as=<name of the metric extension to import as> Description: Import a metric extension archive file. Options: -file_name=<file name> The name of the metric extension archive file to be imported. -rename_as=<metric extension name> Import the metric extension using the specified name, replacing the name given in the archive. emcli publish_metric_extension -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension> Description: Publish a metric extension for use by all administrators. The metric extension must currently be a deployable draft. Options: -target_type=<target type> Target type of the metric extension. -name=<name> Name of the metric extension. -version=<version> Version of the metric extension to be published. emcli save_metric_extension_draft -target_type=<target type of the metric extension> -name=<name of the metric extension -version=<version of the metric extension> Description: Save a deployable draft of a metric extension. The metric extension must currently be in editable state. Once saved as draft, the metric extension will no longer be editable. Options: -target_type=<target type> Target type of the metric extension. -name=<name> Name of the metric extension. -version=<version> Version of the metric extension to be saved to draft.
User-Defined Metric Verbs
emcli abort_udmmig_session -session_id=<sessionId> [-input_file=specific_tasks:<complete path to file>] Description: Abort the migration of user-defined metrics to MEs in a session Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary [-input_file=specific_tasks:<complete file path>] This optional parameter points at a file name that contains a target, user-defined metric, one per line in the following format: <targetType>,<targetName>,<collection name> Use targetType=Template to indicate a template Use * for collection name to abort all user-defined metrics for a target emcli analyze_unconverted_udms [-session_id=<sessionId>] Description: Analyze user-defined metrics and list unique user-defined metrics, any possible matches, and templates that can apply these matching metric extensions Options: -session_id=<id of a session to be reanalyzed> Not specifying a session id causes the creation of a analysis session that contains all unconverted user-defined metrics. You can specify this session id in future invocations to get fresh analysis. emcli create_udmmig_session -name=<name of the session> -desc=<description of the session> [-udm_choice=<specific udm to convert>]* {-target=<type:name of the target to migrate> }* | {-input_file=targetList:<complete path to file>}; {-template=<name of the template to update> }* | {-input_file=templateList:<complete path to file>} [-allUdms] Description: Creates a session to migrate user-defined metrics to metric extensions for targets. Options: -name=<session name> The name of the migration session to be created. -desc=<session session description> A description of the migration session to be created. -udm_choice=<udm name> If the session should migrate specific user-defined metrics, specify them Otherwise, all user-defined metrics will be migrated -target=<type:name of target to migrate> The type:name of the target to be updated. Multiple values may be specified. -input_file=targetList:<complete file path> This takes a file name that contains a list of targets, one per line in the following format: <targetType>:<targetName> -template=<name of template to migrate> The name of the template to update.Multiple values may be specified -input_file=templateList:<complete file path> This takes a file name that contains a list of templates, one name per line -allUdms This forces the session to contain all user-defined metrics from targets and templates (default behavior just picks those not in a session) emcli list_unconverted_udms [-templates_only] Description: Get the list of all user-defined metrics that are not yet in a migration session Options: -templates_only Only lists unconverted user-defined metrics in templates. emcli udmmig_list_matches -session_id=<sessionId> Description: Lists the matching metrics per user-defined metric in a migration session Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary emcli udmmig_request_udmdelete -session_id=<sessionId> -input_file=metric_tasks:<complete path to file> Description: Delete the user-defined metrics that have been replaced by Metric Extenions Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=metric_tasks:<complete file path> This takes a file name that contains a target, user-defined metric, one per line in the following format: <targetType>,<targetName>,<collection name> emcli udmmig_retry_deploys -session_id=<sessionId> -input_file=metric_tasks:<complete path to file> Description: Retry the deployment of metric extensions to a target Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=metric_tasks:<complete file path> This takes a file name that contains a target, user-defined metric, one per line in the following format: <targetType>,<targetName>,<collection name> emcli udmmig_submit_metricpicks -session_id=<sessionId> -input_file=metric_picks:<complete path to file> Description: Supply the metric picks to use to replace user-defined metrics per target in a session Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=metric_picks:<complete file path> This takes a file name that contains a target, user-defined metric, metric pick, one per line in the following format: <targetType>,<targetName>,<collection name>,[N/E],<metric>,<column> using N if a new metric should be created or E if an existing metric is referenced. emcli udmmig_summary [-showAll] Description: Gets the summary details of all migration sessions in progress Options: -showAll This prints out all sessions including those that are complete. By default, only in-progress sessions are listed. emcli udmmig_update_incrules -session_id=<sessionId> -input_file=udm_inc_rules:<complete path to file> Description: Update Incident Rules that reference user-defined metrics with a reference to replacing metric extension. Options: -session_id=<id of the session> Specify the id that was returned at time of session created, or from the output of udmmig_summary -input_file=udm_inc_rules:<complete file path> This takes a file name that contains rule, user-defined metric, metric, one per line in the following format: <ruleset id>,<rule id>,<udm name>,<metric name>