SystemConfig

The System Configuration which can be dynamically managed using REST Api.

Overview

AARFlowStatsInterval integer
AARProbeStatsInterval integer
accumulateLicensesEnabled boolean filterable   orderable  
ACLAllowOrigin string
ADGatewayPurgeTime integer
alarmsMaxPerObject integer
allowEnterpriseAvatarOnNSG boolean filterable   orderable  
APIKeyRenewalInterval integer
APIKeyValidity integer
ASNumber integer
attachProbeToIPsecNPM boolean
attachProbeToVXLANNPM boolean
avatarBasePath string
avatarBaseURL string
creationDate string read only   autogenerated   orderable  
csprootAuthenticationMethod enum (LDAP | LOCAL)
customerIDUpperLimit integer
customerKey string
deniedFlowCollectionEnabled boolean
DHCPOptionSize integer
domainTunnelType enum (GRE | VLAN | VXLAN)
dynamicWANServiceDiffTime integer
ECMPCount integer
ejbcaNSGCertificateProfile string
ejbcaNSGEndEntityProfile string
ejbcaOCSPResponderCN string
ejbcaOCSPResponderURI string
ejbcaVspRootCa string
elasticClusterName string
embeddedMetadata list read only   autogenerated  
embeddedMetadataSize integer filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
esiID integer read only  
eventLogCleanupInterval integer
eventLogEntryMaxAge integer
eventProcessorInterval integer
eventProcessorMaxEventsCount integer
eventProcessorTimeout integer
EVPNBGPCommunityTagASNumber integer
EVPNBGPCommunityTagLowerLimit integer
EVPNBGPCommunityTagUpperLimit integer
explicitACLMatchingEnabled boolean
externalID string filterable   orderable   locally unique  
fecFeedbackTimer integer
flowCollectionEnabled boolean
flowDropTimeout integer
gatewayProbeInterval integer filterable   orderable  
gatewayProbeWindow integer filterable   orderable  
gatewayRebalancingInterval integer filterable   orderable  
globalMACAddress string
googleMapsAPIKey string
groupKeyDefaultSeedGenerationInterval integer
groupKeyDefaultSeedLifetime integer
groupKeyDefaultSeedPayloadAuthenticationAlgorithm enum (HMAC_SHA1 | HMAC_SHA256 | HMAC_SHA512)
groupKeyDefaultSeedPayloadEncryptionAlgorithm enum (AES_128_CBC | AES_256_CBC | TRIPLE_DES_CBC)
groupKeyDefaultSeedPayloadSigningAlgorithm enum (SHA1withRSA | SHA224withRSA | SHA256withRSA | SHA384withRSA | SHA512withRSA)
groupKeyDefaultSEKGenerationInterval integer
groupKeyDefaultSEKLifetime integer
groupKeyDefaultSEKPayloadEncryptionAlgorithm enum (RSA_1024)
groupKeyDefaultSEKPayloadSigningAlgorithm enum (SHA1withRSA | SHA224withRSA | SHA256withRSA | SHA384withRSA | SHA512withRSA)
groupKeyDefaultTrafficAuthenticationAlgorithm enum (HMAC_MD5 | HMAC_SHA1 | HMAC_SHA256 | HMAC_SHA384 | HMAC_SHA512)
groupKeyDefaultTrafficEncryptionAlgorithm enum (AES_128_CBC | AES_192_CBC | AES_256_CBC | TRIPLE_DES_CBC)
groupKeyDefaultTrafficEncryptionKeyLifetime integer
groupKeyGenerationIntervalOnForcedReKey integer
groupKeyGenerationIntervalOnRevoke integer
groupKeyMinimumSeedGenerationInterval integer
groupKeyMinimumSeedLifetime integer
groupKeyMinimumSEKGenerationInterval integer
groupKeyMinimumSEKLifetime integer
groupKeyMinimumTrafficEncryptionKeyLifetime integer
importedSaaSApplicationsVersion string read only  
inactiveTimeout integer
infrastructureBGPASNumber integer
interfaceIdLowerLimit integer filterable   orderable  
interfaceIdUpperLimit integer filterable   orderable  
IPv6ExtendedPrefixesEnabled boolean filterable   orderable  
keyServerMonitorEnabled boolean
keyServerVSDDataSynchronizationInterval integer
lastExecutedMigrationPhase enum (EXPAND | REDUCE)
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
LDAPSyncInterval integer
LDAPTrustStoreCertifcate string
LDAPTrustStorePassword string
LRUCacheSizePerSubnet integer
maintenanceModeEnabled boolean
maxFailedLogins integer
maxResponse integer
nsgBootstrapEndpoint string
nsgConfigEndpoint string
nsgLocalUiUrl string
NSGUplinkHoldDownTimer integer
offsetCustomerID integer
offsetServiceID integer
owner string autogenerated  
pageMaxSize integer
pageSize integer
perDomainVlanIdEnabled boolean filterable   orderable  
PGIDLowerLimit integer
PGIDUpperLimit integer
postProcessorThreadsCount integer
rbacEnabled boolean filterable   orderable  
RDLowerLimit integer
RDPublicNetworkLowerLimit integer
RDPublicNetworkUpperLimit integer
RDUpperLimit integer
RTLowerLimit integer
RTPublicNetworkLowerLimit integer
RTPublicNetworkUpperLimit integer
RTUpperLimit integer
SaaSApplicationsPublishDate string
secondaryASNumber integer filterable   orderable  
secondaryRTLowerLimit integer filterable   orderable  
secondaryRTUpperLimit integer filterable   orderable  
serviceIDUpperLimit integer
stackTraceEnabled boolean
statefulACLNonTCPTimeout integer
statefulACLTCPTimeout integer
staticWANServicePurgeTime integer
statisticsEnabled boolean
statsCollectorAddress string
statsCollectorPort string
statsCollectorProtoBufPort string
statsDatabaseProxy string
statsMaxDataPoints integer
statsMinDuration integer
statsNumberOfDataPoints integer
statsTSDBServerAddress string
stickyECMPIdleTimeout integer filterable   orderable  
subnetResyncInterval integer
subnetResyncOutstandingInterval integer
syslogDestinationHost string
syslogDestinationPort integer
sysmonCleanupTaskInterval integer
sysmonNodePresenceTimeout integer
sysmonProbeResponseTimeout integer
sysmonPurgeInterval integer filterable   orderable  
systemAvatarData string filterable   orderable  
systemAvatarType enum (BASE64 | COMPUTEDURL | URL) filterable   orderable  
systemBlockedPageText string
threatIntelligenceEnabled boolean
threatPreventionFeedServerProxyPort integer
threatPreventionServer string
threatPreventionServerPassword string
threatPreventionServerProxyPort integer
threatPreventionServerUsername string
threatPreventionSyslogProxyPort integer
twoFactorCodeExpiry integer
twoFactorCodeLength integer
twoFactorCodeSeedLength integer
vcinLoadBalancerIP string
virtualFirewallRulesEnabled boolean filterable   orderable  
VLANIDLowerLimit integer
VLANIDUpperLimit integer
VMCacheSize integer
VMPurgeTime integer
VMResyncDeletionWaitTime integer
VMResyncOutstandingInterval integer
VMUnreachableCleanupTime integer
VMUnreachableTime integer
VNFTaskTimeout integer
VNIDLowerLimit integer
VNIDPublicNetworkLowerLimit integer
VNIDPublicNetworkUpperLimit integer
VNIDUpperLimit integer
VPortInitStatefulTimer integer
VSCOnSameVersionAsVSD boolean
VSDAARApplicationVersion string read only  
VSDAARApplicationVersionPublishDate string read only  
VSDReadOnlyMode boolean deprecated  
VSDUpgradeIsComplete boolean
VSSStatsInterval integer
webCatSrvUrl string read only  
webFilteringType enum (CLOUD_SERVICE | VM)
ZFBBootstrapEnabled boolean filterable   orderable  
ZFBRequestRetryTimer integer filterable   orderable  
ZFBSchedulerStaleRequestTimeout integer filterable   orderable  

