node package manager

cloudflash-xl2tpd

cloudflash-xl2tpd

List of xl2tpd APIs

VerbURIDescription
POST/xl2tpdCreate xl2tpd configuration
GET/xl2tpdList summary of xl2tpd configuration
GET/xl2tpd/:xlidList summary of xl2tpd configuration by ID
PUT/xl2tpd/:xlidUpdate xl2tpd configuration by ID
DEL/xl2tpd/:xlidDelete xl2tpd configuration by ID
POST/xl2tpd/:xlid/chapsecretsCreate xl2tpd chap-secret configuration
GET/xl2tpd/:xlid/chapsecretsList summary of xl2tpd chap-secrets configuration
GET/xl2tpd/:xlid/chapsecrets/:idList summary of xl2tpd chap-secrets configuration by ID
PUT/xl2tpd/:xlid/chapsecrets/:idUpdate xl2tpd chap-secrets configuration by ID
DEL/xl2tpd/:xlid/chapsecrets/:idDelete xl2tpd chap-secrets configuration by ID
POST/xl2tpd/:xlid/optionsCreate xl2tpd options configuration
GET/xl2tpd/:xlid/optionsList summary of xl2tpd options configuration
GET/xl2tpd/:xlid/options/:idList summary of xl2tpd options configuration by ID
PUT/xl2tpd/:xlid/options/:idModify xl2tpd options configuration
DEL/xl2tpd/:xlid/options/:idDelete xl2tpd options configuration

xl2tpd configuration

API to configure xl2tpd

Verb          URI                     Description
POST          /xl2tpd                 Create configuration for xl2tpd

Request JSON

{
    "global": {
    "port": 1701,
    "auth file": "/config/xl2tpd/chap-secrets",
    "ipsec saref": "yes"
    },
    "lns default": {
    "exclusive": "yes",
    "ip range": "169.254.254.2-169.254.254.254",
    "lac": "0.0.0.0-255.255.255.255",
    "local ip": "169.254.254.1",
    "require chap": "yes",
    "refuse pap": "yes",
    "require authentication": "yes",
    "name": "test",
    "ppp debug": "yes",
    "pppoptfile": "/config/xl2tpd/options",
    "length bit": "yes"
    }
}

Response JSON

{
   "global":
   {
       "port": 1701,
       "auth file": "/config/xl2tpd/chap-secrets",
       "ipsec saref": "yes"
   },
   "lns default":
   {
       "exclusive": "yes",
       "ip range": "169.254.254.2-169.254.254.254",
       "lac": "0.0.0.0-255.255.255.255",
       "local ip": "169.254.254.1",
       "require chap": "yes",
       "refuse pap": "yes",
       "require authentication": "yes",
       "name": "test",
       "ppp debug": "yes",
       "pppoptfile": "/config/xl2tpd/options",
       "length bit": "yes"
   },
   "id": "17915132-a88d-453b-8c38-031d9ecc1b06"
}

List xl2tpd configuration

Verb          URI                     Description
GET           /xl2tpd                 List configuration of xl2tpd

Response JSON

{
   "xl2tpd":
   [
       {
           "global":
           {
               "port": 1701,
               "auth file": "/config/xl2tpd/chap-secrets",
               "ipsec saref": "yes"
           },
           "lns default":
           {
               "exclusive": "yes",
               "ip range": "169.254.254.2-169.254.254.254",
               "lac": "0.0.0.0-255.255.255.255",
               "local ip": "169.254.254.1",
               "require chap": "yes",
               "refuse pap": "yes",
               "require authentication": "yes",
               "name": "test",
               "ppp debug": "yes",
               "pppoptfile": "/config/xl2tpd/options",
               "length bit": "yes"
           },
           "id": "e6ddc97f-4aea-48b0-aee2-e224ed80cc83"
       }
   ],
   "chapsecrets":
   [
       {
           "secret": "test *009*",
           "id": "cbea63b8-2dc2-4476-9baa-50e9faf1b9b5"
       }
   ],
   "options":
   [
       {
           "ipcp-accept-local": "",
           "ipcp-accept-remote": "",
           "ms-dns":
           [
               "4.2.2.2",
               "172.16.0.1"
           ],
           "ms-wins":
           [
               "192.168.5.2",
               "192.168.5.4"
           ],
           "noccp": "",
           "auth": "",
           "idle": 1800,
           "mtu": 1410,
           "mru": 1410,
           "debug": "",
           "dump": "",
           "lock": "",
           "modem": "",
           "proxyarp": "",
           "lcp-echo-interval": 30,
           "lcp-echo-failure": 4,
           "connect-delay": 5000,
           "interface": "mobi",
           "id": "354cc450-830b-4cc2-ab77-6df55b24e33e"
       }
   ]
}

