Layer5.Dhcp.SessionInfo Class Reference

Class containing the info about the DHCPSession. More...

Methods
	Ack.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Ack message is received. More...
	Description.Get
	Returns a textual description of the object.
	Discover.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Discover message is sent. More...
	Lease.GiAddress.Get
	Returns the ipAddress of the relay agent, used in booting via a relay agent. More...
	Lease.Leasetime.Get
	Returns IP Address lease time. More...
	Lease.Options.Get
	Returns a list if received DHCPOptions. More...
	Lease.ServerAddress.Get
	Returns the ipAddress of the DHCPServer. More...
	Lease.SiAddress.Get
	Returns the ipAddress of next server to use in bootstrap. More...
	Offer.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Offer message is received. More...
	Parent.Get
	Returns the parent object.
	Refresh.Timestamp.Get
	Returns the timestamp when the counters of this object where last refreshed. More...
	Refresh
	Refresh the info. More...
	Request.Timestamp.Last.Get
	Returns the timestamp when the last DHCP Request message is sent. More...
	Rx.Get
	Returns the number of DHCPMessages recieved. More...
	Tx.Get
	Returns the number of DHCPMessages transmitted. More...

Class overview

Class containing the info about the DHCPSession.

This class represents the session info gathered from a DHCPSession. It will contain counters of the amount of DHCPMessages transmitted and received. It also contains some values of the obtained lease ( leasetime, GiAddr, SiAddr, OptionValues )

Definition at line 10595 of file api.tcl.

Method documentation

Layer5.Dhcp.SessionInfo::Ack.Timestamp.Last.Get

Returns the timestamp when the last DHCP Ack message is received.

Since

2.11.2

Returns

The timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the timestamp when the last ACK is received.

$DHCPSessionInfo Ack.Timestamp.Last.Get

Returns:

3600000000000 

Definition at line 10609 of file api.tcl.

Layer5.Dhcp.SessionInfo::Discover.Timestamp.Last.Get

Returns the timestamp when the last DHCP Discover message is sent.

Since

2.11.2

Returns

The timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the timestamp when the last DISCOVER is sent.

$DHCPSessionInfo Discover.Timestamp.Last.Get

Returns:

3600000000000 

Definition at line 10628 of file api.tcl.

Layer5.Dhcp.SessionInfo::Lease.GiAddress.Get

Returns the ipAddress of the relay agent, used in booting via a relay agent.

Returns

Relay agent IpAddress

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Lease.GiAddress.Get

Returns:

10.3.3.1 

Definition at line 10640 of file api.tcl.

Layer5.Dhcp.SessionInfo::Lease.Leasetime.Get

Returns IP Address lease time.

Returns

The leasetime in NanoSeconds

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the given lease time

$DHCPSessionInfo Lease.Leasetime.Get

Returns:

3600000000000 

Definition at line 10652 of file api.tcl.

Layer5.Dhcp.SessionInfo::Lease.Options.Get

Returns a list if received DHCPOptions.

Returns

List of DHCPOptions in the form of OptionNumber-Value

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Lease.Options.Get

Returns:

1 {ff ff ff 0 } 3 {a 8 2 1 } 51 {0 0 0 5 } 53 {5 } 54 {a 8 2 1 } 

Definition at line 10664 of file api.tcl.

Layer5.Dhcp.SessionInfo::Lease.ServerAddress.Get

Returns the ipAddress of the DHCPServer.

This address is parsed out of DHCPServerIdentifier option ( Option 54 )

Returns

Number of DHCPMessages transmitted

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Lease.ServerAddress.Get

Returns:

10.1.1.254 

Definition at line 10678 of file api.tcl.

Layer5.Dhcp.SessionInfo::Lease.SiAddress.Get

Returns the ipAddress of next server to use in bootstrap.

Returns

next server IpAddress

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Lease.SiAddress.Get

Returns:

10.1.1.2 

Definition at line 10690 of file api.tcl.

Layer5.Dhcp.SessionInfo::Offer.Timestamp.Last.Get

Returns the timestamp when the last DHCP Offer message is received.

Since

2.11.2

Returns

The timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the timestamp when the last OFFER is received.

$DHCPSessionInfo Offer.Timestamp.Last.Get

Returns:

3600000000000 

Definition at line 10704 of file api.tcl.

Layer5.Dhcp.SessionInfo::Refresh

Refresh the info.

Only when executing this method the counters are updated

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

$DHCPSessionInfo Refresh

Definition at line 10733 of file api.tcl.

Layer5.Dhcp.SessionInfo::Refresh.Timestamp.Get

Returns the timestamp when the counters of this object where last refreshed.

Returns

RefreshTimestamp in nanoseconds

Example

$dhcpSessionInfo Refresh.Timestamp.Get

Returns:

1432805398000000000 

Definition at line 10721 of file api.tcl.

Layer5.Dhcp.SessionInfo::Request.Timestamp.Last.Get

Returns the timestamp when the last DHCP Request message is sent.

Since

2.11.2

Returns

The timestamp in nanoseconds since epoch

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the timestamp when the last REQUEST is sent.

$DHCPSessionInfo Request.Timestamp.Last.Get

Returns:

3600000000000 

Definition at line 10747 of file api.tcl.

Layer5.Dhcp.SessionInfo::Rx.Get

Returns the number of DHCPMessages recieved.

Returns

Number of DHCPMessages received

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Rx.Get

Returns:

2 

Definition at line 10759 of file api.tcl.

Layer5.Dhcp.SessionInfo::Tx.Get

Returns the number of DHCPMessages transmitted.

Returns

Number of DHCPMessages transmitted

Example

set DHCPSessionInfo [ $DHCPSession Session.Info.Get ]

Returns:

<Layer5::Dhcp::SessionInfo object> 

Get the number of DHCPMessage received

$DHCPSessionInfo Tx.Get

Returns:

2 

Definition at line 10771 of file api.tcl.