Index - Augeas Documentation

Index

$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

R
	rabbit, Rabbitmq
	Rabbitmq
	raidoption, FAI_DiskConfig
	rbrace, Erlang
	rbrack, Erlang
	rbracket, Sep
	reaction, Nsswitch
	READY-TO-USE LENSES, IniFile
	REAL SERVER CHECKS CONFIGURATION, Keepalived
	real_server_field, Keepalived
	realm_entry, JettyRealm
	recipient, Xymon_Alerting
	RECIPIENTS, Xymon_Alerting
	record Global Apt_Update_Manager AptPreferences Aptsources Avahi BackupPCHosts Crypttab Dpkg IniFile Login_defs Modules Pg_Hba Postfix_Transport Postfix_Virtual Puppet_Auth Schroot Services Subversion Systemd
	Record, Avahi
	RECORD Global IniFile
	Record definition, IniFile
	RECORD TYPES, Mke2fs
	record_ace, Test_IniFile
	record_acf, Test_IniFile
	record_ade, Test_IniFile
	record_adf, Test_IniFile
	record_bce, Test_IniFile
	record_bcf, Test_IniFile
	record_bde, Test_IniFile
	record_bdf, Test_IniFile
	record_label_re, IniFile
	record_local, Pg_Hba
	record_noempty, IniFile
	record_re, IniFile
	record_remote, Pg_Hba
	RECORDS cgrules FAI_DiskConfig
	Records definitions, Pg_Hba
	recover, Xymon_Alerting
	Redis
	Reference Access ActiveMQ_Conf ActiveMQ_XML AFS_cellalias Aliases Anacron Approx AptConf Authorized_Keys Automaster Automounter BackupPCHosts BootConf Build Cachefilesd Carbon Channels Chrony Collectd CPanel Cron Crypttab debctrl Dhcpd Dns_Zone Erlang FAI_DiskConfig Fonts Fuse Gshadow Host_Conf Hosts_Access Htpasswd Inputrc JettyRealm JMXAccess JMXPassword Keepalived Known_Hosts Koji Ldif MCollective Memcached Mke2fs Modprobe Modules MongoDBServer Netmasks Networks Nginx Nsswitch Ntpd Pam PamConf Passwd Pbuilder Postfix_Transport Postfix_Virtual Postgresql Protocols Puppet_Auth Puppetfile Rabbitmq Redis Reprepro_Uploaders Resolv Rmt Rsyslog Schroot Services Shadow Shells Sip_Conf Solaris_System Splunk Ssh Sshd Sudoers Sysconfig_Route Sysctl Syslog Systemd Thttpd Tuned Up2date UpdateDB Vfstab Xorg Xymon_Alerting
	References, Kdump
	refid_re, Ntpd
	reldecimal, Rx
	release_upgrades, Test_Apt_Update_Manager
	relinteger, Rx
	relinteger_noplus, Rx
	remtypes, Pg_Hba
	repeat, Xymon_Alerting
	Reprepro_Uploaders
	reset_counters, Puppet_Auth
	resize, FAI_DiskConfig
	Resolv
	rglob, Erlang
	Rmt
	router, Sysconfig_Route
	rspace, Erlang
	Rsyslog
	rtable_re, Ntpd
	rule, Xymon_Alerting
	rule_filter, Xymon_Alerting
	RULES, Xymon_Alerting
	runas_alias, Sudoers
	runas_spec, Sudoers
	Rx

let rabbit = Erlang.application "rabbit" parameters

The rabbit Erlang.application config

Parses Rabbitmq configuration files

let raidoption =

let rbrace = "}"

Right square bracket

let rbrack = "]"

Right curly brackets

let rbracket = Util.del_str ")"

let reaction = let status_kw = /[Ss][Uu][Cc][Cc][Ee][Ss][Ss]/ | /[Nn][Oo][Tt][Ff][Oo][Uu][Nn][Dd]/ | /[Uu][Nn][Aa][Vv][Aa][Ii][Ll]/ | /[Tt][Rr][Yy][Aa][Gg][Aa][Ii][Nn]/ in let action_kw = /[Rr][Ee][Tt][Uu][Rr][Nn]/ | /[Cc][Oo][Nn][Tt][Ii][Nn][Uu][Ee]/ in let negate = [ Util.del_str "!" . label "negate" ] in let reaction_entry = [ label "status" . negate? . store status_kw . Util.del_str "=" . [ label "action" . store action_kw ] ] in Util.del_str "[" . [ label "reaction" . (Build.opt_list reaction_entry Sep.space) ] . Util.del_str "]"

The reaction on lookup result like `[NOTFOUND=return]’ TODO: Use case-insensitive regexps when ticket #147 is fixed.

let real_server_field = let num_re = "weight" in let flag_re = "inhibit_on_failure" in let to_eol_re = /notify_(up|down)/ in field num_re sto_num | flag flag_re | field to_eol_re sto_to_eol | block "TCP_CHECK" tcp_check_field | block "MISC_CHECK" misc_check_field | block "SMTP_CHECK" smtp_check_field | block /(HTTP|SSL)_GET/ http_check_field

let realm_entry = [ label "user" . [ label "username" . store Rx.word ] . del /[ \t]*:[ \t]*/ ": " . [ label "password" . store Rx.word ] . [ label "realm" . comma_sep . store Rx.word ]* . Util.eol ]

let recipient = mail | script | ignore | format | repeat | unmatched | stop | macro

Recipients are made out of any of the above recipient definitions

let record = IniFile.record title entry

An sssd.conf record

let record = IniFile.record title entry

let record = [ seq "record" . entries+ ]

let record = [ Util.indent . seq "source" . [ label "type" . store word ] . sep_ws . [ label "uri" . store word ] . sep_ws . [ label "distribution" . store word ] . [ label "component" . sep_ws . store word ]* . del /[ \t]*(#.*)?/ "" . eol ]

let record = IniFile.record title entry

let record = let moreusers = Build.opt_list [ label "moreusers" . store word ] Sep.comma in [ seq "host" . [ label "host" . store word ] . Util.del_ws_tab . [ label "dhcp" . store word ] . Util.del_ws_tab . [ label "user" . store word ] . (Util.del_ws_tab . moreusers)? . (Util.comment|Util.eol) ]

let record = [ seq "entry" . [ label "target" . store target ] . sep_tab . [ label "device" . store fspath ] . (sep_tab . [ label "password" . store fspath ] . ( sep_tab . comma_sep_list "opt")? )? . eol ]

A crypttab record

let record = [ key keyword . (sep_spc . store word)? . eol ]

Keyword, followed by optional whitespace and value, followed by EOL.

let record (title:lens) (entry:lens) = record_noempty title ( entry | empty )

Generic INI File record

let record = let value = store /[^ \t\n]+([ \t]+[^ \t\n]+)*/ in [ key Rx.word . Sep.space . value . Util.eol ]

A login.defs record

let record = [ key word . (Util.del_ws_tab . sto_line)? . Util.eol ]

let record = [ seq "entries" . (record_local | record_remote) . eol ]

A sequence of record_local or record_remote entries

let record = [ label "pattern" . store /[A-Za-z0-9@\*.-]+/ . space_or_eol . (transport | nexthop_smtp) . Util.eol ]

let record = let destinations = Build.opt_list destination comma in [ label "pattern" . word . space_or_eol Rx.space " " . destinations . Util.eol ]

let record = let operator = [ label "operator" . store "~" ] in [ Util.indent . key "path" . (Sep.space . operator)? . Sep.space . store /[^~# \t\n][^#\n]*[^# \t\n]|[^~# \t\n]/ . Util.eol . reset_counters . (Util.empty | Util.comment | setting)* . setting ]

let record = IniFile.record title entry

An IniFile.record

let record = [ label "service-name" . store word_re . sep_spc . (port | port_range) . del "/" "/" . protocol . ( sep_spc . alias )* . comment_or_eol ]

A standard /etc/services record TODO: make sure a space is added before a comment on new nodes

let record = IniFile.record_noempty title (entry|empty)

Use the non-indented empty

let record = IniFile.record title (entry|include)

An IniFile.record

let record_ace = IniFile.record title_ace entry_ace

let record_acf = IniFile.record_noempty title_acf entry_acf

let record_ade = IniFile.record title_ade entry_ade

let record_adf = IniFile.record_noempty title_adf entry_adf

let record_bce = IniFile.record title_bce entry_bce

let record_bcf = IniFile.record_noempty title_bce entry_bcf

let record_bde = IniFile.record title_bde entry_bde

let record_bdf = IniFile.record_noempty title_bdf entry_bdf

let record_label_re = /[^]\r\n]+/

Default regexp for title_label keyword pattern

let record_local = [ label "type" . store "local" ] . Sep.tab . database . Sep.tab . user . Sep.tab . method

when type is “local”, there is no “address” field

let record_noempty (title:lens) (entry:lens) = [ title . entry* ]

INI File Record with no empty lines allowed.

let record_re = ( /[^]\r\n\/]+/ - /#comment/ )

Default regexp for title keyword pattern

let record_remote = [ label "type" . store remtypes ] . Sep.tab . database . Sep.tab . user . Sep.tab . address . Sep.tab . method

let recover = flag "RECOVER"

The recover filter definition

Parses Redis’s configuration files

Some examples of valid entries can be found in access.conf or “man access.conf”

This lens ensures that conf files included in ActiveMQ /FuseMQ are properly handled by Augeas.

This lens ensures that XML files included in ActiveMQ / FuseMQ are properly handled by Augeas.

This lens is targeted at the OpenAFS CellAlias file

This lens tries to keep as close as possible to `man 5 aliases` where possible.

This lens tries to keep as close as possible to `man 5 anacrontab` where possible.

This lens tries to keep as close as possible to `man 5 approx.conf` where possible.

This lens tries to keep as close as possible to `man 5 apt.conf` where possible.

This lens tries to keep as close as possible to `man 5 authorized_keys` where possible.

See auto.master(5)

See autofs(5)

This lens tries to keep as close as possible to `man backuppc` where possible.

This lens is used to parse the second-stage bootstrap configuration file, /etc/boot.conf as found on OpenBSD.

This file provides generic functions to build Augeas lenses

This lens tries to keep as close as possible to `man 5 cachefilesd.conf` where possible.

This lens is based on the conf/*.conf.example files from the Carbon package.

See http://linuxtv.org/vdrwiki/index.php/Syntax_of_channels.conf

This lens tries to keep as close as possible to chrony config syntax

This lens tries to keep as close as possible to `man 5 collectd.conf` where possible.

This lens parses cpanel.config files

This lens tries to keep as close as possible to `man 5 crontab` where possible.

This lens tries to keep as close as possible to `man crypttab` where possible.

http://augeas.net/page/Create_a_lens_from_bottom_to_top http://www.debian.org/doc/debian-policy/ch-controlfields.html

Reference: manual of dhcpd.conf and dhcp-eval Follow dhclient module for tree structure

RFC 1035, RFC 2782, RFC 3403

This lens tries to keep as close as possible to `http://www.erlang.org/doc/man/config.html` where possible.

