Lookup Service Registration Daemon Configuration File¶

Overview¶

The file lsregistrationdaemon.conf is used to define what gets registered into the lookup service. The file allows a degree of flexibility in what is manually defined versus what is automatically discovered. In most cases, the defaults of this file will be suitable and you should not need to make any changes. Some situations where you might want to edit this file though are (this is not an exhaustive list):

You have a private lookup service and would like to only register to that service. See ls_instance Directive
You have a host with multiple network interfaces and would like to choose the interface on which a particular service or set of services run
You are not running a Toolkit (and thus don’t have the web UI) and would like to set location information, community tags or other values
You wish to override the auto-discovered defaults for one reason or another (e.g. maybe they are not correct or you would like to provide more detail)

The basic structure of the file is as follows:

A collection of top-level directives to control things like lookup service communication and how the daemon process runs
A list of site directives that group together elements with a common set of parameters
A list of host directives within those sites that represent the host to be registered. If the host in question is the host on which the LS Registration Daemon is running, than many of the values can be auto-discovered.
A list of service directives within those hosts that represent the services to be registered.

The lsregistrationdaemon.conf has the feature that almost any directive can be defined at a higher level in the configuration hierarchy and be inherited by all the descendents. For example, one can define the latitude and longitude directives at the top-level of the file. All registered hosts and services will in turn inherit these properties. In contrast, you can define them directly in each host directive if you want each individual host to have different values. You can even define both and have the more specific values in the host directive override the ones defined at a higher level in the hierarchy.

With these items in mind the remainder of this section contains a full reference of the options available in the lsregistrationdaemon.conf file.

Lookup Service Communication¶

check_interval Directive¶

Description:	The number of seconds in between checking and renewing a record in the lookup service
Syntax:	`check_interval SECONDS`
Contexts:	top level
Occurrences:	Exactly one
Default:	3600
Compatibility:	3.3 and later

ls_instance Directive¶

Description:	The URL of the lookup service with which to register. If you are using a private lookup service, you must set the URL here.
Syntax:	`ls_instance URL`
Contexts:	top level
Occurrences:	Exactly one
Default:	Chooses closest server in terms of round-trip time from the bootstrap file

ls_instance_latency_threshold Directive¶

Description:	The percentage difference in round-trip-time as a decimal (e.g. .1 = 10% ) that a new lookup service server must be in order for the client to considering switching to that service. For example, if the threshold is set as .1 (10%) and a lookup services is 100ms away, a new lookup service must be at most 90ms away for the client to consider switching.
Syntax:	`ls_instance_latency_threshold NUMBER`
Contexts:	top level
Occurrences:	Exactly one
Default:	.1
Compatibility:	4.0 and later

server_flap_threshold Directive¶

Description:	If no ls_instance is set, the the default behavior is to use the lookup service that is a) reachable and b) has the shortest round-trip-time. It’s possible due to outages, network changes, new lookup services in the bootstrap, etc the chosen lookup service will change over time. The daemon checks to see which lookup service to use every check interval. Rather than immediately changing, this value sets how many times a new lookup service must be returned before your daemon will switch to using it. This prevents frequent flapping between lookup services.
Syntax:	`server_flap_threshold NUMBER`
Contexts:	top level
Occurrences:	Exactly one
Default:	3
Compatibility:	3.4 and later

Auto-discovery¶

autodiscover Directive¶

Description:	Indicates whether we want to automatically determine the value of any property not manually set in this file. If set to 1, it will try to determine as many fields as possible. If set to 0, all fields must be manually set. Manually set properties take precedence over any auto-discovered values.
Syntax:	`autodiscover 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.4 and later

allow_internal_addresses Directive¶

Description:	If autodiscover is enabled, indicates whether private IP addresses (RFC 1918 and RFC 4193) can be used if discovered. Generally you will only want to set this if you are using a private lookup service.
Syntax:	`allow_internal_addresses 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.3 and later

autodiscover_tests_url¶

Description:	The URL of the pScheduler instance to query for auto-discovering tests.
Syntax:	`allow_internal_addresses 0\|1`
Contexts:	interface
Occurrences:	Zero or one
Default:	Defaults to https://ADDRESS/pscheduler where ADDRESS is the interface address
Compatibility:	4.1 and later

disable_autodiscover_tests Directive¶

Description:	Disables autodiscovery of pScheduler test types for interface
Syntax:	`disable_autodiscover_tests 0\|1`
Contexts:	interface
Occurrences:	Zero or More
Default:	0

disable_ipv4_reverse_lookup Directive¶

Description:	If autodiscover is enabled, any IPv4 address found will lead to an attempt to discover a DNS name via a reverse DNS query. This disables that reverse lookup and any value that would have used the discovered hostname will use the raw IPv4 address instead.
Syntax:	`disable_ipv4_reverse_lookup 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.3 and later

disable_ipv6_reverse_lookup Directive¶

Description:	If autodiscover is enabled, any IPv6 address found will lead to an attempt to discover a DNS name via a reverse DNS query. This disables that reverse lookup and any value that would have used the discovered hostname will use the raw IPv6 address instead.
Syntax:	`disable_ipv6_reverse_lookup 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.3 and later

disabled Directive¶

Description:	Disables registration of the enclosing block and any sub-blocks.
Syntax:	`disabled 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.3 and later

force_up_status Directive¶

Description:	Skips any automatic checks to see if a service is running and registers the record to the lookup service regardless of whether the item being registered is actually running or not.
Syntax:	`force_up_status 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.3 and later

is_local Directive¶

Description:	Indicates that the service runs on the same machine as the LS registration Daemon. This must be set for most autodiscover functionality to work, especially as pertains to hosts.
Syntax:	`is_local 0\|1`
Contexts:	top level, site, host, interface, service, service_template
Occurrences:	Zero or one
Default:	0
Compatibility:	3.3 and later

primary_interface Directive¶

Description:	Indicates the primary interface to use. When set, autodiscover will only register information for this interface when determining a service address
Syntax:	`primary_interface IFNAME`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or one
Default:	First interface encountered with an address
Compatibility:	3.4 and later

service_template Directive¶

Description:	A set of common parameters to be used by any service that inherits this template
Syntax:	`<service_template TEMPLATENAME>...</service_template>`
Contexts:	top level, site, host
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.4 and later

Location and Contact Information¶

administrator Directive¶

Description:	A person responsible for managing the entity to be registered. See Administrators for more information.
Syntax:	`<administrator>...</administrator>`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or More
Default:	N/A
Compatibility:	3.3 and later

city Directive¶

Default (Autodiscover):
Description:	The city in which the entity to be registered resides
Syntax:	`city CITY`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

country Directive¶

Default (Autodiscover):
Description:	The ISO 3166 two-letter country code for the country in which the entity to be registered resides
Syntax:	`country COUNTRY`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

domain Directive¶

Default (Autodiscover):
Description:	The administrative domain in which the entity to be registered resides. Usually expressed as a DNS name (e.g. perfsonar.net).
Syntax:	`domain DOMAIN`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

latitude Directive¶

Default (Autodiscover):
Description:	The latitude of the entity to be registered. Specified as a positive (north of the equator) or negative (south of the equator) decimal.
Syntax:	`latitude LATITUDE`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

longitude Directive¶

Default (Autodiscover):
Description:	The longitude of the entity to be registered. Specified as a positive (east of the prime meridian) or negative (west of the prime meridian) decimal.
Syntax:	`longitude LONGITUDE`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

region Directive¶

Default (Autodiscover):
Description:	The country specific region. For example, in the U.S. this value corresponds to the state. It should be the two-letter abbreviation if applicable.
Syntax:	`region REGION`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

site Directive¶

Default (Autodiscover):
Description:	A grouping of elements that have similar configured properties, be it location, autodiscover settings or otherwise. See Sites for more information.
Syntax:	`<site>...</site>`
Contexts:	top level
Occurrences:	Zero or More
Default:	N/A
	N/A

zip_code Directive¶

Default (Autodiscover):
Description:	The country specific postal code of the location where the entity to be registered resides.
Syntax:	`zip_code ZIPCODE`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

Administrators¶

name Directive¶

Default (Autodiscover):
Description:	The full name of the administrator. Either this field or email is required.
Syntax:	`name NAME`
Contexts:	administrator
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

