The Layer5.Dhcpv6 is the entry point to configure the DHCPv6 client behavior of a ByteBlowerPort. More...

Methods
	Confirm.InitialTimeout.Get
	Getter for <InitialTimeout> when in the Confirm state. More...

	Confirm.InitialTimeout.Set value
	Setter for <InitialTimeout> when in the Confirm state. More...

	Confirm.MaxDuration.Get
	Getter for <MaxDuration> when in the Confirm state. More...

	Confirm.MaxDuration.Set value
	Setter for <MaxDuration> when in the Confirm state. More...

	Confirm.MaxRetries.Get
	Getter for <MaxRetries> when in the Confirm state. More...

	Confirm.MaxRetries.Set value
	Setter for <MaxRetries> when in the Confirm state. More...

	Confirm.MaxTimeout.Get
	Getter for <MaxTimeout> when in the Confirm state. More...

	Confirm.MaxTimeout.Set value
	Setter for <MaxTimeout> when in the Confirm state. More...

	Description.Get
	Returns a textual description of the object.

	Destructor

	Inform.InitialTimeout.Get
	Getter for <InitialTimeout> when in the Inform state. More...

	Inform.InitialTimeout.Set value
	Setter for <InitialTimeout> when in the Inform state. More...

	Inform.MaxDuration.Get
	Getter for <MaxDuration> when in the Inform state. More...

	Inform.MaxDuration.Set value
	Setter for <MaxDuration> when in the Inform state. More...

	Inform.MaxRetries.Get
	Getter for <MaxRetries> when in the Inform state. More...

	Inform.MaxRetries.Set value
	Setter for <MaxRetries> when in the Inform state. More...

	Inform.MaxTimeout.Get
	Getter for <MaxTimeout> when in the Inform state. More...

	Inform.MaxTimeout.Set value
	Setter for <MaxTimeout> when in the Inform state. More...

	Parent.Get
	Returns the parent object.

	Perform.Async
	This method will bootstrap the DHCPv6 process. More...

	Perform
	This method will bootstrap the DHCPv6 process. More...

	Release.Enable bool
	When a ByteBlowerPort is destructed and this port has performed DHCP, such a port should release its address. If this behavior is prefered, then this should be done by using the Release.Enable method to inidicate the ByteBlowerPort should release its address if possible. A ByteBlowerPort is able to release its address at destruction time if the destination mac address is in the ByteBlowerPort's ARP cache. If not, the DHCP release messages will not be sent out, because it could delay the whole cleanup. More...

	Release.IsEnabled
	When a ByteBlowerPort is destructed and this port has performed DHCP, it should release its address. If this behavior is prefered, then this should be done by using the Release.Enable method to inidicate the ByteBlowerPort should release its address if possible. A ByteBlowerPort is able to release its address at destruction time if the destination mac address is in the ByteBlowerPort's ARP cache. If not, the DHCP release messages will not be sent out, because it could delay the whole cleanup. More...

	Release
	This method will release the address previously received using DHCP. After this, the address will not be used anymore by the ByteBlower port and the DHCP server can reuse the address for other DHCP clients. Offcourse, packets sent by the ByteBlower port as part of Tx.Streams can still use the address. More...

	Renew.InitialTimeout.Get
	Getter for <InitialTimeout> when in the Renew state. More...

	Renew.InitialTimeout.Set value
	Setter for <InitialTimeout> when in the Renew state. More...

	Renew.MaxDuration.Get
	Getter for <MaxDuration> when in the Renew state. More...

	Renew.MaxDuration.Set value
	Setter for <MaxDuration> when in the Renew state. More...

	Renew.MaxRetries.Get
	Getter for <MaxRetries> when in the Renew state. More...

	Renew.MaxRetries.Set value
	Setter for <MaxRetries> when in the Renew state. More...

	Renew.MaxTimeout.Get
	Getter for <MaxTimeout> when in the Renew state. More...

	Renew.MaxTimeout.Set value
	Setter for <MaxTimeout> when in the Renew state. More...

	Request.InitialTimeout.Get
	Getter for <InitialTimeout> when in the Request state. More...

	Request.InitialTimeout.Set value
	Setter for <InitialTimeout> when in the Request state. More...

	Request.MaxDuration.Get
	Getter for <MaxDuration> when in the Request state. More...

	Request.MaxDuration.Set value
	Setter for <MaxDuration> when in the Request state. More...

	Request.MaxRetries.Get
	Getter for <MaxRetries> when in the Request state. More...

	Request.MaxRetries.Set value
	Setter for <MaxRetries> when in the Request state. More...

	Request.MaxTimeout.Get
	Getter for <MaxTimeout> when in the Request state. More...

	Request.MaxTimeout.Set value
	Setter for <MaxTimeout> when in the Request state. More...

	Session.Info.Get
	Returns the sessionInfo object for this DHCP Session. More...

	Solicit.InitialTimeout.Get
	Getter for <InitialTimeout> when in the Solicit state. More...

	Solicit.InitialTimeout.Set value
	Setter for <InitialTimeout> when in the Solicit state. More...

	Solicit.MaxDuration.Get
	Getter for <MaxDuration> when in the Solicit state. More...

	Solicit.MaxDuration.Set value
	Setter for <MaxDuration> when in the Solicit state. More...

	Solicit.MaxRetries.Get
	Getter for <MaxRetries> when in the Solicit state. More...

	Solicit.MaxRetries.Set value
	Setter for <MaxRetries> when in the Solicit state. More...

	Solicit.MaxTimeout.Get
	Getter for <MaxTimeout> when in the Solicit state. More...

	Solicit.MaxTimeout.Set value
	Setter for <MaxTimeout> when in the Solicit state. More...

