iproutejs 2.3.0

package/lib/commands/link.constants.js

@@ -0,0 +1,366 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XdpOptionTypes = exports.BridgeSlavePortStates = exports.AddrGenMode = exports.SecureAssociationEncodings = exports.MacsecValidationModeOptions = exports.MldVersions = exports.IgmpVersions = exports.MultiCastRouterOptions = exports.HsrProtocols = exports.HsrVersions = exports.MacvlanMacvtapModes = exports.TtlSpecialValues = exports.ErspanDirections = exports.IpoIbModes = exports.IpipSipDeviceModes = exports.SecondaryUdpEncapsulations = exports.DontFragmentFlagValues = exports.VlanProtocols = exports.ExtendedLinkTypes = exports.LinkTypes = void 0;
+/**
+ * Link Types.
+ * @category Constants
+ */
+exports.LinkTypes = {
+    /** Ethernet Bridge device. */
+    Bridge: 'bridge',
+    /** Bonding device. */
+    Bond: 'bond',
+    /** Dummy network interface. */
+    Dummy: 'dummy',
+    /** High-availability Seamless Redundancy device. */
+    Hsr: 'hsr',
+    /** Intermediate Functional Block device. */
+    Ifb: 'ifb',
+    /** IP over Infiniband device. */
+    Ipoib: 'ipoib',
+    /** Virtual interface base on link layer address (MAC). */
+    Macvlan: 'macvlan',
+    /** Virtual interface based on link layer address (MAC) and TAP. */
+    Macvtap: 'macvtap',
+    /** Virtual Controller Area Network interface. */
+    Vcan: 'vcan',
+    /** Controller Area Network interface. */
+    Can: 'can',
+    /** Virtual Controller Area Network tunnel interface. */
+    Vxcan: 'vxcan',
+    /** Virtual ethernet interface. */
+    Veth: 'veth',
+    /** 802.1q tagged virtual LAN interface. */
+    Vlan: 'vlan',
+    /** Virtual eXtended LAN. */
+    Vxlan: 'vxlan',
+    /** Virtual tunnel interface IPv4|IPv6 over IPv6. */
+    Ip6tnl: 'ip6tnl',
+    /** Virtual tunnel interface IPv4 over IPv4. */
+    Ipip: 'ipip',
+    /** Virtual tunnel interface IPv6 over IPv4. */
+    Sit: 'sit',
+    /** Virtual tunnel interface GRE over IPv4. */
+    Gre: 'gre',
+    /** Virtual L2 tunnel interface GRE over IPv4. */
+    Gretap: 'gretap',
+    /** Encapsulated Remote SPAN over GRE and IPv4. */
+    Erspan: 'erspan',
+    /** Virtual tunnel interface GRE over IPv6. */
+    Ip6gre: 'ip6gre',
+    /** Virtual L2 tunnel interface GRE over IPv6. */
+    Ip6gretap: 'ip6gretap',
+    /** Encapsulated Remote SPAN over GRE and IPv6. */
+    Ip6erspan: 'ip6erspan',
+    /** Virtual tunnel interface. */
+    Vti: 'vti',
+    /** Netlink monitoring device. */
+    Nlmon: 'nlmon',
+    /** Interface for L3 (IPv6/IPv4) based VLANs. */
+    Ipvlan: 'ipvlan',
+    /** Interface for L3 (IPv6/IPv4) based VLANs and TAP. */
+    Ipvtap: 'ipvtap',
+    /** Interface for 6LoWPAN (IPv6) over IEEE 802.15.4 Bluetooth. */
+    Lowpan: 'lowpan',
+    /** GEneric NEtwork Virtualization Encapsulation. */
+    Geneve: 'geneve',
+    /** Bare UDP L3 encapsulation support. */
+    Bareudp: 'bareudp',
+    /** Interface for IEEE 802.1AE MAC Security (MAC‐sec). */
+    Macsec: 'macsec',
+    /** Interface for L3 VRF domains. */
+    Vrf: 'vrf',
+    /** Interface for netdev API tests. */
+    Netdevsim: 'netdevsim',
+    /** Qualcomm rmnet device. */
+    Rmnet: 'rmnet',
+    /** Virtual xfrm interface. */
+    Xfrm: 'xfrm'
+};
+/**
+ * Extended Link Types.
+ * @category Constants
+ */
+exports.ExtendedLinkTypes = Object.assign(Object.assign({}, exports.LinkTypes), { 
+    /** Bridge slave interface. */
+    BridgeSlave: 'bridge_slave', 
+    /** Bond slave interface. */
+    BondSlave: 'bond_slave' });
+/**
+ * VLAN protocols.
+ * @category Constants
+ */
+var VlanProtocols;
+(function (VlanProtocols) {
+    VlanProtocols["802.1Q"] = "802.1Q";
+    VlanProtocols["802.1ad"] = "802.1ad";
+})(VlanProtocols || (exports.VlanProtocols = VlanProtocols = {}));
+/**
+ * Dont fragment flag values.
+ * @category Constants
+ */
+var DontFragmentFlagValues;
+(function (DontFragmentFlagValues) {
+    /** Causes the bit to be copied from the original IP header. */
+    DontFragmentFlagValues["Inherit"] = "inherit";
+    /** Cause the bit to be always unset. */
+    DontFragmentFlagValues["Unset"] = "unset";
+    /** Cause the bit to be always set. */
+    DontFragmentFlagValues["Set"] = "set";
+})(DontFragmentFlagValues || (exports.DontFragmentFlagValues = DontFragmentFlagValues = {}));
+/**
+ * Specifies type of secondary UDP encapsulation.
+ * @category Constants
+ */
+var SecondaryUdpEncapsulations;
+(function (SecondaryUdpEncapsulations) {
+    /** Indicates Foo-Over-UDP. */
+    SecondaryUdpEncapsulations["Fou"] = "fou";
+    /** Indicates Generic UDP Encapsulation. */
+    SecondaryUdpEncapsulations["Gue"] = "gue";
+    SecondaryUdpEncapsulations["None"] = "none";
+})(SecondaryUdpEncapsulations || (exports.SecondaryUdpEncapsulations = SecondaryUdpEncapsulations = {}));
+/**
+ * Specifies mode in which device should run.
+ * @category Constants
+ */
+var IpipSipDeviceModes;
+(function (IpipSipDeviceModes) {
+    /** Indicates IPv6-Over-IPv4 */
+    IpipSipDeviceModes["Ip6ip"] = "ip6ip";
+    /** Indicates "IPv4-Over-IPv4". */
+    IpipSipDeviceModes["Ipip"] = "ipip";
+    /** Indicates MPLS-Over-IPv4. */
+    IpipSipDeviceModes["Mplsip"] = "mplsip";
+    /** Indicates IPv6, IPv4 or MPLS Over IPv4. */
+    IpipSipDeviceModes["Any"] = "any";
+})(IpipSipDeviceModes || (exports.IpipSipDeviceModes = IpipSipDeviceModes = {}));
+/**
+ * Specifies whether the link should be in datagram mode or connected mode.
+ * @category Constants
+ */
+var IpoIbModes;
+(function (IpoIbModes) {
+    /**
+     * This is the default mode. In datagram mode, packets are sent independently of each other,
+     * without a connection between sender and receiver.
+     * */
+    IpoIbModes["Datagram"] = "datagram";
+    /**
+     * In connected mode, a reliable connection is established before data is exchanged, which can
+     * offer higher throughput and lower latency in some situations. However, connected mode uses more
+     * resources and may not be supported by all InfiniBand hardware.
+     */
+    IpoIbModes["Connected"] = "connected";
+})(IpoIbModes || (exports.IpoIbModes = IpoIbModes = {}));
+/**
+ * Specifies the ERSPAN v2 mirrored traffic's direction.
+ * @category Constants
+ */
+var ErspanDirections;
+(function (ErspanDirections) {
+    ErspanDirections["Ingress"] = "ingress";
+    ErspanDirections["Egress"] = "egress";
+})(ErspanDirections || (exports.ErspanDirections = ErspanDirections = {}));
+/**
+ * TTL special values.
+ * @category Constants
+ */
+var TtlSpecialValues;
+(function (TtlSpecialValues) {
+    TtlSpecialValues["Auto"] = "auto";
+    TtlSpecialValues["Inherit"] = "inherit";
+})(TtlSpecialValues || (exports.TtlSpecialValues = TtlSpecialValues = {}));
+/**
+ * Modes for macvlan and macvtap interfaces.
+ * @category Constants
+ */
+var MacvlanMacvtapModes;
+(function (MacvlanMacvtapModes) {
+    /**
+     * Do not allow communication between macvlan instances on the same physical interface,
+     * even if the external switch supports hairpin mode.
+     */
+    MacvlanMacvtapModes["Private"] = "private";
+    /**
+     * Virtual Ethernet Port Aggregator mode.
+     *
+     * Data from one macvlan instance to the other on the same physical inter face is
+     * transmitted over the physical interface.
+     *
+     * Either the attached switch needs to support hairpin mode, or there must be a
+     * TCP/IP router forwarding the packets in order to allow communication.
+     *
+     * This is the default mode.
+     */
+    MacvlanMacvtapModes["Vepa"] = "vepa";
+    /**
+     * In bridge mode, all endpoints are directly connected to each other, communication
+     * is not redirected through the physical interface's peer.
+     */
+    MacvlanMacvtapModes["Bridge"] = "bridge";
+    /**
+     * This mode gives more power to a single endpoint, usually in `macvtap` mode.
+     *
+     * It is not allowed for more than one endpoint on the same physical interface.
+     *
+     * All traffic will be forwarded to this endpoint, allowing virtio guests to change
+     * MAC address or set promiscuous mode in order to bridge the interface or create
+     * vlan interfaces on top of it.
+     *
+     * By default, this mode forces the underlying interface into promiscuous mode.
+     *
+     * Passing the `nopromisc` flag prevents this, so the promisc flag may be controlled
+     * using standard tools.
+     *
+     * @see {@link PassthruNopromisc}
+     */
+    MacvlanMacvtapModes["Passthru"] = "passthru";
+    /**  @see {@link Passthru} */
+    MacvlanMacvtapModes["PassthruNopromisc"] = "passthru nopromisc";
+    /**
+     * Allows one to set a list of allowed mac address, which is used to match against
+     * source mac address from received frames on underlying interface.
+     *
+     * This allows creating mac based VLAN associations, instead of standard port or
+     * tag based.
+     *
+     * The feature is useful to deploy 802.1x mac based behavior, where drivers of underlying
+     * interfaces doesn't allow that.
+     *
+     * By default, packets are also considered (duplicated) for destination-based MACVLAN.
+     *
+     * Passing the `nodst` flag stops matching packets from also going through the destination-based flow.
+     *
+     * @see {@link SourceNodst}
+     */
+    MacvlanMacvtapModes["Source"] = "source";
+    /** @see {@link Source} */
+    MacvlanMacvtapModes["SourceNodst"] = "source nodst";
+})(MacvlanMacvtapModes || (exports.MacvlanMacvtapModes = MacvlanMacvtapModes = {}));
+/**
+ * Protocol version of the interface.
+ * Defaults to {@link HsrVersions.v2010}
+ *
+ * @category Constants
+ */
+var HsrVersions;
+(function (HsrVersions) {
+    HsrVersions[HsrVersions["v2010"] = 0] = "v2010";
+    HsrVersions[HsrVersions["v2012"] = 1] = "v2012";
+})(HsrVersions || (exports.HsrVersions = HsrVersions = {}));
+/**
+ * Protocol of the interface.
+ * Defaults to {@link HsrProtocols.HSR}
+ *
+ * @category Constants
+ */
+var HsrProtocols;
+(function (HsrProtocols) {
+    /** High-availability Seamless Redundancy. */
+    HsrProtocols[HsrProtocols["HSR"] = 0] = "HSR";
+    /** Parallel Redundancy Protocol. */
+    HsrProtocols[HsrProtocols["PRP"] = 1] = "PRP";
+})(HsrProtocols || (exports.HsrProtocols = HsrProtocols = {}));
+/**
+ * Multicast router options.
+ * @category Constants
+ */
+var MultiCastRouterOptions;
+(function (MultiCastRouterOptions) {
+    /**
+     * The bridge does not act as a multicast router. It will not forward any IP multicast packets
+     * between different interfaces.
+     *
+     * It will forward multicast packets only to ports where multicast listeners are detected.
+     */
+    MultiCastRouterOptions[MultiCastRouterOptions["Disabled"] = 0] = "Disabled";
+    /**
+     * The bridge acts as a multicast router and will forward all IP multicast packets.
+     * This is the default setting.
+     */
+    MultiCastRouterOptions[MultiCastRouterOptions["Automatic"] = 1] = "Automatic";
+    /**
+     *  The bridge uses the multicast router discovery protocol to learn whether it should
+     *  forward multicast packets as a multicast router.
+     */
+    MultiCastRouterOptions[MultiCastRouterOptions["PermanentlyEnabled"] = 2] = "PermanentlyEnabled";
+})(MultiCastRouterOptions || (exports.MultiCastRouterOptions = MultiCastRouterOptions = {}));
+/**
+ * IGMP protocol versions.
+ * @category Constants
+ */
+var IgmpVersions;
+(function (IgmpVersions) {
+    IgmpVersions[IgmpVersions["v2"] = 2] = "v2";
+    IgmpVersions[IgmpVersions["v3"] = 3] = "v3";
+})(IgmpVersions || (exports.IgmpVersions = IgmpVersions = {}));
+/**
+ * Mld versions.
+ * @category Constants
+ */
+var MldVersions;
+(function (MldVersions) {
+    MldVersions[MldVersions["v1"] = 1] = "v1";
+    MldVersions[MldVersions["v2"] = 2] = "v2";
+})(MldVersions || (exports.MldVersions = MldVersions = {}));
+/**
+ * Macsec validation mode options.
+ * @category Constants
+ */
+var MacsecValidationModeOptions;
+(function (MacsecValidationModeOptions) {
+    MacsecValidationModeOptions["Strict"] = "strict";
+    MacsecValidationModeOptions["Check"] = "check";
+    MacsecValidationModeOptions["Disabled"] = "disabled";
+})(MacsecValidationModeOptions || (exports.MacsecValidationModeOptions = MacsecValidationModeOptions = {}));
+/**
+ * Secure association encodings.
+ * @category Constants
+ */
+var SecureAssociationEncodings;
+(function (SecureAssociationEncodings) {
+    SecureAssociationEncodings[SecureAssociationEncodings["Implicit"] = 0] = "Implicit";
+    SecureAssociationEncodings[SecureAssociationEncodings["Explicit"] = 1] = "Explicit";
+})(SecureAssociationEncodings || (exports.SecureAssociationEncodings = SecureAssociationEncodings = {}));
+/**
+ * Is used to configure IPv6 address generation mode for a given interface.
+ * @category Constants
+ */
+var AddrGenMode;
+(function (AddrGenMode) {
+    /** Use a Modified EUI-64 format interface identifier. */
+    AddrGenMode["Eui64"] = "eui64";
+    /** Disable automatic address generation. */
+    AddrGenMode["None"] = "none";
+    /**
+     * Generate the interface identifier based on a preset
+     * `/proc/sys/net/ipv6/conf/{default,DEVICE}/stable_secret`.
+     */
+    AddrGenMode["StableSecret"] = "stable_secret";
+    /** Like {@link StableSecret}, but auto-generate a new random secret if none is set. */
+    AddrGenMode["Random"] = "random";
+})(AddrGenMode || (exports.AddrGenMode = AddrGenMode = {}));
+/**
+ * Bridge slave port states.
+ * @category Constants
+ */
+var BridgeSlavePortStates;
+(function (BridgeSlavePortStates) {
+    BridgeSlavePortStates[BridgeSlavePortStates["Disabled"] = 0] = "Disabled";
+    BridgeSlavePortStates[BridgeSlavePortStates["Listening"] = 1] = "Listening";
+    BridgeSlavePortStates[BridgeSlavePortStates["Learning"] = 2] = "Learning";
+    BridgeSlavePortStates[BridgeSlavePortStates["Forwarding"] = 3] = "Forwarding";
+    BridgeSlavePortStates[BridgeSlavePortStates["Blocking"] = 4] = "Blocking";
+})(BridgeSlavePortStates || (exports.BridgeSlavePortStates = BridgeSlavePortStates = {}));
+/**
+ * Xdp option types.
+ * @category Constants
+ */
+var XdpOptionTypes;
+(function (XdpOptionTypes) {
+    XdpOptionTypes["Off"] = "off";
+    XdpOptionTypes["Object"] = "object";
+    XdpOptionTypes["Pinned"] = "pinned";
+})(XdpOptionTypes || (exports.XdpOptionTypes = XdpOptionTypes = {}));
+//# sourceMappingURL=link.constants.js.map

package/lib/commands/link.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.constants.js","sourceRoot":"","sources":["../../src/commands/link.constants.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,8BAA8B;IAC9B,MAAM,EAAE,QAAQ;IAChB,sBAAsB;IACtB,IAAI,EAAE,MAAM;IACZ,+BAA+B;IAC/B,KAAK,EAAE,OAAO;IACd,oDAAoD;IACpD,GAAG,EAAE,KAAK;IACV,4CAA4C;IAC5C,GAAG,EAAE,KAAK;IACV,iCAAiC;IACjC,KAAK,EAAE,OAAO;IACd,0DAA0D;IAC1D,OAAO,EAAE,SAAS;IAClB,mEAAmE;IACnE,OAAO,EAAE,SAAS;IAClB,iDAAiD;IACjD,IAAI,EAAE,MAAM;IACZ,yCAAyC;IACzC,GAAG,EAAE,KAAK;IACV,wDAAwD;IACxD,KAAK,EAAE,OAAO;IACd,kCAAkC;IAClC,IAAI,EAAE,MAAM;IACZ,2CAA2C;IAC3C,IAAI,EAAE,MAAM;IACZ,4BAA4B;IAC5B,KAAK,EAAE,OAAO;IACd,oDAAoD;IACpD,MAAM,EAAE,QAAQ;IAChB,+CAA+C;IAC/C,IAAI,EAAE,MAAM;IACZ,+CAA+C;IAC/C,GAAG,EAAE,KAAK;IACV,8CAA8C;IAC9C,GAAG,EAAE,KAAK;IACV,iDAAiD;IACjD,MAAM,EAAE,QAAQ;IAChB,kDAAkD;IAClD,MAAM,EAAE,QAAQ;IAChB,8CAA8C;IAC9C,MAAM,EAAE,QAAQ;IAChB,iDAAiD;IACjD,SAAS,EAAE,WAAW;IACtB,kDAAkD;IAClD,SAAS,EAAE,WAAW;IACtB,gCAAgC;IAChC,GAAG,EAAE,KAAK;IACV,iCAAiC;IACjC,KAAK,EAAE,OAAO;IACd,gDAAgD;IAChD,MAAM,EAAE,QAAQ;IAChB,wDAAwD;IACxD,MAAM,EAAE,QAAQ;IAChB,iEAAiE;IACjE,MAAM,EAAE,QAAQ;IAChB,oDAAoD;IACpD,MAAM,EAAE,QAAQ;IAChB,yCAAyC;IACzC,OAAO,EAAE,SAAS;IAClB,yDAAyD;IACzD,MAAM,EAAE,QAAQ;IAChB,oCAAoC;IACpC,GAAG,EAAE,KAAK;IACV,sCAAsC;IACtC,SAAS,EAAE,WAAW;IACtB,6BAA6B;IAC7B,KAAK,EAAE,OAAO;IACd,8BAA8B;IAC9B,IAAI,EAAE,MAAM;CACJ,CAAC;AASX;;;GAGG;AACU,QAAA,iBAAiB,GAAG,gCAC5B,iBAAS;IAEZ,8BAA8B;IAC9B,WAAW,EAAE,cAAc;IAC3B,4BAA4B;IAC5B,SAAS,EAAE,YAAY,GACf,CAAC;AASX;;;GAGG;AACH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kCAAoB,CAAA;IACpB,oCAAqB,CAAA;AACvB,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED;;;GAGG;AACH,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,+DAA+D;IAC/D,6CAAmB,CAAA;IACnB,wCAAwC;IACxC,yCAAiB,CAAA;IACjB,sCAAsC;IACtC,qCAAe,CAAA;AACjB,CAAC,EAPW,sBAAsB,sCAAtB,sBAAsB,QAOjC;AAED;;;GAGG;AACH,IAAY,0BAMX;AAND,WAAY,0BAA0B;IACpC,8BAA8B;IAC9B,yCAAY,CAAA;IACZ,2CAA2C;IAC3C,yCAAY,CAAA;IACZ,2CAAa,CAAA;AACf,CAAC,EANW,0BAA0B,0CAA1B,0BAA0B,QAMrC;AAED;;;GAGG;AACH,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,+BAA+B;IAC/B,qCAAgB,CAAA;IAChB,kCAAkC;IAClC,mCAAe,CAAA;IACf,gCAAgC;IAChC,uCAAiB,CAAA;IACjB,8CAA8C;IAC9C,iCAAc,CAAA;AAChB,CAAC,EATW,kBAAkB,kCAAlB,kBAAkB,QAS7B;AAED;;;GAGG;AACH,IAAY,UAYX;AAZD,WAAY,UAAU;IACpB;;;SAGK;IACL,mCAAsB,CAAA;IACtB;;;;OAIG;IACH,qCAAuB,CAAA;AACzB,CAAC,EAZW,UAAU,0BAAV,UAAU,QAYrB;AAED;;;GAGG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAkB,CAAA;AACpB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED;;;GAGG;AACH,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iCAAgB,CAAA;IAChB,uCAAmB,CAAA;AACrB,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B;AAED;;;GAGG;AACH,IAAY,mBA6DX;AA7DD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,0CAA6B,CAAA;IAC7B;;;;;;;;;;OAUG;IACH,oCAA0B,CAAA;IAC1B;;;OAGG;IACH,wCAA4B,CAAA;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,4CAA8B,CAAA;IAC9B,6BAA6B;IAC7B,+DAAwC,CAAA;IACxC;;;;;;;;;;;;;;;OAeG;IACH,wCAA4B,CAAA;IAC5B,0BAA0B;IAC1B,mDAAkC,CAAA;AACpC,CAAC,EA7DW,mBAAmB,mCAAnB,mBAAmB,QA6D9B;AAED;;;;;GAKG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,+CAAS,CAAA;IACT,+CAAS,CAAA;AACX,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAED;;;;;GAKG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,6CAA6C;IAC7C,6CAAO,CAAA;IACP,oCAAoC;IACpC,6CAAO,CAAA;AACT,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED;;;GAGG;AACH,IAAY,sBAkBX;AAlBD,WAAY,sBAAsB;IAChC;;;;;OAKG;IACH,2EAAsB,CAAA;IACtB;;;OAGG;IACH,6EAAsB,CAAA;IACtB;;;OAGG;IACH,+FAAsB,CAAA;AACxB,CAAC,EAlBW,sBAAsB,sCAAtB,sBAAsB,QAkBjC;AAED;;;GAGG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,2CAAM,CAAA;IACN,2CAAM,CAAA;AACR,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAED;;;GAGG;AACH,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,yCAAM,CAAA;IACN,yCAAM,CAAA;AACR,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAED;;;GAGG;AACH,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACrC,gDAAmB,CAAA;IACnB,8CAAkB,CAAA;IAClB,oDAAqB,CAAA;AACvB,CAAC,EAJW,2BAA2B,2CAA3B,2BAA2B,QAItC;AAED;;;GAGG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,mFAAY,CAAA;IACZ,mFAAY,CAAA;AACd,CAAC,EAHW,0BAA0B,0CAA1B,0BAA0B,QAGrC;AAED;;;GAGG;AACH,IAAY,WAYX;AAZD,WAAY,WAAW;IACrB,yDAAyD;IACzD,8BAAsB,CAAA;IACtB,4CAA4C;IAC5C,4BAAqB,CAAA;IACrB;;;OAGG;IACH,6CAA8B,CAAA;IAC9B,uFAAuF;IACvF,gCAAuB,CAAA;AACzB,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB;AAED;;;GAGG;AACH,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,yEAAc,CAAA;IACd,2EAAc,CAAA;IACd,yEAAc,CAAA;IACd,6EAAc,CAAA;IACd,yEAAc,CAAA;AAChB,CAAC,EANW,qBAAqB,qCAArB,qBAAqB,QAMhC;AAED;;;GAGG;AACH,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,6BAAc,CAAA;IACd,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB"}

