nmstatectl(8)

1nmstatectl(8)                 nmstatectl man page                nmstatectl(8)
2
3
4

NAME

6       nmstatectl - A nmstate command line tool
7

SYNOPSIS

9       nmstatectl show [INTERFACE_NAME] [--json]
10       nmstatectl set STATE_FILE_PATH [OPTIONS]
11       nmstatectl edit [INTERFACE_NAME] [OPTIONS]
12       nmstatectl rollback [CHECKPOINT_PATH]
13       nmstatectl commit [CHECKPOINT_PATH]
14       nmstatectl version
15       nmstatectl varlink [UNIX_FILE_SOCKET_PATH]
16

DESCRIPTION

18       nmstatectl  is  created  for  users who want to try out nmstate without
19       using libnmstate.
20
21       show
22              Query the current network state. YAML is the default output for‐
23              mat.  Use  the  --json  argument  to change the output format to
24              JSON. To limit the output state to  include  certain  interfaces
25              only,  please  specify  the  interface  name. Please be advised,
26              global config like DNS will be included.
27
28              For multiple interface names, use comma to  separate  them.  You
29              can also use patterns for interface names:
30                     * matches everything
31                     ? matches any single character
32                     [seq] matches any character in seq
33                     [!seq] matches any character not in seq
34
35              For example, to show all interfaces starts with eth:
36                     nmstatectl show eth\*
37                     #  The  backslash is required to stop shell expanding '*'
38                     to file names.
39
40       set
41              Apply the network state from specified file in YAML or JSON for‐
42              mat.   By  default,  if the network state after state applied is
43              not identical to the desired state, nmstatectl rollbacks to  the
44              state  before  set command. Use the --no-verify argument to skip
45              the verification.
46
47       edit
48              nmstatectl will invoke the text editor  defined  by  environment
49              variable  EDITOR  for  editing the network state in YAML format.
50              Once the text editor quit, nmstatectl will try to apply it using
51              "nmstatectl set".
52              If  there  is any syntax error, you will be asked to edit again.
53              Multiple interfaces are supported, check show for detail.
54
55              By default, if the network state  after  state  applied  is  not
56              identical  to  the  desired  state,  nmstatectl rollbacks to the
57              state before edit command. Use the --no-verify argument to  skip
58              the verification.
59
60       nmstatectl  supports  manual  transaction  control which allows user to
61       decide whether rollback  to  previous  (before  "nmstatectl  set/edit")
62       state.
63
64       rollback
65              rollback  the  network  state  from  specified  checkpoint file.
66              nmstatectl will take the latest checkpoint  if  not  defined  as
67              argument.
68
69       commit
70              commit  the current network state. nmstatectl will take the lat‐
71              est checkpoint if not defined as argument.
72       version
73              displays nmstate version.
74
75       varlink
76              Initates the nmstate-varlink service in the specified unix  file
77              socket  path  supporting  the libnmstate functions (Show, Apply,
78              Commit and Rollback).  This enables functions to be accessed via
79              varlink command-line tool and client implementations.  Currently
80              the service is limited to using unix file socket address only.
81
82              example: nmstatectl varlink /run/nmstate.so &
83

OPTIONS

85       --json
86              change the output format to JSON.
87
88       --no-verify
89              skip the desired network state verification.
90
91       --no-commit
92              create a checkpoint which later could be used  for  rollback  or
93              commit.  The checkpoint will be the last line of nmstatectl out‐
94              put, example: /org/freedesktop/NetworkManager/Checkpoint/1.
95
96       --memory-only
97              all the changes done will be non persistent, they are  going  to
98              be removed after rebooting.
99
100       --timeout=<TIMEOUT>
101              the user must commit the changes within timeout, or they will be
102              automatically rolled back. Default: 60 seconds.
103
104       --version
105              displays nmstate version.
106

LIMITATIONS

108       * Maximum supported number of interfaces in a single  desire  state  is
109       1000.
110

BUG REPORTS

112       Report        bugs        on        nmstate        GitHub        issues
113       <https://github.com/nmstate/nmstate>.
114

COPYRIGHT

116       License       LGPL-2.1        or        any        later        version
117       <https://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt>.
118