Class Mikrotik

Hierarchy

default
- Mikrotik

Index

Constructors

Properties

Methods

bandwidth_test get_interfaces get_ip_addresses get_ip_routes get_route_counts health identity kvs ping resource routerboard semantic_version terse traceroute version

Constructors

constructor

new Mikrotik(config: ConnectConfig): Mikrotik
Creates a new instance of the class
Parameters
- config: ConnectConfig
Returns Mikrotik
Inherited from SSH.constructor

Properties

`Protected` `Static`cache

cache: Memory = ...

Methods

bandwidth_test

bandwidth_test(
    target: string,
    username: string,
    password: string,
    options?: Partial<Options>,
): Promise<Update>
Executes a bandwidth test

Note: you must supply a callback in the options to get the intermittent results of the bandwidth test; otherwise, you will only receive the final result back from the promise
Parameters
- target: string
- username: string
- password: string
- options: Partial<Options> = {}
Returns Promise<Update>

get_interfaces

get_interfaces(active_only?: boolean): Promise<Mikrotik.Response.Interface[]>
Retrieves the interfaces active on the system
Parameters
- active_only: boolean = true
Returns Promise<Mikrotik.Response.Interface[]>

get_ip_addresses

get_ip_addresses(active_only?: boolean): Promise<Mikrotik.Response.Address[]>
Retrieves the IP addresses active on the system
Parameters
- active_only: boolean = true
Returns Promise<Mikrotik.Response.Address[]>

get_ip_routes

get_ip_routes(
    min_distance?: number,
    vrf?: string,
    active_only?: boolean,
): Promise<Mikrotik.Response.Route[]>
Retrieves the routes in the routing table
Parameters
- min_distance: number = 0
- Optionalvrf: string
- active_only: boolean = true
Returns Promise<Mikrotik.Response.Route[]>

get_route_counts

get_route_counts(
min_distance?: number,
vrf?: string,
): Promise<Record<string, Count>>
For all device IP addresses, counts the routes that exit (either directly or tunneled) the device using each IP address
Parameters
- min_distance: number = 0
- Optionalvrf: string
Returns Promise<Record<string, Count>>

health

health(): Promise<Mikrotik.Response.V6.Health | Mikrotik.Response.V7.Health>
Fetches the current health information

Returns Promise<Mikrotik.Response.V6.Health | Mikrotik.Response.V7.Health>

identity

identity(): Promise<string>
Fetches the identity of the device

Returns Promise<string>

`Protected`kvs

kvs<Type extends object = any>(command: string): Promise<Type>
Protected
Executes a command that expects the result as a 'table' of key-value pairs separated by a colon (:)
Type Parameters
- Type extends object = any
Parameters
- command: string
Returns Promise<Type>

ping

ping(target: string, source?: string): Promise<Ping>
Pings the target IP address from the source IP address (if supplied)
Parameters
- target: string
- Optionalsource: string
Returns Promise<Ping>

resource

resource(): Promise<Mikrotik.Response.Resource>
Fetches the resource information of the device

Returns Promise<Mikrotik.Response.Resource>

routerboard

routerboard(): Promise<Mikrotik.Response.Routerboard>
Fetches routerboard information from the device

Returns Promise<Mikrotik.Response.Routerboard>

semantic_version

semantic_version(): Promise<{ major: number; minor: number; patch: number }>
Fetches the semantic RouterOS version

Returns Promise<{ major: number; minor: number; patch: number }>

`Protected`terse

terse<Type extends object = any>(command: string): Promise<Type[]>
Protected
Executes a command with expected terse response and parses it accordingly
Type Parameters
- Type extends object = any
Parameters
- command: string
Returns Promise<Type[]>

traceroute

traceroute(target: string, source?: string): Promise<Traceroute[]>
Performs a traceroute to the target IP address from the source IP address (if supplied)
Parameters
- target: string
- Optionalsource: string
Returns Promise<Traceroute[]>

version

version(): Promise<string>
Fetches the current RouterOS version

Returns Promise<string>

Class Mikrotik

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Mikrotik

Properties

Protected Staticcache

Methods

bandwidth_test

Parameters

Returns Promise<Update>

get_interfaces

Parameters

Returns Promise<Mikrotik.Response.Interface[]>

get_ip_addresses

Parameters

Returns Promise<Mikrotik.Response.Address[]>

get_ip_routes

Parameters

Returns Promise<Mikrotik.Response.Route[]>

get_route_counts

Parameters

Returns Promise<Record<string, Count>>

health

Returns Promise<Mikrotik.Response.V6.Health | Mikrotik.Response.V7.Health>

identity

Returns Promise<string>

Protectedkvs

Type Parameters

Parameters

Returns Promise<Type>

ping

Parameters

Returns Promise<Ping>

resource

Returns Promise<Mikrotik.Response.Resource>

routerboard

Returns Promise<Mikrotik.Response.Routerboard>

semantic_version

Returns Promise<{ major: number; minor: number; patch: number }>

Protectedterse

Type Parameters

Parameters

Returns Promise<Type[]>

traceroute

Parameters

Returns Promise<Traceroute[]>

version

Returns Promise<string>

Settings

On This Page

`Protected` `Static`cache

`Protected`kvs

`Protected`terse