iproutejs 2.3.0

package/lib/commands/link/virtual-link-types/can.interfaces.d.ts

@@ -0,0 +1,71 @@
+import { OnOffToggle } from '../../../common/constants/attribute-values';
+/**
+ * Add link can type arguments.
+ * @category Interfaces
+ */
+export interface AddLinkCanTypeArgs {
+    /** Sets the nominal speed of the CAN bus in bits per second for the arbitration phase. */
+    bitrate?: number;
+    /**
+     * Specifies the sampling point as a percentage.
+     * It defines at which point a bit should be sampled.
+     */
+    'sample-point'?: number;
+    /** Time Quantum. The smallest time unit for the CAN bit timing. */
+    tq?: number;
+    /** Propagation Segment. The time segment needed to compensate for the physical delay of the signal. */
+    'prop-seg'?: number;
+    /** Phase Buffer Segment 1. The first segment of the phase buffer, used to adjust the position of the sample point. */
+    'phase-seg1'?: number;
+    /** Phase Buffer Segment 2. The second segment of the phase buffer, also used for sample point adjustment. */
+    'phase-seg2'?: number;
+    /** Synchronization Jump Width. The maximum number of time quanta that the bit timing can be adjusted to compensate for oscillator drift. */
+    sjw?: number;
+    /**
+     * Sets the nominal speed for the data phase.
+     * @see {@link[bitrate]}
+     */
+    dbitrate?: number;
+    /** @see {@link['sample-point']} */
+    'dsample-point'?: number;
+    /** @see {@link[tq]} */
+    dtq?: number;
+    /** @see {@link['prop-seg']} */
+    'dprop-seg'?: number;
+    /** @see {@link['phase-seg1']} */
+    'dphase-seg1'?: number;
+    /** @see {@link['phase-seg2']} */
+    'dphase-seg2'?: number;
+    /** @see {@link[sjw]} */
+    dsjw?: number;
+    /**
+     * Enables the internal loopback mode of the CAN controller.
+     * In loopback mode, the CAN controller can send and receive messages internally without the need for an actual CAN network.
+     */
+    loopback?: OnOffToggle;
+    /** Sets the interface to listen-only mode where it will not send any messages. */
+    'listen-only'?: OnOffToggle;
+    /** This enables or disables triple sampling for receiving. */
+    'triple-sampling'?: OnOffToggle;
+    /** If enabled, this prevents the controller from automatically retrying to send a message upon an error. */
+    'one-shot'?: OnOffToggle;
+    /**
+     * Enables bus error reporting.
+     * When enabled, the CAN interface will generate error messages in the system logs if bus errors are detected.
+     */
+    'berr-reporting'?: OnOffToggle;
+    /** Enables or disables CAN FD support. */
+    fd?: OnOffToggle;
+    /** Enables or disables non-ISO CAN FD support. */
+    'fd-non-iso'?: OnOffToggle;
+    /** Assume that the acknowledgment for a transmitted frame is received, even if it is not actually received. */
+    'presume-ack'?: OnOffToggle;
+    /** Sets the automatic restart delay in milliseconds if the bus is in an error state. */
+    'restart-ms'?: number;
+    /**
+     * Enables automatic restart of the CAN controller after a bus-off condition.
+     * A bus-off condition occurs when the CAN controller detects too many errors on the bus, causing it to disconnect from the network to prevent further disruptions.
+     * Enabling automatic restart allows the controller to attempt to rejoin the bus after a specified delay.
+     */
+    restart?: boolean;
+}

package/lib/commands/link/virtual-link-types/can.interfaces.js

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

package/lib/commands/link/virtual-link-types/can.interfaces.js.map

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

package/lib/commands/link/virtual-link-types/can.schema.d.ts

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