API Resource

/systemconfigs/id
get put

Parents

/systemconfigs
get

Children

/systemconfigs/id/permissions
delete get post put
/systemconfigs/id/metadatas
get post
/systemconfigs/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

AARFlowStatsInterval integer
Discussion

AAR flow statistics collection interval in seconds.


Charateristics

Default value: 30
Min value: 30
Max value: 2147483647
SDK attribute: AARFlowStatsInterval

AARProbeStatsInterval integer
Discussion

AAR probe statistics collection interval in seconds.


Charateristics

Default value: 30
Min value: 1
SDK attribute: AARProbeStatsInterval

accumulateLicensesEnabled boolean filterable   orderable  
Discussion

Whether the various VRS license flavours be merged in one pool.


Charateristics

Default value: false
SDK attribute: accumulateLicensesEnabled

ACLAllowOrigin string
Discussion

Defines the domains allowed for access control list.


Charateristics

Default value: *
Format: free
Max length: 255
SDK attribute: ACLAllowOrigin

ADGatewayPurgeTime integer
Discussion

Timer in seconds for undefined VMs or auto-discovered NSGateway instances to be deleted from VSD.


Charateristics

Default value: 7200
Min value: 7200
Max value: 2592000
SDK attribute: ADGatewayPurgeTime

alarmsMaxPerObject integer
Discussion

Maximum alarms per object for example max distinct alarms for specific VM (min = 5, max =20)


Charateristics

Default value: 10
Format: free
Min value: 5
Max value: 20
SDK attribute: alarmsMaxPerObject

allowEnterpriseAvatarOnNSG boolean filterable   orderable  
Discussion

When enabled, it allows Enterprise Avatar (image) to be populated on the NSGateway bootstrapping portal and blocked page notification.


Charateristics

Default value: true
SDK attribute: allowEnterpriseAvatarOnNSG

APIKeyRenewalInterval integer
Discussion

Defines the interval in seconds, before the expiry time, which can be used to renew the apiKey by making the '/me' API call. Minimum value is 60 s (1 minute) and maximum is 300 s (5 minutes).


Charateristics

Default value: 300
Min value: 60
Max value: 300
SDK attribute: APIKeyRenewalInterval

APIKeyValidity integer
Discussion

Defines the apiKey validity duration in seconds. Default and maximum values are 24 hours (86400 s) and minimum value is 10 minutes (600 s).


Charateristics

Default value: 86400
Min value: 600
Max value: 86400
SDK attribute: APIKeyValidity

ASNumber integer
Discussion

System's Autonomous System (AS) number. Used in the automatic generation of Route Target (RT) and Route Distinguisher (RD) numbers.


Charateristics

Default value: 65534
Max value: 4294967295
SDK attribute: ASNumber

attachProbeToIPsecNPM boolean
Discussion

Flag to attach or remove system generated probes to system generated Network Performance Measurement (NPM) probes for IPSec.


Charateristics

Default value: true
SDK attribute: attachProbeToIPsecNPM

attachProbeToVXLANNPM boolean
Discussion

Flag to attach or remove system generated probes to system generated Network Performance Measurement (NPM) probes for VxLAN.


Charateristics

Default value: true
SDK attribute: attachProbeToVXLANNPM

avatarBasePath string
Discussion

Defines location, on VSD, where image files needs to be copied to. The Avatar Base URL should be configured to read the files from this location.


Charateristics

Default value: /opt/vsd/jboss/standalone/deployments/CloudMgmt-web.war
Format: free
Min length: 1
Max length: 255
SDK attribute: avatarBasePath

avatarBaseURL string
Discussion

Defines the URL to read the avatar image files.


Charateristics

Default value: https://localhost:8443
Format: free
Min length: 1
Max length: 255
SDK attribute: avatarBaseURL

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.


Charateristics

SDK attribute: creationDate

csprootAuthenticationMethod enum
Discussion

Authentication method for csproot when local authentication is not used for CSP organization


Charateristics

Allowed values: LDAP, LOCAL
Default value: LOCAL
SDK attribute: csprootAuthenticationMethod

customerIDUpperLimit integer
Discussion

Customer ID value upper limit. This is a system wide value.


Charateristics

Default value: 2147483647
Min value: 10000
Max value: 2147483647
SDK attribute: customerIDUpperLimit

customerKey string
Discussion

Customer key associated with the license.


Charateristics

Format: free
SDK attribute: customerKey

deniedFlowCollectionEnabled boolean
Discussion

When this option is selected, VSS will only store flows that are denied by security policy (implicit or explicit ACLs). This requires a valid VSS license and Flow Collection enabled.


Charateristics

Default value: false
SDK attribute: deniedFlowCollectionEnabled

DHCPOptionSize integer
Discussion

Defines total DHCP options that can be set on a domain.


Charateristics

Default value: 16
Min value: 1
SDK attribute: DHCPOptionSize

domainTunnelType enum
Discussion

Default Domain Tunnel Type.


Charateristics

Allowed values: GRE, VLAN, VXLAN
Default value: VXLAN
SDK attribute: domainTunnelType

dynamicWANServiceDiffTime integer
Discussion

Timer in seconds for dynamic WAN Services to be considered as not being seen by a 7x50.


Charateristics

Default value: 5
Min value: 1
Max value: 7200
SDK attribute: dynamicWANServiceDiffTime

ECMPCount integer
Discussion

System Default Equal-cost multi-path routing count. Every Domain derives ECMP count from this value unless specifically set for the domain.


Charateristics

Default value: 1
Min value: 1
Max value: 8
SDK attribute: ECMPCount

ejbcaNSGCertificateProfile string
Discussion

EJBCA NSG Certificate Profile


Charateristics

Default value: VSPClient
Format: free
Min length: 1
Max length: 255
SDK attribute: ejbcaNSGCertificateProfile

ejbcaNSGEndEntityProfile string
Discussion

EJBCA NSG End Entity Profile


Charateristics

Default value: NSG
Format: free
Min length: 1
Max length: 255
SDK attribute: ejbcaNSGEndEntityProfile

ejbcaOCSPResponderCN string
Discussion

EJBCA OCSP Responder CommonName


Charateristics

Default value: ocspsigner
Format: free
Min length: 1
Max length: 255
SDK attribute: ejbcaOCSPResponderCN

ejbcaOCSPResponderURI string
Discussion

EJBCA OCSP Responder URI


Charateristics

Default value: http://localhost:7080/ejbca/publicweb/status/ocsp
Format: free
Min length: 1
Max length: 255
SDK attribute: ejbcaOCSPResponderURI

ejbcaVspRootCa string
Discussion

EJBCA VSP CA


Charateristics

Default value: VSPCA
Format: free
Min length: 1
Max length: 255
SDK attribute: ejbcaVspRootCa

elasticClusterName string
Discussion

Specifies the name of the Elastic Search Cluster.


Charateristics

Default value: nuage_elasticsearch
Format: free
Min length: 1
Max length: 255
SDK attribute: elasticClusterName

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

embeddedMetadataSize integer filterable   orderable  
Discussion

This value limits the number of embedded Metadata objects returned in the API call.


Charateristics

Default value: 10
Min value: 1
Max value: 50
SDK attribute: embeddedMetadataSize

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

esiID integer read only  
Discussion

ESI ID offset


Charateristics

Default value: 10000
Min value: 1
Max value: 40000
SDK attribute: esiID

eventLogCleanupInterval integer
Discussion

VSD event logs cleanup task execution interval in seconds.


Charateristics

Default value: 3600
Min value: 3600
Max value: 86400
SDK attribute: eventLogCleanupInterval

eventLogEntryMaxAge integer
Discussion

Maximum age in days for cleanup of the eventlog entries. On every periodic interval run, any eventlog entries older than this max age will be deleted.


Charateristics

Default value: 7
Min value: 1
Max value: 180
SDK attribute: eventLogEntryMaxAge

eventProcessorInterval integer
Discussion

Defines time interval in milliseconds when events collected for a client should be processed.


Charateristics

Default value: 250
Min value: 250
SDK attribute: eventProcessorInterval

eventProcessorMaxEventsCount integer
Discussion

Defines the maximum number of events to be collected in case of events burst.


Charateristics

Default value: 100
Min value: 100
Max value: 500
SDK attribute: eventProcessorMaxEventsCount

eventProcessorTimeout integer
Discussion

Defines the maximum time period in milliseconds for the ReST server to wait before sending the events from the system.


Charateristics

Default value: 25000
Min value: 25000
Max value: 100000
SDK attribute: eventProcessorTimeout

EVPNBGPCommunityTagASNumber integer
Discussion

Autonomous System Number used for 'EVPNBGPCommunityTag' generation.


Charateristics

Default value: 65534
Max value: 4294967295
SDK attribute: EVPNBGPCommunityTagASNumber

EVPNBGPCommunityTagLowerLimit integer
Discussion

EVPNBGPCommunityTag lower limit


Charateristics

Default value: 0
Max value: 4294967294
SDK attribute: EVPNBGPCommunityTagLowerLimit

EVPNBGPCommunityTagUpperLimit integer
Discussion

EVPNBGPCommunityTag upper limit


Charateristics

Default value: 65535
Min value: 1
Max value: 4294967295
SDK attribute: EVPNBGPCommunityTagUpperLimit

explicitACLMatchingEnabled boolean
Discussion

When this option is selected, VSS will only store allow/denied flows that matches explicit ingress/egress security ACL. This requires a valid VSS license and Flow Collection enabled.


Charateristics

Default value: false
SDK attribute: explicitACLMatchingEnabled

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

fecFeedbackTimer integer
Discussion

Forward Error Correction feedback timer in seconds. Possible values are 1, 2, 3, 4 or 5.


Charateristics

Default value: 1
Min value: 1
Max value: 5
SDK attribute: fecFeedbackTimer

flowCollectionEnabled boolean
Discussion

Enables flow statistics collection. It is needed for the VSS feature, and requires a valid VSS license. This option requires 'statisticsEnabled'.


Charateristics

Default value: false
SDK attribute: flowCollectionEnabled

flowDropTimeout integer
Discussion

Timeout in seconds after which the traffic will be dropped, if the flow limit exceeds.


Charateristics

Default value: 5
Min value: 5
Max value: 3600
SDK attribute: flowDropTimeout

