https://github.com/adonespitogo/node-set-ip-address
Node module for setting up network interface(s) ip address, dns, and default routes of physical network interfaces, VLAN, and bridged interfaces.
https://github.com/adonespitogo/node-set-ip-address
bridge network vlan
Last synced: 9 months ago
JSON representation
Node module for setting up network interface(s) ip address, dns, and default routes of physical network interfaces, VLAN, and bridged interfaces.
- Host: GitHub
- URL: https://github.com/adonespitogo/node-set-ip-address
- Owner: adonespitogo
- License: mit
- Created: 2019-11-14T05:01:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-09-17T05:54:56.000Z (9 months ago)
- Last Synced: 2025-09-19T14:03:27.962Z (9 months ago)
- Topics: bridge, network, vlan
- Language: JavaScript
- Homepage:
- Size: 244 KB
- Stars: 17
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# set-ip-address
Node module for setting up network interface(s) ip address, dns, and default routes of physical network interfaces, VLAN, and bridged interfaces.
[](https://travis-ci.com/adonespitogo/node-set-ip-address)
Supported linux network configurations:
- netplan (/etc/netplan/)
Install
---
```
yarn add set-ip-address
```
OR
```
npm i --save set-ip-address
```
Basic Usage
---
```js
var set_ip_address = require('set-ip-address')
```
```js
var eth0 = {
interface: 'eth0',
ip_address: '10.0.0.1',
prefix: 20,
gateway: '10.0.0.1',
nameservers: ['8.8.8.8'], // nameservers can also be a string separated by space/comma, ex: `"1.1.1.1, 8.8.8.8 8.8.4.4"`
optional: true, // dont wait for interfaces to avoid boot delay
match: { // netplan match option
name: 'eth0'
}
}
var eth1 {
interface: 'eth1',
dhcp: true
}
set_ip_address.configure([eth0, eth1]).then(() => console.log('done writing config files')
```
Create and Configure VLAN Interface
---
You can create vlan interfaces by passing `vlanid` option. Make sure to load `8021q` module to the kernel:
```
sudo modprobe 8021q
```
```js
var eth0 = {
interface: 'eth0',
ip_address: '10.0.0.1',
prefix: 20,
gateway: '10.0.0.1',
nameservers: ['8.8.8.8']
}
var vlan1 {
interface: 'eth0',
vlanid: 10,
ip_address: '20.0.0.1',
prefix: 20,
gateway: '20.0.0.1',
nameservers: ['8.8.8.8']
}
set_ip_address.configure([eth0, vlan1]).then(() => console.log('done writing config files')
```
Create and Configure Bridged Interfaces
---
```js
var eth0 = {
interface: 'eth0',
manual: true
}
var vlan1 {
interface: 'eth0',
vlanid: 10,
manual: true
}
var br0 = {
interface: 'br0',
ip_address: '10.0.0.1',
prefix: 20,
gateway: '10.0.0.1',
nameservers: ['8.8.8.8'],
bridge_ports: ['eth0', 'eth0.10'],
bridge_opts: {
parameters: {
stp: true
}
}
}
set_ip_address
.configure([eth0, vlan1, br0])
.then(() => console.log('done writing config files')
```
Create and Configure PPPoE Interface
---
```js
var ppp = {
provider: 'dsl-provider',
physical_interface: 'eth0'
}
set_ip_address
.configure([ppp])
.then(() => console.log('done writing config files')
```
Restart Networking Service
---
```js
set_ip_address.restartService()
.then(() => console.log('network service restarted'))
```
LICENSE
---
[MIT](LICENSE)