NAME

Net::ISC::DHCPd::Role::Lease - Role for dhcpd lease

DESCRIPTION

See Net::ISC::DHCPd::Leases::Lease, Net::ISC::DHCPd::OMAPI::Lease and Net::ISC::DHCPd::OMAPI::Actions.

ATTRIBUTES

atsfp

 $int = $self->atsfp;
 $self->atsfp($int);

The actual tsfp value sent from the peer. This value is forgotten when a lease binding state change is made, to facillitate retransmission logic.

Actions: examine.

billing_class

 ?? = $self->billing_class;
 $self->billing_class(??);

The handle to the class to which this lease is currently billed, if any (The class object is not currently supported).

Actions: none.

circuit_id

 $str => $self->circuit_id;
 $self->circuit_id($str);

Circuit ID from Relay Agent Option 82.

client_hostname

 $self->client_hostname($str);
 $str = $self->client_hostname;

The value the client sent in the host-name option.

Actions: examine, modify.

cltt

 $int = $self->cltt;
 $self->cltt($int);

The time of the last transaction with the client on this lease.

Actions: examine.

dhcp_client_identifier

 $self->dhcp_client_identifier(??);
 ?? = $self->dhcp_client_identifier;

The client identifier that the client used when it acquired the lease. Not all clients send client identifiers, so this may be empty.

Actions: examine, lookup, modify.

ends

 $self->ends($int);
 $int = $self->ends;

The time when the current state of the lease ends, as understood by the client. Setting this to "0" will effectively makes the DHCP server drop the lease.

Actions: examine, modify.

Note: This attribute can only be modified from ISC-DHCP-4.1.0.

flags

 ?? = $self->flags;
 $self->flags(??);

Actions: none.

host

 $self->host(??);
 ?? = $self->host;

The host declaration associated with this lease, if any.

Actions: examine.

ip_address

 $self->ip_address($ip_addr_obj);
 $self->ip_address("127.0.0.1"); # standard ip
 $self->ip_address("22:33:aa:bb"); # hex
 $std_ip_str = $self->ip_address;

The IP address of the lease.

Actions: examine, lookup.

pool

 ?? = $self->pool;
 $self->pool(??);

The pool object associted with this lease (The pool object is not currently supported).

Actions: examine.

remote_id

 $str = $self->remote_id;
 $self->remote_id($str);

Remote ID from Relay Agent Option 82.

starts

 $self->starts($int);
 $int = $self->starts;

The time when the lease's current state ends, as understood by the server.

Actions: examine.

state

 $self->state($str);
 $str = $self->state;

Valid states: free, active, expired, released, abandoned, reset, backup, reserved, bootp.

Actions: examine, lookup.

subnet

 ?? = $self->subnet;
 $self->subnet(??);

The subnet object associated with this lease. (The subnet object is not currently supported).

Actions: examine.

tsfp

 $self->tsfp($int);
 $int = $self->tsfp;

The adjusted time when the lease's current state ends, as understood by the failover peer (if there is no failover peer, this value is undefined). Generally this value is only adjusted for expired, released, or reset leases while the server is operating in partner-down state, and otherwise is simply the value supplied by the peer.

Actions: examine.

tstp

 $self->tstp($int);
 $int = $self->tstp;

The time when the lease's current state ends, as understood by the server.

Actions: examine.

hardware_address

 $self->hardware_address($str);
 $str = $self->hardware_address;

The hardware address (chaddr) field sent by the client when it acquired its lease.

Actions: examine, modify.

hardware_type

 $self->hardware_type($str);
 $str = $self->hardware_type;

The type of the network interface that the client reported when it acquired its lease.

Actions: examine, modify.

ACKNOWLEDGEMENTS

Most of the documentation is taken from dhcpd(8).

COPYRIGHT & LICENSE

AUTHOR

See Net::ISC::DHCPd.

cpanm Net::ISC::DHCPd

perl -MCPAN -e shell
install Net::ISC::DHCPd