# windows-ip-config

> Node.js wrapper for netsh commands used for adding/removing IP address

Latest version **1.1.0** (published 2019-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install windows-ip-config
pnpm add windows-ip-config
yarn add windows-ip-config
bun add windows-ip-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-12-13 |
| First published | 2019-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alex Dykstra |
| Maintainers | sircodesalittle |

## Links

- npm: https://www.npmjs.com/package/windows-ip-config
- Repository: https://github.com/sircodesalittle/windows-ip-config
- Homepage: https://github.com/sircodesalittle/windows-ip-config#readme
- Issues: https://github.com/sircodesalittle/windows-ip-config/issues
- npm.io page: https://npm.io/package/windows-ip-config

## Recent versions

- 1.1.0 (latest) — 2019-12-13
- 1.0.1 — 2019-11-26
- 1.0.0 — 2019-11-26

## README

# Windows IP Config
Node.js wrapper for netsh commands used for adding/removing IP addresses

*Note: this package only works for windows, and must be run as an administrator

## Getting Started
```
npm install --save windows-ip-config
```

## Normal Usage
How to delete an address:
```javascript
let adapterName = 'Ethernet 3';
let addr = '192.168.1.5';
let ipVersion = 4;  // Optional parameter, default is 4; the other option is 6
deleteAdapterAddress(adapterName, addr, ipVersion);
```

How to add an IPv4 address
```javascript
let adapterName = 'Ethernet 3';
let addr = '192.168.1.5';
let subnetMask = '255.255.255.0';
addAdapterIPv4Address(adapterName, addr, subnetMask)
```

How to add an IPv6 address
```javascript
let adapterName = 'Ethernet 3';
let cidrAddress = 'fd01::01/64';
addAdapterIPv6Address(adapterName, cidrAddress)
```

---
_Source: https://npm.io/package/windows-ip-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._