File: OobsStaticHost.html

package info (click to toggle)
liboobs 2.22.0-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 3,304 kB
  • ctags: 1,810
  • sloc: ansic: 9,187; sh: 9,079; xml: 4,747; makefile: 120
file content (248 lines) | stat: -rw-r--r-- 11,438 bytes parent folder | download
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OobsStaticHost</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Liboobs (System configuration management) Reference Manual">
<link rel="up" href="ch08.html" title="Hosts resolution management">
<link rel="prev" href="liboobs-OobsHostsConfig.html" title="OobsHostsConfig">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Session management">
<link rel="chapter" href="ch02.html" title="Liboobs data management">
<link rel="chapter" href="ch03.html" title="Users and groups management">
<link rel="chapter" href="ch04.html" title="Shared folders management">
<link rel="chapter" href="ch05.html" title="Date and time management">
<link rel="chapter" href="ch06.html" title="System boot management">
<link rel="chapter" href="ch07.html" title="Network interfaces management">
<link rel="chapter" href="ch08.html" title="Hosts resolution management">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="liboobs-OobsHostsConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch08.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#OobsStaticHost.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#OobsStaticHost.description" class="shortcut">Description</a>
                   | 
                  <a href="#OobsStaticHost.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#OobsStaticHost.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="OobsStaticHost"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OobsStaticHost.top_of_page"></a>OobsStaticHost</span></h2>
<p>OobsStaticHost — Object that represents an individual static host settings.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="OobsStaticHost.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">



                    <a class="link" href="OobsStaticHost.html#OobsStaticHost-struct" title="OobsStaticHost">OobsStaticHost</a>;
<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a>*     <a class="link" href="OobsStaticHost.html#oobs-static-host-new" title="oobs_static_host_new ()">oobs_static_host_new</a>                (const gchar *ip_address,
                                                         GList *aliases);
const gchar*        <a class="link" href="OobsStaticHost.html#oobs-static-host-get-ip-address" title="oobs_static_host_get_ip_address ()">oobs_static_host_get_ip_address</a>     (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host);
void                <a class="link" href="OobsStaticHost.html#oobs-static-host-set-ip-address" title="oobs_static_host_set_ip_address ()">oobs_static_host_set_ip_address</a>     (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host,
                                                         const gchar *ip_address);
GList*              <a class="link" href="OobsStaticHost.html#oobs-static-host-get-aliases" title="oobs_static_host_get_aliases ()">oobs_static_host_get_aliases</a>        (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host);
void                <a class="link" href="OobsStaticHost.html#oobs-static-host-set-aliases" title="oobs_static_host_set_aliases ()">oobs_static_host_set_aliases</a>        (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host,
                                                         GList *aliases);

</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsStaticHost.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">

  GObject
   +----OobsStaticHost
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsStaticHost.properties"></a><h2>Properties</h2>
<pre class="synopsis">

  "<a class="link" href="OobsStaticHost.html#OobsStaticHost--ip-address" title='The "ip-address" property'>ip-address</a>"               gchar*                : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsStaticHost.description"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="OobsStaticHost.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="OobsStaticHost-struct"></a><h3>OobsStaticHost</h3>
<pre class="programlisting">typedef struct _OobsStaticHost OobsStaticHost;</pre>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-static-host-new"></a><h3>oobs_static_host_new ()</h3>
<pre class="programlisting"><a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a>*     oobs_static_host_new                (const gchar *ip_address,
                                                         GList *aliases);</pre>
<p>
Returns a new <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a> defining both the IP address
and the list of hostnames that will point to the IP address.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ip_address</code></em> :</span></p></td>
<td> IP address for the static host.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>aliases</code></em> :</span></p></td>
<td> <span class="type">GList</span> of aliases to <span class="type">ip_address</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-static-host-get-ip-address"></a><h3>oobs_static_host_get_ip_address ()</h3>
<pre class="programlisting">const gchar*        oobs_static_host_get_ip_address     (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host);</pre>
<p>
Returns the static host IP address.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
<td> An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A pointer to the static host IP address as a string.
              This string must not be freed, modified or stored.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-static-host-set-ip-address"></a><h3>oobs_static_host_set_ip_address ()</h3>
<pre class="programlisting">void                oobs_static_host_set_ip_address     (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host,
                                                         const gchar *ip_address);</pre>
<p>
Sets the IP address of <span class="type">static_host</span> to be <span class="type">ip_address</span>,
overwriting the previous one.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
<td> An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ip_address</code></em> :</span></p></td>
<td> A new IP address for <span class="type">static_host</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-static-host-get-aliases"></a><h3>oobs_static_host_get_aliases ()</h3>
<pre class="programlisting">GList*              oobs_static_host_get_aliases        (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host);</pre>
<p>
Returns the hostname aliases for the <span class="type">static_host</span> IP address.
The returned list must be freed with <code class="function">g_list_free()</code>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
<td> An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <span class="type">GList</span> of gchar pointers containing the host aliases.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-static-host-set-aliases"></a><h3>oobs_static_host_set_aliases ()</h3>
<pre class="programlisting">void                oobs_static_host_set_aliases        (<a class="link" href="OobsStaticHost.html" title="OobsStaticHost">OobsStaticHost</a> *static_host,
                                                         GList *aliases);</pre>
<p>
Sets a new list of aliases for the <span class="type">static_host</span>
IP address. overwriting the previous one.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>static_host</code></em> :</span></p></td>
<td> An <a class="link" href="OobsStaticHost.html" title="OobsStaticHost"><span class="type">OobsStaticHost</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>aliases</code></em> :</span></p></td>
<td> a <span class="type">GList</span> of gchar pointers containing the host aliases.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsStaticHost.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="OobsStaticHost--ip-address"></a><h3>The <code class="literal">"ip-address"</code> property</h3>
<pre class="programlisting">  "ip-address"               gchar*                : Read / Write</pre>
<p>IP address of the static host definition.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>