package/lib/commands/link/virtual-link-types/can.schema.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddLinkCanArgsSchema = void 0;
+const attribute_values_1 = require("../../../common/constants/attribute-values");
+exports.AddLinkCanArgsSchema = {
+    type: 'object',
+    required: [],
+    additionalProperties: false,
+    properties: {
+        bitrate: {
+            type: 'integer',
+            minimum: 1,
+            maximum: 1000000,
+            nullable: true
+        },
+        'sample-point': {
+            type: 'number',
+            minimum: 0,
+            maximum: 0.999,
+            nullable: true
+        },
+        tq: {
+            type: 'number',
+            nullable: true
+        },
+        'prop-seg': {
+            type: 'integer',
+            minimum: 1,
+            maximum: 8,
+            nullable: true
+        },
+        'phase-seg1': {
+            type: 'integer',
+            minimum: 1,
+            maximum: 8,
+            nullable: true
+        },
+        'phase-seg2': {
+            type: 'integer',
+            minimum: 1,
+            maximum: 8,
+            nullable: true
+        },
+        sjw: {
+            type: 'integer',
+            minimum: 1,
+            maximum: 4,
+            nullable: true
+        },
+        dbitrate: {
+            type: 'integer',
+            minimum: 1,
+            maximum: 1000000,
+            nullable: true
+        },
+        'dsample-point': {
+            type: 'number',
+            minimum: 0,
+            maximum: 0.999,
+            nullable: true
+        },
+        dtq: {
+            type: 'number',
+            nullable: true
+        },
+        'dprop-seg': {
+            type: 'integer',
+            minimum: 1,
+            maximum: 8,
+            nullable: true
+        },
+        'dphase-seg1': {
+            type: 'integer',
+            minimum: 1,
+            maximum: 8,
+            nullable: true
+        },
+        'dphase-seg2': {
+            type: 'integer',
+            minimum: 1,
+            maximum: 8,
+            nullable: true
+        },
+        dsjw: {
+            type: 'integer',
+            minimum: 1,
+            maximum: 4,
+            nullable: true
+        },
+        loopback: {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'listen-only': {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'triple-sampling': {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'one-shot': {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'berr-reporting': {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        fd: {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'fd-non-iso': {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'presume-ack': {
+            type: 'string',
+            enum: Object.values(attribute_values_1.OnOffToggle),
+            nullable: true
+        },
+        'restart-ms': {
+            type: 'integer',
+            minimum: 0,
+            nullable: true
+        },
+        restart: {
+            type: 'boolean',
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=can.schema.js.map

package/lib/commands/link/virtual-link-types/can.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"can.schema.js","sourceRoot":"","sources":["../../../../src/commands/link/virtual-link-types/can.schema.ts"],"names":[],"mappings":";;;AAGA,iFAAyE;AAE5D,QAAA,oBAAoB,GAAuC;IACtE,IAAI,EAAkB,QAAQ;IAC9B,QAAQ,EAAc,EAAE;IACxB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAY;QACpB,OAAO,EAAY;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,OAAO;YACjB,QAAQ,EAAE,IAAI;SACf;QACD,cAAc,EAAK;YACjB,IAAI,EAAM,QAAQ;YAClB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,KAAK;YACf,QAAQ,EAAE,IAAI;SACf;QACD,EAAE,EAAiB;YACjB,IAAI,EAAM,QAAQ;YAClB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAS;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,YAAY,EAAO;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,YAAY,EAAO;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAgB;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAW;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,OAAO;YACjB,QAAQ,EAAE,IAAI;SACf;QACD,eAAe,EAAI;YACjB,IAAI,EAAM,QAAQ;YAClB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,KAAK;YACf,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAgB;YACjB,IAAI,EAAM,QAAQ;YAClB,QAAQ,EAAE,IAAI;SACf;QACD,WAAW,EAAQ;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,aAAa,EAAM;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,aAAa,EAAM;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAe;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,QAAQ,EAAW;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,aAAa,EAAM;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,iBAAiB,EAAE;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAS;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAG;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,EAAE,EAAiB;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,YAAY,EAAO;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,aAAa,EAAM;YACjB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,8BAAW,CAAkB;YACrD,QAAQ,EAAE,IAAI;SACf;QACD,YAAY,EAAO;YACjB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,QAAQ,EAAE,IAAI;SACf;QACD,OAAO,EAAY;YACjB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}

package/lib/commands/link/virtual-link-types/erspan-ip6erspan.interfaces.d.ts

@@ -0,0 +1,58 @@
+import { ErspanDirections } from '../../link.constants';
+/**
+ * Add link erspan & IP6 erspan type arguments.
+ * @category Interfaces
+ */
+export interface AddLinkErspanIp6erspanTypeArgs {
+    /** Specifies the remote address of the tunnel. */
+    remote: string;
+    /**
+     * Specifies the fixed local address for tunneled packets.
+     * It must be an address on another interface on this host.
+     */
+    local: string;
+    /**
+     * Enable sequence numbering of ERSPAN packets.
+     * This can be useful for detecting packet loss.
+     */
+    seq: true;
+    /** A 32-bit key to identify the GRE tunnel. */
+    key: number;
+    /**
+     * TODO: Add an enum for validator?
+     *
+     * Specifies the ERSPAN version number.
+     * `version` indicates the ERSPAN version to be created:
+     *
+     * 0 for version 0 type I,
+     * 1 for version 1 (type II)
+     * or 2 for version 2 (type III).
+     */
+    erspan_ver: number;
+    /**
+     * Specifies the ERSPAN v1 index field.
+     * IDX indicates a 20 bit index/port number associated with the ERSPAN
+     * traffic's source port and direction.
+     */
+    erspan?: number;
+    /** Specifies the ERSPAN v2 mirrored traffic's direction.
+     */
+    erspan_dir?: ErspanDirections;
+    /**
+     * A unique identifier of an ERSPAN v2 engine within a system.
+     * `hwid` is a 6-bit value for users to configure.
+     */
+    erspan_hwid?: number;
+    /** Specifies whether to allow remote endpoint to have an address configured on local host. */
+    'allow-localremote'?: boolean;
+    /** @see {@link['allow-localremote']} */
+    'noallow-localremote'?: boolean;
+    /**
+     * Make this tunnel externally controlled (or not, which is the default).
+     *
+     * In the kernel, this is referred to as collect metadata mode.
+     * This flag is mutually exclusive with the {@link remote},  {@link local},  {@link erspan_ver},
+     * {@link erspan},  {@link erspan_dir} and  {@link erspan_hwid} options.
+     */
+    external?: true;
+}

package/lib/commands/link/virtual-link-types/erspan-ip6erspan.interfaces.js

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

package/lib/commands/link/virtual-link-types/erspan-ip6erspan.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"erspan-ip6erspan.interfaces.js","sourceRoot":"","sources":["../../../../src/commands/link/virtual-link-types/erspan-ip6erspan.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/link/virtual-link-types/erspan-ip6erspan.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { AddLinkErspanIp6erspanTypeArgs } from './erspan-ip6erspan.interfaces';
+export declare const AddLinkErspanIp6ErspanArgsSchema: JSONSchemaType<AddLinkErspanIp6erspanTypeArgs>;

package/lib/commands/link/virtual-link-types/erspan-ip6erspan.schema.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddLinkErspanIp6ErspanArgsSchema = void 0;
+const link_constants_1 = require("../../link.constants");
+exports.AddLinkErspanIp6ErspanArgsSchema = {
+    type: 'object',
+    required: ['remote', 'local', 'seq', 'key', 'erspan_ver'],
+    additionalProperties: false,
+    properties: {
+        remote: {
+            type: 'string',
+            format: 'ip'
+        },
+        local: {
+            type: 'string',
+            format: 'ip'
+        },
+        seq: {
+            type: 'boolean',
+            enum: [true]
+        },
+        key: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 4294967295
+        },
+        erspan_ver: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 2
+        },
+        erspan: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 1048576,
+            nullable: true
+        },
+        erspan_dir: {
+            type: 'string',
+            enum: Object.values(link_constants_1.ErspanDirections),
+            nullable: true
+        },
+        erspan_hwid: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 63,
+            nullable: true
+        },
+        'allow-localremote': {
+            type: 'boolean',
+            nullable: true
+        },
+        'noallow-localremote': {
+            type: 'boolean',
+            nullable: true
+        },
+        external: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=erspan-ip6erspan.schema.js.map

package/lib/commands/link/virtual-link-types/erspan-ip6erspan.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"erspan-ip6erspan.schema.js","sourceRoot":"","sources":["../../../../src/commands/link/virtual-link-types/erspan-ip6erspan.schema.ts"],"names":[],"mappings":";;;AAEA,yDAAsE;AAGzD,QAAA,gCAAgC,GAAmD;IAC9F,IAAI,EAAkB,QAAQ;IAC9B,QAAQ,EAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC;IACrE,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAY;QACpB,MAAM,EAAiB;YACrB,IAAI,EAAI,QAAQ;YAChB,MAAM,EAAE,IAAI;SACb;QACD,KAAK,EAAkB;YACrB,IAAI,EAAI,QAAQ;YAChB,MAAM,EAAE,IAAI;SACb;QACD,GAAG,EAAoB;YACrB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,CAAC,IAAI,CAAC;SACb;QACD,GAAG,EAAoB;YACrB,IAAI,EAAK,SAAS;YAClB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,UAAU;SACpB;QACD,UAAU,EAAa;YACrB,IAAI,EAAK,SAAS;YAClB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACX;QACD,MAAM,EAAiB;YACrB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,OAAO;YACjB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAa;YACrB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,iCAAgB,CAAuB;YAC/D,QAAQ,EAAE,IAAI;SACf;QACD,WAAW,EAAY;YACrB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,EAAE;YACZ,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,QAAQ,EAAe;YACrB,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}

package/lib/commands/link/virtual-link-types/geneve.interfaces.d.ts

@@ -0,0 +1,54 @@
+import { DontFragmentFlagValues } from '../../link.constants';
+/**
+ * Add link geneve type arguments.
+ * @category Interfaces
+ */
+export interface AddLinkGeneveTypeArgs {
+    /** Specifies the Virtual Network Identifier to use. */
+    id: number;
+    /** Specifies the unicast destination IP address to use in outgoing packets. */
+    remote: string;
+    /**
+     * Specifies the TTL value to use in outgoing packets.
+     * "0" or "auto" means use whatever default value, "inherit" means inherit
+     * the inner protocol's ttl.
+     *
+     * Default option is "0".
+     */
+    ttl?: number | string;
+    /** Specifies the TOS value to use in outgoing packets. */
+    tos?: number;
+    /**
+     * Specifies the usage of the Don't Fragment flag (DF) bit in outgoing packets with IPv4 headers.
+     *
+     * The value inherit causes the bit to be copied from the original IP header.
+     * The values unset and set cause the bit to be always unset or always set, respectively.
+     *
+     * By default, the bit is not set.
+     */
+    df?: DontFragmentFlagValues;
+    /** Specifies the flow label to use in outgoing packets. */
+    flowlabel?: number;
+    /** Select a destination port other than the default of 6081. */
+    dstport?: number;
+    /**
+     * Make this tunnel externally controlled (or not, which is the default).
+     * This flag is mutually exclusive with the {@link id}, {@link remote}, {@link ttl}, {@link tos} and
+     * {@link flowlabel} options.
+     */
+    external?: boolean;
+    /** @see {@link external} */
+    noexternal?: boolean;
+    /** Specifies if UDP checksum is calculated for transmitted packets over IPv4. */
+    udpcsum?: boolean;
+    /** @see {@link udpcsum} */
+    noudpcsum?: boolean;
+    /** Skip UDP checksum calculation for transmitted packets over IPv6. */
+    udp6zerocsumtx?: boolean;
+    /** @see {@link udp6zerocsumtx} */
+    noudp6zerocsumtx?: boolean;
+    /** Allow incoming UDP packets over IPv6 with zero checksum field. */
+    udp6zerocsumrx?: boolean;
+    /** @see {@link udp6zerocsumrx} */
+    noudp6zerocsumrx?: boolean;
+}

package/lib/commands/link/virtual-link-types/geneve.interfaces.js

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

package/lib/commands/link/virtual-link-types/geneve.interfaces.js.map

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

package/lib/commands/link/virtual-link-types/geneve.schema.d.ts

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

package/lib/commands/link/virtual-link-types/geneve.schema.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddLinkGeneveArgsSchema = void 0;
+const link_constants_1 = require("../../link.constants");
+exports.AddLinkGeneveArgsSchema = {
+    type: 'object',
+    required: ['id', 'remote'],
+    additionalProperties: false,
+    properties: {
+        id: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 16777215
+        },
+        remote: {
+            type: 'string',
+            format: 'ip'
+        },
+        ttl: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: Object.values(link_constants_1.TtlSpecialValues),
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    maximum: 255,
+                    nullable: true
+                }
+            ]
+        },
+        tos: {
+            type: 'integer',
+            nullable: true,
+            minimum: 0,
+            maximum: 63
+        },
+        df: {
+            type: 'string',
+            enum: Object.values(link_constants_1.DontFragmentFlagValues),
+            nullable: true
+        },
+        flowlabel: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 1048575,
+            nullable: true
+        },
+        dstport: {
+            type: 'integer',
+            nullable: true,
+            minimum: 1,
+            maximum: 65535
+        },
+        external: {
+            type: 'boolean',
+            nullable: true
+        },
+        noexternal: {
+            type: 'boolean',
+            nullable: true
+        },
+        udpcsum: {
+            type: 'boolean',
+            nullable: true
+        },
+        noudpcsum: {
+            type: 'boolean',
+            nullable: true
+        },
+        udp6zerocsumtx: {
+            type: 'boolean',
+            nullable: true
+        },
+        noudp6zerocsumtx: {
+            type: 'boolean',
+            nullable: true
+        },
+        udp6zerocsumrx: {
+            type: 'boolean',
+            nullable: true
+        },
+        noudp6zerocsumrx: {
+            type: 'boolean',
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=geneve.schema.js.map

package/lib/commands/link/virtual-link-types/geneve.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"geneve.schema.js","sourceRoot":"","sources":["../../../../src/commands/link/virtual-link-types/geneve.schema.ts"],"names":[],"mappings":";;;AAEA,yDAAgF;AAGnE,QAAA,uBAAuB,GAA0C;IAC5E,IAAI,EAAkB,QAAQ;IAC9B,QAAQ,EAAc,CAAC,IAAI,EAAE,QAAQ,CAAC;IACtC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAY;QACpB,EAAE,EAAgB;YAChB,IAAI,EAAK,SAAS;YAClB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,QAAQ;SAClB;QACD,MAAM,EAAY;YAChB,IAAI,EAAI,QAAQ;YAChB,MAAM,EAAE,IAAI;SACb;QACD,GAAG,EAAe;YAChB,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,iCAAgB,CAAuB;oBAC/D,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,EAAe;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,EAAE;SACb;QACD,EAAE,EAAgB;YAChB,IAAI,EAAM,QAAQ;YAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,uCAAsB,CAA6B;YAC3E,QAAQ,EAAE,IAAI;SACf;QACD,SAAS,EAAS;YAChB,IAAI,EAAM,SAAS;YACnB,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,OAAO;YACjB,QAAQ,EAAE,IAAI;SACf;QACD,OAAO,EAAW;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAG,CAAC;YACX,OAAO,EAAG,KAAK;SAChB;QACD,QAAQ,EAAU;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAQ;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,OAAO,EAAW;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,SAAS,EAAS;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,cAAc,EAAI;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,cAAc,EAAI;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAM,SAAS;YACnB,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC"}

package/lib/commands/link/virtual-link-types/gre-gretap.interfaces.d.ts

@@ -0,0 +1,106 @@
+import { SecondaryUdpEncapsulations } from '../../link.constants';
+/**
+ * Add link gre & gretap type arguments.
+ * @category Interfaces
+ */
+export interface AddLinkGreGretapTypeArgs {
+    /** Specifies the remote address of the tunnel. */
+    remote: string;
+    /**
+     * Specifies the fixed local address for tunneled packets.
+     * It must be an address on another interface on this host.
+     */
+    local: string;
+    /**
+     * Serialize packets.
+     *
+     * The {@link seq} flag enables sequencing of both incoming and outgoing packets.
+     * The {@link oseq} flag enables sequencing of outgoing packets.
+     * The {@link iseq} flag requires that all input packets are serialized.
+     */
+    seq?: boolean;
+    /** @see {@link seq} */
+    iseq?: boolean;
+    /** @see {@link seq} */
+    noiseq?: boolean;
+    /** @see {@link seq} */
+    oseq?: boolean;
+    /** @see {@link seq} */
+    nooseq?: boolean;
+    /**
+     * Use keyed GRE with key KEY.
+     *
+     * KEY is either a number or an IPv4 address-like dotted quad.
+     * The {@link key} parameter specifies the same key to use in both directions.
+     * The {@link ikey} and {@link okey} parameters specify different keys for input and output.
+     */
+    key?: number | string;
+    /** @see {@link key} */
+    nokey?: true;
+    /** @see {@link key} */
+    ikey?: number | string;
+    /** @see {@link key} */
+    noikey?: true;
+    /** @see {@link key} */
+    okey?: number | string;
+    /** @see {@link key} */
+    nookey?: true;
+    /**
+     * Generate/require checksums for tunneled packets.
+     *
+     * The {@link ocsum} flag calculates checksums for outgoing packets.
+     * The {@link icsum} flag requires that all input packets have the correct checksum.
+     * The {@link csum} flag is equivalent to the combination {@link icsum} {@link ocsum} .
+     */
+    csum?: boolean;
+    /** @see {@link csum} */
+    icsum?: boolean;
+    /** @see {@link csum} */
+    noicsum?: boolean;
+    /** @see {@link csum} */
+    ocsum?: boolean;
+    /** @see {@link csum} */
+    noocsum?: boolean;
+    /** Specifies the TTL value to use in outgoing packets. */
+    ttl?: number;
+    /** Specifies the TOS value to use in outgoing packets. */
+    tos?: number;
+    /**
+     * Enables/disables Path MTU Discovery on this tunnel. It is enabled by default.
+     * Note that a fixed {@link ttl} is incompatible with this option:
+     * tunneling with a fixed {@link ttl} always makes pmtu discovery.
+     */
+    pmtudisc?: boolean;
+    /** @see {@link pmtudisc} */
+    nopmtudisc?: boolean;
+    /**
+     * Enables/disables 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'?: boolean;
+    /** @see {@link['ignore-df']} */
+    'noignore-df'?: boolean;
+    /** Specifies the physical device to use for tunnel endpoint communication. */
+    dev?: string;
+    /** @see SecondaryUdpEncapsulations */
+    encap?: SecondaryUdpEncapsulations;
+    /** @see {@link AddLinkIpipSitTypeArgs['encap-sport'] } */
+    'encap-sport'?: number | 'auto';
+    /** TODO: No doc in man. */
+    'encap-dport'?: number;
+    /** Specifies if UDP checksums are enabled in the secondary encapsulation. */
+    'encap-csum'?: boolean;
+    /** @see {@link['encap-csum']} */
+    'noencap-csum'?: boolean;
+    /**
+     * Specifies if Remote Checksum Offload is enabled.
+     * This is only applicable for Generic UDP Encapsulation.
+     */
+    'encap-remcsum'?: boolean;
+    /** @see {@link['encap-remcsum']} */
+    'noencap-remcsum'?: boolean;
+    /** Make this tunnel externally controlled (e.g. `ip route encap`). */
+    external?: true;
+}

package/lib/commands/link/virtual-link-types/gre-gretap.interfaces.js

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

package/lib/commands/link/virtual-link-types/gre-gretap.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gre-gretap.interfaces.js","sourceRoot":"","sources":["../../../../src/commands/link/virtual-link-types/gre-gretap.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/link/virtual-link-types/gre-gretap.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { AddLinkGreGretapTypeArgs } from './gre-gretap.interfaces';
+export declare const AddGreGretapArgsSchema: JSONSchemaType<AddLinkGreGretapTypeArgs>;