package/lib/commands/link.d.ts

@@ -0,0 +1,113 @@
+import Command from '../common/classes/command';
+import { GlobalOptions } from '../common/interfaces/common';
+import { LinkAddOptions } from './link/add.interfaces';
+import { LinkDeleteOptions } from './link/delete.interfaces';
+import { LinkSetOptions } from './link/set.interfaces';
+import { LinkShowOptions, LinkInfo } from './link/show.interfaces';
+/**
+ * Adds a virtual link.
+ *
+ * @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 { link } from 'iproutejs';
+ * ```
+ *
+ * Add a link
+ * ```
+ * await link.add({
+ *   link:    'lo',
+ *   name:    'dummy100',
+ *   address: '00:11:22:33:44:55',
+ *   mtu:     1500,
+ *   type:    VirtualLinkTypes.Dummy
+ * });
+ * ```
+ */
+export declare function add(options: LinkAddOptions, globalOptions?: GlobalOptions): Promise<Command<LinkAddOptions>>;
+/**
+ * Deletes a virtual link.
+ *
+ * @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 { link } from 'iproutejs';
+ * ```
+ *
+ * Delete a link
+ * ```
+ * await link.del({
+ *   dev: 'eth0.1@eth0'
+ * });
+ * ```
+ */
+export declare function del(options: LinkDeleteOptions, globalOptions?: GlobalOptions): Promise<Command<LinkDeleteOptions>>;
+/**
+ * Display device attributes.
+ *
+ * @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 { link } from 'iproutejs';
+ * ```
+ *
+ * Show link information about the `eth0` device
+ * ```
+ * const links = await link.show({
+ *   dev: 'eth0'
+ * });
+ * ```
+ *
+ * Shortcut to show all links
+ * ```
+ * const links = await link.show();
+ * const links = await link.show({});
+ * ```
+ */
+export declare function show(options?: LinkShowOptions, globalOptions?: GlobalOptions): Promise<Command<LinkShowOptions> | LinkInfo[]>;
+/**
+ * Change device attributes.
+ *
+ * Warning: If multiple parameter changes are requested, `ip` aborts immediately after any
+ * of the changes have failed.
+ *
+ * This is the only case when `ip` can move the system to an
+ * unpredictable state. The solution is to avoid changing several parameters with one `ip link set` call.
+ * The modifier `change` is equivalent to `set`.
+ *
+ * @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 set(options: LinkSetOptions, globalOptions?: GlobalOptions): Promise<Command<LinkSetOptions>>;
+declare const _default: {
+    add: typeof add;
+    del: typeof del;
+    show: typeof show;
+    set: typeof set;
+    change: typeof set;
+};
+export default _default;

package/lib/commands/link.js

@@ -0,0 +1,159 @@
+"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.set = exports.show = exports.del = exports.add = void 0;
+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("./link/add.schema");
+const delete_schema_1 = require("./link/delete.schema");
+const set_schema_1 = require("./link/set.schema");
+const show_schema_1 = require("./link/show.schema");
+/**
+ * Adds a virtual link.
+ *
+ * @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 { link } from 'iproutejs';
+ * ```
+ *
+ * Add a link
+ * ```
+ * await link.add({
+ *   link:    'lo',
+ *   name:    'dummy100',
+ *   address: '00:11:22:33:44:55',
+ *   mtu:     1500,
+ *   type:    VirtualLinkTypes.Dummy
+ * });
+ * ```
+ */
+function add(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'link', 'add'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.LinkAdd, add_schema_1.LinkAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.add = add;
+/**
+ * Deletes a virtual link.
+ *
+ * @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 { link } from 'iproutejs';
+ * ```
+ *
+ * Delete a link
+ * ```
+ * await link.del({
+ *   dev: 'eth0.1@eth0'
+ * });
+ * ```
+ */
+function del(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'link', 'delete'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.LinkDelete, delete_schema_1.LinkDeleteSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.del = del;
+/**
+ * Display device attributes.
+ *
+ * @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 { link } from 'iproutejs';
+ * ```
+ *
+ * Show link information about the `eth0` device
+ * ```
+ * const links = await link.show({
+ *   dev: 'eth0'
+ * });
+ * ```
+ *
+ * Shortcut to show all links
+ * ```
+ * const links = await link.show();
+ * const links = await link.show({});
+ * ```
+ */
+function show(options = {}, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'link', 'show'];
+        const ipCmd = new command_with_returned_data_1.default(schemas_1.SchemaIds.LinkShow, show_schema_1.LinkShowSchema, 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;
+/**
+ * Change device attributes.
+ *
+ * Warning: If multiple parameter changes are requested, `ip` aborts immediately after any
+ * of the changes have failed.
+ *
+ * This is the only case when `ip` can move the system to an
+ * unpredictable state. The solution is to avoid changing several parameters with one `ip link set` call.
+ * The modifier `change` is equivalent to `set`.
+ *
+ * @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 set(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'link', 'set'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.LinkSet, set_schema_1.LinkSetSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.set = set;
+exports.default = {
+    add,
+    del,
+    show,
+    set,
+    change: set
+};
+//# sourceMappingURL=link.js.map

package/lib/commands/link.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.js","sourceRoot":"","sources":["../../src/commands/link.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8GAAmF;AACnF,wEAAgE;AAChE,yDAAkE;AAGlE,kDAAwD;AAExD,wDAA2D;AAE3D,kDAAwD;AAOxD,oDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;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,OAA0B,EAC1B,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAE,CAAC;QAEvC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,UAAU,EACpB,gCAAgB,EAChB,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;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;;;;;;;;;;;;;;;GAeG;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,kBAAe;IACb,GAAG;IACH,GAAG;IACH,IAAI;IACJ,GAAG;IACH,MAAM,EAAE,GAAG;CACZ,CAAC"}

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

@@ -0,0 +1,10 @@
+/**
+ * Maddress add options.
+ * @category Interfaces
+ */
+export interface MaddressAddOptions {
+    /** The link-layer multicast address. */
+    address: string;
+    /** The device to join/leave this multicast address. */
+    dev: string;
+}

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

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

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

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

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

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