Class overview

The Layer5.Dhcpv6 is the entry point to configure the DHCPv6 client behavior of a ByteBlowerPort.

A ByteBlowerPort can perform DHCPv6 for configuring IP addresses, IP prefixes and/or other parameters required to operate on an IPv6 network.

A ByteBlowerPort can acquire and combine IP addresses using stateless address autoconfiguration, or by using DHCPv6 or static configuration. DHCP tends to be preferred at sites where central management of hosts is valued; stateless autoconfiguration does not require any sort of central management, and is therefore preferable in networks where no management is readily available, such as a typical home network.

IPv6 hosts that use stateless autoconfiguration may require information other than an IP address. DHCPv6 can be used to acquire this information, even though it is not being used to configure IP addresses.

DHCPv6 can also be used to deligate prefix information to e.g. home gateways. Such gateways require not only an IPv6 address for use in communicating with upstream routers, but also an IPv6 prefix for use in configuring devices on the downstream side of the router. DHCPv6 Prefix delegation provides a mechanism for configuring such routers. ByteBlower currently doesn't support prefix delegation yet, but can only be used as a host.

ByteBlower allows full control of the timing parameters of the DHCPv6 client side. The retransmission policy used for DHCPv6 is the one suggested in the RFC 3315.

Definition at line 11293 of file api.tcl.

Method documentation

Layer5.Dhcpv6::Confirm.InitialTimeout.Get

Getter for <InitialTimeout> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <InitialTimeout>.

Returns: Current value for <InitialTimeout> for stage Confirm. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <InitialTimeout> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.InitialTimeout.Get

Returns:

1000000000

Definition at line 11307 of file api.tcl.

Layer5.Dhcpv6::Confirm.InitialTimeout.Set			value

Setter for <InitialTimeout> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <InitialTimeout>.

Parameters

value New value for <InitialTimeout> for stage Confirm. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <InitialTimeout> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.InitialTimeout.Set 2s

Definition at line 11323 of file api.tcl.

Layer5.Dhcpv6::Confirm.MaxDuration.Get

Getter for <MaxDuration> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxDuration>.

Returns: Current value for <MaxDuration> for stage Confirm. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxDuration> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.MaxDuration.Get

Returns:

1000000000

Definition at line 11337 of file api.tcl.

Layer5.Dhcpv6::Confirm.MaxDuration.Set			value

Setter for <MaxDuration> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxDuration>.

Parameters

value New value for <MaxDuration> for stage Confirm. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxDuration> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.MaxDuration.Set 2s

Definition at line 11353 of file api.tcl.

Layer5.Dhcpv6::Confirm.MaxRetries.Get

