❤
npm
Sign UpSign In

cloudflash-udhcpd

0.6.2 • Public • Published

List of uDHCPd APIs

VerbURIDescription
POST/network/udhcpdCreate DHCP server configuration
GET/network/udhcpdList DHCP servers configuration
GET/network/udhcpd/:idList DHCP server configuration by ID
DELETE/network/udhcpd/:idDelete DHCP server configuration

Create DHCP server configuration

Verb    URI        		    Description
POST	/network/udhcpd 	Creating a DHCP server configuraion in VCG.

On success it returns JSON data with the service-id, config success.

TODO: Define JSON format for error codes and description.

Example Request and Response

Request Headers

Request JSON

{
       "start": "192.168.0.20",
       "end": "192.168.0.100",
       "interface": "wan0",
       "max_leases": 254,
       "remaining": "yes",
       "auto_time": 7200,
       "decline_time": 3600,
       "conflict_time": 3600,
       "offer_time": 60,
       "min_lease": 60,
       "lease_file": "/var/lib/misc/udhcpd.leases",
       "pidfile": "/var/run/udhcpd.pid",
       "notify_file": "dumpleases",
       "siaddr": "192.168.0.22",
       "sname": "zorak",
       "boot_file": "/var/lib/misc/udhcpd.leases",
       "option": 
       {
        "subnet":["192.168.0.25"],
        "router":["192.10.0.40", "192.10.0.41"],
        "dns":["192.10.0.40", "192.10.0.41"],
        "wins":["192.10.0.40", "192.10.0.41"],
        "domain":["192.10.0.40", "192.10.0.41"],
        "lease":60,
        "timezone":"IST",
        "timesvr":["192.10.0.40", "192.10.0.41"],
        "logsvr" :["192.10.0.40", "192.10.0.41"],
        "cookiesvr" :["192.10.0.40", "192.10.0.41"],
        "lprsrv" :["192.10.0.40", "192.10.0.41"],
        "hostname":"kvm570"
      }
       
}

Response JSON

{
  "id": "cc6279dd-7409-4cd2-b4ad-086dbd1b59a5",
  "config":
  {
   "start": "192.168.0.20",
   "end": "192.168.0.100",
   "interface": "wan0",
   "max_leases": 254,
   "remaining": "yes",
   "auto_time": 7200,
   "decline_time": 3600,
   "conflict_time": 3600,
   "offer_time": 60,
   "min_lease": 60,
   "lease_file": "/var/lib/misc/udhcpd.leases",
   "pidfile": "/var/run/udhcpd.pid",
   "notify_file": "dumpleases",
   "siaddr": "192.168.0.22",
   "sname": "zorak",
   "boot_file": "/var/lib/misc/udhcpd.leases",
   "option":
   {
       "subnet":
       [
           "192.168.0.25"
       ],
       "router":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "dns":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "wins":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "domain":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "lease": 60,
       "timezone": "IST",
       "timesvr":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "logsvr":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "cookiesvr":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "lprsrv":
       [
           "192.10.0.40",
           "192.10.0.41"
       ],
       "hostname": "kvm570"
   }     
  }      
}

Upon error, error code 500 will be returned

List DHCP servers configuration

Verb	URI	             Description
GET	/network/udhcpd	 List the DHCP servers configuration.

Example Request and Response

Request Headers

GET  /network/udhcpd

Response JSON

[
    {
       "id": "fdc1a6fa-a34a-42fb-b735-837a849bfe64",
       "config": {
            "start": "192.168.0.20",
            "end": "192.168.0.254",
            "interface": "eth0",
            "max_leases": 254,
            "remaining": "yes",
            "auto_time": 7200,
            "decline_time": 3600,
            "conflict_time": 3600,
            "offer_time": 60,
            "min_lease": 60,
            "lease_file": "/var/lib/misc/udhcpd.leases",
            "pidfile": "/var/run/udhcpd.pid",
            "notify_file": "dumpleases",
            "siaddr": "192.168.0.22",
            "option": {
                "subnet": [
                   "1.1.1.1",
                   "2.2.2.2"
                 ],
                 "mtu": "100"
             }
         }
    },
    {
       "id": "4d2b0825-1ce0-4d01-9cc3-3edc5307cfaf",
       "config": {
           "start": "192.168.0.20",
           "end": "192.168.0.254",
           "interface": "eth1",
           "max_leases": 254,
           "remaining": "yes",
           "auto_time": 7200,
           "decline_time": 3600,
           "conflict_time": 3600,
           "offer_time": 60,
           "min_lease": 60,
           "lease_file": "/var/lib/misc/udhcpd.leases",
           "pidfile": "/var/run/udhcpd.pid",
           "notify_file": "dumpleases",
           "siaddr": "192.168.0.22",
           "option": {
              "subnet": [
                    "1.1.1.1",
                    "2.2.2.2"
               ],
           "mtu": "100"
            }
         } 
    }
]

List DHCP server configuration by ID

Verb URI                    Description
GET  /network/udhcpd/:id    List DHCP server configuration.

On Success returns 200 with JSON data

Example Request and Response

Request Headers

GET  /network/udhcpd/cc6279dd-7409-4cd2-b4ad-086dbd1b59a5

Response JSON

  {
    "id": "cc6279dd-7409-4cd2-b4ad-086dbd1b59a5",
    "config":
    {
       "start": "192.168.0.20",
       "end": "192.168.0.100",
       "interface": "wan0",
       "max_leases": 254,
       "remaining": "yes",
       "auto_time": 7200,
       "decline_time": 3600,
       "conflict_time": 3600,
       "offer_time": 60,
       "min_lease": 60,
       "lease_file": "/var/lib/misc/udhcpd.leases",
       "pidfile": "/var/run/udhcpd.pid",
       "notify_file": "dumpleases",
       "siaddr": "192.168.0.22",
       "sname": "zorak",
       "boot_file": "/var/lib/misc/udhcpd.leases",
       "option":
       {
           "subnet":
           [
               "192.168.0.25"
           ],
           "router":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "dns":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "wins":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "domain":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "lease": 60,
           "timezone": "IST",
           "timesvr":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "logsvr":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "cookiesvr":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "lprsrv":
           [
               "192.10.0.40",
               "192.10.0.41"
           ],
           "hostname": "kvm570"
       }
    }
 }

Delete DHCP server configuration

Verb        URI	                    Description
DELETE      /network/udhcpd/:id     Delete DHCP server configuration

On Success returns status code 204

Example Request and Response

Request Headers

DELETE  /network/udhcpd/cc6279dd-7409-4cd2-b4ad-086dbd1b59a5

Response JSON

Status Code: 204

Readme

Keywords

none

Package Sidebar

Install

npm i cloudflash-udhcpd

Repository

github.com/clearpath-networks/cloudflash-udhcpd

Homepage

github.com/clearpath-networks/cloudflash-udhcpd#readme

Weekly Downloads

3

Version

0.6.2

License

none

Last publish

Collaborators

  • clearpath
Try on RunKit
Report malware