Configuration¶
This section describe the environment variables that are used to configure the Device Portal. It is divided into various sections. One general for the application itself, two for ISE. One main section and one additional one if pxGrid is enabled. There is one section for authentication settings where the backend is defined and finally a specific section for the chosen authentication backend either LDAP or Radius
Main application configuration parameters¶
Base configuration setting for onboarding app.
allow_unprovisioned¶
“Specifies if the workflow of onboarding unprovisioned devices should be enabled.
Type |
|
Default |
|
Required |
|
Environment Variable |
|
db_database¶
Name of database
Type |
|
Default |
|
Required |
|
Environment Variable |
|
db_host¶
Hostname or address of database server, should be ‘db’ for an internal database or point to an FQDN for external databases.
Type |
|
Default |
|
Required |
|
Environment Variable |
|
db_port¶
Port of the database server
Type |
|
Default |
|
Required |
|
Environment Variable |
|
db_passwd¶
Password for the database user
Type |
|
Default |
|
Required |
|
Environment Variable |
|
db_user¶
Database user account
Type |
|
Default |
|
Required |
|
Environment Variable |
|
redis¶
Redis Connection string
Type |
|
Default |
|
Required |
|
Environment Variable |
|
log_level¶
Logging level [‘CRITICAL’, ‘ERROR’, ‘WARNING’, ‘INFO’, ‘DEBUG’]
Type |
|
Default |
|
Required |
|
Environment Variable |
|
network_users¶
Enables handling of network users (internal ISE Users).
Type |
|
Default |
|
Required |
|
Environment Variable |
|
secret_key¶
A secret key for JSON Script WebToken (JWT). Use a generated value such as ‘openssl rand -hex 32’
Type |
|
Default |
|
Required |
|
Environment Variable |
|
sgt_enabled¶
Incidates if the SGT features are enabled.
Type |
|
Default |
|
Required |
|
Environment Variable |
|
license_key¶
License key
Type |
|
Default |
|
Required |
|
Environment Variable |
|
Cisco ISE Configuration¶
Configuration settings for communication with Cisco ISE.
ise_disable_pxgrid¶
Determines if pxGrid should be disabled
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_node_cert_path¶
The path of the ISE certificates
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_pan_address¶
The DNS name of the primary ISE node
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_password¶
The password of the ISE user
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_username¶
Username for accessing ISE
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_wide_imports¶
If wide imports are enabled non admin users will be able to import any device from ISE, otherwise normal users can only import devices connected to ISE device groups they have access to
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_endpoint_ipsk_attr¶
ISE Custom Attribute name for the iPSK attribute
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_endpoint_interface_attr¶
ISE Custom Attribute name for the interface attribute
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_endpoint_sgt_attr¶
ISE Custom Attribute name for the sgt attribute
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_endpoint_group_attr¶
ISE Custom Attribute name for the device_group/endpoint_group attribute
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_user_interface_attr¶
ISE Custom Attribute name for the user interface attribute
Type |
|
Default |
|
Required |
|
Environment Variable |
|
pxGrid configuration settings¶
Configuration settings for pxGrid when enabled.
ise_pxgrid_client_cert¶
Name of the client certificate file, if this isn’t an absolute path it will be prefixed by /app/certs/ise/
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_pxgrid_client_description¶
Description of the pxGrid client
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_pxgrid_client_key¶
Name of the client secret file, if this isn’t an absolute path it will be prefixed by /app/certs/ise/
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_pxgrid_client_key_secret¶
Password for the client secret file
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ise_pxgrid_client_name¶
Name of the pxGrid client
Type |
|
Default |
|
Required |
|
Environment Variable |
|
Authentication settings¶
Authentication settings.
authentication_backend¶
Supported options are LDAPBackend or RadiusBackend
Type |
|
Default |
|
Required |
|
Environment Variable |
|
authorization_group_map¶
Mapping from specific user group to Application Role
Type |
|
Default |
|
Required |
|
Environment Variable |
|
authorization_group_regex¶
Regex to identify a user’s relevant groups
Type |
|
Default |
|
Required |
|
Environment Variable |
|
authorization_group_regex_map¶
Regex to map user groups to Application Roles
Type |
|
Default |
|
Required |
|
Environment Variable |
|
LDAP Backend¶
Configuration settings for LDAP Authentication
ldap_servers¶
LDAP Servers
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_tls_port¶
LDAP TLS Port
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_use_tls¶
Use TLS
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_tls_validate_server¶
Validate TLS
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_tls_trust_file¶
Trustfile
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_query_field¶
Query field
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_attrs¶
LDAP Attributes to collect
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_uuid_attrs¶
object guid
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_authorization_group_attrs¶
Group attributes
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_service_principal¶
LDAP Service User
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_service_password¶
LDAP Service Password
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_group_dn¶
Group DN, example OU=Users,DC=example,DC=com
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_group_query¶
LDAP Group Query filter
Type |
|
Default |
|
Required |
|
Environment Variable |
|
ldap_nested_groups¶
Enable nested group support
Type |
|
Default |
|
Required |
|
Environment Variable |
|