Getter for <MaxRetries> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxRetries>.

Returns: Current value for <MaxRetries> for stage Confirm. This is a positive integer value, indicating the number of times the ByteBlowerPort will resend its Confirm message.

Example

This example demonstrates how to get the value for <MaxRetries> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.MaxRetries.Get

Returns:

Definition at line 11367 of file api.tcl.

Layer5.Dhcpv6::Confirm.MaxRetries.Set			value

Setter for <MaxRetries> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxRetries>.

Parameters

value New value for <MaxRetries> for stage Confirm. This must be a positive integer value, indicating the number of times the ByteBlowerPort will resend its Confirm message.

Example

This example demonstrates how to set the value for <MaxRetries> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.MaxRetries.Set 5

Definition at line 11383 of file api.tcl.

Layer5.Dhcpv6::Confirm.MaxTimeout.Get

Getter for <MaxTimeout> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxTimeout>.

Returns: Current value for <MaxTimeout> for stage Confirm. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxTimeout> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.MaxTimeout.Get

Returns:

1000000000

Definition at line 11397 of file api.tcl.

Layer5.Dhcpv6::Confirm.MaxTimeout.Set			value

Setter for <MaxTimeout> when in the Confirm state.

In the Confirm state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Confirm state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxTimeout>.

Parameters

value New value for <MaxTimeout> for stage Confirm. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxTimeout> in the Confirm stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Confirm.MaxTimeout.Set 2s

Definition at line 11413 of file api.tcl.

Layer5.Dhcpv6::Inform.InitialTimeout.Get

Getter for <InitialTimeout> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <InitialTimeout>.

Returns: Current value for <InitialTimeout> for stage Inform. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <InitialTimeout> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.InitialTimeout.Get

Returns:

1000000000

Definition at line 11437 of file api.tcl.

Layer5.Dhcpv6::Inform.InitialTimeout.Set			value

Setter for <InitialTimeout> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <InitialTimeout>.

Parameters

value New value for <InitialTimeout> for stage Inform. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <InitialTimeout> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.InitialTimeout.Set 2s

Definition at line 11453 of file api.tcl.

Layer5.Dhcpv6::Inform.MaxDuration.Get

Getter for <MaxDuration> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxDuration>.

Returns: Current value for <MaxDuration> for stage Inform. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxDuration> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.MaxDuration.Get

Returns:

1000000000

Definition at line 11467 of file api.tcl.

Layer5.Dhcpv6::Inform.MaxDuration.Set			value

Setter for <MaxDuration> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxDuration>.

Parameters

value New value for <MaxDuration> for stage Inform. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxDuration> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.MaxDuration.Set 2s

Definition at line 11483 of file api.tcl.

Layer5.Dhcpv6::Inform.MaxRetries.Get

Getter for <MaxRetries> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxRetries>.

Returns: Current value for <MaxRetries> for stage Inform. This is a positive integer value, indicating the number of times the ByteBlowerPort will resend its Inform message.

Example

This example demonstrates how to get the value for <MaxRetries> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.MaxRetries.Get

Returns:

Definition at line 11497 of file api.tcl.

Layer5.Dhcpv6::Inform.MaxRetries.Set			value

Setter for <MaxRetries> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxRetries>.

Parameters

value New value for <MaxRetries> for stage Inform. This must be a positive integer value, indicating the number of times the ByteBlowerPort will resend its Inform message.

Example

This example demonstrates how to set the value for <MaxRetries> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.MaxRetries.Set 5

Definition at line 11511 of file api.tcl.

Layer5.Dhcpv6::Inform.MaxTimeout.Get

Getter for <MaxTimeout> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxTimeout>.

Returns: Current value for <MaxTimeout> for stage Inform. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxTimeout> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.MaxTimeout.Get

Returns:

1000000000

Definition at line 11525 of file api.tcl.

Layer5.Dhcpv6::Inform.MaxTimeout.Set			value

Setter for <MaxTimeout> when in the Inform state.

In the Inform state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Inform state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxTimeout>.

Parameters

value New value for <MaxTimeout> for stage Inform. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxTimeout> in the Inform stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Inform.MaxTimeout.Set 2s

