Differences between revisions 1 and 2
Revision 1 as of 2006-11-15 17:14:48
Size: 2345
Editor: JaapKeuter
Comment: Create new protocol page for OMAPI
Revision 2 as of 2008-04-12 17:50:00
Size: 2361
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 4: Line 4:
The Object Management API is an interface on the [http://www.isc.org ISC] [http://www.isc.org/index.pl?/sw/dhcp/ DHCP] server. It provides access to the objects (leases, hosts or groups) stored in its database. The Object Management API is an interface on the [[http://www.isc.org|ISC]] [[http://www.isc.org/index.pl?/sw/dhcp/|DHCP]] server. It provides access to the objects (leases, hosts or groups) stored in its database.
Line 12: Line 12:
 * ["TCP"]: Typically, OMAPI uses ["TCP"] as its transport protocol. The well known TCP port for OMAPI traffic is 7911.  * [[TCP]]: Typically, OMAPI uses [[TCP]] as its transport protocol. The well known TCP port for OMAPI traffic is 7911.
Line 48: Line 48:
 * attachment:SampleCaptures/OMAPI.pcap  * [[attachment:SampleCaptures/OMAPI.pcap]]
Line 51: Line 51:
A complete list of OMAPI display filter fields can be found in the [http://www.wireshark.org/docs/dfref/o/omapi.html display filter reference] A complete list of OMAPI display filter fields can be found in the [[http://www.wireshark.org/docs/dfref/o/omapi.html|display filter reference]]
Line 58: Line 58:
You cannot directly filter OMAPI protocols while capturing. However, if you know the ["TCP"] port used (see above), you can filter on that one. You cannot directly filter OMAPI protocols while capturing. However, if you know the [[TCP]] port used (see above), you can filter on that one.
Line 65: Line 65:
 * [http://ftp.isc.org/isc/dhcp/ DHCP source code] - contains api+protocol description.
 * [http://www.google.com/search?q=man%20omapi man omapi] - A OMAPI man page.
 * [http://www.google.com/search?q=man%20omshell man omshell] - The simple CLI interface for OMAPI.
 * [[http://ftp.isc.org/isc/dhcp/|DHCP source code]] - contains api+protocol description.
 * [[http://www.google.com/search?q=man%20omapi|man omapi]] - A OMAPI man page.
 * [[http://www.google.com/search?q=man%20omshell|man omshell]] - The simple CLI interface for OMAPI.

Object Management API (OMAPI)

The Object Management API is an interface on the ISC DHCP server. It provides access to the objects (leases, hosts or groups) stored in its database.

History

The API was introduced by the ISC in version 3 of the DHCP software.

Protocol dependencies

  • TCP: Typically, OMAPI uses TCP as its transport protocol. The well known TCP port for OMAPI traffic is 7911.

Example traffic

Frame 755 (129 bytes on wire, 129 bytes captured)
Ethernet II, Src: Intel_bf:3b:59 (00:90:27:bf:3b:59), Dst: Cisco_f2:03:78 (00:d0:bc:f2:03:78)
Internet Protocol, Src: 192.168.21.229 (192.168.21.229), Dst: 192.168.1.251 (192.168.1.251)
Transmission Control Protocol, Src Port: 33156 (33156), Dst Port: 7911 (7911), Seq: 3915, Ack: 12060, Len: 63
ISC Object Management API, Opcode: Open
    Authentication ID: 0
    Authentication length: 0
    Opcode: Open (1)
    Handle: 0
    ID: 1804289445
    Response ID: 0
    Message name length: 4
    Message name: type
    Message value length: 5
    Message value: lease
    Message end tag
    Object name length: 10
    Object name: ip-address
    Object value length: 4
    Object value: C0A8093F
    Message end tag

Wireshark

The OMAPI dissector is fully functional.

Preference Settings

There are no preferences for this protocol dissector

Example capture file

Display Filter

A complete list of OMAPI display filter fields can be found in the display filter reference

  • Show only the OMAPI based traffic:

     omapi 

Capture Filter

You cannot directly filter OMAPI protocols while capturing. However, if you know the TCP port used (see above), you can filter on that one.

  • Capture only the OMAPI traffic over the default port (7911):

     tcp port 7911 

Discussion

Object_Management_API (last edited 2008-04-12 17:50:00 by localhost)