From 8e259891d6ae5c94ab5bc549cbbc1a7e9efb34de Mon Sep 17 00:00:00 2001 From: Karolin Seeger Date: Mon, 8 Oct 2012 11:57:40 +0200 Subject: docs: Add man 8 samba-tool. Addresses bug #8802 - Create missing manpages for new binaries. Please note that it's a very basic version. Please feel free to extend. Karolin --- docs-xml/manpages/samba-tool.8.xml | 613 +++++++++++++++++++++++++++++++++++++ 1 file changed, 613 insertions(+) create mode 100644 docs-xml/manpages/samba-tool.8.xml (limited to 'docs-xml') diff --git a/docs-xml/manpages/samba-tool.8.xml b/docs-xml/manpages/samba-tool.8.xml new file mode 100644 index 0000000000..c312ff07c6 --- /dev/null +++ b/docs-xml/manpages/samba-tool.8.xml @@ -0,0 +1,613 @@ + + + + + + samba-tool + 8 + Samba + System Administration tools + 4.0 + + + + + samba-tool + Main Samba administration tool. + + + + + + samba-tool + -h + -W myworkgroup + -U user + -d debuglevel + --v + + + + + DESCRIPTION + This tool is part of the samba + 7 suite. + + + + OPTIONS + + + + + -h|--help + + Show this help message and exit + + + + + -s FILE|--configfile=FILE + + Configuration file + + + + + -d DEBUGLEVEL|--debuglevel=DEBUGLEVEL + + Debug Level + + + + + --option=OPTION + + Set smb.conf option from command line + + + + + --realm=REALM + + Set the realm name + + + + + --simple-bind-dn=DN + + DN to use for a simple bind + + + + + --password=PASSWORD + + Password + + + + + -U USERNAME|--username=USERNAME + + Username + + + + + -W WORKGROUP|--workgroup=WORKGROUP + + Workgroup + + + + + -N|--no-pass + + Don't ask for a password + + + + + -k KERBEROS|--kerberos=KERBEROS + + Use Kerberos + + + + + --ipaddress=IPADDRESS + + IP address of the server + + + + + --version + + Display version number + + + + + + + +COMMANDS + + + dbcheck + Check the local AD database for errors. + + + + delegation + Manage Delegations. + + + + delegation add-service <replaceable>accountname</replaceable> <replaceable>principal</replaceable> [options] + Add a service principal as msDS-AllowedToDelegateTo. + + + + delegation del-service <replaceable>accountname</replaceable> <replaceable>principal</replaceable> [options] + Delete a service principal as msDS-AllowedToDelegateTo. + + + + delegation for-any-protocol <replaceable>accountname</replaceable> [(on|off)] [options] + Set/unset UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION (S4U2Proxy) + for an account. + + + + delegation for-any-service <replaceable>accountname</replaceable> [(on|off)] [options] + Set/unset UF_TRUSTED_FOR_DELEGATION for an account. + + + + delegation show <replaceable>accountname</replaceable> [options] + Show the delegation setting of an account. + + + + dns + Manage Domain Name Service (DNS). + + + + dns add <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT</replaceable> <replaceable>data</replaceable> + Add a DNS record. + + + + dns delete <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT</replaceable> <replaceable>data</replaceable> + Delete a DNS record. + + + + dns query <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT|ALL</replaceable> [options] <replaceable>data</replaceable> + Query a name. + + + + dns roothints <replaceable>server</replaceable> [<replaceable>name</replaceable>] [options] + Query root hints. + + + + dns serverinfo <replaceable>server</replaceable> [options] + Query server information. + + + + dns update <replaceable>server</replaceable> <replaceable>zone</replaceable> <replaceable>name</replaceable> <replaceable>A|AAAA|PTR|CNAME|NS|MX|SRV|TXT</replaceable> <replaceable>olddata</replaceable> <replaceable>newdata</replaceable> + Update a DNS record. + + + + dns zonecreate <replaceable>server</replaceable> <replaceable>zone</replaceable> [options] + Create a zone. + + + + dns zonedelete <replaceable>server</replaceable> <replaceable>zone</replaceable> [options] + Delete a zone. + + + + dns zoneinfo <replaceable>server</replaceable> <replaceable>zone</replaceable> [options] + Query zone information. + + + + dns zonelist <replaceable>server</replaceable> [options] + List zones. + + + + domain + Manage Domain. + + + + domain classicupgrade [options] <replaceable>classic_smb_conf</replaceable> + Upgrade from Samba classic (NT4-like) database to Samba AD DC + database. + + + + domain dcpromo <replaceable>dnsdomain</replaceable> [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 <replaceable>keytab</replaceable> [options] + Dumps Kerberos keys of the domain into a keytab. + + + + domain info <replaceable>ip_address</replaceable> [options] + Print basic info about a domain and the specified DC. + + + + + domain join <replaceable>dnsdomain</replaceable> [DC|RODC|MEMBER|SUBDOMAIN] [options] + Join a domain as either member or backup domain controller. + + + + domain level <replaceable>show|raise</replaceable> <replaceable>options</replaceable> [options] + Show/raise domain and forest function levels. + + + + domain passwordsettings <replaceable>show|set</replaceable> <replaceable>options</replaceable> [options] + Show/set password settings. + + + + domain provision + Promote an existing domain member or NT4 PDC to an AD DC. + + + + 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 <replaceable>destination_DC</replaceable> <replaceable>source_DC</replaceable> <replaceable>NC</replaceable> [options] + Replicate a naming context between two DCs. + + + + drs showrepl + Show replication status. + + + + dsacl + Administer DS ACLs + + + + dsacl set + Modify access list on a directory object. + + + + 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 <replaceable>displayname</replaceable> [options] + Create an empty GPO. + + + + gpo del <replaceable>gpo</replaceable> [options] + Delete GPO. + + + + gpo dellink <replaceable>container_dn</replaceable> <replaceable>gpo</replaceable> [options] + Delete GPO link from a container. + + + + gpo fetch <replaceable>gpo</replaceable> [options] + Download a GPO. + + + + gpo getinheritance <replaceable>container_dn</replaceable> [options] + Get inheritance flag for a container. + + + + gpo getlink <replaceable>container_dn</replaceable> [options] + List GPO Links for a container. + + + + gpo list <replaceable>username</replaceable> [options] + List GPOs for an account. + + + + gpo listall + List all GPOs. + + + + gpo listcontainers <replaceable>gpo</replaceable> [options] + List all linked containers for a GPO. + + + + gpo setinheritance <replaceable>container_dn</replaceable> <replaceable>block|inherit</replaceable> [options] + Set inheritance flag on a container. + + + + gpo setlink <replaceable>container_dn</replaceable> <replaceable>gpo</replaceable> [options] + Add or Update a GPO link to a container. + + + + gpo show <replaceable>gpo</replaceable> [options] + Show information for a GPO. + + + + group + Manage groups. + + + + group add <replaceable>groupname</replaceable> [options] + Create a new AD group. + + + + group addmembers <replaceable>groupname</replaceable> <replaceable>members</replaceable> [options] + Add members to an AD group. + + + + group delete <replaceable>groupname</replaceable> [options] + Delete an AD group. + + + + group list + List all groups. + + + + group listmembers <replaceable>groupname</replaceable> [options] + List all members of the specified AD group. + + + + group removemembers <replaceable>groupname</replaceable> <replaceable>members</replaceable> [options] + Remove members from the specified AD group. + + + + ldapcmp <replaceable>URL1</replaceable> <replaceable>URL2</replaceable> <replaceable>domain|configuration|schema|dnsdomain|dnsforest</replaceable> [options] + Compare two LDAP databases. + + + + ntacl + Manage NT ACLs. + + + + ntacl get <replaceable>file</replaceable> [options] + Get ACLs on a file. + + + + ntacl set <replaceable>acl</replaceable> <replaceable>file</replaceable> [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). + + + + rodc + Manage Read-Only Domain Controller (RODC). + + + + rodc preload <replaceable>SID</replaceable>|<replaceable>DN</replaceable>|<replaceable>accountname</replaceable> [options] + Preload one account for an RODC. + + + + sites + Manage sites. + + + + sites create <replaceable>site</replaceable> [options] + Create a new site. + + + + sites remove <replaceable>site</replaceable> [options] + Delete an esxisting site. + + + + spn + Manage Service Principal Names (SPN). + + + + spn add <replaceable>name</replaceable> <replaceable>user</replaceable> [options] + Create a new SPN. + + + + spn delete <replaceable>name</replaceable> [<replaceable>user</replaceable>] [options] + Delete an existing SPN. + + + + spn list <replaceable>user</replaceable> [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 <replaceable>username</replaceable> [<replaceable>password</replaceable>] + Create a new user. Please note that this subcommand is deprecated + and available for compatibility reasons only. Please use + samba-tool user create instead. + + + + user create <replaceable>username</replaceable> [<replaceable>password</replaceable>] + Create a new user in the Active Directory Domain. + + + + user delete <replaceable>username</replaceable> [options] + Delete an existing user account. + + + + user disable <replaceable>username</replaceable> + Disable an user account. + + + + user enable <replaceable>username</replaceable> + Enable an user account. + + + + user list + List all users. + + + + user password [options] + Change password for an user account (the one provided in + authentication). + + + + user setexpiry <replaceable>username</replaceable> [options] + Set the expiration of an user account. + + + + user setpassword <replaceable>username</replaceable> [options] + Sets or resets the password of an user account. + + + + vampire [options] <replaceable>domain</replaceable> + 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. + + + +help +Gives usage information. + + + + + + VERSION + + This man page is complete for version 4 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. + + The samba-tool manpage was written by Karolin Seeger. + + + -- cgit