NetMRI_Easy Methods

$easy->set_variable( $variable_name, $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 => $some_username);

This method requires a CLI connection to the device. NetMRI must have credentials for the device against which the NetMRI_Easy script is running.

$easy->send_command( $command )

Send a command to the target device.

Example: my $output = $easy->send_command("show version");

This method requires a CLI connection to the device. NetMRI must have credentials for the device against which the NetMRI_Easy script is running.

$easy->send_command( $command, $new_prompt)

Send a command to the target device. You can use the new_prompt parameter to override the device prompt when the command executed in the $command parameter to change the prompt on the device.

Example: my $output = $easy->send_command("conf t", "mydevice(config-if)#");

This method requires a CLI connection to the device. NetMRI must have credentials for the device against which the NetMRI_Easy script is running.

$easy->get_template( $template_name )

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

Example: my $contents = $easy->get_template("Cisco Router");

This method requires a CLI connection to the device. NetMRI must have credentials for the device against which the NetMRI_Easy script is running.

$easy->get_list_value( $list_name, $key_column, $value_column, $default )

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.
$issue_type_id

String issue type id

$severity

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

%parameters

hash reference containing the issue details.

Example:

my $issue_id = $easy->generate_issue("Invalid Accounts", "warning", "IP Address" => '1.2.3.4',
"Username"=> 'admin',
);

$easy->log_message($severity, $message)

$easy->broker->broker_name

$easy->device_session( $device_id )

Create an instance of NetMRI_Easy associated with this job, but with a different device. Enables sending of commands to an additional device.

Example:

my $easy2 = $easy->device_session( 25 );
my $command_out = $easy2->send_command('show version');
$easy2->log_message('info', 'send command show version');

This method may be called to create as many device sessions as needed.

$easy->write_payload( @list )

$easy->nios_session