3 # Samba4 AD database checker
5 # Copyright (C) Andrew Tridgell 2011
6 # Copyright Giampaolo Lauria 2011 <lauria2@yahoo.com>
8 # This program is free software; you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 import samba
.getopt
as options
24 from samba
.auth
import system_session
25 from samba
.samdb
import SamDB
26 from samba
.netcmd
import (
31 from samba
.dbchecker
import dbcheck
34 class cmd_dbcheck(Command
):
35 """check local AD database for errors"""
36 synopsis
= "%prog [<DN>] [options]"
41 Option("--scope", dest
="scope", default
="SUB",
42 help="Pass search scope that builds DN list. Options: SUB, ONE, BASE"),
43 Option("--fix", dest
="fix", default
=False, action
='store_true',
44 help='Fix any errors found'),
45 Option("--yes", dest
="yes", default
=False, action
='store_true',
46 help="don't confirm changes, just do them all as a single transaction"),
47 Option("--cross-ncs", dest
="cross_ncs", default
=False, action
='store_true',
48 help="cross naming context boundaries"),
49 Option("-v", "--verbose", dest
="verbose", action
="store_true", default
=False,
50 help="Print more details of checking"),
51 Option("--quiet", dest
="quiet", action
="store_true", default
=False,
52 help="don't print details of checking"),
53 Option("--attrs", dest
="attrs", default
=None, help="list of attributes to check (space separated)"),
54 Option("--reindex", dest
="reindex", default
=False, action
="store_true", help="force database re-index"),
55 Option("-H", "--URL", help="LDB URL for database or target server (defaults to local SAM database)",
56 type=str, metavar
="URL", dest
="H"),
59 def run(self
, DN
=None, H
=None, verbose
=False, fix
=False, yes
=False,
60 cross_ncs
=False, quiet
=False,
61 scope
="SUB", credopts
=None, sambaopts
=None, versionopts
=None,
62 attrs
=None, reindex
=False):
64 lp
= sambaopts
.get_loadparm()
66 over_ldap
= H
is not None and H
.startswith('ldap')
69 creds
= credopts
.get_credentials(lp
, fallback_machine
=True)
73 samdb
= SamDB(session_info
=system_session(), url
=H
,
74 credentials
=creds
, lp
=lp
)
76 if H
is None or not over_ldap
:
79 samdb_schema
= SamDB(session_info
=system_session(), url
=None,
80 credentials
=creds
, lp
=lp
)
82 scope_map
= { "SUB": ldb
.SCOPE_SUBTREE
, "BASE": ldb
.SCOPE_BASE
, "ONE":ldb
.SCOPE_ONELEVEL
}
84 if not scope
in scope_map
:
85 raise CommandError("Unknown scope %s" % scope
)
86 search_scope
= scope_map
[scope
]
88 controls
= ['show_deleted:1']
90 controls
.append('paged_results:1:1000')
92 controls
.append("search_options:1:2")
99 started_transaction
= False
101 samdb
.transaction_start()
102 started_transaction
= True
104 chk
= dbcheck(samdb
, samdb_schema
=samdb_schema
, verbose
=verbose
,
105 fix
=fix
, yes
=yes
, quiet
=quiet
)
108 self
.outf
.write("Re-indexing...\n")
110 if chk
.reindex_database():
111 self
.outf
.write("completed re-index OK\n")
113 error_count
= chk
.check_database(DN
=DN
, scope
=search_scope
,
114 controls
=controls
, attrs
=attrs
)
116 if started_transaction
:
117 samdb
.transaction_cancel()
120 if started_transaction
:
121 samdb
.transaction_commit()