List xl2tpd configuration by ID

Verb          URI                     Description
GET           /xl2tpd/:xlid           List configuration of xl2tpd by ID

Response JSON

{
   "global":
   {
       "port": 1701,
       "auth file": "/config/xl2tpd/chap-secrets",
       "ipsec saref": "yes"
   },
   "lns default":
   {
       "exclusive": "yes",
       "ip range": "169.254.254.2-169.254.254.254",
       "lac": "0.0.0.0-255.255.255.255",
       "local ip": "169.254.254.1",
       "require chap": "yes",
       "refuse pap": "yes",
       "require authentication": "yes",
       "name": "test",
       "ppp debug": "yes",
       "pppoptfile": "/config/xl2tpd/options",
       "length bit": "yes"
   },
   "id": "17915132-a88d-453b-8c38-031d9ecc1b06"
}

API to modify xl2tpd configuration

Verb          URI                     Description
PUT           /xl2tpd/:xlid           Modify the configuration of xl2tpd

Request JSON

{
"global": {
    "port": 1701,
    "auth file": "/config/xl2tpd/chap-secrets",
    "ipsec saref": "yes"
},
"lns default": {
    "exclusive": "yes",
    "ip range": "169.254.254.2-169.254.254.254",
    "lac": "0.0.0.0-255.255.255.255",
    "local ip": "169.254.254.1",
    "require chap": "yes",
    "refuse pap": "yes",
    "require authentication": "yes",
    "name": "test",
    "ppp debug": "yes",
    "pppoptfile": "/config/xl2tpd/options",
    "length bit": "yes"
}
}

Response JSON

    {
   "global":
   {
       "port": 1701,
       "auth file": "/config/xl2tpd/chap-secrets",
       "ipsec saref": "yes"
   },
   "lns default":
   {
       "exclusive": "yes",
       "ip range": "169.254.254.2-169.254.254.254",
       "lac": "0.0.0.0-255.255.255.255",
       "local ip": "169.254.254.1",
       "require chap": "yes",
       "refuse pap": "yes",
       "require authentication": "yes",
       "name": "test",
       "ppp debug": "yes",
       "pppoptfile": "/config/xl2tpd/options",
       "length bit": "yes"
   },
   "id": "17915132-a88d-453b-8c38-031d9ecc1b06"
}

API to delete xl2tpd configuration

Verb      URI                            Description
DELETE    /xl2tpd/:xlid                  Delete the xl2tpd configuration by ID.

Request Headers

DELETE     /xl2tpd/:xlid

Response Header

Status Code : 204

API to configure xl2tpd chap-secrets

Verb            URI                             Description
POST            /xl2tpd/:xlid/chapsecrets       Create chap-secrets configuration

Request JSON

{
    "secret" : "test *009*"
}

Response JSON

{
   "secret": "test *009*",
   "id": "95b95b57-1a82-4e06-90ce-9ccc4d4e55c3"
}

List the xl2tpd chap-secrets configuration

Verb      URI                                Description
GET       /xl2tpd/:xlid/chapsecrets          List the xl2tpd chap-secrets configuration.

Response JSON

[
   {
       "secret": "test *009*",
       "id": "95b95b57-1a82-4e06-90ce-9ccc4d4e55c3"

   }
]

List the xl2tpd chap-secrets configuration by ID

Verb      URI                                Description
GET       /xl2tpd/:xlid/chapsecrets/:id      List the xl2tpd chap-secrets configuration by ID

Response JSON

{
   "secret": "test *009*",
   "id": "95b95b57-1a82-4e06-90ce-9ccc4d4e55c3"
}

API to modify xl2tpd chap-secrets configuaration

Verb          URI                                Description
PUT           /xl2tpd/:xlid/chapsecrets/:id      Modify the xl2tpd chap-secrets configuration

Request JSON

{
    "secret" : "test *009*"
}

Response JSON

{
   "secret": "test *009*",
   "id": "95b95b57-1a82-4e06-90ce-9ccc4d4e55c3"
}

API to Delete xl2tpd chap-secrets configuration

Verb      URI                                Description
DELETE    /xl2tpd/:xlid/chapsecrets/:id      Delete the xl2tpd chap-secrets configuration by ID.

Request Headers

DELETE     /xl2tpd/:xlid/chapsecrets/:id

Response Header

Status Code : 204

API for xl2tpd options configuration

Verb           URI                     Description
POST           /xl2tpd/:xlid/options   Create xl2tpd options configuration

Request JSON

{
     "ipcp-accept-local": "",
     "ipcp-accept-remote": "",
     "ms-dns" :  ["4.2.2.2", "172.16.0.1" ],
     "ms-wins": [ "192.168.5.2",  "192.168.5.4" ],
     "noccp":"",
     "auth":"",
     "idle": 1800,
     "mtu": 1410,
     "mru": 1410,
     "debug":"",
     "dump":"",
     "lock": "",
     "modem":"",
     "proxyarp":"",
     "lcp-echo-interval": 30,
     "lcp-echo-failure": 4,
     "connect-delay":5000,
     "interface" : "mobi"
}

Response JSON

{
   "ipcp-accept-local": "",
   "ipcp-accept-remote": "",
   "ms-dns":
   [
       "4.2.2.2",
       "172.16.0.1"
   ],
   "ms-wins":
   [
       "192.168.5.2",
       "192.168.5.4"
   ],
   "noccp": "",
   "auth": "",
   "idle": 1800,
   "mtu": 1410,
   "mru": 1410,
   "debug": "",
   "dump": "",
   "lock": "",
   "modem": "",
   "proxyarp": "",
   "lcp-echo-interval": 30,
   "lcp-echo-failure": 4,
   "connect-delay": 5000,
   "interface": "mobi",
   "id": "d8198114-7485-4d97-a657-93427dbda969"
}

List the xl2tpd options configuration

Verb           URI                     Description
GET            /xl2tpd/:xlid/options   List the xl2tpd options configuration

Response JSON

[
   {
       "ipcp-accept-local": "",
       "ipcp-accept-remote": "",
       "ms-dns":
       [
           "4.2.2.2",
           "172.16.0.1"
       ],
       "ms-wins":
       [
           "192.168.5.2",
           "192.168.5.4"
       ],
       "noccp": "",
       "auth": "",
       "idle": 1800,
       "mtu": 1410,
       "mru": 1410,
       "debug": "",
       "dump": "",
       "lock": "",
       "modem": "",
       "proxyarp": "",
       "lcp-echo-interval": 30,
       "lcp-echo-failure": 4,
       "connect-delay": 5000,
       "interface": "mobi",
       "id": "d8198114-7485-4d97-a657-93427dbda969"
   }
]

List the xl2tpd options configuration by ID

Verb           URI                         Description
GET            /xl2tpd/:xlid/options/:id   List the xl2tpd options  configuration

Response JSON

{
   "ipcp-accept-local": "",
   "ipcp-accept-remote": "",
   "ms-dns":
   [
       "4.2.2.2",
       "172.16.0.1"
   ],
   "ms-wins":
   [
       "192.168.5.2",
       "192.168.5.4"
   ],
   "noccp": "",
   "auth": "",
   "idle": 1800,
   "mtu": 1410,
   "mru": 1410,
   "debug": "",
   "dump": "",
   "lock": "",
   "modem": "",
   "proxyarp": "",
   "lcp-echo-interval": 30,
   "lcp-echo-failure": 4,
   "connect-delay": 5000,
   "interface": "mobi",
   "id": "d8198114-7485-4d97-a657-93427dbda969"
}

API to modify the xl2tpd options configuration

Verb           URI                         Description
PUT            /xl2tpd/:xlid/options/:id   Modify the xl2tpd options configuration

Request JSON

{
     "ipcp-accept-local": "",
     "ipcp-accept-remote": "",
     "ms-dns" :  ["4.2.2.2", "172.16.0.1" ],
     "ms-wins": [ "192.168.5.2",  "192.168.5.4" ],
     "noccp":"",
     "auth":"",
     "idle": 1800,
     "mtu": 1410,
     "mru": 1410,
     "debug":"",
     "dump":"",
     "lock": "",
     "modem":"",
     "proxyarp":"",
     "lcp-echo-interval": 30,
     "lcp-echo-failure": 4,
     "connect-delay":5000,
     "interface" : "mobi"
}

Response JSON

{
   "ipcp-accept-local": "",
   "ipcp-accept-remote": "",
   "ms-dns":
   [
       "4.2.2.2",
       "172.16.0.1"
   ],
   "ms-wins":
   [
       "192.168.5.2",
       "192.168.5.4"
   ],
   "noccp": "",
   "auth": "",
   "idle": 1800,
   "mtu": 1410,
   "mru": 1410,
   "debug": "",
   "dump": "",
   "lock": "",
   "modem": "",
   "proxyarp": "",
   "lcp-echo-interval": 30,
   "lcp-echo-failure": 4,
   "connect-delay": 5000,
   "interface": "mobi",
   "id": "d8198114-7485-4d97-a657-93427dbda969"
}

API to delete xl2tpd options configuration

Verb      URI                            Description
DELETE    /xl2tpd/:xlid/options/:id      Delete the xl2tpd options configuration by ID.

Request Headers

DELETE     /xl2tpd/:xlid/options/:id

Response Header

Status Code : 204