nat
NatPool



public class NatPool

Stats:
nat.NatPoolL2AwStats nat.NatPoolLsnStats

Properties
adminState The value of adminState specifies the administrative state of this NAT address pool.

type=nat.NatAdminState
default=outOfService
Displayed(tab/group)=Administrative State (/NAT)

application This specifies the special applications this NAT address pool is used for.

type=nat.NatPoolApplBitMask
access=read-create
default=0
Displayed(tab/group)=Application (/NAT)

blockUsage Indicates the block usage

DEPRECATED: 11.0 R1 WARNING: This property should not be used. Use nat.NatPoolL2AwStats or nat.NatPoolLsnStats instead
type=int
access=read-only
minimum=0
maximum=100

blockUsageHi If true, indicates that the block usage is high

DEPRECATED: 11.0 R1 WARNING: This property should not be used. Use nat.NatPoolL2AwStats or nat.NatPoolLsnStats instead
type=boolean
access=read-only

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

description The description for this Pool

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description

displayedName The name of this Pool

type=string
access=read-create
default=
minimum=1
maximum=32
Mandatory on create
Displayed(tab/group)=Displayed Name

externalAssignment Specifies if the IP addresses in this Layer-2-Aware NAT address pool are assigned by an external entity rather than by this system.

type=boolean
default=false
Displayed(tab/group)=External Assignment (/NAT)

isaGroupPointer The value of isaGroupPointer specifies the identifier of the NAT Integrated Service Adaptor group associated with this NAT address pool.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=ISA Group (/NAT)

mode Specifies the mode of operation of this NAT address pool : auto or NAPT The value of Mode is only relevant while the value of tmnxNatPlType is equal to 'largeScale'; while the value of tmnxNatPlType is equal to 'l2Aware, the mode of operation is always NAPT.

type=nat.NatMode
default=auto
Displayed(tab/group)=Pool Mode (/NAT/Reservation)

nat.LsnPoolExt-Set type=Children-Set
nat.PoolRange-Set type=Children-Set
natPoolType The value of natPoolType specifies the type of this NAT address pool.

type=nat.NatPoolTypeEnum
access=read-create
default=largeScale
Displayed(tab/group)=NAT Pool Type (/NAT)

operationalMode The actual mode of operation of this NAT address pool. the actual mode can be NAPT or 1:1 NAT (also known as 'Basic NAT')

type=nat.NatOperMode
access=read-only
Displayed(tab/group)=Operational Pool Mode (/NAT/Reservation)

portForwardingDynBlockReservation The portForwardingDynBlockReservation attribute specifies if the port blocks are being reserved for regular dynamic NAT traffic flow on behalf of a subscriber that has a port forwarding entry.

type=boolean
default=false
Displayed(tab/group)=Port Forwarding Dynamic Block Reservation

portFwdRangeEnd Specifies the end of the port range available for port forwarding. The start of the range is always equal to one. The maximum value of portFwdRangeEnd may be restricted to less than 65535, depending on the value of the objects tmnxNatPlPortResvType and tmnxNatPlPortResvVal and on system specifications.

type=int
default=1023
minimum=1023
maximum=65535
Displayed(tab/group)=Port Forward Range End (/NAT/Reservation)

portReservationType The value of portReservationType specifies how the whole ephemeral port range is split up in blocks. Each of those blocks can be associated with a host. The type of port reservation specifies the meaning of the value of the object portReservationValue The value of the object portReservationType must be changed together with the value of the object portReservationValue.

type=nat.PortReservationTypeEnum
default=Blocks
Displayed(tab/group)=Port Reservation Type (/NAT/Reservation)

portReservationValue If the value of the object portReservationType is equal to 'ports', the value of portReservationValue specifies the number of ports in a port range. If the value of the object portReservationType is equal to 'blocks', the value of portReservationValue specifies in how many blocks the whole ephemeral port range is split up. The value of the object portReservationValue must be changed together with the value of the object portReservationType.

type=int
default=128
minimum=1
maximum=64512
Displayed(tab/group)=Port Reservation Value (/NAT/Reservation)

routerId Specifies the Virtual Router Instance

type=int
access=read-only
default=1
minimum=1
maximum=10240

routerName The name of this Pool

type=string
access=read-only

watermarkHigh The value of the object watermarkHigh specifies the high watermark of the block usage of this NAT address pool. The value of the object watermarkHigh must be higher than the value of the object watermarkLow, unless both are equal to zero.

type=int
default=0
minimum=0
maximum=100
units=%
Displayed(tab/group)=High Watermark (/NAT/Watermark)

watermarkLow The value of the object watermarkLow specifies the high watermark of the block usage of this NAT address pool. The value of the object watermarkLow must be lower than the value of the object watermarkHigh, unless both are equal to zero.

type=int
default=0
minimum=0
maximum=99
units=%
Displayed(tab/group)=Low Watermark (/NAT/Watermark)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

requestNatPoolHistogram

This method allows to request the creation of a port usage histogram for a given NAT pool.
Input Parameters:
aInNatPoolFullName : Pointer - Fully Descriptive Name (FDN) of the NAT Pool on which the NAT Pool Histogram action is to be performed. FDN for VPRN routing instance should be: svc-mgr:service-id:node-system-address:NAT:natpool-name For example, if VPRN service-id is 212, the node system address is 1.3.1.3, and the pool name is 'Test', the FDN would be: svc-mgr:service-212:1.3.1.3:NAT:natpool-Test. FDN for Base routing instance should be: network:node-system-address:router-1:NAT:natpool-name For example, if the node system address is 1.3.1.3 and the pool name is 'Test', the FDN would be: network:1.3.1.3:router-1:NAT:natpool-Test
aInBucketSize : long - Specifies bucket size of the histogram. It is plotted along the X-axis and the acceptable value range is 1 to 65536.
aInNumBuckets : long - Specifies the number of buckets in the histogram. It is plotted along the Y-axis and the acceptable value range is 2 to 50.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : List (nat.NatPoolHistogram) -
Supported Network Elements
7750 SR Supported from 10.0.R1 until 12.0.R1
  • Excluded chassis types: 7750-SRc12, 7750-SRc4, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 12.0.R1 until 13.0.R8
  • Excluded chassis types: 7750-SRc4, 7750-SRa4, 7750-SRa8, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 13.0.R8 until 20.5.R1
  • Excluded chassis types: 7750-SRc4, 7750-SRa4, 7750-SRa8, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 20.5.R1
  • Excluded chassis types: 7750-SRa4, 7750-SRa8, 7750 SR-14s
7705 SAR Gen 2
7450 ESS Supported from 11.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
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