1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<!-- splitted from ./en/functions/radius.xml, last change in rev 1.9 -->
<refentry xml:id="function.radius-add-server" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>radius_add_server</refname>
<refpurpose>Adds a server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>radius_add_server</methodname>
<methodparam><type>resource</type><parameter>radius_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam><type>string</type><parameter>secret</parameter></methodparam>
<methodparam><type>int</type><parameter>timeout</parameter></methodparam>
<methodparam><type>int</type><parameter>max_tries</parameter></methodparam>
</methodsynopsis>
<para>
<function>radius_add_server</function> may be called multiple times, and it
may be used together with <function>radius_config</function>. At most 10
servers may be specified. When multiple servers are given, they are tried
in round-robin fashion until a valid response is received, or until each
server's <parameter>max_tries</parameter> limit has been reached.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>radius_handle</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
The <parameter>hostname</parameter> parameter specifies the server host,
either as a fully qualified domain name or as a dotted-quad IP address
in text form.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
<para>
The <parameter>port</parameter> specifies the UDP port to contact on
the server. If port is given as 0, the library looks up the
<systemitem class="resource">radius/udp</systemitem> or
<systemitem class="resource">radacct/udp</systemitem> service in the
network services database, and uses the port found there. If no entry
is found, the library uses the standard Radius ports, 1812 for
authentication and 1813 for accounting.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>secret</parameter></term>
<listitem>
<para>
The shared secret for the server host is passed to the
<parameter>secret</parameter> parameter. The Radius protocol ignores
all but the leading 128 bytes of the shared secret.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
The timeout for receiving replies from the server is passed to the
<parameter>timeout</parameter> parameter, in units of seconds.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_tries</parameter></term>
<listitem>
<para>
The maximum number of repeated requests to make before giving up is
passed into the <parameter>max_tries</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>radius_add_server</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
if (!radius_add_server($res, 'radius.example.com', 1812, 'testing123', 3, 3)) {
echo 'RadiusError:' . radius_strerror($res). "\n<br>";
exit;
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>radius_config</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|