gatewayProbeInterval integer filterable   orderable  
Discussion

Gateway probe interval in seconds.


Charateristics

Default value: 5
Min value: 1
Max value: 30
SDK attribute: gatewayProbeInterval

gatewayProbeWindow integer filterable   orderable  
Discussion

Gateway probe window in seconds.


Charateristics

Default value: 120
Min value: 60
Max value: 600
SDK attribute: gatewayProbeWindow

gatewayRebalancingInterval integer filterable   orderable  
Discussion

Gateway rebalancing interval in seconds.


Charateristics

Default value: 600
Min value: 300
Max value: 86400
SDK attribute: gatewayRebalancingInterval

globalMACAddress string
Discussion

the MAC Address to use for those subnets that have the useGlobalMAC flag enabled.


Charateristics

Default value: 68:54:ED:00:59:EA
Format: free
SDK attribute: globalMACAddress

googleMapsAPIKey string
Discussion

Google Maps API Key used to display maps on Nuage UI applications


Charateristics

Format: free
Max length: 255
SDK attribute: googleMapsAPIKey

groupKeyDefaultSeedGenerationInterval integer
Discussion

Group Key Encryption Profile Default Seed Generation Interval in seconds.


Charateristics

Default value: 1200
SDK attribute: groupKeyDefaultSeedGenerationInterval

groupKeyDefaultSeedLifetime integer
Discussion

Group Key Encryption Profile Default Seed Lifetime in seconds.


Charateristics

Default value: 14400
SDK attribute: groupKeyDefaultSeedLifetime

groupKeyDefaultSeedPayloadAuthenticationAlgorithm enum
Discussion

Group Key Encryption Profile Default Seed Payload Authentication Algorithm.


Charateristics

Allowed values: HMAC_SHA1, HMAC_SHA256, HMAC_SHA512
Default value: HMAC_SHA1
SDK attribute: groupKeyDefaultSeedPayloadAuthenticationAlgorithm

groupKeyDefaultSeedPayloadEncryptionAlgorithm enum
Discussion

Group Key Encryption Profile Default Seed Payload Encryption Algorithm.


Charateristics

Allowed values: AES_128_CBC, AES_256_CBC, TRIPLE_DES_CBC
Default value: AES_256_CBC
SDK attribute: groupKeyDefaultSeedPayloadEncryptionAlgorithm

groupKeyDefaultSeedPayloadSigningAlgorithm enum
Discussion

Group Key Encryption Profile Default Seed Payload Signature Algorithm.


Charateristics

Allowed values: SHA1withRSA, SHA224withRSA, SHA256withRSA, SHA384withRSA, SHA512withRSA
Default value: SHA256withRSA
SDK attribute: groupKeyDefaultSeedPayloadSigningAlgorithm

groupKeyDefaultSEKGenerationInterval integer
Discussion

Group Key Encryption Profile Default SEK Generation Interval in seconds.


Charateristics

Default value: 1200
SDK attribute: groupKeyDefaultSEKGenerationInterval

groupKeyDefaultSEKLifetime integer
Discussion

Group Key Encryption Profile Default SEK Lifetime in seconds.


Charateristics

Default value: 86400
SDK attribute: groupKeyDefaultSEKLifetime

groupKeyDefaultSEKPayloadEncryptionAlgorithm enum
Discussion

Group Key Encryption Profile Default Sek Payload Encryption Algorithm.


Charateristics

Allowed values: RSA_1024
Default value: RSA_1024
SDK attribute: groupKeyDefaultSEKPayloadEncryptionAlgorithm

groupKeyDefaultSEKPayloadSigningAlgorithm enum
Discussion

Group Key Encryption Profile Default Sek Payload Signing Algorithm.


Charateristics

Allowed values: SHA1withRSA, SHA224withRSA, SHA256withRSA, SHA384withRSA, SHA512withRSA
Default value: SHA256withRSA
SDK attribute: groupKeyDefaultSEKPayloadSigningAlgorithm

groupKeyDefaultTrafficAuthenticationAlgorithm enum
Discussion

Group Key Encryption Profile Default Traffic Authentication Algorithm.


Charateristics

Allowed values: HMAC_MD5, HMAC_SHA1, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512
Default value: HMAC_SHA1
SDK attribute: groupKeyDefaultTrafficAuthenticationAlgorithm

groupKeyDefaultTrafficEncryptionAlgorithm enum
Discussion

Group Key Encryption Profile Default Traffic Encryption Algorithm.


Charateristics

Allowed values: AES_128_CBC, AES_192_CBC, AES_256_CBC, TRIPLE_DES_CBC
Default value: AES_128_CBC
SDK attribute: groupKeyDefaultTrafficEncryptionAlgorithm

groupKeyDefaultTrafficEncryptionKeyLifetime integer
Discussion

Group Key Encryption Profile Default Traffic Encryption Key Lifetime in seconds.


Charateristics

Default value: 600
SDK attribute: groupKeyDefaultTrafficEncryptionKeyLifetime

groupKeyGenerationIntervalOnForcedReKey integer
Discussion

Time in seconds before new keys will be generated in the case of a forced re-key event


Charateristics

Default value: 60
SDK attribute: groupKeyGenerationIntervalOnForcedReKey

groupKeyGenerationIntervalOnRevoke integer
Discussion

Time in seconds before new keys will be generated in the case of a revoke event


Charateristics

Default value: 60
SDK attribute: groupKeyGenerationIntervalOnRevoke

groupKeyMinimumSeedGenerationInterval integer
Discussion

Group Key Encryption Profile Default Seed Generation Interval in seconds.


Charateristics

Default value: 20
SDK attribute: groupKeyMinimumSeedGenerationInterval

groupKeyMinimumSeedLifetime integer
Discussion

Group Key Encryption Profile Default Seed Lifetime in seconds.


Charateristics

Default value: 60
SDK attribute: groupKeyMinimumSeedLifetime

groupKeyMinimumSEKGenerationInterval integer
Discussion

Group Key Encryption Profile Minimum SEK Generation Interval in seconds.


Charateristics

Default value: 20
SDK attribute: groupKeyMinimumSEKGenerationInterval

groupKeyMinimumSEKLifetime integer
Discussion

