Network and time

Generated from the committed OpenAPI document, bmcd 2.36.3. Do not edit this file: just refresh-api rewrites it.

GET /api/bmc/network

Interfaces and switch ports

Legacy form: GET /api/bmc?opt=get&type=network with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.

response	body	meaning
200	application/json — object	The result.
204	empty	Done, with nothing to report.
default	application/problem+json — Problem	A refusal, RFC 9457.

`200` body (`application/json`)

field	type	required	description
ports	array of SwitchPort	yes

`default` body (`application/problem+json`): `Problem`

field	type	required	description
detail	string	no
status	integer	yes
title	string	yes
type	string	no

POST /api/bmc/network/reset

Reset the network configuration

Legacy form: GET /api/bmc?opt=set&type=network with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.

response	body	meaning
200	application/json — —	The result. Its shape is not described in this document.
204	empty	Done, with nothing to report.
default	application/problem+json — Problem	A refusal, RFC 9457.

`default` body (`application/problem+json`): `Problem`

field	type	required	description
detail	string	no
status	integer	yes
title	string	yes
type	string	no

GET /api/bmc/ntp

Time sources and the clock's state

Legacy form: GET /api/bmc?opt=get&type=ntp with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.

response	body	meaning
200	application/json — Ntp	The result.
204	empty	Done, with nothing to report.
default	application/problem+json — Problem	A refusal, RFC 9457.

`200` body (`application/json`): `Ntp`

field	type	required	description
clock	Clock	yes
configurable	boolean	yes	False on an image whose chrony.conf predates the sourcedir line. Without it a saved list is written and silently never read, so the interface must be able to say the setting does nothing.
servers	array of string	yes

`default` body (`application/problem+json`): `Problem`

field	type	required	description
detail	string	no
status	integer	yes
title	string	yes
type	string	no

POST /api/bmc/ntp

Replace the time sources and reload chrony

Legacy form: GET /api/bmc?opt=set&type=ntp with the same parameters in the query string. That form answers {"response":[{"result":…}]} and puts a refusal's message in result; this path answers the bare result and a refusal as application/problem+json.

Request body (`application/json`)

field	type	required	description
servers	string	no	comma-separated, in preference order; empty restores the image's pool

Request body (`application/x-www-form-urlencoded`)

field	type	required	description
servers	string	no	comma-separated, in preference order; empty restores the image's pool

response	body	meaning
200	application/json — —	The result. Its shape is not described in this document.
204	empty	Done, with nothing to report.
default	application/problem+json — Problem	A refusal, RFC 9457.

`default` body (`application/problem+json`): `Problem`

field	type	required	description
detail	string	no
status	integer	yes
title	string	yes
type	string	no