|  | Kea 3.1.0
    | 
Parameters specified for lease commands. More...
| Public Types | |
| enum | Type { TYPE_ADDR , TYPE_HWADDR , TYPE_DUID , TYPE_CLIENT_ID } | 
| specifies type of query (by IP addr, by hwaddr, by DUID)  More... | |
| Public Member Functions | |
| Parameters () | |
| Default constructor. | |
| Static Public Member Functions | |
| static Type | txtToType (const std::string &txt) | 
| Attempts to covert text to one of specified types. | |
| Public Attributes | |
| IOAddress | addr | 
| Specifies IPv4/v6 address (used when query_type is TYPE_ADDR) | |
| isc::dhcp::ClientIdPtr | client_id | 
| Specifies identifier value (used when query_type is TYPE_CLIENT_ID) | |
| isc::dhcp::DuidPtr | duid | 
| Specifies identifier value (used when query_type is TYPE_DUID) | |
| HWAddrPtr | hwaddr | 
| Specifies hardware address (used when query_type is TYPE_HWADDR) | |
| uint32_t | iaid | 
| IAID identifier used for v6 leases. | |
| Lease::Type | lease_type | 
| Lease type (NA,TA or PD) used for v6 leases. | |
| Type | query_type | 
| specifies parameter types | |
| SubnetID | subnet_id | 
| Specifies subnet-id (always used) | |
| bool | updateDDNS | 
| Indicates whether or not DNS should be updated. | |
Parameters specified for lease commands.
Definition at line 59 of file lease_cmds.cc.
specifies type of query (by IP addr, by hwaddr, by DUID)
| Enumerator | |
|---|---|
| TYPE_ADDR | query by IP address (either v4 or v6) | 
| TYPE_HWADDR | query by hardware address (v4 only) | 
| TYPE_DUID | query by DUID (v6 only) | 
| TYPE_CLIENT_ID | query by client identifier (v4 only). | 
Definition at line 63 of file lease_cmds.cc.
| 
 | inline | 
Default constructor.
Definition at line 123 of file lease_cmds.cc.
References addr, iaid, lease_type, query_type, subnet_id, TYPE_ADDR, and updateDDNS.
| 
 | inlinestatic | 
Attempts to covert text to one of specified types.
Supported values are: "address", hw-address and duid.
| txt | text to be converted | 
| BadValue | if unsupported type is specified | 
Definition at line 94 of file lease_cmds.cc.
References isc_throw, TYPE_ADDR, TYPE_CLIENT_ID, TYPE_DUID, and TYPE_HWADDR.
Referenced by isc::lease_cmds::LeaseCmdsImpl::getParameters().
| IOAddress isc::lease_cmds::LeaseCmdsImpl::Parameters::addr | 
Specifies IPv4/v6 address (used when query_type is TYPE_ADDR)
Definition at line 74 of file lease_cmds.cc.
Referenced by Parameters(), isc::lease_cmds::LeaseCmdsImpl::getIPv6LeaseForDelete(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| isc::dhcp::ClientIdPtr isc::lease_cmds::LeaseCmdsImpl::Parameters::client_id | 
Specifies identifier value (used when query_type is TYPE_CLIENT_ID)
Definition at line 83 of file lease_cmds.cc.
Referenced by isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| isc::dhcp::DuidPtr isc::lease_cmds::LeaseCmdsImpl::Parameters::duid | 
Specifies identifier value (used when query_type is TYPE_DUID)
Definition at line 80 of file lease_cmds.cc.
Referenced by isc::lease_cmds::LeaseCmdsImpl::getIPv6LeaseForDelete(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| HWAddrPtr isc::lease_cmds::LeaseCmdsImpl::Parameters::hwaddr | 
Specifies hardware address (used when query_type is TYPE_HWADDR)
Definition at line 77 of file lease_cmds.cc.
Referenced by isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| uint32_t isc::lease_cmds::LeaseCmdsImpl::Parameters::iaid | 
IAID identifier used for v6 leases.
Definition at line 117 of file lease_cmds.cc.
Referenced by Parameters(), isc::lease_cmds::LeaseCmdsImpl::getIPv6LeaseForDelete(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| Lease::Type isc::lease_cmds::LeaseCmdsImpl::Parameters::lease_type | 
Lease type (NA,TA or PD) used for v6 leases.
Definition at line 114 of file lease_cmds.cc.
Referenced by Parameters(), isc::lease_cmds::LeaseCmdsImpl::getIPv6LeaseForDelete(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| Type isc::lease_cmds::LeaseCmdsImpl::Parameters::query_type | 
specifies parameter types
Definition at line 111 of file lease_cmds.cc.
Referenced by Parameters(), isc::lease_cmds::LeaseCmdsImpl::getIPv6LeaseForDelete(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| SubnetID isc::lease_cmds::LeaseCmdsImpl::Parameters::subnet_id | 
Specifies subnet-id (always used)
Definition at line 71 of file lease_cmds.cc.
Referenced by Parameters(), isc::lease_cmds::LeaseCmdsImpl::getIPv6LeaseForDelete(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler().
| bool isc::lease_cmds::LeaseCmdsImpl::Parameters::updateDDNS | 
Indicates whether or not DNS should be updated.
Definition at line 120 of file lease_cmds.cc.
Referenced by Parameters(), isc::lease_cmds::LeaseCmdsImpl::getParameters(), isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler(), and isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler().