'\" t .\" Title: ocf_heartbeat_smb-share .\" Author: ClusterLabs contributors (see the resource agent source for information about individual authors) .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 03/13/2024 .\" Manual: OCF resource agents .\" Source: resource-agents 4.13.0-1+b1 .\" Language: English .\" .TH "OCF_HEARTBEAT_SMB\-S" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" ocf_heartbeat_smb-share \- Manages samba shares on the fly .SH "SYNOPSIS" .HP \w'\fBsmb\-share\fR\ 'u \fBsmb\-share\fR [start | stop | status | monitor | meta\-data | validate\-all] .SH "DESCRIPTION" .PP 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\&. .PP 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: .PP include = /etc/samba/conf\&.d/pacemaker\-includes\&.conf .PP The filename can be changed by setting the parameter includesfile\&. Every share created by this RA will create a new file located in: .PP /etc/samba/conf\&.d/ .PP This directory also can be changed by setting the RA parameter confd\&. .SH "SUPPORTED PARAMETERS" .PP \fBshare\fR .RS 4 Set the name of a windows share which should be added to Samba example name "myshare" resulting in [myshare]\&. .sp (unique, required, string, no default) .RE .PP \fBpath\fR .RS 4 Set the path to share for cifs clients\&. example path "/srv/data/myshare"\&. .sp (unique, optional, string, no default) .RE .PP \fBhosts_allow\fR .RS 4 This parameter is a comma, space, or tab delimited set of hosts which are permitted to access a service\&. .sp (optional, string, no default) .RE .PP \fBbrowseable\fR .RS 4 This controls whether this share is seen in the list of available shares in a net view and in the browse list\&. .sp (optional, string, no default) .RE .PP \fBwriteable\fR .RS 4 Inverted synonym for read only\&. .sp (optional, string, no default) .RE .PP \fBread_only\fR .RS 4 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\&. .sp (optional, string, no default) .RE .PP \fBguest_ok\fR .RS 4 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\&. .sp (optional, string, no default) .RE .PP \fBdirectory_mask\fR .RS 4 This parameter is the octal modes which are used when converting DOS modes to UNIX modes when creating UNIX directories\&. .sp (optional, string, no default) .RE .PP \fBcreate_mask\fR .RS 4 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\&. .sp (optional, string, no default) .RE .PP \fBprintable\fR .RS 4 If this parameter is yes, then clients may open, write to and submit spool files on the directory specified for the service\&. .sp (optional, string, no default) .RE .PP \fBvalid_users\fR .RS 4 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\&. .sp (optional, string, no default) .RE .PP \fBforce_user\fR .RS 4 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\&. .sp (optional, string, no default) .RE .PP \fBforce_group\fR .RS 4 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\&. .sp (optional, string, no default) .RE .PP \fBextraopt\fR .RS 4 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 .sp (optional, string, no default) .RE .PP \fBextraopt_list\fR .RS 4 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 .sp (optional, string, no default) .RE .PP \fBoutfile\fR .RS 4 Set the path and filename where the snipped should be written\&. example "/etc/samba/conf\&.d/myshare\&.inc"\&. .sp (unique, required, string, no default) .RE .PP \fBconfd\fR .RS 4 Set the path where the includes will be written\&. This folder have to be a tmpfs mount This defaults to "/etc/samba/conf\&.d"\&. .sp (optional, string, default "/etc/samba/conf\&.d") .RE .PP \fBincludesfile\fR .RS 4 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 .sp (optional, string, default "/etc/samba/conf\&.d/pacemaker\-includes\&.conf") .RE .SH "SUPPORTED ACTIONS" .PP This resource agent supports the following actions (operations): .PP \fBstart\fR .RS 4 Starts the resource\&. Suggested minimum timeout: 20s\&. .RE .PP \fBstop\fR .RS 4 Stops the resource\&. Suggested minimum timeout: 20s\&. .RE .PP \fBstatus\fR .RS 4 Performs a status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&. .RE .PP \fBmonitor\fR .RS 4 Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&. .RE .PP \fBmeta\-data\fR .RS 4 Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&. .RE .PP \fBvalidate\-all\fR .RS 4 Performs a validation of the resource configuration\&. Suggested minimum timeout: 20s\&. .RE .SH "EXAMPLE CRM SHELL" .PP The following is an example configuration for a smb\-share resource using the \fBcrm\fR(8) shell: .sp .if n \{\ .RS 4 .\} .nf primitive p_smb\-share ocf:heartbeat:smb\-share \e params \e share=\fIstring\fR \e outfile=\fIstring\fR \e op monitor depth="0" timeout="20s" interval="10s" .fi .if n \{\ .RE .\} .SH "EXAMPLE PCS" .PP The following is an example configuration for a smb\-share resource using \fBpcs\fR(8) .sp .if n \{\ .RS 4 .\} .nf pcs resource create p_smb\-share ocf:heartbeat:smb\-share \e share=\fIstring\fR \e outfile=\fIstring\fR \e op monitor OCF_CHECK_LEVEL="0" timeout="20s" interval="10s" .fi .if n \{\ .RE .\} .SH "SEE ALSO" .PP \m[blue]\fB\%http://clusterlabs.org/\fR\m[] .SH "AUTHOR" .PP \fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR