Provided by: resource-agents-extra_4.11.0-1ubuntu1_amd64 
NAME
ocf_heartbeat_smb-share - Manages samba shares on the fly
SYNOPSIS
smb-share [start | stop | status | monitor | meta-data | validate-all]
DESCRIPTION
This RA is used to control samba shares on the fly. For adding and removing samba shares
no restart of the samba daemon is needed. This is the equivalent of the exportfs RA which
is used for nfs shares.
For this RA to work as expected you need a cloned samba daemon which have to be startet
before. After this RA manages config snippets placed in the filesystem and after a fence
of that node these snippets will still located there you will have to use a tmpfs mount
for this. Also you need a basic smb.conf file in which all global parameters an permanent
shares should be placed. Within this smb.conf also you must put a line in the global
section like this:
include = /etc/samba/conf.d/pacemaker-includes.conf
The filename can be changed by setting the parameter includesfile. Every share created by
this RA will create a new file located in:
/etc/samba/conf.d/
This directory also can be changed by setting the RA parameter confd.
SUPPORTED PARAMETERS
share
Set the name of a windows share which should be added to Samba example name "myshare"
resulting in [myshare].
(unique, required, string, no default)
path
Set the path to share for cifs clients. example path "/srv/data/myshare".
(unique, optional, string, no default)
hosts_allow
This parameter is a comma, space, or tab delimited set of hosts which are permitted to
access a service.
(optional, string, no default)
browseable
This controls whether this share is seen in the list of available shares in a net view
and in the browse list.
(optional, string, no default)
writeable
Inverted synonym for read only.
(optional, string, no default)
read_only
This option can be used to turn the writing backends tdb, tdb2, and ldap into read
only mode. This can be useful e.g. in cases where a pre-filled database exists that
should not be extended automatically.
(optional, string, no default)
guest_ok
If this parameter is yes for a service, then no password is required to connect to the
service. Privileges will be those of the guest account.
(optional, string, no default)
directory_mask
This parameter is the octal modes which are used when converting DOS modes to UNIX
modes when creating UNIX directories.
(optional, string, no default)
create_mask
When a file is created, the necessary permissions are calculated according to the
mapping from DOS modes to UNIX permissions, and the resulting UNIX mode is then
bit-wise ANDed with this parameter. This parameter may be thought of as a bit-wise
MASK for the UNIX modes of a file.
(optional, string, no default)
printable
If this parameter is yes, then clients may open, write to and submit spool files on
the directory specified for the service.
(optional, string, no default)
valid_users
This is a list of users that should be allowed to login to this service. Names
starting with @, + and & are interpreted using the same rules as described in the
invalid users parameter.
(optional, string, no default)
force_user
This specifies a UNIX user name that will be assigned as the default user for all
users connecting to this service. This is useful for sharing files.
(optional, string, no default)
force_group
This specifies a UNIX group name that will be assigned as the default primary group
for all users connecting to this service. This is useful for sharing files by ensuring
that all access to files on service will use the named group for their permissions
checking.
(optional, string, no default)
extraopt
This option can be used to define an additional key = value pair. In this parameter
also a semicolon could be placed. Need to set e.g somthinspecial = value
(optional, string, no default)
extraopt_list
This option can be used to define multiple additional key = value pairs. Define the
list of element semicolon separated. e.g somethingspecial = value;one more = value2
(optional, string, no default)
outfile
Set the path and filename where the snipped should be written. example
"/etc/samba/conf.d/myshare.inc".
(unique, required, string, no default)
confd
Set the path where the includes will be written. This folder have to be a tmpfs mount
This defaults to "/etc/samba/conf.d".
(optional, string, default "/etc/samba/conf.d")
includesfile
Set the path and filename in which the include should be placed. example includesfile
"/etc/samba/conf.d/pacemaker-includes.conf". This option manages the include=
parameter within this file
(optional, string, default "/etc/samba/conf.d/pacemaker-includes.conf")
SUPPORTED ACTIONS
This resource agent supports the following actions (operations):
start
Starts the resource. Suggested minimum timeout: 20s.
stop
Stops the resource. Suggested minimum timeout: 20s.
status
Performs a status check. Suggested minimum timeout: 20s. Suggested interval: 10s.
monitor
Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval:
10s.
meta-data
Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.
validate-all
Performs a validation of the resource configuration. Suggested minimum timeout: 20s.
EXAMPLE CRM SHELL
The following is an example configuration for a smb-share resource using the crm(8) shell:
primitive p_smb-share ocf:heartbeat:smb-share \
params \
share=string \
outfile=string \
op monitor depth="0" timeout="20s" interval="10s"
EXAMPLE PCS
The following is an example configuration for a smb-share resource using pcs(8)
pcs resource create p_smb-share ocf:heartbeat:smb-share \
share=string \
outfile=string \
op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s"
SEE ALSO
http://clusterlabs.org/
AUTHOR
ClusterLabs contributors (see the resource agent source for information about individual
authors)