InfrastructureGatewayProfile

Represents Infrastructure Gateway Profile

Overview

controllerLessDuration string
controllerLessForwardingMode enum (DISABLED | LOCAL_AND_REMOTE | LOCAL_ONLY)
controllerLessRemoteDuration string
datapathSyncTimeout integer
deadTimer string
deadTimerEnabled boolean
description string filterable   orderable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
flowEvictionThreshold integer filterable   orderable  
forceImmediateSystemSync boolean
lastUpdatedBy string autogenerated  
metadataUpgradePath string
name string required   filterable   orderable  
NTPServerKey string
NTPServerKeyID integer
openFlowAuditTimer integer
proxyDNSName string required   filterable   orderable  
remoteLogMode enum (DISABLED | RSYSLOG)
remoteLogServerAddress string
remoteLogServerPort integer
statsCollectorPort integer
systemSyncScheduler string
upgradeAction enum (DOWNLOAD_AND_UPGRADE_AT_WINDOW | DOWNLOAD_AND_UPGRADE_NOW | DOWNLOAD_ONLY | NONE | UPGRADE_AT_BOOTSTRAPPING | UPGRADE_NOW)
useTwoFactor boolean

API Resource

/infrastructuregatewayprofiles/id
delete get put

Parents

/infrastructuregatewayprofiles
get post

Children

/infrastructuregatewayprofiles/id/metadatas
get post
/infrastructuregatewayprofiles/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

controllerLessDuration string
Discussion

Duration for a controller-less local operation (in ISO-duration format).


Charateristics

Default value: PT7D
Format: free
SDK attribute: controllerLessDuration

controllerLessForwardingMode enum
Discussion

The forwarding mode to use for controllerLess operations


Charateristics

Allowed values: DISABLED, LOCAL_AND_REMOTE, LOCAL_ONLY
Default value: DISABLED
SDK attribute: controllerLessForwardingMode

controllerLessRemoteDuration string
Discussion

Duration for a controller-less remote operation (in ISO-duration format).


Charateristics

Default value: PT7D
Format: free
SDK attribute: controllerLessRemoteDuration

datapathSyncTimeout integer
Discussion

Datapath flows sync-time-interval specified in milliseconds


Charateristics

Default value: 1000
Min value: 1000
Max value: 60000
SDK attribute: datapathSyncTimeout

deadTimer string
Discussion

ISO 8601 format duration: **P nYnMnD T nHnMnS**. **P** represents the period field and **T** the time field. Period field: **Y** = year, **M** = month, **D** = day. Time field: **H** = hours, **M** = minutes, **S** = seconds. **n** is the value of each field. Because the years and month are units that vary in length, for the time being those are not supported yet.


Charateristics

SDK attribute: deadTimer

deadTimerEnabled boolean
Discussion

Flag to enable automatic deactivation.


Charateristics

SDK attribute: deadTimerEnabled

description string filterable   orderable  
Discussion

A description of the Profile instance created.


Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string
Discussion

Enterprise/Organisation associated with this Profile instance.


Charateristics

Format: free
SDK attribute: enterpriseID

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

flowEvictionThreshold integer filterable   orderable  
Discussion

Number of flows at which eviction from kernel flow table will be triggered (default: 2500)


Charateristics

Default value: 2500
Min value: 100
Max value: 200000
SDK attribute: flowEvictionThreshold

forceImmediateSystemSync boolean
Discussion

Usually the synchronization will span across 1 hour window after the defined synchronization time. Forcing an immediate synchronization can overload the system and can have a negative impact on the system.


Charateristics

SDK attribute: forceImmediateSystemSync

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

metadataUpgradePath string
Discussion

Path/URL to retrieve the NSG Upgrade information meta data files. From that meta data, the NSG will be able to retrieve the upgrade package files and perform some validations. It is expected that the meta data file is in JSON format. RFC 2616 states that there are no 'official' maximum length for a URL but different browsers and servers have limits. Our friendly Internet Explorer has a maximum of 'around' 2048 characters, we shall use this as a limit here.


Charateristics

Format: free
Max length: 2048
SDK attribute: metadataUpgradePath

name string required   filterable   orderable  
Discussion

Name of the Infrastructure Profile


Charateristics

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

NTPServerKey string
Discussion

If set, this represents the security key for the Gateway to communicate with the NTP server (a VSC).


Charateristics

Format: free
Max length: 32
SDK attribute: NTPServerKey

NTPServerKeyID integer
Discussion

Correspond to the key ID on the NTP server that matches the ntpServerKey value. Valid values are from 1 to 255 as specified by SR-OS and 0 to specify unused (VSD/NSG only).


Charateristics

Max value: 255
SDK attribute: NTPServerKeyID

openFlowAuditTimer integer
Discussion

Openflow audit timer in sec. Upon the expiry of this timer a set of cleanup operations will be performed


Charateristics

Default value: 180
Min value: 180
Max value: 1800
SDK attribute: openFlowAuditTimer

proxyDNSName string required   filterable   orderable  
Discussion

Proxy DNS Name : DNS Name of the system acting as a proxy between the NSG instances and the VSD.


Charateristics

Format: free
SDK attribute: proxyDNSName

remoteLogMode enum
Discussion

Type of Log Server for system logs generated by Gateways associated with this Infrastructure Profile.


Charateristics

Allowed values: DISABLED, RSYSLOG
SDK attribute: remoteLogMode

remoteLogServerAddress string
Discussion

Primary Log Server for system logs generated by Gateways associated with this Infrastructure Profile. Can be an IP address or a URL. This field is optional.


Charateristics

Format: free
Max length: 255
SDK attribute: remoteLogServerAddress

remoteLogServerPort integer
Discussion

Port to be used to access the Remote Syslog server. By default, this is port 514.


Charateristics

Min value: 1
Max value: 65535
SDK attribute: remoteLogServerPort

statsCollectorPort integer
Discussion

The port to open by the proxy for stats collector to use


Charateristics

Default value: 39090
Min value: 1024
Max value: 65535
SDK attribute: statsCollectorPort

systemSyncScheduler string
Discussion

Time in a Cron format when configuration update are being applied on the Gateway (NSG). This property is linked to systemSyncWindow. Default value is every midnight (0 0 * * *). Format: Minutes Hours DayOfMonth Month DayOfWeek


Charateristics

Format: free
Max length: 64
SDK attribute: systemSyncScheduler

upgradeAction enum
Discussion

Upgrade action for NSG associated with this Infrastructure Gateway Profile instance.


Charateristics

Allowed values: DOWNLOAD_AND_UPGRADE_AT_WINDOW, DOWNLOAD_AND_UPGRADE_NOW, DOWNLOAD_ONLY, NONE, UPGRADE_AT_BOOTSTRAPPING, UPGRADE_NOW
SDK attribute: upgradeAction

useTwoFactor boolean
Discussion

Use Two Factor : When set to true, the use of two independent authentication factors will be used to secure the installed NSG. When set to false, there is an assumption that the NSG is being installed in a secure environment and the installer is also trusted. The defaut value is true, using 2-factor.


Charateristics

SDK attribute: useTwoFactor