[id="{beatname_lc}-reference-yml"]
== {beatname_lc}.reference.yml

The following reference file is available with your {beatname_uc} installation. It
shows all non-deprecated {beatname_uc} options. You can copy from this file and paste
configurations into the +{beatname_lc}.yml+ file to customize it.

TIP: The reference file is located in the same directory as the
+{beatname_lc}.yml+ file. To locate the file, see <<directory-layout>>. 

The contents of the file are included here for your convenience.

ifndef::requires_xpack[]
[source,yaml]
----
include::../../{beatname_lc}/{beatname_lc}.reference.yml[]
----
endif::requires_xpack[]

ifdef::requires_xpack[]
[source,yaml]
----
include::../../x-pack/{beatname_lc}/{beatname_lc}.reference.yml[]
----
endif::requires_xpack[]