email Directive¶

Default (Autodiscover):
Description:	The email address of the administrator. Either this field or name is required.
Syntax:	`email EMAIL`
Contexts:	administrator
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

organization Directive¶

Default (Autodiscover):
Description:	The organization to which the administrator belongs
Syntax:	`organization ORGANIZATION`
Contexts:	administrator
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

phone Directive¶

Default (Autodiscover):
Description:	The phone number of the administrator
Syntax:	`phone PHONE`
Contexts:	administrator
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

Sites¶

host Directive¶

Default (Autodiscover):
Description:	A host to be registered. See Hosts for more details.
Syntax:	`<host>...</host>`
Contexts:	site
Occurrences:	Zero or More
Default:	N/A
	N/A
Compatibility:	3.3 and later

site_name Directive¶

Default (Autodiscover):
Description:	The name of the site
Syntax:	`site_name NAME`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

site_project Directive¶

Default (Autodiscover):
Description:	A community string or project string to be registered. Often used as a way to define custom tags for registered entities.
Syntax:	`site_name NAME`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or More
Default:	N/A
	N/A
Compatibility:	3.3 and later

Hosts¶

access_policy Directive¶

Default (Autodiscover):
Description:	Indicates who may access this host to run tests. Valid values are public (anyone can access), private (only the owner’s local network can access), research-education (only those coming from R&E networks may access) or limited (some combination of the others, you should provide more detail in access_policy_notes).
Syntax:	`access_policy POLICY`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.5 and later

access_policy_notes Directive¶

Default (Autodiscover):
Description:	A human-readable description of the access_policy. For example “Authenticate using username and password”. There is no defined form for this field and is intended as a way to provide additional information to those looking at the record.
Syntax:	`access_policy_notes NOTES`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.5 and later

autodiscover_interfaces Directive¶

Default (Autodiscover):
Description:	Indicates whether you want to autodiscover the list of interfaces on the host. Enabled if autodiscover Directive is set. Disabling this with autodiscover Directive enabled will turn-off interface discover but still allow other fields to be discovered.
Syntax:	`autodiscover_interfaces 0\|1`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	The value of autodiscover Directive
	N/A
Compatibility:	3.4 and later

bundle_type Directive¶

Default (Autodiscover):
Description:	The type of perfSONAR install. Examples include test-point, perfsonar-core, perfsonar-complete, and perfsonar-toolkit
Syntax:	`bundle_type TYPE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The contents of /var/lib/perfsonar/bundles/bundle_type
Compatibility:	3.5 and later

bundle_version Directive¶

Default (Autodiscover):
Description:	The version of the bundle installed
Syntax:	`bundle_version VERSION`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The contents of /var/lib/perfsonar/bundles/bundle_version
Compatibility:	3.5 and later

host_name Directive¶

Default (Autodiscover):
Description:	A DNS name (preferably) or IP that identifies the host
Syntax:	`host_name NAME`
Contexts:	host
Occurrences:	Zero or One
Default:	N/A
	The DNS hostname that matches a reverse lookup of the auto-discovered address of the host.
Compatibility:	3.4 and later

interface Directive¶

Default (Autodiscover):
Description:	Represents a manually defined interface on the host. See Interfaces for more details.
Syntax:	`<interface>...<interface>`
Contexts:	host
Occurrences:	Zero or More
Default:	N/A
	The list of interfaces on the host as reported by ifconfig
Compatibility:	3.4 and later

is_virtual_machine Directive¶

Default (Autodiscover):
Description:	Indicates if this host is a virtual machine (VM) as opposed to a physical host
Syntax:	`is_virtual_machine 0\|1`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.5 and later

memory Directive¶

Default (Autodiscover):
Description:	The amount of memory on the host appended with the units (e.g. 1024MB, 1GB)
Syntax:	`memory MEMORY`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The total system memory in MB
Compatibility:	3.4 and later

os_kernel Directive¶

Default (Autodiscover):
Description:	The kernel and version running on the host.
Syntax:	`os_kernel KERNEL`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The OS name and version output separated by a space from /etc/redhat-release, /etc/os_version or /etc/debian_version depending on the OS.
Compatibility:	3.4 and later

os_name Directive¶

Default (Autodiscover):
Description:	The name of the operating system (e.g. CentOS, Debian, etc).
Syntax:	`os_name NAME`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The OS name from /etc/redhat-release, /etc/os_version or /etc/debian_version depending on the OS.
Compatibility:	3.4 and later

os_version Directive¶

Default (Autodiscover):
Description:	The version of the operating system.
Syntax:	`os_version VERSION`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The OS version from /etc/redhat-release, /etc/os_version or /etc/debian_version depending on the OS.
Compatibility:	3.4 and later

processor_cores Directive¶

Default (Autodiscover):
Description:	The number of cores on the machine’s processor(s)
Syntax:	`processor_cores CORES`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The CPU(s) as reported by lscpu
Compatibility:	3.4 and later

processor_count Directive¶

Default (Autodiscover):
Description:	The number processors
Syntax:	`processor_count COUNT`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The Socket(s) as reported by lscpu
Compatibility:	3.4 and later

processor_speed Directive¶

Default (Autodiscover):
Description:	The processor speed with units at the end of value (e.g. 2400MHz, 2.4 GHz)
Syntax:	`processor_speed SPEED`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The CPU MHz as reported by lscpu
Compatibility:	3.4 and later

processor_cpuid Directive¶

Default (Autodiscover):
Description:	A human readable name and description of your processor
Syntax:	`processor_cpuid DESCRIPTION`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	The model name from /proc/cpuinfo
Compatibility:	3.5 and later

role Directive¶

Default (Autodiscover):
Description:	The type of host. Valid values are zero or more of the following nren, regional, site-border, site-internal, science-dmz, exchange-point, test-host, default-path, backup-path
Syntax:	`role ROLE`
Contexts:	top level, site, host
Occurrences:	Zero or More
Default:	N/A
	N/A
Compatibility:	3.5 and later

service Directive¶

Default (Autodiscover):
Description:	A service running on the host. See Services for more details.
Syntax:	`<service>...</service>`
Contexts:	top level, site, host
Occurrences:	Zero or More
Default:	N/A
	N/A
Compatibility:	3.3 and later

tcp_autotune_max_buffer_recv Directive¶

Default (Autodiscover):
Description:	The maximum receive buffer autotuning will calculate
Syntax:	`tcp_autotune_max_buffer_recv SIZE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	net.ipv4.tcp_rmem as reported by sysctl
Compatibility:	3.4 and later

tcp_autotune_max_buffer_send Directive¶

Default (Autodiscover):
Description:	The maximum send buffer autotuning will calculate
Syntax:	`tcp_autotune_max_buffer_send SIZE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	net.ipv4.tcp_wmem as reported by sysctl
Compatibility:	3.4 and later

tcp_cc_algorithm Directive¶

Default (Autodiscover):
Description:	The TCP congestion control algorithm configured for the host
Syntax:	`tcp_cc_algorithm SIZE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	net.ipv4.tcp_congestion_control as reported by sysctl
Compatibility:	3.4 and later

tcp_max_backlog Directive¶

Default (Autodiscover):
Description:	The length of the processor input queue
Syntax:	`tcp_max_backlog SIZE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	net.core.netdev_max_backlog as reported by sysctl
Compatibility:	3.4 and later

tcp_max_buffer_recv Directive¶

Default (Autodiscover):
Description:	The maximum size of TCP buffers for receiving
Syntax:	`tcp_max_buffer_recv SIZE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	net.core.rmem_max as reported by sysctl
Compatibility:	3.4 and later

tcp_max_buffer_send Directive¶

Default (Autodiscover):
Description:	The maximum size of TCP buffers for sending
Syntax:	`tcp_max_buffer_send SIZE`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	net.core.wmem_max as reported by sysctl
Compatibility:	3.4 and later

tcp_max_achievable Directive¶

Default (Autodiscover):
Description:	The known maximum achievable throughput on this host. This is a manually set value based on experience with the hardware. For example, some low cost hosts may have a 1Gbps network interface, but processor limitations prevent it from ever achieving more than 500Mbps. Should be value followed by units (e.g. 1024Mbps, 1Gbps)
Syntax:	`tcp_max_achievable BANDWIDTH`
Contexts:	top level, site, host
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.5 and later

