Settings
GSO settings.
Ensuring that the required parameters are set correctly. An example file oss-params-example.json
is present in the
GSO package itself.
EnvironmentEnum
Bases: strEnum
The different environments in which the GSO system can run.
Source code in gso/settings.py
DEVELOPMENT = 'development'
class-attribute
instance-attribute
A local development environment.
TEST = 'test'
class-attribute
instance-attribute
The test environment.
UAT = 'uat'
class-attribute
instance-attribute
The user acceptance environment.
PRODUCTION = 'production'
class-attribute
instance-attribute
The production environment.
GeneralParams
Bases: BaseSettings
General parameters for a GSO configuration file.
Source code in gso/settings.py
public_hostname
instance-attribute
The hostname that GSO is publicly served at, used for building callback URLs for public use.
internal_hostname
instance-attribute
The hostname of GSO that is for internal use, such as the provisioning proxy.
CelerySettings
Bases: BaseSettings
Parameters for Celery.
Source code in gso/settings.py
InfoBloxParams
V4NetworkParams
Bases: BaseSettings
A set of parameters that describe an IPv4 network in InfoBlox.
Source code in gso/settings.py
V6NetworkParams
Bases: BaseSettings
A set of parameters that describe an IPv6 network in InfoBlox.
Source code in gso/settings.py
ServiceNetworkParams
Bases: BaseSettings
Parameters for InfoBlox.
The parameters describe IPv4 and v6 networks, and the corresponding domain name that should be used as a suffix.
Source code in gso/settings.py
IPAMParams
Bases: BaseSettings
A set of parameters related to IPAM.
Source code in gso/settings.py
MonitoringSNMPV2Params
MonitoringSNMPV3Params
MonitoringLibreNMSParams
SNMPParams
Bases: BaseSettings
Parameters for SNMP in LibreNMS.
Source code in gso/settings.py
v3 = None
class-attribute
instance-attribute
Optional parameter
Support for SNMP v3 will get added in a later version of GSO. Parameters are optional for now.
MonitoringParams
ProvisioningProxyParams
NetBoxParams
EmailParams
Bases: BaseSettings
Parameters for the email service.
Attributes:
Name | Type | Description |
---|---|---|
notification_email_destinations |
str
|
List of email addresses that should receive notifications when validation of a subscription fails. Can be a comma-separated list of multiple addresses. |
Source code in gso/settings.py
SharepointParams
Bases: BaseSettings
Settings for different Sharepoint sites.
Source code in gso/settings.py
KentikParams
Bases: BaseSettings
Settings for accessing Kentik's API.
Source code in gso/settings.py
SentryParams
MoodiParams
OSSParams
Bases: BaseSettings
The set of parameters required for running GSO.
Source code in gso/settings.py
load_oss_params()
Look for OSS_PARAMS_FILENAME
in the environment and load the parameters from that file.