1nmstatectl(8) nmstatectl man page nmstatectl(8)
2
6 nmstatectl - A nmstate command line tool
7
9 nmstatectl show [INTERFACE_NAME] [--json]
10 nmstatectl show [-r, --running-config]
11 nmstatectl set STATE_FILE_PATH [OPTIONS]
12 nmstatectl apply STATE_FILE_PATH [OPTIONS]
13 nmstatectl edit [INTERFACE_NAME] [OPTIONS]
14 nmstatectl gc [STATE_FILE_PATH] [OPTIONS]
15 nmstatectl rollback [CHECKPOINT_PATH]
16 nmstatectl commit [CHECKPOINT_PATH]
17 nmstatectl version
18 nmstatectl varlink [UNIX_FILE_SOCKET_PATH]
19
21 nmstatectl is created for users who want to try out nmstate without us‐
22 ing libnmstate.
23 show
25 Query the current network state. YAML is the default output for‐
26 mat. Use the --json argument to change the output format to
27 JSON. To limit the output state to include certain interfaces
28 only, please specify the interface name. Please be advised,
29 global config like DNS will be included.
30 For multiple interface names, use comma to separate them. You
32 can also use patterns for interface names:
33 * matches everything
34 ? matches any single character
35 [seq] matches any character in seq
36 [!seq] matches any character not in seq
37 For example, to show all interfaces starts with eth:
39 nmstatectl show eth\*
40 # The backslash is required to stop shell expanding '*'
41 to file names.
42 set
44 "Set" command is deprecated. Please consider using "apply" in‐
45 stead.
46 Apply the network state from specified file in YAML or JSON for‐
48 mat. By default, if the network state after state applied is
49 not identical to the desired state, nmstatectl rollbacks to the
50 state before set command. Use the --no-verify argument to skip
51 the verification.
52 apply
54 Apply the network state from specified file in YAML or JSON for‐
55 mat. By default, if the network state after state applied is
56 not identical to the desired state, nmstatectl rollbacks to the
57 state before set command. Use the --no-verify argument to skip
58 the verification.
59 edit
61 nmstatectl will invoke the text editor defined by environment
62 variable EDITOR for editing the network state in YAML format.
63 Once the text editor quit, nmstatectl will try to apply it using
64 "nmstatectl set".
65 If there is any syntax error, you will be asked to edit again.
66 Multiple interfaces are supported, check show for detail.
67 By default, if the network state after state applied is not
69 identical to the desired state, nmstatectl rollbacks to the
70 state before edit command. Use the --no-verify argument to skip
71 the verification.
72 nmstatectl supports manual transaction control which allows user to de‐
74 cide whether rollback to previous (before "nmstatectl set/edit") state.
75 rollback
77 rollback the network state from specified checkpoint file. nm‐
78 statectl will take the latest checkpoint if not defined as argu‐
79 ment.
80 gc
82 Generates configuration files for specified network state
84 file(s). The output will be dictinary with plugin name as key
85 and an tuple as value. The tuple will holding configuration
86 file name and configuration content.
87 The generated configuration is not saved into system, users have
89 to do it by themselves after refering to the network backend.
90 commit
92 commit the current network state. nmstatectl will take the lat‐
93 est checkpoint if not defined as argument.
94 version
95 displays nmstate version.
96 varlink
98 Initates the nmstate-varlink service in the specified unix file
99 socket path supporting the libnmstate functions (Show, Apply,
100 Commit and Rollback). This enables functions to be accessed via
101 varlink command-line tool and client implementations. Currently
102 the service is limited to using unix file socket address only.
103 example: nmstatectl varlink /run/nmstate.so &
105
107 --json
108 change the output format to JSON.
109 -r, --running-config
111 Showing the running network configuration.
112 -s, --show-secrets
114 Showing with the secrets. By default, nmstate is masking the
115 passwords by <_password_hid_by_nmstate>.
116 --no-verify
119 skip the desired network state verification.
120 --no-commit
122 create a checkpoint which later could be used for rollback or
123 commit. The checkpoint will be the last line of nmstatectl out‐
124 put, example: /org/freedesktop/NetworkManager/Checkpoint/1.
125 --memory-only
127 all the changes done will be non persistent, they are going to
128 be removed after rebooting.
129 --timeout=<TIMEOUT>
131 the user must commit the changes within timeout, or they will be
132 automatically rolled back. Default: 60 seconds.
133 --version
135 displays nmstate version.
136
138 * Maximum supported number of interfaces in a single desire state is
139 1000.
140
142 Report bugs on nmstate GitHub issues <https://github.com/nmstate/nm‐
143 state>.
144
146 License LGPL-2.1 or any later version <https://www.gnu.org/li‐
147 censes/old-licenses/lgpl-2.1.txt>.
148
150 NetworkManager(8)
1511.1.0 July 27, 2021 nmstatectl(8)