Function flush

flush(options: NeighbourShowOptions, globalOptions?: GlobalOptions): Promise<Command<NeighbourShowOptions>>
Flush 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>>
Remarks
The differences are that it does not run when no arguments are given, and that the default neighbour states to be flushed do not include NudStates.Permanent and NudStates.Noarp.

Throws
ParametersError - Throws when passed parameters are invalid.

Throws
CommandError - Throws when the executed command fails.

Example
Import module
```
import { neighbour } from 'iproute';
```
Flush neighbour entries from dev eth0
```
await neighbour.flush({
  dev: 'eth0'
});
```
- Defined in src/commands/neighbour.ts:173

Generated using TypeDoc