modify_virtual_platform

Modifies the Oracle Virtual Platform target's monitoring agent, fail-over agent, or the monitoring credentials. Only the properties of the target needing modification must be specified when modifying a target of that type. For all of the parameters not passed, the existing values are retained.

Format

emcli modify_virtual_platform 
       -name="target_name"
       -agent="agent_target_name"
       [-failover_agent="failover_agent_target_name"]
       -credentials="property_name1:property_value1;property_name2:
           property_value2;..."
	       [-wait_for_completion=true|false]
	       [-wait_for_completion_timeout=<time_in_minutes>]
       [-separator=credentials="separator_for_key_value_pairs"]
	       [-subseparator=credentials="separator_for_key_value_pair"]
       [-input_file="FILE:file_path"]

[ ]  indicates that the parameter is optional

Options

  • name

    Target name of the Oracle Virtual Platform to modify.

  • agent

    Target name of the primary agent used to monitor the Oracle Virtual Platform and related targets.

  • failover_agent

    Target name of the failover agent used to monitor the Oracle Virtual Platform and related targets.

  • credentials

    Monitoring credentials (name-value pairs) for the target instance. The "names" are defined in the target type metadata definition as credential properties. Metadata files are located at $AGENT_HOME/sysman/admin/metadata.

    See the examples for details on various options.

  • wait_for_completion

    Flag to indicate if the CLI is going to wait for the submitted job to finish. The default value is false. If the value is true, the progress of the job is printed on the command line as and when the addition of Oracle Virtual Platform(s) Succeeds/Fails.

  • wait_for_completion

    Flag to indicate if the CLI is going to wait for the submitted job to finish. The default value is false. If the value is true, the CLI waits and prints the job output on the command line when the modification of Oracle Virtual Platform(s) Succeeds/Fails.

  • wait_for_completion_timeout

    Time in minutes after which CLI stops waiting for the job to finish. This option is honored only if the value for parameter wait_for_completion is true. A negative or zero value does not wait for the job to finish.

    See the examples for details.

  • separator=credentials

    Custom separator for the credential key value pairs. Specify a string delimiter to use between name-value pairs for the values of the -credentials option. The default separator delimiter is ";".

    For more information about the separator parameter, see -input_file Syntax Guidelines.

  • subseparator=credentials

    Custom separator for a key value pair. Specify a string delimiter to use between name and value in each name-value pair for the values of the -credentials option. The default subseparator delimiter is ":".

    For more information about the subseparator parameters see -input_file Syntax Guidelines.

  • input_file

    File path with a credential secret value. Optionally use in conjunction with the -credentials option. You can use this option to set specific target monitoring credential values, such as passwords or SSH keys, in a separate file.

    This option specifies a mapping between a tag and a local file path. The tag is specified in lieu of specific -credentials property values.

Examples

Example 1

This example modifies the Oracle Virtual Platform's credentials with root user host credentials. The value of the property "OVSUsername" is used for the user name and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are collected (true) or not (false) when monitoring. The password is passed at the command line.

emcli modify_virtual_platform
      -credentials='type:DMOvsBasicCreds;PrivilegeType:none;
               privilegedUser:true;OVSUsername:root;OVSPassword:mypassword'

Example 2

This example modifies the Oracle Virtual Platform's credentials with root user host credentials. The value of the property "OVSUsername" is used for the user name and "OVSPassword" for the password. The value of the property "privilegedUser" indicates if the virtualization-specific metrics are collected (true) or not (false) when monitoring. The password of the root user is read from the input file "password.txt".

emcli modify_virtual_platform 
      -name=exampletarget 
      -credentials='type:DMOvsBasicCreds;PrivilegeType:none;
          privilegedUser:true;OVSUsername:root;OVSPassword:PWD_FILE'
      -input_file='PWD_FILE:password.txt