SAMBA-TOOL(8)
👑 SAMBA-TOOL — System Administration tools 👑
okay so hi bestie 💖 you have found the manual page for samba-tool, section 8, System Administration tools. Yes the header line says SAMBA-TOOL(8) up top and "System Administration tools" on the right, that's just how man pages dress themselves, it's their whole thing. ✨
This is THE main Samba administration tool. Sit down, grab a strawberry 🍓, we're gonna go through every single flag together, no skimming, no skipping, periodt.
✨ NAME ✨
samba-tool — Main Samba administration tool. 💅
That's it. That's the whole name section. Short, iconic, no notes.
🦋 SYNOPSIS 🦋
samba-tool [-h] [-W myworkgroup] [-U user] [-d debuglevel] [-V]look at her, so compact 😭 this is the tiny little shape of the tool before you go off and use one of the like a hundred sub-commands. Every sub-command has its own options btw, this is just the common ones riding up top.
🌸 DESCRIPTION 🌸
This tool is part of the samba(7) suite. 🫶
Translation for the besties: it's the admin tool that comes with Samba. If Samba is the whole vibe, samba-tool is the group chat where you actually get stuff done (creating users, computers, moving things around, the whole main-character arc 👑).
🎀 OPTIONS 🎀
okay so real talk: samba-tool is not one tool, it's a whole collection of sub-commands, and each sub-command has its own set of options. The ones listed in this section are the ones that are common across several sub-commands, so learn these once and you're basically set. 🦋
-h,--help— Show a help message and exit. That's it, that's the whole thing, free hand-holding bestie 💖-r REALM,--realm=REALM— Set the realm for the domain.
⚠️ Heads up: specifying this parameter here will override therealmparameter in the/etc/samba/smb.conffile. Your config file is not the boss of you right now, the command line is. 💅
--simple-bind-dn=DN— DN to use for a simple bind.--password— Specify the password on the commandline.
bestie, be cautious about this one. Be cautious about including passwords in scripts or passing user-supplied values onto the command line. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with kinit. 🔐
If --password is not specified, the tool will check the PASSWD environment variable, followed by PASSWD_FD, which is expected to contain an open file descriptor (FD) number.
Finally it will check PASSWD_FILE (containing a file path to be opened). The file should only contain the password. Make certain that the permissions on the file restrict access from unwanted users! 🙈
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race. (race = there's a tiny window where it could still be visible, so don't go thinking this is a security blanket.)
-U [DOMAIN\]USERNAME[%PASSWORD],--user=[DOMAIN\]USERNAME[%PASSWORD]— Sets the SMB username or username and password.
If %PASSWORD is not specified, the user will be prompted. The client will first check the USER environment variable (which is also permitted to also contain the password separated by a %), then the LOGNAME variable (which is not permitted to contain a password) and if either exists, the value is used. If these environmental variables are not found, the username found in a Kerberos Credentials cache may be used. ✨
A third option is to use a credentials file which contains the plaintext of the username and password. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions on the file restrict access from unwanted users. See the -A for more details. 📄
Be cautious about including passwords in scripts or passing user-supplied values onto the command line. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with kinit.
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race. 💀
-W WORKGROUP,--workgroup=WORKGROUP— Set the SMB domain of the username. This overrides the default domain which is the domain defined insmb.conf. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM).
⚠️ Note that specifying this parameter here will override theworkgroupparameter in the/etc/samba/smb.conffile. Yeah. Again. The command line simply does not care about your config file, and honestly? Respect. 💅
-N,--no-pass— If specified, this parameter suppresses the normal password prompt from the client to the user. This is useful when accessing a service that does not require a password. 🕊️
Unless a password is specified on the command line or this parameter is specified, the client will request a password.
If a password is specified on the command line and this option is also defined, the password on the command line will be silently ignored and no password will be used. (silently. no warning. it just moves on with its life 🙈)
--use-kerberos=desired|required|off— This parameter determines whether Samba client tools will try to authenticate using Kerberos. For Kerberos authentication you should use DNS names instead of IP addresses when connecting to a service. By default Samba client tools will try to use the default Kerberos credential cache (ccache). In case the ccache does not exist or-U|--useroption was specified, clients will ask to enter a password and will obtain a Kerberos ticket (kinit) for you. If you want to use an alternative Kerberos credentical cache, use the--use-krb5-ccacheoption. 🎟️
⚠️ Note that specifying this parameter here will override theclient use kerberosparameter in the/etc/samba/smb.conffile.
--use-krb5-ccache=CCACHE— Specifies the credential cache location for Kerberos authentication.
This will enforce --use-kerberos=required. 🔥
-A filename,--authentication-file=filename— This option allows you to specify a file from which to read the username and password used in the connection. The format of the file is:
username = <value>
password = <value>
domain = <value>Make certain that the permissions on the file restrict access from unwanted users! 🙈🔒
-H URL,--URL=URL— LDB URL for database or target server.
The URL can either be a plain file path, or use one of the schemes listed here. If a plain path is used, it is treated as if tdb:// was used.
tdb://PATH—PATHis the location of a TDB database.mdb://PATH—PATHis the location of an LMDB database.ldb://PATH—PATHis the location of an LDB database, in either LMDB or TDB format. The formats will be tried one after another until one succeeds or all fail. It is safe to use this if you don't know the format of the file. 🦋ldap://HOSTNAME,ldaps://HOSTNAME— The LDB backend is the named ldap server.ldaps://wraps the connection in TLS. 🔐ldapi://SOCKET— The backend server is a local ldap server using a unix domain socket.
--color=always|never|auto— use colour if available (default:auto).
yes this one shows up twice in the original man page, we don't make the rules, we just report them faithfully 🙈 The fuller version right below says:
--color=always|never|auto— Indicate whethersamba-toolshould use ANSI colour codes in its output. Ifauto(the default),samba-toolwill use colour when its output is directed toward a terminal, unless theNO_COLORenvironment variable is set and non-empty. 🌈
The values yes and force are accepted as synonyms for always; no and none for never; and tty and if-tty for auto.
Note that asking for colour doesn't mean samba-tool will necessarily be very colourful. Many commands are very monochrome, particularly when successful. 💀 she said "I have a colour palette" and then wore greyscale to the function. iconic honestly.
--ipaddress=IPADDRESS— IP address of the server.-s FILE,--configfile=FILE— Use thissmb.confconfiguration file. 📂-V,--version— Display the version number and exit.-d level,--debuglevel=level—levelis an integer from0to10. The default value if this parameter is not specified is1for client applications.
The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running — it generates a small amount of information about operations carried out.
Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. 😭
⚠️ Note that specifying this parameter here will override thelog levelparameter in the/etc/samba/smb.conffile.
--debug-stdout— This will redirect debug output to STDOUT. By default all clients are logging to STDERR. ↩️
🎀 COMMANDS 🎀
okay so here's the fun part — the actual things you can do. Buckle up bestie, this list is long and we are going through all of it. 🧚
computer
Manage computer accounts. 💻
computer add computername [options]
Add a new computer to the Active Directory Domain. 🎉
The new computer name specified on the command is the sAMAccountName, with or without the trailing dollar sign. (yes the $ is optional, she's flexible like that)
--computerou=COMPUTEROU— DN of alternative location (with or withoutdomainDNcounterpart) to defaultCN=Computersin which new computer object will be created. E.g.'OU=OUname'.--description=DESCRIPTION— The new computer's description.--ip-address=IP_ADDRESS_LIST— IPv4 address for the computer's A record, or IPv6 address for AAAA record, can be provided multiple times. 🔁--service-principal-name=SERVICE_PRINCIPAL_NAME_LIST— Computer's Service Principal Name, can be provided multiple times. 🔁--prepare-oldjoin— Prepare enabled machine account for oldjoin mechanism.
computer create computername [options]
Add a new computer. This is a synonym for the samba-tool computer add command and is available for compatibility reasons only. Please use samba-tool computer add instead. 🫶
aka: legacy bestie, still invited to the party, but the cool kids use add.
computer delete computername [options]
Delete an existing computer account. 💀
The computer name specified on the command is the sAMAccountName, with or without the trailing dollar sign.
computer edit computername
Edit a computer AD object. ✏️
The computer name specified on the command is the sAMAccountName, with or without the trailing dollar sign.
--editor=EDITOR— Specifies the editor to use instead of the system default, orviif no system default is set.
computer list
List all computers. 📋
computer move computername new_parent_dn [options]
This command moves a computer account into the specified organizational unit or container. 📦
The computername specified on the command is the sAMAccountName, with or without the trailing dollar sign.
The name of the organizational unit or container can be specified as a full DN or without the domainDN component.
computer show computername [options]
Display a computer AD object. 👀
The computer name specified on the command is the sAMAccountName, with or without the trailing dollar sign.
--attributes=USER_ATTRS— Comma separated list of attributes, which will be printed.
computer keytrust
Manage Key Credential Links for a computer. 🔑
This can populate, describe or delete msDS-KeyCredentialLink attributes.
computer keytrust add computername public-key-or-certificate [options]
Add a key-credential-link, which is a linked attribute that holds a public key in a binary field. 🔐
and that's where part one leaves us bestie, more coming — don't go anywhere 💖
The second argument is a filename, and it's gotta point at a 2048 bit RSA key (or a certificate carrying that key around like an emotional support item) in PEM or DER format. Default vibe: we auto-detect the encoding format for you, but you can try to override that with the --encoding option. Other types of public key? Not supported, bestie, sorry. Though the --force option exists if you wanna add a non-2048 bit key anyway. 💅
--link-target=DN— link to this DN (default: the computer's DN)--encoding=ENCODING— key format, eitherpem,der, orauto. Default isauto, which is lowkey gonna detect the correct format in all circumstances. ✨--force— proceed with operations that seem ill-fated 💀
💅 computer keytrust delete computername [options]
Delete a key-credential-link.
Okay so you can pick which link to delete in a few different ways. --all deletes all key credential links for the computer (and ngl, often there'll only be one anyway). --link-target selects a link based on the DN targeted by that link. --fingerprint selects a link based on the key fingerprint — and that's the SHA256 of the DER-encoded key material, written out as hex-pairs separated by colons. Peep computer keytrust view if you want a list of links plus their fingerprints. 👀
If you use more than one of --link-target, --fingerprint, and --all at the same time, then links matched by any of them will be deleted. Periodt.
The --dry-run option stops links from being deleted and instead shows you what would happen if you left it out.
--link-target=DN— delete this key credential link (a DN)--fingerprint=HH:HH:..— delete the key credential link with this key fingerprint--all— delete all key credential links-n,--dry-run— do nothing but print what would happen
🦋 computer keytrust view computername [options]
View a computer's key credential links. This is how you find a link's fingerprint and target DN. The --verbose includes more, probably useless, information. 🙈
-h,--help— show this help message and exit-v,--verbose— be verbose
🎀 computer generate-csr computername
computer generate-csr computername
subject_name private_key_filename output_filename
[options]"Generate a PEM‑encoded Certificate Signing Request for a computer. 💖
--private-key-encoding— specify which encoding the private key uses. Default is'auto'.--private-key-pass— provide a password to decrypt the private key.
🌸 contact
Manage contacts.
💖 contact add [contactname] [options]
Add a new contact to the Active Directory Domain.
So the name of your new contact can come from the first argument 'contactname', or from the --given-name, --initial and --surname arguments. If you don't hand over a 'contactname', the contact's name gets built by smooshing together the given-name, initials and surname. Every single one of those arguments is optional. And a dot ('.') gets appended to the initials automatically. slay. ✨
--ou=OU— DN of alternative location (with or without domainDN counterpart) in which the new contact will be created. E.g.'OU=OUname'. Default is the domain base.--description=DESCRIPTION— the new contact's description.--surname=SURNAME— contact's surname.--given-name=GIVEN_NAME— contact's given name.--initials=INITIALS— contact's initials.--display-name=DISPLAY_NAME— contact's display name.--job-title=JOB_TITLE— contact's job title.--department=DEPARTMENT— contact's department.--company=COMPANY— contact's company.--mail-address=MAIL_ADDRESS— contact's email address.--internet-address=INTERNET_ADDRESS— contact's home page.--telephone-number=TELEPHONE_NUMBER— contact's phone number.--mobile-number=MOBILE_NUMBER— contact's mobile phone number.--physical-delivery-office=PHYSICAL_DELIVERY_OFFICE— contact's office location.
🌈 contact create [contactname] [options]
Add a new contact. This is literally just a synonym for the samba-tool contact add command and it only exists for compatibility reasons. Please use samba-tool contact add instead, bestie. 🫶
💜 contact delete contactname [options]
Delete an existing contact.
The contactname you pass on the command is the common name or the distinguished name of the contact object. And that distinguished name can be given with or without the domainDN component. 👍
⭐ contact edit contactname
Modify a contact AD object.
The contactname you pass on the command is the common name or the distinguished name of the contact object, and again that DN can come with or without the domainDN component.
--editor=EDITOR— specifies the editor to use instead of the system default, or'vi'if no system default is set.
🍓 contact list [options]
List all contacts.
--full-dn— display contact's full DN instead of the name.
🧚 contact move contactname new_parent_dn [options]
This command moves a contact into the specified organizational unit or container. 📦
The contactname you pass on the command is the common name or the distinguished name of the contact object, and the DN can be given with or without the domainDN component.
💫 contact show contactname [options]
Display a contact AD object.
The contactname you pass on the command is the common name or the distinguished name of the contact object — with or without the domainDN component, your call.
--attributes=CONTACT_ATTRS— comma separated list of attributes, which will be printed.
👑 contact rename contactname [options]
Rename a contact and related attributes.
This one lets you set the contact's name related attributes. The contact's CN gets renamed automatically, and the new CN is made up by combining the given-name, initials and surname. A dot ('.') gets appended to the initials automatically, if required. Wanna specify the new CN yourself? Use the --force-new-cn option. Wanna undo it? --reset-cn. no cap. 💅
Use an empty attribute value to remove the specified attribute.
The contact name specified on the command is the CN.
--surname=SURNAME— new surname.--given-name=GIVEN_NAME— new given name.--initials=INITIALS— new initials.--force-new-cn=NEW_CN— specify a new CN (RDN) instead of using a combination of the given name, initials and surname.--reset-cn— set the CN to the default combination of given name, initials and surname.--display-name=DISPLAY_NAME— new display name.--mail-address=MAIL_ADDRESS— new email address.
🔍 dbcheck
Check the local AD database for errors. very giving "let me just double check that real quick". 🔎
🎀 delegation
Manage Delegations.
✨ delegation add-principal accountname principal [options]
Add a principal to msDS-AllowedToActOnBehalfOfOtherIdentity that may delegate to an account.
🦋 delegation del-principal accountname principal [options]
Delete a principal from msDS-AllowedToActOnBehalfOfOtherIdentity so that it may no longer delegate to an account.
💖 delegation add-service accountname principal [options]
Add a service principal as msDS-AllowedToDelegateTo.
🌸 delegation del-service accountname principal [options]
Delete a service principal as msDS-AllowedToDelegateTo.
💜 delegation for-any-protocol accountname [(on|off)] [options]
Set/unset UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION (S4U2Proxy) for an account.
⭐ delegation for-any-service accountname [(on|off)] [options]
Set/unset UF_TRUSTED_FOR_DELEGATION for an account.
🍓 delegation show accountname [options]
Show the delegation setting of an account.
🌈 dns
Manage Domain Name Service (DNS).
💅 dns add server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT data
Add a DNS record.
--allow-existing— do not treat an existing record of this name and type as an error. This has no functional change (the new DNS record is not added) but the message andsamba-toolreturn code will not indicate error. 😌
🧚 dns cleanup server name
Clean up DNS records for a host, so that DNS queries no longer return results. Usually this works by marking the records as deleted in the database.
Example: samba-tool dns cleanup dc1 computer.samdom.test.site
💫 dns delete server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT data
Delete a DNS record.
👑 dns query server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT|ALL [options] data
Query a name.
🔥 dns roothints server [name] [options]
Query root hints.
⭐ dns serverinfo server [options]
Query server information.
🎀 dns update server zone name A|AAAA|PTR|CNAME|NS|MX|SRV|TXT olddata newdata
Update a DNS record.
🦋 dns zonecreate server zone [options]
Create a zone.
💜 dns zonedelete server zone [options]
Delete a zone.
🌸 dns zoneinfo server zone [options]
Query zone information.
🍓 dns zonelist server [options]
List zones.
✨ dns zoneoptions server zone [options]
Manipulate aging options. This is useful in zones using dynamic DNS.
There are options to change records from static to dynamic based on regular expressions or age, which is useful in some cases where the values got mixed up in old versions of Samba. 😭
-n,--dry-run— do not actually change anything, but show what would happen.--client-version=w2k|dotnet|longhorn— Windows client protocol version. The default islonghorn, which is probably what you want.--mark-old-records-static=YYYY-MM-DD— mark records older than the specified date as static.--mark-records-static-regex=REGEXP— mark records that match the given perl-compatible regular expression as static.--mark-records-dynamic-regex=REGEXP— mark records that match the given perl-compatible regular expression as dynamic.--aging=0|1—--aging=1to enable aging for this zone.--aging=0to disable aging for this zone.--norefreshinterval=HOURS— avoid further refreshes for this long after a dynamic update. Set to zero to use the default.--refreshinterval=HOURS— dynamic refresh interval in hours (0: use default)
👑
👑 domain
Manage Domain.
💖 domain backup
Create or restore a backup of the domain.
🌈 domain backup offline
Backup (with proper locking) local domain directories into a tar file.
🦋 domain backup online
Copy a running DC's current DB into a backup tar file.
💜 domain backup rename
Copy a running DC's DB to backup file, renaming the domain in the process.
⭐ domain backup restore
Restore the domain's DB from a backup-file.
🎀 domain auth policy
Manage authentication policies.
✨ domain auth policy list
List authentication policies on the domain.
-H,--URL— LDB URL for database or target server.--json— view authentication policies as JSON instead of a list.
domain auth policy view 👀
Wanna peek at an authentication policy that lives on the domain? This is the vibe. ✨
-H,--URL— the LDB URL for the database or the target server. that's your "where am I even looking" knob 🗺️--name— the name of the authentication policy you wanna view. required, bestie, no name no view 🙅♀️
domain auth policy create 🎀
Okay so you wanna make authentication policies on the domain. So much power, use it wisely. 👑
-H,--URL— LDB URL for the database or the target server 🌸--name— name of the authentication policy (required) ✨--description— an optional lil description for the authentication policy 💬--protect— protect the authentication policy from accidental deletion 🛡️
cannot be used together with --unprotect. pick a lane.
--unprotect— unprotect the authentication policy from accidental deletion 🫣
cannot be used together with --protect. also pick a lane.
--audit— only audit the authentication policy, don't enforce 👀
cannot be used together with --enforce.
--enforce— enforce the authentication policy, no more just-watching 😤
cannot be used together with --audit.
--strong-ntlm-policy— Strong NTLM Policy. the values areDisabled,Optional,Required💪--user-tgt-lifetime-mins— Ticket-Granting-Ticket lifetime for user accounts 🎫--user-allow-ntlm-auth— allow NTLM and Interactive NETLOGON SamLogon authentication despite the fact that allowed-to-authenticate-from is in use, which would otherwise restrict the user to selected devices 🔓--user-allowed-to-authenticate-from— the conditions a device must meet for users covered by this policy to be allowed to authenticate. While this is a restriction on the device, any conditional ACE rules are expressed as if the device was a user. 💅
must be a valid SDDL string without reference to Device keywords. example: O:SYG:SYD:(XA;OICI;CR;;;WD;(Member_of {SID(AU)}))
--user-allowed-to-authenticate-to=SDDL— this policy, applying to a user account that is offering a service, eg a web server with a user account, restricts which accounts may access it. 🌐
must be a valid SDDL string. The SDDL can reference both bare (user) and Device conditions. SDDL example: O:SYG:SYD:(XA;OICI;CR;;;WD;(Member_of {SID(AO)}))
--service-tgt-lifetime-mins— Ticket-Granting-Ticket lifetime for service accounts 🎟️--service-allow-ntlm-auth— allow NTLM network authentication when the service is restricted to selected devices 🔑--service-allowed-to-authenticate-from— the conditions a device must meet for service accounts covered by this policy to be allowed to authenticate. While this is a restriction on the device, any conditional ACE rules are expressed as if the device was a user. 🧚
must be a valid SDDL string without reference to Device keywords. SDDL example: O:SYG:SYD:(XA;OICI;CR;;;WD;(Member_of {SID(AU)}))
--service-allowed-to-authenticate-to=SDDL— this policy, applying to a service account (eg a Managed Service Account, Group Managed Service Account), restricts which accounts may access it. 🖥️
must be a valid SDDL string. The SDDL can reference both bare (user) and Device conditions. SDDL example: O:SYG:SYD:(XA;OICI;CR;;;WD;(Member_of {SID(AO)}))
--computer-tgt-lifetime-mins— Ticket-Granting-Ticket lifetime for computer accounts 💻--computer-allowed-to-authenticate-to=SDDL— this policy, applying to a computer account (eg a server or workstation), restricts which accounts may access it. 🗄️
must be a valid SDDL string. The SDDL can reference both bare (user) and Device conditions. SDDL example: O:SYG:SYD:(XA;OICI;CR;;;WD;(Member_of {SID(AO)}))
domain auth policy modify 🔧
Modify authentication policies on the domain, glow-up edition. The same options apply as for domain auth policy create — yes, all of them, we're not retyping the whole list, go scroll up bestie 😌
domain auth policy delete 💀
Delete authentication policies on the domain. gone, reduced to atoms.
-H,--URL— LDB URL for the database or the target server 🌸--name— name of the authentication policy to delete (required) 🗑️--force— force the authentication policy delete even if it is protected 😈 it's giving "I said what I said"
domain auth policy user-allowed-to-authenticate-from set 🦋
Set the user-allowed-to-authenticate-from property by scenario. scenario-mode, no raw SDDL required ✨
-H,--URL— LDB URL for the database or the target server 🌈--name— name of the authentication policy 🏷️--by-group=GROUP— the user is allowed to authenticate if the device they authenticate from is assigned and granted membership of a given GROUP 👥--silo=SILO— the user is allowed to authenticate if the device they authenticate from is assigned and granted membership of a given SILO 🏛️
domain auth policy user-allowed-to-authenticate-to set 🌸
Set the user-allowed-to-authenticate-to property by scenario. 💫
-H,--URL— LDB URL for the database or the target server 🗺️--name— name of the authentication policy 🏷️--group=GROUP— the user account, offering a network service, covered by this policy, will only be allowed access from other accounts that are members of the given GROUP 👥--silo=SILO— the user account, offering a network service, covered by this policy, will only be allowed access from other accounts that are assigned to, granted membership of (and meet any authentication conditions of) the given SILO 🏛️
domain auth policy service-allowed-to-authenticate-from set 🖥️
Set the service-allowed-to-authenticate-from property by scenario. 🎀
-H,--URL— LDB URL for the database or the target server 🌸--name— name of the authentication policy 🏷️--group=GROUP— the service account (eg a Managed Service Account, Group Managed Service Account) is allowed to authenticate if the device it authenticates from is a member of the given GROUP 👥--silo=SILO— the service account (eg a Managed Service Account, Group Managed Service Account) is allowed to authenticate if the device it authenticates from is assigned and granted membership of a given SILO 🏛️
domain auth policy service-allowed-to-authenticate-to set 🧚
Set the service-allowed-to-authenticate-to property by scenario. 💅
-H,--URL— LDB URL for the database or the target server 🌈--name— name of the authentication policy 🏷️--group=GROUP— the service account (eg a Managed Service Account, Group Managed Service Account) will only be allowed access by other accounts that are members of the given GROUP 👥--silo=SILO— the service account (eg a Managed Service Account, Group Managed Service Account) will only be allowed access by other accounts that are assigned to, granted membership of (and meet any authentication conditions of) the given SILO 🏛️
domain auth policy computer-allowed-to-authenticate-to set 💻
Set the computer-allowed-to-authenticate-to property by scenario. ✨
-H,--URL— LDB URL for the database or the target server 🗺️--name— name of the authentication policy 🏷️--group=GROUP— the computer account (eg a server or workstation) will only be allowed access by other accounts that are members of the given GROUP 👥--silo=SILO— the computer account (eg a server or workstation) will only be allowed access by other accounts that are assigned to, granted membership of (and meet any authentication conditions of) the given SILO 🏛️
domain auth silo 🏛️
Manage authentication silos. the silo era has begun, no cap.
domain auth silo list 📜
List authentication silos on the domain.
-H,--URL— LDB URL for the database or the target server 🌸--json— view authentication silos as JSON instead of a list 🧾 (for the machine besties)
domain auth silo view 👀
View an authentication silo on the domain.
-H,--URL— LDB URL for the database or the target server 🌈--name— name of the authentication silo to view (required) 🙅♀️
domain auth silo create 🎀
Create authentication silos on the domain. manifesting silos ✨
-H,--URL— LDB URL for the database or the target server 🌸--name— name of the authentication silo (required) ✨--description— an optional description for the authentication silo 💬--user-authentication-policy— user account authentication policy 👤--service-authentication-policy— managed service account authentication policy 🖥️--computer-authentication-policy— computer authentication policy 💻--protect— protect the authentication silo from accidental deletion 🛡️
cannot be used together with --unprotect.
--unprotect— unprotect the authentication silo from accidental deletion 🫣
cannot be used together with --protect.
--audit— only audit silo policies 👀
cannot be used together with --enforce.
--enforce— enforce silo policies 😤
cannot be used together with --audit.
domain auth silo modify 🔧
Modify authentication silos on the domain. same energy, new settings.
-H,--URL— LDB URL for the database or the target server 🌈--name— name of the authentication silo (required) 🏷️--description— an optional description for the authentication silo 💬--user-authentication-policy— user account authentication policy 👤--service-authentication-policy— managed service account authentication policy 🖥️--computer-authentication-policy— computer authentication policy 💻--protect— protect the authentication silo from accidental deletion 🛡️
cannot be used together with --unprotect.
--unprotect— unprotect the authentication silo from accidental deletion 🫣
cannot be used together with --protect.
--audit— only audit silo policies 👀
cannot be used together with --enforce.
--enforce— enforce silo policies 😤
cannot be used together with --audit.
domain auth silo delete 💀
Delete authentication silos on the domain. rip bozo 🪦
-H,--URL— LDB URL for the database or the target server 🌸--name— name of the authentication silo to delete (required) 🗑️--force— force the authentication silo delete even if it is protected 😈
domain auth silo member grant 🎟️
Grant a member access to an authentication silo. come on in, the silo's lovely 🫶
-H,--URL— LDB URL for the database or the target server 🌈--name— name of the authentication silo (required) 🏛️--member— the member to grant access to the silo (DN or account name) 👥
domain auth silo member list 📜
List the members in an authentication silo. who's in the group chat 💬
-H,--URL— LDB URL for the database or the target server 🌸--name— name of the authentication silo (required) 🏛️--json— view members as JSON instead of a list 🧾
domain auth silo member revoke 🚪
Revoke a member from an authentication silo. it's not you it's the policy 💔
-H,--URL— LDB URL for the database or the target server 🌈--name— name of the authentication silo (required) 🏛️--member— the member to revoke from the silo (DN or account name) 👤
domain claim claim-type list 🗂️
List claim types on the domain. claims, but make it a list ✨
-H,--URL— LDB URL for the database or the target server 🌸--json— view claim types as JSON instead of a list 🧾
✨ domain claim claim-type view
Bestie this one is a lil peek-a-boo: it shows you one single claim type on the domain. Just the one. Very demure.
-H,--URL— the LDB URL for the database or the target server.--name— display name of the claim type you wanna view. It's required, no skipping 💅
🎀 domain claim claim-type create
Now we're making claim types on the domain. Main character behavior fr.
-H,--URL— LDB URL for the database or the target server.--attribute— the attribute of the claim type you're creating. Required bestie, don't forget it.--class— the object classes to set the claim type to.
Example: --class=user --class=computer
--name— optional display name, or it just uses the attribute name instead. Lazy but valid.--description— optional description, or it uses the one from the attribute.--enable— turn the claim type ON.
Can't be used together with --disable. Pick a lane, babe.
--disable— turn the claim type OFF.
Cannot be used together with --enable.
--protect— protect the claim type from accidental deletion. Bubble wrap for your config 🫶
Cannot be used together with --unprotect.
--unprotect— unprotect the claim type from accidental deletion.
Cannot be used together with --protect.
🦋 domain claim claim-type modify
Same energy, but for changing claim types that already exist.
-H,--URL— LDB URL for the database or the target server.--name— display name of the claim type you're modifying. Required.--class— object classes to set the claim type to.
Example: --class=user --class=computer
--description— set the claim type's description.--enable— enable the claim type.
Cannot be used together with --disable.
--disable— disable the claim type.
Cannot be used together with --enable.
--protect— protect it from accidental deletion.
Cannot be used together with --unprotect.
--unprotect— unprotect it from accidental deletion.
Cannot be used together with --protect.
💀 domain claim claim-type delete
The dramatic one. It deletes claim types off the domain. Gone. Poof.
-H,--URL— LDB URL for the database or the target server.--name— display name of the claim type to delete. Required — you have to say which one you're yeeting.--force— forces the delete even if the claim type is protected. Break the glass, bestie.
🌈 domain claim value-type list
Lists the claim value types on the domain. Window shopping ✨
-H,--URL— LDB URL for the database or the target server.--json— view the claim value types as JSON instead of a plain list. For the girlies who pipe things intojq.
🍓 domain claim value-type view
Views a single claim value type on the domain.
-H,--URL— LDB URL for the database or the target server.--name— display name of the claim value type to view. Required.
👑
domain classicupgrade [options] classic_smb_confUpgrade from a Samba classic (NT4-like) database all the way to a Samba AD DC database. Glow-up of the century, no cap.
domain dcpromo dnsdomain [DC|RODC] [options]Promotes an existing domain member or an NT4 PDC to an AD DC. Level up 💅
🙈 domain demote
Demotes ourselves from the role of domain controller. Sometimes you gotta step down from the throne, it's giving humble era.
domain exportkeytab keytab [options]Dumps the Kerberos keys of the domain straight into a keytab. Handing out the ✨sparkle✨ to whoever needs it.
domain functionalprep [options]Prepares a domain for a functional level upgrade. If --functional-level isn't used, it just uses the latest supported version (which is currently 2016).
So there's two whole aspects to this prep, bestie, and they relate to the forest and the domain. By default, both of them run. But if you use either --forest-prep or --domain-prep, only that corresponding preparation happens. And if you use both arguments together? Then all the prep gets done — exactly like when you use neither. Balance 🌸
-H,--URL— LDB URL for the database or the target server.--functional-level [2008_R2|2012|2012_R2|2016]— the functional level you're preparing for. The default is 2016.--forest-prep— run forest preparation only (unless--domain-prepis also used).--domain-prep— run domain preparation only (unless--forest-prepis also used).
domain info ip_address [options]Prints the basic info about a domain and the DC you point it at. Receipts 🧾
domain join dnsdomain [DC|RODC|MEMBER|SUBDOMAIN] [options]Joins a domain as either a member or a backup domain controller. Pick your archetype.
🎀 domain kds root-key
Manages Key Distribution Service root keys. The whole KDS root-key world lives under here.
domain kds root-key create [options]
Creates KDS root keys 🔑
-H,--URL— LDB URL for the database or the target server.--use-start-time=["now"|iso8601 or LDIF time string]— the key will be valid from this time onwards.
Valid time formats are: the string "now", the LDIF format YYYYmmddHHMMSS.0Z, or the ISO format YYYY-mm-dd[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]] — where the * can be any character — and that optional trailing [+HH:MM[:SS[.ffffff]]] is a timezone offset (like '+00:00' for UTC).
--json— output the results in JSON format.
domain kds root-key delete --name={GUID}
Deletes the named KDS root key. Heads up: use samba-tool domain kds root-key list to find the name of the key first, iykyk.
-H,--URL— LDB URL for the database or the target server.--name=NAME— the name of the key to delete. It's gonna be a GUID.-v,--verbose— print all attributes (except the secret ones, unless--show secretsis used).--json— output results in JSON format.
domain kds root-key list [options]
Lists KDS root keys. The newest keys come first — fresh to oldest, like your camera roll 🌸
-H,--URL— LDB URL for the database or the target server.--show-secrets— print secret or potentially sensitive attributes, namelymsKds-RootKeyDataandmsKds-SecretAgreementParam. Careful with these, bestie.-v,--verbose— print more attributes (but not the secret ones, unless--show secretsis also used).--json— output results in JSON format.
domain kds root-key view [options]
Views a KDS root key. The default output is basically what samba-tool domain kds root-key list --verbose gives you, except only one key shows up. You pick which one with --latest for the most recent key, or --name to select a key by name.
-H,--URL— LDB URL for the database or the target server.--latest— view the most recent root key.--name=NAME— the name of the key to view. It'll be a GUID.-v,--verbose— print all attributes (except secret ones, unless--show secretsis used). This even includes attributes that are only useful for LDB bookkeeping. The receipts of receipts.--json— output results in JSON format.
🫶 domain leave [options]
Run this on a domain member and it'll make it leave the domain. It's giving ✨*we're done here*✨.
To remove a domain server from the domain, you first need samba-tool domain demote. Don't skip steps, babe.
--keep-account— disable the machine account instead of deleting it.
domain level show|raise options [options]Shows or raises domain and forest function levels.
domain passwordsettings set options [options]Sets password settings, including complexity requirements, lockout policy, history length, minimum password length, and minimum and maximum password age on a Samba AD DC server.
Use against a Windows DC is possible, but group policy will override it. So like... do with that what you will.
-H URL,--URL=URL— LDB URL for database or target server-q,--quiet— be quiet 🤫--complexity=COMPLEXITY— the password complexity (on|off|default). Default is'on'.--store-plaintext=STORE_PLAINTEXT— store plaintext passwords where accounts have 'store passwords with reversible encryption' set (on|off|default). Default is'off'.--history-length=HISTORY_LENGTH— the password history length (integer |default). Default is24.--min-pwd-length=MIN_PWD_LENGTH— the minimum password length (integer |default). Default is7.--min-pwd-age=MIN_PWD_AGE— the minimum password age (number of days |default). Default is1.--max-pwd-age=MAX_PWD_AGE— the maximum password age (number of days |default). Default is43.--account-lockout-duration=ACCOUNT_LOCKOUT_DURATION— how long an account stays locked out after it blows past the bad-password-attempt limit (number of minutes |default). Default is30mins.--account-lockout-threshold=ACCOUNT_LOCKOUT_THRESHOLD— how many bad password attempts are allowed before the account gets locked out (integer |default). Default is0(never lock out).--reset-account-lockout-after=RESET_ACCOUNT_LOCKOUT_AFTER— once this much time has elapsed, the recorded number of attempts restarts from zero (integer |default). Default is30.
domain passwordsettings show options [options]Displays the current password settings for the domain. The tea ☕
-H URL,--URL=URL— LDB URL for database or target server
👑 domain passwordsettings pso
Manages fine-grained Password Settings Objects (PSOs). Fancy, granular, iconic.
domain passwordsettings pso apply pso-name user-or-group-name [options]
Applies a PSO's password policy to a user or a group.
domain passwordsettings pso create pso-name precedence [options]
Creates a new Password Settings Object (PSO).
domain passwordsettings pso delete pso-name [options]
Deletes a Password Settings Object (PSO).
domain passwordsettings pso list [options]
Lists all Password Settings Objects (PSOs).
domain passwordsettings pso set pso-name [options]
Modifies a Password Settings Object (PSO).
domain passwordsettings pso show user-name [options]
Displays a Password Settings Object (PSO).
domain passwordsettings pso show-user pso-name [options]
Displays the Password Settings that apply to a user.
domain passwordsettings pso unapply pso-name user-or-group-name [options]
Updates a PSO to no longer apply to a user or a group. It's not you, it's policy 💔
⭐ domain provision
Promotes an existing domain member or NT4 PDC to an AD DC.
domain schemaupgrade [options]Upgrades the schema. Glow-up but for your directory structure.
-H,--URL— LDB URL for the database or the target server.--schema [2012|2012_R2|2016|2019]— upgrade to this Windows schema level. The default is 2019.--ldf-file— apply the schema changes in this LDIF file, instead of updating to a standard schema level.--base-dir— specify an alternate location to find the schema LDIF files.
domain tombstones expunge NC [NC [...]] [options]-H URL,--URL=URL— LDB URL for database or target server--current-time=YYYY-MM-DD— the current time to evaluate the tombstone lifetime from, expressed asYYYY-MM-DD--tombstone-lifetime=DAYS— number of days a tombstone should be preserved for
🌸 domain trust
Domain and forest trust management. The whole trust tree lives here.
domain trust create DOMAIN options [options]
Create a domain or forest trust.
domain trust modify DOMAIN options [options]
Modify a domain or forest trust.
domain trust delete DOMAIN options [options]
Delete a domain trust.
domain trust list options [options]
List domain trusts.
domain trust namespaces [DOMAIN] options [options]
Manage forest trust namespaces.
domain trust show DOMAIN options [options]
Show trusted domain details.
domain trust validate DOMAIN options [options]
Validate a domain trust.
💜 drs
Manage Directory Replication Services (DRS). Replication girlies rise up.
drs bind
Show DRS capabilities of a server.
drs clone-dc-database dnsdomain
--targetdir=DIR [options]"okay so drs clone wraps up with a whole vibe-check of options, and remember what we said: this one Replicate an initial clone of domain, but DO NOT JOIN it. (the caps are screaming for a reason, bestie — clone only, no joining 💀)
--server=DC— clone this DC. yeah, this one. your source 🫶--targetdir=TARGETDIR— where to store provision. required, so like, not optional-fr-fr 😭-q,--quiet— be quiet. shhh. no yapping.--include-secrets— also replicate secret values. the spicy bits 🔐--backend-store=BACKENDSTORE— specify the database backend to be used (default istdb).--backend-store-size=SIZE— specify the size of the backend database, currently only supported by lmdb backends (default is 8 GB).
drs uptodateness [options]
Show uptodateness status. like, how caught-up is everything, on a scale of "slay" to "bestie we need to talk" 💅
-H URL,--URL=URL— LDB URL for database or target server-p PARTITION,--partition=PARTITION— restrict to this partition--json— print data in json format--maximum— print maximum out-of-date-ness only--median— print median out-of-date-ness only--full— print full out-of-date-ness data
drs kcc
Trigger knowledge consistency center run. that's the ✨self-healing topology✨ moment, periodt.
drs options
Query or change options for NTDS Settings object of a domain controller.
drs replicate destination_DC source_DC NC [options]
Replicate a naming context between two DCs. destination first, source second, NC for the naming context. order matters, don't fight me on it 💜
drs showrepl
Show replication status. heads up: the [--json] option results in JSON output, and with the [--summary] option it produces very little output when the replication status seems healthy. silent = thriving 🦋
dsacl
Administer DS ACLs.
dsacl delete
Delete an access list entry on a directory object.
dsacl get
Print access list on a directory object.
dsacl set
Modify access list on a directory object.
forest
Manage Forest configuration. big-picture stuff, the whole forest, not just one lil tree 🌲
forest directory_service
Manage directory_service behaviour for the forest.
forest directory_service dsheuristics VALUE
Modify dsheuristics directory_service configuration for the forest.
forest directory_service show
Show current directory_service configuration for the forest.
fsmo
Manage Flexible Single Master Operations (FSMO). the celebrity roles of the AD world, ngl 👑
fsmo seize [options]
Seize the role. dramatic. iconic. sometimes necessary. 🔥
fsmo show
Show the roles.
fsmo transfer [options]
Transfer the role. the polite version 🎀
gpo
Manage Group Policy Objects (GPO).
gpo aclcheck [options]
Create an empty GPO.
Check all GPOs have matching LDAP and DS ACLs.
(yeah, that first line is a little copy-paste gremlin moment, but we report what the page says, no cap.)
-H URL,--URL=URL— LDB URL for database or target server
gpo admxload [options]
Loads samba admx files to sysvol.
-H URL,--URL=URL— LDB URL for database or target server--admx-dir=ADMX_DIR— directory where admx templates are stored
gpo backup gpo[options]
Backup a GPO.
-H H— LDB URL for database or target server--tmpdir=TMPDIR— temporary directory for copying policy files--generalize— generalize XML entities to restore--entities=ENT_FILE— file to export defining XML entities for the restore
gpo create displayname [options]
Create an empty GPO.
gpo cse list
List the registered Client Side Extensions (CSEs) on the current host.
gpo cse register cse_file cse_name [options]
Register a Client Side Extension (CSE) on the current host.
okay so this command takes a CSE filename as an argument, and registers it for applying policy on the current host. it's not necessary for CSEs which are distributed with the current version of Samba, but it's useful for installing experimental CSEs or custom built CSEs.
The cse_file argument MUST be a permanent location for the CSE — the register command does not copy the file to some other directory. The samba-gpupdate command will execute the CSE from the exact location specified from this command. so like, put it somewhere it can stay, bestie 😭
--machine— whether to register the CSE as Machine policy--user— whether to register the CSE as User policy
gpo cse unregister GUID
Unregister a Client Side Extension (CSE) from the current host.
This command takes a unique GUID as an argument (representing a registered CSE), and unregisters it for applying policy on the current host. use the samba-tool gpo cse list command to determine the unique GUIDs of CSEs.
gpo del gpo [options]
Delete GPO.
gpo dellink container_dn gpo [options]
Delete GPO link from a container.
gpo fetch gpo [options]
Download a GPO.
gpo getinheritance container_dn [options]
Get inheritance flag for a container.
gpo getlink container_dn [options]
List GPO Links for a container.
gpo list username [options]
List GPOs for an account.
gpo listall
List all GPOs. every single one. the full roster ✨
gpo listcontainers gpo [options]
List all linked containers for a GPO.
gpo load gpo [options]
Load policies onto a GPO.
Reads json from standard input until EOF, unless a json formatted file is provided via --content.
Example json_input:
[
{
"keyname": "Software\Policies\Mozilla\Firefox\Homepage",
"valuename": "StartPage",
"class": "USER",
"type": "REG_SZ",
"data": "homepage"
},
{
"keyname": "Software\Policies\Mozilla\Firefox\Homepage",
"valuename": "URL",
"class": "USER",
"type": "REG_SZ",
"data": "google.com"
},
{
"keyname": "Software\Microsoft\Internet Explorer\Toolbar",
"valuename": "IEToolbar",
"class": "USER",
"type": "REG_BINARY",
"data": [0]
},
{
"keyname": "Software\Policies\Microsoft\InputPersonalization",
"valuename": "RestrictImplicitTextCollection",
"class": "USER",
"type": "REG_DWORD",
"data": 1
}
]Valid class attributes: MACHINE|USER|BOTH. Data arrays are interpreted as bytes.
The --machine-ext-name and --user-ext-name options are multi-value inputs which respectively set the gPCMachineExtensionNames and gPCUserExtensionNames ldap attributes on the GPO. These attributes must be set to the correct GUID names for Windows Group Policy to work correctly. These GUIDs represent the client side extensions to apply on the machine. Linux Group Policy does not enforce this constraint. {35378EAC-683F-11D2-A89A-00C04FBBCFA2} is provided by default, which enables most Registry policies.
-H H— LDB URL for database or target server--content=CONTENT— JSON file of policy inputs--machine-ext-name=MACHINE_EXTS— a machine extension name to add togPCMachineExtensionNames--user-ext-name=USER_EXTS— a user extension name to add togPCUserExtensionNames--replace— replace the existing Group Policies, rather than merging
gpo manage security list gpo [options]
List Samba Security Group Policy from the sysvol.
This command lists security settings from the sysvol that will be applied to winbind clients. These settings only apply to the AD DC.
Example:
samba-tool gpo manage security list {31B2F340-016D-11D2-945F-00C04FB984F9}-H URL,--URL=URL— LDB URL for database or target server
gpo manage security set gpo [options]
Set Samba Security Group Policy to the sysvol.
This command sets a security setting to the sysvol for applying to winbind clients. Not providing a value will unset the policy. These settings only apply to the AD DC.
Example:
samba-tool gpo manage security set {31B2F340-016D-11D2-945F-00C04FB984F9} MaxTicketAge 10Possible policies:
MaxTicketAge— maximum lifetime for user ticket (hours).MaxServiceAge— maximum lifetime for service ticket in minutes. Defined in minutes.MaxRenewAge— maximum lifetime for user ticket renewal, in minutes.MinimumPasswordAge— minimum password age, in days.MaximumPasswordAge— maximum password age, in days.MinimumPasswordLength— minimum password length, in characters.PasswordComplexity— password must meet complexity requirements.1is Enabled,0is Disabled.-H URL,--URL=URL— LDB URL for database or target server
List Samba Security Group Policy from the sysvol.
This command lists security settings from the sysvol that will be applied to winbind clients. These settings only apply to the AD DC.
Example:
samba-tool gpo manage security list {31B2F340-016D-11D2-945F-00C04FB984F9}-H URL,--URL=URL— LDB URL for database or target server
nope, bestie, you're not seeing double — that block really is in here twice. we keep it, all of it, no cutting 💅
gpo manage smb_conf list
List smb.conf settings from the sysvol that will be applied to winbind clients.
Example:
samba-tool gpo manage smb_conf list {31B2F340-016D-11D2-945F-00C04FB984F9}-H URL,--URL=URL— LDB URL for database or target server
gpo manage smb_conf set gpo [value] [options]
Set or unset an smb.conf setting to the sysvol for applying to winbind clients.
If a value is provided, that is the smb.conf value used; if no value is provided, the policy is removed.
Example:
samba-tool gpo manage smb_conf set {31B2F340-016D-11D2-945F-00C04FB984F9} 'apply gpo policies' yes-H URL,--URL=URL— LDB URL for database or target server
gpo setinheritance container_dn block|inherit [options]
Set inheritance flag on a container.
gpo setlink container_dn gpo [options]
Add or Update a GPO link to a container.
gpo removegpo [options]
Show information for a GPO.
Remove policies from a GPO.
Reads json from standard input until EOF, unless a json formatted file is provided via --content.
Example json_input:
[
{
"keyname": "Software\Policies\Mozilla\Firefox\Homepage",
"valuename": "StartPage",
"class": "USER",
},
{
"keyname": "Software\Policies\Mozilla\Firefox\Homepage",
"valuename": "URL",
"class": "USER",
},
{
"keyname": "Software\Microsoft\Internet Explorer\Toolbar",
"valuename": "IEToolbar",
"class": "USER"
},
{
"keyname": "Software\Policies\Microsoft\InputPersonalization",
"valuename": "RestrictImplicitTextCollection",
"class": "USER"
}
]Valid class attributes: MACHINE|USER|BOTH
-H H— LDB URL for database or target server--content=CONTENT— JSON file of policy inputs--machine-ext-name=MACHINE_EXTS— a machine extension name to remove fromgPCMachineExtensionNames--user-ext-name=USER_EXTS— a user extension name to remove fromgPCUserExtensionNames--color=always|never|auto— use colour if available (default:auto)
gpo restore displayname backup location [options]
Restore a GPO to a new container.
-H H— LDB URL for database or target server--tmpdir=TMPDIR— the temporary directory it uses for copying policy files 🗂️--entities=ENTITIES— a file that defines the XML entities to insert into the DOCTYPE header--restore-metadata— keeps the oldGPT.INIfile and its associated version number, no refreshing bestie 💾
gpo show gpo [options] — shows you the info for a GPO.
okay and now the whole gpo manage fam, all of them vibing in the sysvol ✨:
gpo manage symlink list— List VGP Symbolic Link Group Policy from the sysvolgpo manage symlink add— Adds a VGP Symbolic Link Group Policy to the sysvolgpo manage symlink remove— Removes a VGP Symbolic Link Group Policy from the sysvolgpo manage files list— List VGP Files Group Policy from the sysvolgpo manage files add— Add VGP Files Group Policy to the sysvolgpo manage files remove— Remove VGP Files Group Policy from the sysvolgpo manage openssh list— List VGP OpenSSH Group Policy from the sysvolgpo manage openssh set— Sets a VGP OpenSSH Group Policy to the sysvolgpo manage sudoers add— Adds a Samba Sudoers Group Policy to the sysvol.gpo manage sudoers list— List Samba Sudoers Group Policy from the sysvol.gpo manage sudoers remove— Removes a Samba Sudoers Group Policy from the sysvol.gpo manage scripts startup list— List VGP Startup Script Group Policy from the sysvolgpo manage scripts startup add— Adds VGP Startup Script Group Policy to the sysvolgpo manage scripts startup remove— Removes VGP Startup Script Group Policy from the sysvolgpo manage motd list— List VGP MOTD Group Policy from the sysvol.gpo manage motd set— Sets a VGP MOTD Group Policy to the sysvolgpo manage issue list— List VGP Issue Group Policy from the sysvol.gpo manage issue set— Sets a VGP Issue Group Policy to the sysvolgpo manage access add— Adds a VGP Host Access Group Policy to the sysvolgpo manage access list— List VGP Host Access Group Policy from the sysvolgpo manage access remove— Remove a VGP Host Access Group Policy from the sysvol
👯 group
Manage groups. That's it, that's the whole section.
group add groupname [options]
Create a new AD group. brand new baby group 🫶
group create groupname [options]
Add a new AD group. This one is literally a synonym for the samba-tool group add command and it's only here for compatibility reasons, okay? Please use samba-tool group add instead. no cap 🙏
group addmembers groupname members [options]
Add members to an AD group.
group addunixattrs groupname gidnumber [options]
Adds RFC2307 Unix attributes to a group account in the Active Directory domain. The groupname you pass on the command is the sAMaccountName.
Unix (RFC2307) attributes will be added to the group account.
Add idmap_ldb:use rfc2307 = Yes to smb.conf to use these attributes for UID/GID mapping.
The command may be run from the root userid or another authorized userid. The -H or --URL= option can be used to execute the command against a remote server.
Example1:
samba-tool group addunixattrs Group1 10000Example1 shows how to add RFC2307 attributes to a domain enabled group account.
The groups Unix ID will be set to '10000', provided this ID isn't already in use.
-H URL,--URL=URL— LDB URL for database or target server
group delete groupname [options]
Delete an AD group. bye bestie 💀
group edit groupname
Edit a group AD object.
--editor=EDITOR— specifies the editor to use instead of the system default, orviif no system default is set.
group list
List all groups.
group listmembers groupname [options]
List all members of the specified AD group.
By default the sAMAccountNames are listed. If no sAMAccountName is available, the CN will be used instead.
--full-dn— list the distinguished names instead of the sAMAccountNames.--hide-expired— do not list expired group members.--hide-disabled— do not list disabled group members.
group move groupname new_parent_dn [options]
This command moves a group into the specified organizational unit or container.
The groupname specified on the command is the sAMAccountName.
The name of the organizational unit or container can be specified as a full DN or without the domainDN component.
group removemembers groupname members [options]
Remove members from the specified AD group.
group show groupname [options]
Show group object and it's attributes.
group stats [options]
Show statistics for overall groups and group memberships.
group rename groupname [options]
Rename a group and related attributes.
This command allows to set the group's name related attributes. The group's CN will be renamed automatically. The group's CN will be the sAMAccountName. Use the --force-new-cn option to specify the new CN manually and the --reset-cn to reset this change.
Use an empty attribute value to remove the specified attribute.
The groupname specified on the command is the sAMAccountName.
--force-new-cn=NEW_CN— specify a new CN (RDN) instead of using the sAMAccountName.--reset-cn— set the CN to the sAMAccountName.--mail-address=MAIL_ADDRESS— new mail address--samaccountname=SAMACCOUNTNAME— new account name (sAMAccountName/logon name)
ldapcmp URL1 URL2 domain|configuration|schema|dnsdomain|dnsforest [options] — compares two LDAP databases. spot the difference 🔍
🔐 ntacl
Manage NT ACLs.
ntacl changedomsid original-domain-SID new-domain-SID file [options]
Change the domain SID for ACLs. Can be used to change all entries in acl_xattr when the machine's SID has accidentally changed or the data set has been copied to another machine either via backup/restore or rsync.
--use-ntvfs— set the ACLs directly to the TDB or xattr. The POSIX permissions will NOT be changed, only the NT ACL will be stored.--service=SERVICE— specify the name of thesmb.confservice to use. This option is required in combination with the--use-s3fsoption.--use-s3fs— set the ACLs for use with the default s3fs file server via the VFS layer. This option requires asmb.confservice, specified by the--service=SERVICEoption.--xattr-backend=[native|tdb]— specify the xattr backend type (native fs or tdb).--eadb-file=EADB_FILE— name of the tdb file where attributes are stored.--recursive— set the ACLs for directories and their contents recursively.--follow-symlinks— follow symlinks when--recursiveis specified.--verbose— verbosely list files and ACLs which are being processed.
ntacl getdosinfo file [options]
Get DOS info of a file from xattr.
ntacl get file [options]
Get ACLs on a file.
ntacl set acl file [options]
Set ACLs on a file.
ntacl sysvolcheck
Check sysvol ACLs match defaults (including correct ACLs on GPOs).
ntacl sysvolreset
Reset sysvol ACLs to defaults (including correct ACLs on GPOs).
🏢 ou
Manage organizational units (OUs).
ou add ou_dn [options]
Add a new organizational unit.
The name of the organizational unit can be specified as a full DN or without the domainDN component.
--description=DESCRIPTION— specify OU's description.
ou create ou_dn [options]
Add a new organizational unit. This is a synonym for the samba-tool ou add command and is available for compatibility reasons only. Please use samba-tool ou add instead. same energy as the group one fr fr 💅
ou delete ou_dn [options]
Delete an organizational unit.
The name of the organizational unit can be specified as a full DN or without the domainDN component.
--force-subtree-delete— delete organizational unit and all children recursively.
ou list [options]
List all organizational units.
--full-dn— display DNs including the base DN.
ou listobjects ou_dn [options]
List all objects in an organizational unit.
The name of the organizational unit can be specified as a full DN or without the domainDN component.
--full-dn— display DNs including the base DN.-r|--recursive— list objects recursively.
ou move old_ou_dn new_parent_dn [options]
Move an organizational unit.
The name of the organizational units can be specified as a full DN or without the domainDN component.
ou rename old_ou_dn new_ou_dn [options]
Rename an organizational unit.
The name of the organizational units can be specified as a full DN or without the domainDN component.
🔍 processes
List samba server processes.
If no processes are show, but Samba is running, it is possible that samba-tool has not found the correct smb.conf, and the use of -s/--configfile is required. (yes really, check the config file bestie 🙈)
--name=NAME— show processes associated with the given name.--pid=PID— show names associated with the PID.
🧊 rodc
Manage Read-Only Domain Controller (RODC).
rodc preload SID|DN|accountname [options]
Preload one account for an RODC.
📜 schema
Manage and query schema.
schema attribute modify attribute [options]
Modify the behaviour of an attribute in schema.
schema attribute show attribute [options]
Display an attribute schema definition.
schema attribute show_oc attribute [options]
Show objectclasses that MAY or MUST contain this attribute.
schema objectclass show objectclass [options]
Display an objectclass schema definition.
🧑💼 service-account
Service account management.
service-account list
List service accounts on the domain.
-H,--URL— LDB URL for database or target server.--json— view service accounts as JSON instead of a list.
service-account view
View a single service account on the domain.
-H,--URL— LDB URL for database or target server.--name— account name of service account to view (required).
service-account create
Create a new service account on the domain.
-H,--URL— LDB URL for database or target server.--name— account name of service account (required).--dns-host-name— DNS hostname of this service account (required).--group-msa-membership— optional Group MSA Membership SDDL.--managed-password-interval— managed password refresh interval in days.
service-account modify
Modify an existing service account on the domain.
-H,--URL— LDB URL for database or target server.--name— account name of service account (required).--dns-host-name— update DNS hostname of this service account.--group-msa-membership— update Group MSA Membership SDDL.
service-account delete
Delete a service accounts on the domain.
-H,--URL— LDB URL for database or target server.--name— account name of service account to delete.
service-account group-msa-membership
Service account Group MSA Membership management.
service-account group-msa-membership show
Display Group MSA Membership for a service account.
-H,--URL— LDB URL for database or target server.--name— account name of service account (required).--json— Return as JSON instead of a list. 📦
✨ service-account group-msa-membership add ✨
Add a principal to Group MSA Membership for a service account. 💖
-H,--URL— LDB URL for database or target server. 🔗--name— Account name of service account (required). 📛--principal— Name, DN or SID of principal to add. 👑
✨ service-account group-msa-membership remove ✨
Remove a principal from Group MSA Membership for a service account. 💔
-H,--URL— LDB URL for database or target server. 🔗--name— Account name of service account (required). 📛--principal— Name, DN or SID of principal to remove. 🗑️
🐚 shell 🐚
Opens an interactive Samba Python shell. ✨
🐚 shell [options] 🐚
Opens an interactive Python shell for Samba ldb connection. 🔌
-H,--URL— LDB URL for database or target server. 🔗
🌐 sites 🌐
Manage sites. 🗺️
📋 sites list [options] 📋
List sites. 📝
--json— Output as JSON instead of a list. 📦
👀 sites view site [options] 👀
View site details. 🔍
➕ sites create site [options] ➕
Create a new site. 🆕
❌ sites remove site [options] ❌
Delete an existing site. 🗑️
📋 sites subnet list site [options] 📋
List subnets for a site. 📡
--json— Output as JSON instead of a list. 📦
👀 sites subnet view subnet [options] 👀
View subnet details. 🔍
➕ sites subnet create subnet site-of-subnet [options] ➕
Create a new subnet. 🆕
❌ sites subnet remove subnet [options] ❌
Delete an existing subnet. 🗑️
🔗 sites subnet set-site subnet site-of-subnet [options] 🔗
Assign a subnet to a site. 📌
🎫 spn 🎫
Manage Service Principal Names (SPN). 🎟️
➕ spn add name user [options] ➕
Create a new SPN. ✨
❌ spn delete name [user] [options] ❌
Delete an existing SPN. 🗑️
📋 spn list user [options] 📋
List SPNs of a given user. 👤
🧪 testparm 🧪
Check the syntax of the configuration file. 📄
⏰ time ⏰
Retrieve the time on a server. 🕰️
👤 user 👤
Manage users. 🧑🤝🧑
➕ user add username [password] ➕
Add a new user to the Active Directory Domain. 🎉
🧬 user addunixattrs username uid-number [options] 🧬
Add RFC2307 attributes to a user. 🧩
This command adds Unix attributes to a user account in the Active Directory domain. ✨
The username specified on the command is the sAMaccountName. 📛
You must supply a unique uid. 🔑
Unix (RFC2307) attributes will be added to the user account. 💖
If you supply a group id with --gid-number, this will be used for the users Unix gidNumber attribute. 🆔
If --gid-number is not supplied, the users Unix gidNumber will be set to the one found in Domain Users, this means Domain Users must have a gidNumber attribute. 👥
If --unix-home is not supplied, the users Unix home directory will be set to /home/DOMAIN/username. 🏠
If --login-shell is not supplied, the users Unix login shell will be set to /bin/sh. 🐚
If ---gecos is not supplied, the users Unix gecos field will be set to the user's CN attribute. 📝
Add idmap_ldb:use rfc2307 = Yes to the smb.conf on DCs to use these attributes for UID/GID mapping. ⚙️
The command may be run from the root userid or another authorised userid. The -H or --URL= option can be used to execute the command against a remote server. 🌐
Example1:
samba-tool user addunixattrs User1 10001Example1 shows how to add RFC2307 attributes to a domain enabled user account, Domain Users will be set as the users gidNumber. 👑
The users Unix ID will be set to 10001, provided this ID isn't already in use. 🆔
Example2:
samba-tool user addunixattrs User2 10002 --gid-number=10001 --unix-home=/home/User2Example2 shows how to add RFC2307 attributes to a domain enabled user account. 🎉
The users Unix ID will be set to 10002, provided this ID isn't already in use. 🆔
The users gidNumber attribute will be set to 10001. 🆔
The users Unix home directory will be set to /home/user2. 🏠
Example3:
samba-tool user addunixattrs User3 10003 --gid-number=10001 --login-shell=/bin/false --gecos='User3 test'Example3 shows how to add RFC2307 attributes to a domain enabled user account. 🎉
The users Unix ID will be set to 10003, provided this ID isn't already in use. The users gidNumber attribute will be set to 10001. The users Unix login shell will be set to /bin/false. The users gecos field will be set to User3 test. 📝
-H URL,--URL=URL— LDB URL for database or target server 🔗--gid-number=GROUP_ID— User's Unix/RFC2307 GID 🆔--unix-home=DIR— User's Unix/RFC2307 home directory 🏠--login-shell=SHELL— User's Unix/RFC2307 login shell 🐚--gecos=GECOS— User's Unix/RFC2307 GECOS field 📝--uid=USER_ID— User's Unix/RFC2307 user id 🆔
🧑💻 user create username [password] 🧑💻
Add a new user. This is a synonym for the samba-tool user add command and is available for compatibility reasons only. Please use samba-tool user add instead. ⚠️
🗑️ user delete username [options] 🗑️
Delete an existing user account. 😢
🚫 user disable username 🚫
Disable a user account. 🔒
--remove-supplemental-groups— Remove user from all groups, but keep the primary group. 👥
✏️ user edit username ✏️
Edit a user account AD object. 📝
--editor=EDITOR— Specifies the editor to use instead of the system default, orviif no system default is set. 📟
✅ user enable username ✅
Enable a user account. 🔓
📋 user list 📋
List all users. 👥
By default the user's sAMAccountNames are listed. 📛
--full-dn— List user's distinguished names instead of the sAMAccountNames. 🌳-b BASE_DN,--base-dn=BASE_DN— Specify base DN to use. Only users under the specified base DN will be listed. 📂--hide-expired— Do not list expired user accounts. ⏳--hide-disabled— Do not list disabled user accounts. 🚫--locked-only— Only list locked user accounts. 🔒
👑 user setprimarygroup username primarygroupname 👑
Set the primary group a user account. 🎯
👥 user getgroups username 👥
Get the direct group memberships of a user account. 🔍
👀 user show username [options] 👀
Display a user AD object. 📇
--attributes=USER_ATTRS— Comma separated list of attributes, which will be printed. 📋
📦 user move username new_parent_dn [options] 📦
This command moves a user account into the specified organizational unit or container. 🚚
The username specified on the command is the sAMAccountName. 📛
The name of the organizational unit or container can be specified as a full DN or without the domainDN component. 🏢
🔑 user password [options] 🔑
Change password for a user account (the one provided in authentication). 🔐
🏷️ user rename username [options] 🏷️
Rename a user and related attributes. 📝
This command allows to set the user's name related attributes. The user's CN will be renamed automatically. The user's new CN will be made up by combining the given-name, initials and surname. A dot (.) will be appended to the initials automatically, if required. Use the --force-new-cn option to specify the new CN manually and --reset-cn to reset this change. 🔄
Use an empty attribute value to remove the specified attribute. 🗑️
The username specified on the command is the sAMAccountName. 📛
--surname=SURNAME— New surname 👤--given-name=GIVEN_NAME— New given name 👤--initials=INITIALS— New initials 🔤--force-new-cn=NEW_CN— Specify a new CN (RDN) instead of using a combination of the given name, initials and surname. 📛--reset-cn— Set the CN to the default combination of given name, initials and surname. 🔄--display-name=DISPLAY_NAME— New display name 🏷️--mail-address=MAIL_ADDRESS— New email address 📧--samaccountname=SAMACCOUNTNAME— New account name (sAMAccountName/logon name) 🔑--upn=UPN— New user principal name 🎫
🕵️ user sensitive accountname [show|on|off] [options] 🕵️
Set/unset or show UF_NOT_DELEGATED for an account. 🔒
-H URL,--URL=URL— LDB URL for database or target server 🔗
⏳ user setexpiry username [options] ⏳
Set the expiration of a user account. 📅
🔑 user setpassword username [options] 🔑
Sets or resets the password of a user account. 🔐
🔓 user unlock username [options] 🔓
This command unlocks a user account in the Active Directory domain. 🎉
🔍 user getpassword username [options] 🔍
Gets the password of a user account. 🔑
🎫 user get-kerberos-ticket username [options] 🎫
Gets a Kerberos Ticket Granting Ticket as the account. 🎟️
🔄 user syncpasswords --cache-ldb-initialize [options] 🔄
Syncs the passwords of all user accounts, using an optional script. 🔐
Note that this command should run on a single domain controller only (typically the PDC-emulator). ⚠️
📜 user auth policy assign username [options] 📜
Set assigned authentication policy for user. 🎯
--policy— Name of authentication policy to assign or leave empty to remove. 📝
❌ user auth policy remove username ❌
Remove assigned authentication policy from user. 🗑️
👀 user auth policy view username 👀
View the assigned authentication policy for user. 🔍
🏛️ user auth silo assign username [options] 🏛️
Set assigned authentication silo for user. 🎯
--silo— Name of authentication silo to assign or leave empty to remove. 📝
❌ user auth silo remove username ❌
Remove assigned authentication silo from user. 🗑️
👀 user auth silo view username 👀
View the assigned authentication silo for user. 🔍
🔑 user keytrust 🔑
Manage Key Credential Links for a user. 🔗
This can populate, describe or delete msDS-KeyCredentialLink attributes. 📝
➕ user keytrust add username public-key-or-certificate[options] ➕
Add a key-credential-link, which is a linked attribute that holds a public key in a binary field. 🔐
The second argument is a filename that should refer to a 2048 bit RSA key (or a certificate containing that key) in PEM or DER format. By default the encoding format will be detected automatically, but you can attempt to override this with --encoding option. Other types of public key are not supported, though the --force option can be used to add a non-2048 bit key. ⚠️
--link-target=DN— link to this DN (default: the user's DN) 🔗--encoding=ENCODING— Key format, eitherpem,der, orauto. The default isauto, which is likely to detect the correct format in all circumstances. 📄--force— proceed with operations that seems ill-fated ⚠️
❌ user keytrust delete username [options] ❌
Delete a key-credential-link. 🗑️
The link to be deleted can be selected in a number of ways. --all will delete all key credential links for the user (often there will only be one). The --link-target option selects a key credential link based on the DN targeted by the link. The --fingerprint option selects a link to delete based on the key fingerprint. This is the SHA256 of the DER-encoded key material, expressed as hex-pairs separated by colons. See user keytrust view to get a list of links and their fingerprints. 🔍
If more than one of --link-target, --fingerprint, and --all are used, links matched by any of them will be deleted. ⚠️
Okay bestie, --dry-run is giving dress rehearsal 🎭 — pass it and nothing gets deleted, she just tells you what would have happened if you'd left her out. Main character energy, honestly. 💅
--link-target=DN— yeet this key credential link, identified by a DN--fingerprint=HH:HH:..— yeet the key credential link that has this key fingerprint--all— yeet every single key credential link, no survivors 😭-n,--dry-run— do absolutely nothing except print what would happen
user keytrust view — peek at a user's key credential links 👀
user keytrust view username [options]This is the one you pull up to find a link's fingerprint and target DN for . (yes, the sentence really does just end there, iykyk 💀). And the --verbose? It includes more, probably useless, information. She's an over-sharer fr.
-h,--help— show this help message and exit, classic 🫶-v,--verbose— Be verbose
user generate-csr — time to make a certificate request ✨
user generate-csr username subject_name private_key_filename output_filename [options]Generate a PEM-encoded Certificate Signing Request for a user. Slay.
--private-key-encoding— specify which encoding the private key uses. Default is'auto'.--private-key-pass— hand over a password to decrypt the private key. 🔑
vampire — join and sync a remote AD domain 🧛
vampire [options] domainJoin and synchronise a remote AD domain to the local server.
⚠️ BIG WARNING BESTIE:samba-tool vampireis deprecated. Please usesamba-tool domain joininstead. Like, please. She's retired, let her rest. 😭
visualize — art class but for your network 🎨
visualize [options] subcommandProduce graphical representations of Samba network state. To work out what is happening in a replication graph, it is sometimes helpful to use visualisations. Like, sometimes you just gotta look at it, you know?
There are two subcommands, two graphical modes, and (roughly) two modes of operation with respect to the location of authority. Roughly, okay? Don't come for her. 💅
MODES OF OPERATION 🕸️
samba-tool visualize ntdsconn— Looks at NTDS connections.samba-tool visualize reps— Looks at repsTo and repsFrom objects.samba-tool visualize uptodateness— Looks at replication lag as shown by the uptodateness vectors.
GRAPHICAL MODES 🌈
--distance— distances between DCs are shown in a matrix in the terminal.--dot— generate Graphviz dot output (for ntdsconn and reps modes). When viewed usingdotorxdot, this shows the network as a graph with DCs as vertices and connections edges. Certain types of degenerate edges are shown in different colours or line-styles. Very demure, very mindful ✨--xdot— generate Graphviz dot output as with[--dot]and attempt to view it immediately using/usr/bin/xdot.-r— normally,samba-tooltalks to one database; with the[-r]option attempts are made to contact all the DCs known to the first database. This is necessary forsamba-tool visualize uptodatenessand forsamba-tool visualize repsbecause the repsFrom/To objects are not replicated, and it can reveal replication issues in other modes. Lowkey the receipts option. 🔍
help — when you're lost bestie 🫶
Gives usage information.
VERSION 👑
This man page is complete for version 4.24.7-Ubuntu-4.24.7+dfsg-1ubuntu1 of the Samba suite.
AUTHOR 🌸
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. Iconic behaviour, no cap. 👑
and that's a wrap on SAMBA-TOOL(8) bestie!! 💖 this whole page is complete for Samba 4.24.7-Ubuntu-4.24.7+dfsg-1ubuntu1, it's dated 09/13/2026 (the footer shows it as Samba 4.24.7-Ubuntu-4.24.7+dfs), and it's filed under SAMBA-TOOL(8). go forth and slay your domain controller, ily 🎀🦋
📦 where this page comes from
- ubuntu stonking: python3-samba 2:4.24.7+dfsg-1ubuntu1 · GPL-3.0-or-later
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms