OverlayAddressPool

The address pool the public IP of the PAT/NAT entries belong too.

Overview

associatedDomainID string
creationDate string read only   autogenerated   orderable  
description string
embeddedMetadata list read only   autogenerated  
endAddressRange string creation only   filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
IPType enum (DUALSTACK | IPV4 | IPV6) filterable   orderable  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
owner string autogenerated  
startAddressRange string creation only   filterable   orderable  

API Resource

/overlayaddresspools/id
delete get put

Parents

/links/id/overlayaddresspools
get post

Children

/overlayaddresspools/id/permissions
delete get post put
/overlayaddresspools/id/metadatas
get post
/overlayaddresspools/id/globalmetadatas
get post put
/overlayaddresspools/id/overlaypatnatentries
get post

Members

This object has no members.

Attributes documentation

associatedDomainID string
Discussion

The ID of the associated l3-domain.

Charateristics

Format: free
SDK attribute: associatedDomainID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string
Discussion

addresspool description

Charateristics

Format: free
Max length: 255
SDK attribute: description

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 creation only   filterable   orderable  
Discussion

The end address for the pool range.

Charateristics

Format: free
Max length: 64
SDK attribute: endAddressRange

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 Overlay Address Pool, possible values are IPV4, IPV6 or DUALSTACK.

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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name for the PAT NAT pool

Charateristics

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

startAddressRange string creation only   filterable   orderable  
Discussion

Start address for the pool range

Charateristics

Format: free
Max length: 64
SDK attribute: startAddressRange