iproutejs 2.3.0

package/lib/commands/rule.js

@@ -0,0 +1,205 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.show = exports.flush = exports.restore = exports.save = exports.del = exports.add = void 0;
+const command_with_redirect_from_filepath_1 = __importDefault(require("../common/classes/command-with-redirect-from-filepath"));
+const command_with_redirect_to_filepath_1 = __importDefault(require("../common/classes/command-with-redirect-to-filepath"));
+const command_with_returned_data_1 = __importDefault(require("../common/classes/command-with-returned-data"));
+const command_1 = __importDefault(require("../common/classes/command"));
+const schemas_1 = require("../common/constants/schemas");
+const add_schema_1 = require("./rule/add.schema");
+const show_schema_1 = require("./rule/show.schema");
+/**
+ * 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`.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { rule } from 'iproutejs';
+ * ```
+ *
+ * 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'
+ * });
+ * ```
+ */
+function add(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'rule', 'add'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RuleAdd, add_schema_1.RuleAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.add = add;
+/**
+ * Delete a rule.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { rule } from 'iproutejs';
+ * ```
+ *
+ * Delete the unused default rule
+ * ```
+ * await rule.del({
+ *   preference: 32767
+ * });
+ * ```
+ */
+function del(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'rule', 'delete'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RuleAdd, add_schema_1.RuleAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.del = del;
+/**
+ * Save rule configuration into a file.
+ *
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ */
+function save(globalOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'rule', 'save'];
+        const ipCmd = new command_with_redirect_to_filepath_1.default(schemas_1.SchemaIds.Empty, schemas_1.EmptySchema, {}, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.save = save;
+/**
+ * Restore rule configuration from a file previously generated by {@link save}.
+ *
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ */
+function restore(globalOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'rule', 'restore'];
+        const ipCmd = new command_with_redirect_from_filepath_1.default(schemas_1.SchemaIds.Empty, schemas_1.EmptySchema, {}, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.restore = restore;
+/**
+ * Deletes all rules.
+ *
+ * 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`.
+ *
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { rule } from 'iproutejs';
+ * ```
+ *
+ * Flush the rules
+ * ```
+ * await rule.flush();
+ * ```
+ */
+function flush(globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'rule', 'flush'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.Empty, schemas_1.EmptySchema, {}, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.flush = flush;
+/**
+ * Shows installed rules.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { rule } from 'iproutejs';
+ * ```
+ *
+ * Show all rules
+ * ```
+ * const rules = await rule.show();
+ * ```
+ */
+function show(options = {}, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'rule', 'show'];
+        const ipCmd = new command_with_returned_data_1.default(schemas_1.SchemaIds.RuleShow, show_schema_1.RuleShowSchema, options, Object.assign(Object.assign({}, globalOptions), { 
+            // Overrides for a better show.
+            '-details': true, '-statistics': true, '-json': true }), cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.show = show;
+exports.default = {
+    add,
+    del,
+    save,
+    restore,
+    flush,
+    show,
+    list: show
+};
+//# sourceMappingURL=rule.js.map

package/lib/commands/rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../src/commands/rule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gIAAoG;AACpG,4HAAkG;AAClG,8GAA2F;AAC3F,wEAAwE;AACxE,yDAA0E;AAS1E,kDAA8D;AAE9D,oDAA+D;AAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,SAAsB,GAAG,CAAC,OAAuB,EACvB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAE,CAAC;QAEpC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,OAAO,EACjB,0BAAa,EACb,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAsB,GAAG,CAAC,OAAuB,EACvB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAE,CAAC;QAEvC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,OAAO,EACjB,0BAAa,EACb,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;GAOG;AACH,SAAsB,IAAI,CAAC,aAAgD;;QAEzE,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAE,CAAC;QAErC,MAAM,KAAK,GAAG,IAAI,2CAA6B,CAC7C,mBAAS,CAAC,KAAK,EACf,qBAAW,EACX,EAAE,EACF,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAZD,oBAYC;AAED;;;;;;;GAOG;AACH,SAAsB,OAAO,CAAC,aAAgD;;QAE5E,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAE,CAAC;QAExC,MAAM,KAAK,GAAG,IAAI,6CAA+B,CAC/C,mBAAS,CAAC,KAAK,EACf,qBAAW,EACX,EAAE,EACF,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAZD,0BAYC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAsB,KAAK,CAAC,gBAA+B,EAAE;;QAC3D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAE,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,KAAK,EACf,qBAAW,EACX,EAAE,EACF,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAXD,sBAWC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAsB,IAAI,CAAC,UAA+B,EAAE,EACjC,gBAA+B,EAAE;;QAE1D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAE,CAAC;QAErC,MAAM,KAAK,GAAG,IAAI,oCAAuB,CACvC,mBAAS,CAAC,QAAQ,EAClB,4BAAc,EACd,OAAO,kCAEF,aAAa;YAChB,+BAA+B;YAC/B,UAAU,EAAK,IAAI,EACnB,aAAa,EAAE,IAAI,EACnB,OAAO,EAAQ,IAAI,KAErB,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAc,CAAC;IACxC,CAAC;CAAA;AAnBD,oBAmBC;AAED,kBAAe;IACb,GAAG;IACH,GAAG;IACH,IAAI;IACJ,OAAO;IACP,KAAK;IACL,IAAI;IACJ,IAAI,EAAE,IAAI;CACX,CAAC"}

package/lib/commands/tunnel/6rd.interfaces.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Tunnel 6rd options.
+ * @category Interfaces
+ */
+export interface Tunnel6rdOptions {
+    /**
+     * Bind the tunnel to the device NAME so that tunneled packets will only be routed via this
+     * device and will not be able to escape to another device when the route to endpoint changes.
+     */
+    dev: string;
+    /** XXX. */
+    '6rd-prefix'?: string;
+    /** XXX. */
+    '6rd-relay_prefix'?: string;
+    /** XXX. */
+    '6rd-reset'?: true;
+}

package/lib/commands/tunnel/6rd.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=6rd.interfaces.js.map

package/lib/commands/tunnel/6rd.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"6rd.interfaces.js","sourceRoot":"","sources":["../../../src/commands/tunnel/6rd.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/tunnel/6rd.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { Tunnel6rdOptions } from './6rd.interfaces';
+export declare const Tunnel6rdSchema: JSONSchemaType<Tunnel6rdOptions>;

package/lib/commands/tunnel/6rd.schema.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tunnel6rdSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+exports.Tunnel6rdSchema = {
+    $id: schemas_1.SchemaIds.Tunnel6rd,
+    type: 'object',
+    required: ['dev'],
+    properties: {
+        dev: {
+            type: 'string',
+            minLength: 1
+        },
+        '6rd-prefix': {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        },
+        '6rd-relay_prefix': {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        },
+        '6rd-reset': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=6rd.schema.js.map

package/lib/commands/tunnel/6rd.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"6rd.schema.js","sourceRoot":"","sources":["../../../src/commands/tunnel/6rd.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAG9C,QAAA,eAAe,GAAqC;IAC/D,GAAG,EAAS,mBAAS,CAAC,SAAS;IAC/B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAC,KAAK,CAAC;IACnB,UAAU,EAAE;QACV,GAAG,EAAiB;YAClB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;SACb;QACD,YAAY,EAAQ;YAClB,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,kBAAkB,EAAE;YAClB,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,WAAW,EAAS;YAClB,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}

package/lib/commands/tunnel/add.interfaces.d.ts

@@ -0,0 +1,124 @@
+import { TunnelModes } from '../tunnel.constants';
+/**
+ * Tunnel add options.
+ * @category Interfaces
+ */
+export interface TunnelAddOptions {
+    /** Select the tunnel device name. */
+    name?: string;
+    /**
+     * Set the tunnel mode.
+     * Available modes depend on the encapsulating address family.
+     */
+    mode?: TunnelModes;
+    /** Set the remote endpoint of the tunnel. */
+    remote?: string;
+    /**
+     * Set the fixed local address for tunneled packets.
+     * It must be an address on another interface of this host.
+     */
+    local?: string;
+    /**
+     * Serialize packets.
+     * The `oseq` flag enables sequencing of outgoing packets.
+     * The `iseq` flag requires that all input packets are serialized.
+     * The `seq` flag is equivalent to the combination `iseq` `oseq`.
+     *
+     * Note: only GRE tunnels.
+     */
+    seq?: boolean;
+    /** @see {@link seq} */
+    iseq?: boolean;
+    /** @see {@link seq} */
+    oseq?: boolean;
+    /**
+     * Use keyed GRE with key `K`.
+     * `K` is either a number or an IP address-like dotted quad.
+     * The key parameter sets the key to use in both directions.
+     * The `ikey` and `okey` parameters set different keys for input and output.
+     *
+     * Note: only GRE tunnels.
+     */
+    key?: number | string;
+    /** @see {@link key} */
+    ikey?: number | string;
+    /** @see {@link key} */
+    okey?: number | string;
+    /**
+     * Generate/require checksums for tunneled packets.
+     * The `ocsum` flag calculates checksums for outgoing packets.
+     * The `icsum` flag requires that all input packets have the correct checksum.
+     * The `csum` flag is equivalent to the combination `icsum` `ocsum`.
+     *
+     * Note: only GRE tunnels.
+     */
+    csum?: boolean;
+    /** @see {@link csum} */
+    icsum?: boolean;
+    /** @see {@link csum} */
+    ocsum?: boolean;
+    /**
+     * Set a fixed encapsulation limit. Default is 4.
+     * Note: only IPv6 tunnels.
+     */
+    encaplimit?: number | 'none';
+    /**
+     * Set a fixed TTL (IPv4) or hoplimit (IPv6) `N` on tunneled packets.
+     * `N` is a number in the range 1-255.
+     * `0` is a special value meaning that packets inherit the TTL value.
+     * The default value for IPv4 tunnels is: `inherit`.
+     * The default value for IPv6 tunnels is: `64`.
+     */
+    ttl?: number | 'inherit';
+    /** @see {@link ttl} */
+    hoplimit?: number | 'inherit';
+    /**
+     * Set the type of service (IPv4) or traffic class (IPv6) field on tunneled packets,
+     * which can be specified as either a two-digit hex value (e.g. `c0`) or a predefined string (e.g. `internet`).
+     * The value inherit causes the field to be copied from the original IP header.
+     * The values `inherit/STRING` or `inherit/00..ff` will set the field to STRING or` 00..ff`
+     * when tunneling non-IP packets.
+     *
+     * The default value is `00`.
+     */
+    tos?: string;
+    /** @see {@link tos} */
+    dsfield?: string;
+    /** @see {@link tos} */
+    tclass?: string;
+    /**
+     * Set a fixed flowlabel.
+     * Note: only IPv6 tunnels.
+     */
+    flowlabel?: string;
+    /** XXX. */
+    pmtudisc?: true;
+    /**
+     * Disable Path MTU Discovery on this tunnel.
+     * It is enabled by default.
+     * Note that a fixed ttl is incompatible with this option: tunneling with a fixed ttl always makes pmtu discovery.
+     *
+     * @see {@link pmtudisc} */
+    nopmtudisc?: true;
+    /**
+     * Enable IPv4 DF suppression on this tunnel.
+     * Normally datagrams that exceed the MTU will be fragmented; the presence of the DF flag inhibits this,
+     * resulting instead in an ICMP Unreachable (Fragmentation Required) message.
+     * Enabling this attribute causes the DF flag to be ignored.
+     */
+    'ignore-df'?: true;
+    /** @see {@link['ignore-df']} */
+    'noignore-df'?: true;
+    /**
+     * Allow remote endpoint on the local host.
+     * Note: only IPv6 tunnels.
+     */
+    'allow-localremote'?: true;
+    /** @see {@link['allow-localremote']} */
+    'noallow-localremote'?: true;
+    /**
+     * Bind the tunnel to the device NAME so that tunneled packets will only be routed via this
+     * device and will not be able to escape to another device when the route to endpoint changes.
+     */
+    dev?: string;
+}

package/lib/commands/tunnel/add.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=add.interfaces.js.map

package/lib/commands/tunnel/add.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.interfaces.js","sourceRoot":"","sources":["../../../src/commands/tunnel/add.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/tunnel/add.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { TunnelAddOptions } from './add.interfaces';
+export declare const TunnelAddSchema: JSONSchemaType<TunnelAddOptions>;

package/lib/commands/tunnel/add.schema.js

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelAddSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const tunnel_constants_1 = require("../tunnel.constants");
+exports.TunnelAddSchema = {
+    $id: schemas_1.SchemaIds.TunnelAdd,
+    type: 'object',
+    required: [],
+    properties: {
+        name: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        },
+        mode: {
+            type: 'string',
+            enum: Object.values(tunnel_constants_1.TunnelModes),
+            nullable: true
+        },
+        remote: {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        },
+        local: {
+            type: 'string',
+            format: 'ip-or-any',
+            minLength: 1,
+            nullable: true
+        },
+        seq: {
+            type: 'boolean',
+            nullable: true
+        },
+        iseq: {
+            type: 'boolean',
+            nullable: true
+        },
+        oseq: {
+            type: 'boolean',
+            nullable: true
+        },
+        key: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    format: 'ipv4',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 4294967295,
+                    nullable: true
+                }
+            ]
+        },
+        ikey: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    format: 'ipv4',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 4294967295,
+                    nullable: true
+                }
+            ]
+        },
+        okey: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    format: 'ipv4',
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 4294967295,
+                    nullable: true
+                }
+            ]
+        },
+        csum: {
+            type: 'boolean',
+            nullable: true
+        },
+        icsum: {
+            type: 'boolean',
+            nullable: true
+        },
+        ocsum: {
+            type: 'boolean',
+            nullable: true
+        },
+        encaplimit: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: ['none'],
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 255,
+                    nullable: true
+                }
+            ]
+        },
+        ttl: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: ['inherit'],
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 255,
+                    nullable: true
+                }
+            ]
+        },
+        hoplimit: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: ['inherit'],
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 255,
+                    nullable: true
+                }
+            ]
+        },
+        tos: {
+            type: 'string',
+            minLength: 1,
+            format: 'tos',
+            nullable: true
+        },
+        dsfield: {
+            type: 'string',
+            minLength: 1,
+            format: 'tos',
+            nullable: true
+        },
+        tclass: {
+            type: 'string',
+            minLength: 1,
+            format: 'tos',
+            nullable: true
+        },
+        flowlabel: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        },
+        pmtudisc: {
+            type: 'boolean',
+            nullable: true
+        },
+        nopmtudisc: {
+            type: 'boolean',
+            nullable: true
+        },
+        'ignore-df': {
+            type: 'boolean',
+            nullable: true
+        },
+        'noignore-df': {
+            type: 'boolean',
+            nullable: true
+        },
+        'allow-localremote': {
+            type: 'boolean',
+            nullable: true
+        },
+        'noallow-localremote': {
+            type: 'boolean',
+            nullable: true
+        },
+        dev: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=add.schema.js.map

