308 lines
13 KiB
Mathematica
308 lines
13 KiB
Mathematica
/* 02comp_ipnet_dhcp.cdf - IPNet DHCP configuration file */
|
|
|
|
/*
|
|
* Copyright (c) 2006-2009 Wind River Systems, Inc.
|
|
*
|
|
* The right to copy, distribute or otherwise make use of this software
|
|
* may be licensed only pursuant to the terms of an applicable Wind River
|
|
* license agreement. No license to Wind River intellectual property rights
|
|
* is granted herein. All rights not licensed by Wind River are reserved
|
|
* by Wind River.
|
|
*/
|
|
|
|
/*
|
|
modification history
|
|
--------------------
|
|
01v,02aug10,fei move from osconfig and spilt from 02comp_ipnet_dhcp.cdf
|
|
01u,05jul10,lzq Added INCLUDE_IPDHCPC6_CMD component
|
|
01t,04sep09,h_s Modify the DHCPC,DHCPR,DHCPS related callback function to 0 instead of NULL
|
|
to make gnu compile correct.
|
|
01s,04jun09,ggz Added DHCPC ip address lease time
|
|
01r,29may09,spw Add DHCPS_NO_STRICT_SUBNET_MATCH param
|
|
01q,11feb08,spw Add support for user defined client options
|
|
01p,10oct08,spw Add max message size, ttl, auto enable interface configs
|
|
01o,27aug08,spw Add option to remove existing addresses from interface
|
|
when starting negotiation
|
|
01n,27aug08,spw Modify option callback param name, add netmask option
|
|
01m,30may08,spw Add bootp mode and some more options
|
|
01l,23sep08,rme Misspelled words corrected
|
|
01k,19sep07,rme Added missing backslash
|
|
01n,07sep07,rme Replaced SELECTION_IPCOM_FS with SELECT_IPCOM_FS in INCLUDE_IPDHCPC6
|
|
|
|
01m,07sep07,rme Replaced SELECTION_IPCOM_FS with SELECT_IPCOM_FS in INCLUDE_IPDHCPS
|
|
|
|
01l,10sep07,mze INCLUDE_IPCOM_FS_SELECTION changed to SELECT_IPCOM_FS
|
|
01k,21aug07,mze fixed mistake in INCLUDE_IPDHCPS MODULES line continued without "\"
|
|
01j,28aug07,ps Add DHCPc6 authentication parameters
|
|
01i,07feb07,tkf Add IPDHCPS dependency on SELECT_IPCOM_FS.
|
|
01h,22jan07,kch Added DHCPC_RFC2131_INIT_DELAY, DHCPC_RFC2131_EXP_BACKOFF,
|
|
DHCPC_DISCOVER_RETRIES and DHCPC_OFFER_TIMEOUT configuration
|
|
macros (WIND00086146).
|
|
01g,03jan07,kch Changed DHCPC_SERVER_PORT default value from 68 to 67.
|
|
Renamed DHCPC_IFLIST_REQ_OPTS and DHCPC_IFLIST_CLIENT_ID
|
|
macros to DHCPC_IF_REQ_OPTS_LIST and DHCPC_IF_CLIENT_ID_LIST.
|
|
01f,19dec06,mwv Correct typos throughout (WIND00083100)
|
|
01e,15dec06,kch Corrected typo for DHCPC6_IF_IA_NA_DEFAULT_LIST description.
|
|
01d,11dec06,kch Added configuration parameters for DHCP client, relay
|
|
and server callback hooks. Also added DHCPS_NETCONF_SYSVAR
|
|
and DHCPR_NETCONF_SYSVAR. Added ipnet/ipDHCPc_example.c
|
|
configlette to INCLUDE_IPDHCPC as well.
|
|
01c,01dec06,kch Added additional configuration parameters for DHCP6 Client.
|
|
01b,23sep06.kch Added INCLUDE_IPDHCPS6_CMD.
|
|
01a,14sep06,tkf Written
|
|
*/
|
|
#ifdef _WRS_CONFIG_COMPONENT_IPDHCPS
|
|
|
|
Component INCLUDE_IPDHCPS {
|
|
NAME DHCP Server
|
|
SYNOPSIS DHCP Server
|
|
MODULES ipdhcps.o ipdhcps_cmd_dhcps.o ipdhcps_db.o \
|
|
ipdhcps_leasedump.o ipdhcps_options.o ipdhcps_packet.o
|
|
REQUIRES INCLUDE_IPCOM SELECT_IPCOM_FS
|
|
CONFIGLETTES ipdhcps_config.c
|
|
CFG_PARAMS DHCPS_SERVER_PORT DHCPS_CLIENT_PORT \
|
|
DHCPS_DEFAULT_LEASE_TIME DHCPS_MAX_LEASE_TIME \
|
|
DHCPS_MIN_LEASE_TIME DHCPS_RENEWAL_TIME \
|
|
DHCPS_REBINDING_TIME DHCPS_ABANDONED_STATE_MAX_TIME \
|
|
DHCPS_EXPIRED_STATE_MAX_TIME \
|
|
DHCPS_RELEASED_STATE_MAX_TIME \
|
|
DHCPS_OFFERED_STATE_MAX_TIME \
|
|
DHCPS_LEASE_BOOTPC_MAX_TIME DHCPS_ALLOW_DECLINE \
|
|
DHCPS_PKT_SIZE DHCPS_ALLOW_BOOTP \
|
|
DHCPS_ALLOW_DYNAMIC_BOOTP DHCPS_DO_ICMP_ADDRESS_CHECK \
|
|
DHCPS_AUTHORIZED_AGENTS DHCPS_NETCONF_SYSVAR \
|
|
DHCPS_INSTALL_CALLBACK_HOOK DHCPS_START_CALLBACK_HOOK \
|
|
DHCPS_STOP_CALLBACK_HOOK \
|
|
DHCPS_AUTO_ENABLE_INTERFACES \
|
|
DHCPS_NO_STRICT_SUBNET_MATCH
|
|
_CHILDREN FOLDER_DHCP
|
|
}
|
|
|
|
/* INCLUDE_IPDHCPS configuration parameters */
|
|
Parameter DHCPS_SERVER_PORT {
|
|
NAME UDP port used by the DHCP server
|
|
SYNOPSIS Defines the UDP port used by IPDHCPS for receiving.
|
|
TYPE char *
|
|
DEFAULT "67"
|
|
}
|
|
|
|
Parameter DHCPS_CLIENT_PORT {
|
|
NAME UDP port used by the DHCP/bootp clients
|
|
SYNOPSIS Defines the UDP port used for reception by DHCP/bootp \
|
|
clients handled by DHCP server.
|
|
TYPE char *
|
|
DEFAULT "68"
|
|
}
|
|
|
|
Parameter DHCPS_DEFAULT_LEASE_TIME {
|
|
NAME Default lease time
|
|
SYNOPSIS The default time in seconds a client can hold a dynamic \
|
|
lease before it expires.
|
|
TYPE char *
|
|
DEFAULT "864000"
|
|
}
|
|
|
|
Parameter DHCPS_MAX_LEASE_TIME {
|
|
NAME Maximum lease time
|
|
SYNOPSIS The maximum time in seconds a client can hold a dynamic \
|
|
lease before it expires.
|
|
TYPE char *
|
|
DEFAULT "8640000"
|
|
}
|
|
|
|
Parameter DHCPS_MIN_LEASE_TIME {
|
|
NAME Minimum lease time
|
|
SYNOPSIS The minimum time in seconds a client can hold a dynamic \
|
|
lease before it expires.
|
|
TYPE char *
|
|
DEFAULT "60"
|
|
}
|
|
|
|
Parameter DHCPS_RENEWAL_TIME {
|
|
NAME Lease renewal time
|
|
SYNOPSIS The time in seconds when the client must start asking to \
|
|
extend the lease. If set to "disabled", the server will not \
|
|
transmit its value to its clients. Clients will then use a \
|
|
local default value for this parameter, typically one-half \
|
|
of the lease time.
|
|
TYPE char *
|
|
DEFAULT "disabled"
|
|
}
|
|
|
|
Parameter DHCPS_REBINDING_TIME {
|
|
NAME Lease rebinding time
|
|
SYNOPSIS The time in seconds when the client must start rebinding \
|
|
the lease if it has failed to renew it. If set to "disabled", \
|
|
the server will not transmit its value to its clients. Clients \
|
|
will then use a local default value for this parameter.
|
|
TYPE char *
|
|
DEFAULT "disabled"
|
|
}
|
|
|
|
Parameter DHCPS_ABANDONED_STATE_MAX_TIME {
|
|
NAME Abandoned state max time
|
|
SYNOPSIS The time in seconds that must pass before an abandoned lease \
|
|
is allowed to be released and set to state free.
|
|
TYPE char *
|
|
DEFAULT "8640000"
|
|
}
|
|
|
|
Parameter DHCPS_EXPIRED_STATE_MAX_TIME {
|
|
NAME Expired state max time
|
|
SYNOPSIS The time in seconds that must pass before an expired lease \
|
|
will be set to state free to be reused. If set to "forever", \
|
|
the server will never flush expired leases automatically.
|
|
TYPE char *
|
|
DEFAULT "forever"
|
|
}
|
|
|
|
Parameter DHCPS_RELEASED_STATE_MAX_TIME {
|
|
NAME Released state max time
|
|
SYNOPSIS The time in seconds that must pass before a released lease \
|
|
can be set to state free to be reused. If set to "forever", \
|
|
the server will never flush released leases automatically.
|
|
TYPE char *
|
|
DEFAULT "forever"
|
|
}
|
|
|
|
Parameter DHCPS_OFFERED_STATE_MAX_TIME {
|
|
NAME Offered state max time
|
|
SYNOPSIS The time in seconds that must pass before an offered lease \
|
|
can be set to state free to be reused.
|
|
TYPE char *
|
|
DEFAULT "10"
|
|
}
|
|
|
|
Parameter DHCPS_LEASE_BOOTPC_MAX_TIME {
|
|
NAME Lease for bootp client max time
|
|
SYNOPSIS The time in seconds that must pass before a lease held by a \
|
|
bootp client can be set to state free to be reused. If set \
|
|
to "forever", the server will never flush bootp leases \
|
|
automatically.
|
|
TYPE char *
|
|
DEFAULT "forever"
|
|
}
|
|
|
|
Parameter DHCPS_ALLOW_DECLINE {
|
|
NAME Allow decline
|
|
SYNOPSIS Whether DHCP server shall ignore DHCP DECLINE messages \
|
|
or if it shall honor them in an appropriate way.
|
|
TYPE char *
|
|
DEFAULT "true"
|
|
}
|
|
|
|
Parameter DHCPS_PKT_SIZE {
|
|
NAME Packet size
|
|
SYNOPSIS The size in bytes of a DHCP packet used by IPDHCPS. It must \
|
|
never be less than 576 bytes.
|
|
TYPE char *
|
|
DEFAULT "576"
|
|
}
|
|
|
|
Parameter DHCPS_ALLOW_BOOTP {
|
|
NAME Allow bootp
|
|
SYNOPSIS Whether DHCP server shall accept requests from bootp \
|
|
clients or not.
|
|
TYPE char *
|
|
DEFAULT "true"
|
|
}
|
|
|
|
Parameter DHCPS_ALLOW_DYNAMIC_BOOTP {
|
|
NAME Allow dynamic bootp
|
|
SYNOPSIS Whether DHCP server shall accept allocating dynamic leases \
|
|
to bootp clients or not. If set to "false", the server will \
|
|
only use static leases for bootp clients.
|
|
TYPE char *
|
|
DEFAULT "false"
|
|
}
|
|
|
|
Parameter DHCPS_DO_ICMP_ADDRESS_CHECK {
|
|
NAME Check address
|
|
SYNOPSIS Specifies if DHCP server should perform an ICMP ping to \
|
|
check on each address before it is offered to a DHCP client.
|
|
TYPE char *
|
|
DEFAULT "false"
|
|
}
|
|
|
|
Parameter DHCPS_AUTHORIZED_AGENTS {
|
|
NAME Authorized DHCP relay agent
|
|
SYNOPSIS Set to "any" or specifies a list of space-separated IP \
|
|
addresses to DHCP relay agents that are authorized to \
|
|
access this DHCP server.
|
|
TYPE char *
|
|
DEFAULT "any"
|
|
}
|
|
|
|
Parameter DHCPS_NETCONF_SYSVAR {
|
|
NAME DHCP server network pre-configuration
|
|
SYNOPSIS DHCP server network pre-configuration array is used to \
|
|
statically configure the DHCP server with a pre-configured \
|
|
setup of networks and hosts when initiated. Each system \
|
|
variable in this array must be named according to the syntax \
|
|
ipdhcps.netconf.<index>, where <index> is a unique line \
|
|
indicator. The value of each system variable must consist \
|
|
of a IPDHCPS shell command (without the preceding dhcps \
|
|
that is used only when executing from a shell). The commands \
|
|
are executed in the order they are defined. See \
|
|
ipdhcps_netconf_sysvar Ipcom_sysvar array in ipdhcps_config.c \
|
|
configlette for the example usage.
|
|
TYPE void *
|
|
DEFAULT NULL
|
|
}
|
|
|
|
Parameter DHCPS_INSTALL_CALLBACK_HOOK {
|
|
NAME Install dhcp server callback routines
|
|
SYNOPSIS Determine if the user-defined DHCP server callback routines \
|
|
as specified by the macro DHCPS_START_CALLBACK_HOOK and \
|
|
DHCPS_STOP_CALLBACK_HOOK should be installed. If FALSE, the \
|
|
DHCPS_START_CALLBACK_HOOK and DHCPS_STOP_CALLBACK_HOOK \
|
|
configurations are not applicable.
|
|
TYPE BOOL
|
|
DEFAULT FALSE
|
|
}
|
|
|
|
Parameter DHCPS_START_CALLBACK_HOOK {
|
|
NAME DHCP server startup callback routine
|
|
SYNOPSIS DHCP server startup callback routine. This routine, if \
|
|
provided, will be called by dhcp server at startup. It is \
|
|
intended to be used for static configuration of DHCP server, \
|
|
i.e. to install a lease 'dump to file' routine and/or to \
|
|
restore a lease database from a file. The \
|
|
DHCPS_INSTALL_CALLBACK_HOOK must also be set to TRUE in \
|
|
order to install this callback hook.
|
|
TYPE FUNCPTR
|
|
DEFAULT 0
|
|
}
|
|
|
|
Parameter DHCPS_STOP_CALLBACK_HOOK {
|
|
NAME DHCP server termination callback routine
|
|
SYNOPSIS DHCP server termination callback routine. This callback \
|
|
will be called by DHCP server upon termination of the DHCP \
|
|
server. It is intended to be used for static configuration \
|
|
of IPDHCPS, for instance to save the lease database at \
|
|
shutdown so that the lease can later be restored. The \
|
|
DHCPS_INSTALL_CALLBACK_HOOK must also be set to TRUE in \
|
|
order to install this callback hook.
|
|
TYPE FUNCPTR
|
|
DEFAULT 0
|
|
}
|
|
|
|
Parameter DHCPS_AUTO_ENABLE_INTERFACES {
|
|
NAME Enable Interfaces Automatically
|
|
SYNOPSIS Whether DHCP server should automatically start the server on \
|
|
interfaces when they are found. If set to "false", the server \
|
|
will have to be enabled on interfaces manually.
|
|
TYPE char *
|
|
DEFAULT "true"
|
|
}
|
|
|
|
Parameter DHCPS_NO_STRICT_SUBNET_MATCH {
|
|
NAME Disable Strict Subnet Matching
|
|
SYNOPSIS Whether DHCP server should _not_ prefer to issue a lease from \
|
|
a pool with the same subnet that is present on the enabled dhcps interface. \
|
|
Default is "false". ie. strict subnet matching is enabled.
|
|
TYPE char *
|
|
DEFAULT "false"
|
|
}
|
|
|
|
#endif /* _WRS_CONFIG_COMPONENT_IPDHCPS */ |