Scalelogic Wiki - User contributions [en]

NVMe-oF Initiator

2025-07-30T12:28:32Z

Da-F:

__NOTOC__
The NVMe-oF (NVMe over Fabrics) initiator enables connections to external NVMe storage arrays (targets) via network protocols. This feature provides efficient and high-performance management of remote storage solutions, overcoming traditional cabling limitations by allowing substantial distances between servers and storage arrays.

== Supported Protocols ==

The software supports two principal NVMe-oF initiator protocols:

*'''TCP''' – A widely adopted protocol ensuring ease of implementation and compatibility with conventional networking infrastructure.
*'''RDMA''' – A protocol providing lower latency and higher performance, ideal for environments requiring exceptional throughput. RDMA requires specialized hardware, such as Mellanox/NVIDIA ConnectX or ATTO network interface cards, to fully utilize its capabilities.

== Configuration ==

Follow these steps to configure the NVMe-oF initiator:

#'''Start Discovery'''
#;Click the "'''Discover'''" button to start the discovery wizard.
#'''Enter Connection Details'''
#*'''Server IP''': IP address of the NVMe storage target.
#*'''Server port''': Network port for communication ('''default is 4420''').
#*'''Server protocol''': Choose between TCP and RDMA.
#*'''Advanced settings (optional)''': Enable and specify the number of I/O queues. Leave blank or disabled to use the system default, or enter a specific number to override.
#:The number of I/O queues refers to the parallel channels through which data is transferred between the NVMe initiator and the target. Increasing this number can improve performance by enabling higher parallelism and reducing latency. However, each queue consumes system resources, and setting the number too high may exceed hardware or network capabilities, leading to connection issues. Adjust this value based on performance requirements and available resources.
#'''Proceed to Subsystems'''
#;Click "'''Next'''". A list of available NVMe-oF subsystems will appear. Select the subsystems you want to connect to and click “'''Connect'''”.

== Manage Connection Paths ==

'''Add a new path''': Click the “'''Options'''” dropdown menu and select “'''Add path'''”. Enter the required connection details (Server IP, port, protocol, and optionally the number of I/O queues).

'''Disconnect a subsystem''': Use the “'''Options'''” menu and select “'''Disconnect subsystem'''”.

You can perform additional discoveries at any time to connect new subsystems.

== Practical Implementation ==

After connecting to a subsystem, a list of available namespaces will be displayed, including:

*Namespace ID
*Namespace capacity
*Namespace aliases

Namespaces are sections of the NVMe controller on the storage array. They appear as independent NVMe disks to the server, can be identified by their alias, and are managed in the same manner as standard NVMe disks. Namespaces can be partitioned and added to storage pools.

'''Note''': Only one partition per disk can be active within a single pool or data group to maintain redundancy and reliability.

== Multi-path Connectivity ==

The initiator supports multi-path connectivity, allowing multiple redundant network paths to a single NVMe target. Each path requires a distinct IP address (Virtual IP) to ensure redundancy and high availability.

== Troubleshooting ==

If you encounter connection issues (e.g., “Could not connect to subsystem(s)” error), consider the following actions:

#Check Network Connectivity:
#*Ensure that the server can ping the target’s IP address.
#*Verify that the correct port (default 4420) is open and not blocked by a firewall.
#Validate Target Configuration:
#*Verify that the NVMe target is online and properly configured to support NVMe over Fabrics (NVMe-oF) connections.
#*Ensure that access control lists (ACLs) or authentication settings on the target allow the initiator to establish a connection.
#Adjust I/O Queues:
#*If connection errors occur due to queue limits, try lowering the number of I/O queues in the advanced settings to match target capabilities.
#Use Alternative Paths:
#*If multiple network interfaces are available (typical in JBOD or HA environments), try using an alternative IP address or configure multi-path connectivity.
#Review Logs:
#*Check logs for detailed error messages that can guide further troubleshooting.

[[Category:Help_topics]]

Scale Logic NX ver.1.0 up31 ZFS Upgrade

2025-01-21T07:43:46Z

Da-F: Redirected page to File system upgrade

#REDIRECT [[File system upgrade]]

File system upgrade

2025-01-16T10:22:50Z

Da-F:

<div>After upgrading to a version with a newer ZFS filesystem, the following notification will be displayed upon first access:</div><br/>
<q>Zpools available for ZFS filesystem upgrade Upgrading Zpools to the latest ZFS file system is recommended. Although the file system upgrade is absolutely safe for your data and its integrity and will only take few minutes please be aware that this operation cannot be undone and accessing this zpool data will not be possible with older software versions. In order to upgrade a single Zpool, please use “Upgrade file system" from Zpool's option menu.</q>
<br/><div>Additionally, the zpool itself will display the following zpool status:</div><br/>
<q>Some supported features are not enabled on the pool. The pool can still be used but it is recommended to upgrade it in order to fully utilize all system features. Action: Upgrade the pool using "Upgrade file system" in pool options menu. Once this is done, the pool will no longer be accessible by software that does not support new features.</q>
<br/><div>As prompted, expand the zpool options and choose "Upgrade file system":</div>
[[File:Upgrade file system option.png]]
<br/><div>The following windows will appear. Type ‘upgrade’ and click the Upgrade button to proceed:</div>
[[File:Upgrade file system confirmation.png]]
<br/><div>Once completed, the system will notify you that the zpool has been updated successfully.</div>
[[Category:Help topics]]

Zpool wizard

2025-01-15T15:02:22Z

Da-F:

<div>A '''zpool''' is the foundational storage construct in ZFS. It serves as a logical storage pool that combines multiple physical storage devices (disks) into '''vdevs''' (virtual devices), which collectively form the unified zpool. From this zpool, ZFS creates and manages '''datasets''' (file systems) and '''zvols''' (block storage volumes).</div><br/><div>The zpool wizard is made up of the following steps:</div><br/><div>
<span style="font-size:larger">'''1. Add data group'''</span>

This section provides information about all storage devices connected to the storage server. To add the first Data Group to your Zpool, follow these steps:

#Select the desired disks from the list on the left.
#Choose the redundancy type.
#Click the "Add group" button.
</div><br/><div>The available redundancy options for groups are as follows:
*'''Single''': Each disk operates as an independent drive with no redundancy.
*'''Mirror''': All data written to one device in the mirror is automatically replicated to another device, ensuring data redundancy. A minimum of two disks is required to create a mirrored vdev.
**'''Mirror (Single Group)''': All selected disks will be combined into a single mirrored group.
**'''Mirror (Multiple Groups)''': The selected disks will be paired into multiple mirrored groups, each consisting of two disks.
*'''RAIDZ-1''': Allows for the failure of one disk per RAIDZ-1 group without losing data. A minimum of three disks is required for a RAIDZ-1 group.
*'''RAIDZ-2''': Allows for the failure of two disks per RAIDZ-2 group without losing data. A minimum of four disks is required for a RAIDZ-2 group.
*'''RAIDZ-3''': Allows for the failure of three disks per RAIDZ-3 group without losing data. A minimum of five disks is required for a RAIDZ-3 group.
</div><br/><div>To learn more vdev types, please refer to the following article: [[Redundancy in Disks Groups|Redundancy_in_Disks_Groups]]</div><br/>
<span style="font-size:larger">'''2. Add write log'''</span>
<div>This feature allows you to configure the write log function using a chosen redundancy level (either a single drive or a mirror). The write log utilizes a separate intent log (SLOG) device. A fast SSD/NVME should be used for this vdev.</div><br/><div>Key points to consider:
*If multiple log devices are specified, write operations are load-balanced between the devices.
*Log devices can be configured with redundancy by using mirrors to enhance fault tolerance.
*RAIDZ vdev types are not supported for the intent log.
</div><br/><div>This ensures efficient and reliable write operations while leveraging the selected redundancy level.</div><br/>
<span style="font-size:larger">'''3. Add read cache'''</span>
<div>A cache device is used to store frequently accessed storage pool data, providing an additional layer of caching between main memory and disk. These devices cannot be configured as mirrors or RAIDZ groups. A fast SSD/NVME should be used for this vdev.</div><br/><div>Key benefits and considerations:
*Cache devices are particularly useful for '''read-heavy workloads''' where the working dataset size exceeds the capacity of main memory.
*By utilizing cache devices, a larger portion of the working dataset can be served from low-latency storage, improving performance significantly.
*The greatest performance improvements are seen in workloads characterized by '''random reads''' of primarily static content.
</div><br/><div>Adding a read cache helps enhance performance and reduces latency for storage systems with high read demands.</div><br/>
<span style="font-size:larger">'''4. Add special devices group'''</span>
<div>Special devices are used to store specific types of data, such as metadata or small files, on dedicated storage devices separate from the main data pool. A fast SSD/NVME should be used for this vdev.</div><br/><div>Key features and benefits:
*Storing metadata on special devices improves performance for metadata-intensive operations, such as file lookups and directory traversals.
*Small files below a certain size threshold can also be stored on these devices, enhancing read and write speeds for such workloads.
*Special devices are particularly beneficial for environments with a large number of small files or high metadata activity.<div></div>
<div>Using special devices optimizes the overall performance of the ZFS pool by offloading critical metadata and small-file operations to faster storage.</div><br/>
<span style="font-size:larger">'''5. Add deduplication group'''</span>
<div>A deduplication group can be explicitly excluded from a special device group as a dedicated storage group used to hold deduplication tables. This allows the deduplication tables to be stored separately from the special device class.</div><br/><div>Key features and considerations:
*Storing deduplication tables in a dedicated group improves the efficiency of deduplication processes by isolating them from other metadata operations.
*This configuration provides flexibility in optimizing storage layout based on workload requirements.
*Using a deduplication group is particularly beneficial for systems with high deduplication demands, ensuring better performance and management.
</div><br/><div>This setup enhances deduplication performance while maintaining a clear separation of metadata and deduplication operations.</div><br/>
<span style="font-size:larger">'''6. Add spare disks'''</span>
<div>A spare disk is a special pseudo-vdev used to track available spare devices for a zpool.</div><br/><div>Using spare disks enhances the reliability of the storage pool by allowing seamless drive replacement and reducing the risk of data loss.</div><br/>
<span style="font-size:larger">'''7. Configuration'''</span>
<div>During this step, you can configure the Zpool by naming it and enabling additional features if required.</div><br/><div>Key configurations:
*'''Zpool Name''': Assign a unique and descriptive name to the Zpool for easy identification.
*'''Enable AutoTRIM''': If supported by your devices, enable the AutoTRIM feature to automatically reclaim unused space. AutoTRIM helps optimize the performance and lifespan of SSDs by informing them when blocks are no longer in use.
*'''Small blocks policy settings''' if a special device group has been configured in Step. When the small block size is set for the pool all datasets inherit this value by default. It can be changed for a particular dataset in its setting.
</div><br/><div>Proper configuration ensures that the Zpool is tailored to your needs and operates efficiently.</div><br/>
<span style="font-size:larger">'''8. Summary'''</span>
<div>This step provides a summary of the zpool configuration, detailing the arrangement of disk groups and their roles within the pool. Click ‘Add zpool’ to create a zpool.</div>
<br/></div>
[[Category:Help topics]]

Small blocks policy settings

2025-01-15T11:58:03Z

Da-F: Created page with "<div>This feature is available only when the special devices group exists in the pool.</div><br/><div>Devices assigned to the special devices group are designated for storing ..."

<div>This feature is available only when the special devices group exists in the pool.</div><br/><div>Devices assigned to the special devices group are designated for storing specific data, including metadata, indirect blocks of user data, and deduplication tables. Additionally, devices in the special devices group can be configured to handle small file blocks that are not listed above by applying the small blocks policy.</div><div>The size of the small block refers to the size of a single block of data configured on the dataset. Maximum size of such blocks can be set for each dataset under the “Record size” option.</div><div>Deduplication tables can alternatively be placed in a separate group known as the deduplication group.</div><br/><div><span style="color:#ff0000">'''WARNING''': If the size of the small block is greater than or equal to the value of record size on the dataset, all the blocks will be offloaded to the special devices group.</span></div><br/><div>The small block size can be configured for the whole Pool or for each dataset separately. Options to choose range from 4 KiB to 16 MiB.</div><br/><div>Configuring a bigger size for the small block policy can be helpful in case the administrator expects the to have a substantial amount of small files that will require low access times separated from the bigger files. Using this option is recommended only if the administrator understands what kind of data will be stored in configured datasets and the maximum size of offloaded files is exactly known, to avoid accidental data offload and special devices congestion.</div><div>[[Category:Help_topics]]</div><div></div>

Critical system error response policy

2025-01-15T11:39:50Z

Da-F:

<div>A system reboot may be necessary when a critical error is detected. The administrator may choose to handle different errors in a different manner.</div><br/><div>Possible critical errors are divided into three categories:
*'''ZFS pool I/O suspend''': errors from this group are raised in case an uncorrectable I/O failure is encountered during read/write operation to the Pool. The I/O operation is suspended and the system awaits a reboot.
*'''Kernel oops or bug''': kernel oops is defined as a deviation from the correct behavior of the Linux kernel that produces a certain error log. Such an error is not fatal to the system but may be dangerous to the system’s stability. Kernel oops often precedes a kernel panic, causing the system to immediately shutdown. Kernel bug refers to an internal error in the kernel code. Un-Kh errors put the system integrity at risk. It is highly recommended that a reboot is performed immediately to avoid unexpected failures.
*'''Out-of-memory error''': This error, abbreviated as OOM, refers to the state of the system where no additional memory can be allocated for use by programs or the operating system. It is necessary to free up or add memory to the system to recover the system operation. Once this error occurs the system enters an unresponsive state until the memory issue is solved. It is highly recommended to reboot the system at the first moment possible.
</div><br/><div>For each of the mentioned categories the following behavior patterns can be configured:
*'''Immediate''': system will reboot the machine immediately after the error occurs (the event will not be recorded in the event viewer).
*'''Automatic''': system will restart in 30 seconds from when the errors appear.
*'''Manual''': system will prompt for manual restart.
</div>
[[Category:Help topics]]

Critical IO Errors

2025-01-15T11:38:36Z

Da-F: Da-F moved page Critical IO Errors to Critical system error response policy

#REDIRECT [[Critical system error response policy]]

Backup & Recovery replication task

2025-01-15T11:08:06Z

Da-F:

__NOTOC__
== Backup & Recovery: Overview Tabs ==

#'''Tasks''': View the list of all tasks with their current statuses.
#'''Destination Servers''': View all added destination servers. Use the '''Add Server''' button to configure a new server outside of the Backup Task Wizard.
#'''vCenter/vSphere Servers''': View all added vCenter/vSphere servers. Use the '''Add Server''' button to configure a new server outside of the Backup Task Wizard.

For additional support or detailed guidance, refer to the article [[On- and Off-site Data Protection|On-_and_Off-site_Data_Protection]]
<div><br/></div>
== Backup & Recovery: Creating a Replication Task ==

To create a replication task, navigate to '''Backup & Recovery''' and click on the '''Add Replication Task''' button. This launches the Backup Task Wizard, which consists of the following steps:

=== Step 1: Source Configuration ===

#'''Resource Path''': Browse and select the ZVOLs or datasets to be backed up. Confirm your selection by clicking '''Apply'''.
#'''Retention Interval Plan''': Specify how often snapshots should be taken and how long they should be retained.
<div><br/></div>
=== Step 2: Destination Configuration ===

*If the '''Toggle Bar''' is disabled, no destination will be configured. Enable the toggle bar to activate '''Destination 1'''.
*The destination server can be either:
**'''Local Server''': The same machine as the source.
**'''Remote Server''': A different server. To configure a remote server:
**#Select '''Add New Server'''.
**#Provide the following details:
**#*'''IP Address/Domain'''
**#*'''Port''' (default: 40000)
**#*'''Password'''
**#*'''Description''' (optional)
**#After adding the server, select the appropriate '''Resource Path'''.

<span style="color:#ff0000">'''Note''': '''The resource path cannot have iSCSI targets attached (for ZVOLs) or shared datasets.'''</span>

*Specify the '''Retention Interval Plan''' for the destination.
*To configure additional destinations, click '''Add Another Destination'''.

For detailed explanations of these options, refer to the article [[On- and Off-site Data Protection|On-_and_Off-site_Data_Protection]].
<div><br/></div>
=== Step 3: vCenter/vSphere Server Integration ===

*Add a vCenter/vSphere server to enable consistent snapshots.

For detailed instructions, refer to the article [[On- and Off-site Data Protection|On-_and_Off-site_Data_Protection]].
<div><br/></div>
=== Step 4: Task Properties ===

#'''Task Description''': Create a custom description for the task.
#'''Enable MBuffer''': Buffer the data stream on the source and destination to prevent buffer underruns. Configure:
#*'''Buffer Size'''
#*'''Rate Limit'''
#'''Send Compressed Data''': Enable this option to transfer compressed data directly without decompression, which speeds up the process and reduces network bandwidth usage.
<div><br/></div>
=== Step 5: Summary ===

*Review a summary of the configured settings.
*Click '''Add''' to finalize the task.

[[Category:Help topics]]

Active Directory (AD) server authentication

2024-12-12T09:23:55Z

Da-F:

__NOTOC__
This functionality is available in '''User Management > Share users/groups > Authorization protocols'''.

<br/>To configure a connection to the existing Active Directory server:

#Navigate to the '''User Management '''section in the left menu.
#Go to the '''Share users/groups''' tab.
#Find the '''Active Directory (AD) server authentication''' block.
#Enable the '''Enable protocol''' option.

== AD server authentication status ==

*'''Connection''' - shows whether you are connected to an AD server or not.
*'''Users/groups list''' - shows when the lists of users and groups were last synchronized or if the synchronization is taking place at the moment.

Users and groups are synchronized with an Active Directory server every 2 hours. Synchronization can also be started manually by using the '''Synchronize''' button.

== AD server authentication settings ==

To connect to the existing AD server, fill in the following fields with credentials provided by the AD server administrator and click the '''Apply''' button.

*'''Realm'''
*'''Administrator name'''
*'''Password'''<br/>NOTE''': Password cannot contain:'''
**special characters such as ' " ` ^ & $ # ~ [ ] \ / | * : ? < >
**spaces
**less than 12 and more than 16 characters
*'''Organizational Unit (OU) - '''a direct path to the container where the Computer Organizational Unit is placed. The path must be entered starting from the primary container name within the domain structure. The container name set by default is '''Computers'''. If another container name is used instead, then '''Computers''' must be changed to the appropriate name. If the path to the container is nested, use a slash as the connector. In the screenshot below, the OU is in the '''Computers''' container that is nested in '''AllComputers > Marketing'''. In this example, the path to the OU is: '''AllComputers/Marketing/Computers'''<br/><br/>[[File:Ad-structure.png]]<br/><br/>NOTE''': Container name can't contain:'''
**special characters such as , + " \ < > ; = / #
**spaces

<div>'''The following reasons might prevent you from connecting to Active Directory:'''<br/></div>
#Difference in time between Active Directory Server - if the time difference is greater than 5 minutes, the connection is not possible.
#The method of authenticating trusted domains - the authentication has to be set to two-way trust. Otherwise, it is not possible to read users and groups from trusted domains.
#DNS configuration - for an Active Directory domain, it is not possible to use a round-robin mechanism in DNS. This is connected to the fact that only one IP address is authorized. In a moment when another IP is obtained from DNS, the connection is not possible.
#The '''server name''' is the same as the Computer Organizational Unit (OU) named in the Active Directory (AD) server. If the object with the same name exists and the user that you use to log in to the AD server does not have permission to access this file, the connection will fail. The solution is to delete the existing computer object from the AD server. The following information explains how to delete the OU file:
<ul style="margin-left: 80px;">
<li>Log on to the Domain Controller with the domain administrator account. Press Windows Logo + R, enter "dsa.msc" and press Enter.</li>
<li>In the "Active Directory Users and Computers" window, select the domain container in which the OU you are looking for is located.</li>
<li>Select the computer object and delete it.</li>
</ul>

::'''Note''': By default, any created Organizational Unit is protected from accidental deletion. To delete the OU, you need to clear the "Protect object from accidental deletion" checkbox, which you can find in the object properties in the "Object" tab. By deleting OU, you delete all nested objects that it contains as well.
:::<div><br/></div>

== Users and user groups management ==

'''Management mode:'''

*'''Scan single domain (default)''' - Using this function allows the user to obtain users and groups from the main domain only.

*'''Scan all trusted domains''' - Using this function allows the user to obtain users and groups from the main and trusted domains.

<br/>'''ID mapping backend:'''