Interfaces¶

address Directive¶

Default (Autodiscover):
Description:	The IP address or DNS name of the interface.
Syntax:	`address ADDRESS`
Contexts:	top level, site, host, interface
Occurrences:	Zero or More
Default:	N/A
	The IP address(es) as reported by ifconfig
Compatibility:	3.3 and later

capacity Directive¶

Default (Autodiscover):
Description:	The maximum throughput of the interface in bps.
Syntax:	`capacity CAPACITY`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	The speed as reported by /sys/class/net/IF_NAME/speed. If not available, the speed as reported by ethtool.
Compatibility:	3.3 and later

disable_test Directive¶

Description:	Removes test type from interface even if it is in the autodiscovery list
Syntax:	`disable_test TEST_TYPE`
Contexts:	interface
Occurrences:	Zero or More
Default:	N/A

if_name Directive¶

Default (Autodiscover):
Description:	The interface name (e.g. eth1, em0)
Syntax:	`if_name NAME`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	The interface name as reported by ifconfig
Compatibility:	3.3 and later

if_type Directive¶

Default (Autodiscover):
Description:	The type of interface (e.g. Ethernet)
Syntax:	`if_type TYPE`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

mac_address Directive¶

Default (Autodiscover):
Description:	The MAC address of the interface
Syntax:	`mac_address ADDRESS`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	The MAC address as reported by the IO::Interface::Simple perl module
Compatibility:	3.3 and later

mtu Directive¶

Default (Autodiscover):
Description:	The MTU of the interface in bytes
Syntax:	`mtu MTU`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	The MTU as reported by the IO::Interface::Simple perl module
Compatibility:	3.3 and later

subnet Directive¶

Default (Autodiscover):
Description:	The IP subnet mask of the interface.
Syntax:	`subnet MASK`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

test Directive¶

Default (Autodiscover):
Description:	A pscheduler test type that is allowed on this interface. For example throughput, latencybg or trace. Will be merged with autodiscovered values unless disable_autodiscover_tests set.
Syntax:	`test TEST_TYPE`
Contexts:	interface
Occurrences:	Zero or More
Default:	N/A
	The tests found by querying pScheduler

urn Directive¶

Default (Autodiscover):
Description:	A URN used to identify his interface in an external topology description format
Syntax:	`urn URN`
Contexts:	top level, site, host, interface
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

Services¶

address Directive¶

Default (Autodiscover):
Description:	The IP address or DNS name on which the service listens
Syntax:	`address ADDRESS`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or More
Default:	N/A
	The auto-discovered primary address
Compatibility:	3.3 and later

authentication_type Directive¶

Default (Autodiscover):
Description:	The method with which one may authenticate to this service.
Syntax:	`authentication_type TYPE`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or More
Default:	N/A
	N/A
Compatibility:	3.3 and later

autodiscover_addresses Directive¶

Default (Autodiscover):
Description:	Indicates whether you want to autodiscover the address on which the service listens. Enabled if autodiscover Directive is set. Disabling this with autodiscover Directive enabled will turn-off address discovery but still allow other fields to be discovered.
Syntax:	`autodiscover_addresses 0\|1`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	The value of autodiscover Directive
	N/A
Compatibility:	3.3 and later

inherits Directive¶

Default (Autodiscover):
Description:	Indicates the service template from which to inherit properties
Syntax:	`inherits TEMPLATENAME`
Contexts:	service
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.3 and later

port Directive¶

Default (Autodiscover):
Description:	The port on which the service listens
Syntax:	`port NUMBER`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	Depends on the service type
	N/A
Compatibility:	3.3 and later

service_locator Directive¶

Default (Autodiscover):
Description:	The URL where the service can be contacted
Syntax:	`service_locator URL`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	Built from the address and port
	N/A
Compatibility:	3.3 and later

service_name Directive¶

Default (Autodiscover):
Description:	The name of the service as a human-readable description
Syntax:	`service_name NAME`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	The site name and service type separated by a space
	N/A
Compatibility:	3.3 and later

service_version Directive¶

