cloudflash-network
v0.6.25
Published
cloudflash network module implements network and dhcp configuration on unix systems
Downloads
81
Readme
cloudflash-network
List of interface APIs
List Network Interfaces
Verb URI Description
GET /network/interfaces List summary of network interfaces configured.Note: The request does not require a message body. Success: Returns JSON data with list of network configured.
Response
[
{
"id": "lo",
"config": { },
"stats": {
"txbytes": "832529",
"rxbytes": "832529"
},
"operstate": "unknown",
"mtu": "16436",
"devtype": "lo"
},
{
"id": "eth1",
"config": {
"type": "static",
"address": [
"10.1.10.142"
],
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "1139580",
"rxbytes": "17212321"
},
"operstate": "up",
"mtu": "1500",
"devtype": "Ether"
},
{
"id": "eth1.3",
"config": {
"type": "static",
"address": "10.1.10.111",
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "468",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
},
{
"id": "eth1.4",
"config": {
"type": "static",
"address": "10.2.10.111",
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "8358",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
},
{
"id": "eth1.5",
"config": {
"type": "dynamic",
"dhcp": true
},
"stats": {
"txbytes": "3546",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
},
{
"id": "eth1.6",
"config": {
"type": "dynamic",
"dhcp": true
},
"stats": {
"txbytes": "4230",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
}]
Configure Network Interfaces
Verb URI Description
POST /network/interfaces/eth1 Create network interfaces configuration.Example Request and Response
Request JSON For static
{
"type": "static",
"address": [
"10.1.10.142"
],:
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
"post-up": [
"route add -net 10.10.10.0/24 gw 10.1.10.1"
]
}Response JSON
{
"id": "eth1",
"config": {
"type": "static",
"address": [
"10.1.10.142"
],
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
"post-up": [
"route add -net 10.10.10.0/24 gw 10.1.10.1"
]
}
}Request JSON For dynamic
{ "dhcp": true, "type":"dynamic" }
Response JSON
{
"id": "eth1.6",
"config": {
"type": "dynamic",
"dhcp": true
}
}Configure VLAN Network Interfaces
Verb URI Description
POST /network/interfaces/:ifid/vlan/:vid Create network VLAN interfaces configuration.Example Request and Response POST /network/interfaces/eth1/vlan/4
Request JSON For vlan
{
"type":"static",
"address":"10.2.10.111",
"netmask":"255.255.255.0",
"gateway":"10.1.10.1",
"broadcast":"10.1.10.255"
}Response JSON
{
"id": "eth1.4",
"config": {
"type": "static",
"address": "10.2.10.111",
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
}
}List a Network Interface
Verb URI Description
GET /network/interfaces/:id Describes an configured network by name.Note: The request does not require a message body. Success: Returns JSON data with list of network configured.
GET /network/interfaces/eth1
Response
{
"id": "eth1",
"config": {
"type": "static",
"address": [
"10.1.10.142"
],
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "1152289",
"rxbytes": "17325196"
},
"operstate": "up",
"mtu": "1500",
"devtype": "Ether"}
GET /network/interfaces/eth1.4
Response
{
"id": "eth1.4",
"config": {
"type": "static",
"address": "10.2.10.111",
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "8358",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
}List VLAN Network Interface
Verb URI Description
GET /network/interfaces/:id/vlan Describes configured VLAN network.Note: The request does not require a message body. Success: Returns JSON data with list of network configured.
GET /network/interfaces/eth1/vlan
Response
[
{
"id": "eth1.3",
"config": {
"type": "static",
"address": "10.1.10.111",
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "468",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
},
{
"id": "eth1.5",
"config": {
"type": "dynamic",
"dhcp": true
},
"stats": {
"txbytes": "3546",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
}]
List a VLAN Network Interface
Verb URI Description
GET /network/interfaces/:id/vlan/:vid Describes a configured VLAN network by ID.Note: The request does not require a message body. Success: Returns JSON data with list of network configured.
GET /network/interfaces/eth1/vlan/4
Response
{
"id": "eth1.4",
"config": {
"type": "static",
"address": "10.2.10.111",
"netmask": "255.255.255.0",
"gateway": "10.1.10.1",
"broadcast": "10.1.10.255"
},
"stats": {
"txbytes": "8358",
"rxbytes": "0"
},
"operstate": "down",
"mtu": "1500",
"devtype": "Ether"
}Delete a network interface
Verb URI Description
DELETE /network/interfaces/:id Delete an configured network by name.Example Request and Response
Request Headers
DELETE /network/interfaces/eth0Response Header
Status Code : 204
Delete a VLAN network interface
Verb URI Description
DELETE /network/interfaces/:id/vlan/:vid Delete an configured VLAN network by VLAN ID.Example Request and Response
Request Headers
DELETE /network/interfaces/eth0/vlan/1Response Header
Status Code : 204
Create a policy route
Verb URI Description
POST /network/route/policy Create a policy routing table.Example Request and Response
Request JSON For static
{
"name": "RDS",
"static-routes": [
{
"network": "10.1.2.56.119",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "eth0"
},
{
"network": "10.1.2.56.110",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "lan0"
}
]
}Response JSON
{
"id": "8af0076e-65c3-4a95-8c11-dbb7b29d13df",
"config":
{
"name": "RDS",
"static-routes":
[
{
"network": "10.1.2.56.119",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "eth0"
},
{
"network": "10.1.2.56.110",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "lan0"
}
]
}
}List of route policy
Verb URI Description
GET /network/route List all policy route.Example Request and Response
Response JSON
[
{
"id": "8af0076e-65c3-4a95-8c11-dbb7b29d13df",
"config":
{
"name": "RDS",
"static-routes":
[
{
"network": "10.1.2.56.119",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "eth0"
},
{
"network": "10.1.2.56.110",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "lan0"
}
]
}
}
]List a policy
Verb URI Description
GET /network/route/policy/:id List a policy route.Example Request and Response
Response JSON
{
"id": "8af0076e-65c3-4a95-8c11-dbb7b29d13df",
"config":
{
"name": "RDS",
"static-routes":
[
{
"network": "10.1.2.56.119",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "eth0"
},
{
"network": "10.1.2.56.110",
"netmask": "255.255.255.0",
"gateway": "10.2.56.1",
"interface": "lan0"
}
]
}
}Delete a route policy
Verb URI Description
DELETE /network/route/policy/:id Delete a route policy table.Example Request and Response
Request Headers
DELETE /network/route/policy/8af0076e-65c3-4a95-8c11-dbb7b29d13dfResponse Header
Status Code : 204