Improve man page
Marcos Fouces
3 years ago
| 12 | 12 | Braa implements its OWN snmp stack, so it does NOT need any SNMP libraries like net-snmp. The implementation is very dirty, supports only several data |
| 13 | 13 | types, and in any case cannot be stated 'standard-conforming'! It was designed to be fast, and it is fast. For this reason (well, and also because of my |
| 14 | 14 | laziness ;), there is no ASN.1 parser in braa - you HAVE to know the numerical values of OID's (for instance .1.3.6.1.2.1.1.5.0 instead of system.sysName.0). |
| 15 | ||
| 16 | 15 | .SH OPTIONS |
| 17 | 16 | .TP |
| 18 | 17 | .B \-h |
| 44 | 43 | .TP |
| 45 | 44 | .B \-r <rc> |
| 46 | 45 | Retry count (default: 3). |
| 47 | ||
| 48 | 46 | .SH QUERY FORMATS |
| 49 | 47 | .TP |
| 50 | 48 | .B GET: [community@]iprange[:port]:oid[/id] |
| 52 | 50 | .B WALK: [community@]iprange[:port]:oid.*[/id] |
| 53 | 51 | .TP |
| 54 | 52 | .B SET: [community@]iprange[:port]:oid=value[/id] |
| 55 | ||
| 56 | 53 | .SH EXAMPLES |
| 57 | 54 | .TP |
| 58 | 55 | .B $braa public@10.253.101.1:161:.1.3.6.* |
| 60 | 57 | .TP |
| 61 | 58 | .B $braa 10.253.101.1-10.253.101.254:.1.3.6.1.2.1.1.6.0 |
| 62 | 59 | Query the whole subnet 10.53.101/24 of for system.sysLocation.0 |
| 63 | ||
| 64 | 60 | .TP |
| 65 | 61 | .B $braa private@10.253.101.1:.1.3.6.1.2.1.1.6.0=sMy network |
| 66 | 62 | Tries to set the value of system.sysLocation.0 to "My network" at host 10.253.101.1 |
| 63 | .SH BUGS AND LIMITATIONS | |
| 64 | .IP * | |
| 65 | The only supported datatypes are: integer (gauge, counter, timeticks, etc.) counter64, string, ipaddress, OID. Of course you are free to modify braaasn.c/braaasn.h to support more types... | |
| 66 | .IP * | |
| 67 | braa will never send more than 1500 bytes (or a single packet) to a host in a single try. Thus the number of queries that might be sent to a single host is limited. Additionally, if you reach the limit by specifying too many queries, braa will terminate the whole scanning process... I can't tell what the limit exactly is, it just depends on many factors (mainly, the length of OIDs), anyway, 15 queries per hosts sounds dangerous, and better try not to exceed this number. | |
| 68 | .IP * | |
| 69 | It is impossible to specify FQDN hostnames - you always have to give IP addresses of hosts... well, I think it'll be corrected in future versions, if there will be ones. | |