← Back to branch summary

~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/snmpusm.1.def

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-12-08 14:59:50 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20071208145950-u1tykhpw56nyzqik
Tags: 5.4.1~dfsg-4ubuntu1
* Merge from debian unstable.
* Remaining Ubuntu changes:
  - Remove stop links from rc0 and rc6
  - Munge Maintainer field as per spec.
* Ubuntu changes dropped:
  - Symlink common files between the packages, CDBS ought to handle that
    for us automatically.
* The latest Debian changes has dropped history from the changelog. Slot in
  the Ubuntu changes as best I can. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/snmpusm.1.def
4
4
snmpusm - creates and maintains SNMPv3 users on a network entity
5
5
.SH SYNOPSIS
6
6
.B snmpusm
7
 
[COMMON OPTIONS] [-CE ENGINE-ID]
 
7
[COMMON OPTIONS]
8
8
.B create
9
9
USER [CLONEFROM-USER]
10
10
.br
11
11
.B snmpusm
12
 
[COMMON OPTIONS] [-CE ENGINE-ID]
 
12
[COMMON OPTIONS]
13
13
.B delete
14
14
USER
15
15
.br
16
16
.B snmpusm
17
 
[COMMON OPTIONS] [-CE ENGINE-ID]
 
17
[COMMON OPTIONS]
18
18
.B cloneFrom
19
19
USER CLONEFROM-USER
20
20
.br
21
21
.B snmpusm
22
 
[COMMON OPTIONS] [-CE ENGINE-ID] [-Ca] [-Cx]
 
22
[COMMON OPTIONS] [-Ca] [-Cx]
23
23
.B passwd
24
24
OLD-PASSPHRASE NEW-PASSPHRASE [USER]
25
25
.br
26
26
.B snmpusm
27
 
[COMMON OPTIONS] [-CE ENGINE-ID] <-Ca | -Cx> -Ck
 
27
[COMMON OPTIONS] <-Ca | -Cx> -Ck
28
28
.B passwd
29
29
OLD-KEY-OR-PASSPHRASE NEW-KEY-OR-PASSPHRASE [USER]
30
30
.br
31
31
.B snmpusm
32
 
[COMMON OPTIONS] [-CE ENGINE-ID] [-Ca] [-Cx]
33
 
.B changekey [USER]
 
32
[COMMON OPTIONS] [-Ca] [-Cx]
 
33
.B changekey
 
34
[USER]
34
35
 
35
36
.SH DESCRIPTION
36
37
.B snmpusm
42
43
configured on a running SNMP agent.
43
44
 
44
45
.SH OPTIONS
 
46
Common options for all
 
47
.B snmpusm
 
48
commands:
45
49
.TP
46
50
.BI -CE " ENGINE-ID"
47
51
Set usmUserEngineID to be used as part of the index of the usmUserTable.
48
52
Default is to use the contextEngineID (set via -E or probed) as the 
49
53
usmUserEngineID.
50
54
.TP
 
55
.BI -Cp " STRING"
 
56
Set the usmUserPublic value of the (new) user to the specified STRING.
 
57
.PP
 
58
Options for the
 
59
.B passwd 
 
60
and
 
61
.B changekey
 
62
commands:
 
63
.TP
51
64
.BI -Ca
52
65
Change the authentication key.
53
66
.TP
56
69
.TP
57
70
.BI -Ck
58
71
Allows to use localized key (must start with 0x) instead of passphrase.
59
 
When this option is used, either the -Ca or -Cx (but not both) option must also
 
72
When this option is used, either the -Ca or -Cx option (but not both) must also
60
73
be used.
61
74
 
62
75
.SH CREATING USERS
64
77
An unauthenticated SNMPv3 user can be created using the command
65
78
.IP
66
79
.B snmpusm
67
 
[-CE ENGINE-ID] create USER
 
80
[OPTIONS] create USER
68
81
.PP
69
82
This constructs an (inactive) entry in the usmUserTable,
70
83
with no authentication or privacy settings.
77
90
user, using the command
78
91
.IP
79
92
.B snmpusm
80
 
[-CE ENGINE-ID] cloneFrom USER CLONEFROM-USER
 
93
[OPTIONS] cloneFrom USER CLONEFROM-USER
81
94
.PP
82
95
The USER entry then inherits the same authentication and privacy
83
96
settings (including pass phrases) as the CLONEFROM user.
86
99
These two steps can be combined into one, by using the command
87
100
.IP
88
101
.B snmpusm
89
 
[-CE ENGINE-ID] create USER CLONEFROM-USER
 
102
[OPTIONS] create USER CLONEFROM-USER
90
103
 
91
104
.PP
92
105
The two forms of the
122
135
A user can be deleted from the usmUserTable using the command
123
136
.IP
124
137
.B snmpusm
125
 
[-CE ENGINE-ID] delete USER
 
138
[OPTIONS] delete USER
126
139
 
127
140
.SH CHANGING PASS PHRASES
128
141
User profiles contain private keys that are never
133
146
This uses the command
134
147
.IP
135
148
.B snmpusm
136
 
[-CE ENGINE-ID] [-Ca] [-Cx] passwd OLD-PASSPHRASE NEW-PASSPHRASE [USER]
 
149
[OPTIONS] [-Ca] [-Cx] passwd OLD-PASSPHRASE NEW-PASSPHRASE [USER]
137
150
 
138
151
.PP
139
152
After cloning a new user entry from the appropriate template,
148
161
 
149
162
.IP
150
163
.B snmpusm
151
 
[-CE ENGINE-ID] [-Ca] [-Cx] changekey [USER]
 
164
[OPTIONS] [-Ca] [-Cx] changekey [USER]
152
165
 
153
166
.PP
154
167
This command changes the key in a perfect-forward-secrecy compliant
172
185
 
173
186
.IP
174
187
.B snmpusm
175
 
[-CE ENGINE-ID] <-Ca | -Cx> -Ck passwd OLD-KEY-OR-PASSPHRASE NEW-KEY-OR-PASSPHRASE [USER]
 
188
[OPTIONS] <-Ca | -Cx> -Ck passwd OLD-KEY-OR-PASSPHRASE NEW-KEY-OR-PASSPHRASE [USER]
176
189
 
177
190
.PP
178
191
Either the -Ca or the -Cx option must be specified.  The OLD-KEY-OR-PASSPHRASE