http://wiki.fai-project.org/wiki/Setup-storage#New_configuration_file_syntax

This lens tries to keep as close as possible to `man 5 fonts-conf` where possible.

This lens tries to keep as close as possible to `man 5 host.conf` where possible.

This lens tries to keep as close as possible to `man 5 hosts_access` and `man 5 hosts_options` where possible.

This lens is based on examples in htpasswd(1) and rsyncd.conf(5)

This lens tries to keep as close as possible to `man 3 readline` where possible.

This lens ensures that properties files for JettyRealms are properly handled by Augeas.

This lens ensures that files included in JMXAccess are properly handled by Augeas.

This lens ensures that files included in JMXPassword are properly handled by Augeas.

This lens tries to keep as close as possible to `man 5 keepalived.conf` where possible.

This lens ensures that conf files included in ActiveMQ /FuseMQ are properly handled by Augeas.

This lens tries to keep as close as possible to koji config syntax

This lens tries to keep as close as possible to RFC2849 http://tools.ietf.org/html/rfc2849 and OpenLDAP’s ldif(5)

This lens is based on MCollective’s default client.cfg and server.cfg.

This lens is based on Memcached’s default memcached.conf file.

This lens tries to keep as close as possible to `man 5 mke2fs.conf` where possible.

This lens tries to keep as close as possible to `man 5 modprobe.conf` where possible.

This lens tries to keep as close as possible to `man 5 modules` where possible.

For information on configuration options available to mongod reference one of the following resources:

This lens tries to keep as close as possible to `man 4 netmasks` where possible.

