Overview Package Class Deprecated Help

nat
AbstractNatPlcy

Abstract class for NAT and Firewall policy.

public class AbstractNatPlcy

Properties
algBitMask Specifies the set of protocols for which the NAT Application Level Gateway (ALG) is enabled.

type=nat.AlgBitMask
default=ftp
Displayed(tab/group)=ALG Protocols (/NAT)
creationOrigin Indicates the mechanism used to create this entry.

type=nat.NatCreateOrigin
access=read-only
Displayed(tab/group)=Creation Origin (/Site)
filtering Specifies the type of NAT filtering to use with this Policy.

type=nat.NatFiltering
default=endpointIndependent
Displayed(tab/group)=Filtering (/NAT)
l2Outside Specifies that this nat-policy will be used with an L2 outside service instead of an L3 outside service. This node is mutually exclusive with the pool command.

type=boolean
default=false
Displayed(tab/group)=L2 Outside
maxPortFwdEntry Specifies the maximum number of port forwarding entries per subscriber. 0 means not forwarding allowed

type=int
default=0
minimum=0
maximum=64
natPlcyPurpose Indicates the purpose of this policy.

type=nat.NatPolicyPurpose
access=read-only
portFwdRangeEnd Specifies the end of the port range available for port forwarding. The start of the range is always equal to one. The actual maximum value of the object tmnxNatPlcyPortFwdRangeEnd may be restricted to less than 65535, depending on the system specifications.

type=int
default=1023
minimum=1023
maximum=65535
prioritySessionFCSet Specifies the forwarding classes that have their sessions prioritized. Prioritized sessions are allowed to use the ports from the reserved ports of a block.

type=nat.FcBitMask
default=0
Displayed(tab/group)=Priority Session Forwarding Class Set (/Session)
sessionLimit Specifies the maximum number of sessions allowed for a NAT subscriber associated with this policy.

type=int
default=65535
minimum=1
maximum=65535
Displayed(tab/group)=Session Limit (/Session)
sessionReservationCount Specifies, for each NAT subscriber associated with this policy, the number of sessions that are reserved within its allocation allowed by the value of SessionLimit. The value obtained by subtracting the sessionReservationCount from the SessionLimit is a soft session limit; this soft limit can only be exceeded by sessions that belong to one of the forwarding classes specified by the value of prioritySessionFCSet The value of sessionReservationCount must be smaller than the value of SessionLimit.

type=int
default=0
minimum=0
maximum=65534
Displayed(tab/group)=Reservation Count (/Session)
sessionWatermarkHigh Specifies the high watermark of the number of sessions for each NAT subscriber associated with this policy. The value of this object must be higher than the value of sessionWatermarkLow, unless both are equal to zero.

type=int
default=0
minimum=0
maximum=100
units=%
Displayed(tab/group)=Session High Watermark (/Session)
sessionWatermarkLow Specifies the low watermark of the number of sessions for each NAT subscriber with this policy. The value of this object must be lower than the value of sessionWatermarkHigh, unless both are equal to zero.

type=int
default=0
minimum=0
maximum=99
units=%
Displayed(tab/group)=Session Low Watermark (/Session)
sipTimeout Specifies the sip inactive media timeout, the time a temporary mapping remains active without any media traffic, range is 10 -2550.

Additional (Deprecation) Information

If the sipTimeout is set and either or all of the sipTimeoutSec, sipTimeoutMin, and sipTimeoutHr are set as well, the value of sipTimeout will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.sipTimeoutSec, nat.AbstractNatPlcy.sipTimeoutMin and nat.AbstractNatPlcy.sipTimeoutHr
type=int
default=120
minimum=10
maximum=7200
units=Seconds
sipTimeoutHr Specifies the hour(s) of the sip inactive media.

type=int
default=0
minimum=0
maximum=2
Displayed(tab/group)=Hours (Timeouts/SIP)
sipTimeoutMin Specifies the minute(s) of the sip inactive media.

type=int
default=2
minimum=0
maximum=59
Displayed(tab/group)=Minutes (Timeouts/SIP)
sipTimeoutSec Specifies the seconds of the sip inactive media.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/SIP)
tcpMssAdjust Specifies the TCP Maximum segment size(MSS).

type=int
default=0
minimum=0
maximum=10240
Displayed(tab/group)=TCP Maximum Segment Size (/NAT)
toIcmpQuery Specifies the timeout applied to an ICMP Query session.

Additional (Deprecation) Information

If the toIcmpQuery is set and either or all of the toIcmpQuerySec and toIcmpQueryMin, are set as well, the value of toIcmpQuery will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toIcmpQuerySec and nat.AbstractNatPlcy.toIcmpQueryMin
type=int
default=60
minimum=60
maximum=240
units=Seconds
toIcmpQueryMin Specifies the minute(s) of timeout applied to an ICMP Query session.

type=int
default=1
minimum=0
maximum=4
Displayed(tab/group)=Minutes (Timeouts/ICMP Query Session)
toIcmpQuerySec Specifies the seconds of timeout applied to an ICMP Query session.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/ICMP Query Session)
toTcpEstab Specifies the idle timeout applied to a TCP session in the established state.

Additional (Deprecation) Information

If the toTcpEstab is set and either or all of the toTcpEstabSec, toTcpEstabMin, toTcpEstabHr and toTcpEstabDay are set as well, the value of toTcpEstab will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toTcpEstabSec, nat.AbstractNatPlcy.toTcpEstabMin, nat.AbstractNatPlcy.toTcpEstabHr and nat.AbstractNatPlcy.toTcpEstabDay
type=int
default=7440
minimum=60
maximum=86400
units=Seconds
toTcpEstabDay Specifies the day of idle timeout applied to a TCP session in the established state.

type=int
default=0
minimum=0
maximum=1
Displayed(tab/group)=Days (Timeouts/TCP Established)
toTcpEstabHr Specifies the hour(s) of idle timeout applied to a TCP session in the established state.

type=int
default=2
minimum=0
maximum=23
Displayed(tab/group)=Hours (Timeouts/TCP Established)
toTcpEstabMin Specifies the minute(s) of idle timeout applied to a TCP session in the established state.

type=int
default=4
minimum=0
maximum=59
Displayed(tab/group)=Minutes (Timeouts/TCP Established)
toTcpEstabSec Specifies the seconds of idle timeout applied to a TCP session in the established state.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/TCP Established)
toTcpRstMin Specifies minute(s) of the timeout after receiving a RST and closing the session before going to the LISTEN state again. This has the effect of blocking a new TCP session with the same port during this time.

type=int
default=0
minimum=0
maximum=4
Displayed(tab/group)=Minutes (Timeouts/TCP RST)
toTcpRstSec Specifies seconds of the timeout after receiving a RST and closing the session before going to the LISTEN state again. This has the effect of blocking a new TCP session with the same port during this time.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/TCP RST)
toTcpSyn Specifies the timeout applied to a TCP session when synchronizing its initial sequence.

Additional (Deprecation) Information

If the toTcpSyn is set and either or all of the toTcpSynSec, toTcpSynMin, toTcpSynHr and toTcpSynDay are set as well, the value of toTcpSyn will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toTcpSynSec, nat.AbstractNatPlcy.toTcpSynMin, nat.AbstractNatPlcy.toTcpSynHr and nat.AbstractNatPlcy.toTcpSynDay
type=int
default=15
minimum=6
maximum=86400
units=Seconds
toTcpSynDay Specifies the day of timeout applied to a TCP session when synchronizing its initial sequence.

type=int
default=0
minimum=0
maximum=1
Displayed(tab/group)=Days (Timeouts/TCP Synchronization)
toTcpSynHr Specifies the hour(s) of timeout applied to a TCP session when synchronizing its initial sequence

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (Timeouts/TCP Synchronization)
toTcpSynMin Specifies the minute(s) of timeout applied to a TCP session when synchronizing its initial sequence.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Minutes (Timeouts/TCP Synchronization)
toTcpSynSec Specifies the seconds of timeout applied to a TCP session when synchronizing its initial sequence.

type=int
default=15
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/TCP Synchronization)
toTcpTimeWait Specifies the timeout before leaving the TIME-WAIT state and entering the CLOSED state.

Additional (Deprecation) Information

If the toTcpTimeWait is set and either or all of the toTcpTimeWaitSec and toTcpTimeWaitMin, are set as well, the value of toTcpTimeWait will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toTcpTimeWaitSec and nat.AbstractNatPlcy.toTcpTimeWaitMin
type=int
default=0
minimum=0
maximum=240
units=Seconds
toTcpTimeWaitMin Specifies the minute(s) of the timeout before leaving the TIME-WAIT state and entering the CLOSED state.

type=int
default=0
minimum=0
maximum=4
Displayed(tab/group)=Minutes (Timeouts/TCP Time Wait)
toTcpTimeWaitSec Specifies the seconds of the timeout before leaving the TIME-WAIT state and entering the CLOSED state.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/TCP Time Wait)
toTcpTrans Specifies the idle timeout applied to a TCP session in a transitory state.

Additional (Deprecation) Information

If the toTcpTrans is set and either or all of the toTcpTransSec, toTcpTransMin, toTcpTransHr and toTcpTransDay are set as well, the value of toTcpTrans will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toTcpTransSec, nat.AbstractNatPlcy.toTcpTransMin, nat.AbstractNatPlcy.toTcpTransHr and nat.AbstractNatPlcy.toTcpTransDay
type=int
default=240
minimum=60
maximum=86400
units=Seconds
toTcpTransDay Specifies the day of idle timeout applied to a TCP session in a transitory state.

type=int
default=0
minimum=0
maximum=1
Displayed(tab/group)=Days (Timeouts/TCP Transitory)
toTcpTransHr Specifies the hour(s) of idle timeout applied to a TCP session in a transitory state.

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (Timeouts/TCP Transitory)
toTcpTransMin Specifies the minute(s) of idle timeout applied to a TCP session in a transitory state.

type=int
default=4
minimum=0
maximum=59
Displayed(tab/group)=Minutes (Timeouts/TCP Transitory)
toTcpTransSec Specifies the seconds of idle timeout applied to a TCP session in a transitory state.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/TCP Transitory)
toUdp Specifies the UDP mapping timeout.

Additonal (Deprecation) Information

If the toUdp is set and either or all of the toUdpSec, toUdpMin, toUdpHr and toUdpDay are set as well, the value of toUdp will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toUdpSec, nat.AbstractNatPlcy.toUdpMin, nat.AbstractNatPlcy.toUdpHr and AbstractNatPlcy.toUdpDay
type=int
default=300
minimum=60
maximum=86400
units=Seconds
toUdpDay Specifies the day of the UDP mapping timeout.

type=int
default=0
minimum=0
maximum=1
Displayed(tab/group)=Days (Timeouts/UDP)
toUdpDns Specifies the timeout applied to a UDP session with destination port 53.

Additional (Deprecation) Information

If the toUdpDns is set and either or all of the toUdpDnsSec, toUdpDnsMin, toUdpDnsHr and toUdpDnsDay are set as well, the value of toUdpDns will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toUdpDnsSec, nat.AbstractNatPlcy.toUdpDnsMin, nat.AbstractNatPlcy.toUdpDnsHr and nat.AbstractNatPlcy.toUdpDnsDay
type=int
default=15
minimum=15
maximum=86400
units=Seconds
toUdpDnsDay Specifies the day of timeout applied to a UDP session with destination port 53.

type=int
default=0
minimum=0
maximum=1
Displayed(tab/group)=Days (Timeouts/UDP DNS)
toUdpDnsHr Specifies the hour(s) of timeout applied to a UDP session with destination port 53.

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (Timeouts/UDP DNS)
toUdpDnsMin Specifies the minute(s) of timeout applied to a UDP session with destination port 53.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Minutes (Timeouts/UDP DNS)
toUdpDnsSec Specifies the seconds of timeout applied to a UDP session with destination port 53.

type=int
default=15
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/UDP DNS)
toUdpHr Specifies the hour(s) of the UDP mapping timeout.

type=int
default=0
minimum=0
maximum=23
Displayed(tab/group)=Hours (Timeouts/UDP)
toUdpInitial Specifies the UDP mapping timeout to be applied for new UDP mappings, where only a single packet has been transmitted.

Additional (Deprecation) Information

If the toUdpInitial is set and either or all of the toUdpInitialSec and toUdpInitialMin are set as well, the value of toUdpInitial will be ignored.

DEPRECATED: 17.3 - In the future, this property will be used internally. Please use nat.AbstractNatPlcy.toUdpInitialSec and nat.AbstractNatPlcy.toUdpInitialMin
type=int
default=15
minimum=10
maximum=300
units=Seconds
toUdpInitialMin Specifies the minute(s) of the UDP mapping timeout to be applied for new UDP mappings, where only a single packet has been transmitted.

type=int
default=0
minimum=0
maximum=5
Displayed(tab/group)=Minutes (Timeouts/UDP Initial)
toUdpInitialSec Specifies the seconds of the UDP mapping timeout to be applied for new UDP mappings, where only a single packet has been transmitted.

type=int
default=15
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/UDP Initial)
toUdpMin Specifies the minute(s) of the UDP mapping timeout.

type=int
default=5
minimum=0
maximum=59
Displayed(tab/group)=Minutes (Timeouts/UDP)
toUdpSec Specifies the seconds of the UDP mapping timeout.

type=int
default=0
minimum=0
maximum=59
Displayed(tab/group)=Seconds (Timeouts/UDP)
udpInbndRefresh Specifies the NAT inbound refresh behavior.

type=boolean
default=false
Displayed(tab/group)=UDP Inbound Refresh (/NAT)
 
Overridden Properties
description The Policy Description

displayedName The Policy Name

access=read-create
minimum=1
maximum=32
 
Properties inherited from policy.PolicyDefinition
configurationAction, configurationMode, discoveryState, displayedName, distributionMode, isMaster, lastSyncTime, numberOfUnderlyingPolicyItems, origin, policyMode, policySyncGroupPointer, policyType
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7450 ESS
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0