Worksheet for gathering SMB configuration information

10/23/2021 Contributors

The SMB configuration worksheet enables you to collect the required information to set up SMB access for clients.

You should complete one or both sections of the worksheet, depending on the decision you made about where to provision storage:

If you are configuring SMB access to an SVM, you should complete both sections.

Configuring SMB access to an SVM

Configuring SMB client access to shared storage
If you are adding storage capacity to an SMB-enabled SVM, you should complete only the second section.

Configuring SMB client access to shared storage

The command man pages contain details about the parameters.

Configuring SMB access to an SVM

Parameters for creating an SVM

You supply these values with the vserver create command if you are creating a new SVM.

Field Description Your value

Field	Description	Your value
`-vserver`	A name you supply for the new SVM that is either a fully qualified domain name (FQDN) or follows another convention that enforces unique SVM names across a cluster.
`-aggregate`	The name of an aggregate in the cluster with sufficient space for new SMB storage capacity.
`-rootvolume`	A unique name you supply for the SVM root volume.
`-rootvolume-security-style`	Use the NTFS security style for the SVM.	`ntfs`
`-language`	Use the default language setting in this workflow.	`C.UTF-8`
`ipspace`	Optional: IPspaces are distinct IP address spaces in which SVMs reside.

-vserver

A name you supply for the new SVM that is either a fully qualified domain name (FQDN) or follows another convention that enforces unique SVM names across a cluster.

-aggregate

The name of an aggregate in the cluster with sufficient space for new SMB storage capacity.

-rootvolume

A unique name you supply for the SVM root volume.

-rootvolume-security-style

Use the NTFS security style for the SVM.

ntfs

-language

Use the default language setting in this workflow.

C.UTF-8

ipspace

Optional: IPspaces are distinct IP address spaces in which SVMs reside.

Parameters for creating a LIF

You supply these values with the network interface create command when you are creating LIFs.

Field Description Your value

Field	Description	Your value
`-lif`	A name you supply for the new LIF.
`-role`	Use the data LIF role in this workflow.	`data`
`-data-protocol`	Use only the SMB protocol in this workflow.	`cifs`
`-home-node`	The node to which the LIF returns when the `network interface revert` command is run on the LIF.
`-home-port`	The port or interface group to which the LIF returns when the `network interface revert` command is run on the LIF.
`-address`	The IPv4 or IPv6 address on the cluster that will be used for data access by the new LIF.
`-netmask`	The network mask and gateway for the LIF.
`-subnet`	A pool of IP addresses. Used instead of `-address` and `-netmask` to assign addresses and netmasks automatically.
`-firewall-policy`	Use the default data firewall policy in this workflow.	`data`
`-auto-revert`	Optional: Specifies whether a data LIF is automatically reverted to its home node on startup or under other circumstances. The default setting is `false`.

-lif

A name you supply for the new LIF.

-role

Use the data LIF role in this workflow.

data

-data-protocol

Use only the SMB protocol in this workflow.

cifs

-home-node

The node to which the LIF returns when the network interface revert command is run on the LIF.

-home-port

The port or interface group to which the LIF returns when the network interface revert command is run on the LIF.

-address

The IPv4 or IPv6 address on the cluster that will be used for data access by the new LIF.

-netmask

The network mask and gateway for the LIF.

-subnet

A pool of IP addresses. Used instead of -address and -netmask to assign addresses and netmasks automatically.

-firewall-policy

Use the default data firewall policy in this workflow.

data

-auto-revert

Optional: Specifies whether a data LIF is automatically reverted to its home node on startup or under other circumstances. The default setting is false.

Parameters for DNS host name resolution

You supply these values with the vserver services name-service dns create command when you are configuring DNS.

Field Description Your value

Field	Description	Your value
`-domains`	Up to five DNS domain names.
`-name-servers`	Up to three IP addresses for each DNS name server.

-domains

Up to five DNS domain names.

-name-servers

