NetMRI_Easy.py Methods

easy.set_variable( variable_name, variable_value )

Set a server-side variable. This is useful when retrieving a template via get_template and the template contains variables that are not defined by the Script-Variables for the current job. This is because template merging (i.e. variable substitution) is performed on the server-side.

Example: easy.set_variable('username', 'test_username')

This method requires a CLI connection to the device, NetMRI must have credentials for the device the NetMRIEasy script is run against.

easy.send_command( command )

Send a command to the target device.

Example: output = easy.send_command("show version")

This method requires a CLI connection to the device and that the NetMRI have credentials for the device the NetMRIEasy script is run against.

easy->get_template( $template_name )

Retrieve a template. For the given template, retrieve the content and perform any necessary variable substitutions.

Example: contents = easy.get_template("Cisco Router")

This method requires a CLI connection to the device and that the NetMRI have credentials for the device the NetMRIEasy script is run against.

easy.get_list_value(list_name, key_column, key_value, value_column, default)

Look up a value in a list. For the given list name, finds the first row containing the given key value in the given key column and returns the value contained in the given value column. If the look up fails, the given default is returned.

The default is returned if no value is found. If default is not specified, then empty string " " is used as the default. This method requires a CLI connection to the device, NetMRI must have credentials for the device the NetMRIEasy script is run against.

easy.generate_issue(severity, issue_type_id, **kwargs)

Generate an issue. For the given issue type id, generate an issue of the given severity using the name/value pairs defined in the given parameters as the issue details.

severity

severity is one of "error", "warning" or "info"

issue_type_id

String issue type id

kwargs

arguments containing the issue details.

Example:

issue_id = easy.generate_issue("info", "IOSBanLoginUpdateSuccess", **{

     "Name":'Sample Name',

     "Host":'1.2.3.4'

})

easy.log_message(severity, message)

Log a message of the given severity (one of 'debug', 'error', 'warning' or 'info'). The message is written to the custom.log file.

This method requires a CLI connection to the device and that NetMRI have credentials for the device the NetMRIEasy script is run against.

easy.broker(broker_name)