Overview Package Class Deprecated Help

nat
StaticPortMapRequest

This object is not persisted in NFM-P. It is only to be used for passing request information for APIs to create/modify/delete static port forwarding. These include methods like applyStaticPortMapRequest, applyStaticPortMapRequests, applyStaticPortMapRequestWithResult etc. User should never try to create/delete/modify this object itself.

public class StaticPortMapRequest

Properties
actionType Specifies the type of the action: Create/Modify/Delete

type=nat.ActionType
default=create
aftrAddressType The value of aftrAddressType specifies the address type of ipv6AftrAddress

type=rtr.InetAddressType
access=read-create
default=ipv6
b4AddressType The value of b4AddressType specifies the address type of ipv6B4Address

type=rtr.InetAddressType
access=read-create
default=ipv6
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
expiryTime The value of sysUpTime at the last time that the object success was written by the system.

type=Date
access=read-only
ipAddress The inside IP address

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Inside IP Address
ipAddressType The value of ipAddressType specifies the address type of ipAddress

type=rtr.InetAddressType
access=read-create
default=ipv4
ipv6AftrAddress specifies the inside Dual Stack Lite AFTR IPv6 address. Broadcast, multicast or martian IP addresses are not allowed. Set this value of if the forwarding entry is for a Dual Stack Lite subscriber."

type=InetAddress
access=read-create
default=
Mandatory on create
Displayed(tab/group)=AFTR Address (/DS Lite)
ipv6B4Address Specifies the inside Dual Stack Lite B4 IPv6 address. Broadcast, multicast or martian IP addresses are not allowed. Set this value if the forwarding entry is for a Dual Stack Lite subscriber.

type=InetAddress
access=read-create
default=
Mandatory on create
Displayed(tab/group)=B4 Address (/DS Lite)
natFwdSaveConfig The value of natFwdSaveConfig specifies during creation if the system must save the forwarding entry in the configuration file.

type=boolean
default=false
Displayed(tab/group)=NAT Forward Save Config
natPolicyPointer Specifies the pointer name of the NAT policy to be used when the value of Protocol is nat. When not specified the inside nat policy will be used.

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=NAT Policy
nodeId Specifies the node Id (IP Address)

type=string
access=read-create
maximum=64
Mandatory on create
Displayed(tab/group)=Targeted Node
outIpAddress Specifies the outside IP address allocated to the host. If any address is acceptable, do not set the value of outIpAddress; in this case, if a corresponding row exists in the tmnxNatL2AwSubTable, the tmnxNatDsliteSubTable or the tmnxNatLsnSubTable, the system will try to use the same outside IP address.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Outside IP Address
outIpAddressType The value of ipAddressType specifies the address type of ipAddress

type=rtr.InetAddressType
default=ipv4
outPort Specifies the outside port. If any port is acceptable, do not specify the value outPort in this case, the system will use the same value as for the inside port."

type=int
default=0
minimum=1
maximum=65535
Displayed(tab/group)=Outside Port
port The Inside Port number

type=int
minimum=1
maximum=65535
Displayed(tab/group)=Inside Port
protocol specifies the IP protocol.

type=nat.ProtocolEnum
access=read-create
default=TCP
Displayed(tab/group)=Protocol
redundantNodeId Specifies the redundant node Id (IP Address). This optional parameter will only be used when creating SPFs with wildcard outside IP address.

type=string
default=
Displayed(tab/group)=Site ID (/Standby Pool Routing Instance)
redundantRouterId Specifies the Redundant Virtual Routing Instance. This optional parameter will only be used when creating SPFs with wildcard outside IP address.

type=int
default=0
minimum=1
maximum=10240
routerId Specifies the Virtual Router Instance. Set this value if the forwarding entry is for a Large Scale NAT subscriber."

type=int
access=read-create
default=1
subIdent Specifies the identification of the Layer-2-Aware NAT subscriber. Set this value if the forwarding entry is for a Layer-2-Aware NAT subscriber.

type=string
Displayed(tab/group)=Subscriber ID
subType Specifies the type of subscriber where the action is done for: LSN. L2Aware. DS Lite. NAT64 LSN

type=nat.SubTypes
default=lsn
Displayed(tab/group)=Type
supressDuplicateError Specifies should the error message be shown when SPF already exists.

type=boolean
Displayed(tab/group)=Suppress Duplicate Error
timeout Specifies the timeout applied to the NAT forwarding entry. The value zero specifies that the forwarding entry does not time out.

type=long
minimum=60
maximum=86400
units=Seconds
Displayed(tab/group)=Lifetime
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

applyStaticPortMapRequest

Method will not return errors through exceptions, but will use JMS instead. If the caller is not able to listen to JMS events but is interested in error conditions, 'applyStaticPortMapRequestWithResult' method should be used. For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters, "actionType", "ipAddress", "routerId" and "nodeId" for creation. Although, for delete/modify "port"(inside) value is required along with above mandatory parameters. However for the parameters "ipAddresstype", "subType" and "protocol" if a value is not defined the default value will be provided before deployment. For L2-Aware type everything remains the same except in SPF request user has to specify "subIdent" parameter to create, modify or delete.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
aInRequest : config(nat.StaticPortMapRequest) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : config(nat.StaticPortMapRequest) -

applyStaticPortMapRequestWithResult

For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters, "actionType", "ipAddress", "routerId" and "nodeId" for creation. Although, for delete/modify "port"(inside) value is required along with above mandatory parameters. However for the parameters "ipAddresstype", "subType" and "protocol" if a value is not defined the default value will be provided before deployment. For L2-Aware type everything remains the same except in SPF request user has to specify "subIdent" parameter to create, modify or delete.
Input Parameters:
aInRequest : config(nat.StaticPortMapRequest) -
aInValidate : boolean - (Optional) This attribute only controls the validation case where the "StaticPortMapRequest.nodeId" and "StaticPortMapRequest.routerId" specified in the "aInRequest" parameter. if "aInValidate" is set to "true", there will be a check to see the NE identified by "StaticPortMapRequest.nodeId" is managed by NFM-P and the "StaticPortMapRequest.routerId" exists on this NE. If the NE is not managed by NFM-P or if the Router Id does not exist on the NE an error will be returned. This check is done for for Sync, Modification and Deletion request types only. This is an optional attribute and its default value is "false". Note: The Creation request is not controlled by this attribute. During a creation request if the NE identified by "StaticPortMapRequest.nodeId" is not managed by NFM-P or the "StaticPortMapRequest.routerId" does not exist on this node an error will be returned irrespective of the value of "aInValidate". If NFM-P manages the NE and the Router Id is valid, existing validation and error checking will be enforced.
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 (summary(nat.StaticPortMapping)) -

applyStaticPortMapRequests

Method will not return errors through exceptions, but will use JMS instead. If the caller is not able to listen to JMS events but is interested in error conditions, 'applyStaticPortMapRequestWithResult' method should be used. For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters, "actionType", "ipAddress", "routerId" and "nodeId" for creation. Although, for delete/modify "port"(inside) value is required along with above mandatory parameters. However for the parameters "ipAddresstype", "subType" and "protocol" if a value is not defined the default value will be provided before deployment. For L2-Aware type everything remains the same except in SPF request user has to specify "subIdent" parameter to create, modify or delete.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
aInRequests : List (config(nat.StaticPortMapRequest)) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
results : List (config(nat.StaticPortMapRequest)) -
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