summaryrefslogtreecommitdiffstats
path: root/docs/netctl.1.txt
blob: 9edd74a769aeae959bee9957e270b952da7ff459 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
NETCTL(1)
=========

NAME
----
netctl - Control the netctl network profile manager


SYNOPSIS
--------
*netctl* {*COMMAND*} [+PROFILE+]

*netctl* [--help | --version]


DESCRIPTION
-----------
*netctl* may be used to introspect and control the state of the systemd
services for the network profile manager.


OPTIONS
-------
The following commands are understood:

*list*::
    List all available profiles. Active profiles will be marked with a
    `*'.

*store*::
    Saves which profiles are currently active.

*restore*::
    Loads the profiles that were active during the last invocation of
    `*store*'.

*stop-all*::
    Stops all active network profiles.

*start [+PROFILE+]*::
    Start the network profile specified on the command line.

*stop [+PROFILE+]*::
    Stop the network profile specified on the command line.

*restart [+PROFILE+]*::
    Restart the network profile specified on the command line. If it is
    not started yet, it will be started.

*switch-to [+PROFILE+]*::
    Starts the network profile specified on the command line after
    stopping all profiles that refer to the same interface.

*status [+PROFILE+]*::
    Show terse runtime status information about a profile, followed by
    its most recent log data from the journal.

*enable [+PROFILE+]*::
    Enable the systemd unit for the profile specified. This will create
    a unit configuration file. If the file already exists, the command
    fails. No other profiles than the one specified will be enabled.
    Changes to the general options in a profile specification will not
    propagate to the unit configuration file automatically. After such
    changes, it is necessary to `*reenable*' the profile.

*disable [+PROFILE+]*::
    Disable the systemd unit for the profile specified. This will remove
    the file created by `*enable*' even if it was customized, so be
    carefull.

*reenable [+PROFILE+]*::
    Reenable the systemd unit for the profile specified. This is
    effectively a combination of `*disable*' and `*enable*'.


EXIT STATUS
-----------
On success 0 is returned, a non-zero failure code otherwise.


ENVIRONMENT
-----------
'$NETCTL_DEBUG'::
    If set to +"yes"+, debugging output is generated.
'$NETCTL_STATE_FILE'::
    The location of the state file. Defaults to
    '/var/lib/netctl/netctl.state'.


SEE ALSO
--------
*netctl.profile*(5) *netctl.special*(7) *systemctl*(1)