ParameterMap Class Reference

ParameterMap handles and manipulates Zone-Based Policy Firewall parameter maps. More...

Public Member Functions
string	getMapName ()
	Returns the name of the paramter map. More...
ZfwMapType	getMapType ()
	Returns the type of the paramter map. More...
void	setInUsed (bool)
	Sets the parameter map as in use or not in use. More...
void	setMapType (ZfwMapType)
	Sets the type of the paramter map. More...
void	setAlert (bool)
	Turns on or off alert. More...
void	setAlertEnable (bool)
	Enables or disables alert. More...
void	setAuditTrail (bool)
	Turns on or off audit-trail. More...
void	setAuditTrailEnable (bool)
	Enables or disables audit-trail. More...
void	setDnsTimeout (int)
	Sets the dns-timeout value. More...
void	setDnsTimeoutEnable (bool)
	Enables or disables dns-timeout. More...
void	setIcmpIdleTimeout (int)
	Sets the icmp idle-timeout value. More...
void	setIcmpIdleTimeoutEnable (bool)
	Enables or disables icmp idle-timeout. More...
void	setMaxIncompleteLow (int)
	Sets the max-incomplete low value. More...
void	setMaxIncompleteLowEnable (bool)
	Enables or disables max-incomplete low. More...
void	setMaxIncompleteHigh (int)
	Sets the max-incomplete high value. More...
void	setMaxIncompleteHighEnable (bool)
	Enables or disables max-incomplete high. More...
void	setSessionMax (int)
	Sets the session max value. More...
void	setSessionMaxEnable (bool)
	Enables or disables session max. More...
void	setOneMinLow (int)
	Sets the one-minute low value. More...
void	setOneMinLowEnable (bool)
	Enables or disables one-minute low. More...
void	setOneMinHigh (int)
	Sets the one-minute high value. More...
void	setOneMinHighEnable (bool)
	Enables or disables one-minute high. More...
void	setTcpFinWaitTimeout (int)
	Sets the tcp finwait-time value. More...
void	setTcpFinWaitTimeoutEnable (bool)
	Enables or disables tcp finwait-time. More...
void	setTcpIdleTimeout (int)
	Sets the tcp idle-time value. More...
void	setTcpIdleTimeoutEnable (bool)
	Enables or disables tcp idle-time. More...
void	setTcpMaxIncompleteConn (int)
	Sets the tcp max-incomplete host value. More...
void	setTcpMaxIncompleteConnEnable (bool)
	Enables or disables tcp max-incomplete host. More...
void	setTcpMaxIncompleteConnBlockTime (int)
	Sets the tcp max-incomplete host block-time value. More...
void	setTcpMaxIncompleteConnBlockTimeEnable (bool)
	Enables or disables tcp max-incomplete host block-time. More...
void	setTcpSynWaitTimeout (int)
	Sets the tcp synwait-time value. More...
void	setTcpSynWaitTimeoutEnable (bool)
	Enables or disables tcp synwait-time block-time. More...
void	setUdpIdleTimeout (int)
	Sets the udp idle-time value. More...
void	setUdpIdleTimeoutEnable (bool)
	Enables or disables udp idle-time. More...
bool	getAlert ()
	Returns true if alert is on, otherwise false. More...
bool	getAlertEnable ()
	Returns true if alert is enabled, otherwise false. More...
bool	getAuditTrail ()
	Returns true if audit-trail is on, otherwise false. More...
bool	getAuditTrailEnable ()
	Returns true if audit-trail is enabled, otherwise false. More...
int	getDnsTimeout ()
	Returns the dns-timeout value. More...
bool	getDnsTimeoutEnable ()
	Returns true if dns-timeout is enabled, otherwise false. More...
int	getIcmpIdleTimeout ()
	Returns the icmp idle-timeout value. More...
bool	getIcmpIdleTimeoutEnable ()
	Returns true if icmp idle-timeout is enabled, otherwise false. More...
int	getMaxIncompleteLow ()
	Returns the max-incomplete low value. More...