Default (Autodiscover):
Description:	The version of the service
Syntax:	`service_version VERSION`
Contexts:	top level, site, host, service, service_template
Occurrences:	Zero or One
Default:	Service dependent
	N/A
Compatibility:	3.3 and later

type Directive¶

Default (Autodiscover):
Description:	The type of the service. See description below for valid types.
Syntax:	`type TYPE`
Contexts:	top level, site, host, service
Occurrences:	Zero or One
Default:	Service dependent
	N/A
Compatibility:	3.3 and later

Valid values for this field are currently:

dashboard
gridftp
ma
owamp
ping
pscheduler
traceroute

Service Type-Specific Parameters¶

autodiscover_ca_file Directive¶

Default (Autodiscover):
Description:	For autodiscovery of information that requires contacting an HTTPS service, this is the path to the CA file that can be used to verify the identity of the server
Syntax:	`autodiscover_ca_file FILE`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.4 and later

autodiscover_ca_path Directive¶

Default (Autodiscover):
Description:	For autodiscovery of information that requires contacting an HTTPS service, this is the path to a directory of CA files that can be used to verify the identity of the server when using HTTPS
Syntax:	`autodiscover_ca_path DIR`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.4 and later

autodiscover_indices Directive¶

Default (Autodiscover):
Description:	Indicates whether or not to try to index results. Currently only traceroute data is supported. This will look at traceroute results in autodiscover_index_time_range and report unique hops.
Syntax:	`autodiscover_indices 0\|1`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	The value of autodiscover_tests
	N/A
Compatibility:	3.4 and later

autodiscover_index_time_range Directive¶

Default (Autodiscover):
Description:	If autodiscover_indices is enabled, the time range to query the MA for results to index in seconds.
Syntax:	`autodiscover_index_time_range 0\|1`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	604800
	N/A
Compatibility:	3.4 and later

autodiscover_tests Directive¶

Default (Autodiscover):
Description:	If enabled, contacts the MA service to be registered and automatically generates a list of tests to register based on the metadata returned.
Syntax:	`autodiscover_tests 0\|1`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	0
	N/A

autodiscover_url Directive¶

Default (Autodiscover):
Description:	The URL to contact to autodiscover details about an HTTP service
Syntax:	`autodiscover_url URL`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	The value of service_locator Directive
	N/A

autodiscover_verify_hostname Directive¶

Default (Autodiscover):
Description:	For autodiscovery of information that requires contacting an HTTPS service, indicates whether the hostname must match the certificate common name
Syntax:	`autodiscover_verify_hostname 0\|1`
Contexts:	service where type is ma
Occurrences:	Zero or One
Default:	0
	N/A
Compatibility:	3.4 and later

autodiscover_webui_url Directive¶

Default (Autodiscover):
Description:	Indicates whether the dashboard web interface URL should be auto-discovered
Syntax:	`autodiscover_webui_url 0\|1`
Contexts:	service where type is dashboard
Occurrences:	Zero or One
Default:	0
	N/A
Compatibility:	3.4 and later

http_port Directive¶

Default (Autodiscover):
Description:	The port where a web service listens for HTTP connections
Syntax:	`http_port PORT`
Contexts:	service where type is dashboard, ma, pscheduler
Occurrences:	Zero or One
Default:	80 (unless https_port Directive set, then this is left unset if no manual value provided)
	N/A
Compatibility:	3.4 and later

https_port Directive¶

Default (Autodiscover):
Description:	The port where a web service listens for HTTPS connections
Syntax:	`https_port PORT`
Contexts:	service where type is dashboard, ma, pscheduler
Occurrences:	Zero or One
Default:	N/A
	N/A
Compatibility:	3.4 and later

url_path Directive¶

Default (Autodiscover):
Description:	The path portion of the URL where a web service runs
Syntax:	`url_path PATH`
Contexts:	service where type is dashboard, ma, pscheduler
Occurrences:	Exactly one
Default:	N/A
	N/A
Compatibility:	3.4 and later

webui_url Directive¶

Default (Autodiscover):
Description:	The URL of a web interface associated with a service
Syntax:	`webui_url URL`
Contexts:	service where type is dashboard
Occurrences:	Zero or One
Default:	The manually set address and port with path /maddash-webui
	The auto-detected address and port with path /maddash-webui