Definition at line 11541 of file api.tcl.

Layer5.Dhcpv6::Perform

This method will bootstrap the DHCPv6 process.

The client will start with sending DHCPv6 solicit messages. This is a synchronous call, so the full DHCPv6 solicit and request will be done once this call returns, or an error have occurred.

Returns: This method will return nothing, but will return after DHCP is performed successfully. If DHCP fails, and exception is thrown.

Exceptions

ByteBlower.Exception.API.DHCPFailed Thrown if no offer was received during the DHCP solicit stage or no DHCPReply during DHCPRequest stage

Example

This example will start the DHCPv6 process.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Perform

Definition at line 11578 of file api.tcl.

Layer5.Dhcpv6::Perform.Async

This method will bootstrap the DHCPv6 process.

The client will start with sending DHCPv6 solicit messages. This is a asynchronous call, so it will return immediately. If you want to see if there an exception occured during this async, call the perform method.

Returns: This method will return nothing and return immediately

Since: API 2.2

Example

This example will start the DHCPv6 process.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Perform.Async

Definition at line 11562 of file api.tcl.

Layer5.Dhcpv6::Release

This method will release the address previously received using DHCP. After this, the address will not be used anymore by the ByteBlower port and the DHCP server can reuse the address for other DHCP clients. Offcourse, packets sent by the ByteBlower port as part of Tx.Streams can still use the address.

Returns: This method will return nothing, but will return after DHCP Release is performed

Example

This example will release the DHCP address.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Release

Definition at line 11618 of file api.tcl.

Layer5.Dhcpv6::Release.Enable			bool

When a ByteBlowerPort is destructed and this port has performed DHCP, such a port should release its address. If this behavior is prefered, then this should be done by using the Release.Enable method to inidicate the ByteBlowerPort should release its address if possible. A ByteBlowerPort is able to release its address at destruction time if the destination mac address is in the ByteBlowerPort's ARP cache. If not, the DHCP release messages will not be sent out, because it could delay the whole cleanup.

If you want to force the release of an address received through DHCP, use Layer5.Dhcp::Release.

Parameters

bool	Boolean to enable or disable the release of the address at the end of the test. true Will enable the automatic release of the address at the end of the test. false Will disable the automatic release of the address at the end of the test. Default: `true`

Example

This example will disable the automatic release of the DHCP address at the end of the test.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Release.Enable false

Definition at line 11592 of file api.tcl.

Layer5.Dhcpv6::Release.IsEnabled

When a ByteBlowerPort is destructed and this port has performed DHCP, it should release its address. If this behavior is prefered, then this should be done by using the Release.Enable method to inidicate the ByteBlowerPort should release its address if possible. A ByteBlowerPort is able to release its address at destruction time if the destination mac address is in the ByteBlowerPort's ARP cache. If not, the DHCP release messages will not be sent out, because it could delay the whole cleanup.

If you want to force the release of an address received through DHCP, use Layer5.Dhcp::Release.

Returns: If the port will release its IP at destruction

Example

This example will disable the automatic release of the DHCP address at the end of the test.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Release.IsEnabled

Returns:

true

Definition at line 11606 of file api.tcl.

Layer5.Dhcpv6::Renew.InitialTimeout.Get

Getter for <InitialTimeout> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <InitialTimeout>.

Returns: Current value for <InitialTimeout> for stage Renew. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <InitialTimeout> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.InitialTimeout.Get

Returns:

1000000000

Definition at line 11632 of file api.tcl.

Layer5.Dhcpv6::Renew.InitialTimeout.Set			value

Setter for <InitialTimeout> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <InitialTimeout>.

Parameters

value New value for <InitialTimeout> for stage Renew. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <InitialTimeout> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.InitialTimeout.Set 2s

Definition at line 11648 of file api.tcl.

Layer5.Dhcpv6::Renew.MaxDuration.Get

Getter for <MaxDuration> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxDuration>.

Returns: Current value for <MaxDuration> for stage Renew. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxDuration> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.MaxDuration.Get

Returns:

1000000000

Definition at line 11662 of file api.tcl.

Layer5.Dhcpv6::Renew.MaxDuration.Set			value

Setter for <MaxDuration> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxDuration>.

