src/usr.bin/snmp/snmp.1 - diff

Return to snmp.1 CVS log

Up to [local] / src / usr.bin / snmp

Diff for /src/usr.bin/snmp/snmp.1 between version 1.7 and 1.8

version 1.7, 2019/10/03 11:02:26

version 1.8, 2019/10/26 17:43:52

Line 22

.Nd simple SNMP client

.Sh SYNOPSIS

.Nm

.Cm get | getnext

.Cm get | getnext | bulkget

.Op Fl A Ar authpass

.Op Ar options

.Op Fl a Ar digest

.Op Fl c Ar community

.Op Fl E Ar ctxengineid

.Op Fl e Ar secengineid

.Op Fl K Ar localpriv

.Op Fl k Ar localauth

.Op Fl l Ar seclevel

.Op Fl n Ar ctxname

.Op Fl O Cm afnQqSvx

.Op Fl r Ar retries

.Op Fl t Ar timeout

.Op Fl u Ar user

.Op Fl v Ar version

.Op Fl X Ar privpass

.Op Fl x Ar cipher

.Op Fl Z Ar boots , Ns Ar time

.Ar agent

.Ar oid ...

.Nm

.Cm walk

.Cm walk | bulkwalk

.Op Fl A Ar authpass

.Op Ar options

.Op Fl a Ar digest

.Op Fl c Ar community

.Op Fl E Ar ctxengineid

.Op Fl e Ar secengineid

.Op Fl K Ar localpriv

.Op Fl k Ar localauth

.Op Fl l Ar seclevel

.Op Fl n Ar ctxname

.Op Fl O Cm afnQqSvx

.Op Fl r Ar retries

.Op Fl t Ar timeout

.Op Fl u Ar user

.Op Fl v Ar version

.Op Fl X Ar privpass

.Op Fl x Ar cipher

.Op Fl Z Ar boots , Ns Ar time

.Op Fl C Cm cIipt

.Op Fl C Cm E Ar endoid

.Ar agent

.Op Ar oid

.Nm

.Cm bulkget

.Op Fl A Ar authpass

.Op Fl a Ar digest

.Op Fl c Ar community

.Op Fl E Ar ctxengineid

.Op Fl e Ar secengineid

.Op Fl K Ar localpriv

.Op Fl k Ar localauth

.Op Fl l Ar seclevel

.Op Fl n Ar ctxname

.Op Fl O Cm afnQqSvx

.Op Fl r Ar retries

.Op Fl t Ar timeout

.Op Fl u Ar user

.Op Fl v Ar version

.Op Fl X Ar privpass

.Op Fl x Ar cipher

.Op Fl Z Ar boots , Ns Ar time

.Op Fl C Cm n Ns Ar nonrep Ns Cm r Ns Ar maxrep

.Ar agent

.Ar oid ...

.Nm

.Cm bulkwalk

.Op Fl A Ar authpass

.Op Fl a Ar digest

.Op Fl c Ar community

.Op Fl E Ar ctxengineid

.Op Fl e Ar secengineid

.Op Fl K Ar localpriv

.Op Fl k Ar localauth

.Op Fl l Ar seclevel

.Op Fl n Ar ctxname

.Op Fl O Cm afnQqSvx

.Op Fl r Ar retries

.Op Fl t Ar timeout

.Op Fl u Ar user

.Op Fl v Ar version

.Op Fl X Ar privpass

.Op Fl x Ar cipher

.Op Fl Z Ar boots , Ns Ar time

.Op Fl C Cm cipn Ns Ar nonrep Ns Cm r Ns Ar maxrep

.Ar agent

.Op Ar oid

.Nm

.Cm set

.Op Fl A Ar authpass

.Op Ar options

.Op Fl a Ar digest

.Op Fl c Ar community

.Op Fl E Ar ctxengineid

.Op Fl e Ar secengineid

.Op Fl K Ar localpriv

.Op Fl k Ar localauth

.Op Fl l Ar seclevel

