|
Last Updated |
27 August 2026 |
-
1OneFS Version Requirements:
-
For SMB workloads using CEE with RabbitMQ, the minimum required version of OneFS is v8.1.0.x.
-
For SMB workloads using syslog, the minimum required version of OneFS is v9.5.0.x. PeerSync is not supported for SMB workloads using syslog.
-
For NFS and multi-protocol workloads using syslog, the minimum required version of OneFS is v9.5.0.x. PeerSync is not supported for NFS or multi-protocol workloads. CEE with RabbitMQ is not supported for NFS or multi-protocol workloads.
-
-
Any server that will be interfacing with a PowerScale cluster through a Peer Agent or PeerSync must reside within the same domain, the same network segment, and the same subnet as the cluster. Specifically, this connection should be established on OneFS's "external" network, not the internal one. Additionally, the network connection between OneFS and the Agent or PeerSync must operate at speeds of at least 1 Gbit/sec with sub-millisecond latency.
-
Time Synchronization: The server hosting the Peer Agent or PeerSync as well as the PowerScale cluster must synchronize their system clocks with the same private or public Network Time Protocol (NTP) service. If you are using virtual machines, ensure that time synchronization between the VM and the hypervisor host is disabled so that the VMs rely solely on NTP for timekeeping.
-
Server OS Version Requirements:
-
For SMB workloads, the minimum version of Windows required for PowerScale support with the Peer Agent or PeerSync is Windows Server 2016.
-
For NFS and multi-protocol workloads, the Peer Agent must be installed on Ubuntu Server 22.04 operating system or later, Red Hat Enterprise Linux v9.x or later, or Rocky Linux v9.x or later. PeerSync is not supported for NFS or multi-protocol workloads.
-
-
The server hosting the Peer Agent or PeerSync must not run any other products based on the Common Event Enabler (CEE) framework or syslog from Peer Software or any other vendor. In addition, no other Peer Software components can be run on this server (such as Peer Management Center).
-
Messaging Infrastructure Restrictions:
-
For environments using CEE with RabbitMQ, no other CEE-based applications can utilize the CEE framework on the PowerScale cluster. This restriction does not apply to environments using syslog.
-
For environments using syslog, any other audit vendors utilizing syslog with OneFS must employ TLS for secure communication.
-
-
Authentication Requirement for OneFS v9.2 and later: Basic Authentication must be enabled on the cluster. To do so, run the following console/SSH command:
isi_gconfig -t web-config auth_basic=true -
When connecting a Peer Agent or PeerSync to an access zone other than the default System zone, each node in the cluster must possess an accessible IP address within the IP range associated with the intended access zone.
-
The PowerScale cluster's Management IP must be within the System access zone.
-
Privileges and Permissions for SMB Workloads:
-
The service account for Peer Agent or PeerSync must have local administrator privileges on the Windows Server where the Peer Agent or PeerSync will be hosted.
-
The service account for Peer Agent or PeerSync must be included as a local administrator on the PowerScale cluster.
To add an account to the local administrators group on the cluster, run the following console/SSH command:isi auth groups modify --group=administrators --add-user=<Domain Name>\\<User Name> -
The service account for Peer Agent or PeerSync must be granted root access to all shares, both source and target, that the Peer Agent or PeerSync will connect to.
To add a new account permission with root access to a share, run the following console/SSH command:isi smb shares permission create <Share Name> <User Name @ Domain Name> --run-as-rootTo change an existing account permission on a share to root access, run the following console/SSH command:
isi smb shares permission modify <Share Name> <User Name @ Domain Name> --run-as-root
-
-
Privileges and Permissions for NFS Workloads:
-
The Peer Agent server IP needs to be granted read/write and root access to the exports that this Agent will be monitoring.
-
NFSv4 ACL support requires:
-
Name Mapping to be enabled.
-
The Peer Agent server to be in the same DNS domain as its associated PowerScale cluster.
-
-
-
Privileges and Permissions for Multi-Protocol Workloads:
-
When replicating Windows-style or Mixed permissions, the domain account used by the Samba connection of the Peer Agent must be included as a local administrator on the PowerScale cluster.
To add an account to the local administrators group on the cluster, run the following console/SSH command:isi auth groups modify --group=administrators --add-user=<Domain Name>\\<User Name> -
When replicating Windows-style or Mixed permissions, the domain account used by the Samba connection of the Peer Agent must be granted root access to the shares that it will be monitoring.
To add a new account permission with root access to a share, run the following console/SSH command:isi smb shares permission create <Share Name> <User Name @ Domain Name> --run-as-rootTo change an existing account permission on a share to root access, run the following console/SSH command:
isi smb shares permission modify <Share Name> <User Name @ Domain Name> --run-as-root -
The Peer Agent server IP needs to be granted read/write and root access to the exports that this Agent will be monitoring.
-
When replication Linux-style or Mixed permissions, NFSv4 ACL support requires:
-
Name Mapping to be enabled.
-
The Peer Agent server to be in the same DNS domain as its associated PowerScale cluster.
-
-
-
API Permissions: The Peer Agent and PeerSync must both be configured with an API user account in OneFS with appropriate access. It is recommended that this be a dedicated local account on the associated cluster just for the use of Peer products.
If you are unable to use a built-in admin account, you can create a local account with the exact privileges using the following SSH commands. Note that certain characters need to be escaped in the password. Please review OneFS documentation for details.Bashisi auth users create --password=<PASSWORD> --password-expires=false --enabled=true <USERNAME> isi auth roles create --name=PeerREST --description="Role for Peer REST access" isi auth roles modify PeerREST --add-user=<USERNAME> isi auth roles modify PeerREST --add-priv-read=ISI_PRIV_NETWORK isi auth roles modify PeerREST --add-priv-read=ISI_PRIV_LOGIN_PAPI isi auth roles modify PeerREST --add-priv-write=ISI_PRIV_AUDIT : For SMB or multi-protocol, the role needs the following privileges: isi auth roles modify PeerREST --add-priv-read=ISI_PRIV_SMB isi auth roles modify PeerREST --add-priv-read=ISI_PRIV_SMB_SHARES : For NFS or multi-protocol, the role needs the following privileges: isi auth roles modify PeerREST --add-priv-read=ISI_PRIV_NFS isi auth roles modify PeerREST --add-priv-read=ISI_PRIV_NFS_EXPORTS : If snapshots are to be used, the role needs the following privilege: isi auth roles modify PeerREST --add-priv-write=ISI_PRIV_SNAPSHOT-
API Account Requirements for PeerSync ONLY: To connect PeerSync to an access zone other than the default System zone, this API account must have ZoneAdmin privileges within the intended access zone. It's essential to note that the default root and admin accounts are not automatically granted these privileges when an access zone is created.
Starting in v6.1, PeerGFS no longer has this requirement.
To grant ZoneAdmin privileges to a user within a specific access zone, run the following console/ssh command:isi auth roles modify ZoneAdmin --zone <Access Zone Name> --add-user=<API User Name>
-
-
The use of NFS aliases is currently not supported.
-
No firewalls (software or hardware) should be enabled between the server hosting Peer Agent or PeerSync and the PowerScale cluster. If firewalls cannot be disabled, review the Firewall Requirements guide for details on the specific ports that must be opened.
Known Limitations
-
When using PowerScale OneFS v9.5+ with syslog, MED pattern matching is not fully functional due to a limitation in OneFS. We are currently investigating this with Dell.
Related articles
- Achieving high availability for the PMC through active-passive configuration
- Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)
- Achieving high availability for the PMC through active-passive configuration (v5.2 only)
- Achieving high availability for the PMC through active-passive configuration (v6.0 and later)
- Amazon FSx for NetApp ONTAP Prerequisites
- Dell PowerScale Prerequisites
- Dell PowerStore Prerequisites
- Dell Unity Prerequisites
- Firewall Requirements
- Getting Started with Multi-Protocol for PeerGFS
- Issues runing PeerSync as a service
- NetApp ONTAP Prerequisites
- Nutanix Files Prerequisites
- Peer Global File Service - Environmental Requirements
- PeerGFS jobs fail to start after initial job due to NetAPP ONTAP v9.15.1 upgrade