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.

--computerou=COMPUTEROU

--description=DESCRIPTION

--ip-address=IP_ADDRESS_LIST

--service-principal-name=SERVICE_PRINCIPAL_NAME_LIST

--prepare-oldjoin

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.

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

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

contact¶

Manage contacts.

contact add [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

--description=DESCRIPTION

--surname=SURNAME

--given-name=GIVEN_NAME

--initials=INITIALS

--display-name=DISPLAY_NAME

--job-title=JOB_TITLE

--department=DEPARTMENT

--company=COMPANY

--mail-address=MAIL_ADDRESS

--internet-address=INTERNET_ADDRESS

--telephone-number=TELEPHONE_NUMBER

--mobile-number=MOBILE_NUMBER

--physical-delivery-office=PHYSICAL_DELIVERY_OFFICE

contact create [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.

contact delete contactname [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.

contact edit contactname¶

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

contact list [options]¶

List all contacts.

--full-dn

contact move contactname new_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.

contact show contactname [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

contact rename contactname [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

--given-name=GIVEN_NAME

--initials=INITIALS

--force-new-cn=NEW_CN

--reset-cn

--display-name=DISPLAY_NAME

--mail-address=MAIL_ADDRESS

dbcheck¶

Check the local AD database for errors.

delegation¶

Manage Delegations.

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.

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.

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

--json

domain auth policy view¶

View an authentication policy on the domain.

-H, --URL

--name

domain auth policy create¶

Create authentication policies on the domain.

-H, --URL

--name

--description

--protect

--unprotect

--audit

--enforce

--strong-ntlm-policy

--user-tgt-lifetime-mins

--user-allow-ntlm-auth

--user-allowed-to-authenticate-from

--user-allowed-to-authenticate-to=SDDL

--service-tgt-lifetime-mins

--service-allow-ntlm-auth

--service-allowed-to-authenticate-from

--service-allowed-to-authenticate-to=SDDL

--computer-tgt-lifetime-mins

--computer-allowed-to-authenticate-to=SDDL

domain auth policy modify¶

Modify authentication policies on the domain. The same options apply as for domain auth policy create.

domain auth policy delete¶

Delete authentication policies on the domain.

-H, --URL

--name

--force

domain auth policy user-allowed-to-authenticate-from set¶

Set the user-allowed-to-authenticate-from property by scenario.

-H, --URL

--name

--by-group=GROUP

--silo=SILO

domain auth policy user-allowed-to-authenticate-to set¶

Set the user-allowed-to-authenticate-to property by scenario.

-H, --URL

--name

--group=GROUP

--silo=SILO

domain auth policy service-allowed-to-authenticate-from set¶

Set the service-allowed-to-authenticate-from property by scenario.

-H, --URL

--name

--group=GROUP

--silo=SILO

domain auth policy service-allowed-to-authenticate-to set¶

Set the service-allowed-to-authenticate-to property by scenario.

-H, --URL

--name

--group=GROUP

--silo=SILO

domain auth policy computer-allowed-to-authenticate-to set¶

Set the computer-allowed-to-authenticate-to property by scenario.

-H, --URL

--name

--group=GROUP

--silo=SILO

domain auth silo¶

Manage authentication silos.

domain auth silo list¶

List authentication silos on the domain.

-H, --URL

--json

domain auth silo view¶

View an authentication silo on the domain.

-H, --URL

--name

domain auth silo create¶

Create authentication silos on the domain.

-H, --URL

--name

--description

--user-authentication-policy

--service-authentication-policy

--computer-authentication-policy

--protect

--unprotect

--audit

--enforce

domain auth silo modify¶

Modify authentication silos on the domain.

-H, --URL

--name

--description

--user-authentication-policy

--service-authentication-policy

--computer-authentication-policy

--protect

--unprotect

--audit

--enforce

domain auth silo delete¶

Delete authentication silos on the domain.

-H, --URL

--name

--force

domain auth silo member grant¶

Grant a member access to an authentication silo.

-H, --URL

--name

--member

domain auth silo member list¶

List members in an authentication silo.

-H, --URL

--name

--json

domain auth silo member revoke¶

Revoke a member from an authentication silo.

-H, --URL

--name

--member

domain claim claim-type list¶

List claim types on the domain.

-H, --URL

--json

domain claim claim-type view¶

View a single claim type on the domain.

-H, --URL

--name

domain claim claim-type create¶

Create claim types on the domain.

-H, --URL

--attribute

--class

--name

--description

--enable

--disable

--protect

--unprotect

domain claim claim-type modify¶

Modify claim types on the domain.

-H, --URL

--name

--class

--description

--enable

--disable

--protect

--unprotect

domain claim claim-type delete¶

Delete claim types on the domain.

-H, --URL

--name

--force

domain claim value-type list¶

List claim value types on the domain.

-H, --URL

--json

domain claim value-type view¶

View a single claim value type on the domain.

-H, --URL

--name

service-account¶

Service account management.

service-account list¶

List service accounts on the domain.

-H, --URL

--json

service-account view¶

View a single service account on the domain.

-H, --URL

--name

service-account create¶

Create a new service account on the domain.

-H, --URL

--name

--dns-host-name

--group-msa-membership

--managed-password-interval

service-account modify¶

Modify an existing service account on the domain.

-H, --URL

--name

--dns-host-name

--group-msa-membership

service-account delete¶

Delete a service accounts on the domain.

-H, --URL

--name

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

--name

--json

service-account group-msa-membership add¶

Add a principal to Group MSA Membership for a service account.

-H, --URL

--name

--principal

service-account group-msa-membership remove¶

Remove a principal from Group MSA Membership for a service account.

-H, --URL

--name

--principal

domain classicupgrade [options] classic_smb_conf¶

Upgrade from Samba classic (NT4-like) database to Samba AD DC database.

domain dcpromo dnsdomain [DC|RODC] [options]¶

Promote an existing domain member or NT4 PDC to an AD DC.

domain demote¶

Demote ourselves from the role of domain controller.

domain exportkeytab keytab [options]¶

Dumps Kerberos keys of the domain into a keytab.

domain info ip_address [options]¶

Print basic info about a domain and the specified DC.

domain join dnsdomain [DC|RODC|MEMBER|SUBDOMAIN] [options]¶

Join a domain as either member or backup domain controller.

domain level show|raise options [options]¶

Show/raise domain and forest function levels.

domain passwordsettings show|set options [options]¶

Show/set password settings.

domain passwordsettings pso¶

Manage fine-grained Password Settings Objects (PSOs).

domain passwordsettings pso apply pso-name user-or-group-name [options]¶

Applies a PSO's password policy to a user or 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 group.

domain provision¶

Promote an existing domain member or NT4 PDC to an AD DC.

domain trust¶

Domain and forest trust management.

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).

drs bind¶

Show DRS capabilities of a server.

drs kcc¶

Trigger knowledge consistency center run.

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.

drs showrepl¶

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

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.

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).

fsmo seize [options]¶

Seize the role.

fsmo show¶

Show the roles.

fsmo transfer [options]¶

Transfer the role.

gpo¶

Manage Group Policy Objects (GPO).

gpo create displayname [options]¶

Create an empty GPO.

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.

gpo listcontainers gpo [options]¶

List all linked containers for a GPO.

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 show gpo [options]¶

Show information for a GPO.

gpo manage symlink list¶

List VGP Symbolic Link Group Policy from the sysvol

gpo manage symlink add¶

Adds a VGP Symbolic Link Group Policy to the sysvol

gpo manage symlink remove¶

Removes a VGP Symbolic Link Group Policy from the sysvol

gpo manage files list¶

List VGP Files Group Policy from the sysvol

gpo manage files add¶

Add VGP Files Group Policy to the sysvol

gpo manage files remove¶

Remove VGP Files Group Policy from the sysvol

gpo manage openssh list¶

List VGP OpenSSH Group Policy from the sysvol

gpo manage openssh set¶

Sets a VGP OpenSSH Group Policy to the sysvol

gpo 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 sysvol

gpo manage scripts startup add¶

Adds VGP Startup Script Group Policy to the sysvol

gpo manage scripts startup remove¶

Removes VGP Startup Script Group Policy from the sysvol

gpo manage motd list¶

List VGP MOTD Group Policy from the sysvol.

gpo manage motd set¶

Sets a VGP MOTD Group Policy to the sysvol

gpo manage issue list¶

List VGP Issue Group Policy from the sysvol.

gpo manage issue set¶

Sets a VGP Issue Group Policy to the sysvol

gpo manage access add¶

Adds a VGP Host Access Group Policy to the sysvol

gpo manage access list¶

List VGP Host Access Group Policy from the sysvol

gpo manage access remove¶

Remove a VGP Host Access Group Policy from the sysvol

group¶

Manage groups.

group add groupname [options]¶

Create a new AD group.

group create groupname [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.

group addmembers groupname members [options]¶

Add members to an AD group.

group delete groupname [options]¶

Delete an AD group.

group edit groupname¶

Edit a group AD object.

--editor=EDITOR

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

--hide-expired

--hide-disabled

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

--reset-cn

--mail-address=MAIL_ADDRESS

--samaccountname=SAMACCOUNTNAME

ldapcmp URL1 URL2 domain|configuration|schema|dnsdomain|dnsforest [options]¶

Compare two LDAP databases.

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

--service=SERVICE

--use-s3fs

--xattr-backend=[native|tdb]

--eadb-file=EADB_FILE

--recursive

--follow-symlinks

--verbose

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

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.

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

ou list [options]¶

List all organizational units.

--full-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

-r|--recursive

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.

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.

shell¶

Opens an interactive Samba Python shell.

shell [options]¶

Opens an interactive Python shell for Samba ldb connection.

-H, --URL

sites¶

Manage sites.

sites list [options]¶

List sites.

--json

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

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 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.

user edit username¶

Edit a user account AD object.

--editor=EDITOR

user enable username¶

Enable a user account.

user list¶

List all users.

By default the user's sAMAccountNames are listed.

--full-dn

-b BASE_DN|--base-dn=BASE_DN

--hide-expired

--hide-disabled

--locked-only

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

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

--given-name=GIVEN_NAME

--initials=INITIALS

--force-new-cn=NEW_CN

--reset-cn

--display-name=DISPLAY_NAME

--mail-address=MAIL_ADDRESS

--samaccountname=SAMACCOUNTNAME

--upn=UPN

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

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

user auth silo remove username¶

Remove assigned authentication silo from user.

user auth silo view username¶

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.

MODES OF OPERATION¶

samba-tool visualize ntdsconn

samba-tool visualize reps

samba-tool visualize uptodateness

GRAPHICAL MODES¶

--distance

--dot

--xdot

-r

help¶

Gives usage information.