.Op Fl n Ar ctxname

.Op Fl O Cm afnQqSvx

.Op Fl r Ar retries

.Op Fl t Ar timeout

.Op Fl u Ar user

.Op Fl v Ar version

.Op Fl X Ar privpass

.Op Fl x Ar cipher

.Op Fl Z Ar boots , Ns Ar time

.Ar agent

.Ar varoid type value

.Oo Ar varoid type value Oc ...

.Nm

.Cm trap

.Op Fl A Ar authpass

.Op Ar options

.Op Fl a Ar digest

.Op Fl c Ar community

.Op Fl E Ar ctxengineid

.Op Fl e Ar secengineid

.Op Fl K Ar localpriv

.Op Fl k Ar localauth

.Op Fl l Ar seclevel

.Op Fl n Ar ctxname

.Op Fl r Ar retries

.Op Fl t Ar timeout

.Op Fl u Ar user

.Op Fl v Ar version

.Op Fl X Ar privpass

.Op Fl x Ar cipher

.Op Fl Z Ar boots , Ns Ar time

.Ar agent uptime trapoid

.Oo Ar varoid type value Oc ...

.Nm

.Cm mibtree

.Op Fl O Cm fnS

.Op Fl O Ar fns

.Sh DESCRIPTION

The

.Nm

utility is a simple SNMP client.

.Pp

The subcommands are as follows:

.Bl -tag -width bulkwalk

.Bl -tag -width Ds

.It Cm get

.It Xo

Retrieve the MIB for

.Nm snmp

.Cm get

.Op Ar options

.Ar agent oid ...

.Xc

Retrieve the varbind for

.Ar oid

from the

.Ar agent .

If more than one

.Ar oid

is specified, retrieve the MIB for each one.

is specified, retrieve the varbind for each one.

.It Cm getnext

.It Xo

Retrieve the MIB that follows

.Nm snmp

.Cm getnext

.Op Ar options

.Ar agent oid ...

.Xc

Retrieve the varbind that follows

.Ar oid

from the

.Ar agent .

If more than one

.Ar oid

is specified, retrieve the MIB following each one of them.

is specified, retrieve the varbind following each one of them.

.It Cm walk

.It Nm snmp Cm walk Oo Ar options Oc Ar agent Op Ar oid

Retrieve all the MIBs that are branches of

Retrieve all the varbinds that are branches of

.Ar oid

from the

.Ar agent .

This uses the

.Cm getnext

subcommand internally and requests a single MIB at a time.

subcommand internally and requests a single varbind at a time.

If no OID is specified it defaults to mib-2

If no

.Ar oid

is specified it defaults to mib-2

.Pq .1.3.6.1.2.1 .

.It Cm bulkget

.It Xo

Retrieve the next 10 MIBs following each

.Nm snmp

.Cm bulkget

.Op Ar options

.Ar agent Ar oid ...

.Xc

Retrieve the next 10 varbinds following each

.Ar oid

from the

.Ar agent .

This command is not available for

.Fl v Cm 1 .

.It Cm bulkwalk

.It Xo

Retrieve all the MIBs from the

.Nm snmp

.Cm bulkwalk

.Op Ar options

.Ar agent

.Op Ar oid

.Xc

Retrieve all the varbinds from the

.Ar agent

that are branches of

.Ar oid .

This uses the

.Cm bulkget

subcommand internally to retrieve multiple MIBs at a time.

subcommand internally to retrieve multiple varbinds at a time.

This command is not available for

.Fl v Cm 1 .

.It Cm set

.It Xo

Set one or more OIDs to a new value.

.Nm snmp

The triple

.Cm set

.Ar varoid , type , value

.Op Ar options

is described in

.Ar agent varoid type value ...

.Sx Data types .

.Xc

.It Cm trap

Set one or more

.Ar varoid to a new

.Ar value .

The format of the

.Ar varoid type value

triple is described in

.Sx Data types ,

below.

.It Xo

.Nm snmp

.Cm trap

.Op Ar options

