DHCP¶

Description¶

Commands for working with the DHCP protocol. As DHCP is a UDP protocol, the valid events for these commands are CLIENT_DATA and SERVER_DATA.

Command List¶

All Versions¶

DHCP::version - returns the DHCP version
DHCPv4::chaddr - Returns chaddr (client hardware address) from DHCPv4 message
DHCPv4::ciaddr - Returns ciaddr (client IP) field from DHCPv4 message
DHCPv4::drop - Drops the packet silently
DHCPv4::hlen - Returns hlen (hardware len) field from DHCPv4 message
DHCPv4::htype - Returns htype (hardware type) field from DHCPv4 message
DHCPv4::giaddr - Returns giaddr (gateway or relay IP) field from DHCPv4 message
DHCPv4::hops - Returns hops (num. of hops) field from DHCPv4 message
DHCPv4::len - Returns the length of the DHCP packet length
DHCPv4::opcode - Returns opcode field from DHCPv4 message
DHCPv4::option - Retrieves or sets the option by id number x
DHCPv4::reject - Drops the packet while sending ICMP packet about the drop reason
DHCPv4::secs - Returns xid (transaction ID) field from DHCPv4 message
DHCPv4::siaddr - Returns siaddr (server IP) field from DHCPv4 message
DHCPv4::type - Returns type of DHCPv4 message
DHCPv4::xid - Returns xid (transaction ID) field from DHCPv4 message
DHCPv4::yiaddr - Returns yiaddr (your IP) field from DHCPv4 message
DHCPv6::drop - Drops the packet silently
DHCPv6::hop_count - Returns hop-count field from DHCPv6 RELAY message
DHCPv6::len - Returns the length of the DHCP packet length
DHCPv6::link_address - Returns link address field from DHCPv6 RELAY message
DHCPv6::msg_type - Returns msg-type field from DHCPv6 message
DHCPv6::option - Retrieves, sets or deletes the option by id number x
DHCPv6::peer_address - Returns peer address field from DHCPv6 RELAY message
DHCPv6::reject - Drops the packet while sending ICMP packet about the drop reason
DHCPv6::transaction_id - Returns transaction-id field from DHCPv6 message

DHCPv4¶

DHCPv4::hlen - Returns hlen (hardware len) field from DHCPv4 message
DHCPv4::htype - Returns htype (hardware type) field from DHCPv4 message
DHCPv4::chaddr - Returns chaddr (client hardware address) from DHCPv4 message
DHCPv4::ciaddr - Returns ciaddr (client IP) field from DHCPv4 message
DHCPv4::drop - Drops the packet silently
DHCPv4::giaddr - Returns giaddr (gateway or relay IP) field from DHCPv4 message
DHCPv4::hops - Returns hops (num. of hops) field from DHCPv4 message
DHCPv4::len - Returns the length of the DHCP packet length
DHCPv4::opcode - Returns opcode field from DHCPv4 message
DHCPv4::option - Retrieves or sets the option by id number x
DHCPv4::reject - Drops the packet while sending ICMP packet about the drop reason
DHCPv4::secs - Returns xid (transaction ID) field from DHCPv4 message
DHCPv4::siaddr - Returns siaddr (server IP) field from DHCPv4 message
DHCPv4::type - Returns type of DHCPv4 message
DHCPv4::xid - Returns xid (transaction ID) field from DHCPv4 message
DHCPv4::yiaddr - Returns yiaddr (your IP) field from DHCPv4 message

DHCPv6¶

DHCPv6::drop - Drops the packet silently
DHCPv6::hop_count - Returns hop-count field from DHCPv6 RELAY message
DHCPv6::len - Returns the length of the DHCP packet length
DHCPv6::link_address - Returns link address field from DHCPv6 RELAY message
DHCPv6::msg_type - Returns msg-type field from DHCPv6 message
DHCPv6::option - Retrieves, sets or deletes the option by id number x
DHCPv6::peer_address - Returns peer address field from DHCPv6 RELAY message
DHCPv6::reject - Drops the packet while sending ICMP packet about the drop reason
DHCPv6::transaction_id - Returns transaction-id field from DHCPv6 message

Associated Events¶

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.

Previous Next