networks

Manage networks.

GET /networks

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/networks
                

Response 200

id
integer
optional
Id of this network, generated internally
ip
string
optional
An IP in this network, does not have to be the first one (network address)
netmask
integer
optional
A CIDR netmask
gateway
string
optional
Optional gateway that will be installed as default route on servers with this network
poolStart
string
optional
Optional DHCP pool start address
poolEnd
string
optional
Optional DHCP pool emd address
type
string
optional
[other, ceph_public, ceph_internal, croit, ipmi]
description
string
optional
User-defined notes
mtu
integer
optional
Custom MTU, null indicates the default MTU of 1500

Example response

[
  {
    "id": 0,
    "ip": "string",
    "netmask": 0,
    "gateway": "string",
    "poolStart": "string",
    "poolEnd": "string",
    "type": "other",
    "description": "string",
    "mtu": 0
  }
]
                  

POST /networks

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/networks
                

Example body

{
  "ip": "string",
  "netmask": 0,
  "gateway": "string",
  "poolStart": "string",
  "poolEnd": "string",
  "type": "other",
  "description": "string",
  "mtu": 0
}
                

Response 200

id
integer
optional
Id of this network, generated internally
ip
string
optional
An IP in this network, does not have to be the first one (network address)
netmask
integer
optional
A CIDR netmask
gateway
string
optional
Optional gateway that will be installed as default route on servers with this network
poolStart
string
optional
Optional DHCP pool start address
poolEnd
string
optional
Optional DHCP pool emd address
type
string
optional
[other, ceph_public, ceph_internal, croit, ipmi]
description
string
optional
User-defined notes
mtu
integer
optional
Custom MTU, null indicates the default MTU of 1500

Example response

{
  "id": 0,
  "ip": "string",
  "netmask": 0,
  "gateway": "string",
  "poolStart": "string",
  "poolEnd": "string",
  "type": "other",
  "description": "string",
  "mtu": 0
}
                  

PUT /networks/{id}

Parameters

body
object
optional
-
id
integer
path
-

Endpoint

curl -X PUT http://mgmt-node:8080/api/networks/{id}
                

Example body

{
  "ip": "string",
  "netmask": 0,
  "gateway": "string",
  "poolStart": "string",
  "poolEnd": "string",
  "type": "other",
  "description": "string",
  "mtu": 0
}
                

DELETE /networks/{id}

Parameters

id
integer
path
-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/networks/{id}