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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<!-- Created with Funcmake.vsp -->
<refentry id="fn_sys_lockdown">
<refmeta>
<refentrytitle>sys_lockdown</refentrytitle>
<refmiscinfo>admin</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sys_lockdown</refname>
<refpurpose>Set virtuoso in lockdown state and back.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_sys_lockdown">
<funcprototype id="fproto_sys_lockdown">
<funcdef><function>sys_lockdown</function></funcdef>
<paramdef>in <parameter>lock_action</parameter> integer</paramdef>
<paramdef><optional>in <parameter>listeners_mode</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_sys_lockdown">
<title>Description</title>
<para>You must have DBA privileges to run that function.</para>
<para>Calling this with lock_mode = 1 causes the server not to accept any new client
connections, except ones coming from localhost (127.0.0.1). This will also shut down any other
listeners and terminate any possibly pending processing, rolling back all open transactions and
disconnecting all clients, except ones from localhost. Calling thi with lock_mode 0 reverses the effect.
</para>
</refsect1>
<refsect1 id="params_sys_lockdown"><title>Parameters</title>
<refsect2><title>lock_action</title>
<para>(0|1) - 0 = unlock the server; 1 = lock the server</para>
</refsect2>
<refsect2><title>listeners</title>
<para>(0|1 default 0) - 0 = don't serve the listener sockets; 1 = close the listener sockets</para>
</refsect2>
</refsect1>
<refsect1 id="ret_sys_lockdown"><title>Return Types</title>
<para>Lock mode (lock_action = 1) if already in that mode returns 0 otherwise returns 1</para>
<para>Unlock mode (lock_action = 0) if already in that mode returns 0 otherwise returns 2</para>
</refsect1>
</refentry>
|