Group Key Encryption Profile Minimum SEK Lifetime in seconds.


Charateristics

Default value: 120
SDK attribute: groupKeyMinimumSEKLifetime

groupKeyMinimumTrafficEncryptionKeyLifetime integer
Discussion

Group Key Encryption Profile Minimum TEK Lifetime in seconds.


Charateristics

Default value: 30
SDK attribute: groupKeyMinimumTrafficEncryptionKeyLifetime

importedSaaSApplicationsVersion string read only  
Discussion

Version of the current imported SaaS Application Type Master List.


Charateristics

Default value: 1.0
Format: free
Min length: 1
Max length: 255
SDK attribute: importedSaaSApplicationsVersion

inactiveTimeout integer
Discussion

Defines the inactive timeout for the client. If the client is inactive for more than the timeout value, server clears off all the cached information regarding the client. This value should be greater than the maximum timeout for the event processor. Value is in milliseconds.


Charateristics

Default value: 600000
Min value: 25000
Max value: 1800000
SDK attribute: inactiveTimeout

infrastructureBGPASNumber integer
Discussion

Autonomous System Number, Used for Infrastructure BGP PE_CE.


Charateristics

Default value: 65500
Min value: 1
Max value: 4294967295
SDK attribute: infrastructureBGPASNumber

interfaceIdLowerLimit integer filterable   orderable  
Discussion

Lower limit for interface Id configured on SRLinux device.


Charateristics

Default value: 245
Max value: 255
SDK attribute: interfaceIdLowerLimit

interfaceIdUpperLimit integer filterable   orderable  
Discussion

Upper limit for interface Id configured on SRLinux device.


Charateristics

Default value: 255
Max value: 255
SDK attribute: interfaceIdUpperLimit

IPv6ExtendedPrefixesEnabled boolean filterable   orderable  
Discussion

Allows the creation of IPv6 subnets and routes with masks longer than /64.


Charateristics

Default value: false
SDK attribute: IPv6ExtendedPrefixesEnabled

keyServerMonitorEnabled boolean
Discussion

Enable the keyserver debug monitor (ie. ksmon command)


Charateristics

Default value: true
SDK attribute: keyServerMonitorEnabled

keyServerVSDDataSynchronizationInterval integer
Discussion

KeyServer time in seconds between full resyncs of VSD data (just in case of missed events)


Charateristics

Default value: 3600
SDK attribute: keyServerVSDDataSynchronizationInterval

lastExecutedMigrationPhase enum
Discussion

Indicates the last successfully executed phase of online schema migration. This value is set automatically upon execution of online schema migration scripts.


Charateristics

Allowed values: EXPAND, REDUCE
Default value: REDUCE
SDK attribute: lastExecutedMigrationPhase

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

LDAPSyncInterval integer
Discussion

LDAP Sync-Up task interval in seconds.


Charateristics

Default value: 3600
Min value: 600
Max value: 86400
SDK attribute: LDAPSyncInterval

LDAPTrustStoreCertifcate string
Discussion

Location of the truststore which is need to store LDAP server certificates. Default is cacerts located in java.home/lib/security/cacerts. Uncomment below setting if you need to use a different file


Charateristics

Default value: /opt/vsd/jboss/standalone/configuration/vsd.keystore
Format: free
SDK attribute: LDAPTrustStoreCertifcate

LDAPTrustStorePassword string
Discussion

Password to access the truststore. Uncomment below line to change its value.


Charateristics

Default value: changeit
Format: free
SDK attribute: LDAPTrustStorePassword

LRUCacheSizePerSubnet integer
Discussion

Least Recently Used (LRU) Cache map size per subnet. Serves to hold the deleted VM instances' IP addresses.


Charateristics

Default value: 32
Min value: 32
Max value: 256
SDK attribute: LRUCacheSizePerSubnet

maintenanceModeEnabled boolean
Discussion

Indicates if the VSD is configured in maintenance mode. This is typically enabled during the VSD upgrade window and when enabled the VSD would support only a subset of functionality.


Charateristics

Default value: false
SDK attribute: maintenanceModeEnabled

maxFailedLogins integer
Discussion

Maximum failed login attempts before the account is locked. 0 = not enforced (unlimited attempts). This is not enforced if LDAP is used for authorization


Charateristics

Default value: 0
Max value: 10
SDK attribute: maxFailedLogins

maxResponse integer
Discussion

Defines maximum results returned by the REST call (allowed maximum value is 5000).


Charateristics

Default value: 500
Min value: 1
Max value: 5000
SDK attribute: maxResponse

nsgBootstrapEndpoint string
Discussion

NSG Bootstrap Endpoint


Charateristics

Default value: https://proxy-bootstrap:12443/nuage/api
Format: free
Min length: 1
Max length: 255
SDK attribute: nsgBootstrapEndpoint

nsgConfigEndpoint string
Discussion

NSG Config Endpoint


Charateristics

Default value: https://{proxyDNSName}:11443/nuage/api
Format: free
Min length: 1
Max length: 255
SDK attribute: nsgConfigEndpoint

nsgLocalUiUrl string
Discussion

The bootstrapping UI URL on NSGateway. The URL will be redirected on NSG to its localhost so that the bootstrapping server on the NSGateway may handle the request.


Charateristics

Default value: http://registration.nsg
Format: free
Min length: 1
Max length: 255
SDK attribute: nsgLocalUiUrl

NSGUplinkHoldDownTimer integer
Discussion

In case of a dual-uplink NSG, the hold down time in seconds, after which an uplink connection that recovered from failure is re-used.


Charateristics

Default value: 5
Max value: 30
SDK attribute: NSGUplinkHoldDownTimer

offsetCustomerID integer
Discussion

Customer ID offset, this value has to be set before JBoss starts, following its starting, any change of value will be ignored. This is a system wide value.


Charateristics

Default value: 10000
Min value: 10000
Max value: 2147483646
SDK attribute: offsetCustomerID

offsetServiceID integer
Discussion

Service ID offset, this value has to be set before JBoss starts during the time of VSD installation, from thereon, any change of value will be ignored. This is a system wide value.


Charateristics

