Configuration¶
The DomainTools DXL Python Service application requires a set of configuration files to operate.
This distribution contains a config
sub-directory that includes the configuration files that must
be populated prior to running the application.
Each of these files are documented throughout the remained of this page.
Application configuration directory:
config/ dxlclient.config dxldomaintoolsservice.config logging.config (optional)
DXL Client Configuration File (dxlclient.config)¶
The required
dxlclient.config
file is used to configure the DXL client that will connect to the DXL fabric.The steps to populate this configuration file are the same as those documented in the OpenDXL Python SDK, see the OpenDXL Python SDK Samples Configuration page for more information.
The following is an example of a populated DXL client configuration file:
[Certs] BrokerCertChain=c:\\certificates\\brokercerts.crt CertFile=c:\\certificates\\client.crt PrivateKey=c:\\certificates\\client.key [Brokers] {5d73b77f-8c4b-4ae0-b437-febd12facfd4}={5d73b77f-8c4b-4ae0-b437-febd12facfd4};8883;mybroker.mcafee.com;192.168.1.12 {24397e4d-645f-4f2f-974f-f98c55bdddf7}={24397e4d-645f-4f2f-974f-f98c55bdddf7};8883;mybroker2.mcafee.com;192.168.1.13
DomainTools DXL Python Service (dxldomaintoolsservice.config)¶
The required
dxldomaintoolsservice.config
file is used to configure the application.The following is an example of a populated application configuration file:
[General] # The DomainTools API User (required) apiUser=-- YOUR API USER -- # The DomainTools API Key (required) apiKey=-- YOUR API KEY --General
The
General
section is used to specify the DomainTools API User and API Key:
Name Required Description apiUser yes The DomainTools API username for authenticating with DomainTools apiKey yes The DomainTools API key for authenticating with DomainTools
Logging File (logging.config)¶
The optionallogging.config
file is used to configure how the application writes log messages.