Up to three IP addresses for each DNS name server.

Setting up an SMB server in an Active Directory domain

Parameters for time service configuration

You supply these values with the cluster time-service ntp server create command when you are configuring time services.

Field Description Your value

Field	Description	Your value
`-server`	The host name or IP address of the NTP server for the Active Directory domain.

-server

The host name or IP address of the NTP server for the Active Directory domain.

Parameters for creating an SMB server in an Active Directory domain

You supply these values with the vserver cifs create command when you create a new SMB server and specify domain information.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which to create the SMB server.
`-cifs-server`	The name of the SMB server (up to 15 characters).
`-domain`	The fully qualified domain name (FQDN) of the Active Directory domain to associate with the SMB server.
`-ou`	Optional: The organizational unit within the Active Directory domain to associate with the SMB server. By default, this parameter is set to CN=Computers.
`-netbios-aliases`	Optional: A list of NetBIOS aliases, which are alternate names to the SMB server name.
`-comment`	Optional: A text comment for the server. Windows clients can see this SMB server description when browsing servers on the network.

-vserver

The name of the SVM on which to create the SMB server.

-cifs-server

The name of the SMB server (up to 15 characters).

-domain

The fully qualified domain name (FQDN) of the Active Directory domain to associate with the SMB server.

-ou

Optional: The organizational unit within the Active Directory domain to associate with the SMB server. By default, this parameter is set to CN=Computers.

-netbios-aliases

Optional: A list of NetBIOS aliases, which are alternate names to the SMB server name.

-comment

Optional: A text comment for the server. Windows clients can see this SMB server description when browsing servers on the network.

Setting up an SMB server in a workgroup

Parameters for creating an SMB server in a workgroup

You supply these values with the vserver cifs create command when you create a new SMB server and specify supported SMB versions.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which to create the SMB server.
`-cifs-server`	The name of the SMB server (up to 15 characters).
`-workgroup`	The name of the workgroup (up to 15 characters).
`-comment`	Optional: A text comment for the server. Windows clients can see this SMB server description when browsing servers on the network.

-vserver

The name of the SVM on which to create the SMB server.

-cifs-server

The name of the SMB server (up to 15 characters).

-workgroup

The name of the workgroup (up to 15 characters).

-comment

Optional: A text comment for the server. Windows clients can see this SMB server description when browsing servers on the network.

Parameters for creating local users

You supply these values when you create local users by using the vserver cifs users-and-groups local-user create command. They are required for SMB servers in workgroups and optional in AD domains.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which to create the local user.
`-user-name`	The name of the local user (up to 20 characters).
`-full-name`	Optional: The user's full name. If the full name contains a space, enclose the full name within double quotation marks.
`-description`	Optional: A description for the local user. If the description contains a space, enclose the parameter in quotation marks.
`-is-account-disabled`	Optional: Specifies whether the user account is enabled or disabled. If this parameter is not specified, the default is to enable the user account.

-vserver

The name of the SVM on which to create the local user.

-user-name

The name of the local user (up to 20 characters).

-full-name

Optional: The user's full name. If the full name contains a space, enclose the full name within double quotation marks.

-description

Optional: A description for the local user. If the description contains a space, enclose the parameter in quotation marks.

-is-account-disabled

Optional: Specifies whether the user account is enabled or disabled. If this parameter is not specified, the default is to enable the user account.

Parameters for creating local groups

You supply these values when you create local groups by using the vserver cifs users-and-groups local-group create command. They are optional for SMB servers in AD domains and workgroups.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which to create the local group.
`-group-name`	The name of the local group (up to 256 characters).
`-description`	Optional: A description for the local group. If the description contains a space, enclose the parameter in quotation marks.

-vserver

The name of the SVM on which to create the local group.

-group-name

The name of the local group (up to 256 characters).

-description

Optional: A description for the local group. If the description contains a space, enclose the parameter in quotation marks.

Adding storage capacity to an SMB-enabled SVM

Parameters for creating a volume

You supply these values with the volume create command if you are creating a volume instead of a qtree.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of a new or existing SVM that will host the new volume.
`-volume`	A unique descriptive name you supply for the new volume.
`-aggregate`	The name of an aggregate in the cluster with sufficient space for the new SMB volume.
`-size`	An integer you supply for the size of the new volume.
`-security-style`	Use the NTFS security style for this workflow.	`ntfs`
`-junction-path`	Location under root (/) where the new volume is to be mounted.

-vserver

The name of a new or existing SVM that will host the new volume.

-volume

A unique descriptive name you supply for the new volume.

-aggregate

The name of an aggregate in the cluster with sufficient space for the new SMB volume.

-size

An integer you supply for the size of the new volume.

-security-style

Use the NTFS security style for this workflow.

ntfs

-junction-path

Location under root (/) where the new volume is to be mounted.

Parameters for creating a qtree

You supply these values with the volume qtree create command if you are creating a qtree instead of a volume.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which the volume containing the qtree resides.
`-volume`	The name of the volume that will contain the new qtree.
`-qtree`	A unique descriptive name you supply for the new qtree, 64 characters or less.
`-qtree-path`	The qtree path argument in the format `/vol/volume_name/qtree_name\>` can be specified instead of specifying volume and qtree as separate arguments.

-vserver

The name of the SVM on which the volume containing the qtree resides.

-volume

The name of the volume that will contain the new qtree.

-qtree

A unique descriptive name you supply for the new qtree, 64 characters or less.

-qtree-path

The qtree path argument in the format /vol/volume_name/qtree_name\> can be specified instead of specifying volume and qtree as separate arguments.

Parameters for creating SMB shares

You supply these values with the vserver cifs share create command.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which to create the SMB share.
`-share-name`	The name of the SMB share that you want to create (up to 256 characters).
`-path`	The name of the path to the SMB share (up to 256 characters). This path must exist in a volume before creating the share.
`-share-properties`	Optional: A list of share properties. The default settings are `oplocks`, `browsable`, `changenotify`, and `show-previous-versions`.
`-comment`	Optional: A text comment for the server (up to 256 characters). Windows clients can see this SMB share description when browsing on the network.

-vserver

The name of the SVM on which to create the SMB share.

-share-name

The name of the SMB share that you want to create (up to 256 characters).

-path

The name of the path to the SMB share (up to 256 characters). This path must exist in a volume before creating the share.

-share-properties

Optional: A list of share properties. The default settings are oplocks, browsable, changenotify, and show-previous-versions.

-comment

Optional: A text comment for the server (up to 256 characters). Windows clients can see this SMB share description when browsing on the network.

Parameters for creating SMB share access control lists (ACLs)

You supply these values with the vserver cifs share access-control create command.

Field Description Your value

Field	Description	Your value
`-vserver`	The name of the SVM on which to create the SMB ACL.
`-share`	The name of the SMB share on which to create.
`-user-group-type`	The type of the user or group to add to the share's ACL. The default type is `windows`	`windows`
`-user-or-group`	The user or group to add to the share's ACL. If you specify the user name, you must include the user's domain using the “domain\username” format.
`-permission`	Specifies the permissions for the user or group.	`[ No_access \| Read \| Change \| Full_Control ]`

-vserver

The name of the SVM on which to create the SMB ACL.

-share

The name of the SMB share on which to create.

-user-group-type

The type of the user or group to add to the share's ACL. The default type is windows

windows

-user-or-group

The user or group to add to the share's ACL. If you specify the user name, you must include the user's domain using the “domain\username” format.

-permission

Specifies the permissions for the user or group.

[ No_access | Read | Change | Full_Control ]

Worksheet for gathering SMB configuration information

Creating your file...

Configuring SMB access to an SVM

Setting up an SMB server in an Active Directory domain

Setting up an SMB server in a workgroup

Adding storage capacity to an SMB-enabled SVM