Function add

  • Insert a new rule.

    Warning: Changes to the RPDB made with these commands do not become active immediately. It is assumed that after a script finishes a batch of updates, it flushes the routing cache with ip route flush cache.

    Parameters

    • options: RuleAddOptions

      Parameters options to be passed down to ip.

    • globalOptions: GlobalOptions = {}

      Global parameters options that affects the command execution.

    Returns Promise<Command<RuleAddOptions>>

    Throws

    ParametersError - Throws when passed parameters are invalid.

    Throws

    CommandError - Throws when the executed command fails.

    Example

    Import module

    import { rule } from 'iproute';
    

    Unicast type rule (the default if not specified)

    await rule.add({
    from: '192.203.80.0/24',
    table: 300,
    preference: 220
    });

    NAT type rule

    await rule.add({
    from: '193.233.7.83',
    table: 1,
    preference: 320,
    nat: '192.203.80.144'
    });

Generated using TypeDoc