Cluster Server 8.0 Bundled Agents Reference Guide - Windows
- Introducing VCS bundled agents
- Storage agents
- Network agents
- FileShare agents
- Services and applications agents
- VCS infrastructure and support agents
- VCS hardware replication agent for NetApp
- Troubleshooting bundled agents
Attribute definitions
Table: FileShare agent required attributes
Required Attributes | Description |
|---|---|
LanmanResName | The name of the Lanman resource on which the FileShare resource depends. If this attribute is not specified, the agent ignores this attribute and uses localhost. Type and Dimension: string-scalar |
MountResName | The name of the MountV resource on which the FileShare resource depends. For NetApp storage, this is the NetAppSnapDrive resource name. In case of Logical Disk Management, this is the Mount resource name. Type and Dimension: string-scalar |
PathName | The path of the folder to be shared. To share a drive, specify the PathName as \. For example, to share drive X:, the PathName is \. To share a folder on a mounted drive, specify the PathName as \directoryname. Note: This attribute can take localized values. Type and Dimension: string-scalar |
ShareName | The name by which the share is known to clients. Note: This attribute can take localized values. Type and Dimension: string-scalar |
Table: FileShare agent optional attributes
Optional Attributes | Description |
|---|---|
AutoControl |
Defines the agent behavior when share properties are modified (either within or from outside VCS) when the FileShare resource is online. The value 1 indicates that the agent synchronizes the changes made to the share properties with those that were defined while configuring the file share service group in the cluster. The value 0 indicates that the agent does not synchronize the share properties as per what is defined in the cluster configuration. If this attribute is set to 0 and the share properties are modified (either within or from outside VCS), the FileShare resource goes into the UNKNOWN state. The changes made to the share properties remain in effect until the resource is in the UNKNOWN state. To restore the state, you have to take the FileShare resource offline and bring it online again. When the resource is brought online, the agent restores the share properties as per what is defined in the cluster configuration. Default is 1. To make an existing share highly available, the share name and the share permissions in the configuration file must be the same as those for the file share. Type and Dimension: boolean-scalar |
AutoShare | Defines agent behavior when a folder with shared subfolders is added to a VCS file share. The value 1 indicates the agent automatically shares the newly added subfolder in its next monitor cycle. The value 0 indicates the agent does not. Default is 1. This attribute is considered only if the attribute ShareSubdirectories is set to 1. Type and Dimension: boolean-scalar |
ClientCacheType | A string that specifies whether the files and programs in the shared folder are cached locally on the client computer when accessed by users. It also specifies how the files are cached. The cached files are then available offline even if users are not connected to the share. Note: The agent does not cache the files or programs itself. It sets the value so that the server and client interfaces do the needful. This attribute can have the following values:
Default is MANUAL. Type and Dimension: string-scalar |
HiddenShare | Defines whether the agent hides the file share. The value 1 indicates the agent hides the file share. The value 0 indicates it does not. Default is 0. Note: To create a hidden share, set the HiddenShare attribute to 1. Do not append the share name with a $ (dollar) sign. Type and Dimension: boolean-scalar |
HideChildShares | Defines whether the agent hides the subfolder shares. The value 1 indicates the agent hides the subfolder shares. The value 0 indicates it does not. Default is 0. This attribute is considered only if the attribute ShareSubdirectories is set to 1. Type and Dimension: boolean-scalar |
IgnorePermissions | This attribute has been deprecated. Please use AutoControl attribute instead. Type and Dimension: boolean-scalar |
MaxUsers | The maximum number of users that can access the file share. Default is null, which indicates access is granted to maximum users allowed on Windows. If this attribute is set to zero or greater than the maximum users allowed on Windows, access is granted to the maximum users allowed on Windows. Type and Dimension: string-scalar |
ShareSubdirectories | Defines whether the agent shares the subfolders of the file shares defined in the attribute PathName and ShareName. Subfolders are shared with their own names, that is, the share name of a subfolder is the same as the subfolder name. If a share with the same name exists, the subfolder will not be shared. However, this does not affect the state of the resource. The value 1 indicates the agent shares the subfolders. The value 0 indicates it does not. Default is 0. Note: Sharing a folder with a large number of subfolders and enabling the ShareSubdirectories attribute may cause increased failover time and high CPU and memory utilization. Type and Dimension: boolean-scalar |
UserPermissions | The permissions with which the folders are shared for users. The following permissions are associated with the FileShare resource:
The UserPermissions are specified in the format 'Domain_Name\Username'=Permission. For example, to give full control to user John who belongs to the domain vcs_domain, the syntax is 'VCS_DOMAIN\John'=FULL_CONTROL. The domain name and the user name must be enclosed in quotation marks. Default is {'Everyone' = READ_ACCESS}. A maximum of 50 users can be configured for each file share. To configure more than 50 users for a file share, configure user groups. Note that the agent monitors only the users and the permissions that are defined in the VCS configuration. Note: This attribute can take localized values. Type and Dimension: string-association |
AccessBasedEnumeration | Defines whether the agent enables the Windows Access-based Enumeration option for the specified file share. The value 1 indicates that the agent enables it and the value 0 indicates that the agent does not. Default is 0. Type and Dimension: boolean-scalar |
ShareComment |
A string that describes the share. Use this attribute to add comments to the file share resource. If this attribute is blank, the agent uses the default VCS comment. Type and Dimension: string-scalar |