This lens tries to keep as close as possible to `man 5 networks` where possible.

This module was built to support a limited subset of nginx configuration syntax.

This lens tries to keep as close as possible to `man nsswitch.conf` where possible.

This lens is used to parse OpenNTPD’s configuration file, ntpd.conf.

This lens tries to keep as close as possible to `man pam.conf` where possible.

Pbuilderrc is a standard shellvars file.

This lens tries to keep as close as possible to `man 5 transport` where possible.

This lens tries to keep as close as possible to `man 5 virtual` where possible.

http://www.postgresql.org/docs/current/static/config-setting.html

This lens tries to keep as close as possible to `man 5 protocols` where possible.

This lens tries to keep as close as possible to `http://docs.puppetlabs.com/guides/rest_auth_conf.html` where possible.

See https://github.com/rodjek/librarian-puppet

This lens tries to keep as close as possible to `http://www.rabbitmq.com/configure.html` where possible.

This lens is based on Redis’s default redis.conf

This lens tries to keep as close as possible to `man 1 reprepro` where possible.

This lens tries to keep as close as possible to `man resolv.conf` where possible.

This lens is based on rmt(1)

This lens tries to keep as close as possible to `man 5 rsyslog.conf` where possible.

This lens tries to keep as close as possible to `man 5 schroot.conf` where possible.

This lens tries to keep as close as possible to ‘man services’ where possible.

This lens tries to keep as close as possible to `man 5 shells` where possible.

Lens parses the sip.conf with support for template structure

This lens tries to keep as close as possible to `man 4 system` where possible.

http://docs.splunk.com/Documentation/Splunk/5.0.2/Admin/AboutConfigurationFiles

ssh_config man page

sshd_config man page.

This lens tries to keep as close as possible to `man sudoers` where possible.

This lens allows manipulation of one IPv4 variant of the /etc/sysconfig/network-scripts/route-${device} script found in RHEL5+, CentOS5+ and Fedora.

This lens tries to keep as close as possible to `man 5 resolv.conf` where possible.

This lens tries to keep as close as possible to systemd.unit(5) and systemd.service(5) etc where possible.

This lens is based on Thttpd’s default thttpd.conf file.

This lens is based on tuned’s tuned-main.conf

This lens tries to keep as close as possible to `man 5 up2date` where possible.

This lens tries to keep as close as possible to `man 5 updatedb.conf` where possible.

See vfstab(4)

This lens tries to keep as close as possible to `man xorg.conf` where possible.

This lens tries to keep as close as possible to `man 5 alerts.cfg` where possible.

manual page kdump.conf(5)

let refid_re = /[A-Za-z0-9_.-]{1,5}/

string with length < 5

let reldecimal = /[+-]?[0-9]+([.,][0-9]+)?/

A relative decimal

let release_upgrades = "# Default behavior for the release upgrader. [DEFAULT] Prompt=lts "

let relinteger = /[-+]?[0-9]+/

A relative integer

let relinteger_noplus = /[-]?[0-9]+/

A relative integer, without explicit plus sign

let remtypes = "host" | "hostssl" | "hostnossl"

non-local connection types

let repeat = kw_word_filters_opt "REPEAT"

The repeat recipient definition

Parses reprepro’s uploaders files

let reset_counters = counter "environment" . counter "method" . counter "allow" . counter "allow_ip"

let resize = tag "resize"

resize tag

Parses /etc/resolv.conf

let rglob = "\">>"

Right glob separator

Parses rmt’s configuration file

let router = Rx.ipv4

A router

let rspace (char:string) = del (char . /[ \t\n]*/ ) char

Add spaces to the right of char

Parses /etc/rsyslog.conf

let rtable_re = Rx.byte

let rule = [ seq "rules" . filters . ws_or_eol . recipients . eol ]

Rules are made of rule_filter and then recipients sperarated by a whitespace

let rule_filter = page | group | host | service | color | time | duration | recover | notice

Filters are made out of any of the above filter definitions

let runas_alias = alias_entry "Runas_Alias" "runas_user" sto_to_com

Run_Alias, see alias_field

let runas_spec_user = alias_list "runas_user" sto_to_com

A runas specification for spec, using alias_list for listing users and/or groups used to run a command

Generic regexps to build lenses