1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

Add descriptions to all config parameters

This commit is contained in:
jeremystretch
2021-10-26 16:54:12 -04:00
parent ff5c274048
commit 4cdc2601f5

View File

@ -16,9 +16,24 @@ class ConfigParam:
PARAMS = ( PARAMS = (
# Banners # Banners
ConfigParam('BANNER_LOGIN', 'Login banner', ''), ConfigParam(
ConfigParam('BANNER_TOP', 'Top banner', ''), name='BANNER_LOGIN',
ConfigParam('BANNER_BOTTOM', 'Bottom banner', ''), label='Login banner',
default='',
description="Additional content to display on the login page"
),
ConfigParam(
name='BANNER_TOP',
label='Top banner',
default='',
description="Additional content to display at the top of every page"
),
ConfigParam(
name='BANNER_BOTTOM',
label='Bottom banner',
default='',
description="Additional content to display at the bottom of every page"
),
# IPAM # IPAM
ConfigParam( ConfigParam(
@ -83,24 +98,27 @@ PARAMS = (
ConfigParam( ConfigParam(
name='NAPALM_USERNAME', name='NAPALM_USERNAME',
label='NAPALM username', label='NAPALM username',
default='' default='',
description="Username to use when connecting to devices via NAPALM"
), ),
ConfigParam( ConfigParam(
name='NAPALM_PASSWORD', name='NAPALM_PASSWORD',
label='NAPALM password', label='NAPALM password',
default='' default='',
description="Password to use when connecting to devices via NAPALM"
), ),
ConfigParam( ConfigParam(
name='NAPALM_TIMEOUT', name='NAPALM_TIMEOUT',
label='NAPALM timeout', label='NAPALM timeout',
default=30, default=30,
description="NAPALM connection timeout (in seconds)",
field=forms.IntegerField field=forms.IntegerField
), ),
ConfigParam( ConfigParam(
name='NAPALM_ARGS', name='NAPALM_ARGS',
label='NAPALM arguments', label='NAPALM arguments',
default={}, default={},
description="Additional arguments to pass when invoking NAPALM", description="Additional arguments to pass when invoking a NAPALM driver (as JSON data)",
field=forms.JSONField field=forms.JSONField
), ),