bool	getMaxIncompleteLowEnable ()
	Returns true if max-incomplete low is enabled, otherwise false. More...
int	getMaxIncompleteHigh ()
	Returns the max-incomplete high value. More...
bool	getMaxIncompleteHighEnable ()
	Returns true if max-incomplete high is enabled, otherwise false. More...
int	getSessionMax ()
	Returns the session max value. More...
bool	getSessionMaxEnable ()
	Returns true if session max is enabled, otherwise false. More...
int	getOneMinLow ()
	Returns the one-minute low value. More...
bool	getOneMinLowEnable ()
	Returns true if one-minute low is enabled, otherwise false. More...
int	getOneMinHigh ()
	Returns the one-minute high value. More...
bool	getOneMinHighEnable ()
	Returns true if one-minute high is enabled, otherwise false. More...
int	getTcpFinWaitTimeout ()
	Returns the tcp finwait-time value. More...
bool	getTcpFinWaitTimeoutEnable ()
	Returns true if tcp finwait-time is enabled, otherwise false. More...
int	getTcpIdleTimeout ()
	Returns the tcp idle-time value. More...
bool	getTcpIdleTimeoutEnable ()
	Returns true if tcp idle-time is enabled, otherwise false. More...
int	getTcpMaxIncompleteConn ()
	Returns the tcp max-incomplete host value. More...
bool	getTcpMaxIncompleteConnEnable ()
	Returns true if tcp max-incomplete host is enabled, otherwise false. More...
int	getTcpMaxIncompleteConnBlockTime ()
	Returns the tcp max-incomplete host block-time value. More...
bool	getTcpMaxIncompleteConnBlockTimeEnable ()
	Returns true if tcp max-incomplete host block-time is enabled, otherwise false. More...
int	getTcpSynWaitTimeout ()
	Returns the tcp synwait-time value. More...
bool	getTcpSynWaitTimeoutEnable ()
	Returns true if tcp synwait-time is enabled, otherwise false. More...
int	getUdpIdleTimeout ()
	Returns the udp idle-time value. More...
bool	getUdpIdleTimeoutEnable ()
	Returns true if udp idle-time is enabled, otherwise false. More...
bool	isInUsed ()
	Returns true if the parameter map is in use, otherwise false. More...
string	toString ()
	Returns the name of the parameter map. More...

Detailed Description

ParameterMap handles and manipulates Zone-Based Policy Firewall parameter maps.

Member Function Documentation

getAlert()

bool ParameterMap::getAlert

(

)

Returns true if alert is on, otherwise false.

Returns

bool, true if alert is on, otherwise false.

getAlertEnable()

bool ParameterMap::getAlertEnable

(

)

Returns true if alert is enabled, otherwise false.

Returns

bool, true if alert is enabled, otherwise false.

getAuditTrail()

bool ParameterMap::getAuditTrail

(

)

Returns true if audit-trail is on, otherwise false.

Returns

bool, true if audit-trail is on, otherwise false.

getAuditTrailEnable()

bool ParameterMap::getAuditTrailEnable

(

)

Returns true if audit-trail is enabled, otherwise false.

Returns

bool, true if audit-trail is enabled, otherwise false.

getDnsTimeout()

int ParameterMap::getDnsTimeout

(

)

Returns the dns-timeout value.

Returns

int, the dns-timeout value.

getDnsTimeoutEnable()

bool ParameterMap::getDnsTimeoutEnable

(

)

Returns true if dns-timeout is enabled, otherwise false.

Returns

bool, true if dns-timeout is enabled, otherwise false.

getIcmpIdleTimeout()

int ParameterMap::getIcmpIdleTimeout

(

)

Returns the icmp idle-timeout value.

Returns

int, the icmp idle-timeout value.

getIcmpIdleTimeoutEnable()

bool ParameterMap::getIcmpIdleTimeoutEnable

(

)

Returns true if icmp idle-timeout is enabled, otherwise false.

Returns

bool, true if icmp idle-timeout is enabled, otherwise false.

