source4/scripting/python/samba/netcmd/fsmo.py

   1 #!/usr/bin/env python
   2 #
   3 # Changes a FSMO role owner
   4 #
   5 # Copyright Nadezhda Ivanova 2009
   6 # Copyright Jelmer Vernooij 2009
   7 #
   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.
  12 #
  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.
  17 #
  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/>.
  20 #
  21
  22 import samba.getopt as options
  23 import ldb
  24 from ldb import LdbError
  25
  26 from samba.auth import system_session
  27 from samba.netcmd import (
  28     Command,
  29     CommandError,
  30     SuperCommand,
  31     Option,
  32     )
  33 from samba.samdb import SamDB
  34
  35
  36 class cmd_fsmo_seize(Command):
  37     """Seize the role"""
  38
  39     synopsis = "%prog [options]"
  40
  41     takes_optiongroups = {
  42         "sambaopts": options.SambaOptions,
  43         "credopts": options.CredentialsOptions,
  44         "versionopts": options.VersionOptions,
  45         }
  46
  47     takes_options = [
  48         Option("-H", "--URL", help="LDB URL for database or target server", type=str,
  49                metavar="URL", dest="H"),
  50         Option("--force", help="Force seizing of the role without attempting to transfer first.", action="store_true"),
  51         Option("--role", type="choice", choices=["rid", "pdc", "infrastructure","schema","naming","all"],
  52                help="""The FSMO role to seize or transfer.\n
  53 rid=RidAllocationMasterRole\n
  54 schema=SchemaMasterRole\n
  55 pdc=PdcEmulationMasterRole\n
  56 naming=DomainNamingMasterRole\n
  57 infrastructure=InfrastructureMasterRole\n
  58 all=all of the above"""),
  59         ]
  60
  61     takes_args = []
  62
  63     def seize_role(self, role, samdb, force):
  64         res = samdb.search("",
  65                            scope=ldb.SCOPE_BASE, attrs=["dsServiceName"])
  66         assert len(res) == 1
  67         serviceName = res[0]["dsServiceName"][0]
  68         domain_dn = samdb.domain_dn()
  69         m = ldb.Message()
  70         if role == "rid":
  71             m.dn = ldb.Dn(samdb, self.rid_dn)
  72         elif role == "pdc":
  73             m.dn = ldb.Dn(samdb, domain_dn)
  74         elif role == "naming":
  75             m.dn = ldb.Dn(samdb, self.naming_dn)
  76         elif role == "infrastructure":
  77             m.dn = ldb.Dn(samdb, self.infrastructure_dn)
  78         elif role == "schema":
  79             m.dn = ldb.Dn(samdb, self.schema_dn)
  80         else:
  81             raise CommandError("Invalid FSMO role.")
  82         #first try to transfer to avoid problem if the owner is still active
  83         if force is None:
  84             self.message("Attempting transfer...")
  85             try:
  86                 self.transfer_role(role, samdb)
  87             except LdbError, (num, _):
  88             #transfer failed, use the big axe...
  89                 self.message("Transfer unsuccessful, seizing...")
  90                 m["fSMORoleOwner"]= ldb.MessageElement(
  91                     serviceName, ldb.FLAG_MOD_REPLACE,
  92                     "fSMORoleOwner")
  93         else:
  94             self.message("Will not attempt transfer, seizing...")
  95             m["fSMORoleOwner"]= ldb.MessageElement(
  96                 serviceName, ldb.FLAG_MOD_REPLACE,
  97                 "fSMORoleOwner")
  98         try:
  99             samdb.modify(m)
 100         except LdbError, (num, msg):
 101             raise CommandError("Failed to initiate role seize of '%s' role: %s" % (role, msg))
 102         self.outf.write("FSMO transfer of '%s' role successful\n" % role)
 103
 104     def run(self, force=None, H=None, role=None,
 105             credopts=None, sambaopts=None, versionopts=None):
 106
 107         lp = sambaopts.get_loadparm()
 108         creds = credopts.get_credentials(lp, fallback_machine=True)
 109
 110         samdb = SamDB(url=H, session_info=system_session(),
 111                       credentials=creds, lp=lp)
 112
 113         if role == "all":
 114             self.seize_role("rid", samdb, force)
 115             self.seize_role("pdc", samdb, force)
 116             self.seize_role("naming", samdb, force)
 117             self.seize_role("infrastructure", samdb, force)
 118             self.seize_role("schema", samdb, force)
 119         else:
 120             self.seize_role(role, samdb, force)
 121
 122
 123 class cmd_fsmo_show(Command):
 124     """Show the roles"""
 125
 126     synopsis = "%prog [options]"
 127
 128     takes_options = [
 129         Option("-H", "--URL", help="LDB URL for database or target server", type=str,
 130                metavar="URL", dest="H"),
 131         ]
 132
 133     takes_args = []
 134
 135     def run(self, H=None, credopts=None, sambaopts=None, versionopts=None):
 136         lp = sambaopts.get_loadparm()
 137         creds = credopts.get_credentials(lp, fallback_machine=True)
 138
 139         samdb = SamDB(url=H, session_info=system_session(),
 140             credentials=creds, lp=lp)
 141
 142         domain_dn = samdb.domain_dn()
 143         self.infrastructure_dn = "CN=Infrastructure," + domain_dn
 144         self.naming_dn = "CN=Partitions,%s" % samdb.get_config_basedn()
 145         self.schema_dn = samdb.get_schema_basedn()
 146         self.rid_dn = "CN=RID Manager$,CN=System," + domain_dn
 147
 148         res = samdb.search(self.infrastructure_dn,
 149                            scope=ldb.SCOPE_BASE, attrs=["fSMORoleOwner"])
 150         assert len(res) == 1
 151         self.infrastructureMaster = res[0]["fSMORoleOwner"][0]
 152
 153         res = samdb.search(domain_dn,
 154                            scope=ldb.SCOPE_BASE, attrs=["fSMORoleOwner"])
 155         assert len(res) == 1
 156         self.pdcEmulator = res[0]["fSMORoleOwner"][0]
 157
 158         res = samdb.search(self.naming_dn,
 159                            scope=ldb.SCOPE_BASE, attrs=["fSMORoleOwner"])
 160         assert len(res) == 1
 161         self.namingMaster = res[0]["fSMORoleOwner"][0]
 162
 163         res = samdb.search(self.schema_dn,
 164                            scope=ldb.SCOPE_BASE, attrs=["fSMORoleOwner"])
 165         assert len(res) == 1
 166         self.schemaMaster = res[0]["fSMORoleOwner"][0]
 167
 168         res = samdb.search(self.rid_dn,
 169                            scope=ldb.SCOPE_BASE, attrs=["fSMORoleOwner"])
 170         assert len(res) == 1
 171         self.ridMaster = res[0]["fSMORoleOwner"][0]
 172
 173         self.message("InfrastructureMasterRole owner: " + self.infrastructureMaster)
 174         self.message("RidAllocationMasterRole owner: " + self.ridMaster)
 175         self.message("PdcEmulationMasterRole owner: " + self.pdcEmulator)
 176         self.message("DomainNamingMasterRole owner: " + self.namingMaster)
 177         self.message("SchemaMasterRole owner: " + self.schemaMaster)
 178
 179
 180 class cmd_fsmo_transfer(Command):
 181     """Transfer the role"""
 182
 183     synopsis = "%prog [options]"
 184
 185     takes_options = [
 186         Option("-H", "--URL", help="LDB URL for database or target server", type=str,
 187                metavar="URL", dest="H"),
 188         Option("--role", type="choice", choices=["rid", "pdc", "infrastructure","schema","naming","all"],
 189                help="""The FSMO role to seize or transfer.\n
 190 rid=RidAllocationMasterRole\n
 191 schema=SchemaMasterRole\n
 192 pdc=PdcEmulationMasterRole\n
 193 naming=DomainNamingMasterRole\n
 194 infrastructure=InfrastructureMasterRole\n
 195 all=all of the above"""),
 196         ]
 197
 198     takes_args = []
 199
 200     def transfer_role(self, role, samdb):
 201         m = ldb.Message()
 202         m.dn = ldb.Dn(samdb, "")
 203         if role == "rid":
 204             m["becomeRidMaster"]= ldb.MessageElement(
 205                 "1", ldb.FLAG_MOD_REPLACE,
 206                 "becomeRidMaster")
 207         elif role == "pdc":
 208             domain_dn = samdb.domain_dn()
 209             res = samdb.search(domain_dn,
 210                                scope=ldb.SCOPE_BASE, attrs=["objectSid"])
 211             assert len(res) == 1
 212             sid = res[0]["objectSid"][0]
 213             m["becomePdc"]= ldb.MessageElement(
 214                 sid, ldb.FLAG_MOD_REPLACE,
 215                 "becomePdc")
 216         elif role == "naming":
 217             m["becomeDomainMaster"]= ldb.MessageElement(
 218                 "1", ldb.FLAG_MOD_REPLACE,
 219                 "becomeDomainMaster")
 220             samdb.modify(m)
 221         elif role == "infrastructure":
 222             m["becomeInfrastructureMaster"]= ldb.MessageElement(
 223                 "1", ldb.FLAG_MOD_REPLACE,
 224                 "becomeInfrastructureMaster")
 225         elif role == "schema":
 226             m["becomeSchemaMaster"]= ldb.MessageElement(
 227                 "1", ldb.FLAG_MOD_REPLACE,
 228                 "becomeSchemaMaster")
 229         else:
 230             raise CommandError("Invalid FSMO role.")
 231         try:
 232             samdb.modify(m)
 233         except LdbError, (num, msg):
 234             raise CommandError("Failed to initiate transfer of '%s' role: %s" % (role, msg))
 235         self.outf.write("FSMO transfer of '%s' role successful\n" % role)
 236
 237     def run(self, force=None, H=None, role=None,
 238             credopts=None, sambaopts=None, versionopts=None):
 239
 240         lp = sambaopts.get_loadparm()
 241         creds = credopts.get_credentials(lp, fallback_machine=True)
 242
 243         samdb = SamDB(url=H, session_info=system_session(),
 244                       credentials=creds, lp=lp)
 245
 246         if role == "all":
 247             self.transfer_role("rid", samdb)
 248             self.transfer_role("pdc", samdb)
 249             self.transfer_role("naming", samdb)
 250             self.transfer_role("infrastructure", samdb)
 251             self.transfer_role("schema", samdb)
 252         else:
 253             self.transfer_role(role, samdb)
 254
 255
 256 class cmd_fsmo(SuperCommand):
 257     """Flexible Single Master Operations (FSMO) roles management"""
 258
 259     subcommands = {}
 260     subcommands["seize"] = cmd_fsmo_seize()
 261     subcommands["show"] = cmd_fsmo_show()
 262     subcommands["transfer"] = cmd_fsmo_transfer()