| 1 | '\" t
|
|---|
| 2 | .\" Title: samba-tool
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 10/25/2016
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 4.4
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "SAMBA\-TOOL" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * Define some portability stuff
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 15 | .\" http://bugs.debian.org/507673
|
|---|
| 16 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|---|
| 17 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 18 | .ie \n(.g .ds Aq \(aq
|
|---|
| 19 | .el .ds Aq '
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .\" * set default formatting
|
|---|
| 22 | .\" -----------------------------------------------------------------
|
|---|
| 23 | .\" disable hyphenation
|
|---|
| 24 | .nh
|
|---|
| 25 | .\" disable justification (adjust text to left margin only)
|
|---|
| 26 | .ad l
|
|---|
| 27 | .\" -----------------------------------------------------------------
|
|---|
| 28 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 29 | .\" -----------------------------------------------------------------
|
|---|
| 30 | .SH "NAME"
|
|---|
| 31 | samba-tool \- Main Samba administration tool\&.
|
|---|
| 32 | .SH "SYNOPSIS"
|
|---|
| 33 | .HP \w'\ 'u
|
|---|
| 34 | samba\-tool [\-h] [\-W\ myworkgroup] [\-U\ user] [\-d\ debuglevel] [\-\-v]
|
|---|
| 35 | .SH "DESCRIPTION"
|
|---|
| 36 | .PP
|
|---|
| 37 | This tool is part of the
|
|---|
| 38 | \fBsamba\fR(7)
|
|---|
| 39 | suite\&.
|
|---|
| 40 | .SH "OPTIONS"
|
|---|
| 41 | .PP
|
|---|
| 42 | \-h|\-\-help
|
|---|
| 43 | .RS 4
|
|---|
| 44 | Show this help message and exit
|
|---|
| 45 | .RE
|
|---|
| 46 | .PP
|
|---|
| 47 | \-\-realm=REALM
|
|---|
| 48 | .RS 4
|
|---|
| 49 | Set the realm name
|
|---|
| 50 | .RE
|
|---|
| 51 | .PP
|
|---|
| 52 | \-\-simple\-bind\-dn=DN
|
|---|
| 53 | .RS 4
|
|---|
| 54 | DN to use for a simple bind
|
|---|
| 55 | .RE
|
|---|
| 56 | .PP
|
|---|
| 57 | \-\-password=PASSWORD
|
|---|
| 58 | .RS 4
|
|---|
| 59 | Password
|
|---|
| 60 | .RE
|
|---|
| 61 | .PP
|
|---|
| 62 | \-U USERNAME|\-\-username=USERNAME
|
|---|
| 63 | .RS 4
|
|---|
| 64 | Username
|
|---|
| 65 | .RE
|
|---|
| 66 | .PP
|
|---|
| 67 | \-W WORKGROUP|\-\-workgroup=WORKGROUP
|
|---|
| 68 | .RS 4
|
|---|
| 69 | Workgroup
|
|---|
| 70 | .RE
|
|---|
| 71 | .PP
|
|---|
| 72 | \-N|\-\-no\-pass
|
|---|
| 73 | .RS 4
|
|---|
| 74 | Don\*(Aqt ask for a password
|
|---|
| 75 | .RE
|
|---|
| 76 | .PP
|
|---|
| 77 | \-k KERBEROS|\-\-kerberos=KERBEROS
|
|---|
| 78 | .RS 4
|
|---|
| 79 | Use Kerberos
|
|---|
| 80 | .RE
|
|---|
| 81 | .PP
|
|---|
| 82 | \-\-ipaddress=IPADDRESS
|
|---|
| 83 | .RS 4
|
|---|
| 84 | IP address of the server
|
|---|
| 85 | .RE
|
|---|
| 86 | .SH "COMMANDS"
|
|---|
| 87 | .SS "dbcheck"
|
|---|
| 88 | .PP
|
|---|
| 89 | Check the local AD database for errors\&.
|
|---|
| 90 | .SS "delegation"
|
|---|
| 91 | .PP
|
|---|
| 92 | Manage Delegations\&.
|
|---|
| 93 | .SS "delegation add-service accountname principal [options]"
|
|---|
| 94 | .PP
|
|---|
| 95 | Add a service principal as msDS\-AllowedToDelegateTo\&.
|
|---|
| 96 | .SS "delegation del-service accountname principal [options]"
|
|---|
| 97 | .PP
|
|---|
| 98 | Delete a service principal as msDS\-AllowedToDelegateTo\&.
|
|---|
| 99 | .SS "delegation for-any-protocol accountname [(on|off)] [options]"
|
|---|
| 100 | .PP
|
|---|
| 101 | Set/unset UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION (S4U2Proxy) for an account\&.
|
|---|
| 102 | .SS "delegation for-any-service accountname [(on|off)] [options]"
|
|---|
| 103 | .PP
|
|---|
| 104 | Set/unset UF_TRUSTED_FOR_DELEGATION for an account\&.
|
|---|
| 105 | .SS "delegation show accountname [options] "
|
|---|
| 106 | .PP
|
|---|
| 107 | Show the delegation setting of an account\&.
|
|---|
| 108 | .SS "dns"
|
|---|
| 109 | .PP
|
|---|
| 110 | Manage Domain Name Service (DNS)\&.
|
|---|
| 111 | .SS "dns add server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT data"
|
|---|
| 112 | .PP
|
|---|
| 113 | Add a DNS record\&.
|
|---|
| 114 | .SS "dns delete server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT data"
|
|---|
| 115 | .PP
|
|---|
| 116 | Delete a DNS record\&.
|
|---|
| 117 | .SS "dns query server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT|ALL [options] data"
|
|---|
| 118 | .PP
|
|---|
| 119 | Query a name\&.
|
|---|
| 120 | .SS "dns roothints server [name] [options]"
|
|---|
| 121 | .PP
|
|---|
| 122 | Query root hints\&.
|
|---|
| 123 | .SS "dns serverinfo server [options]"
|
|---|
| 124 | .PP
|
|---|
| 125 | Query server information\&.
|
|---|
| 126 | .SS "dns update server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT olddata newdata"
|
|---|
| 127 | .PP
|
|---|
| 128 | Update a DNS record\&.
|
|---|
| 129 | .SS "dns zonecreate server zone [options]"
|
|---|
| 130 | .PP
|
|---|
| 131 | Create a zone\&.
|
|---|
| 132 | .SS "dns zonedelete server zone [options]"
|
|---|
| 133 | .PP
|
|---|
| 134 | Delete a zone\&.
|
|---|
| 135 | .SS "dns zoneinfo server zone [options]"
|
|---|
| 136 | .PP
|
|---|
| 137 | Query zone information\&.
|
|---|
| 138 | .SS "dns zonelist server [options]"
|
|---|
| 139 | .PP
|
|---|
| 140 | List zones\&.
|
|---|
| 141 | .SS "domain"
|
|---|
| 142 | .PP
|
|---|
| 143 | Manage Domain\&.
|
|---|
| 144 | .SS "domain classicupgrade [options] classic_smb_conf"
|
|---|
| 145 | .PP
|
|---|
| 146 | Upgrade from Samba classic (NT4\-like) database to Samba AD DC database\&.
|
|---|
| 147 | .SS "domain dcpromo dnsdomain [DC|RODC] [options]"
|
|---|
| 148 | .PP
|
|---|
| 149 | Promote an existing domain member or NT4 PDC to an AD DC\&.
|
|---|
| 150 | .SS "domain demote"
|
|---|
| 151 | .PP
|
|---|
| 152 | Demote ourselves from the role of domain controller\&.
|
|---|
| 153 | .SS "domain exportkeytab keytab [options]"
|
|---|
| 154 | .PP
|
|---|
| 155 | Dumps Kerberos keys of the domain into a keytab\&.
|
|---|
| 156 | .SS "domain info ip_address [options]"
|
|---|
| 157 | .PP
|
|---|
| 158 | Print basic info about a domain and the specified DC\&.
|
|---|
| 159 | .SS "domain join dnsdomain [DC|RODC|MEMBER|SUBDOMAIN] [options]"
|
|---|
| 160 | .PP
|
|---|
| 161 | Join a domain as either member or backup domain controller\&.
|
|---|
| 162 | .SS "domain level show|raise options [options]"
|
|---|
| 163 | .PP
|
|---|
| 164 | Show/raise domain and forest function levels\&.
|
|---|
| 165 | .SS "domain passwordsettings show|set options [options]"
|
|---|
| 166 | .PP
|
|---|
| 167 | Show/set password settings\&.
|
|---|
| 168 | .SS "domain provision"
|
|---|
| 169 | .PP
|
|---|
| 170 | Promote an existing domain member or NT4 PDC to an AD DC\&.
|
|---|
| 171 | .SS "domain trust"
|
|---|
| 172 | .PP
|
|---|
| 173 | Domain and forest trust management\&.
|
|---|
| 174 | .SS "domain trust create DOMAIN options [options]"
|
|---|
| 175 | .PP
|
|---|
| 176 | Create a domain or forest trust\&.
|
|---|
| 177 | .SS "domain trust delete DOMAIN options [options]"
|
|---|
| 178 | .PP
|
|---|
| 179 | Delete a domain trust\&.
|
|---|
| 180 | .SS "domain trust list options [options]"
|
|---|
| 181 | .PP
|
|---|
| 182 | List domain trusts\&.
|
|---|
| 183 | .SS "domain trust namespaces [DOMAIN] options [options]"
|
|---|
| 184 | .PP
|
|---|
| 185 | Manage forest trust namespaces\&.
|
|---|
| 186 | .SS "domain trust show DOMAIN options [options]"
|
|---|
| 187 | .PP
|
|---|
| 188 | Show trusted domain details\&.
|
|---|
| 189 | .SS "domain trust validate DOMAIN options [options]"
|
|---|
| 190 | .PP
|
|---|
| 191 | Validate a domain trust\&.
|
|---|
| 192 | .SS "drs"
|
|---|
| 193 | .PP
|
|---|
| 194 | Manage Directory Replication Services (DRS)\&.
|
|---|
| 195 | .SS "drs bind"
|
|---|
| 196 | .PP
|
|---|
| 197 | Show DRS capabilities of a server\&.
|
|---|
| 198 | .SS "drs kcc"
|
|---|
| 199 | .PP
|
|---|
| 200 | Trigger knowledge consistency center run\&.
|
|---|
| 201 | .SS "drs options"
|
|---|
| 202 | .PP
|
|---|
| 203 | Query or change
|
|---|
| 204 | \fIoptions\fR
|
|---|
| 205 | for NTDS Settings object of a domain controller\&.
|
|---|
| 206 | .SS "drs replicate destination_DC source_DC NC [options]"
|
|---|
| 207 | .PP
|
|---|
| 208 | Replicate a naming context between two DCs\&.
|
|---|
| 209 | .SS "drs showrepl"
|
|---|
| 210 | .PP
|
|---|
| 211 | Show replication status\&.
|
|---|
| 212 | .SS "dsacl"
|
|---|
| 213 | .PP
|
|---|
| 214 | Administer DS ACLs
|
|---|
| 215 | .SS "dsacl set"
|
|---|
| 216 | .PP
|
|---|
| 217 | Modify access list on a directory object\&.
|
|---|
| 218 | .SS "fsmo"
|
|---|
| 219 | .PP
|
|---|
| 220 | Manage Flexible Single Master Operations (FSMO)\&.
|
|---|
| 221 | .SS "fsmo seize [options]"
|
|---|
| 222 | .PP
|
|---|
| 223 | Seize the role\&.
|
|---|
| 224 | .SS "fsmo show"
|
|---|
| 225 | .PP
|
|---|
| 226 | Show the roles\&.
|
|---|
| 227 | .SS "fsmo transfer [options]"
|
|---|
| 228 | .PP
|
|---|
| 229 | Transfer the role\&.
|
|---|
| 230 | .SS "gpo"
|
|---|
| 231 | .PP
|
|---|
| 232 | Manage Group Policy Objects (GPO)\&.
|
|---|
| 233 | .SS "gpo create displayname [options]"
|
|---|
| 234 | .PP
|
|---|
| 235 | Create an empty GPO\&.
|
|---|
| 236 | .SS "gpo del gpo [options]"
|
|---|
| 237 | .PP
|
|---|
| 238 | Delete GPO\&.
|
|---|
| 239 | .SS "gpo dellink container_dn gpo [options]"
|
|---|
| 240 | .PP
|
|---|
| 241 | Delete GPO link from a container\&.
|
|---|
| 242 | .SS "gpo fetch gpo [options]"
|
|---|
| 243 | .PP
|
|---|
| 244 | Download a GPO\&.
|
|---|
| 245 | .SS "gpo getinheritance container_dn [options]"
|
|---|
| 246 | .PP
|
|---|
| 247 | Get inheritance flag for a container\&.
|
|---|
| 248 | .SS "gpo getlink container_dn [options]"
|
|---|
| 249 | .PP
|
|---|
| 250 | List GPO Links for a container\&.
|
|---|
| 251 | .SS "gpo list username [options]"
|
|---|
| 252 | .PP
|
|---|
| 253 | List GPOs for an account\&.
|
|---|
| 254 | .SS "gpo listall"
|
|---|
| 255 | .PP
|
|---|
| 256 | List all GPOs\&.
|
|---|
| 257 | .SS "gpo listcontainers gpo [options]"
|
|---|
| 258 | .PP
|
|---|
| 259 | List all linked containers for a GPO\&.
|
|---|
| 260 | .SS "gpo setinheritance container_dn block|inherit [options]"
|
|---|
| 261 | .PP
|
|---|
| 262 | Set inheritance flag on a container\&.
|
|---|
| 263 | .SS "gpo setlink container_dn gpo [options]"
|
|---|
| 264 | .PP
|
|---|
| 265 | Add or Update a GPO link to a container\&.
|
|---|
| 266 | .SS "gpo show gpo [options]"
|
|---|
| 267 | .PP
|
|---|
| 268 | Show information for a GPO\&.
|
|---|
| 269 | .SS "group"
|
|---|
| 270 | .PP
|
|---|
| 271 | Manage groups\&.
|
|---|
| 272 | .SS "group add groupname [options]"
|
|---|
| 273 | .PP
|
|---|
| 274 | Create a new AD group\&.
|
|---|
| 275 | .SS "group addmembers groupname members [options]"
|
|---|
| 276 | .PP
|
|---|
| 277 | Add members to an AD group\&.
|
|---|
| 278 | .SS "group delete groupname [options]"
|
|---|
| 279 | .PP
|
|---|
| 280 | Delete an AD group\&.
|
|---|
| 281 | .SS "group list"
|
|---|
| 282 | .PP
|
|---|
| 283 | List all groups\&.
|
|---|
| 284 | .SS "group listmembers groupname [options]"
|
|---|
| 285 | .PP
|
|---|
| 286 | List all members of the specified AD group\&.
|
|---|
| 287 | .SS "group removemembers groupname members [options]"
|
|---|
| 288 | .PP
|
|---|
| 289 | Remove members from the specified AD group\&.
|
|---|
| 290 | .SS "ldapcmp \fIURL1\fR \fIURL2\fR \fIdomain|configuration|schema|dnsdomain|dnsforest\fR [options]"
|
|---|
| 291 | .PP
|
|---|
| 292 | Compare two LDAP databases\&.
|
|---|
| 293 | .SS "ntacl"
|
|---|
| 294 | .PP
|
|---|
| 295 | Manage NT ACLs\&.
|
|---|
| 296 | .SS "ntacl get file [options]"
|
|---|
| 297 | .PP
|
|---|
| 298 | Get ACLs on a file\&.
|
|---|
| 299 | .SS "ntacl set acl file [options]"
|
|---|
| 300 | .PP
|
|---|
| 301 | Set ACLs on a file\&.
|
|---|
| 302 | .SS "ntacl sysvolcheck"
|
|---|
| 303 | .PP
|
|---|
| 304 | Check sysvol ACLs match defaults (including correct ACLs on GPOs)\&.
|
|---|
| 305 | .SS "ntacl sysvolreset"
|
|---|
| 306 | .PP
|
|---|
| 307 | Reset sysvol ACLs to defaults (including correct ACLs on GPOs)\&.
|
|---|
| 308 | .SS "rodc"
|
|---|
| 309 | .PP
|
|---|
| 310 | Manage Read\-Only Domain Controller (RODC)\&.
|
|---|
| 311 | .SS "rodc preload SID|DN|accountname [options]"
|
|---|
| 312 | .PP
|
|---|
| 313 | Preload one account for an RODC\&.
|
|---|
| 314 | .SS "sites"
|
|---|
| 315 | .PP
|
|---|
| 316 | Manage sites\&.
|
|---|
| 317 | .SS "sites create site [options]"
|
|---|
| 318 | .PP
|
|---|
| 319 | Create a new site\&.
|
|---|
| 320 | .SS "sites remove site [options]"
|
|---|
| 321 | .PP
|
|---|
| 322 | Delete an existing site\&.
|
|---|
| 323 | .SS "spn"
|
|---|
| 324 | .PP
|
|---|
| 325 | Manage Service Principal Names (SPN)\&.
|
|---|
| 326 | .SS "spn add name user [options]"
|
|---|
| 327 | .PP
|
|---|
| 328 | Create a new SPN\&.
|
|---|
| 329 | .SS "spn delete name [user] [options]"
|
|---|
| 330 | .PP
|
|---|
| 331 | Delete an existing SPN\&.
|
|---|
| 332 | .SS "spn list user [options]"
|
|---|
| 333 | .PP
|
|---|
| 334 | List SPNs of a given user\&.
|
|---|
| 335 | .SS "testparm"
|
|---|
| 336 | .PP
|
|---|
| 337 | Check the syntax of the configuration file\&.
|
|---|
| 338 | .SS "time"
|
|---|
| 339 | .PP
|
|---|
| 340 | Retrieve the time on a server\&.
|
|---|
| 341 | .SS "user"
|
|---|
| 342 | .PP
|
|---|
| 343 | Manage users\&.
|
|---|
| 344 | .SS "user add username [password]"
|
|---|
| 345 | .PP
|
|---|
| 346 | Create a new user\&. Please note that this subcommand is deprecated and available for compatibility reasons only\&. Please use
|
|---|
| 347 | samba\-tool user create
|
|---|
| 348 | instead\&.
|
|---|
| 349 | .SS "user create username [password]"
|
|---|
| 350 | .PP
|
|---|
| 351 | Create a new user in the Active Directory Domain\&.
|
|---|
| 352 | .SS "user delete username [options]"
|
|---|
| 353 | .PP
|
|---|
| 354 | Delete an existing user account\&.
|
|---|
| 355 | .SS "user disable username"
|
|---|
| 356 | .PP
|
|---|
| 357 | Disable an user account\&.
|
|---|
| 358 | .SS "user enable username"
|
|---|
| 359 | .PP
|
|---|
| 360 | Enable an user account\&.
|
|---|
| 361 | .SS "user list"
|
|---|
| 362 | .PP
|
|---|
| 363 | List all users\&.
|
|---|
| 364 | .SS "user password [options]"
|
|---|
| 365 | .PP
|
|---|
| 366 | Change password for an user account (the one provided in authentication)\&.
|
|---|
| 367 | .SS "user setexpiry username [options]"
|
|---|
| 368 | .PP
|
|---|
| 369 | Set the expiration of an user account\&.
|
|---|
| 370 | .SS "user setpassword username [options]"
|
|---|
| 371 | .PP
|
|---|
| 372 | Sets or resets the password of an user account\&.
|
|---|
| 373 | .SS "vampire [options] \fIdomain\fR"
|
|---|
| 374 | .PP
|
|---|
| 375 | Join and synchronise a remote AD domain to the local server\&. Please note that
|
|---|
| 376 | samba\-tool vampire
|
|---|
| 377 | is deprecated, please use
|
|---|
| 378 | samba\-tool domain join
|
|---|
| 379 | instead\&.
|
|---|
| 380 | .SS "help"
|
|---|
| 381 | .PP
|
|---|
| 382 | Gives usage information\&.
|
|---|
| 383 | .SH "VERSION"
|
|---|
| 384 | .PP
|
|---|
| 385 | This man page is complete for version 4 of the Samba suite\&.
|
|---|
| 386 | .SH "AUTHOR"
|
|---|
| 387 | .PP
|
|---|
| 388 | The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
| 389 | .PP
|
|---|
| 390 | The samba\-tool manpage was written by Karolin Seeger\&.
|
|---|
