README

<3 NetMiko but I'm a php developer. So I've decided to build a php alternative

Mad respect to Kirk Byers for creating netmiko and being a huge inspiration to this project.

To hit the ground running check out the Quickstart example.

Requires:

Php >= 7.1

Installation:

composer require epiecs/phpmiko

Supported devices

Implemented

Aruba
Cisco ios
Cisco nx-os
HPE Comware
Juniper Junos

Planned

Avaya
Linux
Vyos
Checkpoint
...

Supported protocols

ssh
telnet

PhpMiko

Examples:

Quickstart example

<?php

require_once __DIR__ . '/vendor/autoload.php';

$device = new \Epiecs\PhpMiko\ConnectionHandler([
	'device_type' => 'junos',
	'hostname'    => '192.168.0.1',
	'username'    => 'my_user',
	'password'    => 'mysafepassword',
]);

print_r($device->operation([
	'show system uptime',
	'show system alarms',
]));

/*
Array
(
    [show system uptime] => fpc0:
--------------------------------------------------------------------------
Current time: 2018-11-02 02:30:18 CET
Time Source:  LOCAL CLOCK 
System booted: 2018-09-15 09:22:02 CEST (6w5d 18:08 ago)
Protocols started: 2018-09-15 09:24:40 CEST (6w5d 18:05 ago)
Last configured: 2018-10-14 06:47:11 CEST (2w4d 20:43 ago) by itdept
 2:30AM  up 47 days, 18:08, 3 users, load averages: 0.11, 0.11, 0.08

    [show system alarms] => No alarms currently active
)
*/

print_r($device->configure([
	'set interfaces ge-0/0/47 description "Test for documentation"',
	'edit interfaces ge-0/0/46',
	'set description "Sequential commands work"',
]));

/*
Array
(
    [set interfaces ge-0/0/47 description "Test for documentation"] => 
    [edit interfaces ge-0/0/46] => 
    [set description "Sequential commands work"] => 
)
*/

Connecting to a device

<?php

require_once __DIR__ . '/vendor/autoload.php';

$device = new \Epiecs\PhpMiko\ConnectionHandler([
	'device_type' => 'junos',
	'hostname'    => '192.168.0.1',
	'username'    => 'username',
	'password'    => 'password',
	'protocol'    => 'ssh',          //default is ssh
	'port'        => 22,             //defaults to the protocol default if not set
	'secret'      => 'secret',       //default is ''
	'verbose'     => false,          //default is false
	'raw'         => false           //default is false
]);

When the raw flag is set to true PhpMiko will not clean up output and return it as is (minus a few hidden characters so you at least get all textual output).

secret is used when a runlevel requires a different password. Like for example enable mode (privileged exec) in Cisco ios. You would put the enable password in the secret field.

verbose when set to true all sent and received raw packets will be ouput for debugging purposes.

--- output cut short for brevity, notice the arrows

-> NET_SSH2_MSG_CHANNEL_DATA (since last: 0.0013, network: 0.0002s)
00000000  00:00:00:00:00:00:00:05:64:61:74:65:0a           ........date.

<- NET_SSH2_MSG_CHANNEL_DATA (since last: 0.1556, network: 0.0011s)
00000000  00:00:00:02:00:00:00:07:64:61:74:65:0d:0d:0a     ........date...

<- NET_SSH2_MSG_CHANNEL_DATA (since last: 0.1458, network: 0.0001s)
00000000  00:00:00:02:00:00:00:1f:46:72:69:20:4a:75:6e:20  ........Fri Jun
00000010  32:31:20:31:31:3a:31:36:3a:31:32:20:43:45:53:54  21 11:16:12 CEST
00000020  20:32:30:31:39:0d:0a                              2019..

For a list of all device_types refer to Device types and command mapping.

Sending commands

When sending commands you can either provide a string or an array. Either way is fine. When providing an array the commands are run in order.

In these examples the command type operation is used. For all command types check out Command types.

Sending one command as string

print_r($device->operation('show interfaces ge-0/0/0'));

Sending one command as an array

print_r($device->operation([
	'show interfaces ge-0/0/0',
]));

Sending multiple commands

print_r($device->operation([
	'show interfaces ge-0/0/0',
	'show interfaces ge-0/0/1',
]));

Output

All output will be returned as an array where the key is the command that was run

Array
(
    [show version] => fpc0:
--------------------------------------------------------------------------
Hostname: SW-Junos
Model: ex3300-48p
Junos: 15.1R7.9
JUNOS EX  Software Suite [15.1R7.9]
JUNOS FIPS mode utilities [15.1R7.9]
JUNOS Online Documentation [15.1R7.9]
JUNOS EX 3300 Software Suite [15.1R7.9]
JUNOS Web Management Platform Package [15.1R7.9]

)

Command types

PhpMiko has 3 distinct mechanisms to send commands:

cli
operation
configure

All commands are run sequentially and chained. However this is only per set of supplied commands.

Even though PhpMiko has 3 mechanisms not all are implemented on each device. Some devices only have 1 or 2 configuration tiers. For an overview please refer to Device types and command mapping.

cli

Runs one or more cli commands on a device. Eg. the standard linux cli in junos or user exec mode in cisco ios

print_r($device->cli([
	'pwd',
	'cd /var/www ; pwd ; ls -l'
]));

operation

Runs one or more operational/enable commands on a device. Eg. cli (operational) mode in junos or privileged exec mode in cisco ios

print_r($device->operation([
	'show interfaces terse',
	'show configuration interfaces ge-0/0/0'
]));

configure

Sends one or more configuration commands to the device. Eg. configuration mode in junos or global configuration (configure terminal) in cisco ios

print_r($device->configure([
	'set interfaces ge-0/0/0 description "Test for documentation"',
	'edit interfaces ge-0/0/1',
	'set description "Sequential commands work"',
]));

Device types and command mapping

Vendor	Device	device_type	cli	operation	configure
Aruba	Aruba	aruba	user exec	privileged exec	configure terminal
Cisco	Cisco ios	cisco_ios	user exec	privileged exec	configure terminal
	Cisco nxos	cisco_nxos	user exec	user exec	configure terminal
Juniper	Junos	junos	linux cli ¹	operational mode	configuration mode
HP	HPE Comware	comware	user exec	user exec	system-view

1: Only works when using the root account

Cleaning up and debugging

Setting raw mode

Defaults to true when calling the function.

$device->raw();
$device->raw(false);

Closing the connection

$device->disconnect();

Suggestions

The underlaying library for ssh connections is phpseclib. They recommend the following php extensions for a nice speed boost when using ssh:

ext-libsodium
ext-openssl
ext-mcrypt
ext-gmp

These extensions are not required.

Contributions and thanks

HPE Comware support murrant
Phpseclib phpseclib

epiecs / phpmiko

Maintainers

Details