iproutejs 2.3.0

package/lib/commands/route.d.ts

@@ -0,0 +1,268 @@
+import Command from '../common/classes/command';
+import { Empty, GlobalOptions, GlobalOptionsWithRequiredFilePath } from '../common/interfaces/common';
+import { RouteGetOptions } from './route/get.interfaces';
+import { RouteInfo, RouteShowOptions } from './route/show.interfaces';
+import { RouteAddOptions } from './route/add.interfaces';
+/**
+ * List routes.
+ * The command displays the contents of the routing tables or the route(s) selected by some criteria.
+ *
+ * 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 { route } from 'iproutejs';
+ * ```
+ *
+ * Show routes from all tables
+ * ```
+ * const routes = await route.show({
+ *   table: RouteRoutingTables.All
+ * });
+ * ```
+ */
+export declare function show(options?: RouteShowOptions, globalOptions?: GlobalOptions): Promise<Command<RouteShowOptions> | RouteInfo[]>;
+/**
+ * Flush routing tables this command flushes routes selected by some criteria.
+ *
+ * The arguments have the same syntax and semantics as the arguments of `ip route show`, but routing tables are
+ * not listed but purged.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Flush the table cache
+ * ```
+ * await route.flush({
+ *   table: RouteRoutingTables.Cache
+ * });
+ * ```
+ */
+export declare function flush(options: RouteShowOptions, globalOptions?: GlobalOptions): Promise<Command<RouteShowOptions>>;
+/**
+ * Save routing table information.
+ *
+ * @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.
+ */
+export declare function save(options: RouteShowOptions | undefined, globalOptions: GlobalOptionsWithRequiredFilePath): Promise<Command<RouteShowOptions>>;
+/**
+ * Restore routing table information 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.
+ */
+export declare function restore(globalOptions: GlobalOptionsWithRequiredFilePath): Promise<Command<Empty>>;
+/**
+ * Get a single route.
+ *
+ * This command gets a single route to a destination and prints its contents exactly as the  kernel sees it.
+ *
+ * @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.
+ */
+export declare function get(options: RouteGetOptions, globalOptions?: GlobalOptions): Promise<Command<RouteGetOptions> | RouteInfo[]>;
+/**
+ * Add new route.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Unicast type route (the default if not specified)
+ * ```
+ * await route.add({
+ *   to:	'10.0.0.0/24',
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ *
+ * Multipath route with load balance between devices
+ * ```
+ * await route.add({
+ *   to:	  'default',
+ *   scope:	AddressScopes.Global,
+ *   nexthops:  [{
+ *     nexthop: true,
+ *     dev:     'ppp0'
+ *   },
+ *   {
+ *     nexthop: true,
+ *     dev:     'ppp1'
+ *   }]
+ * });
+ * ```
+ *
+ * A NAT route
+ * ```
+ * await route.add({
+ *   type:	RoutingTableTypes.Nat,
+ *   to:	    '10.0.0.0/24',
+ *   table:	300,
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ */
+export declare function add(options: RouteAddOptions, globalOptions?: GlobalOptions): Promise<Command<RouteAddOptions>>;
+/**
+ * Delete route.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Delete multipath route with load balance between devices
+ * ```
+ * await route.del({
+ *   to:	  'default',
+ *   scope:	AddressScopes.Global,
+ *   nexthops:  [{
+ *     nexthop: true,
+ *     dev:     'ppp0'
+ *   },
+ *   {
+ *     nexthop: true,
+ *     dev:     'ppp1'
+ *  }]
+ * });
+ * ```
+ */
+export declare function del(options: RouteAddOptions, globalOptions?: GlobalOptions): Promise<Command<RouteAddOptions>>;
+/**
+ * Change route.
+ *
+ * @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.
+ */
+export declare function change(options: RouteAddOptions, globalOptions?: GlobalOptions): Promise<Command<RouteAddOptions>>;
+/**
+ * Append route.
+ *
+ * @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.
+ */
+export declare function append(options: RouteAddOptions, globalOptions?: GlobalOptions): Promise<Command<RouteAddOptions>>;
+/**
+ * Change or add new one.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Unicast type route (the default if not specified)
+ * ```
+ * await route.add({
+ *   to:	'10.0.0.0/24',
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ *
+ * Multipath route with load balance between devices
+ * ```
+ * await route.add({
+ *   to:	  'default',
+ *   scope:	AddressScopes.Global,
+ *   nexthops:  [{
+ *     nexthop: true,
+ *     dev:     'ppp0'
+ *   },
+ *   {
+ *     nexthop: true,
+ *     dev:     'ppp1'
+ *   }]
+ * });
+ * ```
+ *
+ * A NAT route
+ * ```
+ * await route.add({
+ *   type:	RoutingTableTypes.Nat,
+ *   to:	    '10.0.0.0/24',
+ *   table:	300,
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ */
+export declare function replace(options: RouteAddOptions, globalOptions?: GlobalOptions): Promise<Command<RouteAddOptions>>;
+declare const _default: {
+    show: typeof show;
+    flush: typeof flush;
+    save: typeof save;
+    restore: typeof restore;
+    get: typeof get;
+    add: typeof add;
+    del: typeof del;
+    change: typeof change;
+    append: typeof append;
+    replace: typeof replace;
+};
+export default _default;

