PATNATPool

Represents a PAT NAT Pool object.

Overview

addressRange string 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  
endAddressRange string filterable   orderable  
endSourceAddress string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
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
/gateways/id/patnatpools
get put
/patnatpools
get post
/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 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

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

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