apm_parameter_register (public)

 apm_parameter_register [ -callback callback ] \
    [ -parameter_id parameter_id ] [ -scope scope ] parameter_name \
    description package_key default_value datatype [ section_name ] \
    [ min_n_values ] [ max_n_values ]

Defined in packages/acs-tcl/tcl/apm-procs.tcl

Register a parameter in the system. The new "scope" parameter is named rather than positional to avoid breaking existing code.

Switches:
-callback (optional, defaults to "apm_dummy_callback")
-parameter_id (optional)
-scope (optional, defaults to "instance")
Parameters:
parameter_name (required)
description (required)
package_key (required)
default_value (required)
datatype (required)
section_name (optional)
min_n_values (optional, defaults to "1")
max_n_values (optional, defaults to "1")
Returns:
The parameter id of the new parameter.

Testcases:
test_apm_parameter__register, parameter_register_test, parameter__check_procs
[ show source ]
Show another procedure: