summaryrefslogtreecommitdiffstats
path: root/lib/puppet/reference/network.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet/reference/network.rb')
-rw-r--r--lib/puppet/reference/network.rb33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/puppet/reference/network.rb b/lib/puppet/reference/network.rb
new file mode 100644
index 000000000..32a1fdd89
--- /dev/null
+++ b/lib/puppet/reference/network.rb
@@ -0,0 +1,33 @@
+network = Puppet::Util::Reference.newreference :network, :depth => 2, :doc => "Available network handlers and clients" do
+ ret = ""
+ Puppet::Network::Handler.subclasses.each do |name|
+ handler = Puppet::Network::Handler.handler(name)
+
+ next if ! handler.doc or handler.doc == ""
+
+ interface = handler.interface
+
+ ret += h(name, 2)
+
+ ret += scrub(handler.doc)
+ ret += "\n\n"
+ ret += option(:prefix, interface.prefix)
+ ret += option(:side, handler.side.to_s.capitalize)
+ ret += option(:methods, interface.methods.collect { |ary| ary[0] }.join(", ") )
+ ret += "\n\n"
+ end
+
+ ret
+end
+
+network.header = "
+This is a list of all Puppet network interfaces. Each interface is
+implemented in the form of a client and a handler; the handler is loaded
+on the server, and the client knows how to call the handler's methods
+appropriately.
+
+Most handlers are meant to be started on the server, usually within
+``puppetmasterd``, and the clients are mostly started on the client,
+usually within ``puppetd``.
+
+"