nmstate/doc/nmstate.service.8.in
Gris Ge 733deba324 cli service: Allow user to opt-in on not deleting applied file
Previously, we introduced new method on finding un-applied state YAML
files. It was a changed behaviour which break API.

This patch change `nmstatectl service` to original behaviour which just
rename applied YAML file with `.applied` postfix.

If you don't want the applied state been deleted, please place
`/etc/nmstate/nmstate.conf` (folder can be defined by `--config`
argument) with content of:

```toml
[service]
keep_state_file_after_apply = true
```

Manpage updated.

Integration test case included.

Signed-off-by: Gris Ge <fge@redhat.com>
2024-02-08 15:03:47 +08:00

33 lines
1007 B
Groff

.TH nmstate\&.service 8 "@DATE@" "@VERSION@" "nmstate.service man page"
.SH "NAME"
nmstate\&.service \- Apply /etc/nmstate network states
.SH "SYNOPSIS"
.PP
nmstate\&.service
.SH "DESCRIPTION"
.PP
nmstate\&.service invokes \fBnmstatectl service\fR command which
apply all network state files ending with \fB.yml\fR in
\fB/etc/nmstate\fR folder.
By default, the network state file will be renamed with the suffix
\fB.applied\fR after applying it. This is to prevent it being applied again
when the service runs next.
With \fB/etc/nmstate/nmstate.conf\fR holding below content:
\fB
[service]
keep_state_file_after_apply = true
\fR
The nmstate.service will not remove network state file, just copy applied
network stata to file with the suffix \fB.applied\fR after applying it.
.SH BUG REPORTS
Report bugs on nmstate GitHub issues <https://github.com/nmstate/nmstate>.
.SH COPYRIGHT
License Apache 2.0 or any later version
<https://www.apache.org/licenses/LICENSE-2.0.txt>
.SH SEE ALSO
.B nmstatectl\fP(8)