*'''rid + tdb (default)''' - This option utilizes the rid backend for ID mapping to AD users. UID/GIDs range has to be entered manually The tdb backend is used when no other configuration is set. Recommended for large databases.Samba Wiki link for rid backend: [https://wiki.samba.org/index.php/Idmap_config_rid https://wiki.samba.org/index.php/Idmap_config_rid]
*'''ad (with RFC2307 schema) + tdb''' - Allows reading ID mappings from an AD server, provided that the uidNumber attributes for users and gidNumber attributes for groups were added in advance in the AD. This backend requires additional configuration of uidNumber and gidNumber on the AD server side. The tdb back end is used when no other configuration is set. Samba Wiki link for rid backend: [https://wiki.samba.org/index.php/Idmap_config_ad https://wiki.samba.org/index.php/Idmap_config_ad]
*'''autorid''' - This backend can be used if users are imported from a set of different domains. Automatically configures the range to be used for each domain. The only configuration needed is the range of UID/GIDs used for user/group mappings and the number of IDs per domain.Samba Wiki link for autorid backend: [https://wiki.samba.org/index.php/Idmap_config_autorid https://wiki.samba.org/index.php/Idmap_config_autorid]

== Troubleshooting ==

'''<span style="font-size:small">The TDB UID/GIDs mapping does not work properly.</span>'''

'''Single-Domain Environments'''
<div>It is recommended to use the "autorid" option in the "ID mapping backend" settings. Alternatively, you can use the "rid+tdb" option. If you choose "rid+tdb," set the UID/GIDs mapping to "rid" and define the Min ID and Max ID range (e.g., 2,000,000 to 2,999,999). The range 1,000,000 to 1,999,999 is reserved.</div><br/>
'''Multi-Domain Environments'''
<div>The "autorid" option cannot be used. Instead, use "rid+tdb" or "ad (with RFC2307 schema) + tdb." Ensure the UID/GIDs mapping is set to "rid" and define the Min ID and Max ID range for each domain (e.g., 2,000,000 to 2,999,999 for the first domain, 3,000,000 to 3,999,999 for the second domain, etc.).</div>
[[Category:Help topics]]

SNMP settings

2024-10-21T10:10:12Z

Da-F:

This function enables you to configure access over the '''SNMP''' protocol in versions 2 or 3.

With SNMP enabled, you receive a wealth of information (CPU usage, system load, memory info, ethernet traffic, running processes).<br/>System location and system contact are only for your information.  For example, when you connect from an SNMP client, you will see your location and name.

SNMP, version 3 has an encrypted transmission feature as well as authentication by username and password.<br/>SNMP, version 2 does not have encrypted transmission, and authentication is done only via the community string.

The community string you set can contain up to 20 characters, while the password needs to have at least 8 characters.

Links to SNMP clients:

*<span style="font-size:larger">[http://www.muonics.com http://www.muonics.com]</span>
*<span style="font-size:larger">[http://www.mg-soft.com http://www.mg-soft.com]</span>
*<span style="font-size:larger">[http://www.manageengine.com http://www.manageengine.com]</span>

{{Note|
Our storage system supports the SNMP protocol in MIB-II standard.  List of MIBs:

*- mib-2.host

*- mib-2.ip

*- mib-2.tcp

*- mib-2.udp

*- mib-2.interfaces

*- mib-2.at

*- system
}}

NX offers additional SNMP values to monitor Pool and ZFS attributes.<br/>It is necessary to query specific OIDs in order to receive those attributes.

For basic ZFS parameters, NYMNETWORKS-MIB mib is included:

*to version v.1.0 up29r4  [[:Media:NYMNETWORKS-MIB.txt|NYMNETWORKS-MIB.txt]]
*from version v.1.0 up30 [[:Media:NYMNETWORKS-MIB-up30.txt|NYMNETWORKS-MIB.txt]]

<br/>'''SNMP v2:''' snmpwalk -v 2c -m NYMNETWORKS-MIB -c community 192.168.251.79 .1.3.6.1.4.1.25359.1<br/>'''SNMP v3:''' snmpwalk -v3 -l authPriv -u nagios -a MD5 -x DES -A 12345678 -X 12345678 192.168.150.70

<br/>NYMNETWORKS-MIB::zfsFilesystemName.1 = STRING: "Pool-0"<br/>NYMNETWORKS-MIB::zfsFilesystemName.2 = STRING: "Pool-1"<br/>NYMNETWORKS-MIB::zfsFilesystemAvailableKB.1 = Gauge32: 15861464<br/>NYMNETWORKS-MIB::zfsFilesystemAvailableKB.2 = Gauge32: 15861672<br/>NYMNETWORKS-MIB::zfsFilesystemUsedKB.1 = Gauge32: 4327720<br/>NYMNETWORKS-MIB::zfsFilesystemUsedKB.2 = Gauge32: 4327512<br/>NYMNETWORKS-MIB::zfsPoolHealth.1 = INTEGER: online(1)<br/>NYMNETWORKS-MIB::zfsPoolHealth.2 = INTEGER: online(1)<br/>NYMNETWORKS-MIB::zfsFilesystemSizeKB.1 = Wrong Type (should be INTEGER): Gauge32: 20189184<br/>NYMNETWORKS-MIB::zfsFilesystemSizeKB.2 = Wrong Type (should be INTEGER): Gauge32: 20189184<br/>NYMNETWORKS-MIB::zfsFilesystemAvailableMB.1 = Gauge32: 15489<br/>NYMNETWORKS-MIB::zfsFilesystemAvailableMB.2 = Gauge32: 15489<br/>NYMNETWORKS-MIB::zfsFilesystemUsedMB.1 = Gauge32: 4226<br/>NYMNETWORKS-MIB::zfsFilesystemUsedMB.2 = Gauge32: 4226<br/>NYMNETWORKS-MIB::zfsFilesystemSizeMB.1 = Gauge32: 19716<br/>NYMNETWORKS-MIB::zfsFilesystemSizeMB.2 = Gauge32: 19716<br/>NYMNETWORKS-MIB::zfsARCSizeKB.0 = Gauge32: 61086<br/>NYMNETWORKS-MIB::zfsARCMetadataSizeKB.0 = Gauge32: 9278<br/>NYMNETWORKS-MIB::zfsARCDataSizeKB.0 = Gauge32: 51808<br/>NYMNETWORKS-MIB::zfsARCHits.0 = Counter32: 229308<br/>NYMNETWORKS-MIB::zfsARCMisses.0 = Counter32: 41260<br/>NYMNETWORKS-MIB::zfsARCTargetSize.0 = Gauge32: 64287<br/>NYMNETWORKS-MIB::zfsARCMru.0 = Gauge32: 59529<br/>NYMNETWORKS-MIB::zfsL2ARCHits.0 = Counter32: 0<br/>NYMNETWORKS-MIB::zfsL2ARCMisses.0 = Counter32: 0<br/>NYMNETWORKS-MIB::zfsL2ARCReads.0 = Counter32: 0<br/>NYMNETWORKS-MIB::zfsL2ARCWrites.0 = Counter32: 0

Additional information, like compression ratio, deduplication ratio, available space (in bytes), age (in seconds) of latest snapshot on volume,<br/>can be obtained with standard NET-SNMP-EXTEND-MIB:

'''Examples:'''<br/><br/>NET-SNMP-EXTEND-MIB::nsExtendOutputFull."deduplication" = STRING:

"deduplication Pool-0 1.00"<br/><br/>NET-SNMP-EXTEND-MIB::nsExtendOutputFull."compression" = STRING:

"compression Pool-0/vol00 1.01<br/>compression Pool-0/clone-vol00 1.00"

NET-SNMP-EXTEND-MIB::nsExtendOutputFull."volumes_list" = STRING:<br/><br/>"available Pool-0/vol00 11981377536<br/>available Pool-0/clone-vol00 11981377536"

NET-SNMP-EXTEND-MIB::nsExtendOutputFull."snapshots_age" = STRING:<br/><br/>"snapshot_age Pool-0/vol00 3<br/>snapshot_age Pool-0/vol01 371"

'''Untranslated OIDs:'''<br/><br/>root@p-GA-880GM-USB3:/home/p# snmpwalk -v2c -c public 192.168.0.80  1.3.6.1.4.1.8072.1.3.2.3<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.1.11.99.111.109.112.114.101.115.115.105.111.110 = STRING: "compression Pool-0/vol00 1.01"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.1.12.115.110.97.112.115.104.111.116.95.97.103.101 = STRING: "snapshot_age Pool-0/vol00 3"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.1.12.118.111.108.117.109.101.115.95.108.105.115.116 = STRING: "available Pool-0/vol00 11981377536"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.1.13.100.101.100.117.112.108.105.99.97.116.105.111.110 = STRING: "deduplication Pool-0 1.00"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.2.11.99.111.109.112.114.101.115.115.105.111.110 = STRING: "compression Pool-0/vol00 1.01<br/>compression Pool-0/clone-vol00 1.00"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.2.12.115.110.97.112.115.104.111.116.95.97.103.101 = STRING: "snapshot_age Pool-0/vol00 3<br/>snapshot_age Pool-0/vol01 371"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.2.12.118.111.108.117.109.101.115.95.108.105.115.116 = STRING: "available Pool-0/vol00 11981377536<br/>available Pool-0/clone-vol00 11981377536"<br/>iso.3.6.1.4.1.8072.1.3.2.3.1.2.13.100.101.100.117.112.108.105.99.97.116.105.111.110 = STRING: "deduplication Pool-0 1.00"

[[Category:Help topics]]

Upload update

2024-06-11T09:52:17Z

Da-F:

This option is available in the '''System Settings''' > '''Update''' tab.

The following can be uploaded into the Update tab:

*A new release
*A small update provided by the Support Team.

'''Note!''' Always back up your data and configuration before changing the software version.

<br/>'''Related articles'''

[[Change version|Change version]]

[[Category:Help topics]]

Change version

2024-06-11T08:55:13Z

Da-F: Created page with "This option is available in the '''System Settings''' > '''Update''' tab '''Note!''' Always back up your data and configuration before changing the software version. == U..."

This option is available in the '''System Settings''' > '''Update''' tab

'''Note!''' Always back up your data and configuration before changing the software version.

== Upgrade to the latest version ==

'''Note!''' If a new software version includes an updated ZFS version, do not upgrade your zpools unless you're ready for a permanent change. Upgrading zpools to a more recent version of ZFS is irreversible. After upgrading, the zpool won't work with older software versions.

As a rule, you should upgrade the software from version to version. In case such an upgrade is not possible and some versions must be omitted, please contact the Support Team to confirm the best procedure.

<br/>'''To upgrade the software''':

#Go to the “System Settings” and then the “Update” tab.
#Click the “Upload update” button. Select the iso file with the release you want to install, and apply by clicking the “Upload” button.
#After the file is uploaded, the popup with the following options appears:
#*'''Cancel''' - use this option to close the popup window if you want to install the uploaded version later. See the details below. This is also recommended if you install a system version older than the one currently running. To downgrade the system to an older version, we recommend using the Change Version option to decide whether to keep the current system settings. Downgrading the system version is described in the “Downgrade to an older version” section.
#*'''Change and reboot later''' - using this option will install the uploaded version, set it up as default, and boot it after the next restart. In this case, all current system settings will be saved and applied to the installed version.
#*'''Change and reboot now''' - using this option will install the uploaded version, set it up as default, and the new version will be applied immediately after the automatic reboot. In this case, all current system settings will be saved and applied to the installed version.

If the "Cancel" option has been chosen after downloading the iso file, you can finish the update with the "Change version" option.

#Go to the “Available version” table.
#Select the uploaded version.
#Using the context menu, select the “Change version” option.
#The popup appears.
#'''Check''' the "Keep all current system settings" option '''while upgrading''' to the newer version. All current system settings will be saved and applied to the installed version.
#Finish by clicking one of the available buttons:
#*'''Change and reboot later''' - using this option will install the selected version, set it as the default, and boot it after the next restart.
#*'''Change and reboot now''' - using this option will install the selected version and apply it immediately after the automatic reboot.
#*'''Cancel''' - use this option to close the popup window without taking any action if you do not want to continue.

== Downgrade to an older version ==

Downgrading is not recommended and must be done after careful consideration. The newer software version may include bug fixes and security updates. Downgrading to an older version may result in exposure to known vulnerabilities or issues that have been addressed in the newer release.

<br/>'''To avoid issues when downgrading:'''

*Always check compatibility and differences between iterations.
*Back up your data and configurations.
*'''Do not downgrade the system by more than one version.'''
*'''Do not keep the current system settings.''' Downgrading the system with saved configuration settings from a newer version can cause issues for several reasons, for example:
**'''Incompatibility''': A newer software version may introduce some changes in configuration settings or dependencies. When you downgrade to an older version, it might cause issues with interpreting or using the settings created by the newer version. This can lead to errors, crashes, or unexpected behavior.
**'''Missing features''': A newer version of software may include new features, options, or optimizations unavailable in older versions. When you downgrade, you might lose access to these features, and the software may not handle the missing functionalities.
**'''Regression issues''': Downgrading might not always be a straightforward process. Some changes made in the newer version may be tightly integrated into the system, and reverting to an older version could break these dependencies, causing problems.
**'''Configuration settings migration''': If you have made significant changes to configuration settings in the newer version, these changes might not easily translate to the older version's configuration format. This can result in configuration conflicts or incomplete settings.
*Be prepared to reconfigure settings or adapt to any changes between versions.

<br/>'''To downgrade the system it is recommended to use the “Change version” option:'''

#Go to the “System Settings” and then the “Update” tab.
#Go to the “Available version” table.
#Select the version to be installed.
#Using the context menu select the “Change version” option.
#The popup appears.
#Choose whether to keep the current system settings.
#*Leave the "Keep all current system settings" option '''unchecked while downgrading''' to the older version. This will launch the older version with the default system settings of that version.
#Finish by clicking one of the available buttons:
#*'''Change and reboot later''' - using this option will install the selected version, set it as the default, and boot it after the next restart.
#*'''Change and reboot now''' - using this option will install the selected version and apply it immediately after the automatic reboot.
#*'''Cancel''' - use this option to close the popup window without taking any action if you do not want to continue.

[[Category:Help topics]]

Restore settings

2024-06-10T12:27:06Z

Da-F:

__NOTOC__
<div>This functionality is available in the '''System Settings''' > '''Settings management''' tab.</div><br/><div>With this function, you can restore configuration settings if they have been saved to a file. If a settings file is not on the "Manually saved settings" list, it should be uploaded. For this purpose, the "Upload settings file" button should be used, and through the "Browse" option, select the file to upload. To complete the action, the "Upload" button must be clicked. After the file is uploaded to the "Manually saved settings" list, you can proceed to restore the settings. To this end, use the "Restore" option from the context menu.</div><br/><div>Alternatively, the restoring process will start if the "Apply settings after uploaded" option is enabled during the upload of the settings file.</div><br/><div>Regardless of which option has been chosen ("Restore" or the "Apply settings after uploaded"), a popup will appear. There are two types of settings that can be restored:
*System and storage settings which restore the following settings:
**Network, GUI and console configuration, services configuration, time and date settings, e-mail notifications, SNMP, CHAP users access discovery
*Pools settings that restore the following settings:
**Targets, shares, and virtual aliases together with their settings</div>
'''Note''' that the structure of the pool itself, i.e. its disk groups, datasets, zvols, snapshots, and clones will not be restored. Also, please remember that only pools imported at the moment of saving the settings will be restored.
<div>You can select which types of settings described above (only System and storage settings, only Pools settings, or both) to restore by enabling the respective toggle button. To confirm, click the "Reboot & Restore" action button. For security reasons, additional verification is needed. On the following popup that appears, the word "reboot" must be typed, and then the “Reboot" button pressed to confirm the execution of restoring the settings. The system will auto-save the current settings before it restores the settings from the selected file. The restored settings are available after the reboot.</div><br/>

[[Category:Help topics]]

Active iSCSI connections

2024-06-10T07:21:25Z

Da-F:

<div>This functionality is available in '''Services Status > Connections'''</div><br/><div>The "Active iSCSI connections" section lists initiators actively connected to the targets. The table contains the following information:
*The initiator's name is connected to the server.
*The target's name to which the initiator is connected.
*Connection IP address.
*Session ID.
*Connection ID.
</div><br/><div>To show a single session details, use the context menu. As a result, you will see the following list of parameters:
*'''Initiator name''': Initiator name connected to the target (Target name).
*'''Target name''': Target name to which the initiator (Initiator name) is connected.
*'''Initiator IP''': The IP address of the initiator that is connected to the target in this session.
*'''SID''': Session ID.
*'''CID''': Connection ID.
*'''State''': contains processing state of this connection.
*'''Reinstating''': contains reinstatement state of the session.
*'''Bidi IO count KB (bidi_io_count_kb)''': Amount of data in KB transferred by the initiator since beginning or last reset.
*'''Bidi command count (bidi_cmd_count)''': Number of BIDI SCSI commands received since beginning or last reset.
*'''Read command count (read_cmd_count)''': Number of READ SCSI commands received since beginning or last reset.
*'''Read IO count KB (read_io_count_kb)''': Amount of data in KB read by the initiator since beginning or last reset.
*'''None command count (none_cmd_count)''': Number of not transferring data SCSI commands (e.g. INQUIRY or TEST UNIT READY) received since beginning or last reset.
*'''Write command count (write_cmd_count)''': Number of WRITE SCSI commands received since beginning or last reset.
*'''Write IO count KB (write_io_count_kb)''': amount of data in KB written by the initiator since beginning or last reset.
*'''Unknown command count (unknown_cmd_count)''': Number of unknown SCSI commands received since beginning or last reset .
*'''Commands''': Contains overall number of SCSI commands in this session.
*'''Active commands''': Contains number of active, i.e. not yet or being executed, SCSI commands in this session.
*'''FirstBurstLength''': Specifies the maximum amount of unsolicited data an iSCSI initiator can send to the target during the execution of a single SCSI command, in bytes. This parameter is sent by both the initiator and the target, and the negotiated value used takes the minimum.
*'''DataDigest''': Increases data integrity. When the data digest parameter is enabled, the system performs a checksum over each PDU data part. The system verifies the data using the CRC32C algorithm. This parameter is sent by the initiator and target. Checksum enablement is negotiated only if both the initiator and target intend to use CRC32c.
*'''HeaderDigest''': Increases data integrity. When the header digest parameter is enabled, the system performs a checksum over each header part of the iSCSI Protocol Data Unit (PDU). The system verifies the data using the CRC32C algorithm. This parameter is sent by the initiator and target. Checksum enablement is negotiated only if both the initiator and target intend to use CRC32c.
*'''ImmediateData''': This allows the initiator to append unsolicited data to a command. To achieve better performance, this should be set to "Yes". This parameter is sent by the initiator and target, and the negotiated value used is the logical product.
*'''InitialR2T''': Turns on the default use of R2T; if disabled, allows an initiator to start sending data to a target as if it had received an initial R2T. If set to "Yes", the initiator has to wait for the target to solicit SCSI data before sending it. Setting it to "No" allows the initiator to send a burst of FirstBurstLength bytes unsolicited right after and/or (depending on the setting of ImmediateData) together with the command. Thus setting it to "No" may improve performance. This parameter is sent by the initiator and target, and the negotiated value used is the logical sum.
*'''MaxBurstLength''': Parameter specifies the maximum amount of usable data in bytes (SCSI data payload) that can be sent in outgoing (SCSI Data-Out) or incoming (SCSI Data-In) packets. The value must be greater than or equal to the value of the FirstBurstLenght parameter.<br/>Configuring too large values may lead to problems allocating sufficient memory, which in turn may lead to SCSI commands timing out at the initiator host. This parameter is sent by the initiator and target, and the negotiated value used is the minimum.
*'''MaxOutstandingR2T''': Defines the R2T (Ready to Transfer) PDUs that can be in transition before an acknowledged PDU is received.<br/>Controls the maximum number of data transfers the target may request at once, each of up to MaxBurstLength bytes. This parameter is sent by the initiator and target, and the negotiated used value is the minimum.<br/>SEE:[https://kb.scalelogicinc.com/how-can-we-improve-high-latency-links-using-maxoutstandingr2t-iscsi-parameter_1083.html https://kb.scalelogicinc.com/how-can-we-improve-high-latency-links-using-maxoutstandingr2t-iscsi-parameter_1083.html]
*'''MaxRecvDataSegmentLength''': Sets the maximum data segment length that can be received in an iSCSI PDU. Configuring too large values may lead to problems allocating sufficient memory, which in turn may lead to SCSI commands timing out at the initiator host. This parameter is sent by the initiator and target, and the negotiated value used is the minimum.
*'''MaxXmitDataSegmentLength''': Sets the maximum data segment length that can be sent in any iSCSI PDU. The value actually used is the minimum of MaxXmitDataSegmentLength and the MaxRecvDataSegmentLength announced by the initiator. Configuring too large values may lead to problems allocating sufficient memory, which in turn may lead to SCSI commands timing out at the initiator host.
</div>
[[Category:Help topics]]

ISCSI connections

2024-06-10T07:19:21Z

Da-F: Da-F moved page ISCSI connections to Active iSCSI connections: Matching the section's name.

#REDIRECT [[Active iSCSI connections]]

SMB connections

2024-06-06T09:11:26Z

Da-F: Da-F moved page SMB connections to Active SMB user connections: Matching the section's name.

#REDIRECT [[Active SMB user connections]]

Active SMB user connections

2024-06-06T09:11:26Z

Da-F: Da-F moved page SMB connections to Active SMB user connections: Matching the section's name.

<div>'''This functionality is available in Services Status > Connections tab'''</div><br/><div>The "Active SMB user connections" section lists users who are connected to the shares. The main table contains the following information:
*User's name. If a user is connected as a guest, the user's name is shown as "nobody". Users who are set as superusers (Storage Settings > NAS Settings > SMB) may be named "superuser(root)" in the table.
*The IP address through which the user is connected.

The protocol through which the user is connected.
</div><br/><div>To see a user's active sessions list, use the "Connected resources" button. After you click, the popup appears, and you can see the list of the user's active sessions. On the list, you can see all shares that the user is connected to at the moment. You can also see:
*Share's name.
*Resource's location (the name of the zpool and the name of the dataset).
*Date and time when the connection has been established.
</div>
[[Category:Help topics]]

Non-data group disks

2024-06-06T07:41:48Z

Da-F: Created page with "== General information == <div>This section displays partitioned disks only. '''Please note that only NVMe disks can be partitioned.'''</div><div>NVMe disks available in the "..."

== General information ==
<div>This section displays partitioned disks only. '''Please note that only NVMe disks can be partitioned.'''</div><div>NVMe disks available in the "Unassigned disks" section can be partitioned. Once divided, these partitions can be used as devices in the following non-data groups:
*Write log
*Read cache
*Special devices groups
*Deduplication data groups
</div><br/><div>When working with partitions, keep the following rules in mind:
#Partitions can only be used in the following non-data groups: write log, read cache, special devices group, and deduplication group.
#Only one partition per disk can be assigned to a single non-data group.

</div><br/>
== Creating partitions ==
<div>Disks suitable for partitioning activate the "Make partitions (non-data group only)" option in the context menu.</div><div>'''Important:''' All the partitions on a given disk must be created at once. It is not possible to edit or add partitions afterward.</div><div>To create partitions:
#Navigate to the "Unassigned disks" card in the Storage section. It's located at the bottom of the page, under zpools.
#Select an NVMe disk that you wish to partition.
#Click the options icon, then choose "Make partitions (non-data group only)".
#A popup window with the following options will appear:
#*'''Total disk size:''' indicates the overall capacity of the disk to be partitioned.
#*'''Remaining disk capacity left to use:''' displays the capacity remaining after adding a partition. This assists in partitioning without manual calculations, showing available capacity.
#*'''Defined partitions:''' presented as a percentage of the disk capacity covered by the added partitions.
#*'''"Add partition" button:''' used to add a partition.
#Click the "Add partition" button and complete the brief form, providing the following information:
#*'''Partition's name suffix:''' this should be a number. By default, it begins from 1 but can be modified.
#:The partition name structure includes the following: a disk name + p + partition number (suffix), e.g., nvme1p1
#*'''Partition size:''' expressed in MB, GB, or TB. Sizes can be expressed in integers or decimals. The unit can be selected from the adjacent dropdown menu.<div>'''Note!''' <span style="color:#ff0000">All the partitions on a given disk must be created at once. It is not possible to edit or add partitions afterward.</span></div>
#After specifying partition sizes, click "Apply" to confirm and finalize the partition creation.
</div><br/><div>All created partitions are listed in the "Non-data group disks" section. Unassigned partitions are also visible in the "Unassigned disks" section. They can be used as devices in any non-data group.</div><br/>
== Deleting partitions ==
<div>'''Important:''' Deleting all partitions at once is the only option. Partitions allocated to non-data groups cannot be deleted. If any partition is assigned, the option to delete is disabled. To enable it, all partitions must be unassigned.</div><div>This action is irreversible. After partitions are deleted, the disk returns to the "Unassigned disks" group.</div><div>To delete partitions:
#Go to the "Non-data group disks" section.
#Select the disk whose partitions you want to delete. Click the "Delete all partitions" option in the context menu.
#A confirmation popup will appear. Confirm the action, and all partitions on the disk will be permanently deleted.
</div>
[[Category:Help topics]]

TRIM

2024-06-03T10:21:17Z

Da-F:

__NOTOC__
== What is TRIM? ==
<div>TRIM is a feature associated with solid-state drives (SSDs). SSDs use NAND flash memory to store data; over time, as files are deleted or modified, free space within the SSD can become fragmented. This fragmentation can impact the performance and lifespan of the SSD. TRIM allows the operating system to inform the SSD which blocks of data are no longer in use, marking them as available for erasure. By doing so, the SSD can perform internal housekeeping tasks and optimize its performance by consolidating free space. This process helps maintain the SSD's efficiency, prevent write amplification, and extend its lifespan. TRIM support is contingent on the SSD and the operating system. The SSD must have TRIM functionality built into its firmware, and the operating system must support TRIM commands. When both the SSD and the operating system support TRIM, it ensures the optimal functioning and longevity of the SSD in computing systems.</div><br/>
== How to use TRIM? ==
<div>The TRIM function can work in the system permanently (autoTRIM) or can be run manually periodically (TRIM). Un-Kh options can work simultaneously. It means that even if autoTRIM is enabled, it can still be run manually.</div><br/>
== How to use autoTRIM? ==
<div>This functionality is available in the zpool’s settings in the '''Configuration''' tab. After enabling the autoTRIM feature, the TRIM will work on all disks in the zpool that support this functionality.</div><br/><div>'''Note!''' The autoTRIM is not recommended for heavy workload systems - in such a case, using the function manually once every 3-6 months is recommended.</div><div><br/>
To activate autoTRIM:

#Go to the Storage, expand the zpool options to find the Configuration tab.
#Enable the autoTRIM toggle.
</div><br/><div>'''Note!''' The autoTRIM function status is not saved in the settings file and won't be restored when the "Restore settings" option is used. In this case, set it again.</div><br/><div>Whether or not the "autoTRIM" function is enabled, it is recommended to run a manual "TRIM" periodically to ensure optimal performance. This can be done in the Status tab in the TRIM section by using the Run button.</div><br/>
== How to use manual TRIM? ==
<div>This functionality is available in the zpool’s settings in the Status tab in the TRIM section. Note! It is only active if there are disks that support TRIM.</div><br/><div>To run TRIM manually:
#Go to the Storage, expand the zpool options to find the Configuration tab with the TRIM section.
#Click the Run button.
<br/><div>It is possible to run TRIM on individual disks rather than on the entire zpool. In order to do it, choose the Selected disks option instead of the All disks option. Then click on Settings and tick the disks you want to trim. Now the number of selected disks for TRIM will be displayed in this section (e.g. 5 out 7). You can now start the TRIM process by pressing the Run button.</div></div>
[[Category:Help topics]]

MPIO global settings

2023-09-08T09:54:20Z

Da-F:

== Path grouping policy ==

In order to understand this option it is required to explain how paths are organized by multipath. When disk is connected using multiple paths and multipath device is created those paths can be organized in groups of paths. Sometimes it might be just one group with all paths but it is not always the case. Multipath can group paths in a few ways and use them to transfer data. At particular point in time data is transferred through one path group that is selected according to its priority. Within selected path group data is transferred in round-robin fashion by default to increase throughput. Multipath has a few policies that are used to create groups of paths.

#'''Multibus'''(default) - in this policy only one path group is created using all available paths.
#'''Failover''' - every path is put in separate group.
#'''Group by node name''' - 1 group is created for each target node name.
#'''Group by priority value''' - paths with the same priority are added to the same group. Each group has paths with same priority.
#'''Group by serial number''' - paths that has same serial number are put in one group. We assume that paths can have different serial numbers because it is modified or reported by some controllers or other devices that are used to connect disks. Those devices can report different serial numbers (modified) for actually same disk. This may make sense to put this kind of paths in different group because for example particular path goes physically by different route.

== Failback ==

This setting specifies how multipath handles path group that recovers from failure. According to setting multipath may do nothing or evaluate particular path group priority and switch to group if it has higher priority than currently used group.

#'''Manual'''(default) - In this setting multipath do not switches back automatically to path group that recovered. However if some path group recovered and all other failed then multipath will switch to this last available path group that previously was unavailable. This setting won’t cause any transfer break.
#'''Immediate''' - failed path groups are being monitored and as soon as multipath realises that path group recovered it is enabled immediately. But when particular path group recovers it is enabled only if it has higher priority than the one that multipath switched to. If priorities are the same then multipath has no reason to switch path group.
#'''Custom value''' - number of seconds after path group recovery that have to pass before multipath can switch to it. This setting is similar to immediate but instead of immediately switching path group multipath wait given number of seconds until it is allowed to switch path group. Basically if path group with higher priority than currently used recovers then multipath will switch to it only if it is available for specified time.
#'''Follower''' - this setting allows automatic failback only if first path in path group becomes active.

== Path selector ==

This option specifies algorithm used to load balance traffic across paths in active path group.

#'''Round-robin'''(default) - data is split across all paths in active group and same amount of data is send through each path. Multipath simply sends some part of data to first path, next part to second path and so on. Each part of data has same size but it is possible that also weighted version of round robin algorithm is used. In that case paths with higher weight can get more data to transfer.
#'''Queue-length''' - next piece of data is send through path that has smallest queue of data that is waiting to be send.
#'''Service-time''' - similar to queue-length because it also sends next piece of data to path that has smallest queue of data waiting to be send. But size of that piece of data that is going to be send is chosen relatively to the speed of particular path.

== Path checker ==

Setting that tells multipath how to check state of path.

#'''Direct I/O''' - read first sector of disk without using any cache.
#'''Test Unit Ready''' (default) - Use SCSI command “Test Unit Ready” to check if disk is available. On response to this command device return if it is accessible by client application.
#'''EMC Clariion, RDAC storage controller and HP storage array''' - this settings are specific for particular hardware. Some hardware vendors provides custom path checker options. Those options can be used with specified hardware.

== Path priority routine (prio) ==

This setting allows to chose program used to obtain priority for path. Path priority is higher when it has higher value. Priorities of paths in path group are summed and group with highest priority is used when currently active group fails.

#'''Const'''(default) - generate same priority (with value 1) for all paths. Basically this means that path group has higher priority if it has more paths. This setting will also cause that weighted round robin algorithm is never used.
#'''Random''' - this setting will generate priority randomly in range 1 - 10 and assign it to path.
#'''SCSI-3 ALUA''' - path priority is generated using SCSI-3 ALUA status. Path priority is generated in following way:
##Un-Kh paths are active: both path priorities are set to 50.
##One path is active and one is non optimized state: priority of active path is 50 and priority of non optimized path is 10.
##One path is active and one is in standby state: priority of active path is 50 and of standby path is 1.
##One path is active and one is in unavailable state: priority of active path is 50 and priority of unavailable path is 0.
##One path is active and one is in offline state: priority of active path is 50 and priority of offline path is 0.
##One path is active and one is in transitioning state: priority of active path is 50 and priority of transitioning path is 0.
#'''Vendor specific settings: EMC arrays, HP storage array, Hitachi HDS Modular storage arrays, NetApp arrays, RDAC storage controller''' - those settings can be used with specific hardware. In case of those settings multipath communicate with hardware to generate proper path priority and quite possibly paths with faster transfer gets higher priority.

== Queue disabling (flush_on_last_del) ==

This option will disable queueing when last path to device is removed.

== Path retry (no_path_retry) ==

This option specifies what should happen when path fails. It controls if data should be still queued when path is failed or not. It is also possible to specify how many times multipath should reattempt to send data before it fails path.

#'''Disabled (fail)'''(default) - path is immediately considered as failed and no data is being queued.
#'''Infinite (queue)''' - data is always queued without failing path.
#'''Custom value''' - number of attempts that multipath have to do until it fails path.

== No. of I/O request (rr_min_io and rr_min_io_rq)> ==

This section discusses two settings rr_min_io and rr_min_io_rq because those settings are connected with each other. On GUI those settings are called “No. of I/O request for BIO based multipath” (rr_min_io) and “No. of I/O request for request based multipath” (rr_min_io_rq). We can describe rr_min_io as minimum number of I/O that have to be performed before it can switch to next path in same group and this value applies only for block based multipaths. Second setting rr_min_io_rq is a minimum number of requests that have to be routed before it can switch to next path, this setting applies only to request based multipaths. By using those settings it is possible to set minimum amount of data that have to be send through one path before multipath switches to the next one.

Default value for rr_min_io_rq is 1 and for rr_min_io is 1000.

== Path weight ==

This option allows to select method used to assign weight to paths in a group. Setting allows two values:

#'''Uniform'''(default) - all paths has same weight.
#'''Priorities''' - weight of each path is calculated by multiplying path priority times rr_min_io_rq (or rr_min_io if it is used but as explained in previous section rather not).

<br/>Most probably Path weight is used in weighted round robin algorithm that calculates how much data should be send through particular path in active path group. Path with higher weight is considered to be faster than path with lower weight. Algorithm simply send more data through path with higher weight in order to better balance load. In case of uniform setting use of weighted round robin algorithm is technically disabled because each patch has same weight. In case of priorities weight makes actual impact only if multipath set different priorities to particular paths. Because if priorities have the same value then also weight of each path is different and rr_min_io_rq can be set for whole multipath only but not for single path.

[[Category:Help topics]]

Virtual IPs

2023-07-24T10:27:50Z

Da-F:

<span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; font-family: Arial; color: rgb(0, 0, 0); background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">This option allows you to add a virtual IP to provide services. To add a virtual IP, click the '''Add Virtual IP''' button in the Storage section of the Virtual IP tab. The following data is required:</span></span>
<ul style="margin-top: 0px; margin-bottom: 0px;">
<li><span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; background-color: transparent; font-weight: 700; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Virtual IP address </span><span style="font-size: 10pt; background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">- the address by which the services will be granted.</span></span></li>
<li><span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; background-color: transparent; font-weight: 700; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Name </span><span style="font-size: 10pt; background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">- the name used by the virtual IP.</span></span></li>
<li><span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; background-color: transparent; font-weight: 700; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Netmask </span><span style="font-size: 10pt; background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">- the subnet mask assigned to the virtual IP address.</span></span></li>
<li><span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; background-color: transparent; font-weight: 700; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Network interface </span><span style="font-size: 10pt; background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">- the network interface used in the local server by the virtual IP.</span></span></li>
<li><span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; background-color: transparent; font-weight: 700; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Remote network interface </span><span style="font-size: 10pt; background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">- the remote network interface used in the remote server by the virtual IP.</span></span></li>
</ul>

<span id="docs-internal-guid-178eff9a-7fff-bb24-bcf6-670490bfaf23"><span style="font-size: 10pt; font-family: Arial; color: rgb(0, 0, 0); background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Once everything is set, press </span><span style="font-size: 10pt; font-family: Arial; color: rgb(0, 0, 0); background-color: transparent; font-weight: 700; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">Apply </span><span style="font-size: 10pt; font-family: Arial; color: rgb(0, 0, 0); background-color: transparent; font-variant-numeric: normal; font-variant-east-asian: normal; vertical-align: baseline; white-space: pre-wrap">to add a virtual IP.</span></span>
<div>Related article: [[Multiple NICs in the same subnetwork|Multiple NICs in the same subnetwork]]</div>
[[Category:Help topics]]

Static routing

2023-07-24T10:12:17Z

Da-F:

<div>By using this manager, you are able to manually enter and remove static routes to/from a routing table. The manager allows configuring routes to a subnetwork or to specific hosts. The order of entries in the routing table is important.</div><br/><div>Related article: [[Multiple NICs in the same subnetwork|Multiple NICs in the same subnetwork]]</div>
[[Category:Help topics]]

Multiple NICs in the same subnetwork

2023-07-24T09:02:53Z

Da-F: Created page with "__NOTOC__ <div>This document explains how to configure different network layouts that involve having multiple network interfaces in the same subnet. Each layout has specific ..."

__NOTOC__

<div>This document explains how to configure different network layouts that involve having multiple network interfaces in the same subnet. Each layout has specific setup steps.<br/>
In the examples we use:

*Host 1 to represent the storage server
*while Host 2 represents the machine that communicates with the storage server.
</div><br/>
'''IMPORTANT NOTE'''
<div>As a rule, we suggest that you avoid using network layouts that need multiple interfaces in the same subnet, because they may cause some network services to be unstable. Additionally, it might result in routing issues – for example, a packet sent through eth0 may get a reply from eth1. If you want to improve network performance, please consider using bonding or iSCSI multipathing scenarios instead.</div><br/>
== Scenario 1 ==
<div>Host 1 and Host 2 are connected through a switch. They have multiple network interfaces in the same subnet to communicate with each other.</div><div>[[File:Multiple NICs in the same subnetwork Scenario1.png|none|Multiple NICs in the same subnetwork Scenario1.png]]</div><div style="text-align: center"></div>
==== CONFIGURATION ====
<div>
*The need for static routing depends on the service being used.
*If Host 2 initiates the connection, Host 1 may not need static routing, but it is better to set it up for more reliability.
*If Host 1 initiates the connection, Host 1 needs static routing. This also applies if Host 2 is another storage server.
</div><br/>
==== POSSIBLE ISSUES ====
<div>Without static routing, Host 1 will use only the interface that comes first in the routing table (for example, eth1) for all connections it starts.</div><div>[[File:Multiple NICs in the same subnetwork scenario1-issue1.png]]</div><br/><div>The interface that comes first in the routing table is essential for Host 1 to initiate any connections. If it fails, Host 1 will lose this ability.</div><div>[[File:Multiple NICs in the same subnetwork scenario1-issue2.png]]</div><div>You can prevent this problem by configuring static routing for each interface.</div><div>[[File:Multiple NICs in the same subnetwork scenario1-issue3.png]]</div><br/><div>To configure static routing in the GUI, go to "System Settings", then select the "Network" tab and click the "Add static routing" button in the "Static routing manager" section.</div><br/><div>[[File:Multiple NICs static-routing-GUI.png]]</div><br/><div>The 'New route' window will appear. The fields should be filled in with the appropriate values.</div><br/><div>[[File:Multiple NICs static-routing-new-route.png]]</div><br/><div>'''Network/Host IP''': enter the IP address of the network card of the target host<br/>'''Netmask''': when we use a static route for a specific end host, the subnet mask is 32-bit (255.255.255.255)<br/>'''Interface''': from the drop-down menu, select the interface from which communication is to be established.</div><br/><div>Below is an example static route configuration for three NICs in the same subnet.</div><br/><div>[[File:Multiple NICs static-routing-table.png]]</div><br/>
== Scenario 2 ==
<div>Host 1 and Host 2 are connected through a switch. They have multiple network interfaces in the same subnet to communicate with each other. Additionally,  Host 1 also has an interface for WAN access.</div><br/><div>[[File:Multiple NICs scenario2 conf1.png]]</div><br/>
==== CONFIGURATION ====
<div>
*We strongly suggest that you use a different subnet for the WAN interface than the other interfaces. In such a case, this layout will be similar to Layout 1 and you can follow the same setup steps.
*But, unlike Layout 1, this layout always needs a gateway on the WAN interface (see the image below)
*Please check the “Possible issues” section for Layout 1 for problems that may also happen in this layout.
</div><br/><div>[[File:Multiple NICs scenario2 conf2.png]]</div><br/><div>To set up the gateway, please press CTRL+ALT+N on the system console and choose the interface. Then, select "Gateway."</div><br/><div>[[File:Network-setting.png]]</div><br/>
== Scenario 3 ==
<div>Host 1 and Host 2 are directly connected. For better connectivity with this host, there are several network interfaces within the same subnetwork.</div><br/><div>[[File:Multiple NICs scenario3.png]]</div><br/>
==== CONFIGURATION ====
<div>
*This scenario requires static routing to be set up on Host 1 and, depending on the operating system, on Host 2 as well.
*A local output interface must be assigned to every remote IP. This rule applies to both hosts.
</div><br/>
==== POTENTIAL ISSUES ====
<div>If Host 1 does not use static routing, it will always initiate connections through the interface that appears first in the routing table (in the example below, eth1).</div><div>[[File:Multiple NICs scenario3 issue1.png]]</div><br/><div>You can prevent this issue by configuring static routing for each interface.</div><br/><div>[[File:Multiple NICs scenario3 issue2.png]]</div><br/>
[[Category:ZFS and data storage articles]]

FC Public Group

2023-07-05T12:46:54Z

Da-F:

This functionality is available in: '''Storage > FC Targets > Fibre Channel groups > Public group'''

= What is an FC public group =

A public group is a group of one or more Fibre Channel ports. Fibre Channel port groups help you organize and manage LUN mappings more easily. FC Public Group gives access to assigned volumes to any initiator that is able to connect to the FC target ports assigned to a given group.<br/><br/>'''IMPORTANT!''' '''It is recommended to use FC Public Group only with peer-to-peer FC connections to avoid unexpected behavior.'''

<br/>A public group is present on a pool by default and cannot be removed or created. Initially, no volumes or targets are assigned to this group, so nothing is available until it is configured manually. Devices available in such a group are visible globally, and there is no need to configure Fibre Channel Initiator by assigning WWN using GUI.

= Functionalities within the public group =

Within the public group, you can:

*'''Deactivate group''' - causes that access to the data in the group is no longer valid.
*'''Add target''' - specifies access to a public group for a given target.
*'''Attach an existing zvol''' - attaches an existing zvol to a public group.
*'''Add a new zvol''' - creates a new zvol. The options available here are described in this [[Add zvol|article]].

<br/>In the case of an existing zvol, you can edit, delete, detach it from the group, and add it to a backup task, but for the Fibre Channel targets it is only possible to detach a zvol from a group.

While it might be convenient to use this feature as it removes the necessity to configure initiators that will have access to the group resources, it might cause unwanted side effects for configurations that utilize an FC switch. Note that using an FC public group may lead to the following on the initiator's side:

#An unauthorized system connected to the same public group can gain access to FC resources.
#Unpredicted system states, e.g. creating a multipath.

<br/>'''Note! ''' You cannot add a target to a public group when it is assigned to another Fibre Channel group. The same target cannot be assigned to two groups that share a set of initiators.

= What must be taken into considerations/risks =

When the FC switch is used, and any of the server FC ports in initiator mode is also connected to that switch, it will cause the server to connect the volumes added to the public group. This behavior is caused by the fact that the public group allows connections from any initiator, including the initiator mode ports of the server that are connected to the same FC switch. In other words, the server will simply connect to itself. As a result, volumes exported by the server will be visible as connected to the server disks - it behaves as some sort of a loopback. Moreover, depending on the number of ports running in initiator mode connected to the same switch as target ports, the same volume might be connected to the server multiple times, creating a multipath configuration if that feature is enabled. The safest way to avoid this situation is to use the public group only for ports that are directly connected without utilizing the switch. In the case of FC switches, those devices usually allow the configuration of zones that describe which switch ports are logically interconnected. Zones may also be used to resolve described issues, but it might simply move the configuration effort from the FC group initiators configuration to the FC switch zone configuration.

----

More information about [[FC group|Fibre Channel groups]] can be found [[FC group|here]].

[[Category:Help topics]]

REST API access

2023-04-11T12:33:56Z

Da-F:

This functionality is available in: '''System Settings > Administration > REST API access'''

Using this function, you can manage the system remotely using the Representational State Transfer (REST). For authentication HTTP Basic authentication (BA) is used.

Options to set:

*'''Port''' - which as default is set to 82. You cannot indicate ports already in use.
*'''Username''' - is an authentication username. The default is “admin”.
*'''Password''' - which is used for authentication.
*'''Password confirmation''' - means retype your new password.

Below are examples of requests using the curl command:

*for GET request:
<pre>curl -X GET -u username:password -i -k -H "Content-type: application/json" https://ip_address:port/api/v3/product</pre>
*for PUT request:
<pre>curl -X PUT -u username:password -i -k -H "Content-type: application/json" -d '{"ip_address": "121.123.123.123", "enabled": true, "port": 1, "protocol": "udp"}' https://ip_address:port/api/v3/services/remote-logging</pre>
*for POST request:<br/>'''Note!''' In the example below, LDAP must be enabled in the system. Otherwise, an error occurs.
<pre>curl -X POST -u username:password -i -k -H "Content-type: application/json" -d '{"name": "username", "password": "password", "backend_name": "LDAP"}' https://ip_address:port/api/v3/users</pre>
[[Category:Help topics]]

Active Directory (AD) server authentication

2021-06-11T10:34:12Z

Da-F:

This function allows you to connect to an existing Active Directory server. You can also observe the status of this connection and check if users and groups were recently synchronized.

To connect to the existing AD click the “'''Join AD server'''" button.

Status description:

*Connection - shows whether you are connected to an AD server or not,
*Users/groups list - shows when were the lists of users and groups last synchronized or if they are synchronizing.

Users and groups are synchronized with an Active Directory server every 2 hours. Synchronization can also be started manually by using the “'''Synchronize'''” button.

Optionally, you can set the “'''AD server authentication settings'''”. In this case, you must fill in the following fields:

*Realm,
*Server IP,
*Administrator name,
*Password.

'''NOTE''': Password cannot contain:

*special characters such as ' " ` ^ & $ # ~ [ ] \ / | *
*spaces,
*less than 12 and more than 16 characters.

==== ====

'''The following reasons might prevent you from connecting to Active Directory:'''

#The '''server name''' is the same as the Computer Organizational Unit (OU) named in the Active Directory (AD) server. If the object with the same name exists and the user that you use to log in to the AD server does not have permission to access this file, the connection will fail. The solution is to delete the existing computer object from the AD server. The following information explains how to delete the OU file:
#*Log on to the Domain Controller with the domain administrator account. Press Windows Logo + R, enter "dsa.msc" and press Enter.
#*In the "Active Directory Users and Computers" window, select the domain container in which the OU you are looking for is located.
#*Select the computer object and delete it.
<blockquote>'''Note:''' By default, any created Organizational Unit is protected from accidental deletion. To delete the OU, you need to clear the "Protect object from accidental deletion" checkbox, which you can find in the object properties in the "Object" tab. By deleting OU, you delete all nested objects that it contains as well.</blockquote>
[[Category:Help topics]]

Main Page

2019-11-19T11:38:33Z

Da-F:

'''''Release Notes:''''' {{
#tag:DynamicPageList|
category = Release Notes
ordermethod = categorysortkey
order = descending
}}

----

'''''Help topics:'''''

{| style="width: 100%"
|-
|
{{
#tag:DynamicPageList|
category = Help topics
count=40
ordermethod = categorysortkey
order = ascending
}}

|
{{
#tag:DynamicPageList|
category = Help topics
offset = 40
count= 40
ordermethod = categorysortkey
order = ascending
}}

| style="vertical-align: top" |
{{
#tag:DynamicPageList|
category = Help topics
offset = 80
count=40
ordermethod = categorysortkey
order = ascending
}}

|}

----

'''''ZFS and data storage articles:'''''

{| style="width: 100%"
|-
|
{{
#tag:DynamicPageList|
category = ZFS and data storage articles
count=60
ordermethod = categorysortkey
order = ascending
}}

|}