.Ar agent uptime trapoid

.Op Ar varoid type value ...

.Xc

Send a trap message to the

.Ar agent .

The

Line 221

Line 149

The

.Ar trapoid

is the identification OID used by the trap handler to determine its action.

The triple

.Op Ar varoid , type , value

is described in

.Sx Data types .

This command is not available for

.Fl v Cm 1 .

.It Cm mibtree

.It Nm Cm mibtree Op Fl O Ar fnS

Dump the tree of compiled-in MIB objects.

.El

.Pp

The options are as follows:

The

.Ar options

are as follows:

.Bl -tag -width Ds

.It Fl A Ar authpass

The authentication password for the user.

Line 256

Line 182

This option is only used by

.Fl v Cm 3 .

.It Fl C Ar appopt

Set the application specific

For the

.Cm bulkget ,

.Cm bulkwalk ,

and

.Cm walk

subcommands, set the application specific

.Ar appopt

options by supplying a string of one or more

of the following modifier letters:

.Bl -tag -width Ds

.It Cm c

During a

For

.Cm walk

and

.Cm bulkwalk ,

disable checking the order of MIBs.

On some devices that return MIBs out of order,

this may cause an infinite loop.

.It Cm E Ar endoid

Walk the tree up to but excluding

For

.Cm walk ,

walk the tree up to but excluding

.Ar endoid .

The blank before

.Ar endoid

is mandatory.

.It Cm I

If no branches are found during a

For

.Cm walk ,

do not fall back to returning the original MIB via a

.Cm get

request.

.It Cm i

Before starting a

For

.Cm walk

and

.Cm bulkwalk ,

always do a

.Cm get

Line 292

Line 225

.Ar oid

first.

.It Cm n Ns Ar nonrep

For

.Cm bulkget

and

.Cm bulkwalk ,

Set the non-repeaters field in the request to the non-negative integer

.Ar nonrep .

This causes the first

Line 303

Line 240

No blank is allowed before

.Ar nonrep .

.It Cm p

At the end of a

For

.Cm walk

.Cm bulkwalk ,

show a summary of the total variables received.

also show a summary of the total variables received.

.It Cm r Ns Ar maxrep

Set the max-repetitions field in the request to the positive integer

.Ar maxrep .

For

.Cm bulkget

and

.Cm bulkwalk

.Cm bulkwalk ,

this determines the amount of MIBs to return for each specified OID.

set the max-repetitions field in the request to the positive integer

.Ar maxrep .

This determines the amount of MIBs to return for each specified OID.

This value defaults to 10.

No blank is allowed before

.Ar maxrep .

.It Cm t

Show how long it took to

For

.Cm walk

.Cm walk ,

the entire tree.

Show how long it took to walk the entire tree.

.El

.It Fl c Ar community

Set the

Line 416

Line 353

.It Cm x

Display the varbind string values as hexadecimal strings.

.El

.Pp

The

.Cm mibtree

subcommand may only use the

.Op Fl fnS

output options;

no output options are available for

.Cm trap .

.It Fl r Ar retries

Set the number of

.Ar retries

Line 470

Line 415

The syntax for the

.Ar agent

argument is

.Oo Ar protocol : Oc Ns Ar address

.Oo Ar protocol : Oc Ns Ar address ,

with the follwing forms:

with the following format:

.Bl -column udp6XXXtcp6X address -offset indent

.It Ar protocol Ta Ar address

.It Cm udp | tcp Ta Ar hostname Ns Oo Pf : Ar port Oc |

Line 488

Line 433

.Cm udp

and the default

.Ar port

is 161; except for the

is 161, except for the

.Nm snmp Cm trap

.Cm trap

command which uses 162.

subcommand, which uses 162.

.Cm udpv6

and

.Cm udpipv6

Line 517

Line 462

and

.Ar value .

Supported types are:

.Bl -tag -width 1n

.Bl -tag -width 1n -offset indent

.It Cm a

An IPv4 Address.

.It Cm b