getMapName()

string ParameterMap::getMapName

(

)

Returns the name of the paramter map.

Returns

string, the name of the paramter map.

getMapType()

ZfwMapType ParameterMap::getMapType

(

)

Returns the type of the paramter map.

Returns

enum<ZfwMapType>, the type of the paramter map. Map types: type_default = 0, type_global = 1, type_inspect = 2,

getMaxIncompleteHigh()

int ParameterMap::getMaxIncompleteHigh

(

)

Returns the max-incomplete high value.

Returns

int, the max-incomplete high value.

getMaxIncompleteHighEnable()

bool ParameterMap::getMaxIncompleteHighEnable

(

)

Returns true if max-incomplete high is enabled, otherwise false.

Returns

bool, true if max-incomplete high is enabled, otherwise false.

getMaxIncompleteLow()

int ParameterMap::getMaxIncompleteLow

(

)

Returns the max-incomplete low value.

Returns

int, the max-incomplete low value.

getMaxIncompleteLowEnable()

bool ParameterMap::getMaxIncompleteLowEnable

(

)

Returns true if max-incomplete low is enabled, otherwise false.

Returns

bool, true if max-incomplete low is enabled, otherwise false.

getOneMinHigh()

int ParameterMap::getOneMinHigh

(

)

Returns the one-minute high value.

Returns

int, the one-minute high value.

getOneMinHighEnable()

bool ParameterMap::getOneMinHighEnable

(

)

Returns true if one-minute high is enabled, otherwise false.

Returns

bool, true if one-minute high is enabled, otherwise false.

getOneMinLow()

int ParameterMap::getOneMinLow

(

)

Returns the one-minute low value.

Returns

int, the one-minute low value.

getOneMinLowEnable()

bool ParameterMap::getOneMinLowEnable

(

)

Returns true if one-minute low is enabled, otherwise false.

Returns

bool, true if one-minute low is enabled, otherwise false.

getSessionMax()

int ParameterMap::getSessionMax

(

)

Returns the session max value.

Returns

int, the session max value.

getSessionMaxEnable()

bool ParameterMap::getSessionMaxEnable

(

)

Returns true if session max is enabled, otherwise false.

Returns

bool, true if session max is enabled, otherwise false.

getTcpFinWaitTimeout()

int ParameterMap::getTcpFinWaitTimeout

(

)

Returns the tcp finwait-time value.

Returns

int, the tcp finwait-time value.

getTcpFinWaitTimeoutEnable()

bool ParameterMap::getTcpFinWaitTimeoutEnable

(

)

Returns true if tcp finwait-time is enabled, otherwise false.

Returns

bool, true if tcp finwait-time is enabled, otherwise false.

getTcpIdleTimeout()

int ParameterMap::getTcpIdleTimeout

(

)

Returns the tcp idle-time value.

Returns

int, the tcp idle-time value.

getTcpIdleTimeoutEnable()

bool ParameterMap::getTcpIdleTimeoutEnable

(

)

Returns true if tcp idle-time is enabled, otherwise false.

Returns

bool, true if tcp idle-time is enabled, otherwise false.

getTcpMaxIncompleteConn()

int ParameterMap::getTcpMaxIncompleteConn

(

)

Returns the tcp max-incomplete host value.

Returns

int, the tcp max-incomplete host value.

getTcpMaxIncompleteConnBlockTime()

int ParameterMap::getTcpMaxIncompleteConnBlockTime

(

)

Returns the tcp max-incomplete host block-time value.

Returns

int, the tcp max-incomplete host block-time value.

getTcpMaxIncompleteConnBlockTimeEnable()

bool ParameterMap::getTcpMaxIncompleteConnBlockTimeEnable

(

)

Returns true if tcp max-incomplete host block-time is enabled, otherwise false.

Returns

bool, true if tcp max-incomplete host block-time is enabled, otherwise false.

getTcpMaxIncompleteConnEnable()

bool ParameterMap::getTcpMaxIncompleteConnEnable