Parameters

value New value for <MaxDuration> for stage Renew. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxDuration> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.MaxDuration.Set 2s

Definition at line 11678 of file api.tcl.

Layer5.Dhcpv6::Renew.MaxRetries.Get

Getter for <MaxRetries> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxRetries>.

Returns: Current value for <MaxRetries> for stage Renew. This is a positive integer value, indicating the number of times the ByteBlowerPort will resend its Renew message.

Example

This example demonstrates how to get the value for <MaxRetries> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.MaxRetries.Get

Returns:

Definition at line 11692 of file api.tcl.

Layer5.Dhcpv6::Renew.MaxRetries.Set			value

Setter for <MaxRetries> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxRetries>.

Parameters

value New value for <MaxRetries> for stage Renew. This must be a positive integer value, indicating the number of times the ByteBlowerPort will resend its Renew message.

Example

This example demonstrates how to set the value for <MaxRetries> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.MaxRetries.Set 5

Definition at line 11708 of file api.tcl.

Layer5.Dhcpv6::Renew.MaxTimeout.Get

Getter for <MaxTimeout> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxTimeout>.

Returns: Current value for <MaxTimeout> for stage Renew. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxTimeout> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.MaxTimeout.Get

Returns:

1000000000

Definition at line 11722 of file api.tcl.

Layer5.Dhcpv6::Renew.MaxTimeout.Set			value

Setter for <MaxTimeout> when in the Renew state.

In the Renew state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Renew state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxTimeout>.

Parameters

value New value for <MaxTimeout> for stage Renew. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxTimeout> in the Renew stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Renew.MaxTimeout.Set 2s

Definition at line 11738 of file api.tcl.

Layer5.Dhcpv6::Request.InitialTimeout.Get

Getter for <InitialTimeout> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <InitialTimeout>.

Returns: Current value for <InitialTimeout> for stage Request. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <InitialTimeout> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.InitialTimeout.Get

Returns:

1000000000

Definition at line 11752 of file api.tcl.

Layer5.Dhcpv6::Request.InitialTimeout.Set			value

Setter for <InitialTimeout> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <InitialTimeout>.

Parameters

value New value for <InitialTimeout> for stage Request. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <InitialTimeout> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.InitialTimeout.Set 2s

Definition at line 11768 of file api.tcl.

Layer5.Dhcpv6::Request.MaxDuration.Get

Getter for <MaxDuration> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxDuration>.

Returns: Current value for <MaxDuration> for stage Request. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxDuration> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.MaxDuration.Get

Returns:

1000000000

Definition at line 11782 of file api.tcl.

Layer5.Dhcpv6::Request.MaxDuration.Set			value

Setter for <MaxDuration> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxDuration>.

Parameters

value New value for <MaxDuration> for stage Request. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxDuration> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.MaxDuration.Set 2s

Definition at line 11796 of file api.tcl.

Layer5.Dhcpv6::Request.MaxRetries.Get

Getter for <MaxRetries> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxRetries>.

Returns: Current value for <MaxRetries> for stage Request. This is a positive integer value, indicating the number of times the ByteBlowerPort will resend its Request message.

Example

This example demonstrates how to get the value for <MaxRetries> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.MaxRetries.Get

Returns:

Definition at line 11810 of file api.tcl.

Layer5.Dhcpv6::Request.MaxRetries.Set			value

Setter for <MaxRetries> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxRetries>.

Parameters

value New value for <MaxRetries> for stage Request. This must be a positive integer value, indicating the number of times the ByteBlowerPort will resend its Request message.

Example

This example demonstrates how to set the value for <MaxRetries> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.MaxRetries.Set 5

Definition at line 11826 of file api.tcl.

Layer5.Dhcpv6::Request.MaxTimeout.Get

Getter for <MaxTimeout> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxTimeout>.

Returns: Current value for <MaxTimeout> for stage Request. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxTimeout> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.MaxTimeout.Get

Returns:

1000000000

Definition at line 11840 of file api.tcl.

Layer5.Dhcpv6::Request.MaxTimeout.Set			value

Setter for <MaxTimeout> when in the Request state.

In the Request state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Request state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxTimeout>.

Parameters

value New value for <MaxTimeout> for stage Request. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxTimeout> in the Request stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Request.MaxTimeout.Set 2s

Definition at line 11856 of file api.tcl.

Layer5.Dhcpv6::Session.Info.Get

Returns the sessionInfo object for this DHCP Session.

This object contains all the DHCP sessionInfo like Tx,Rx

Returns: The Layer5.Dhcpv6.SessionInfo object for this dhcp session

Example

This example will return the Layer5.Dhcpv6.SessionInfo object for this DHCP session.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Session.Info.Get

Returns:

<Layer5.Dhcpv6.SessionInfo object>

Definition at line 11870 of file api.tcl.

Layer5.Dhcpv6::Solicit.InitialTimeout.Get

Getter for <InitialTimeout> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <InitialTimeout>.

Returns: Current value for <InitialTimeout> for stage Solicit. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <InitialTimeout> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.InitialTimeout.Get

Returns:

1000000000

Definition at line 11886 of file api.tcl.

Layer5.Dhcpv6::Solicit.InitialTimeout.Set			value

Setter for <InitialTimeout> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <InitialTimeout>.

Parameters

value New value for <InitialTimeout> for stage Solicit. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <InitialTimeout> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.InitialTimeout.Set 2s

Definition at line 11900 of file api.tcl.

Layer5.Dhcpv6::Solicit.MaxDuration.Get

Getter for <MaxDuration> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxDuration>.

Returns: Current value for <MaxDuration> for stage Solicit. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxDuration> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.MaxDuration.Get

Returns:

1000000000

Definition at line 11914 of file api.tcl.

Layer5.Dhcpv6::Solicit.MaxDuration.Set			value

Setter for <MaxDuration> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxDuration>.

Parameters

value New value for <MaxDuration> for stage Solicit. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxDuration> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.MaxDuration.Set 2s

Definition at line 11930 of file api.tcl.

Layer5.Dhcpv6::Solicit.MaxRetries.Get

Getter for <MaxRetries> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxRetries>.

Returns: Current value for <MaxRetries> for stage Solicit. This is a positive integer value, indicating the number of times the ByteBlowerPort will resend its Solicit message.

Example

This example demonstrates how to get the value for <MaxRetries> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.MaxRetries.Get

Returns:

Definition at line 11944 of file api.tcl.

Layer5.Dhcpv6::Solicit.MaxRetries.Set			value

Setter for <MaxRetries> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxRetries>.

Parameters

value New value for <MaxRetries> for stage Solicit. This must be a positive integer value, indicating the number of times the ByteBlowerPort will resend its Solicit message.

Example

This example demonstrates how to set the value for <MaxRetries> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.MaxRetries.Set 5

Definition at line 11958 of file api.tcl.

Layer5.Dhcpv6::Solicit.MaxTimeout.Get

Getter for <MaxTimeout> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will get the value for <MaxTimeout>.

Returns: Current value for <MaxTimeout> for stage Solicit. This is a time value, in nanosecond units.

Example

This example demonstrates how to get the value for <MaxTimeout> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.MaxTimeout.Get

Returns:

1000000000

Definition at line 11972 of file api.tcl.

Layer5.Dhcpv6::Solicit.MaxTimeout.Set			value

Setter for <MaxTimeout> when in the Solicit state.

In the Solicit state of DHCPv6, ByteBlower will sent up to <MaxRetries> messages. The total duration of the the Solicit state may take up the <MaxDuration>. For the first attempt, a ByteBlowerPort will wait up to <InitialTimeout> nanoseconds before retrying. Each attempt will wait for maximum '<MaxTimeout> nanoseconds before concluding that the messages has timed out.

This method will set the value for <MaxTimeout>.

Parameters

value New value for <MaxTimeout> for stage Solicit. This is a time value, in nanosecond units. You can define the unit by appending in to the value. e.g. 5s

Example

This example demonstrates how to set the value for <MaxTimeout> in the Solicit stage.

1 [ [ $port Layer3.IPv6.Get ] Protocol.Dhcp.Get ] Solicit.MaxTimeout.Set 2s

Definition at line 11986 of file api.tcl.

Methods

Class overview

Method documentation