Function del

  • Delete a neighbour entry.

    Parameters

    • options: NeighbourDelOptions

      Parameters options to be passed down to ip.

    • globalOptions: GlobalOptions = {}

      Global parameters options that affects the command execution.

    Returns Promise<Command<NeighbourDelOptions>>

    Remarks

    Warning: Attempts to delete or manually change a NudStates.Noarp entry created by the kernel may result in unpredictable behaviour.

    Particularly, the kernel may try to resolve this address even on a NOARP interface or if the address is multicast or broadcast.

    Throws

    ParametersError - Throws when passed parameters are invalid.

    Throws

    CommandError - Throws when the executed command fails.

    Example

    Import module

    import { neighbour } from 'iproute';
    

    Delete an ARP entry

    await neighbour.del({
    to : '192.168.1.100',
    dev: 'eth0'
    });

Generated using TypeDoc