package/lib/commands/route.js

@@ -0,0 +1,362 @@
+"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.replace = exports.append = exports.change = exports.del = exports.add = exports.get = exports.restore = exports.save = exports.flush = exports.show = 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 get_schema_1 = require("./route/get.schema");
+const show_schema_1 = require("./route/show.schema");
+const add_schema_1 = require("./route/add.schema");
+/**
+ * List routes.
+ * The command displays the contents of the routing tables or the route(s) selected by some criteria.
+ *
+ * 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 { route } from 'iproutejs';
+ * ```
+ *
+ * Show routes from all tables
+ * ```
+ * const routes = await route.show({
+ *   table: RouteRoutingTables.All
+ * });
+ * ```
+ */
+function show(options = {}, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'show'];
+        const ipCmd = new command_with_returned_data_1.default(schemas_1.SchemaIds.RouteShow, show_schema_1.RouteShowSchema, 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;
+/**
+ * Flush routing tables this command flushes routes selected by some criteria.
+ *
+ * The arguments have the same syntax and semantics as the arguments of `ip route show`, but routing tables are
+ * not listed but purged.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Flush the table cache
+ * ```
+ * await route.flush({
+ *   table: RouteRoutingTables.Cache
+ * });
+ * ```
+ */
+function flush(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'flush'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RouteShow, show_schema_1.RouteShowSchema, options, Object.assign(Object.assign({}, globalOptions), { 
+            // Overrides for a better show.
+            '-details': true, '-statistics': true, '-json': true }), cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.flush = flush;
+/**
+ * Save routing table information.
+ *
+ * @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.
+ */
+function save(options = {}, globalOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'save'];
+        const ipCmd = new command_with_redirect_to_filepath_1.default(schemas_1.SchemaIds.RouteShow, show_schema_1.RouteShowSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.save = save;
+/**
+ * Restore routing table information 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', 'route', '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;
+/**
+ * Get a single route.
+ *
+ * This command gets a single route to a destination and prints its contents exactly as the  kernel sees it.
+ *
+ * @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.
+ */
+function get(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'get'];
+        const ipCmd = new command_with_returned_data_1.default(schemas_1.SchemaIds.RouteShow, get_schema_1.RouteGetSchema, options, Object.assign(Object.assign({}, globalOptions), { 
+            // Overrides for a better show.
+            '-details': true, '-statistics': true, '-json': true }), cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.get = get;
+/**
+ * Add new route.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Unicast type route (the default if not specified)
+ * ```
+ * await route.add({
+ *   to:	'10.0.0.0/24',
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ *
+ * Multipath route with load balance between devices
+ * ```
+ * await route.add({
+ *   to:	  'default',
+ *   scope:	AddressScopes.Global,
+ *   nexthops:  [{
+ *     nexthop: true,
+ *     dev:     'ppp0'
+ *   },
+ *   {
+ *     nexthop: true,
+ *     dev:     'ppp1'
+ *   }]
+ * });
+ * ```
+ *
+ * A NAT route
+ * ```
+ * await route.add({
+ *   type:	RoutingTableTypes.Nat,
+ *   to:	    '10.0.0.0/24',
+ *   table:	300,
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ */
+function add(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'add'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RouteAdd, add_schema_1.RouteAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.add = add;
+/**
+ * Delete route.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Delete multipath route with load balance between devices
+ * ```
+ * await route.del({
+ *   to:	  'default',
+ *   scope:	AddressScopes.Global,
+ *   nexthops:  [{
+ *     nexthop: true,
+ *     dev:     'ppp0'
+ *   },
+ *   {
+ *     nexthop: true,
+ *     dev:     'ppp1'
+ *  }]
+ * });
+ * ```
+ */
+function del(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'delete'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RouteAdd, add_schema_1.RouteAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.del = del;
+/**
+ * Change route.
+ *
+ * @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.
+ */
+function change(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'change'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RouteAdd, add_schema_1.RouteAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.change = change;
+/**
+ * Append route.
+ *
+ * @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.
+ */
+function append(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'append'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RouteAdd, add_schema_1.RouteAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.append = append;
+/**
+ * Change or add new one.
+ *
+ * @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 { route } from 'iproutejs';
+ * ```
+ *
+ * Unicast type route (the default if not specified)
+ * ```
+ * await route.add({
+ *   to:	'10.0.0.0/24',
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ *
+ * Multipath route with load balance between devices
+ * ```
+ * await route.add({
+ *   to:	  'default',
+ *   scope:	AddressScopes.Global,
+ *   nexthops:  [{
+ *     nexthop: true,
+ *     dev:     'ppp0'
+ *   },
+ *   {
+ *     nexthop: true,
+ *     dev:     'ppp1'
+ *   }]
+ * });
+ * ```
+ *
+ * A NAT route
+ * ```
+ * await route.add({
+ *   type:	RoutingTableTypes.Nat,
+ *   to:	    '10.0.0.0/24',
+ *   table:	300,
+ *   via:	{
+ *     address: '192.168.56.1'
+ *   }
+ * });
+ * ```
+ */
+function replace(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'route', 'replace'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.RouteAdd, add_schema_1.RouteAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.replace = replace;
+exports.default = {
+    show,
+    flush,
+    save,
+    restore,
+    get,
+    add,
+    del,
+    change,
+    append,
+    replace
+};
+//# sourceMappingURL=route.js.map

package/lib/commands/route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/commands/route.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gIAAoG;AACpG,4HAAkG;AAClG,8GAA2F;AAC3F,wEAAwE;AACxE,yDAA0E;AAS1E,mDAAiE;AAEjE,qDAAkE;AAElE,mDAAiE;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAsB,IAAI,CAAC,UAA+B,EAAE,EACjC,gBAA+B,EAAE;;QAE1D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAE,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,oCAAuB,CACvC,mBAAS,CAAC,SAAS,EACnB,6BAAe,EACf,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,EAAe,CAAC;IACzC,CAAC;CAAA;AAnBD,oBAmBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAsB,KAAK,CAAC,OAAyB,EACzB,gBAA+B,EAAE;;QAE3D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAE,CAAC;QAEvC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,SAAS,EACnB,6BAAe,EACf,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,EAAE,CAAC;IAC5B,CAAC;CAAA;AAnBD,sBAmBC;AAED;;;;;;;;GAQG;AACH,SAAsB,IAAI,CAAC,UAA4B,EAAE,EAC9B,aAAgD;;QAEzE,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAE,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,2CAA6B,CAC7C,mBAAS,CAAC,SAAS,EACnB,6BAAe,EACf,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,oBAaC;AAED;;;;;;;GAOG;AACH,SAAsB,OAAO,CAAC,aAAgD;;QAE5E,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAE,CAAC;QAEzC,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;;;;;;;;;;GAUG;AACH,SAAsB,GAAG,CAAC,OAAwB,EACxB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAE,CAAC;QAErC,MAAM,KAAK,GAAG,IAAI,oCAAuB,CACvC,mBAAS,CAAC,SAAS,EACnB,2BAAc,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,EAAe,CAAC;IACzC,CAAC;CAAA;AAnBD,kBAmBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,SAAsB,GAAG,CAAC,OAAwB,EACxB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,KAAK,CAAE,CAAC;QAErC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,QAAQ,EAClB,2BAAc,EACd,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAsB,GAAG,CAAC,OAAwB,EACxB,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAE,CAAC;QAExC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,QAAQ,EAClB,2BAAc,EACd,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;GAQG;AACH,SAAsB,MAAM,CAAC,OAAwB,EACxB,gBAA+B,EAAE;;QAE5D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAE,CAAC;QAExC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,QAAQ,EAClB,2BAAc,EACd,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,wBAaC;AAED;;;;;;;;GAQG;AACH,SAAsB,MAAM,CAAC,OAAwB,EACxB,gBAA+B,EAAE;;QAE5D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAE,CAAC;QAExC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,QAAQ,EAClB,2BAAc,EACd,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,wBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,SAAsB,OAAO,CAAC,OAAwB,EACxB,gBAA+B,EAAE;;QAE7D,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,OAAO,EAAE,SAAS,CAAE,CAAC;QAEzC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,QAAQ,EAClB,2BAAc,EACd,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,0BAaC;AAED,kBAAe;IACb,IAAI;IACJ,KAAK;IACL,IAAI;IACJ,OAAO;IACP,GAAG;IACH,GAAG;IACH,GAAG;IACH,MAAM;IACN,MAAM;IACN,OAAO;CACR,CAAC"}

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

@@ -0,0 +1,41 @@
+import { RoutingTables } from '../rule.constants';
+import { RuleShowOptions } from './show.interfaces';
+/**
+ * Rule add options.
+ * @category Interfaces
+ */
+export interface RuleAddOptions extends RuleShowOptions {
+    /**
+     * The routing table identifier to lookup if the rule selector matches.
+     * It is also possible to use lookup instead of table.
+     */
+    table?: number | RoutingTables;
+    /**
+     * The routing protocol who installed the rule in question.
+     * As an example when zebra installs a rule it would get RTPROT_ZEBRA as the installing protocol.
+     */
+    protocol?: string | number;
+    /**
+     * The base of the IP address block to translate (for source addresses).
+     * The ADDRESS may be either the start of the block of NAT addresses (selected by NAT routes) or a local host
+     * address (or even zero).
+     *
+     * In the last case the router does not translate the packets, but masquerades them to this address.
+     * Using `map-to` instead of `nat` means the same thing.
+     */
+    nat?: string;
+    /**
+     * Realms to select if the rule matched and the routing table lookup succeeded.
+     * Realm TO is only used if the route did not select any realm.
+     */
+    realms?: string;
+    /**
+     * Attribute is used to jump to a rule with a specified priority.
+     * It essentially alters the typical sequence in which rules are evaluated.
+     */
+    goto?: number;
+    /** Reject routing decisions that have a prefix length of NUMBER or less. */
+    suppress_prefixlength?: number;
+    /** Reject routing decisions that use a device belonging to the interface group GROUP. */
+    suppress_ifgroup?: number;
+}

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

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

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

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

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

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