Function show

show(options?: NeighbourShowOptions, globalOptions?: GlobalOptions): Promise<Command<NeighbourShowOptions> | NeighbourInfo[]>
List neighbour entries.
Parameters
- options: NeighbourShowOptions = {}
  
  Parameters options to be passed down to ip.
- globalOptions: GlobalOptions = {}
  
  Global parameters options that affects the command execution.
Returns Promise<Command<NeighbourShowOptions> | NeighbourInfo[]>
Throws
ParametersError - Throws when passed parameters are invalid.

Throws
CommandError - Throws when the executed command fails.

Example
Import module
```
import { neighbour } from 'iproute';
```
Show all neighbour entries
```
const entries = await neighbour.show({});
```
- Defined in src/commands/neighbour.ts:211

Generated using TypeDoc