Page MenuHomeVyOS Platform
Create Task
Maniphest T1432

Implement config write API for Python
Closed, ResolvedPublicENHANCEMENT
Actions

Description

Right now we only have config read API for Python, and no write API. If used with care, it can be implemented by saving the environment variables given by cli-shell-api getSessionEnv and using it for calls to my_set, my_delete etc.

s = vyos.configsession.ConfigSession(os.getpid(), app="vyos-http-api")
s.set(["system", "host-name"], value="vyos")
s.delete(["system", "options", "reboot-on-panic"])
s.comment(["system", "host-name"], value="Haha, I can change host-name via an API")
s.commit()

Details

Version
-
Is it a breaking change?
Perfectly compatible

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedFEATURE REQUESTdmbaturinT1431 Implement an HTTP API for config reading and modification
 ResolvedENHANCEMENTdmbaturinT1432 Implement config write API for Python

Event Timeline

dmbaturin created this task.Jun 12 2019, 8:01 AM
dmbaturin triaged this task as High priority.
dmbaturin added a parent task: T1431: Implement an HTTP API for config reading and modification.
dmbaturin mentioned this in rVYOSONEX5e7cf2bb32ca: T1432: initial implementation of the config write API..Jun 12 2019, 8:14 AM
dmbaturin mentioned this in rVYOSONEX6f42122bc4b8: T1432: correct the ConfigSessionError exception name..Jun 12 2019, 8:44 AM
runar subscribed.Jun 12 2019, 2:49 PM
pasik subscribed.Jun 13 2019, 7:41 PM
dmbaturin mentioned this in rVYOSONEX6b5f0dd5e59b: T1432: add a discard function to vyos.configsession.Jun 16 2019, 9:20 AM
dmbaturin mentioned this in rVYOSONEX303e8cb27560: T1432: add a finalizer to vyos.configsession to avoid leaking sessions..
dmbaturin mentioned this in rVYOSONEX9bf7d03ff734: T1432: inject VyOS-specific environment variables into the session environment..Jun 16 2019, 7:27 PM
eronlloyd subscribed.Aug 11 2019, 11:06 PM
syncer changed the subtype of this task from "Task" to "Enhancement".Mar 15 2020, 3:25 PM
dmbaturin closed this task as Resolved.Mar 15 2020, 3:27 PM
dmbaturin added a project: VyOS 1.2 Crux (VyOS 1.2.3).
dmbaturin edited a custom field.
dmbaturin edited a custom field.
dmbaturin set Is it a breaking change? to Perfectly compatible.
c-po moved this task from Need Triage to Finished on the VyOS 1.3 Equuleus board.Mar 22 2020, 8:53 AM
dmbaturin removed a project: VyOS 1.3 Equuleus.Sep 10 2021, 2:22 PM