(

)

Returns true if tcp max-incomplete host is enabled, otherwise false.

Returns

bool, true if tcp max-incomplete host is enabled, otherwise false.

getTcpSynWaitTimeout()

int ParameterMap::getTcpSynWaitTimeout

(

)

Returns the tcp synwait-time value.

Returns

int, the tcp synwait-time value.

getTcpSynWaitTimeoutEnable()

bool ParameterMap::getTcpSynWaitTimeoutEnable

(

)

Returns true if tcp synwait-time is enabled, otherwise false.

Returns

bool, true if tcp synwait-time is enabled, otherwise false.

getUdpIdleTimeout()

int ParameterMap::getUdpIdleTimeout

(

)

Returns the udp idle-time value.

Returns

int, the tcp idle-time value.

getUdpIdleTimeoutEnable()

bool ParameterMap::getUdpIdleTimeoutEnable

(

)

Returns true if udp idle-time is enabled, otherwise false.

Returns

bool, true if udp idle-time is enabled, otherwise false.

isInUsed()

bool ParameterMap::isInUsed

(

)

Returns true if the parameter map is in use, otherwise false.

Returns

bool, true if the parameter map is in use, otherwise false.

setAlert()

void ParameterMap::setAlert

(

bool

)

Turns on or off alert.

Parameters

p_on_off,true

to enable alert, false to disable it.

setAlertEnable()

void ParameterMap::setAlertEnable

(

bool

)

Enables or disables alert.

Parameters

p_enable,true

to enable alert, false to disable it.

setAuditTrail()

void ParameterMap::setAuditTrail

(

bool

)

Turns on or off audit-trail.

Parameters

p_on_off,true

to enable audit-trail, false to disable it.

setAuditTrailEnable()

void ParameterMap::setAuditTrailEnable

(

bool

)

Enables or disables audit-trail.

Parameters

p_enable,true

to enable audit-trail, false to disable it.

setDnsTimeout()

void ParameterMap::setDnsTimeout

(

int

)

Sets the dns-timeout value.

Parameters

p_time,the

dns-timeout value.

setDnsTimeoutEnable()

void ParameterMap::setDnsTimeoutEnable

(

bool

)

Enables or disables dns-timeout.

Parameters

p_enable,true

to enable dns-timeout, false to disable it.

setIcmpIdleTimeout()

void ParameterMap::setIcmpIdleTimeout

(

int

)

Sets the icmp idle-timeout value.

Parameters

p_time,the

icmp idle-timeout value.

setIcmpIdleTimeoutEnable()

void ParameterMap::setIcmpIdleTimeoutEnable

(

bool

)

Enables or disables icmp idle-timeout.

Parameters

p_enable,true

to enable icmp idle-timeout, false to disable it.

setInUsed()

void ParameterMap::setInUsed

(

bool

)

Sets the parameter map as in use or not in use.

Parameters

p_used,true

for in use, false for not in use.

setMapType()

void ParameterMap::setMapType

(

ZfwMapType

)

Sets the type of the paramter map.

Parameters

mapType,the

type of the paramter map. Map types: type_default = 0, type_global = 1, type_inspect = 2,

setMaxIncompleteHigh()

void ParameterMap::setMaxIncompleteHigh

(

int

)

Sets the max-incomplete high value.

Parameters

p_num,the

max-incomplete high value.

setMaxIncompleteHighEnable()

void ParameterMap::setMaxIncompleteHighEnable

(

bool

)

Enables or disables max-incomplete high.

Parameters

p_enable,true

to enable max-incomplete high, false to disable it.

setMaxIncompleteLow()

void ParameterMap::setMaxIncompleteLow

(

int

)

Sets the max-incomplete low value.

Parameters

p_num,the

max-incomplete low value.

setMaxIncompleteLowEnable()

void ParameterMap::setMaxIncompleteLowEnable

(

bool

)

Enables or disables max-incomplete low.

Parameters

p_enable,true

to enable max-incomplete low, false to disable it.

setOneMinHigh()