package/lib/commands/tunnel/add.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.schema.js","sourceRoot":"","sources":["../../../src/commands/tunnel/add.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAE3D,0DAAkD;AAErC,QAAA,eAAe,GAAqC;IAC/D,GAAG,EAAS,mBAAS,CAAC,SAAS;IAC/B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,EAAE;IACd,UAAU,EAAE;QACV,IAAI,EAAmB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,MAAM,EAAiB;YACrB,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,KAAK,EAAkB;YACrB,IAAI,EAAO,QAAQ;YACnB,MAAM,EAAK,WAAW;YACtB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,GAAG,EAAoB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAoB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,MAAM,EAAI,MAAM;oBAChB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,OAAO,EAAG,UAAU;oBACpB,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,MAAM,EAAI,MAAM;oBAChB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,OAAO,EAAG,UAAU;oBACpB,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,MAAM,EAAI,MAAM;oBAChB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,OAAO,EAAG,UAAU;oBACpB,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,IAAI,EAAmB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAkB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAkB;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAa;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,CAAC,MAAM,CAAC;oBAClB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,OAAO,EAAG,GAAG;oBACb,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,GAAG,EAAoB;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,CAAC,SAAS,CAAC;oBACrB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,OAAO,EAAG,GAAG;oBACb,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,QAAQ,EAAe;YACrB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAK,CAAE,SAAS,CAAC;oBACrB,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,OAAO,EAAG,GAAG;oBACb,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;QACD,GAAG,EAAoB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,MAAM,EAAK,KAAK;YAChB,QAAQ,EAAG,IAAI;SAChB;QACD,OAAO,EAAgB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,MAAM,EAAK,KAAK;YAChB,QAAQ,EAAG,IAAI;SAChB;QACD,MAAM,EAAiB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,MAAM,EAAK,KAAK;YAChB,QAAQ,EAAG,IAAI;SAChB;QACD,SAAS,EAAc;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,QAAQ,EAAe;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAa;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,WAAW,EAAY;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,aAAa,EAAU;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,mBAAmB,EAAI;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,qBAAqB,EAAE;YACrB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAoB;YACrB,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;KACF;CACF,CAAC"}

package/lib/commands/tunnel/prl.interfaces.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Tunnel prl options.
+ * @category Interfaces
+ */
+export interface TunnelPrlOptions {
+    /**
+     * Bind the tunnel to the device NAME so that tunneled packets will only be routed via this
+     * device and will not be able to escape to another device when the route to endpoint changes.
+     */
+    dev: string;
+    /** Add or delete ADDR as a potential router or default router. */
+    'prl-default'?: string;
+    /** @see {@link['prl-default']} */
+    'prl-nodefault'?: string;
+    /** @see {@link['prl-default']} */
+    'prl-delete'?: string;
+}

package/lib/commands/tunnel/prl.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=prl.interfaces.js.map

package/lib/commands/tunnel/prl.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prl.interfaces.js","sourceRoot":"","sources":["../../../src/commands/tunnel/prl.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/tunnel/prl.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { TunnelPrlOptions } from './prl.interfaces';
+export declare const TunnelPrlSchema: JSONSchemaType<TunnelPrlOptions>;