Default value: 20001
Min value: 20001
Max value: 2147483648
SDK attribute: offsetServiceID

owner string autogenerated  
Discussion

Identifies the user that has created this object.


Charateristics

Format: free
SDK attribute: owner

pageMaxSize integer
Discussion

Defines upper bound for the page size. Configured or input page size should be less than this max page size.


Charateristics

Default value: 500
Min value: 5
Max value: 1000
SDK attribute: pageMaxSize

pageSize integer
Discussion

Defines the page size for the results returned by the ReST call. This value can not exceed what has been defined in 'pageMaxSize'.


Charateristics

Default value: 50
Min value: 1
Max value: 1000
SDK attribute: pageSize

perDomainVlanIdEnabled boolean filterable   orderable  
Discussion

Determines whether per domain VLAN ID generation is required.


Charateristics

Default value: false
SDK attribute: perDomainVlanIdEnabled

PGIDLowerLimit integer
Discussion

Lower limit for the policy group ID.


Charateristics

Default value: 65536
Min value: 65536
Max value: 2147483646
SDK attribute: PGIDLowerLimit

PGIDUpperLimit integer
Discussion

Upper limit for the policy group ID.


Charateristics

Default value: 2147483647
Min value: 65537
Max value: 2147483647
SDK attribute: PGIDUpperLimit

postProcessorThreadsCount integer
Discussion

Post processor thread count.


Charateristics

Default value: 10
Min value: 1
SDK attribute: postProcessorThreadsCount

rbacEnabled boolean filterable   orderable  
Discussion

Enables the advanced granular permissions feature. This should not be enabled without prior discussion and agreement with the Nuage Product team, as this feature is only qualified for a limited set of use cases.


Charateristics

Default value: false
SDK attribute: rbacEnabled

RDLowerLimit integer
Discussion

Route distinguisher (RD) lower limit.


Charateristics

Default value: 0
Max value: 4294967294
SDK attribute: RDLowerLimit

RDPublicNetworkLowerLimit integer
Discussion

Route distinguisher (RD) public network lower limit.


Charateristics

Default value: 0
Max value: 4294967294
SDK attribute: RDPublicNetworkLowerLimit

RDPublicNetworkUpperLimit integer
Discussion

Route distinguisher (RD) public network upper limit.


Charateristics

Default value: 65535
Min value: 1
Max value: 4294967295
SDK attribute: RDPublicNetworkUpperLimit

RDUpperLimit integer
Discussion

Route distinguisher (RD) upper limit.


Charateristics

Default value: 65535
Min value: 1
Max value: 4294967295
SDK attribute: RDUpperLimit

RTLowerLimit integer
Discussion

Route target (RT) lower limit.


Charateristics

Default value: 0
Max value: 4294967294
SDK attribute: RTLowerLimit

RTPublicNetworkLowerLimit integer
Discussion

Route target (RT) public network lower limit.


Charateristics

Default value: 0
Max value: 4294967294
SDK attribute: RTPublicNetworkLowerLimit

RTPublicNetworkUpperLimit integer
Discussion

Route target (RT) public network upper limit.


Charateristics

Default value: 65535
Min value: 1
Max value: 4294967295
SDK attribute: RTPublicNetworkUpperLimit

RTUpperLimit integer
Discussion

Route target (RT) upper limit


Charateristics

Default value: 65535
Min value: 1
Max value: 4294967295
SDK attribute: RTUpperLimit

SaaSApplicationsPublishDate string
Discussion

Determines the time that SaaS applications were imported in VSD or if they are the ones that came with this version of VSD (built-in).


Charateristics

SDK attribute: SaaSApplicationsPublishDate

secondaryASNumber integer filterable   orderable  
Discussion

Autonomous System Number, used for secondary RT auto-generation.


Charateristics

Default value: 65533
Max value: 65533
SDK attribute: secondaryASNumber

secondaryRTLowerLimit integer filterable   orderable  
Discussion

Secondary route target lower limit.


Charateristics

Default value: 0
Max value: 65533
SDK attribute: secondaryRTLowerLimit

secondaryRTUpperLimit integer filterable   orderable  
Discussion

Secondary route target upper limit.


Charateristics

Default value: 65533
Max value: 65533
SDK attribute: secondaryRTUpperLimit

serviceIDUpperLimit integer
Discussion

Service ID upper limit system wide value.


Charateristics

Default value: 2147483648
Min value: 20002
Max value: 2147483648
SDK attribute: serviceIDUpperLimit

stackTraceEnabled boolean
Discussion

Set value to TRUE to enable stacktraces in the ReST calls.


Charateristics

Default value: false
SDK attribute: stackTraceEnabled

statefulACLNonTCPTimeout integer
Discussion

Defines the timeout in seconds for stateful ACLs that are not of type TCP.


Charateristics

Default value: 180
Min value: 10
Max value: 86400
SDK attribute: statefulACLNonTCPTimeout

statefulACLTCPTimeout integer
Discussion

Defines the timeout in seconds for stateful ACLs that are of type TCP.


Charateristics

Default value: 3600
Min value: 10
Max value: 86400
SDK attribute: statefulACLTCPTimeout

staticWANServicePurgeTime integer
Discussion

Timer in seconds for an unreacheable static WAN Services to be deleted.


Charateristics

Default value: 3600
Min value: 3600
Max value: 7200
SDK attribute: staticWANServicePurgeTime

statisticsEnabled boolean
Discussion

This flag is used to indicate if statistics is enabled in the system. CSProot is expected to activate this through the enable statistics script.


Charateristics

Default value: false
SDK attribute: statisticsEnabled

statsCollectorAddress string
Discussion

Specify the IP address(es) of the stats collector.


Charateristics

Default value: localhost
Format: free
Min length: 1
Max length: 255
SDK attribute: statsCollectorAddress

statsCollectorPort string
Discussion

Specify the port number(s) of the stats collector.


Charateristics

Default value: 29090
Format: free
SDK attribute: statsCollectorPort

statsCollectorProtoBufPort string
Discussion

Specify the protobuf port number(s) of the stats collector.


Charateristics

Default value: 39090
Format: free
SDK attribute: statsCollectorProtoBufPort

statsDatabaseProxy string
Discussion