void ParameterMap::setOneMinHigh

(

int

)

Sets the one-minute high value.

Parameters

p_num,the

one-minute high value.

setOneMinHighEnable()

void ParameterMap::setOneMinHighEnable

(

bool

)

Enables or disables one-minute high.

Parameters

p_enable,true

to enable one-minute high, false to disable it.

setOneMinLow()

void ParameterMap::setOneMinLow

(

int

)

Sets the one-minute low value.

Parameters

p_num,the

one-minute low value.

setOneMinLowEnable()

void ParameterMap::setOneMinLowEnable

(

bool

)

Enables or disables one-minute low.

Parameters

p_enable,true

to enable one-minute low, false to disable it.

setSessionMax()

void ParameterMap::setSessionMax

(

int

)

Sets the session max value.

Parameters

p_num,the

session max value.

setSessionMaxEnable()

void ParameterMap::setSessionMaxEnable

(

bool

)

Enables or disables session max.

Parameters

p_enable,true

to enable session max, false to disable it.

setTcpFinWaitTimeout()

void ParameterMap::setTcpFinWaitTimeout

(

int

)

Sets the tcp finwait-time value.

Parameters

p_time,the

tcp finwait-time value.

setTcpFinWaitTimeoutEnable()

void ParameterMap::setTcpFinWaitTimeoutEnable

(

bool

)

Enables or disables tcp finwait-time.

Parameters

p_enable,true

to enable tcp finwait-time, false to disable it.

setTcpIdleTimeout()

void ParameterMap::setTcpIdleTimeout

(

int

)

Sets the tcp idle-time value.

Parameters

p_time,the

tcp idle-time value.

setTcpIdleTimeoutEnable()

void ParameterMap::setTcpIdleTimeoutEnable

(

bool

)

Enables or disables tcp idle-time.

Parameters

p_enable,true

to enable tcp idle-time, false to disable it.

setTcpMaxIncompleteConn()

void ParameterMap::setTcpMaxIncompleteConn

(

int

)

Sets the tcp max-incomplete host value.

Parameters

p_num,the

tcp max-incomplete host value.

setTcpMaxIncompleteConnBlockTime()

void ParameterMap::setTcpMaxIncompleteConnBlockTime

(

int

)

Sets the tcp max-incomplete host block-time value.

Parameters

p_time,the

tcp max-incomplete host block-time value.

setTcpMaxIncompleteConnBlockTimeEnable()

void ParameterMap::setTcpMaxIncompleteConnBlockTimeEnable

(

bool

)

Enables or disables tcp max-incomplete host block-time.

Parameters

p_enable,true

to enable tcp max-incomplete host block-time, false to disable it.

setTcpMaxIncompleteConnEnable()

void ParameterMap::setTcpMaxIncompleteConnEnable

(

bool

)

Enables or disables tcp max-incomplete host.

Parameters

p_enable,true

to enable tcp max-incomplete host, false to disable it.

setTcpSynWaitTimeout()

void ParameterMap::setTcpSynWaitTimeout

(

int

)

Sets the tcp synwait-time value.

Parameters

p_time,the

tcp synwait-time value.

setTcpSynWaitTimeoutEnable()

void ParameterMap::setTcpSynWaitTimeoutEnable

(

bool

)

Enables or disables tcp synwait-time block-time.

Parameters

p_enable,true

to enable tcp synwait-time, false to disable it.

setUdpIdleTimeout()

void ParameterMap::setUdpIdleTimeout

(

int

)

Sets the udp idle-time value.

Parameters

p_time,the

udp idle-time value.

setUdpIdleTimeoutEnable()

void ParameterMap::setUdpIdleTimeoutEnable

(

bool

)

Enables or disables udp idle-time.

Parameters

p_enable,true

to enable udp idle-time, false to disable it.

toString()

string ParameterMap::toString

(

)

Returns the name of the parameter map.

Returns

string, the name of the parameter map.

---

The documentation for this class was generated from the following file:

• CParameterMap.pki