computer
Manage computer accounts.
computeraddcomputername[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.
--computerou=COMPUTEROU
DN of alternative location (with or without domainDN counterpart) to default CN=Computers in 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.
computercreatecomputername[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.
computerdeletecomputername[options]
Delete an existing computer account.
The computer name specified on the command is the sAMAccountName, with or without the trailing dollar
sign.
computereditcomputername
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, or 'vi' if no system default is set.
computerlist
List all computers.
computermovecomputernamenew_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.
computershowcomputername[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.
contact
Manage contacts.
contactadd[contactname][options]
Add a new contact to the Active Directory Domain.
The name of the new contact can be specified by the first argument 'contactname' or the --given-name,
--initial and --surname arguments. If no 'contactname' is given, contact's name will be made up of the
given arguments by combining the given-name, initials and surname. Each argument is optional. A dot ('.')
will be appended to the initials automatically.
--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.
contactcreate[contactname][options]
Add a new contact. This is a synonym for the samba-tool contact add command and is available for
compatibility reasons only. Please use samba-tool contact add instead.
contactdeletecontactname[options]
Delete an existing contact.
The contactname specified on the command is the common name or the distinguished name of the contact
object. The distinguished name of the contact can be specified with or without the domainDN component.
contacteditcontactname
Modify a contact AD object.
The contactname specified on the command is the common name or the distinguished name of the contact
object. The distinguished name of the contact can be specified 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.
contactlist[options]
List all contacts.
--full-dn
Display contact's full DN instead of the name.
contactmovecontactnamenew_parent_dn[options]
This command moves a contact into the specified organizational unit or container.
The contactname specified on the command is the common name or the distinguished name of the contact
object. The distinguished name of the contact can be specified with or without the domainDN component.
contactshowcontactname[options]
Display a contact AD object.
The contactname specified on the command is the common name or the distinguished name of the contact
object. The distinguished name of the contact can be specified with or without the domainDN component.
--attributes=CONTACT_ATTRS
Comma separated list of attributes, which will be printed.
contactrenamecontactname[options]
Rename a contact and related attributes.
This command allows to set the contact's name related attributes. The contact's CN will be renamed
automatically. The contact'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 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.
delegation
Manage Delegations.
delegationadd-serviceaccountnameprincipal[options]
Add a service principal as msDS-AllowedToDelegateTo.
delegationdel-serviceaccountnameprincipal[options]
Delete a service principal as msDS-AllowedToDelegateTo.
delegationfor-any-protocolaccountname[(on|off)][options]
Set/unset UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION (S4U2Proxy) for an account.
delegationfor-any-serviceaccountname[(on|off)][options]
Set/unset UF_TRUSTED_FOR_DELEGATION for an account.
delegationshowaccountname[options]
Show the delegation setting of an account.
dns
Manage Domain Name Service (DNS).
dnsaddserverzonenameA|AAAA|PTR|CNAME|NS|MX|SRV|TXTdata
Add a DNS record.
dnsdeleteserverzonenameA|AAAA|PTR|CNAME|NS|MX|SRV|TXTdata
Delete a DNS record.
dnsqueryserverzonenameA|AAAA|PTR|CNAME|NS|MX|SRV|TXT|ALL[options]data
Query a name.
dnsroothintsserver[name][options]
Query root hints.
dnsserverinfoserver[options]
Query server information.
dnsupdateserverzonenameA|AAAA|PTR|CNAME|NS|MX|SRV|TXTolddatanewdata
Update a DNS record.
dnszonecreateserverzone[options]
Create a zone.
dnszonedeleteserverzone[options]
Delete a zone.
dnszoneinfoserverzone[options]
Query zone information.
dnszonelistserver[options]
List zones.
domain
Manage Domain.
domainbackup
Create or restore a backup of the domain.
domainbackupoffline
Backup (with proper locking) local domain directories into a tar file.
domainbackuponline
Copy a running DC's current DB into a backup tar file.
domainbackuprename
Copy a running DC's DB to backup file, renaming the domain in the process.
domainbackuprestore
Restore the domain's DB from a backup-file.
domainauthpolicy
Manage authentication policies.
domainauthpolicylist
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.
domainauthpolicyview
View an authentication policy on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of the authentication policy to view (required).
domainauthpolicycreate
Create authentication policies on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of the authentication policy (required).
--description
Optional description for the authentication policy.
--protect
Protect authentication policy from accidental deletion.
Cannot be used together with --unprotect.
--unprotect
Unprotect authentication policy from accidental deletion.
Cannot be used together with --protect.
--audit
Only audit authentication policy.
Cannot be used together with --enforce.
--enforce
Enforce authentication policy.
Cannot be used together with --audit.
--strong-ntlm-policy
Strong NTLM Policy (Disabled, Optional, Required).
--user-tgt-lifetime-mins
Ticket-Granting-Ticket lifetime for user accounts.
--user-allow-ntlm-auth
Allow NTLM and
InteractiveNETLOGONSamLogon 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
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 service is restricted to selected devices.
--service-allowed-to-authenticate-from
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)}))
domainauthpolicymodify
Modify authentication policies on the domain. The same options apply as for domainauthpolicycreate.
domainauthpolicydelete
Delete authentication policies on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of authentication policy to delete (required).
--force
Force authentication policy delete even if it is protected.
domainauthpolicyuser-allowed-to-authenticate-fromset
Set the user-allowed-to-authenticate-from property by scenario.
-H, --URL
LDB URL for database or target server.
--name
Name of authentication policy.
--by-group=GROUP
User is allowed to authenticate, if the device they authenticate from is assigned and granted
membership of a given GROUP.
--silo=SILO
User is allowed to authenticate, if the device they authenticate from is assigned and granted
membership of a given SILO.
domainauthpolicyuser-allowed-to-authenticate-toset
Set the user-allowed-to-authenticate-to property by scenario.
-H, --URL
LDB URL for database or target server.
--name
Name of 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.
domainauthpolicyservice-allowed-to-authenticate-fromset
Set the service-allowed-to-authenticate-from property by scenario.
-H, --URL
LDB URL for database or target server.
--name
Name of 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.
domainauthpolicyservice-allowed-to-authenticate-toset
Set the service-allowed-to-authenticate-to property by scenario.
-H, --URL
LDB URL for database or target server.
--name
Name of 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.
domainauthpolicycomputer-allowed-to-authenticate-toset
Set the computer-allowed-to-authenticate-to property by scenario.
-H, --URL
LDB URL for database or target server.
--name
Name of 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.
domainauthsilo
Manage authentication silos.
domainauthsilolist
List authentication silos on the domain.
-H, --URL
LDB URL for database or target server.
--json
View authentication silos as JSON instead of a list.
domainauthsiloview
View an authentication silo on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of the authentication silo to view (required).
domainauthsilocreate
Create authentication silos on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of the authentication silo (required).
--description
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 authentication silo from accidental deletion.
Cannot be used together with --unprotect.
--unprotect
Unprotect 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.
domainauthsilomodify
Modify authentication silos on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of the authentication silo (required).
--description
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 authentication silo from accidental deletion.
Cannot be used together with --unprotect.
--unprotect
Unprotect 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.
domainauthsilodelete
Delete authentication silos on the domain.
-H, --URL
LDB URL for database or target server.
--name
Name of authentication silo to delete (required).
--force
Force authentication silo delete even if it is protected.
domainauthsilomembergrant
Grant a member access to an authentication silo.
-H, --URL
LDB URL for database or target server.
--name
Name of authentication silo (required).
--member
Member to grant access to the silo (DN or account name).
domainauthsilomemberlist
List members in an authentication silo.
-H, --URL
LDB URL for database or target server.
--name
Name of authentication silo (required).
--json
View members as JSON instead of a list.
domainauthsilomemberrevoke
Revoke a member from an authentication silo.
-H, --URL
LDB URL for database or target server.
--name
Name of authentication silo (required).
--member
Member to revoke from the silo (DN or account name).
domainclaimclaim-typelist
List claim types on the domain.
-H, --URL
LDB URL for database or target server.
--json
View claim types as JSON instead of a list.
domainclaimclaim-typeview
View a single claim type on the domain.
-H, --URL
LDB URL for database or target server.
--name
Display name of claim type to view (required).
domainclaimclaim-typecreate
Create claim types on the domain.
-H, --URL
LDB URL for database or target server.
--attribute
Attribute of claim type to create (required).
--class
Object classes to set claim type to.
Example: --class=user --class=computer
--name
Optional display name or use attribute name.
--description
Optional description or use from attribute.
--enable
Enable claim type.
Cannot be used together with --disable.
--disable
Disable claim type.
Cannot be used together with --enable.
--protect
Protect claim type from accidental deletion.
Cannot be used together with --unprotect.
--unprotect
Unprotect claim type from accidental deletion.
Cannot be used together with --protect.
domainclaimclaim-typemodify
Modify claim types on the domain.
-H, --URL
LDB URL for database or target server.
--name
Display name of claim type to modify (required).
--class
Object classes to set claim type to.
Example: --class=user --class=computer
--description
Set the claim type description.
--enable
Enable claim type.
Cannot be used together with --disable.
--disable
Disable claim type.
Cannot be used together with --enable.
--protect
Protect claim type from accidental deletion.
Cannot be used together with --unprotect.
--unprotect
Unprotect claim type from accidental deletion.
Cannot be used together with --protect.
domainclaimclaim-typedelete
Delete claim types on the domain.
-H, --URL
LDB URL for database or target server.
--name
Display name of claim type to delete (required).
--force
Force claim type delete even if it is protected.
domainclaimvalue-typelist
List claim value types on the domain.
-H, --URL
LDB URL for database or target server.
--json
View claim value types as JSON instead of a list.
domainclaimvalue-typeview
View a single claim value type on the domain.
-H, --URL
LDB URL for database or target server.
--name
Display name of claim value type to view (required).
service-account
Service account management.
service-accountlist
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-accountview
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-accountcreate
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-accountmodify
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-accountdelete
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-accountgroup-msa-membership
Service account Group MSA Membership management.
service-accountgroup-msa-membershipshow
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-accountgroup-msa-membershipadd
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-accountgroup-msa-membershipremove
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.
domainclassicupgrade[options]classic_smb_conf
Upgrade from Samba classic (NT4-like) database to Samba AD DC database.
domaindcpromodnsdomain[DC|RODC][options]
Promote an existing domain member or NT4 PDC to an AD DC.
domaindemote
Demote ourselves from the role of domain controller.
domainexportkeytabkeytab[options]
Dumps Kerberos keys of the domain into a keytab.
domaininfoip_address[options]
Print basic info about a domain and the specified DC.
domainjoindnsdomain[DC|RODC|MEMBER|SUBDOMAIN][options]
Join a domain as either member or backup domain controller.
domainlevelshow|raiseoptions[options]
Show/raise domain and forest function levels.
domainpasswordsettingsshow|setoptions[options]
Show/set password settings.
domainpasswordsettingspso
Manage fine-grained Password Settings Objects (PSOs).
domainpasswordsettingspsoapplypso-nameuser-or-group-name[options]
Applies a PSO's password policy to a user or group.
domainpasswordsettingspsocreatepso-nameprecedence[options]
Creates a new Password Settings Object (PSO).
domainpasswordsettingspsodeletepso-name[options]
Deletes a Password Settings Object (PSO).
domainpasswordsettingspsolist[options]
Lists all Password Settings Objects (PSOs).
domainpasswordsettingspsosetpso-name[options]
Modifies a Password Settings Object (PSO).
domainpasswordsettingspsoshowuser-name[options]
Displays a Password Settings Object (PSO).
domainpasswordsettingspsoshow-userpso-name[options]
Displays the Password Settings that apply to a user.
domainpasswordsettingspsounapplypso-nameuser-or-group-name[options]
Updates a PSO to no longer apply to a user or group.
domainprovision
Promote an existing domain member or NT4 PDC to an AD DC.
domaintrust
Domain and forest trust management.
domaintrustcreateDOMAINoptions[options]
Create a domain or forest trust.
domaintrustmodifyDOMAINoptions[options]
Modify a domain or forest trust.
domaintrustdeleteDOMAINoptions[options]
Delete a domain trust.
domaintrustlistoptions[options]
List domain trusts.
domaintrustnamespaces[DOMAIN]options[options]
Manage forest trust namespaces.
domaintrustshowDOMAINoptions[options]
Show trusted domain details.
domaintrustvalidateDOMAINoptions[options]
Validate a domain trust.
drs
Manage Directory Replication Services (DRS).
drsbind
Show DRS capabilities of a server.
drskcc
Trigger knowledge consistency center run.
drsoptions
Query or change options for NTDS Settings object of a domain controller.
drsreplicatedestination_DCsource_DCNC[options]
Replicate a naming context between two DCs.
drsshowrepl
Show replication status. The [--json] option results in JSON output, and with the [--summary] option
produces very little output when the replication status seems healthy.
dsacl
Administer DS ACLs
dsacldelete
Delete an access list entry on a directory object.
dsaclget
Print access list on a directory object.
dsaclset
Modify access list on a directory object.
forest
Manage Forest configuration.
forestdirectory_service
Manage directory_service behaviour for the forest.
forestdirectory_servicedsheuristicsVALUE
Modify dsheuristics directory_service configuration for the forest.
forestdirectory_serviceshow
Show current directory_service configuration for the forest.
fsmo
Manage Flexible Single Master Operations (FSMO).
fsmoseize[options]
Seize the role.
fsmoshow
Show the roles.
fsmotransfer[options]
Transfer the role.
gpo
Manage Group Policy Objects (GPO).
gpocreatedisplayname[options]
Create an empty GPO.
gpodelgpo[options]
Delete GPO.
gpodellinkcontainer_dngpo[options]
Delete GPO link from a container.
gpofetchgpo[options]
Download a GPO.
gpogetinheritancecontainer_dn[options]
Get inheritance flag for a container.
gpogetlinkcontainer_dn[options]
List GPO Links for a container.
gpolistusername[options]
List GPOs for an account.
gpolistall
List all GPOs.
gpolistcontainersgpo[options]
List all linked containers for a GPO.
gposetinheritancecontainer_dnblock|inherit[options]
Set inheritance flag on a container.
gposetlinkcontainer_dngpo[options]
Add or Update a GPO link to a container.
gposhowgpo[options]
Show information for a GPO.
gpomanagesymlinklist
List VGP Symbolic Link Group Policy from the sysvol
gpomanagesymlinkadd
Adds a VGP Symbolic Link Group Policy to the sysvol
gpomanagesymlinkremove
Removes a VGP Symbolic Link Group Policy from the sysvol
gpomanagefileslist
List VGP Files Group Policy from the sysvol
gpomanagefilesadd
Add VGP Files Group Policy to the sysvol
gpomanagefilesremove
Remove VGP Files Group Policy from the sysvol
gpomanageopensshlist
List VGP OpenSSH Group Policy from the sysvol
gpomanageopensshset
Sets a VGP OpenSSH Group Policy to the sysvol
gpomanagesudoersadd
Adds a Samba Sudoers Group Policy to the sysvol.
gpomanagesudoerslist
List Samba Sudoers Group Policy from the sysvol.
gpomanagesudoersremove
Removes a Samba Sudoers Group Policy from the sysvol.
gpomanagescriptsstartuplist
List VGP Startup Script Group Policy from the sysvol
gpomanagescriptsstartupadd
Adds VGP Startup Script Group Policy to the sysvol
gpomanagescriptsstartupremove
Removes VGP Startup Script Group Policy from the sysvol
gpomanagemotdlist
List VGP MOTD Group Policy from the sysvol.
gpomanagemotdset
Sets a VGP MOTD Group Policy to the sysvol
gpomanageissuelist
List VGP Issue Group Policy from the sysvol.
gpomanageissueset
Sets a VGP Issue Group Policy to the sysvol
gpomanageaccessadd
Adds a VGP Host Access Group Policy to the sysvol
gpomanageaccesslist
List VGP Host Access Group Policy from the sysvol
gpomanageaccessremove
Remove a VGP Host Access Group Policy from the sysvol
group
Manage groups.
groupaddgroupname[options]
Create a new AD group.
groupcreategroupname[options]
Add a new AD group. This is a synonym for the samba-tool group add command and is available for
compatibility reasons only. Please use samba-tool group add instead.
groupaddmembersgroupnamemembers[options]
Add members to an AD group.
groupdeletegroupname[options]
Delete an AD group.
groupeditgroupname
Edit a group AD object.
--editor=EDITOR
Specifies the editor to use instead of the system default, or 'vi' if no system default is set.
grouplist
List all groups.
grouplistmembersgroupname[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.
groupmovegroupnamenew_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.
groupremovemembersgroupnamemembers[options]
Remove members from the specified AD group.
groupshowgroupname[options]
Show group object and it's attributes.
groupstats[options]
Show statistics for overall groups and group memberships.
grouprenamegroupname[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)
ldapcmpURL1URL2domain|configuration|schema|dnsdomain|dnsforest [options]
Compare two LDAP databases.
ntacl
Manage NT ACLs.
ntaclchangedomsidoriginal-domain-SIDnew-domain-SIDfile[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 the smb.conf service to use. This option is required in combination with the
--use-s3fs option.
--use-s3fs
Set the ACLs for use with the default s3fs file server via the VFS layer. This option requires a
smb.conf service, specified by the --service=SERVICE option.
--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 --recursive is specified.
--verbose
Verbosely list files and ACLs which are being processed.
ntaclgetfile[options]
Get ACLs on a file.
ntaclsetaclfile[options]
Set ACLs on a file.
ntaclsysvolcheck
Check sysvol ACLs match defaults (including correct ACLs on GPOs).
ntaclsysvolreset
Reset sysvol ACLs to defaults (including correct ACLs on GPOs).
ou
Manage organizational units (OUs).
ouaddou_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.
oucreateou_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.
oudeleteou_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.
oulist[options]
List all organizational units.
--full-dn
Display DNs including the base DN.
oulistobjectsou_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.
oumoveold_ou_dnnew_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.
ourenameold_ou_dnnew_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.
rodc
Manage Read-Only Domain Controller (RODC).
rodcpreloadSID|DN|accountname[options]
Preload one account for an RODC.
schema
Manage and query schema.
schemaattributemodifyattribute[options]
Modify the behaviour of an attribute in schema.
schemaattributeshowattribute[options]
Display an attribute schema definition.
schemaattributeshow_ocattribute[options]
Show objectclasses that MAY or MUST contain this attribute.
schemaobjectclassshowobjectclass[options]
Display an objectclass schema definition.
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.
siteslist[options]
List sites.
--json
Output as JSON instead of a list
sitesviewsite[options]
View site details.
sitescreatesite[options]
Create a new site.
sitesremovesite[options]
Delete an existing site.
sitessubnetlistsite[options]
List subnets for a site.
--json
Output as JSON instead of a list
sitessubnetviewsubnet[options]
View subnet details.
sitessubnetcreatesubnetsite-of-subnet[options]
Create a new subnet.
sitessubnetremovesubnet[options]
Delete an existing subnet.
sitessubnetset-sitesubnetsite-of-subnet[options]
Assign a subnet to a site.
spn
Manage Service Principal Names (SPN).
spnaddnameuser[options]
Create a new SPN.
spndeletename[user][options]
Delete an existing SPN.
spnlistuser[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.
useraddusername[password]
Add a new user to the Active Directory Domain.
usercreateusername[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.
userdeleteusername[options]
Delete an existing user account.
userdisableusername
Disable a user account.
--remove-supplemental-groups
Remove user from all groups, but keep the primary group.
usereditusername
Edit a user account AD object.
--editor=EDITOR
Specifies the editor to use instead of the system default, or 'vi' if no system default is set.
userenableusername
Enable a user account.
userlist
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.
usersetprimarygroupusernameprimarygroupname
Set the primary group a user account.
usergetgroupsusername
Get the direct group memberships of a user account.
usershowusername[options]
Display a user AD object.
--attributes=USER_ATTRS
Comma separated list of attributes, which will be printed.
usermoveusernamenew_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.
userpassword[options]
Change password for a user account (the one provided in authentication).
userrenameusername[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
usersetexpiryusername[options]
Set the expiration of a user account.
usersetpasswordusername[options]
Sets or resets the password of a user account.
userunlockusername[options]
This command unlocks a user account in the Active Directory domain.
usergetpasswordusername[options]
Gets the password of a user account.
userget-kerberos-ticketusername[options]
Gets a Kerberos Ticket Granting Ticket as the account.
usersyncpasswords--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).
userauthpolicyassignusername[options]
Set assigned authentication policy for user.
--policy
Name of authentication policy to assign or leave empty to remove.
userauthpolicyremoveusername
Remove assigned authentication policy from user.
userauthpolicyviewusername
View the assigned authentication policy for user.
userauthsiloassignusername[options]
Set assigned authentication silo for user.
--silo
Name of authentication silo to assign or leave empty to remove.
userauthsiloremoveusername
Remove assigned authentication silo from user.
userauthsiloviewusername
View the assigned authentication silo for user.
vampire[options]domain
Join and synchronise a remote AD domain to the local server. Please note that samba-tool vampire is
deprecated, please use samba-tool domain join instead.
visualize[options]subcommand
Produce graphical representations of Samba network state. To work out what is happening in a replication
graph, it is sometimes helpful to use visualisations.
There are two subcommands, two graphical modes, and (roughly) two modes of operation with respect to the
location of authority.
MODESOFOPERATION
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.
GRAPHICALMODES
--distance
Distances between DCs are shown in a matrix in the terminal.
--dot
Generate Graphviz dot output (for ntdsconn and reps modes). When viewed using dot or xdot, 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.
--xdot
Generate Graphviz dot output as with [--dot] and attempt to view it immediately using /usr/bin/xdot.
-r
Normally, samba-tool talks to one database; with the [-r] option attempts are made to contact all the
DCs known to the first database. This is necessary for samba-tool visualize uptodateness and for
samba-tool visualize reps because the repsFrom/To objects are not replicated, and it can reveal
replication issues in other modes.
help
Gives usage information.
Install Now
PNG Icons