OverlayPATNATEntry

Create a static NAT 1:1 IP mapping between a Pool IP and a host IP in the branch domain, to provide access to the branch resource.

Overview

associatedDomainID string
associatedLinkID string filterable   orderable  
creationDate string read only   autogenerated   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
NATEnabled boolean
owner string autogenerated  
privateIP string filterable   orderable  
publicIP string filterable   orderable  

API Resource

/overlaypatnatentries/id
delete get put

Parents

/overlayaddresspools/id/overlaypatnatentries
get post

Children

/overlaypatnatentries/id/metadatas
get post
/overlaypatnatentries/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedDomainID string
Discussion

The ID of the associated l3-domain.

Charateristics

Format: free
SDK attribute: associatedDomainID

associatedLinkID string filterable   orderable  
Discussion

The ID of the associated domain-link.

Charateristics

Format: free
SDK attribute: associatedLinkID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

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

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

NATEnabled boolean
Discussion

This flag will determine whether the entry is NAT or PAT.

Charateristics

Default value: true
Format: free
SDK attribute: NATEnabled

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

privateIP string filterable   orderable  
Discussion

Private IP address for the interface

Charateristics

Format: free
SDK attribute: privateIP

publicIP string filterable   orderable  
Discussion

Public IP address of the interface

Charateristics

Format: free
SDK attribute: publicIP