PATNATPool

Address Translation Pools are a range of externally routable IP addresses. User or application traffic is translated prior to being forwarded across the network.

Overview

addressRange string deprecated   filterable   orderable  
associatedGatewayId string filterable   orderable  
associatedGatewayType enum (AUTO_DISC_GATEWAY | GATEWAY | IKE_GATEWAY | NSGATEWAY)
associatedSubnetId string filterable   orderable  
associatedVlanId string filterable   orderable  
defaultPATIP string filterable   orderable  
description string
dynamicSourceEnabled boolean filterable   orderable  
embeddedMetadata list read only   autogenerated  
endAddressRange string filterable   orderable  
endSourceAddress string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPType enum (DUALSTACK | IPV4 | IPV6) filterable   orderable  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
startAddressRange string filterable   orderable  
startSourceAddress string filterable   orderable  

API Resource

/patnatpools/id
delete get put

Parents

/enterprises/id/patnatpools
get
/patnatpools
get post
/netconfgateways/id/patnatpools
get put
/gateways/id/patnatpools
get put
/nsgateways/id/patnatpools
get put
/vlans/id/patnatpools
get put

Children

/patnatpools/id/natmapentries
get post
/patnatpools/id/addressmaps
get post
/patnatpools/id/metadatas
get post
/patnatpools/id/globalmetadatas
get post put
/patnatpools/id/enterprisepermissions
get post
/patnatpools/id/statistics
get
/patnatpools/id/statisticspolicies
get post
/patnatpools/id/bulkstatistics
get

Members

This object has no members.

Attributes documentation

addressRange string deprecated   filterable   orderable  
Discussion

Default PAT IP Address, must belong to the pool above

Charateristics

Format: free
Max length: 255
SDK attribute: addressRange

associatedGatewayId string filterable   orderable  
Discussion

UUID of the NSG instance this Pool is assocated with. This attribute may be auto-populated when the pool is assigned to a Network VLAN instance.

Charateristics

Format: free
SDK attribute: associatedGatewayId

associatedGatewayType enum
Discussion

None

Charateristics

Allowed values: AUTO_DISC_GATEWAY, GATEWAY, IKE_GATEWAY, NSGATEWAY
SDK attribute: associatedGatewayType

associatedSubnetId string filterable   orderable  
Discussion

ID of the Subnet for which the information will be used to populate Source Address Range (Dynamic Source NAT).

Charateristics

Format: free
SDK attribute: associatedSubnetId

associatedVlanId string filterable   orderable  
Discussion

ID of the network port VLAN on which the pool is associated.

Charateristics

Format: free
SDK attribute: associatedVlanId

defaultPATIP string filterable   orderable  
Discussion

Default PAT IP Address, must belong to the pool above

Charateristics

Format: free
SDK attribute: defaultPATIP

description string
Discussion

A description of the PATNATPool

Charateristics

Format: free
Max length: 255
SDK attribute: description

dynamicSourceEnabled boolean filterable   orderable  
Discussion

Set to True if the address translation pool at the address translation pool definition level

Charateristics

SDK attribute: dynamicSourceEnabled

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

endAddressRange string filterable   orderable  
Discussion

Ending IP Address for the pool of available addresses for use

Charateristics

Format: free
Max length: 64
SDK attribute: endAddressRange

endSourceAddress string filterable   orderable  
Discussion

Ending Source IP Address for the pool. (Dynamic Source NAT)

Charateristics

Format: free
Max length: 64
SDK attribute: endSourceAddress

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

IPType enum filterable   orderable  
Discussion

The IP type of this Address Translation Pool. This can be DUALSTACK, IPV4 or IPV6

Charateristics

Allowed values: DUALSTACK, IPV4, IPV6
SDK attribute: IPType

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the PATNATPool

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction

startAddressRange string filterable   orderable  
Discussion

Starting IP Address for the pool of available addresses for use

Charateristics

Format: free
Max length: 64
SDK attribute: startAddressRange

startSourceAddress string filterable   orderable  
Discussion

Starting Source IP Address for the pool. (Dynamic Source NAT)

Charateristics

Format: free
Max length: 64
SDK attribute: startSourceAddress