From 0360ec2b48b1e0a2cbed4b4cf38b914c291ea39d Mon Sep 17 00:00:00 2001 From: Bert Van Vreckem Date: Thu, 16 Aug 2018 21:31:32 +0200 Subject: [PATCH] Add documentation for new role variables samba_printer_type and samba_cups_server --- README.md | 54 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 3eb250a..08905d0 100644 --- a/README.md +++ b/README.md @@ -31,32 +31,34 @@ No specific requirements ## Role Variables -| Variable | Default | Comments | -| :--- | :--- | :--- | -| `samba_create_varwww_symlinks` | false | When true, symlinks are created in web docroot to the shares.(`var/www/` or `/var/www/html` depending on platform) | -| `samba_domain_master` | true | When true, smbd enables WAN-wide browse list collation | -| `samba_guest_account` | - | Guest account for unknown users | -| `samba_interfaces` | [] | List of network interfaces used for browsing, name registration, etc. | -| `samba_load_homes` | false | When true, user home directories are accessible. | -| `samba_load_printers` | false | When true, printers attached to the host are shared | -| `samba_local_master` | true | When true, nmbd will try & become local master of the subnet | -| `samba_log_size` | 5000 | Set the maximum size of the log file. | -| `samba_log` | - | Set the log file. If left undefined, logging is done through syslog. | -| `samba_map_to_guest` | `bad user` | Behaviour when unregistered users access the shares. | -| `samba_mitigate_cve_2017_7494` | true | CVE-2017-7494 mitigation breaks some clients, such as macOS High Sierra. | -| `samba_netbios_name` | `{{ ansible_hostname }}` | The NetBIOS name of this server. | -| `samba_passdb_backend` | `tdbsam` | Password database backend. | -| `samba_preferred_master` | true | When true, indicates nmbd is a preferred master browser for workgroup | -| `samba_realm` | - | Realm domain name | -| `samba_security` | `user` | Samba security setting | -| `samba_server_max_protocol` | - | Specify a maximum protocol version offered by the server. | -| `samba_server_min_protocol` | - | Specify a minimum protocol version offered by the server. | -| `samba_server_string` | `fileserver %m` | Comment string for the server. | -| `samba_shares_root` | `/srv/shares` | Directories for the shares are created under this directory. | -| `samba_shares` | [] | List of dicts containing share definitions. See below for details. | -| `samba_users` | [] | List of dicts defining users that can access shares. | -| `samba_wins_support` | true | When true, Samba will act as a WINS server | -| `samba_workgroup` | `WORKGROUP` | Name of the server workgroup. | +| Variable | Default | Comments | +| :--- | :--- | :--- | +| `samba_create_varwww_symlinks` | false | When true, symlinks are created in web docroot to the shares. (`var/www/` or `/var/www/html` depending on platform) | +| `samba_cups_server` | localhost:631 | Value for the global option `cups server` (only needed when `samba_printer_type` is "cups") | +| `samba_domain_master` | true | When true, smbd enables WAN-wide browse list collation | +| `samba_guest_account` | - | Guest account for unknown users | +| `samba_interfaces` | [] | List of network interfaces used for browsing, name registration, etc. | +| `samba_load_homes` | false | When true, user home directories are accessible. | +| `samba_load_printers` | false | When true, printers attached to the host are shared | +| `samba_local_master` | true | When true, nmbd will try & become local master of the subnet | +| `samba_log_size` | 5000 | Set the maximum size of the log file. | +| `samba_log` | - | Set the log file. If left undefined, logging is done through syslog. | +| `samba_map_to_guest` | `bad user` | Behaviour when unregistered users access the shares. | +| `samba_mitigate_cve_2017_7494` | true | CVE-2017-7494 mitigation breaks some clients, such as macOS High Sierra. | +| `samba_netbios_name` | `{{ ansible_hostname }}` | The NetBIOS name of this server. | +| `samba_passdb_backend` | `tdbsam` | Password database backend. | +| `samba_preferred_master` | true | When true, indicates nmbd is a preferred master browser for workgroup | +| `samba_realm` | - | Realm domain name | +| `samba_printer_type` | cups | value for the global option `printing` and `printcap name` | +| `samba_security` | `user` | Samba security setting | +| `samba_server_max_protocol` | - | Specify a maximum protocol version offered by the server. | +| `samba_server_min_protocol` | - | Specify a minimum protocol version offered by the server. | +| `samba_server_string` | `fileserver %m` | Comment string for the server. | +| `samba_shares_root` | `/srv/shares` | Directories for the shares are created under this directory. | +| `samba_shares` | [] | List of dicts containing share definitions. See below for details. | +| `samba_users` | [] | List of dicts defining users that can access shares. | +| `samba_wins_support` | true | When true, Samba will act as a WINS server | +| `samba_workgroup` | `WORKGROUP` | Name of the server workgroup. | ### Defining users