The location of a public proxy to statistics database server in : format.


Charateristics

Format: free
Max length: 255
SDK attribute: statsDatabaseProxy

statsMaxDataPoints integer
Discussion

Specifies the maximum number of statistics data points to support.


Charateristics

Default value: 10000
Min value: 1
SDK attribute: statsMaxDataPoints

statsMinDuration integer
Discussion

The minimum duration for statistics to be displayed on UI in seconds. Default is 30 days in seconds (2592000 s).


Charateristics

Default value: 2592000
SDK attribute: statsMinDuration

statsNumberOfDataPoints integer
Discussion

Specifies number of data points.


Charateristics

Default value: 30
Min value: 1
SDK attribute: statsNumberOfDataPoints

statsTSDBServerAddress string
Discussion

Specifies the Elastic Search server location.


Charateristics

Default value: localhost:9300
Format: free
Min length: 1
Max length: 255
SDK attribute: statsTSDBServerAddress

stickyECMPIdleTimeout integer filterable   orderable  
Discussion

Sticky ECMP Idle Timeout in seconds.


Charateristics

Default value: 0
Max value: 300
SDK attribute: stickyECMPIdleTimeout

subnetResyncInterval integer
Discussion

Following a resync on a subnet, another resync on the same subnet will be allowed based on the completion of the previous subnet resync plus the defined wait time in minutes.


Charateristics

Default value: 10
Min value: 5
Max value: 15
SDK attribute: subnetResyncInterval

subnetResyncOutstandingInterval integer
Discussion

Outstanding subnet resync interval (in seconds). System wide value.


Charateristics

Default value: 20
Min value: 10
Max value: 50
SDK attribute: subnetResyncOutstandingInterval

syslogDestinationHost string
Discussion

Specifies the remote syslog destination host for VSD logs.


Charateristics

Default value: http://localhost
Format: free
Min length: 1
Max length: 255
SDK attribute: syslogDestinationHost

syslogDestinationPort integer
Discussion

Specified the remote syslog destination port for VSD.


Charateristics

Default value: 514
SDK attribute: syslogDestinationPort

sysmonCleanupTaskInterval integer
Discussion

Sysmon cleanup task run interval in seconds.


Charateristics

Default value: 20
Min value: 10
Max value: 3600
SDK attribute: sysmonCleanupTaskInterval

sysmonNodePresenceTimeout integer
Discussion

Time interval in seconds at which sysmon messages are reported by controller.


Charateristics

Default value: 3600
Min value: 600
Max value: 86400
SDK attribute: sysmonNodePresenceTimeout

sysmonProbeResponseTimeout integer
Discussion

Probe response timeout in seconds.


Charateristics

Default value: 30
Min value: 5
Max value: 60
SDK attribute: sysmonProbeResponseTimeout

sysmonPurgeInterval integer filterable   orderable  
Discussion

Time interval in seconds at which sysmon objects are purged.


Charateristics

Default value: 86400
Min value: 1800
Max value: 2592000
SDK attribute: sysmonPurgeInterval

systemAvatarData string filterable   orderable  
Discussion

CSP Avatar Data


Charateristics

Format: free
SDK attribute: systemAvatarData

systemAvatarType enum filterable   orderable  
Discussion

Avatar type - URL or BASE64


Charateristics

Allowed values: BASE64, COMPUTEDURL, URL
SDK attribute: systemAvatarType

systemBlockedPageText string
Discussion

The text for blocked page html which gets displayed to the end-users when they reach a website that is blocked by Web Filtering ACL. User can possibly include very basic html tags like

,

    etc. in order to fomat the text displayed to the end-users.


    Charateristics

    Format: free
    Max length: 4000
    SDK attribute: systemBlockedPageText

threatIntelligenceEnabled boolean
Discussion

Enables IP based threat intelligence. This requires Flow Collection to be enabled.


Charateristics

Default value: false
SDK attribute: threatIntelligenceEnabled

threatPreventionFeedServerProxyPort integer
Discussion

Feed server download port for Threat Prevention VNF


Charateristics

Default value: 13080
Max value: 2147483647
SDK attribute: threatPreventionFeedServerProxyPort

threatPreventionServer string
Discussion

Specifies the Threat Prevention Management server location.


Charateristics

Format: free
Max length: 255
SDK attribute: threatPreventionServer

threatPreventionServerPassword string
Discussion

Password to access Threat Prevention Server Password


Charateristics

Format: free
Max length: 255
SDK attribute: threatPreventionServerPassword

threatPreventionServerProxyPort integer
Discussion

Destination TCP Port on the Proxy to connect to the Threat Prevention Management Server


Charateristics

Default value: 13022
Max value: 2147483647
SDK attribute: threatPreventionServerProxyPort

threatPreventionServerUsername string
Discussion

Username to accessThreat Prevention management Server.


Charateristics

Format: free
Max length: 255
SDK attribute: threatPreventionServerUsername

threatPreventionSyslogProxyPort integer
Discussion

Syslog server port for Threat Prevention Service


Charateristics

Default value: 13514
Max value: 2147483647
SDK attribute: threatPreventionSyslogProxyPort

twoFactorCodeExpiry integer
Discussion

Two Factor Code Expiration time in seconds for bootstrapping gateways. (min = 60, max = 604800)


Charateristics

Default value: 300
Min value: 60
Max value: 604800
SDK attribute: twoFactorCodeExpiry

twoFactorCodeLength integer
Discussion

The number of characters in the generated Two Factor Code for bootstrapping gateways. (min = 4, max = 10)


Charateristics

Default value: 6
Min value: 4
Max value: 10
SDK attribute: twoFactorCodeLength

twoFactorCodeSeedLength integer
Discussion

Two Factor Seed length in bytes for generating the bootstrapping code. (min = 0, max = 255)


Charateristics

Default value: 96
Max value: 255
SDK attribute: twoFactorCodeSeedLength

vcinLoadBalancerIP string
Discussion

If VCIN Active/Standby is enabled, this needs to be the load-balancer IP which sits in front of the Active and Standby VCIN nodes. The VRS will make its API calls to this load-balancer


Charateristics

Format: free
SDK attribute: vcinLoadBalancerIP

virtualFirewallRulesEnabled boolean filterable   orderable  
Discussion

Enable Virtual Firewall Rule creation and management. This will be available only with VSS license


Charateristics

Default value: false
SDK attribute: virtualFirewallRulesEnabled

VLANIDLowerLimit integer
Discussion

Offset for the Per domain VLAN ID for gateways of type HWVTEP


Charateristics

Default value: 0
Max value: 4096
SDK attribute: VLANIDLowerLimit

VLANIDUpperLimit integer
Discussion

Upper limit for the per domain VLAN ID for gateways of type HWVTEP


Charateristics

Default value: 0
Max value: 4096
SDK attribute: VLANIDUpperLimit

VMCacheSize integer
Discussion

Least Recently Used (LRU) Map size for VMs, this value has to be set based on the amount of memory given to VSD's JVM.


Charateristics

Default value: 5000
Min value: 1000
Max value: 100000
SDK attribute: VMCacheSize

VMPurgeTime integer
Discussion

Timer in seconds for undefined VMs to be deleted.


Charateristics

Default value: 60
Min value: 60
Max value: 600
SDK attribute: VMPurgeTime

VMResyncDeletionWaitTime integer
Discussion

After performing a resync on VMs, if no controller returns with a VM request within the specified timeframe then it will be deleted. The deletion wait time is in minutes.


Charateristics

Default value: 2
Min value: 1
Max value: 5
SDK attribute: VMResyncDeletionWaitTime

VMResyncOutstandingInterval integer
Discussion

Outstanding VM resync interval (in seconds). System wide value.


Charateristics

Default value: 1000
Min value: 500
Max value: 2000
SDK attribute: VMResyncOutstandingInterval

VMUnreachableCleanupTime integer
Discussion

Timer in seconds for unreachable VMs to be marked for cleanup.


Charateristics

Default value: 7200
Min value: 3600
Max value: 86400
SDK attribute: VMUnreachableCleanupTime

VMUnreachableTime integer
Discussion

Timer in seconds for considering a VM as unreachable.


Charateristics

Default value: 3600
Min value: 1800
Max value: 7200
SDK attribute: VMUnreachableTime

VNFTaskTimeout integer
Discussion

Timeout for VNF task running on the NSG by the NSG Agent (in seconds).


Charateristics

Default value: 3600
Min value: 300
Max value: 10000
SDK attribute: VNFTaskTimeout

VNIDLowerLimit integer
Discussion

Virtual network ID offset


Charateristics

Default value: 1
Format: free
Min value: 1
Max value: 1048574
SDK attribute: VNIDLowerLimit

VNIDPublicNetworkLowerLimit integer
Discussion

Virtual network ID public network lower limit


Charateristics

Default value: 1
Min value: 1
Max value: 16777215
SDK attribute: VNIDPublicNetworkLowerLimit

VNIDPublicNetworkUpperLimit integer
Discussion

Virtual network ID public network upper limit


Charateristics

Default value: 16777215
Min value: 2
Max value: 16777215
SDK attribute: VNIDPublicNetworkUpperLimit

VNIDUpperLimit integer
Discussion

Virtual network ID upper limit


Charateristics

Default value: 16777165
Min value: 2
Max value: 16777215
SDK attribute: VNIDUpperLimit

VPortInitStatefulTimer integer
Discussion

Defines the timeout in seconds for vport initialization to stateful. Default value is 300 seconds and the timeout should be within a range going from 0 to 86400 seconds.


Charateristics

Default value: 300
Max value: 86400
SDK attribute: VPortInitStatefulTimer

VSCOnSameVersionAsVSD boolean
Discussion

This flag is used to indicate that whether VSC is on the same version as VSD or not.


Charateristics

Default value: true
SDK attribute: VSCOnSameVersionAsVSD

VSDAARApplicationVersion string read only  
Discussion

Version of the current imported Application Signatures.


Charateristics

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

VSDAARApplicationVersionPublishDate string read only  
Discussion

Determines the time that Application Signatures were published and added in the VSD or if the signatures used are the ones that came with the current version of VSD.


Charateristics

Format: free
SDK attribute: VSDAARApplicationVersionPublishDate

VSDReadOnlyMode boolean deprecated  
Discussion

True means VSD readonly mode enabled. False means VSD readonly mode disabled.


Charateristics

Default value: false
SDK attribute: VSDReadOnlyMode

VSDUpgradeIsComplete boolean
Discussion

This flag is used to indicate whether VSD upgrade is complete. It is expected that csproot will set the value to true after VSD upgrade is complete and ensuring that all VSC's audits and Gateway audits with VSD are completed.


Charateristics

Default value: true
SDK attribute: VSDUpgradeIsComplete

VSSStatsInterval integer
Discussion

VSS statistics collection frequency in seconds.


Charateristics

Default value: 30
Min value: 30
Max value: 300
SDK attribute: VSSStatsInterval

webCatSrvUrl string read only  
Discussion

Indicates web categorization service url. Applicable only for web filtering type CLOUD_SERVICE


Charateristics

Default value: incompasshybridpc.netstar-inc.com
Format: free
Max length: 255
SDK attribute: webCatSrvUrl

webFilteringType enum
Discussion

Indicates the type of web filtering. Possible values are CLOUD_SERVICE, VM


Charateristics

Allowed values: CLOUD_SERVICE, VM
Default value: VM
SDK attribute: webFilteringType

ZFBBootstrapEnabled boolean filterable   orderable  
Discussion

Whether the NSG should auto bootstrap using ZFB


Charateristics

Default value: true
SDK attribute: ZFBBootstrapEnabled

ZFBRequestRetryTimer integer filterable   orderable  
Discussion

Retry time for the ZFB daemon to recheck ZFBRequest Status in seconds


Charateristics

Default value: 30
Min value: 15
Max value: 240
SDK attribute: ZFBRequestRetryTimer

ZFBSchedulerStaleRequestTimeout integer filterable   orderable  
Discussion

Time for the ZFB scheduler to wait in seconds before deleting a stale request


Charateristics

Default value: 1440
Min value: 1
Max value: 10080
SDK attribute: ZFBSchedulerStaleRequestTimeout