Parameter Descriptions
Plug-in Program: The plug-in program that is executed in the child process forked by IMGW runtime. The system administrator gives this information to IMGW runtime during registration.
temp_logfile_name: The full path to the device module temporary log file, which should be used by the device module to log the processing history of one instance of operation (configuration download, command execution or hop test). This file is by default located at /tmp directory on the Cisco Configuration Engine. After the plug-in program exits, IMGW runtime puts the content of this file into a centralized log file named /opt/CSCOimgw/bin/IMGW-DEVMOD_LOG for debugging purpose, then unlinks this file.
logging_level: It could be verbose, error, or silent. This flag can be set up by running setup command on the host system. It is recommended that the device module log information into the file <temp_logfile_name> based on the specified logging level.
device_id: The identification of the device that is processed by the device module. It is passed in by the cisco.mgmt.cns.config.load or cisco.mgmt.cns.exec.cmd event.
action_type: It could be config, exec, or hoptest. Action type config notifies the device module to update the device configuration. Action type exec notifies the device module to execute a command on the device. Action type hoptest notifies the device module to test if the device is reachable by way of the hop information provided in <hop_information_string>. The device module should do the proper operation in response to this flag.
warning_logfile_name: The full path to the file that is used by the device module to log all warning messages and its corresponding configuration commands line numbers. This parameter is supplied by IMGW runtime only when the action type is config because the information in this file is only used to generate the response message to the cisco.mgmt.cns.config.load event if the configure succeeds with warnings. In order for the IMGW runtime to generate the proper response message, each warning message should begin a new line and be prefixed with the string of LINE <
line number of the configuration command that causes the warning message
>: An example of the warning file is as follows:
LINE 3: The interface has already been removed
.
.
.
LINE 7: The interface already exists.
The location of this file is under /tmp on the host system. After the plug-in program exits, IMGW runtime puts the content of this file into the response event payload, then immediately unlinks this file.
error_logfile_name: The full path to the file that is used by the device module to log the occurrences of the error messages and their corresponding configuration command line numbers. This parameter is supplied by IMGW runtime only when the action type is config because the information in this file is only used to generate the response message to the cisco.mgmt.cns.config.load event if the configure fails. In order for the IMGW runtime to generate the proper response message, each error message should begin a new line and be prefixed with the string of LINE <l
ine number of the configuration command that causes the error message
>.
An example of the error file is as follows:
LINE 3: % Invalid input detected at
LINE 7: % Incomplete command
.
.
.
LINE 12: % The interface already exists
The location of this file is under /tmp on the host system. After the plug-in program exits, IMGW runtime puts the content of this file into the response event payload, then immediately unlinks this file.
exec_response_logfile_name: The full path to the file that is used to log the output of command execution on the device. It is supplied by IMGW runtime only when the action type is exec and its location is under /tmp on the host system. After the plug-in program exits, IMGW runtime puts the content of this file into the response event payload, then immediately unlinks this file.
hop_information_string: The string used to store the access information of the device. It is the string concatenation of all individual hop information of the device in order. An example the hop information and its <hop_information_string> are as follows:
Hop type
|
IP address
|
Port
|
Username
|
Password
|
IOS_LOGIN
|
172.29.145.45
|
|
Admin
|
Cisco
|
IOS_EN
|
|
|
Lab
|
Lab
|
The corresponding <hop_information_string> should be as follows:
“IOS_LOGIN” “172.29.145.45” “ ” “Admin” “Cisco” “IOS_EN” “ ” “ ” “Lab” “Lab”
Note For those fields of hop information with null value, IMGW runtime automatically adds a space before passing it to the child process.
command_to_be_executed: The command to be executed on the device. It is supplied by IMGW runtime only when the action type is exec.
command_arguments: The arguments of the command to be executed on the device. It is supplied by IMGW runtime only when the action type is exec.
configuration_file_name: The full path to the configuration file which will be downloaded onto the device. It is supplied by IMGW runtime only when the action type is config and its location is under /tmp on the host system. After the plug-in program exits, IMGW runtime immediately unlinks this file.
persistence: y or n. The value y means the configuration needs to be written into non-volatile storage. It is supplied by IMGW runtime only when the action type is config. This option is dependent on the device type. This means the device module can ignore it if the device type does not support it.
operation_timeout_value: The maximum time period allowed to execute a command on the device. This parameter is now used by Expect scripts in IMGW legacy device module for IOS, CatOS, CatIOS, PIX, CSS and CE devices. A user-defined device module can ignore this parameter if it does not use it.
prompt_timeout_value: The maximum time period allowed to wait for the next prompt during login session to the device. This parameter is now used by Expect scripts in IMGW legacy device module for IOS, CatOS, CatIOS, PIX, CSS and CE devices. A user-defined device module can ignore this parameter if it does not use it.