Compatibility:	3.4 and later

test Directive¶

Default (Autodiscover):
Description:	Represents a measurement stored in an archive. See Measurement Archive Tests for more details.
Syntax:	`<test>...</test>`
Contexts:	service where type is ma
Occurrences:	Zero or More
Default:	N/A
	The tests found by querying the MA metadata

Measurement Archive Tests¶

event_type Directive¶

Default (Autodiscover):
Description:	The type of test as defined here.
Syntax:	`event_type EVENTTYPE`
Contexts:	test
Occurrences:	One or More
Default:	N/A
	The list of event-types for a given test as reported by the queried MA

destination Directive¶

Default (Autodiscover):
Description:	The destination of the test as an IP address
Syntax:	`destination IP`
Contexts:	test
Occurrences:	Exactly One
Default:	N/A
	The destination of a given test as reported by the queried MA

ma_locator Directive¶

Default (Autodiscover):
Description:	The URL of the MA storing this test
Syntax:	`ma_locator URL`
Contexts:	test
Occurrences:	One or More
Default:	N/A
	The URL of the queried MA

measurement_agent Directive¶

Default (Autodiscover):
Description:	The IP address of the test initiator
Syntax:	`measurement_agent IP`
Contexts:	test
Occurrences:	Exactly one
Default:	N/A
	The measurement-agent of a given test as reported by the queried MA

metadata_uri Directive¶

Default (Autodiscover):
Description:	The URI used to access a particular test
Syntax:	`metadata_uri URI`
Contexts:	test
Occurrences:	Exactly one
Default:	N/A
	The uri of a given test as reported by the queried MA

result_index Directive¶

Default (Autodiscover):
Description:	In general, you will not manually set this value. A summarized value derived from the results of the test that can be searched by LS clients.
Syntax:	`result_index VALUE`
Contexts:	test
Occurrences:	Zero or More
Default:	N/A
	Type dependent. For traceroute tests, a unique hop found in the results.

source Directive¶

Default (Autodiscover):
Description:	The source of the test as an IP address
Syntax:	`source IP`
Contexts:	test
Occurrences:	Exactly One
Default:	N/A
	The source of a given test as reported by the queried MA

tool_name Directive¶

Default (Autodiscover):
Description:	The name of the tool used to perform a measurement
Syntax:	`tool_name TOOL`
Contexts:	test
Occurrences:	Exactly One
Default:	N/A
	The tool-name of a given test as reported by the queried MA

Misc. Daemon Settings¶

check_config_interval Directive¶

Description:	The frequency in seconds to check the lsregistrationdaemon.conf file for changes.
Syntax:	`check_config_interval SECONDS`
Contexts:	top level
Occurrences:	Zero or One
Default:	60
Compatibility:	4.0 and later

client_uuid_file Directive¶

Description:	The location of the file containing a UUID to be registered with each record in the client-uuid field. If the file does not exist it will be created and populated with a random UUID.
Syntax:	`client_uuid_file FILE`
Contexts:	top level
Occurrences:	Zero or One
Default:	/var/lib/perfsonar/lsregistrationdaemon/client_uuid

group Directive¶

Description:	The group to run the daemon as. Overridden by the –group command-line switch.
Syntax:	`group GID`
Contexts:	top level
Occurrences:	Zero or One
Default:	N/A

ls_key_db Directive¶

Description:	The location of the SQLite database where registration keys are kept. Registration keys are assigned by the lookup service when a record is first created and are used for subsequent renewals.
Syntax:	`ls_key_db DB`
Contexts:	top level
Occurrences:	Zero or One
Default:	/var/lib/perfsonar/lsregistrationdaemon/lsKey.db

pidfile Directive¶

Description:	The PID file location. Overridden by the –pidfile command-line switch.
Syntax:	`pidfile FILE`
Contexts:	top level
Occurrences:	Zero or One
Default:	/var/run/ls_registration_daemon.pid

user Directive¶

Description:	The user to run the daemon as. Overridden by the –user command-line switch.
Syntax:	`user UID`
Contexts:	top level
Occurrences:	Zero or One
Default:	N/A