--- language: "en" --- # Peer Knowledge Base Home ## [PeerGFS](https://kb.peersoftware.com/kb/peergfs.md) ### [PeerIQ](https://kb.peersoftware.com/kb/peeriq.md) ### [PeerSync](https://kb.peersoftware.com/kb/peersync.md) ### [Analytics](https://kb.peersoftware.com/kb/analytics.md) ### [Getting Started](https://kb.peersoftware.com/kb/getting-started.md) ### [Advisories](https://kb.peersoftware.com/kb/advisories.md) * ### [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) --- language: "en" --- # 8.3 short file names cause out of sync file/folder data ## Problem In some scenarios, PeerGFS/PeerLink has undertaken the replication of data and has applied file and folders with their short name (8.3) paths referenced. The result is that when the dataset is queried across locations, it does not match and will appear with duplicated information in some locations. In the following example, two of the folders names have been truncated: ## ![image2019-12-23_11-44-24.png](https://kb.peersoftware.com/__attachments/a_1cd29d3b0628a69f255b1554291d4b2dc31c4fc5867c7d5a23893cb8b11d2e1e/image2019-12-23_11-44-24.png?cb=b6e6e911613a687114ae7239ea89cff2) ## Cause This behavior is usually triggered in environments where the 8.3 naming convention is both enabled and disabled across different watched volumes. For example, if a source system is a Windows Server 2008, the 8.3 naming convention will be enabled across all volumes. However, if this server replicates to a Windows Server 2012 R2, the 8.3 naming convention will be disabled, which can result in problems as PeerGFS/PeerLink now looks to translate the 8.3 short names at the operating system level and will be unable to do so. Therefore, a new folder/file would be created solely with the short name as its full name. Note PeerGFS v4.5 (and later) checks whether 8.3 short names are disabled on watched volumes. ## Diagnosis To determine the extent of the problem, check the files on both servers to see the complete 8.3 file breakdown: 1. In a command prompt, cd to the watch set configured in PeerGFS/PeerLink and enter the following command: **dir /x** This lists both the long and short names. For servers with issues, the short name path will appear in the far-right column. ![image2019-12-23_12-12-11.png](https://kb.peersoftware.com/__attachments/a_201328323910be38954d9c3f3172dd474f150a0ee627c08a1e35178b94339246/image2019-12-23_12-12-11.png?cb=14134dc9f289313edaa1402d0069a93b) 2. To query whether the 8.3 naming convention is enabled or disabled, enter the following command on all servers: fsutil.exe 8dot3name query E: (replace *E* with the volume letter for that server) ![image2021-4-22_14-23-54.png](https://kb.peersoftware.com/__attachments/a_b799751b71d99c4c5f177a7c85858dd1d4c29b8696dc50396842b0eea638adcd/image2021-4-22_14-23-54.png?cb=e9d08f8ad04e94b0e90d1cc8ed3e80b0) ## Solution 1. [Disable the 8.3 short naming convention.](https://kb.peersoftware.com/kb/8-3-short-file-names-cause-out-of-sync-file-folder.md#id-8.3shortfilenamescauseoutofsyncfile/folderdata-Disableshortname) 2. [Clean the data by removing the 8.3 short name references](https://kb.peersoftware.com/kb/8-3-short-file-names-cause-out-of-sync-file-folder.md#id-8.3shortfilenamescauseoutofsyncfile/folderdata-Cleanthedata). ### Disable the 8.3 Short Naming Convention Before disabling the 8.3 naming convention, ask the customer whether any legacy applications are using it. If not, you can proceed by disabling the convention. To disable 8.3 name creation on all NTFS partitions: 1. Type **fsutil.exe behavior set disable8dot3 1** at an elevated command prompt. 2. Press **Enter** . This operation takes effect immediately (no restart required). Note When a volume is not specified, the operation updates the registry value: * 0 - Enable 8dot3 name creation on all volumes on the system * 1 - Disable 8dot3 name creation on all volumes on the system * 2 - Set 8dot3 name creation on a per volume basis * 3 - Disable 8dot3 name creation on all volumes except the system volume When a volume is specified, the operation updates the individual volume's on disk flag. This operation is meaningful only if the registry value is set to 2. * 0 - Enable 8dot3 name creation on this volume * 1 - Disable 8dot3 name creation on this volume ### Clean the Data After disabling the 8.3 naming convention, the dataset must be completely cleaned to stop any reoccurrence: * Before cleaning the dataset, turn off the PeerGFS job. * If only a small portion of data is affected, the cleaning can be done manually. * If the problem occurs across the file system, [use this script](https://kb.peersoftware.com/kb/8-3-short-file-names-cause-out-of-sync-file-folder.md#id-8.3shortfilenamescauseoutofsyncfile/folderdata-Script) to clean the file system: [StripLocal83Shortnames_v005.txt](https://kb.peersoftware.com/__attachments/a_3caf27ee2e761c8eb9ae9218316dc7ad488399b5a23cf15dc348a55fe01a214f/StripLocal83Shortnames_v005.txt.md?cb=a545ef796af8339675acedb17f6e31ae) * After cleaning the data, restart the PeerGFS job, and the data will replicate correctly. #### Using the Script * The script must be run under an account with local admin rights on the local file server. * 8.3 short names must be disabled on the file server prior to running the script. * PowerShell v5.1 is required (). * Usage: .\\StripLocal83Shortnames.ps1 -Path \ -LogPath \ -PrintToScreen \ -ReportOnly \ * After running the script, review the log files to confirm that no errors have occurred: \\\strip8.3.log \\\strip8.3_error.log \\\strip8.3_skip.log ## Related articles Wikipedia article: How to disable the 8.3 short name convention: * [8.3 short file names cause out of sync file/folder data](https://kb.peersoftware.com/kb/8-3-short-file-names-cause-out-of-sync-file-folder.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) --- language: "en" --- # Achieving high availability for the PMC through active-passive configuration Select the appropriate configuration guide based on your version of PeerGFS: * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) --- language: "en" --- # Achieving high availability for the PMC through active-passive configuration (v5.2 only) Version applicability This article applies to PeerGFS version 5.2 only. If you are using a different version, see one of the following: • [Achieving high availability for the PMC through active-passive configuration (v4.7.0--v5.1.1)](https://peersoftware.atlassian.net/wiki/display/KB/Achieving+high+availability+for+the+PMC+through+active-passive+configuration+(v4.7.0%E2%80%93v5.1.1)) • [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) This article describes how to achieve high availability for the Peer Management Center by setting up an active-passive configuration. It covers: * An overview of active-passive configuration. * Setting up active-passive configuration. * Performing manual failover to the passive PMC. * Configuring automatic failover to the passive PMC. ## Overview With an active-passive configuration, you run an active PMC server (physical or virtual) with a second passive PMC server (physical or virtual) configured as a backup. When a failure occurs on the active PMC server, the passive PMC server is ready to take over the work of the active server. Agents will automatically failover from the active PMC server to the passive PMC server. Manual failover of the PMC itself requires minimal user interaction while automatic failover requires no user interaction. After PMC failover, jobs set to auto-start will automatically start on the passive server. ### Benefits The benefits of an active-passive configuration include the absence of a need for additional hardware and software, except for provisioning a new physical or virtual server. Furthermore, it is a simpler and more cost-effective solution to implement across multiple locations, particularly for covering PMC disaster recovery scenarios. ### Licensing Since only one PMC server is active at a time, only one PeerGFS license is needed. You are allowed to use the same license on the active and passive servers but only one server can be active at a time. If you try to start a second PMC when there is a running PMC, then the second one will not be allowed to start. When this is attempted, an alert will be sent to the running PMC before shutting down the second PMC. ### Prerequisites * Ensure that the identical version of Peer Management Center is already installed on both the active and passive servers, leaving the passive PMC unlicensed and unconfigured. * If you are using a network of brokers, set up the broker network **before** setting up active-passive configuration. Details on how to set up a network of brokers can be found here: [Getting Started with Network of Brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md). Once the network setup is complete, you can skip the **Setting Up an Active-Passive Configuration** section and jump to either **Performing Manual Failover to the Passive PMC Server** or **Configuring Automatic Failover** below. ## Setting Up an Active-Passive Configuration Setup of active-passive configuration involves: * Task 1: Adding sites to the topology - Establish connectivity within the topology to enable mutual awareness between the two PMCs for seamless failover operations and to guarantee synchronization of their configurations. * Task 2: Configuring Agents to failover to the passive server -- Set up each Agent to automatically failover to the passive PMC when the active PMC is inaccessible, and failback to the original PMC when it is available again. This section describes how to configure each PMC server so that they are connected together. Start with the currently active PMC followed by the passive one. ### Task 1: Adding sites to the topology To add the active and passive PMC servers to the topology perspective: 1. Open the PMC on the active PMC server. The active PMC server is the one that is licensed and configured. 2. Click the **Open Perspective** icon in the upper right corner of the PMC. ![Open Perspective.png](https://kb.peersoftware.com/__attachments/a_c7e6625e155fb7c3fb257bb0f166b8d9a25798c08e8e20d90b6f2c264979618a/Open%20Perspective.png?cb=b4f460b12d39285407c632008368f7bc) 3. Select **Topology** , and then click **Open** . The Topology Perspective appears. ![TopologyPerspAddSite.PNG](https://kb.peersoftware.com/__attachments/a_ea31e489788f9975cdc3024b2fa1b246fc21265fe7dfa8a180b57bdc8f5d07ec/TopologyPerspAddSite.PNG?cb=67c94a48673256e0e5afd59cbfdf4066) 4. Click the **Add** **Site** button to open the **Add Site** wizard. 5. Name the site, drag the site icon to the desired location on the topology map, and then click **Next** . ![AddSite1.PNG](https://kb.peersoftware.com/__attachments/a_d2a17b53859a77419e469b87fb9a3d07cb51069a3acc1273f779169d3e51a470/AddSite1.PNG?cb=7ff86ad65f96557a36953bc837b10c79) 6. (Optional) Enable TLS to encrypt all broker connections to and from this site. ![AddSite2.PNG](https://kb.peersoftware.com/__attachments/a_7f274496f807651e7765931688014200d9599c9fd4b9b087bc67ff62154f9007/AddSite2.PNG?cb=2787cbb1b3d5ffc659440170a9df9903) 7. Click **Next**, 8. Configure the broker on this PMC host: ![AddSite3.PNG](https://kb.peersoftware.com/__attachments/a_fea0c42f523cbf5f6f67ad2da1ad6200fc1c04352344126cbc32bd61f8e40d68/AddSite3.PNG?cb=9e828139e8d842501fb5d2e90130ac51) 1. Enter a host name in the **Hostname** field. 2. In the **Failover Method** section, keep the default failover method of **All Primary**. 3. In the **Network Interfaces** section, enter one or more IP addresses for the broker. 4. Keep the default value for the available bandwidth. **Note:** Ensure that network routing policies are set correctly to achieve the desired behavior. Note that PeerGFS has no control over these policies, so please contact your network administrator for assistance. 9. Click **Finish**. 10. Repeat Steps 4-8 for the passive PMC. After adding the second (passive) PMC, the new site will momentarily have a status of **Unconfigured** before being automatically configured with the same settings as the active PMC. After this, the second PMC should have a status of **Online** but will be in a passive state. ![TopologyPersp2PMCs.PNG](/__attachments/a_41bba7fbab6c82e9ef547d54784eff82e0361a8e347864ed87149d3772838d3f/TopologyPersp2PMCs.PNG?cb=882028d8f93da67060e6fb1d912092f0) ### Task 2: Configure Agents to Failover to the Passive Server This section outlines the steps needed to configure all Agents for failover to or from the passive server. This process entails making modifications to the Broker configuration for each individual Agent. 1. Within the Peer Management Centerclient, select all Agents, right-click and select the **Edit Agent Configuration on Selected Agents** option, and then click **OK** in the message that appears. ![Edit Agent Configuration.png](https://kb.peersoftware.com/__attachments/a_578fcad0d7b7e0f3b8babd0baec8986f890cce684b480f8012cd489d03940bea/Edit%20Agent%20Configuration.png?cb=3611af4d87146c9ac06c569903af57f4) 2. In the **Failover Brokers** section, add the broker IP address for the **passive** server in **Broker Hosts** field (if there is an address already present, then add the new address separated by a comma). Note: Do not change the primary broker, even if there are multiple values in Broker Hosts. If a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md) is deployed, then ensure that both the active **and** passive PMC are included in one of the **Broker Hosts** fields. ![Broker Hosts.png](https://kb.peersoftware.com/__attachments/a_09cfa1f300c7bdbe74ff7dedbfc946a2fe2041d5261b450c302f3368dd74e67f/Broker%20Hosts.png?cb=323bb9fdc62fee174e3df0d664ee0b8e) 3. Set the connection type appropriately for your environment, and then click **OK**. 4. Restart all Agents by selecting all Agents in the **Agents** view, and then right-clicking and selecting the **Restart Agent Service** option. ![Restart Agent Service.png](https://kb.peersoftware.com/__attachments/a_9e0e3b878911a808633f27da9bba742afdcb5e78b6ecfece51666493fec2cc37/Restart%20Agent%20Service.png?cb=05c30e38428e42204c3654720e652fbf) ## Performing Manual Failover to the Passive PMC Server This section describes the actions to take when failing over between the active and passive PMC servers. There are two scenarios covered in this section: * Performing a planned failover between PMC servers * Manually enabling a passive PMC after failure ### Scenario 1: Performing a planned failover between PMC servers Occasionally, deliberate control transfer between PMC servers may be necessary, often as part of routine maintenance procedures. To activate a passive PMC server: 1. Open the PMC on the currently active PMC server. 2. Open the Topology perspective. 3. Select the passive PMC site in the **Sites**panel. 4. Click the **Activate PMC** button. ![Activate Passive PMC.PNG](https://kb.peersoftware.com/__attachments/a_53cff9b1460850b8e35e0ed0c73cccfd4716cb36b4de47ebed34c0a03e126e86/Activate%20Passive%20PMC.PNG?cb=e56126ae682195a144e51114af88b971) 5. Click **OK** in the message that appears. Once this has been done, the two PMCs will negotiate the handover of control. Any jobs that are configured to automatically start will do so. ### Scenario 2: Manually enabling a passive PMC after failure In the event of a genuine failure necessitating environment recovery, this section describes the process to disable the active PMC and manually start the passive PMC. Even if connectivity between the PMCs is lost, it remains necessary to deactivate the currently active PMC. #### Disable the active PMC To disable the active PMC, follow these steps if the original active PMC server is still available: 1. Launch the PMC on the active PMC server. 2. Open the **Topology** perspective. The passive PMC will appear to be offline as there is no network connectivity between them. ![PMCOffline.PNG](https://kb.peersoftware.com/__attachments/a_8826a36259178f90c12eef9628a4f75c88a0ed937574d16de64cabe5510b3334/PMCOffline.PNG?cb=1254a4635c3808e4d036999f5478d137) 3. Select the active PMC in the **Sites** view, and then click the **Deactivate PMC** button in the **Details** view. ![DeactivatePMC.PNG](https://kb.peersoftware.com/__attachments/a_086c395ac6716e20fb956a4c900241e54d110c8c19f5dcb70e991788d9411e4d/DeactivatePMC.PNG?cb=be922696e45ef4010224fcf9dd638099) The PMC will automatically close and all Peer Management services will be stopped. #### Enable the passive PMC To enable the passive PMC, you must manually start the Peer Management service. These steps vary depending on the operating system hosting the passive PMC. Enable passive PMC on Windows manually 1. Log in to the passive PMC server. 2. Open the **Windows Services** application and find the Peer Management Services. The number of Peer Management services listed will vary, depending on your installation. ![Services.PNG](https://kb.peersoftware.com/__attachments/a_879830aeb2326837017d8c98df1b6f5c61a4929d88e738bf3fed7ceec90b5e90/Services.PNG?cb=379c5c6475a2b87f7adaef572d3f2f73) 3. Edit the properties of each **disabled** service: 1. Change **S** **tartup type** from **Disabled** to **Automatic**. 2. Click **OK** to save the changes. ![Peer Management Broker Service Properties image](https://kb.peersoftware.com/__attachments/a_f0d9dbb79aaf3f876650ed9daefcc609d0e3170702ba7401c730e7feb4adeab4/Peer%20Management%20Broker%20Service%20-%20Change%20Startup.png?cb=e222f0d998949447800e6a9befd50b5e) 4. Start the services that were just enabled. The PMC will start and become active. Any jobs marked to automatically start will do so. Enable passive PMC on Linux manually 1. Use SSH to connect to the Linux server where the passive PMC is installed. 2. Run the following commands to enable PMC services. sudo systemctl enable PL-Hub-Service.service sudo systemctl enable PL-Hub-Web-Service.service sudo systemctl enable PL-Hub-Service.service sudo systemctl enable PMC-API-Service.service 3. Run the following commands to turn on PMC services. The PL-Hub-Service must be started first. sudo systemctl start PL-Hub-Service.service sudo systemctl start PL-Hub-Web-Service.service sudo systemctl start PL-Hub-Service.service sudo systemctl start PMC-API-Service.service ## Configuring Automatic Failover The preceding sections have explained the manual execution of failover operations. However, depending on your license, you can configure two PMCs to automatically switch over between each other in the event of a failure. To enable automatic failover: * Verify that the environment is licensed for automatic failover. * Install the **watch node** broker. * Configure automatic failover. **Note:**In automatic failover scenarios, no PMC is designated as more important or given higher priority. As a result, automatic failback is not inherent. If there is a preference for a specific PMC to be active, it must be manually accomplished by following the steps outlined in the planned manual failover process. ### Verify that the environment is licensed for automatic failover 1. Open the PMC client (rich or web) 2. From the **Help** menu, select **Licenses**. 3. Verify that **Automatic Failover** is enabled in the **Licensed Features** section. ![Licensing.png](https://kb.peersoftware.com/__attachments/a_144834457947f0d42d1e34b5beb4f7ec32d386a8f710f85f80974043d30ab679/Licensing.png?cb=4e88c0ad58c6d3b3dcb91f29f0ad40b9) ### Install the watch node broker For automatic failover to function, each PMC server must be aware of the connected and disconnected status of other PMC servers in the environment. This awareness is facilitated through the establishment of a reliable third point of view. To achieve this, a broker known as a **watch node** is introduced to the environment, positioned independently and not affiliated with either PMC site. Install a watch node broker on Windows 1. Use Remote Desktop to connect to a Windows Server where the broker is to be installed. 2. Download the broker installer using one of the following methods: • In the PMC, select the **Download Broker Installer** command from the **Help** menu. • Use the download link that is included in the email containing your new PeerGFS license. 3. Right-click the installer and choose **Run as administrator** . ![image2023-12-20_11-9-39.png](https://kb.peersoftware.com/__attachments/a_95b1b9aafaf17fbe423b2ca95e37b7ea14726b19c6c904c39da736bf794af107/image2023-12-20_11-9-39.png?cb=c849019cca96661d17992ad47009e112) 4. Read and accept the license agreement. ![image2023-12-20_11-10-33.png](https://kb.peersoftware.com/__attachments/a_e70767905f7d63298fef3c495a06936bc007ec0fa6704aae8c1f9d8508ee41d3/image2023-12-20_11-10-33.png?cb=e1589845f12c3dc2f8669fe83c2e843e) 5. Confirm the location of the installation directory. ![image2023-12-20_11-10-54.png](https://kb.peersoftware.com/__attachments/a_f64fcdd96eba066a25933faf6e2a4abfc23a1fe01707a08ef99fc0523261a866/image2023-12-20_11-10-54.png?cb=4dbe04e4b1d9ec1d812f26f1dd5e6973) 6. Confirm the location of the Start Menu folder. ![image2023-12-20_11-11-16.png](https://kb.peersoftware.com/__attachments/a_1f97edfdabe4f7bc10daa36795be702f464536dc9fd4bc1cb4826ddb0685151a/image2023-12-20_11-11-16.png?cb=1be19871bd1064ad58150d88a44af14e) 7. Finish the installation. If this is a new installation, add the recommended firewall rules if needed. All brokers connect to each other on TCP ports 61616 (TCP) or 61617 (TLS); therefore access to these ports is required. ![image2023-12-20_11-18-22.png](https://kb.peersoftware.com/__attachments/a_d8ebae852fb22c21c7e4f2fb0c6b8a615ac1a0de1bb43487ba55f20767525a01/image2023-12-20_11-18-22.png?cb=639884a38fb1df29043a52a04c166f31) 8. Once the watch node broker has been installed, add the new site to the topology perspective in the same way as described in [Task 1. Adding sites to the topology](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v5.2only)-Task1). Install a watch node broker on Linux 1. Use SSH to connect to the Linux server where the broker is to be installed. 2. Download the broker installer using one of the following methods: • If you are running a Linux-based PMC, select the **Download Broker Installer** command from the **Help** menu in the PMC web client. • Use the download link that is included in the email containing your new PeerGFS license. 3. Make the .sh installer executable by running: sudo chmod a+x \ 4. Run the .sh installer by running: sudo . /\ 5. Follow the prompts. 6. Finish the installation. If this is a new installation, add the recommended firewall rules if needed. All brokers connect to each other on TCP ports 61616 (TCP) or 61617 (TLS); therefore access to these ports is required. 7. Once the watch node broker has been installed, add the new site to the topology perspective in the same way as described in [Task 1. Adding sites to the topology](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v5.2only)-Task1). ### Configure automatic failover To configure automatic failover: 1. Navigate to the topology perspective within the PeerGFS client. 2. Click the **Failover Options** button. ![image2023-12-20_11-14-22.png](https://kb.peersoftware.com/__attachments/a_a95ef6e4dc565d30551f229d07ffc8460095411f09f19dba4f94f2b7743b9853/image2023-12-20_11-14-22.png?cb=67c9235633d6728db24d3f1e354d3b46) The **Failover Options** dialog appears. ![FailoverDialog.PNG](https://kb.peersoftware.com/__attachments/a_243f5e78278d3ecb1bc861cfd1c2936b1293542606462e9408499abb4c344924/FailoverDialog.PNG?cb=e7cb3d07dc4b2f1f98a06987a86f7074) 3. Select **Enable Auto-Failover**. 4. Select a watch node broker. If your environment utilizes a Network of Brokers, all configured brokers will be available as options. 5. Click **OK** . ## Best Practices for PMC Failover and Network Planning Considerations during a failover event: **PeerGFS web server configuration** * Take note of the hostname used in your PeerGFS web service configuration, especially if you plan to use web access during a failover event. * The web service port (default: 8443) binds to the hostname specified in the configuration. * To ensure access to either PMC's web server---during normal operation or after a failover---set the hostname to the default value of `0.0.0.0`. This allows access using the server's NetBIOS name, FQDN, or IP address. * During a failover, point your browser to the secondary PMC's address. **Network connectivity** * Ensure that all PMCs and the watch node broker can receive incoming network connections. **Location planning** * Place the watch node broker in a neutral location relative to both PMCs. * In both local and distributed environments, avoid creating a single point of failure by positioning PMCs and the watch node broker strategically. * A well-planned layout helps ensure resilience in the event of a failover. ## Troubleshooting ### PMC startup failure * Verify that another PMC instance is not already running. * If automatic failover is enabled, ensure that the watch node broker or passive PMC is online. ### Lack of passive PMC or watch node broker If automatic failover is enabled and there is no passive PMC or watch node broker available: * A PMC using automatic failover requires the presence of either a watch node broker or passive PMC to remain active. * If neither is available, you must disable automatic failover to allow the PMC to continue running. **To manually disable automatic failover:** 1. Edit the `SPGlobal.prefs` file located in the `workspace/prefs` directory. 2. Change the value of `autoFailover` from `true` to `false`. ## Related articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Can a job back up files that were created between two specific dates?](https://kb.peersoftware.com/kb/can-a-job-back-up-files-that-were-created-between-.md) * [Can PeerSync change an IP address to point to a backup server?](https://kb.peersoftware.com/kb/can-peersync-change-an-ip-address-to-point-to-a-ba.md) * [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) * [Getting Started with Network of Brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md) * [Maximize network throughput](https://kb.peersoftware.com/kb/maximize-network-throughput.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) * [Peer Global File Service - Environmental Requirements](https://kb.peersoftware.com/kb/peergfs-environmental-requirements.md) * [PeerGFS jobs fail to start after initial job due to NetAPP ONTAP v9.15.1 upgrade](https://kb.peersoftware.com/kb/job-start-issues-with-ontap-9.15.1.md) * [PeerSync - Environmental Requirements](https://kb.peersoftware.com/kb/peersync-environmental-requirements.md) * [Prerequisites](https://kb.peersoftware.com/kb/prerequisites.md) * [Schedule upload of PMC and Agent logs to Peer Software Support](https://kb.peersoftware.com/kb/peergfs-schedule-upload-of-logs-to-support.md) --- language: "en" --- # Achieving high availability for the PMC through active-passive configuration (v6.0 and later) ## Version applicability This article applies to PeerGFS version 6.0 and later. If you are using an earlier version, see one of the following: • [Achieving high availability for the PMC through active-passive configuration (v4.7.0--v5.1.1)](https://peersoftware.atlassian.net/wiki/display/KB/Achieving+high+availability+for+the+PMC+through+active-passive+configuration+(v4.7.0%E2%80%93v5.1.1)) • [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) This article describes how to achieve high availability for the Peer Management Center by setting up an active-passive configuration. It covers: * An overview of active-passive configuration. * Setting up active-passive configuration. * Performing manual failover to the passive PMC. * Configuring automatic failover to the passive PMC. ## Overview With an active-passive configuration, you run an active PMC server (physical or virtual) with a second passive PMC server (physical or virtual) configured as a backup. When a failure occurs on the active PMC server, the passive PMC server is ready to take over the work of the active server. Agents will automatically failover from the active PMC server to the passive PMC server. Manual failover of the PMC itself requires minimal user interaction while automatic failover requires no user interaction. After PMC failover, jobs set to auto-start will automatically start on the passive server. ### Benefits The benefits of an active-passive configuration include the absence of a need for additional hardware and software, except for provisioning a new physical or virtual server. Furthermore, it is a simpler and more cost-effective solution to implement across multiple locations, particularly for covering PMC disaster recovery scenarios. ### Licensing Since only one PMC server is active at a time, only one PeerGFS license is needed. You are allowed to use the same license on the active and passive servers but only one server can be active at a time. If you try to start a second PMC when there is a running PMC, then the second one will not be allowed to start. When this is attempted, an alert will be sent to the running PMC before shutting down the second PMC. ### Prerequisites * Ensure that the identical version of Peer Management Center is already installed on both the active and passive servers, leaving the passive PMC unlicensed and unconfigured. * If you are using a network of brokers, set up the broker network **before**setting up active-passive configuration. For details on how to set up a network of brokers, see [Getting Started with Network of Brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md). Once the network setup is complete, you can skip the **Setting Up an Active-Passive Configuration**section and jump to either **Performing Manual Failover to the Passive PMC Server** or **Configuring Automatic Failover** below. ## Setting Up an Active-Passive Configuration Setup of active-passive configuration involves: * **Task 1: Adding sites to the topology**- Establish connectivity within the topology to enable mutual awareness between the two PMCs for seamless failover operations and to guarantee synchronization of their configurations. * **Task 2: Configuring Agents to failover to the passive server** -- Set up each Agent to automatically failover to the passive PMC when the active PMC is inaccessible, and failback to the original PMC when it is available again. This section describes how to configure each PMC server so that they are connected together. **Start with the currently active PMC followed by the passive one.** ### Task 1: Adding PMC sites to the topology To add the active and passive PMC servers to the Topology perspective: 1. Open the PMC on the active PMC server (the licensed and configured instance). 2. Click the **Open Perspective** icon in the upper right corner of the PMC. ![Open Perspective.png](https://kb.peersoftware.com/__attachments/a_c98776221cc83d955e0a1bd966c4f86f776802c7e7e7fc36b90b65750201637c/Open%20Perspective.png?cb=b4f460b12d39285407c632008368f7bc) 3. Select **Topology** , and then click **Open** . The Topology perspective opens. ![Topolgy Task 1-Perspective.PNG](https://kb.peersoftware.com/__attachments/a_b8b6fc1066cc35aab581ad80f473728059622fc389a88b61b5e80e229b347fe4/Topolgy%20Task%201-Perspective.PNG?cb=a88bcf7ce690c160de3ddafe0911f875) 4. Click the **Add Site** button to launch the **Add Site**wizard. 5. Enter a name for the site, drag the site icon to the desired location on the topology map, and then click **Next**. ![Topolgy Task 1-Add Site.PNG](https://kb.peersoftware.com/__attachments/a_49d8eea0575753638fea95b8be753cc2c275f236b2b685a3a4d39e1e240a6200/Topolgy%20Task%201-Add%20Site.PNG?cb=fb8633bf2e0e01d47d2814a238d1e739) 6. (Optional) Enable TLS to encrypt all broker connections to and from this site. ![Topolgy Task 1-Network Properties.PNG](https://kb.peersoftware.com/__attachments/a_141b6ebc82f1edefa65b760e1191adc298bba18188c7ae87305f4af55264bb9c/Topolgy%20Task%201-Network%20Properties.PNG?cb=2787cbb1b3d5ffc659440170a9df9903) 7. Click **Next**. 8. Configure the broker on this PMC host: ![Topolgy Task 1-Site Brokers.PNG](https://kb.peersoftware.com/__attachments/a_0d8a8cc16de6aad4ad31336cefe022cb25ee1e6bd1e76ff73a92e23b53d135ed/Topolgy%20Task%201-Site%20Brokers.PNG?cb=6b97dfcba358c9909b7850b0f974890e) 1. In the **Hostname**field, enter a host name. 2. In the **Failover Method** section, keep the default failover method of **All Primary**. 3. In the **Network Interfaces** section, enter one or more IP addresses for the broker. 4. Keep the default value for the available bandwidth. 5. In the **Agent Connection** section, enter the network address that Agents should use to connect to this broker. If the broker uses the same address for broker and Agent connections, select **Use Broker Addresses**. 6. (Optional) Enable TLS encryption for Agent connections to encrypt all broker connections to and from this site. **Note:** Ensure that network routing policies are configured correctly to support the intended behavior. PeerGFS does not manage routing policies---contact your network administrator for assistance. 9. Click **Finish**. 10. Repeat Steps 4-8 for the passive PMC. After you add the second (passive) PMC, the new site momentarily has a status of *Unconfigured* before it is automatically configured with the same settings as the active PMC. After that, the second PMC has a status of *Online* but remains in a passive state. ![Topolgy Task 1-Second PMC.PNG](/__attachments/a_73791bf2239dd3282c09fed7f12a6d4aeaf68d760ebb01e0b90b4d46b48c19dd/Topolgy%20Task%201-Second%20PMC.PNG?cb=36b147cfdfd248412bdec682cd525682) ### Task 2: Configure Agents to Failover to the Passive Server This section outlines the steps needed to configure all Agents for failover to or from the passive server. The instructions assume you are modifying the Broker configuration for all Agents at once, although you can also update them individually if needed. 1. Within the Peer Management Centerclient, select all Agents, right-click and select the **Edit Agent Configuration on Selected Agents** option, and then click **OK**in the message that appears. ![EditAgents.PNG](https://kb.peersoftware.com/__attachments/a_45787b250cd1b242e3d371fed45e53ecf635921f9d118cda893efc8b1c9bb0fb/EditAgents.PNG?cb=eb3bdfc8413dd9f6f5a88287b88c2dce) 2. In the **Failover Brokers** section, add the broker IP address for the **passive**server in **Broker Hosts** field (if there is an address already present, then add the new address separated by a comma). **Note:** Do not change the primary broker, even if there are multiple values in Broker Hosts. If a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md) is deployed, then ensure that both the active **and** passive PMC are included in one of the **Broker Hosts** fields. ![Broker Hosts.png](https://kb.peersoftware.com/__attachments/a_5984a821c1f7ee32fefd82808cd1b86f9bde9f30777010c02fa08ccb4d8db4d1/Broker%20Hosts.png?cb=323bb9fdc62fee174e3df0d664ee0b8e) 3. Set the connection type appropriately for your environment, and then click **OK**. 4. Restart all Agents by selecting all Agents in the **Agents**view, and then right-clicking and selecting the **Restart Agent Service**option. ![87f31dd6-fe5a-4f58-992e-f63a3b8b73ec.jpg](https://kb.peersoftware.com/__attachments/a_5ebf07890070ffc26a4e2640f16b51c55abf51043685530c7d84e53ebe1081eb/87f31dd6-fe5a-4f58-992e-f63a3b8b73ec.jpg?cb=3c40d3f574baee063fdc5025c66a2f4b) ## Performing Manual Failover to the Passive PMC Server This section describes the actions to take when failing over between the active and passive PMC servers. There are two scenarios covered in this section: * Performing a planned failover between PMC servers * Manually enabling a passive PMC after failure ### Scenario 1: Performing a planned failover between PMC servers Occasionally, deliberate control transfer between PMC servers may be necessary, often as part of routine maintenance procedures. To activate a passive PMC server: 1. Open the PMC on the currently active PMC server 2. Open the Topology perspective. 3. Select the passive PMC site in the **Sites**panel. 4. Click the **Activate PMC** button. ![ActivatePMC.PNG](https://kb.peersoftware.com/__attachments/a_b3ca8ea7c6406a11dea1e5a9d14023d58d92d813b5c6b4ef8d66a156d148ea9d/ActivatePMC.PNG?cb=5f8b1d4b0c5bfb975dc45e3c7c23e372) 5. Click **OK** in the message that appears. Once this has been done, the two PMCs will negotiate the handover of control. Any jobs that are configured to automatically start will do so. ### Scenario 2: Manually enabling a passive PMC after failure In the event of a genuine failure necessitating environment recovery, this section describes the process to disable the active PMC and manually start the passive PMC. Even if connectivity between the PMCs is lost, it remains necessary to deactivate the currently active PMC. #### Disable the active PMC To disable the active PMC, follow these steps if the original active PMC server is still available: 1. Launch the PMC on the active PMC server. 2. Open the **Topology** perspective. The passive PMC will appear to be offline as there is no network connectivity between them. ![Failure1.PNG](https://kb.peersoftware.com/__attachments/a_855ce214db81e812a7facd42c4c9ccf198e94d1f2c40118274cb21dd36e835a3/Failure1.PNG?cb=81bb9dbe7dea2f72f2adea60d4fd883f) 3. Select the active PMC in the **Sites** view, and then click the **Deactivate PMC** button in the **Details** view. ![Deactivate.PNG](https://kb.peersoftware.com/__attachments/a_77e15cd680e3592870db85a84d06449ac261fa2b5a79da2049657909ea326833/Deactivate.PNG?cb=78e610bf635bf9292a9c715e1d20cfb7) The PMC will automatically close and all Peer Management services will be stopped. #### Enable the passive PMC To enable the passive PMC, you must manually start the Peer Management service. These steps vary depending on the operating system hosting the passive PMC. Enable passive PMC on Windows manually 1. Log in to the passive PMC server. 2. Open the **Windows Services** application and find the Peer Management Services. The number of Peer Management services listed will vary, depending on your installation. ![52acd7c7-dcc0-45bc-92b5-ed38ca583de1.png](https://kb.peersoftware.com/__attachments/a_5ba7aea42f53aaca146a2597d6636fd7d01c8a51c62907af20f5cad4414e1c5d/52acd7c7-dcc0-45bc-92b5-ed38ca583de1.png?cb=29c4f85662f377af5fec6fb2af8909e6) 3. Edit the properties of each **disabled**service: 1. Change **Startup type** from **Disabled** to **Automatic**. 2. Click **OK**to save the changes. ![Peer Management Broker Service Properties image](https://kb.peersoftware.com/__attachments/a_275259f2996d05108e0789e97ddb05f093e8e107d7575c4b3b2debc1a498e99f/Peer%20Management%20Broker%20Service%20-%20Change%20Startup.png?cb=e222f0d998949447800e6a9befd50b5e) 4. Start the services that were just enabled. The PMC will start and become active. Any jobs marked to automatically start will do so. Enable passive PMC on Linux manually 1. Use SSH to connect to the Linux server where the passive PMC is installed. 2. Run the following commands to enable PMC services: sudo systemctl enable PL-Hub-Service.service sudo systemctl enable PL-Hub-Web-Service.service sudo systemctl enable PL-Hub-Service.service sudo systemctl enable PMC-API-Service.service 3. Run the following commands to turn on PMC services. The PL-Hub-Service must be started first. sudo systemctl start PL-Hub-Service.service sudo systemctl start PL-Hub-Web-Service.service sudo systemctl start PL-Hub-Service.service sudo systemctl start PMC-API-Service.service ## Configuring Automatic Failover The preceding sections have explained the manual execution of failover operations. However, depending on your license, you can configure two PMCs to automatically switch over between each other in the event of a failure. To enable automatic failover: * Verify that the environment is licensed for automatic failover. * Install the **watch node** broker. * Configure automatic failover. **Note:**In automatic failover scenarios, no PMC is designated as more important or given higher priority. As a result, automatic failback is not inherent. If there is a preference for a specific PMC to be active, it must be manually accomplished by following the steps outlined in the planned manual failover process. ### Verify that the environment is licensed for automatic failover 1. Open the PMC client (rich or web) 2. From the **Help** menu, select **Licenses**. 3. Verify that **Automatic Failover** is enabled in the **Licensed Features**section. ![Configuring Automatic Failover - Licensing.png](https://kb.peersoftware.com/__attachments/a_7c01ba5446e81df6182331c13ad5c1aca624e62892354e8eea2fb4772cf74973/Configuring%20Automatic%20Failover%20-%20Licensing.png?cb=4e88c0ad58c6d3b3dcb91f29f0ad40b9) ### Install the watch node broker For automatic failover to function, each PMC server must be aware of the connected and disconnected status of other PMC servers in the environment. This awareness is facilitated through the establishment of a reliable third point of view. To achieve this, a broker known as a **watch node** is introduced to the environment, positioned independently and not affiliated with either PMC site. Install a watch node broker on Windows 1. Use Remote Desktop to connect to the Windows Server where the broker is to be installed. 2. Download the broker installer using one of the following methods: • In the PMC, select the **Download Broker Installer** command from the **Help** menu. • Use the download link that is included in the email containing your new PeerGFS license. command from the **Help**menu. 3. Right-click the installer and choose **Run as administrator** . ![image2023-12-20_11-9-39.png](https://kb.peersoftware.com/__attachments/a_bd6483d9753dac8012feaac4119e3ea03f7ea0bed68b3a3d1f69f3c3b1930f2a/image2023-12-20_11-9-39.png?cb=c849019cca96661d17992ad47009e112) 4. Read and accept the license agreement. ![image2023-12-20_11-10-33.png](https://kb.peersoftware.com/__attachments/a_4e0e5b02cfda8a40fef18216f0c85eddadf3e540c80c29a393c34682445a31c0/image2023-12-20_11-10-33.png?cb=e1589845f12c3dc2f8669fe83c2e843e) 5. Confirm the location of the installation directory. ![image2023-12-20_11-10-54.png](https://kb.peersoftware.com/__attachments/a_c9b15ab8e3c7f924079695d2d5d5405913c10d9b5737ddb6131029b031c6da94/image2023-12-20_11-10-54.png?cb=4dbe04e4b1d9ec1d812f26f1dd5e6973) 6. Confirm the location of the Start Menu folder. ![image2023-12-20_11-11-16.png](https://kb.peersoftware.com/__attachments/a_71bdf0abfba1597b8742a8ac8a4f6750e4ec3791f57df5d729189aa1afdb27a7/image2023-12-20_11-11-16.png?cb=1be19871bd1064ad58150d88a44af14e) 7. Finish the installation. If this is a new installation, add the recommended firewall rules if needed. All brokers connect to each other on TCP ports 61616 (unecrypted) or 61617 (TLS-encrypted), so access to these ports must be alllowed. ![image2023-12-20_11-18-22.png](https://kb.peersoftware.com/__attachments/a_a9b14907297de471a364584b313ad6659a2d777460ff8d39c2e1dd5488d30b7c/image2023-12-20_11-18-22.png?cb=639884a38fb1df29043a52a04c166f31) 8. After installing the watch node broker, add the new site to the Topology perspective in the same way as described in [Task 1. Adding sites to the topology](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md#Task-1). Install a watch node broker on Linux 1. Use SSH to connect to the Linux server where the broker is to be installed. 2. Download the broker installer using one of the following methods: • In the PMC web client, select the **Download Broker Installer** command from the **Help** menu. • Use the download link that is included in the email containing your new PeerGFS license. 3. Make the .sh installer executable by running: sudo chmod a+x \ 4. Run the .sh installer by running: sudo . /\ 5. Follow the prompts. 6. Finish the installation. If this is a new installation, add the recommended firewall rules if needed. All brokers connect to each other on TCP ports 61616 (unecrypted) or 61617 (TLS-encrypted), so access to these ports must be alllowed. 7. Once the watch node broker has been installed, add the new site to the topology perspective in the same way as described in [Task 1. Adding sites to the topology](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md#Task-1). ### Configure automatic failover To configure automatic failover: 1. Navigate to the topology perspective within the PeerGFS client. 2. Click the **Failover Options** button. ![FailoverOptions.PNG](https://kb.peersoftware.com/__attachments/a_656772678e63c1b157f3bd4e00f01bd3dd63cc90365576f8017e772631078e62/FailoverOptions.PNG?cb=0696bbc7f5ea91d39bfc67fcd1a954dc) The **Failover Options** dialog appears. ![FailoverDialog.PNG](https://kb.peersoftware.com/__attachments/a_9ae693e7154442c52605f25e40a868b94f516ae7296cc6c2c7d240bab6fbcc98/FailoverDialog.PNG?cb=e7cb3d07dc4b2f1f98a06987a86f7074) 3. Select **Enable Auto-Failover**. 4. Select a watch node broker. If your environment utilizes a network of nrokers, all configured brokers will be available as options. 5. Click **OK**. ## Best Practices for PMC Failover and Network Planning Considerations during a failover event: **PeerGFS web server configuration** * Take note of the hostname used in your PeerGFS web service configuration, especially if you plan to use web access during a failover event. * The web service port (default: 8443) binds to the hostname specified in the configuration. * To ensure access to either PMC's web server---during normal operation or after a failover---set the hostname to the default value of `0.0.0.0`. This allows access using the server's NetBIOS name, FQDN, or IP address. * During a failover, point your browser to the secondary PMC's address. **Network connectivity** * Ensure that all PMCs and the watch node broker can receive incoming network connections. **Location planning** * Place the watch node broker in a neutral location relative to both PMCs. * In both local and distributed environments, avoid creating a single point of failure by positioning PMCs and the watch node broker strategically. * A well-planned layout helps ensure resilience in the event of a failover. ## Troubleshooting ### PMC startup failure * Verify that another PMC instance is not already running. * If automatic failover is enabled, ensure that the watch node broker or passive PMC is online. ### Lack of passive PMC or watch node broker If automatic failover is enabled and there is no passive PMC or watch node broker available: * A PMC using automatic failover requires the presence of either a watch node broker or passive PMC to remain active. * If neither is available, you must disable automatic failover to allow the PMC to continue running. **To manually disable automatic failover:** 1. Edit the `SPGlobal.prefs` file located in the `workspace/prefs` directory. 2. Change the value of `autoFailover` from `true` to `false`. ## Related articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Can a job back up files that were created between two specific dates?](https://kb.peersoftware.com/kb/can-a-job-back-up-files-that-were-created-between-.md) * [Can PeerSync change an IP address to point to a backup server?](https://kb.peersoftware.com/kb/can-peersync-change-an-ip-address-to-point-to-a-ba.md) * [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) * [Getting Started with Network of Brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md) * [Maximize network throughput](https://kb.peersoftware.com/kb/maximize-network-throughput.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) * [Peer Global File Service - Environmental Requirements](https://kb.peersoftware.com/kb/peergfs-environmental-requirements.md) * [PeerGFS jobs fail to start after initial job due to NetAPP ONTAP v9.15.1 upgrade](https://kb.peersoftware.com/kb/job-start-issues-with-ontap-9.15.1.md) * [PeerSync - Environmental Requirements](https://kb.peersoftware.com/kb/peersync-environmental-requirements.md) * [Prerequisites](https://kb.peersoftware.com/kb/prerequisites.md) * [Schedule upload of PMC and Agent logs to Peer Software Support](https://kb.peersoftware.com/kb/peergfs-schedule-upload-of-logs-to-support.md) --- language: "en" --- # Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1) Legacy version notice This article applies to PeerGFS versions 4.7.0 through 5.1.1, which are no longer supported. It is retained for reference purposes only. **We strongly recommend upgrading to a supported version of PeerGFS** to ensure continued access to updates, support, and improved functionality. For current configuration steps, see the appropriate article for your version: • [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) • [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) ## Overview This article describes how to achieve high availability for your PeerGFS environment by setting up an active-passive configuration. As of PeerGFS v4.7.0, you can configure Agents to failover from one PMC server to a backup PMC server. With an active-passive configuration, you run a primary active PMC server (physical or virtual) with a second passive PMC server (physical or virtual) configured as a backup. When a failure occurs on the active PMC server, the passive PMC server is ready to take over the work of the active server. Once configured, no user interaction is required when failing over to or from the backup PMC other than starting the Peer services on the passive server. Jobs set to autostart will start automatically on the passive server. The PMC *workspace* folder (a subfolder in the PMC installation folder) on the passive server must be kept up-to-date so that it is ready to take over if the active server goes down. Although any third-party replication tool can be used to keep the PMC configuration on the passive server up-to-date, with PeerGFS v4.5.2 and later, the Task Scheduler includes a **Back up PMC Configuration** task that can be scheduled to regularly back up the configuration of the active server directly to the passive server. If you use a third-party replication tool, it will require VSS support to ensure it gets a clean snapshot of the PMC's configuration database. ## Benefits The benefits of an active-passive configuration include the absence of a need for additional hardware and software, except for provisioning a new physical or virtual server. Furthermore, it is a simpler and more cost-effective solution to implement across multiple locations, particularly for covering PMC disaster recovery scenarios. ## Licensing Since only one PMC server is active at a time, only one PeerGFS license is needed. You are allowed to use the same license on the primary and backup servers but only one server can be active at a time. Having both the active and backup servers active at the same time would require an additional PeerGFS license. ## Prerequisites * If you are using a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md), set up the network **before**setting up active-passive configuration. * Ensure that the identical version of PeerGFS is already installed on both the active and passive servers. * License and set up one PMC to function as the active one while leaving the other PMC unlicensed and in an empty state. * The active and passive servers must be belong to the same Windows Domain and share the same time zone. ## Configuration Process Overview Ideally, the active-passive configuration should be set up before configuring the first production job. As soon as PeerGFS jobs approach production readiness, it is advisable to create a backup of the PMC configuration, irrespective of whether a server is designated as a backup PMC device. Backing up the PMC configuration takes seconds and can save hours of job reconfiguration in case of a system failure. Once you have backed up the PMC configuration, you are ready to set up the active-passive configuration. The setup consists of four tasks: 1. [Disable the Peer services on the passive server](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-Task1) -- All Peer services should be set to a manual start to ensure this server is in a passive/standby role while the primary server is active. 2. [Give the active server permission to write to the passive server](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-Task2) -- The active server needs permission to back up the PMC configuration to the passive server. 3. [Create a backup task on the active server](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-Task3) -- The backup task should regularly back up the PMC configuration on the active server to the PMC *workspace*folder on the passive (backup) PMC server. 4. [Configure Agents to failover to the passive server](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-Task4) -- Set up each Agent to automatically failover to the backup PMC when the primary is inaccessible, and failback to the original PMC when it is available again. The next section, [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1) \| AchievinghighavailabilityforthePMCthroughactive passiveconfiguration(v4.7.0 v5.1.1) ConfigurationTasks](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-ConfigurationTasks), provide step-by-step instructions for these four tasks. The [Recovery](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-Recovery)section describes how to failover to the backup PMC server and then how to failback to the original PMC server. ## Configuration Tasks ### Task 1. Disable the Peer services on the passive server This task is necessary to prevent Peer services running on the passive server while the active server is running. 1. Login to the passive PMC server. 2. Open the **Windows Services** application. A total of five Peer Management services may be listed, depending on your installation. ![Peer Management Services image](https://kb.peersoftware.com/__attachments/a_a3502cc62b0e9ed48e51bca9ee67eaa4077fd0810f1a286c09236aa1714bc06b/Peer%20Management%20Services.png?cb=15e4285f1f74e04e2d8c3e6cd858c025) 3. Stop all the Peer Management services **UNLESS** you are using a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md). If you are using a network of brokers, keep the **Peer Management Broker Service** and **Peer Management Topology Service** running. 4. Edit the properties of each **stopped** service (do not edit services kept running for network of brokers): ![Peer Management Broker Service Properties image](https://kb.peersoftware.com/__attachments/a_7884fae9629ea1908472057cf87cfcaf8b1efb1ef0bce013f2ef82fd8a06b3e7/Peer%20Management%20Broker%20Service%20-%20Change%20Startup.png?cb=e222f0d998949447800e6a9befd50b5e) a. Change **S** **tartup type** from **Automatic** to **Manual** . b. Click **OK**to save the changes. ### Task 2. Give the active server permission to write to the passive server Before you can back up the active server's PMC configuration to the passive server, you must authorize the active server to write to the passive server. To add the active server's computer account to the local Administrators group on the passive server: 1. Open the Windows **Computer Management** application. 2. In the console tree, click **Local Users and Groups** , and then click **Groups**. 3. Right-click the **Administrators** group, and then select **Add to Group** . ![Computer Management - Local Users and Groups image](https://kb.peersoftware.com/__attachments/a_0e3ff3e11ce6aa2fba1f614dea4a1fac501748aef837a4a6ddcd6f65afe8f6c5/Add%20to%20Group.png?cb=7b554293710a7350f1196bec4410be65) 4. In the **Administrators** **Properties** dialog, click **Add** . ![Administrator Properties dialog image](https://kb.peersoftware.com/__attachments/a_2153c0a200661aca2d7ab20d77585b8f1daaf0fd70fd0958f018743eb7e30046/image-2023-3-22_14-23-20.png?cb=f200612c3cd066788b3d6022103ef625) 5. In the **Select Users, Computers, Service Accounts, or Groups dialog** , click **Object Types** . ![Select Object Types image](https://kb.peersoftware.com/__attachments/a_b8d925c8df1c1d62b27252138001bee0a0885039a53c7489fc76506fb02ffc5f/image-2023-3-22_14-30-37.png?cb=f8640956d15c29b916b9effba648cbae) 6. In the **Obect Types** dialog, select the **Computers** checkbox, and then click **OK** . ![Select Computers checkbox image](https://kb.peersoftware.com/__attachments/a_5fb998357d1ee9aa444b276072b8b938e403554ffa798b22520e68f1e85a5c64/image-2023-3-22_14-40-7.png?cb=afaf1383703dc3ccd08dfbbf54789788) 7. Type the name of the primary PMC server into the **Enter the object names to select** field. ![image-2023-3-22_14-42-31.png](https://kb.peersoftware.com/__attachments/a_67a1e0281c50f4424ac7e01fcc1e52b1f4634cfcd0154f40a3057d8eade8d7ab/image-2023-3-22_14-42-31.png?cb=31c77888ee31f4ef1582db801c730848) 8. Click **Check Names** to confirm the computer is found on the network. 9. Click **OK** to add it as a member of the local Administrators group. 10. Click **OK** to save the Group change. 11. Close Computer Management. 12. Log off from this server. ### Task 3. Create a backup task on the active server The backup task will back up the configuration of the active PMC server to the passive PMC server on scheduled basis. 1. Log in to the active PMC server. 2. Open the PMC. 3. Select **Preferences** from the **Window** menu. 4. Select **Task Scheduler** in the navigation tree. 5. Click the **Create** button. 6. Name the backup task (e.g., *PMC Configuration Backup*). 7. Select **Peer Management Center** from the **Solution** dropdown list. 8. Select **Back up PMC Configuration** for **Job/Task Types** . ![Select Scheduler Task Type image](https://kb.peersoftware.com/__attachments/a_bb5ae6c52324cde741d6193a9b899913b027fd55d52461b4590a8e9f1df9e0bc/Create%20Backup%20Task-1.png?cb=82e2396dc0f4c6b6086c7a99e58058f3) 9. Click **Next**. 10. Select the backup frequency from the **Settings** options (**One Time** , **Daily** , **Weekly,** or **Monthly**); at least weekly is recommended). |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | **Daily** | Allows selecting a recurring frequency of every 1, 2, 3, 5, 10, or 15 days. | | **Weekly** | Requires selecting at least one day of the week to run on. | | **Monthly** | Allows selecting **All or specific month(s)** in which to run, as well as any numbered day of the month or the **Last day of selected month(s)**. | 11. Select the start date and time of the first backup. ![Select backup start date and time image](/__attachments/a_947409a27a72322d03fb94f31e9e9a0d754b1a8d6cd685c4c4ed5c724eaa992a/Create%20Backup%20Task-2.png?cb=47d9f6e96b1a440418672e5ca09393bb) 12. Click **Next**. 13. In the **Target Path** field, enter the UNC path to the PMC installation folder on the passive PMC server. Use the admin path rather than a share path (for example, ++\\\\++ ++*secondaryPMC-DNSname*++ ++\\c$\\Program Files\\Peer Software\\Peer Management Center++ ). ![Selected scheduled task options image](/__attachments/a_bf9c3f3f77b89971247e7556c3325c28a1415dfd9ecad5e096831ae09c871926/PMCBackupTask_TargetPath.png?cb=b5e67acccced91fdf72e79f3ff2a6250) 14. Click **Finish** to save the backup task. The backup task appears in the Task Scheduler's list of tasks. ![Task Scheduler's list of task image](/__attachments/a_a027e327f3ff4b540cb195126a5156d29c08710981c4f4115165fcfe0e24a11f/Run%20Backup%20Task.png?cb=7d76e0ba3f666d1f8b9fc0e38b08b89d) 15. (Optional) To create the initial backup, select the backup task, and then click the **Run Now** button. **Tip:** The **Task History** view displays the details for past task runs (e.g. Start Time, End Time, Elapsed Time, any associated errors ). To display the **Task History** view, select **Show View** from the **Window** menu, and then select **View Task History**. ![Task History view.png](https://kb.peersoftware.com/__attachments/a_c4c524d9f014fe8bb0abf308a0bbb809bf9a2d31c3cb03bb8c4fbb75314a7fcd/Task%20History%20view.png?cb=1d4ecbccde42563b0c203313d554998f) ### Task 4. Configure Agents to Failover to the Passive Server This section describes the steps required to configure all Agents to failing over to or from the backup server. It involves modifying the Broker configuration for each Agent. 1. **PeerGFS v4.7 users only:** To gain access to the Agent broker failover options, insert the following line into the *workspace\\hub.ini* file in the PMC installation folder. Create the file if necessary. Java hub.agent.enable.broker.secondary.ui=true 2. **PeerGFS v4.7 users only:** Client Users: Restart the **Peer Management Center** **Client** application. Web Client Users: Restart the **Peer Management Center** **Web Service**. 3. Within the **Peer Management Center Client** , select all Agents, right-click and select the **Edit Agent Configuration on Selected Agents** option. ![image2021-9-29_16-6-31.png](https://kb.peersoftware.com/__attachments/a_6b5e9f85e04aed1e1a0b853d0ffeeb55b26ddf31582e0e5d379eed9693b37bd6/image2021-9-29_16-6-31.png?cb=aa53bf03050710fb9c52f9a9ae29736f) 4. In the **Broker Configuration** section, add the failover broker IP address in the **Failover Broker** section (if there is an address already present, then add the new address separated by a comma). Set the other failover broker fields appropriately for your environment. **Note:** Do not change the primary broker, even if there are multiple values in Broker Hosts. If a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md) is deployed, then ensure that both the active **and** passive PMC are included in one of the **Broker Hosts** fields. ![image2021-10-15_13-22-51.png](https://kb.peersoftware.com/__attachments/a_a2dd84501fc83a03cce1965bee605024f7cfd2416799e2c2e5f87d0b0a94645d/image2021-10-15_13-22-51.png?cb=ec85c86f9ad5a14db49cbc5c2a390336) 5. Restart all Agents by selecting all Agents in the **Agents** view, and then right-clicking and selecting the **Restart Agent Service** option. ![image2021-9-29_17-12-38.png](https://kb.peersoftware.com/__attachments/a_d1eb12b49e8a5ec147a4784db4ff23f0bfd961a698edea23cf8ba55aa8a7c272/image2021-9-29_17-12-38.png?cb=c895dbf81f0fdc1ad5e0fad7b27da1c1) ## Recovering from a failure This section describes the actions to take when the active PMC server fails. Recovering from a failure on the active PMC server involves: * Failing over to the backup PMC server * Failing back to the primary PMC server ### Failover to the backup PMC server If the primary (active) PMC server fails, follow these steps to make sure the passive PMC server takes on the primary role: 1. Ensure that the active PMC server is completely stopped. If the server has partially failed but is still running, **disable** the Peer Management services. This prevents the problems that occur if both the active and passive servers are running simultaneously. To disable the Peer Services: a. Log in to the primary (active) PMC server. b. Open the Windows Services application. c. Stop all the Peer services **UNLESS** you are using a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md). If you are using a network of brokers, keep the **Peer Management Broker Service** and **Peer Management Topology Service** running. d. Edit the properties of each of the **stopped** Peer services: Set **Startup type** to **Manual** , and then click **OK** to save. 2. Log in to the backup PMC server. 3. Open the **Windows Services** application and start the Peer services on the backup server. 4. Start the job(s). ### Failback to the primary PMC server Once the failure event has been resolved and you have access to the former primary PMC: 1. Follow the recommendations in the [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1) \| AchievinghighavailabilityforthePMCthroughactive passiveconfiguration(v4.7.0 v5.1.1) BestPractices](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-BestPractices) section prior to failing back. 2. Return the primary server back to its active role: 1. Stop and disable the Peer services on the backup PMC server. 2. Start the Peer services on the primary PMC server. 3. Start the job(s) that aren't set to automatically start. **Note:** If you are using a [network of brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md), you can leave the **Peer Management Broker Service** and **Peer Management Topology Service** running on both the active and passive PMC server. ## Best Practices Considerations during a failover event: * When the backup task runs from your primary PMC server, the entire current configuration, including the backup task itself, will be written to your secondary server. This means in the event of a failover, while you are running on your secondary PMC, the next time the backup task runs on this server, it will be trying to back up to itself (using the path that was configured on primary PMC server). * It is not recommended to run in a failover mode for a prolonged period of time. If you have to run on the secondary PMC for a prolonged period where configuration changes were made that need to be synced back to the primary PMC Server: 1. Repeat [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1) \| AchievinghighavailabilityforthePMCthroughactive passiveconfiguration(v4.7.0 v5.1.1) Task2](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md#AchievinghighavailabilityforthePMCthroughactive-passiveconfiguration(v4.7.0-v5.1.1)-Task2) in the reverse direction, granting your secondary PMC server the rights to write to the primary PMC server. 2. You must also edit your task on the secondary PMC server. Repeat Step 13 in Task 2 but modify the path of the backup task to include the primary server in the UNC path, rather than the secondary. 3. Run the backup task one time prior to failing back to the primary PMC server. 4. After failback to the primary PMC server, again edit the backup task to point to the UNC path of the secondary PMC server. * It is recommended that you also create a secondary backup task that targets a central network share to store another backup. This will ensure you always have a backup you can restore manually to either PMC server in the event you run into any issues backing up directly between your PMC servers at any point. * You will need to consider the hostname you use for your PeerGFS web server configuration if you intend to use the web access during a failover event. The web server port (default 8443) binds to the hostname specified in the configuration; you must ensure that you use a hostname that resolves to either PMC depending on which is the active one or use the default setting of "0.0.0.0", which should ensure access to either PMC web server using its NetBIOS/FQDN/IP address in the web server URL during normal operation or in the event of a failover event. ## Related articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Can a job back up files that were created between two specific dates?](https://kb.peersoftware.com/kb/can-a-job-back-up-files-that-were-created-between-.md) * [Can PeerSync change an IP address to point to a backup server?](https://kb.peersoftware.com/kb/can-peersync-change-an-ip-address-to-point-to-a-ba.md) * [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) * [Getting Started with Network of Brokers](https://kb.peersoftware.com/kb/getting-started-with-network-of-brokers.md) * [Maximize network throughput](https://kb.peersoftware.com/kb/maximize-network-throughput.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) * [Peer Global File Service - Environmental Requirements](https://kb.peersoftware.com/kb/peergfs-environmental-requirements.md) * [PeerGFS jobs fail to start after initial job due to NetAPP ONTAP v9.15.1 upgrade](https://kb.peersoftware.com/kb/job-start-issues-with-ontap-9.15.1.md) * [PeerSync - Environmental Requirements](https://kb.peersoftware.com/kb/peersync-environmental-requirements.md) * [Prerequisites](https://kb.peersoftware.com/kb/prerequisites.md) * [Schedule upload of PMC and Agent logs to Peer Software Support](https://kb.peersoftware.com/kb/peergfs-schedule-upload-of-logs-to-support.md) --- language: "en" --- # Advisories * [Security Advisory: Apache ActiveMQ Vulnerability (CVE-2023-46604)](https://kb.peersoftware.com/kb/security-advisory-apache-activemq-cve-2023-46604.md) * [Security Advisory: Log4j v2 Vulnerability (CVE-2021-44228)](https://kb.peersoftware.com/kb/security-advisory-log4j-v2-cve-2021-44228.md) * [Security Advisory: Spring Framework Vulnerability (CVE-2022-22965)](https://kb.peersoftware.com/kb/security-advisory-spring-framework-cve-2022-22965.md) --- language: "en" --- # Amazon FSx for NetApp ONTAP Prerequisites |------------------|--------------| | **Last Updated** | 24 June 2026 | 1. **ONTAP Version Requirements:** 1. ***For SMB workloads*** **,** the minimum required version of Amazon FSx for NetApp ONTAP (FSxN) is **v9.11**. 2. ***For NFS and multi-protocol workloads*** **,** the minimum required version of Amazon FSx for NetApp ONTAP (FSxN) is **v9.11** . PeerSync is ***not*** supported for NFS or multi-protocol workloads. 2. Any server that will be interfacing with an FSxN Storage Virtual Machine (SVM) with the Peer Agent or PeerSync must reside within the same domain, the same network segment, and the same subnet as the SVM. Additionally, the network connection between the SVM and the Agent or PeerSync ***must*** operate at speeds of at least 1 Gbit/sec with sub-millisecond latency. 3. **Time Synchronization** : The server hosting the Peer Agent or PeerSync as well as the FSxN SVM ***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. 4. **Server OS Version Requirements:** 1. ***For SMB workloads*** , the minimum version of Windows required for FPolicy support with the Peer Agent or PeerSync is Windows Server 2016. 2. ***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. 5. **SMB Multichannel Requirement for SMB and multi-protocol workloads** ***:*** Starting with PeerGFS **v6.4** , SMB Multichannel can be left enabled. However, if you are using PeerSync or versions of PeerGFS ***prior to v6.4***, SMB Multichannel support ***must*** be disabled on the SVM using the following SSH commands: set -priv diag cifs options modify -vserver -is-multichannel-enabled false All SMB client connections to the SVM ***must*** be reset once this change is made on the SVM. 6. **NFS Protocol Version Requirements:** If using ONTAP v9.14 or earlier, clients must exclusively use NFSv3.0 or NFSv4.0 for accessing data. If running ONTAP v9.15 or newer, clients may also use NFSv4.1. NFSv4.2, and pNFS are ***not*** supported by FPolicy. 7. The FPolicy Server hosting the Peer Agent or PeerSync can only work with a single SVM at a time. 8. No other FPolicy or VSCAN products from Peer Software or any other vendor can be run on the FPolicy Server hosting the Peer Agent or PeerSync. In addition, no other Peer Software components can be run on this server (such as Peer Management Center). 9. **Privileges and Permissions for SMB Workloads:** 1. **CIFS Permissions** : The service account for the Peer Agent or PeerSync must be a member of the Local Admin Group on the SVM. To add the service account ***\*** (in the format "DOMAIN\\USERNAME") to the Local Admin Group of SVM ***\***, run the following SSH command: vserver cifs users-and-groups local-group add-members -vserver -group-name BUILTIN\Administrators -member-names 2. **CIFS Privileges** : To properly query and set DACLs, SACLs, owner and/or group configurations on files and folders, the service account for the Peer Agent or PeerSync must be granted special privileges. To grant these privileges to the account ***\*** (in the format "DOMAIN\\USERNAME") on SVM ***\***, use the following SSH command: vserver cifs users-and-groups privilege add-privilege -vserver -user-or-group-name -privileges SeBackupPrivilege,SeRestorePrivilege,SeSecurityPrivilege,SeTakeOwnershipPrivilege,SeTcbPrivilege 10. **Privileges and Permissions for NFS Workloads** ***:*** The Peer Agent server IP needs to be granted superuser access in the export policies for any volumes that this Agent will be monitoring, as well as the parents of these volumes in the SVM's namespace. 11. **Privileges and Permissions for Multi-Protocol Workloads:** 1. **CIFS Permissions** : When replicating Windows-style permissions, the domain account used by the Samba connection of the Peer Agent must be a member of the Local Admin Group on the SVM. To add the service account ***\*** (in the format "DOMAIN\\USERNAME") to the Local Admin Group of SVM ***\***, run the following SSH command: vserver cifs users-and-groups local-group add-members -vserver -group-name BUILTIN\Administrators -member-names 2. **CIFS Privileges** : When replicating Windows-style permissions, the domain account used by the Samba connection of the Peer Agent must be granted special privileges. These privileges allow the Agent to properly query and set DACLs, owner and/or group configurations on files and folders. To grant these privileges to the account ***\*** (in the format "DOMAIN\\USERNAME") on SVM ***\***, use the following SSH command: vserver cifs users-and-groups privilege add-privilege -vserver -user-or-group-name -privileges SeBackupPrivilege,SeRestorePrivilege,SeSecurityPrivilege,SeTakeOwnershipPrivilege,SeTcbPrivilege 3. **Export Privileges:**The Peer Agent server IP needs to be granted superuser access in the export policies for any volumes that this Agent will be monitoring, as well as the parents of these volumes in the SVM's namespace. 12. **API Permissions** : Peer Agent and PeerSync must both be configured with an account on the SVM that has been granted ONTAPI access. It is recommended that this be a dedicated local account on the associated SVM just for the use of Peer products. The following SSH commands can be used to create a local account ***\*** with appropriate ONTAP API access on SVM ***\.*** If you are running PeerGFS v5.2 and above, a new REST-based API model is in place. HTTP support is required for the user account. You can create this account using the following SSH command: security login create -vserver -username -application http -authmethod password -role vsadmin If you need to use a domain account with the NetApp API, use the following SSH command: security login create -vserver -username \ -application http -authmethod domain -role vsadmin **Note**: The username and password of this account must be entered into each Peer product as part of the configuration process. 13. No active firewalls (software or hardware) should be enabled between the server hosting Peer Agent or PeerSync and the SVM. If the firewall(s) between the Agent or PeerSync server and the Files cluster cannot be disabled, please review [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) for minimum TCP port requirements. ## Related articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Amazon FSx for NetApp ONTAP Prerequisites](https://kb.peersoftware.com/kb/amazon-fsx-for-netapp-ontap-prerequisites.md) * [Dell PowerScale Prerequisites](https://kb.peersoftware.com/kb/dell-powerscale-prerequisites.md) * [Dell PowerStore Prerequisites](https://kb.peersoftware.com/kb/dell-powerstore-prerequisites.md) * [Dell Unity Prerequisites](https://kb.peersoftware.com/kb/dell-unity-prerequisites.md) * [Does the EOA of NetApp ONTAPI impact PeerGFS?](https://kb.peersoftware.com/kb/does-the-eoa-of-netapp-ontapi-impact-peergfs.md) * [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) * [Getting Started with Multi-Protocol for PeerGFS](https://kb.peersoftware.com/kb/getting-started-with-multi-protocol-for-peergfs.md) * [Getting Started with PeerGFS and Amazon FSx for NetApp ONTAP](https://kb.peersoftware.com/kb/getting-started-with-peergfs-and-amazon-fsxn.md) * [Issues runing PeerSync as a service](https://kb.peersoftware.com/kb/issues-runing-peersync-as-a-service.md) * [NetApp ONTAP Prerequisites](https://kb.peersoftware.com/kb/netapp-ontap-prerequisites.md) * [Nutanix Files Prerequisites](https://kb.peersoftware.com/kb/nutanix-files-prerequisites.md) --- language: "en" --- # Analytics ## Articles by Category * [What anonymous diagnostic data is collected?](https://kb.peersoftware.com/kb/what-anonymous-diagnostic-data-is-collected.md) * [Proactive Monitoring](https://kb.peersoftware.com/kb/proactive-monitoring.md) * [Health Checker](https://kb.peersoftware.com/kb/health-checker.md) --- language: "en" --- # Archive deleted files/folders ## Step-by-step guide **Preparation:**Set up your PeerSync Profile Jobs. To archive deleted data for later file/folder restore: 1. Select the specific job in your profile that you wish to have deletions replicated to the target folder**.** 2. Click on **File Options** from the left menu tree**.** 3. Select **Replicate -- Delete unmatched files** from **Event Options**on the right pane. 4. Click on the **Deletion Options...**button. The following window will come up. ![image2017-1-4 13:52:19.png](https://kb.peersoftware.com/__attachments/a_3ad7b25b43feb013f0224c876ba0a58f29a68f758cfbaafa9ff81ea5e3112b56/image2017-1-4%2013:52:19.png?cb=83f8b99e182eb95983c3d36692033d4c) 5. Select your preference for **Deletion Warning Message** a. **Do not Display:**the files/folders will be deleted without any warning message displayed prior to the deletion. b. **Require manual intervention:**a message will be displayed with the option for you to accept the deletion or reject the deletion. c. **Display for x num second(s):**a message will be displayed prior to file/folder deletion for specified x num of seconds(s). 6. Check **Delete Excluded Files from target** to delete any files on the target that meet the criteria selected for the **Exclude Files (using sub-strings)** option on the **Exceptions** screen if the **Replicate -- Delete unmatched files/folders** option is selected from the **File Options**screen. 7. Under **File Options** check **Move deleted files to an alternate location**to specify the path of where you would like the deleted files/folders to be archived to. 8. Click on the **Move Options...** button to access the **Additional Options**screen for further configuration. ![image2017-1-4 13:51:42.png](https://kb.peersoftware.com/__attachments/a_98e70c1e44d229a1bb1811bc58444f8c2cf5afba5d9a76ba0ec1ce8ce81ca0f8/image2017-1-4%2013:51:42.png?cb=7be56292a764421bd4c98a69b56ca6d8) 9. This screen provides a field where the user can designate an alternate folder to which unmatched files will be moved in order to avoid permanent deletion. This folder path can be typed manually, or selected using the **Browse Button**provided to the right of the field. If the designated folder exists, all unmatched files will be moved there, allowing you the opportunity to recover files deleted from the Target. This field also supports **File/Folder Path Variables**and when used, the current path will be displayed above the field. 10. Choose **Relative Paths** , **Preserved Paths** , or **Use Recycle Bin** a. **Relative Paths** will keep the file/folder structure from the source folder down, **not**including the source root. If the source folder is C:\\SourceFolder, then your relative structure in the archived folder would start from the folder below the Source folder going down. This option is recommended when tracking deletions from a local/remote source folder and one target folder. If tracking multiple jobs deletions, we recommend specifying a separate deletion folder for each of the jobs. b. **Preserve Paths**will preserve the file/folder structure from the source folder down, including the source root. If the source folder is C:\\SourceFolder, then archived folder would include the folder C which would include a folder Source Folder and so forth. This option is recommended if tracking multiple jobs deletions using the same deletion folder. c. **Use Recycle Bin**to have the deleted files moved to the Recycle Bin. This option may only be used for local deletions from the source or target folders, and it is not recommended when tracking multiple targets deletions. If your job has a remote source folder or multiple targets, please use one of the options below. If this option is selected and your deletions are being tracked for a remote source or remote target location, the deletions will be moved to a subfolder named "PSRecycle" located in the PeerSync installation folder (by default C:\\Program Files\\PeerSync). 11. Check **Delete unmatched target files older than x days**if you wish to have the archived deleted files/folders permanently deleted after x number of days. ## Related articles * [Archive deleted files/folders](https://kb.peersoftware.com/kb/archive-deleted-files-folders.md) * [What are \~PSTMP files?](https://kb.peersoftware.com/kb/what-are-pstmp-files.md) --- language: "en" --- # Are there Priority settings in PeerSync? PeerSync does not provide for a priority-based system, however you can achieve a similar result by restricting the resource usage of the jobs you want to be considered as low-priority. Under the 'Performance' options for each job, you can limit the amount of bandwidth used for that job. If you are currently using the multi-threading feature, you can limit the amount of copy threads that each job will use on a job by job basis by limiting the 'Set maximum number of Copy threads to' number for each job. By limiting these performance options for the lower priority jobs, you can ensure that the high priority job will not have to wait for resources to become available. Also, as an alternative to limiting the performance on the lower priority jobs, you can configure the high priority job to perform its replication in real-time, and have the lower priority jobs configured to perform scans on a scheduled basis. --- language: "en" --- # Back up your PeerGFS configuration manually ## Overview We recommend that you manually back up your PeerGFS configuration whenever you [upgrade](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) or downgrade PeerGFS. Backing up your PeerGFS configuration includes not only job configurations, preferences, databases, but also internal options stored in various .ini files. Previous PeerGFS configuration information and logs are automatically retained during the installation of Peer Management Center; however, manually backing up PeerGFS provides an added layer of protection. See the **Step-by-step guide** below for detailed instructions. Update versus upgrade Although **update** and **upgrade** are often used interchangeably in the technology world, an **update** (or **patch** ) is typically an enhancement to the current version of the software, while an **upgrade** is typically a whole new version of the software. Overall, the processes for updating and upgrading are very similar; however, an upgrade requires a new version license and a few additional steps. ## Step-by-step guide Manually back up your PeerGFS configuration on Windows To manually back up your PeerGFS configuration on Windows, follow these steps: 1. Open the Peer Management Center web interface or rich client. 2. Stop all running jobs. ![image2021-4-14_9-44-28.png](https://kb.peersoftware.com/__attachments/a_ca5d5da807b5f38456e9dce707ff37ce19ebf0b0fe1fce0319137decd7c7fe43/image2021-4-14_9-44-28.png?cb=d472d0934fec4123bd6517e2b00fa509) 3. Close the client. 4. Open Windows Service Manager (services.msc). 5. Stop Peer Management Broker Service. ![Stop Peer Management Broker Service.png](https://kb.peersoftware.com/__attachments/a_022a8e216e636b87b6a765e482fa8dcbe4eeee7ac07968b9685d1c64ee5f7974/Stop%20Peer%20Management%20Broker%20Service.png?cb=9fa5631f343d6b162f6479183747cf22) The **Stop Other Services** dialog appears. ![Stop Other Services.png](https://kb.peersoftware.com/__attachments/a_f906e922ec236d92f08176db483d06bdcecebef6aa591df8b30aefd46ec4f90b/Stop%20Other%20Services.png?cb=a5b0a1d264ad3646d17cc6e6f4cefb54) 6. Click **Yes**to stop all Peer Services. 7. Navigate to the Peer Management Center installation directory (typically **C:\\Program Files\\Peer Software\\Peer Management Center** ): ![PMC Installation Folder.png](https://kb.peersoftware.com/__attachments/a_688b98fbb29b65cf259f591096562dfa304d33e9c6724cd66b01f88d38fec256/PMC%20Installation%20Folder.png?cb=83993b030f811a8f4e5d4125353dfa59) 8. Back up the following files and folders by copying them to a backup location (such as a folder on the Desktop): PMC installation folder * PL-Hub.vmoptions (if present) * PL-Hub-Service.vmoptions (if present) * PL-Hub-Web-Service.vmoptions (if present) API subfolder * \\API\\PMC-API-Service.vmoptions (only with PeerGFS v4.6 and later) Broker subfolder * \\Broker\\PL-Broker.vmoptions Hub subfolder * \\Hub\\workspace\\jobs\\\* * \\Hub\\workspace\\prefs\\\* * \\Hub\\workspace\\fc.ini (if present) * \\Hub\\workspace\\hub.ini (if present) * \\Hub\\workspace\\backup.ini (only with PeerGFS v4.5 and later) * \\Hub\\workspace\\db\\peerlink\\\* * \\Hub\\workspace\\db\\backup\\\* (only with PeerGFS v4.5 and later) * \\Hub\\workspace\\db\\dfs\\\* (only with PeerGFS v4.3 and later) * \\Hub\\workspace\\db\\filecollaboration\\\* Before backing up the **Hub\\workspace\\db\\filecollaboration**subfolder, check its size. If it is greater than 1 GB, we recommend NOT backing it up. This particular database folder will be automatically rebuilt when you start your PeerGFS jobs. 9. Open Windows Service Manager (services.msc). 10. Start Peer Management Broker Service. ![Stop Peer Management Broker Service.png](/__attachments/a_022a8e216e636b87b6a765e482fa8dcbe4eeee7ac07968b9685d1c64ee5f7974/Stop%20Peer%20Management%20Broker%20Service.png?cb=9fa5631f343d6b162f6479183747cf22) 11. Repeat for the following services, in this order: 1. Peer Management Center Service 2. Peer Management Center Web Service (if you are using the web interface) 3. Peer Management API Service (if you are using the PeerGFS API) 4. Peer Management Topology Service 12. Open the Peer Management Center web interface or rich client. 13. Start jobs as necessary. Manually back up your PeerGFS configuration on Linux To manually back up your PeerGFS configuration on Linux, follow these steps: 1. Open the Peer Management Center web interface. 2. Stop all running jobs. 3. Use SSH to connect to the Linux server where the Peer Management Center is installed. 4. Run the following commands in order to shut down the Peer Management Center service stack: sudo systemctl stop PL-Hub-Web-Service.service sudo systemctl stop PMC-API-Service.service sudo systemctl stop Peer-Management-Topology-Service.service sudo systemctl stop PL-Hub-Service.service sudo systemctl stop PL-Broker.service 5. Navigate to the Peer Management Center installation directory (typically **/opt/peersoftware/peer-management-center** ): 6. Back up the following files and folders by copying them to a backup location (such as a folder under **\~/**): PMC installation folder * ./PL-Hub.vmoptions (if present) * ./PL-Hub-Service.vmoptions (if present) * ./PL-Hub-Web-Service.vmoptions (if present) API subfolder * ./API/PMC-API-Service.vmoptions (only with PeerGFS v4.6 and later) Broker subfolder * ./Broker/PL-Broker.vmoptions Hub subfolder * ./Hub/workspace/jobs/\* * ./Hub/workspace/prefs/\* * ./Hub/workspace/fc.ini (if present) * ./Hub/workspace/hub.ini (if present) * ./Hub/workspace/backup.ini (only with PeerGFS v4.5 and later) * ./Hub/workspace/db/peerlink/\* * ./Hub/workspace/db/backup/\* (only with PeerGFS v4.5 and later) * ./Hub/workspace/db/dfs/\* (only with PeerGFS v4.3 and later) * ./Hub/workspace/db/filecollaboration/\* Before backing up the ./**Hub/workspace/db/filecollaboration**subfolder, check its size. If it is greater than 1 GB, we recommend NOT backing it up. This particular database folder will be automatically rebuilt when you start your PeerGFS jobs. 7. Run the following commands in order to start the Peer Management Center service stack: sudo systemctl start PL-Broker.service sudo systemctl start PL-Hub-Service.service sudo systemctl start Peer-Management-Topology-Service.service sudo systemctl start PMC-API-Service.service sudo systemctl start PL-Hub-Web-Service.service 8. Open the Peer Management Center web interface. 9. Start jobs as necessary. ## Related articles * [Back up your PeerGFS configuration manually](https://kb.peersoftware.com/kb/back-up-your-peergfs-configuration-manually.md) * [Can a job back up files that were created between two specific dates?](https://kb.peersoftware.com/kb/can-a-job-back-up-files-that-were-created-between-.md) * [Cannot upgrade PeerIQ virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-peeriq-virtual-appliance.md) * [Cannot upgrade PMC virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-pmc-virtual-appliance.md) * [Check for a new version of PeerGFS](https://kb.peersoftware.com/kb/check-for-a-new-version-of-peergfs.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Move Peer Management Center to another machine](https://kb.peersoftware.com/kb/move-the-pmc-to-another-machine.md) * [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) * [Set up real-time one-way replication](https://kb.peersoftware.com/kb/set-up-real-time-one-way-replication.md) * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Update PeerIQ](https://kb.peersoftware.com/kb/update-peeriq.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) --- language: "en" --- # Best Practices: PeerGFS and FSLogix Design Considerations FSLogix provides the ability to roam profiles in remote computing environments by storing a complete user profile in a single container. At user sign in, this container is dynamically attached to the remote computing environment as a natively supported virtual hard disk (VHD or VHDX formats). The user's profile is immediately available and appears in the system exactly like a native user profile. PeerGFS can replicate the container files and user data in multi-site, multi-platform, and hybrid multi-cloud environments, making them highly available across environments. ## Interaction between PeerGFS and FSLogix PeerGFS can replicate the container files with other file servers only while a user remains logged out of their profile. When a user is logged into their profile, FSLogix places a write handle on its associated profile container, and any changes made to the profile cannot be replicated until logoff. When a user logs out of their profile, PeerGFS can replicate any changes made to the profile container within seconds of the logoff or on a schedule. Profile containers can take advantage of PeerGFS's delta-level replication functionality where only the changed segments of the underlying virtual hard disk are replicated. ## Achieving real-time replication with FSLogix containers Microsoft Windows allows the redirection of specified folders (e.g., Downloads, Desktop, Documents) into standard CIFS/SMB shares. PeerGFS can replicate the contents of those folders in real-time, including "Sync-on-Save" functionality for specific applications (e.g., Microsoft Office). With redirection, customers can achieve real-time protection and availability for specified files and folders and scheduled or end-of-workday protection for container files. ## Summary FSLogix stores data in container files. Data stored within the container will not be replicated in real-time. Replication can occur only while the user is signed-off and the profile container is unlocked. Real-time replication of file data is possible when specified folders are redirected outside of the container and into CIFS/SMB shares. ## Related articles * [Best Practices: PeerGFS and FSLogix Design Considerations](https://kb.peersoftware.com/kb/best-practices-FSLogix-design-considerations.md) * [Should minimum file size equal or exceed delta block transfer size?](https://kb.peersoftware.com/kb/peergfs-minimum-file-size-for-delta-block-transfer.md) * [What are \~PSTMP files?](https://kb.peersoftware.com/kb/what-are-pstmp-files.md) --- language: "en" --- # Best Practices: Autodesk Inventor Autodesk Inventor is a 3D mechanical CAD software program for crating 3D digital prototypes used in the design, visualization and simulation of products. Autodesk Inventor does not maintain a handle on opened files and allows multiple users the ability to open and edit the same file. Inventor relies on a file named **lockfile.lck** to prevent users from saving changes which may overwrite the work of other users. The lock file stores user and status information of Inventor files opened and modified within the same directory. ## Lock file A single Inventor lock file (**lockfile.lck**) exists per directory to manage all Inventor files within that directory. It gets created when a user opens an Inventor file and will remain there until the user closes Inventor. As more users open files from that directory through Inventor, the lock file gets updated to keep track of those files. Inventor maintains a handle on the lock file while at the same time allowing Read + Write access to it. This is to ensure that Inventor can continue to make updates to the file as users open, close, and modify files. These files are partially locked and are similar to Exchange and SharePoint managed files. ## Peer interaction In order for us to be able to collaborate on Inventor files, we must be able to synchronize the lock file as soon as it changes in order for Inventor to be able to protect files from being overwritten in all locations. Both Peer Global File Service and PeerSync have ways to achieve this to some degree, but the solutions they provide are **incomplete**: * Peer Global File Service, for example, needs to use the Sync on Save option, but has no option currently to exclude the lock file form being locked---if Peer Global File Service locks the lockfile.lck file, it will prevent Inventor from writing to it on the source/target to prevent version conflicts. * PeerLock is able to exclude the lock file from being locked, but PeerSync requires the use of VSS on an aggressive cycle to gain access to the source file while it is in use. Note: Additional PeerSync options that may be needed: /Q7R (to get a very light handle on the source file) /GYV05 (to get a more frequent VSS frequency) /QD (for VSS to include only the extensions we are interested in) /YF:.lck (identify the lock file in the VSS extension list) * More importantly, both products will fail to synchronize the lock file if it is locked by Inventor on the target. This means if anyone opens ANY Inventor file in the same directory as the target file, Inventor will fail to write that information to the lockfile.lck. Thus, PeerSync and Peer Global File Service will fail to update the lock file if anyone has an Inventor file open in the target folder. * In order for us to be able to update the partially locked lockfile.lck file, we would need to learn more about how Inventor writes to the lock file. This would involve some reverse engineering of the file to figure out what blocks are locked and where do new records get written to (at the end?). We could then customize our sync logic to be compatible. ## Summary Both Peer Global File Service and PeerSync support the synchronization of Inventor files as long as the **lockfile.lck** file is excluded from being locked. Therefore, Peer only supports Inventor files in scenarios where these files are accessed by users in one location only. This requires adding the **lockfile.lck** file to the list of **SyncOnly** filters in Peer Global File Service and excluding them from PeerLock (but not PeerSync). Peer will fail to synchronize the **lockfile.lck** file if it is locked by Inventor on the target. This means that if anyone opens ANY Inventor file(s) in the same directory as the target file, Peer Global File Service and PeerSync will fail to sync the lock file. ## Related articles * [Best Practices: Autodesk Inventor](https://kb.peersoftware.com/kb/best-practices-autodesk-inventor.md) * [Best Practices: Autodesk Sheet Set Manager](https://kb.peersoftware.com/kb/best-practices-civil-3d-sheet-set-dst.md) * [Does element borrowing work cross-domain where user names are not recognized by Active Directory?](https://kb.peersoftware.com/kb/peergfs-element-borrowing-with-unrecognized-users.md) --- language: "en" --- # Best Practices: Autodesk Sheet Set Manager Sheet sets for both AutoCAD and Civil 3D are stored in `.dst` files, which are *not* locked when loaded by users. This allows multiple users to open the same sheet set and access the associated reference files simultaneously. If one user makes a change to the sheet set---such as adding, removing, renaming, or reordering sheets---those changes are synchronized by Peer Global File Service (PeerGFS) and automatically reloaded in the Sheet Set Manager for other users. Users may need to manually refresh the Sheet Set Manager to view the latest updates. ![Sheet Set Manager](https://kb.peersoftware.com/__attachments/a_e0d654c4fd5af9d78983709306b94c20bb490d3ff16c12dc7ae68080f275f0c5/SheetSetManager.png?cb=ec2facd01621f1f64090da9627025c5f) The Sheet Set Manager displays a **lock** icon next to a referenced file that is currently in use, provided the file has an associated `.dwl` drawing lock file. By default, file filters exclude `.dwl` files from synchronization by PeerGFS. ## Enabling Sheet Set Manager Support in PeerGFS If you're using PeerGFS v6.0 or later, you can configure support for Sheet Set Manager---as well as AutoCAD or Civil 3D---directly within the **Edit Job** wizard. Enabling support for **Sheet Set Manager** ensures that PeerGFS is properly configured to synchronize the `.dst` files used by AutoCAD or Civil 3D, allowing seamless collaboration and synchronization of sheet sets across users. If you're using a PeerGFS version earlier than v6.0, contact [Peer Support](https://servicedesk.jira.peersoftware.com/) for assistance. To enable proper synchronization of sheet set files in PeerGFS v6.0 and later: 1. Edit your existing job from within **Peer Management Center (PMC)**. 2. In the **Edit Job** wizard, select the **Application Support** page. ![Application Support.png](https://kb.peersoftware.com/__attachments/a_3200b0d84459025570dcc3488f413e7eae48ec8a65d71aecc5c1dfae4ac67ef8/Application%20Support.png?cb=7b30eae0431dae9d9e478bf5dc2cf224) 3. Select the following options: * **Autodesk Sheet Set Manager** (for AutoCAD or Civil 3D). * **Autodesk AutoCAD** or **Autodesk Civil 3D**, depending on which application you use with Sheet Set Manager. 4. Click **OK**, and then restart the job. Related articles * [Best Practices: Autodesk Inventor](https://kb.peersoftware.com/kb/best-practices-autodesk-inventor.md) * [Best Practices: Autodesk Sheet Set Manager](https://kb.peersoftware.com/kb/best-practices-civil-3d-sheet-set-dst.md) * [Does element borrowing work cross-domain where user names are not recognized by Active Directory?](https://kb.peersoftware.com/kb/peergfs-element-borrowing-with-unrecognized-users.md) --- language: "en" --- # Best Practices: CommVault file collaboration ## Goals * Synchronize CommVault placeholder files without recalling them. * Ensure that file archiving and unarchiving events are mirrored across all participating sites. ## CommVault recommendations * The CommVault Agent must be installed and running on all the servers where users will open files. * The CommVault archiving policy must leave behind placeholder shortcut files immediately after files have been archived. * Support for CommVault placeholder files applies only to files and will not apply to email, SharePoint, or social media information that may be managed by CommVault. ## Peer Global File Service configuration options * Enter **29** in the **File Metadata** \> **Reparse Tag Name (numerical value only)** field. * Identify the host where CommVault archives files. In Peer Global File Service, select that host from the**File Metadata** \> **Reparse Master Host** drop-down list. During scans, Peer Global File Service will synchronize the placeholder files from the Master Host to all participating sites. ## Related articles * [Best Practices: CommVault file collaboration](https://kb.peersoftware.com/kb/best-practices-commvault-file-collaboration.md) * [How does PeerGFS handle permission conflicts during scans?](https://kb.peersoftware.com/kb/how-does-peergfs-handle-permission-conflicts-durin.md) * [When should I synchronize permissions in real-time but not during the scan?](https://kb.peersoftware.com/kb/when-should-i-sync-perms-in-rt-but-not-during-scan.md) --- language: "en" --- # Best Practices: Revit Worksharing When operating in **Worksharing** mode, a Revit model requires the use of a Central file that is stored on a network location. In a multi-site environment, the Central file is replicated across all the locations in order to provide users with LAN access to the file. Users within each site copy the central file onto their Desktops, make updates locally and periodically save their changes to the Central file so that other users can see their work. The path to the Central file is stored within the Central file. When the file is replicated across all the sites, the path to the Central file is retained. This can result in users saving their work across the WAN to the original Central file instead of the copy on their local file server. ## Solution 1: Utilize DFS Namespace Users need to access the Revit files on their local file server through a Microsoft DFS Namespace. This can be done via a UNC path or mapped drive (does not need to be the same on all user workstations). The DFS namespace allows the path to the Central file to be generic and, when queried by Revit, points to the closest file server on the LAN. ## ![image2016-6-2 9:58:37.png](https://kb.peersoftware.com/__attachments/a_532287fdaeecf53da7a501723aa84dcd546da8808ebf4b3880e256c083be2bc6/image2016-6-2%209:58:37.png?cb=12d53abc5d775fd133bb20e3c64aaf65) Solution 2: Utilize Virtual Mapped Drive Create a **virtual** mapped drive using the same drive letter on all user workstations (not to be confused with a **standard mapped drive** ). A virtual mapped drive provides a generic path to the Central file and prevents Revit from converting the path to its UNC format. Because virtual drives do not persist during reboots, use the **SUBST** command via a login script to create a new drive letter that maps to the location where the Central files are stored. ![SUBST.png](https://kb.peersoftware.com/__attachments/a_517a19e49d7f2549b0eecfcd4cdb784b10aa19c140f2ffc76fb71bf1451e0166/SUBST.png?cb=a7d10bc7ba397f4339d2bd236e306fb7) Another way is to make a registry modification which creates the virtual drive that persists across reboots: 1. Map a drive letter to the location where the Central files are stored (in this example we use **R:\\**). 2. Create a new registry entry "String Value" in the following key (in this example we use **V:**): ![REGISTRY.png](https://kb.peersoftware.com/__attachments/a_6e83da19d615e7c0dd475e7d7510231ee15f47b91140df77a4f5059919cf3540/REGISTRY.png?cb=d1f00ac14905eb56c3b1207a373f57e9) ![image2016-6-2 10:1:31.png](https://kb.peersoftware.com/__attachments/a_f6327f19f2f47c0859b8de9690e7f61caa3de36fd765662cce922b709622a0ff/image2016-6-2%2010:1:31.png?cb=23d3277d38c6ee1d022dd454ebb459d2) * The **Value name** should be **V:**, where V is the new drive letter you wish to create. * The **Value data** needs to be in the form **\\??\\R:\\path**, where R is the map drive created above. You now have a new Local Disk drive V. When a local copy is made of the Central file from the virtual drive, the path to the Central file will be the generic V drive and RevIt will not be able to convert it to its UNC equivalent. ![image2016-6-2 10:4:29.png](https://kb.peersoftware.com/__attachments/a_e3fc1d8bead5ccb37cb573ed5bfd63443aa9cd5a4b9898d0d07f5f4686d74b95/image2016-6-2%2010:4:29.png?cb=ddf64bfd93942a1098d9804ee4281c7c) ## Related articles * [Best Practices: Revit Worksharing](https://kb.peersoftware.com/kb/best-practices-revit-worksharing.md) * [Can I use DFS Namespaces when specifying folder paths in PeerSync?](https://kb.peersoftware.com/kb/can-i-use-dfs-namespaces-when-specifying-folder-pa.md) * [Does element borrowing work cross-domain where user names are not recognized by Active Directory?](https://kb.peersoftware.com/kb/peergfs-element-borrowing-with-unrecognized-users.md) * [Does PeerSync work with Revit?](https://kb.peersoftware.com/kb/does-peersync-work-with-revit.md) * [What should users expect when a Revit .RVT file is quarantined?](https://kb.peersoftware.com/kb/what-should-users-expect-when-a-revit-rvt-file-is-.md) --- language: "en" --- # Best Practices: Stop jobs before performing bulk changes to a PeerGFS-monitored system When using Robocopy or making other mass bulk changes (e.g. metadata changes, file seeding) to a file server being replicated by PeerGFS, the best practice is to disable jobs before using Robocopy or performing the mass bulk changes. Otherwise, if there are excessively high levels of data changes incurred by Robocopy, the Peer Agent may become overwhelmed trying to keep up with them. This can cause undesired behavior in the host server. ## Steps 1. Stop all jobs that use the Agent that is the target of the Robocopy or bulk changes. 2. Perform the bulk changes. 3. Restart the jobs. ## Related articles * [Best Practices: Stop jobs before performing bulk changes to a PeerGFS-monitored system](https://kb.peersoftware.com/kb/best-practices-stop-jobs-before-bulk-changes.md) --- language: "en" --- # Best Practices: Symantec Enterprise Vault file collaboration ## Goals * Synchronize Symantec Enterprise Vault placeholder files without recalling them. * Ensure that file archiving and unarchiving events are mirrored across all participating sites. ## Symantec Enterprise Vault recommendations * The FSA Agent must be installed and running on all the servers where users will open files. * The Enterprise Vault archiving policy must leave behind placeholder shortcut files, not Internet links, and the placeholder files must be created immediately. * Support for Symantec Enterprise Vault placeholder files applies only to files and will not apply to email, SharePoint, or social media information that may be managed by Enterprise Vault. * Peer Global File Service supports SEV versions 9, 10, and 11. ## Peer Global File Service configuration options * Enter **16** in the **File Metadata** \> **Reparse Tag Name (numerical value only)** field. * Identify the host where Symantec Enterprise Vault archives files. In Peer Global File Service, select that host from the **File Metadata** \>**Reparse Master Host** drop-down list. During scans, Peer Global File Service will synchronize the placeholder files from the Master Host to all participating sites. ## Related articles * [Best Practices: Symantec Enterprise Vault file collaboration](https://kb.peersoftware.com/kb/best-practices-symantec-enterprise-vault-file-coll.md) * [Is there a list of known applications which may interfere with VSS functionality?](https://kb.peersoftware.com/kb/is-there-a-list-of-known-applications-which-may-in.md) --- language: "en" --- # Can a job back up files that were created between two specific dates? **Question:** Is it possible to create a job to back up files that were created between two specific dates? **Answer:** You can create a job to include the relevant dates by selecting Exceptions on the appropriate job, and then clicking on the button in the Selected File Dates box. This box has an option at the bottom of the screen where you can enter the appropriate date range. You also have the option of deleting the source file after copying to the target. This option is located on the File Options screen. You would enter a check mark on the Move Files - Delete source field after successful copy to target option. (If this option is selected, make sure the Replicate option under File Options is not checked). ## Related articles * [Can a job back up files that were created between two specific dates?](https://kb.peersoftware.com/kb/can-a-job-back-up-files-that-were-created-between-.md) --- language: "en" --- # Can I copy a 100 GB file? There is no limit on the file size. There is an option that allows recovery of partial files if there is a break in transmission. The option is called 'File Recovery' and is in the 'Additional Features' window. We strongly encourage evaluation prior to purchase to make sure your system and environment is able to handle large files processing without impacting other processes. --- language: "en" --- # Can I use DFS Namespaces when specifying folder paths in PeerSync? If possible, we recommend specifying the full administrative paths to the remote machines. Under certain circumstances, it may be more convenient to use DFS namespaces. PeerSync supports the use of DFS namespaces, provided that they are accessible by the host and user account running PeerSync. If using DFS namespace paths with the ByteReplicator, the PSListener will need to be installed on the Domain Controller. If you have more than one Domain Controller in your domain it may be necessary to install the PSListener on all of them. The PSListener would need to be installed on all the Domain Controllers that could potentially be selected by the host computer when it tries to look up the DFS namespace. ## Related articles * [Best Practices: Revit Worksharing](https://kb.peersoftware.com/kb/best-practices-revit-worksharing.md) * [Can I use DFS Namespaces when specifying folder paths in PeerSync?](https://kb.peersoftware.com/kb/can-i-use-dfs-namespaces-when-specifying-folder-pa.md) * [Configure PeerSync Listener's advanced settings](https://kb.peersoftware.com/kb/configure-peersync-listener-s-advanced-settings.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Does PeerSync Listener have to be installed on both servers when using the ByteReplicator?](https://kb.peersoftware.com/kb/does-peersync-listener-have-to-be-installed-on-bot.md) * [How does the ByteReplicator work?](https://kb.peersoftware.com/kb/how-does-the-bytereplicator-work.md) * [Set up synchronization/replication over TCP](https://kb.peersoftware.com/kb/set-up-synchronization-replication-over-tcp.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) * [Why does ByteReplicator use .BRTMP temporary files?](https://kb.peersoftware.com/kb/why-does-bytereplicator-use-brtmp-temporary-files.md) --- language: "en" --- # Can I use PeerSync with Linux, Unix, or NetWare? With PeerSync Server Edition installed on a Windows OS, you can synchronize files between any network shared drive including: Linux, Unix, or NetWare. ## Licensing and configuration PeerSync Server includes one remote connection license. This gives you the ability to install PeerSync on one machine A (Windows OS) and connect to one additional remote machine B (any network shared drive including Linux, Unix, or NetWare). With the purchase of one Additional Remote Connection License, files from A can be synchronized to/from/between B and C. Only one copy of PeerSync needs to be installed on the primary machine A. No software is required on B and C. Operating modes include: on demand, scheduled, or interval. Note: Real-time updating on a remote machine is not supported. ## Related articles * [Can I use PeerSync with Linux, Unix, or NetWare?](https://kb.peersoftware.com/kb/can-i-use-peersync-with-linux-unix-or-netware.md) * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Move Peer Management Center to another machine](https://kb.peersoftware.com/kb/move-the-pmc-to-another-machine.md) * [Uninstaller not working on Windows 2012 or Newer](https://kb.peersoftware.com/kb/uninstaller-not-working-on-windows-2012-or-newer.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Where can I find the installers for PeerGFS components?](https://kb.peersoftware.com/kb/where-can-i-find-the-installers-for-peergfs-compon.md) * [Why isn't my PeerSync license key working?](https://kb.peersoftware.com/kb/why-isn-t-my-peersync-license-key-working.md) --- language: "en" --- # Can PeerSync change an IP address to point to a backup server? **Question:** If I have two identical servers running with different IP addresses, can PeerSync change the IP in my remote DNS to point to the other data center that's still up if a data center goes down? **Answer:** PeerSync is designed to synchronize/backup the data from one server to another. In your case, PeerSync could be used to keep a real-time backup of all the files and data from the primary server onto the backup server, which your users could then reference after the IP address was changed in the DNS. Any changes or modifications which may need to be made to the data in order to function on the backup server (such as importing the data into an application, updating any machine-specific configuration files, etc.) will need to be performed manually, as PeerSync will make sure the data folders are mirrored however it does not provide automatic failover. ## Related articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) --- language: "en" --- # Can PeerSync send email via server requiring SSL? **Question:**Is it possible to set a user name and password on the email to pass it through an email server requiring SSL? **Answer:**Currently PeerSync does not support user name/password authentication for sending email reports. PeerSync is only able to send emails through a local SMTP server which does not require such authentication. ## Related article * [Can PeerSync send email via server requiring SSL?](https://kb.peersoftware.com/kb/can-peersync-send-email-via-server-requiring-ssl.md) --- language: "en" --- # Cannot access the target drive ## Problem The following error message appears in the log file: Cannot initialize target device: T:\\Data (The system cannot find the path specified) ## Solution When running as a Service, be sure you are using a UNC path (\\\\Server\\Path\\To\\Folder) instead of a mapped drive when specifying the target. Changing your target path to use the UNC path of the target location will resolve the issue. You may also want to try using the server's IP address. If the issue still persist, make sure your PeerSync Service is running under an Administrator account with enough rights to your source and target folders. ## Related articles * [Cannot access the target drive](https://kb.peersoftware.com/kb/cannot-access-the-target-drive.md) --- language: "en" --- # Cannot see the PeerSync Profiler Display The most common cause of no display in the Profiler is that mail slots are not working properly and it is usually due to the Local Area Connection's NetBIOS Settings. 1. Go to **Control Panel** \> **Network and Sharing Center**. 2. Click **View Status** to the right of the Local Area Connection. 3. Click **Properties**. 4. Select **Internet Protocol Version 4 (TCP/IPv4)** and click **Properties**. 5. Select **Advanced**. 6. Select the **Default** *or* **Enable** option under **NetBIOS setting (WINS tab)**. This signifies that NetBIOS is enabled. 7. Select **OK** and **close out** all windows to apply the change if it was needed. ## Related articles * [Cannot see the PeerSync Profiler Display](https://kb.peersoftware.com/kb/cannot-see-the-peersync-profiler-display.md) * [Create a Profile](https://kb.peersoftware.com/kb/create-a-profile.md) * [Distribute a PeerSync Profile to other machines on a network](https://kb.peersoftware.com/kb/distribute-a-peersync-profile-to-other-machines-on.md) * [Find all the configuration options of the PeerSync software](https://kb.peersoftware.com/kb/find-all-the-configuration-options-of-the-peersync.md) * [Link an existing PeerSync configuration with the PMC](https://kb.peersoftware.com/kb/link-an-existing-peersync-configuration-with-the-p.md) * [Move a PeerSync configuration to a new server](https://kb.peersoftware.com/kb/move-a-peersync-configuration-to-a-new-server.md) * [Set up PeerSync to run as a service](https://kb.peersoftware.com/kb/set-up-peersync-to-run-as-a-service.md) * [Set up real-time bi-directional synchronization](https://kb.peersoftware.com/kb/set-up-real-time-bi-directional-synchronization.md) * [Supported predefined variables](https://kb.peersoftware.com/kb/supported-predefined-variables.md) --- language: "en" --- # Cannot send email alerts using SMTP server with Office 365 ## Problem I tried to send email alerts using the PMC user interface, but received this error message: "MessagingException --\> Exception reading response" ## Cause The recipients' mailboxes are hosted within Microsoft 365 or Office 365, and the SMTP server of Microsoft Office 365 or Office 365 is not configured to send mail directly from applications to the mailboxes. ## Solution Set up Direct Send through Office365. See Option 2 in this Microsoft article: ## Related articles * [Cannot send email alerts using SMTP server with Office 365](https://kb.peersoftware.com/kb/cannot-send-email-alerts-using-smtp-server-with-of.md) * [How do I install Health Checker on a remote server?](https://kb.peersoftware.com/kb/installing-health-checker-on-a-remote-server.md) * [What is the Health Checker?](https://kb.peersoftware.com/kb/what-is-the-health-checker.md) --- language: "en" --- # Cannot upgrade PeerIQ virtual appliance via the console menu ## Problem When attempting to upgrade software via the console menu on a PeerIQ virtual appliance, the following error message is displayed: ![image-20250110-183524.png](https://kb.peersoftware.com/__attachments/a_a7d1a729253b613408bc8838daf1afbbad3dce816213716ce324c9a41a4e4aa0/image-20250110-183524.png?cb=ee7053a80743903559a1b05e8929d067) ## Cause Microsoft recently discontinued the service that we used to make our product installers available via a content delivery network. The replacement service lacks some of the previous capabilities, which prevents our upgrade logic from working within the virtual appliances' console menu system. ## Solution To resolve this issue, a new version of the console menu system is available. Upgrading to this version requires the following manual steps: 1. Connect into the virtual appliance via SSH. 2. Download the new `menu.sh` file using the command: wget https://peerdownloads.blob.core.windows.net/appliances/61/menu_linux_6_1_0_64_piq.sh 3. Make the new script executable: chmod a+x menu_linux_6_1_0_64_piq.sh 4. Launch the new script: sudo ./menu_linux_6_1_0_64_piq.sh 5. Select **Upgrade this Menu**. ![image-20250110-184253.png](https://kb.peersoftware.com/__attachments/a_1b51307790a6e38c5c90ec345150997d3abb3938a624f5c087118743ae146d46/image-20250110-184253.png?cb=ddc09c220a61786bb4e2e41bf54b71fa) 6. Select **Download** and press **Enter**. ![image-20250110-184358.png](https://kb.peersoftware.com/__attachments/a_8d20b4ae1478d9cccbc354e7bcc59b01dd434a72994d3566207a7feb49e95352/image-20250110-184358.png?cb=1d72f63fd5fb3c2e3fbe24da44ee0830) 7. When the update is complete, select **OK**. ![image-20250110-184429.png](https://kb.peersoftware.com/__attachments/a_bd7c3c74fe2af566c89b9d49e534fc73d56372277d8db4201129c5386efe5f93/image-20250110-184429.png?cb=6a10e0a97899760224fc3dc8e48cb851) 8. Select **Exit**. ![image-20250110-184513.png](https://kb.peersoftware.com/__attachments/a_8ed387d435dc7584493925ea4ec54376b89a5a34a9319d319b6a493608dae6bf/image-20250110-184513.png?cb=ff427fead6e277d75a860f35d4084f11) After completing these steps, you can re-run the script that launches the console menu system and proceed with the desired upgrades using the command: sudo menu.sh ## 📎 Related articles * [Back up your PeerGFS configuration manually](https://kb.peersoftware.com/kb/back-up-your-peergfs-configuration-manually.md) * [Cannot upgrade PeerIQ virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-peeriq-virtual-appliance.md) * [Cannot upgrade PMC virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-pmc-virtual-appliance.md) * [Check for a new version of PeerGFS](https://kb.peersoftware.com/kb/check-for-a-new-version-of-peergfs.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Getting Started with the PeerIQ Virtual Appliance](https://kb.peersoftware.com/kb/getting-started-with-the-peeriq-virtual-appliance.md) * [Getting Started with the PMC Virtual Appliance](https://kb.peersoftware.com/kb/getting-started-with-the-pmc-virtual-appliance.md) * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Update PeerIQ](https://kb.peersoftware.com/kb/update-peeriq.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) * [What is File Activity Analytics?](https://kb.peersoftware.com/kb/what-is-file-activity-analytics.md) * [What is File System Analytics?](https://kb.peersoftware.com/kb/what-is-file-system-analytics.md) --- language: "en" --- # Cannot upgrade PMC virtual appliance via the console menu ## Problem When attempting to upgrade software via the console menu on a PMC virtual appliance, the following error message is displayed: ![image-20250110-183524.png](https://kb.peersoftware.com/__attachments/a_c04807c311cac457fae5dc5e01ddd79c711ace20ee420b128dd7fcfb52759e12/image-20250110-183524.png?cb=ee7053a80743903559a1b05e8929d067) ## Cause Microsoft recently discontinued the service that we used to make our product installers available via a content delivery network. The replacement service lacks some of the previous capabilities, which prevents our upgrade logic from working within the virtual appliances' console menu system. ## Solution To resolve this issue, a new version of the console menu system is available. Upgrading to this version requires the following manual steps: 1. Connect into the virtual appliance via SSH. 2. Download the new `menu.sh` file using the command: wget https://peerdownloads.blob.core.windows.net/appliances/61/menu_linux_6_1_0_64_piq.sh 3. Make the new script executable: chmod a+x menu_linux_6_1_0_64_piq.sh 4. Launch the new script: sudo ./menu_linux_6_1_0_64_piq.sh 5. Select **Upgrade this Menu**. ![image-20250110-184253.png](https://kb.peersoftware.com/__attachments/a_2c57cfc0396521ecaa6f1a91e6e7e1a68c2567ed720fe226cc763e03beb4623a/image-20250110-184253.png?cb=ddc09c220a61786bb4e2e41bf54b71fa) 6. Select **Download** and press **Enter**. ![image-20250110-184358.png](https://kb.peersoftware.com/__attachments/a_8120cbffdb2fd3cead03cdd92a60ae55d0b7a3c4b65c2c47ef9f11a61162d02e/image-20250110-184358.png?cb=1d72f63fd5fb3c2e3fbe24da44ee0830) 7. When the update is complete, select **OK**. ![image-20250110-184429.png](https://kb.peersoftware.com/__attachments/a_8750992acecaa4844b41bde8d94c3491fa580d2311937571d6fc0832c478b640/image-20250110-184429.png?cb=6a10e0a97899760224fc3dc8e48cb851) 8. Select **Exit**. ![image-20250110-184513.png](https://kb.peersoftware.com/__attachments/a_fb497dd659e5f3c74cd896314f5cbfba29b2b23f0f12485a5e287069a3692c1f/image-20250110-184513.png?cb=ff427fead6e277d75a860f35d4084f11) After completing these steps, you can re-run the script that launches the console menu system and proceed with the desired upgrades using the command: sudo menu.sh ## 📎 Related articles * [Back up your PeerGFS configuration manually](https://kb.peersoftware.com/kb/back-up-your-peergfs-configuration-manually.md) * [Cannot upgrade PeerIQ virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-peeriq-virtual-appliance.md) * [Cannot upgrade PMC virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-pmc-virtual-appliance.md) * [Check for a new version of PeerGFS](https://kb.peersoftware.com/kb/check-for-a-new-version-of-peergfs.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Getting Started with the PeerIQ Virtual Appliance](https://kb.peersoftware.com/kb/getting-started-with-the-peeriq-virtual-appliance.md) * [Getting Started with the PMC Virtual Appliance](https://kb.peersoftware.com/kb/getting-started-with-the-pmc-virtual-appliance.md) * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Update PeerIQ](https://kb.peersoftware.com/kb/update-peeriq.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) * [What is File Activity Analytics?](https://kb.peersoftware.com/kb/what-is-file-activity-analytics.md) * [What is File System Analytics?](https://kb.peersoftware.com/kb/what-is-file-system-analytics.md) --- language: "en" --- # Check for a new version of PeerGFS ## Overview You can check to see whether a new version of PeerGFS has been released by using the **Check for Updates** functionality within Peer Management Center. If a minor update is available, you can proceed to immediately install the new version. If a major upgrade is available, you must first obtain a new license by submitting the [Peer Global File Service Upgrade Form](https://go.peersoftware.com/peergfs-upgrade-requests-contact-us?chat_topic_source=kb-upgrade). You should also back up your PeerGFS configuration before installing a major upgrade. See [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) to learn more about Peer Software major and minor releases. Update versus upgrade Although **update** and **upgrade** are often used interchangeably in the technology world, an **update** (or **patch** ) is typically an enhancement to the current version of the software, while an **upgrade** is typically a whole new version of the software. Overall, the processes for updating and upgrading are very similar. However, an upgrade requires a new version license and a few additional steps. See the [Check for a new version of PeerGFS \| CheckforanewversionofPeerGFS Step by stepguide](https://kb.peersoftware.com/kb/check-for-a-new-version-of-peergfs.md#CheckforanewversionofPeerGFS-Step-by-stepguide) section for detailed instructions for checking for a new version of PeerGFS. Instructions for installing the new version are provided in the following knowledge base articles: * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) ## Step-by-step guide If you are running Peer Management Center on a Windows Server and have access to the rich client, you can use the UI to check for, download, and install updates. If you do not have access to the rich client or are running on a Linux server, there are convenience scripts available within the installation folder of Peer Management Center. Check for Updates from the PMC rich client on Windows You can configure Peer Management Center to automatically check for and download minor updates. If configured, Peer Management Center checks for updates every evening at 11 p.m. local time. Only minor updates can be downloaded; if a major upgrade is available, a notification is displayed. Major upgrades require a new license which can be requested by submitting the [Peer Global File Service Upgrade Form](https://go.peersoftware.com/peergfs-upgrade-requests-contact-us?chat_topic_source=kb-upgrade). See **Software Updates** in the PeerGFS User Guide for instructions on setting up PMC to automatically check for and download updates. To check for a new version of PeerGFS: 1. Open Peer Management Center. 2. From the **Help** menu, select **Check for Updates** . ![image2021-10-11_15-27-31.png](https://kb.peersoftware.com/__attachments/a_7a7637ba186b1e6cf2d4f377dfaecc1b31af580d29cb7dd6c2f97a27928cb2fa/image2021-10-11_15-27-31.png?cb=162d2d4878c1a1f68c0b20cdeb6e14a2) The **Check for Updates** dialog appears. The information displayed varies depending on whether a new version is available. Minor update available If a **minor** update is available, the dialog identifies the new version (and your current version) and provides a link to the release notes. Click **Yes** to proceed with downloading the new version. ![image2021-9-7_0-51-56.png](https://kb.peersoftware.com/__attachments/a_8c367e03a4ecab302957193c3203a7933c82b0d0959b0360cafa056b32e6b7e0/image2021-9-7_0-51-56.png?cb=237d131e63e7dabe3265e1190e32504e) Major upgrade available If a **major** upgrade is available, the dialog presents a link to an announcement page on the Peer Software website. Click this link to learn more about the new major release and to request a license. ![image2021-9-20_2-21-15.png](https://kb.peersoftware.com/__attachments/a_822cabdc852c175b747d43468372bc761c465c769f5f28b055a051d00d7f4bf8/image2021-9-20_2-21-15.png?cb=ca8c71e336fd909660bfdcc7fd0ce7c0) Minor and major release available If **both a major and a minor release** are available, the dialog displays information about both. You can download and install the minor release. Click **Yes** to do so. If you want to learn about and request a license for the new major release, click on the link to the announcement page. ![image2021-9-15_1-8-18.png](https://kb.peersoftware.com/__attachments/a_300c9cee9ab25543f30af7e93f9c294ea3f2b4888f884a89678cf2efb5ba3983/image2021-9-15_1-8-18.png?cb=f77a88db60540ffb960079f9c88fe686) No update available If no updates are available, the dialog displays the following message: ![No updates available.png](https://kb.peersoftware.com/__attachments/a_823e593c414f0debff3f235662f955a1832e6af5d902f576f4fb5e45a1fceb4e/No%20updates%20available.png?cb=81e9c8dd0829546172e69cef09c0dc5e) 3. (Optional) Click **Release Notes** to learn more about the changes in the new version. 4. If a new version of PeerGFS is available, continue with the appropriate process: * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) Check for and install minor updates by script on Windows If this script finds an available minor update, it will automatically download and install the update. Make sure you are prepared to install the update prior to running this script. To use the convenience script to check for and install PMC updates on a Windows Server, follow these steps: 1. Use Remote Desktop to connect to a Windows Server where Peer Management Center is to be updated. 2. Navigate to **\\\tools**. 3. Run **Upgrade-PMCServiceStack.ps1** as an administrator. .\Upgrade-PMCServiceStack.ps1 4. If the script finds that a minor update is available, it will automatically download and install the update. If no minor update is available, the script will complete with a note stating that you are on the latest available version. Check for and install minor updates by script on Linux If this script finds an available minor update, it will automatically download and install the update. Make sure you are prepared to install the update prior to running this script. To use the convenience script to check for and install PMC updates on a Linux server, follow these steps: 1. Use SSH to connect to the Linux server where Peer Management Center is to be updated. 2. Navigate to **\/tools**. 3. Run **upgrade-pmc-service-stack.sh** as **sudo**. sudo ./upgrade-pmc-service-stack.sh 4. If the script finds that a minor update is available, it will automatically download and install the update. If no minor update is available, the script will complete with a note stating that you are on the latest available version. ## Related articles * [Back up your PeerGFS configuration manually](https://kb.peersoftware.com/kb/back-up-your-peergfs-configuration-manually.md) * [Can a job back up files that were created between two specific dates?](https://kb.peersoftware.com/kb/can-a-job-back-up-files-that-were-created-between-.md) * [Cannot upgrade PeerIQ virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-peeriq-virtual-appliance.md) * [Cannot upgrade PMC virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-pmc-virtual-appliance.md) * [Check for a new version of PeerGFS](https://kb.peersoftware.com/kb/check-for-a-new-version-of-peergfs.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Distribute a PeerSync Profile to other machines on a network](https://kb.peersoftware.com/kb/distribute-a-peersync-profile-to-other-machines-on.md) * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Move a PeerSync configuration to a new server](https://kb.peersoftware.com/kb/move-a-peersync-configuration-to-a-new-server.md) * [Move Peer Management Center to another machine](https://kb.peersoftware.com/kb/move-the-pmc-to-another-machine.md) * [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) * [Set up real-time one-way replication](https://kb.peersoftware.com/kb/set-up-real-time-one-way-replication.md) * [Unable to install as a service after upgrade](https://kb.peersoftware.com/kb/unable-to-install-as-a-service-after-upgrade.md) * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Update PeerIQ](https://kb.peersoftware.com/kb/update-peeriq.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) * [Where can I find the installers for PeerGFS components?](https://kb.peersoftware.com/kb/where-can-i-find-the-installers-for-peergfs-compon.md) --- language: "en" --- # Check .pc-trash\_bin date stored times for target protection With Peer Global File Service, you can enable **target protection** on a file collaboration, file replication, or file synchronization job. If this is done, when the file is modified on one of the participants, a copy of the file will be stored in the .pc-trash_bin folder on the remaining participants. Peer Global File Service will keep as many copies as are specified in the job's target protection options. Some customers have asked to see the timestamp of when the files were added to the .pc-trash_bin folder. This data is stored in an alternate data stream called **\~pc.TrashBinDate** and is stored as a number of milliseconds from the Linux epoch (01/01/1970). You can use a PowerShell command to show the contents of any .pc-trash_bin folder and the date/time that the files were added to the trash bin. ## Step-by-step guide 1. Open PowerShell: 1. Open the **Start** menu. 2. Type *powershell* and press **Enter** . 2. Copy and paste the following script into the PowerShell window: PowerShell Get-ChildItem -path e:\test\.pc-trash_bin | ForEach-Object {$cFileTime=@(); $FileTime=@(); $aFound=@()} {$FileTime=(Get-Content -Path ./$_ -Stream '~pc.TrashBinDate').Split("|")[1]; $epoch=Get-Date -Date "01/01/1970"; $cFileTime=$epoch.AddMilliseconds($FileTime) ; $Properties = @{FileName=$_.Fullname; "Date Stored"=$cFileTime}; $NewObject = New-Object PSObject -Property $Properties; $aFound+=$NewObject } {$aFound | ft -Property Filename, "Date Stored"} 3. Replace the **e:\\test\\.pc-trash_bin** entry with the path to the .pc-trash_bin folder you want to view the contents of. 4. Press **Enter** . Output similar to below will be displayed: FileName Date Stored -------- ---------- E:\\test\\.pc-trash_bin\\uno - Copy.xlsx 12/17/2015 3:56:05 PM E:\\test\\.pc-trash_bin\\uno.xlsx 12/17/2015 7:20:57 PM E:\\test\\.pc-trash_bin\\uno.xlsx\~pc-ver.1 12/17/2015 2:23:27 PM 5. If you'd like to export this to a text file, modify the script as follows: PowerShell Get-ChildItem -path e:\test\.pc-trash_bin | ForEach-Object {$cFileTime=@(); $FileTime=@(); $aFound=@()} {$FileTime=(Get-Content -Path ./$_ -Stream '~pc.TrashBinDate').Split("|")[1]; $epoch=Get-Date -Date "01/01/1970"; $cFileTime=$epoch.AddMilliseconds($FileTime) ; $Properties = @{FileName=$_.Fullname; "Date Stored"=$cFileTime}; $NewObject = New-Object PSObject -Property $Properties; $aFound+=$NewObject } {$aFound | ft -Property Filename, "Date Stored"} | Out-file -FilePath c:\temp\out.txt -Encoding ascii Make sure to point the **c:\\temp\\out.txt** file at a directory that exists so the file can be created. ## Related articles * [Check .pc-trash_bin date stored times for target protection](https://kb.peersoftware.com/kb/check-pc-trash_bin-date-stored-times-for-target-pr.md) * [How does PeerSync determine which file to sync to the target folder?](https://kb.peersoftware.com/kb/how-does-peersync-determine-which-file-to-sync-to-.md) * [How will the product react to Daylight Savings Time changes?](https://kb.peersoftware.com/kb/how-will-the-product-react-to-daylight-savings-tim.md) * [What does the Clean Up Trash Bin command do?](https://kb.peersoftware.com/kb/what-does-the-clean-up-trash-bin-command-do.md) --- language: "en" --- # Configuration Guides * [Dell PowerScale Syslog Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-syslog-configuration-guide.md) * [Dell PowerScale \| EMC Isilon Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-emc-isilon-configuration-guide.md) * [Dell PowerStore Configuration Guide](https://kb.peersoftware.com/kb/dell-powerstore-configuration-guide.md) * [Dell Unity Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-configuration-guide.md) * [Dell Unity Legacy Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-legacy-configuration-guide.md) * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Using a Peer Agent in a Windows Failover Cluster](https://kb.peersoftware.com/kb/using-a-peer-agent-in-a-windows-failover-cluster.md) --- language: "en" --- # Configure a blackout period to stop synchronization for specific times of the day An administrator may want to limit resource usage when the network bandwidth is busy with other activities (such as during working hours). ## Step-by-step guide 1. Click on **Blackout Settings** under **Automation** in the left menu tree. In order for Blackout Settings to appear in the menu, the left menu tree has to be in **Intermediate** or **Advanced** mode. 2. Select the specific job in the **Profiler Job List**that you wish to enable blackout settings for or else add another job. 3. In the main window, enter a **Start** and **End Time** (the duration of the blackout period, e.g., from 8 AM to 6 PM) or multiple start and end times; all times will be added to the **List of Current Selections**). 4. Check the box **Suspend active scans when a Blackout Period starts** for active scans to resume when the blackout period ends. If not checked, scans that were active upon start of a blackout period will be restarted (from the beginning) when the blackout period expires. Any scans scheduled to run during a blackout period will run after the blackout period ends, as long as **Suspend active scans when a blackout period starts** is enabled. 5. Save your changes and restart the PeerSync Application or Service for the changes to take effect. If a blackout period begins as a large file is being transferred, PeerSync will allow the transfer to complete but suspend any new events from being processed before the blackout period ends. Any changes made to the Profiler will take effect after the application or service is restarted. ## Related articles * [Configure a blackout period to stop synchronization for specific times of the day](https://kb.peersoftware.com/kb/configure-a-blackout-period-to-stop-synchronizatio.md) --- language: "en" --- # Configure PeerSync Listener's advanced settings PeerSync Listener is a mandatory part of the ByteReplicator option and the TCP Wan Connector and has to be installed, configured, and running on the target side before a successful byte-level synchronization can be run or a TCP connection established. When using ByteReplicator, keep in mind that: * The Target Path of the PeerSync Profile cannot be an FTP Target. * The PSListener Service has been installed, set up, and is running on the Target Machine. * The PeerSync license has an available Remote Connection License(s) with ByteReplicator. When using TCP Wan Connector, keep in mind that: * The Source/Target Path of the PeerSync Profile cannot be an FTP Source/Target. * The PSListener Service has been installed, set up, and is running on the Target Machine. * The PeerSync license has the TCP Wan Connector Option enabled. ## Step-by-step guide To set up PeerSync Listener's Advanced options: 1. Locate the **PSLConfig.exe** file located in the PeerSync Listener installation directory (by default, is set to C:\\Program Files\\PeerSync Listener), and then double-click it. The PeerSync Listener Configuration window will appear. It contains several options that can affect the way in which the ByteReplicator feature runs. Among these options are **TCP Port** , **Max Thread Count** , **Logging** , **Priority** , and **CPU Utilization** . For a description of each of these options and what they do, see the *PSListHelp.chm* file located in the same directory as the *PSLConfig.exe* executable. 2. Make the appropriate changes to the options. 3. Fromm the **File** menu, select **Save** . Your saved settings will be applied to the PSListener service within the time set by the **Reload Interval** option. Note that if you changed the **Application Priority** or the **TCP Port**, you will have to restart the service. 4. To restart the service, open up the **Services** window, right-click **PS Listener Utility Software** , and then select **Restart** . The service should then shut down and then start itself up again. See the *PSListHelp.chm* document in the PeerSync Listener installation directory for a detailed description of ByteReplicator features and how to set it up. ## Related articles * [Can I use DFS Namespaces when specifying folder paths in PeerSync?](https://kb.peersoftware.com/kb/can-i-use-dfs-namespaces-when-specifying-folder-pa.md) * [Configure PeerSync Listener's advanced settings](https://kb.peersoftware.com/kb/configure-peersync-listener-s-advanced-settings.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Does PeerSync Listener have to be installed on both servers when using the ByteReplicator?](https://kb.peersoftware.com/kb/does-peersync-listener-have-to-be-installed-on-bot.md) * [How does the ByteReplicator work?](https://kb.peersoftware.com/kb/how-does-the-bytereplicator-work.md) * [Set up synchronization/replication over TCP](https://kb.peersoftware.com/kb/set-up-synchronization-replication-over-tcp.md) * [Uninstaller not working on Windows 2012 or Newer](https://kb.peersoftware.com/kb/uninstaller-not-working-on-windows-2012-or-newer.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) * [What is the disk space requirement for PeerSync?](https://kb.peersoftware.com/kb/what-is-the-disk-space-requirement-for-peersync.md) * [Why does ByteReplicator use .BRTMP temporary files?](https://kb.peersoftware.com/kb/why-does-bytereplicator-use-brtmp-temporary-files.md) --- language: "en" --- # Configure PeerSync to synchronize in a clustered environment When deploying PeerSync in a clustered environment, it is important to remember that PeerSync by itself is not a cluster-aware solution and will not utilize any clustering features. Therefore, it should be treated as just a normal service that runs on a single server. ## Real-time synchronization In scenarios where PeerSync in a cluster environment will be synchronizing in real-time, it is recommended that a full licensed copy of PeerSync is running on all servers that will provide files or services similar to the original server hosting PeerSync. Each PeerSync will then be responsible for two tasks: 1. Synchronizing local data to the intended target. 2. Synchronizing local data to the other cluster machines. (Optional) Task 2 is optional because it may not be necessary for the cluster servers data to be synchronized, in cases such as the source storage data does not reside on any physical cluster machine and it is using a shared storage mechanism. These two tasks ensure that if another machine takes over, it will have the latest data available. ## Scheduled synchronization In scenarios where PeerSync in a cluster environment will be synchronizing on a schedule, it is recommended that a full licensed copy of PeerSync is installed on each server in the cluster that will provide files or services similar to the original server hosting PeerSync. These additional installations do not need to be running; however they should be configured and ready to be started either manually or by scripted action. Each PeerSync will be responsible for two tasks: 1. Synchronizing on a schedule the local data to the intended target (distribution), remote data to the local folder (backup), or in both directions (bi-directional). 2. Synchronizing local data to the other cluster machines. (Optional) Task 2 is optional because it may not be necessary for the cluster servers data to be synchronized, in cases such as the source storage data does not reside on any physical cluster machine and it is using a shared storage mechanism. ## Licensing A fully-licensed copy of PeerSync must be installed on each server in both real-time and scheduled scenarios. ## Related articles * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Move Peer Management Center to another machine](https://kb.peersoftware.com/kb/move-the-pmc-to-another-machine.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Where can I find the installers for PeerGFS components?](https://kb.peersoftware.com/kb/where-can-i-find-the-installers-for-peergfs-compon.md) * [Why isn't my PeerSync license key working?](https://kb.peersoftware.com/kb/why-isn-t-my-peersync-license-key-working.md) --- language: "en" --- # Configure the Agent installer to run unattended ## Overview This article applies to PMC v4.0 and older. You can configure the Agent installer to run attended and silently. This process relies on the Agent installer using a **Response File**, which stores the necessary information that is typically customized during a standard installation process. Example of a Response File: [![ResponseFile.png](https://kb.peersoftware.com/__attachments/a_f673d84099108cb8f6261c58a1f20f56a0a6653d0ebe4cb7654c4a07cd649d73/ResponseFile.png?cb=efbe2bc13a48b6717513d3fd3613bd73)](/__attachments/a_86a179a3468e98d7b9d801d6191df93128c0b0bbac5bbee622b51ccf3d8e5270/ResponseFile.varfile.md?cb=352de73b2eec99f8bd149e75867db8b5) If you want the Agent service to be configured and started automatically at the end of the unattended installation, you will need to store the service credentials in the Response File. Credential information is not encrypted in PMC v4.0 and older. Therefore, for security reasons, make sure you delete the Response File after the installation successfully completed. ## Step-by-step guide To configure the Agent installer to run unattended and silently: 1. Using a text editor, create a new text document called **ResponseFile.varfile** . You may also download it from here: [ResponseFile.varfile](https://kb.peersoftware.com/__attachments/a_86a179a3468e98d7b9d801d6191df93128c0b0bbac5bbee622b51ccf3d8e5270/ResponseFile.varfile.md?cb=352de73b2eec99f8bd149e75867db8b5) 2. Add the following lines to the Response File: sys.programGroupAllUsers$Boolean=true sys.programGroupName=Peer Software\\Peer Agent sys.adminRights$Boolean=true sys.installationDir=C\:\\Program Files (x86)\\Peer Software\\Peer Agent providerHostname=Hub_Server brokerPort$Integer=0 providerPort=61617 myServiceAccount=domain\\user_account ServicePassword1=password ServicePassword2=password 3. Customize the fields as necessary: | Variable | Description | |-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| | sys.programGroupAllUsers$Boolean= | Specify whether or not you want the Agent to be installed for all Users. Specify **true** or **false**. | | sys.programGroupName= | Enter the Program Group in which the application will be installed. Be sure to use double backslashes. For example: **Peer Software\\\\Peer Agent** | | sys.adminRights$Boolean= | Specify whether or not the installation will require admin rights. Specify **true** or **false**. | | sys.installationDir= | Specify the installation directory. Be sure to use double backslashes. For example: **C\\:\\\\Program Files (x86)\\\\Peer Software\\\\Peer Agent** | | providerHostname= | Enter the name of the server where PeerGFS is running. | | brokerPort$Integer= | Specify the TCP protocol that the Agent will be using: **0** = SSL **1** = TCP | | providerPort= | Identify the port number the Agent will be using to communicate with the PeerGFS. | | myServiceAccount= | Provide the service account information for the Agent service using the following format: *domain\\\\user_name* | | ServicePassword1= | Enter the password for Agent service account. This will be stored in plain text format. | | ServicePassword2= | Re-enter the password for the Agent service account. This will be stored in plain text format. | * Use double backslashes wherever backslashes are needed as outlined in the examples. * If theservice credentials are not provided, the Agent service will not start at the end of the installation. 4. You can place the Agent installation file and the Response File in a central location accessible by all the systems where the Agent will be installed. This will cause the installation to take place over the network and may be slow. Alternatively, you can distribute the Agent installation file to all systems where the Agent will be installed while keeping the Response File in a central location for security reasons. 5. Run the following at the command prompt or via a script on each of the systems where the Agent will be installed (make sure you run the script or command line as an administrator): **To run silently without the progress indicator:** Agent_Installer.exe -q -varfile "\\\\Location\\To\\The\\ResponseFile.varfile" **To run unattended with the progress indicator:** Agent_Installer.exe -q -splash "Agent Installation" -varfile "\\\\Location\\To\\The\\ResponseFile.varfile" ![Agent Installation.png](https://kb.peersoftware.com/__attachments/a_f485003aca2756d490678485ba57da07f136ea1d0101983a5ff5b9f325571e90/Agent%20Installation.png?cb=ee1fe817b1f73b932086cabfbe8d7e92) ## Related articles * [Back up your PeerGFS configuration manually](https://kb.peersoftware.com/kb/back-up-your-peergfs-configuration-manually.md) * [Cannot upgrade PeerIQ virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-peeriq-virtual-appliance.md) * [Cannot upgrade PMC virtual appliance via the console menu](https://kb.peersoftware.com/kb/cannot-upgrade-pmc-virtual-appliance.md) * [Check for a new version of PeerGFS](https://kb.peersoftware.com/kb/check-for-a-new-version-of-peergfs.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Connectivity issue during Agent update](https://kb.peersoftware.com/kb/connectivity-issue-during-agent-update.md) * [How do I install Health Checker on a remote server?](https://kb.peersoftware.com/kb/installing-health-checker-on-a-remote-server.md) * [Install a new PeerGFS license](https://kb.peersoftware.com/kb/install-a-new-peergfs-license.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) * [Peer Software Lifecycle Policy](https://kb.peersoftware.com/kb/peer-software-lifecycle-policy.md) * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Update PeerIQ](https://kb.peersoftware.com/kb/update-peeriq.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) --- language: "en" --- # Configure the PeerSync Listener installer to run unattended ## Overview This article applies to PeerSync Listener v9.4.1 and older. You can configure the PeerSync Listener installer to run unattended and silently. This process relies on the PeerSync Listener installer using a **Response File**, which stores the necessary information that is typically customized during a standard installation process. Example of a Response File: ![ResponseFile.png](https://kb.peersoftware.com/__attachments/a_9ef0bf246ded6247deca4ec02be25351042df14b48e661e39dcbcfa2e5e1f7da/ResponseFile.png?cb=c1db6f444dcc316728f5403c303c1f3d) If you want the PeerSync Listener service to be configured and started automatically at the end of the unattended installation, you will need to store the service credentials in the Response File. Credential information is not encrypted. Therefore, for security reasons make sure you delete the Response File after the installation has successfully completed. ## Step-by-step guide 1. Using a text editor, create a text document called **ResponseFile.varfile** . You may also download it from here: [ResponseFile.varfile](https://kb.peersoftware.com/__attachments/a_f36a5c12878aac07e36cc47a700c6dc2b50c345abcc89ac8661200cbdfd0620a/ResponseFile.varfile.md?cb=6e2b301f8b4e3341487ae13edec97c29). 2. Add the following lines to the Response File: InstallationFolder=D\:\\PeerSync Listener myServiceAccount=domain\\administrator ServicePassword1=NotEncryptedPassword ServicePassword2=NotEncryptedPassword ServiceOption1=Button1 startPSListenerServiceAction=true 3. Customize the field values as necessary: | Variable | Description | |-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | InstallationFolder= | Specify the installation directory. Be sure to use double backslashes. For example: C\\:\\\\Program Files\\\\Peer Software\\\\PeerSync Listener | | myServiceAccount= | Provide the service account information for the PeerSync Listener service using the following format: *domain\\\\user* *_* *name* | | ServicePassword1= | Enter the password for the PeerSync Listener service account. The password will be stored in plain text. | | ServicePassword2= | Re-enter the password for the PeerSync Listener service account. The password will be stored in plain text. | | ServiceOption1= | Specify what actions you want the installer to perform with the PeerSync Listener service: Button1 = Install and configure the PeerSync Listener service using the credentials provided. Button2 = Install and configure the PeerSync Listener service using the Local System account. Button3 = Do not install the PeerSync Listener service. | | startPSListenerServiceAction= | Specify whether the PeerSync Listener service will be started: true = Start the PeerSync Listener service false = Do not start the PeerSync Listener service | * Use double backslashes wherever backslashes are needed as outlined in the examples. * If the service credentials are not provided, the PeerSync Listener service will not start at the end of the installation. 4. You can place the PeerSync Listener installation file and the Response File in a central location accessible by all the systems where the PeerSync Listener will be installed. This will cause the installation to take place over the network and may be slow. Alternatively, you can distribute the PeerSync Listener installation file to all the systems where the PeerSync Listener will be installed while keeping the Response File in a central location for security reasons. 5. Run one of the following at the command prompt or via a script on each of the systems where the PeerSync Listener will be installed (make sure you run the script or command line as an administrator): **To run silently without the progress indicator:** pslistener_x64_9_4_1_1002.exe -q -varfile "\\\\Location\\To\\The\\ResponseFile.varfile" **To run unattended with the progress indicator:** pslistener_x64_9_4_1_1002.exe -q -splash "PeerSync Listener Installation Progress" -varfile "\\\\Location\\To\\The\\ResponseFile.varfile" ![PSLProgress.png](https://kb.peersoftware.com/__attachments/a_dfecacab2aa0a547ce14644063423e7150a0e3afb4c0900cec3646f57bd23bec/PSLProgress.png?cb=272fc5007814eeed875564c67c56671f) ## Related articles * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Does PeerSync Listener have to be installed on both servers when using the ByteReplicator?](https://kb.peersoftware.com/kb/does-peersync-listener-have-to-be-installed-on-bot.md) * [How do I install Health Checker on a remote server?](https://kb.peersoftware.com/kb/installing-health-checker-on-a-remote-server.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) * [Set up synchronization/replication over TCP](https://kb.peersoftware.com/kb/set-up-synchronization-replication-over-tcp.md) * [Upgrade PeerSync and PeerSync Listener](https://kb.peersoftware.com/kb/upgrade-peersync-and-peersync-listener.md) * [Where can I find the installers for PeerGFS components?](https://kb.peersoftware.com/kb/where-can-i-find-the-installers-for-peergfs-compon.md) --- language: "en" --- # Conflict Log Details Excel Header File [fc_conflict_headers.xlsx](https://kb.peersoftware.com/__attachments/a_6d368162d3ec1112fac07c3c087fd7c537bcfa22aed2392268b3bb2cffa34eed/fc_conflict_headers.xlsx.md?cb=80c8d0267982b5846943024dcc10cec0) Conflict Log Record Format | **Column** | **Description** | |------------|-----------------------------------------------------------------------------------------------------------------------------------------------| | 1 | Log Entry Create Date (including milliseconds in the form of '.###) | | 2 | Job ID (job-specific internal ID; aka appId) | | 3 | Job Session Id (a unique identifier for a particular running session - a new sessionId is created whenever you start a job; aka appSessionId) | | 4 | Event Date | | 5 | Action (added, removed, etc.) | | 6 | Relative Path (below the watch set) | | 7 | Status of Conflict/Quarantine | | 8 | Message | | 9 | Event Type | | 10 | Collaboration ID | | 11 | Event ID | ## Related articles * [Conflict Log Details](https://kb.peersoftware.com/kb/conflict-log-details.md) * [Event Log Details](https://kb.peersoftware.com/kb/event-log-details.md) * [Schedule upload of PMC and Agent logs to Peer Software Support](https://kb.peersoftware.com/kb/peergfs-schedule-upload-of-logs-to-support.md) * [Upload PMC and Agent logs to Peer Software Support](https://kb.peersoftware.com/kb/upload-pmc-and-agent-logs-to-peer-software-support.md) * [Using PeerGFS logs to troubleshoot](https://kb.peersoftware.com/kb/using-peergfs-logs-to-troubleshoot.md) * [What firewall settings are needed to enable PeerGFS uploads and download software updates?](https://kb.peersoftware.com/kb/peergfs-firewall-settings-for-uploads-and-updates.md) --- language: "en" --- # Connectivity issue during Agent update ## Problem During the Agent update process, an Agent may appear to be disconnected for a few minutes. This is normal since associated Windows services need to be stopped, the update must be performed, and Windows services need to be restarted. However, if the disconnection lasts for longer than a few minutes, the Agent may actually be disconnected. ## Solution If after five minutes, the Agent still hasn't reconnected, right-click the Agent in the Peer Management Center and select the **Restart Agent Service** option. This will attempt to restart the service using a Windows service control (SC) command. However, this will only have an impact if the Windows server where the Peer Management Center is installed can directly access the Windows server running the Agent. If the Agent still fails to reconnect, a remote desktop connection to the Agent's server will be necessary to attempt to restart the Agent service, and if necessary, to reinstall the Agent manually. Related articles * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Connectivity issue during Agent update](https://kb.peersoftware.com/kb/connectivity-issue-during-agent-update.md) * [Update Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/update-peer-global-file-service.md) * [Upgrade Peer Global File Service (PeerGFS)](https://kb.peersoftware.com/kb/upgrade-peer-global-file-service.md) * [Using the PortCheck utility to troubleshoot connectivity issues](https://kb.peersoftware.com/kb/using-portcheck-utility-for-connectivity-issues.md) * [What causes an Agent to disconnect?](https://kb.peersoftware.com/kb/what-causes-an-agent-to-disconnect.md) * [What do the Agent connection statuses mean?](https://kb.peersoftware.com/kb/what-do-the-agent-connection-statuses-mean.md) --- language: "en" --- # Create a Profile ## Goal Create a Profile when running PeerSync for the first time. ## Step-by-step guide To create a PeerSync Profile: 1. Open the **PeerSync Profiler** (PSProfiler.exe). 2. Select **Add New Job** . ![image2020-10-9_16-30-9.png](https://kb.peersoftware.com/__attachments/a_0f88349688fef2c98b23ef555de11f420985f2d3e0b1a2861875ff33ae71ea50/image2020-10-9_16-30-9.png?cb=49e481703ea31f2e00a77d8458b2f9f0) 3. Click and edit the Source Folder and Target Folder paths. ![image2020-10-9_16-33-30.png](https://kb.peersoftware.com/__attachments/a_4f9f647be14c0286b78a35b13ed240f8a714c077a1762b503f7e9d76f06ecd6b/image2020-10-9_16-33-30.png?cb=2b5ea0a29d36b386e4d2c65346186133) 4. To add another job, select **Job** from the menu, hover over **Add** , select**Job with Defaults** or **Job with Wizard** : • **Job with Wizard:** Walk through the new job wizard while creating a new job. • **Job with Defaults:** A new job is created with default settings. ![image2020-10-12_12-49-9.png](https://kb.peersoftware.com/__attachments/a_9efe751e8d12cf6f72b17a8fdd9ea42a3ef26704ea5c54b17a768c73a521bacd/image2020-10-12_12-49-9.png?cb=99976d81c66249f2d7301fed0b0d5440) 5. You can adjust existing job settings using **PeerSync Job Settings** tree on the left-hand side of the Profiler window. Settings include folder selection, automation, file options, exceptions, reporting, compression, pre-post processes, and global settings. 6. Save the profile once you are done configuring it. The recommended place to save your profile is in the Profiles folder, down the install directory of PeerSync. If logs were ever needed to be gathered, the profiles folder will be gathered together along with the logs. ## Related articles * [Cannot see the PeerSync Profiler Display](https://kb.peersoftware.com/kb/cannot-see-the-peersync-profiler-display.md) * [Create a Profile](https://kb.peersoftware.com/kb/create-a-profile.md) * [Find all the configuration options of the PeerSync software](https://kb.peersoftware.com/kb/find-all-the-configuration-options-of-the-peersync.md) * [PeerSync fails to run as a service](https://kb.peersoftware.com/kb/peersync-fails-to-run-as-a-service.md) * [When do files get deleted during a bi-directional scan?](https://kb.peersoftware.com/kb/when-do-files-get-deleted-during-a-bi-directional-.md) --- language: "en" --- # Create dynamic jobs via job data import PeerSync contains tools for importing data from files to dynamically create jobs. One generic job can be created within a Profile to contain specific information. This job would utilize text files with the desired folder paths to be monitored and synchronized. This would be a useful feature if you need to synchronize data to multiple machines from one source to multiple destinations or multiple sources to multiple destinations **Lists can be used in Source and Target path names as such:** Source: \<\<$FileNameSources.txt$\>\> Target: \<\<$FileNameTargets.txt$\>\> **Example Source File "FileNameSources.txt"** C:\\Source1 C:\\Source2 **Example Target File "FileNameTargets.txt"** C:\\Target1 C:\\Target2 ## Related articles * [Create dynamic jobs via job data import](https://kb.peersoftware.com/kb/create-dynamic-jobs-via-job-data-import.md) --- language: "en" --- # Creating a Job Using Bash Scripting Applies to PeerGFS v6.1.0 and later ## Overview This article expands on the workflow and high-level tasks described in [Creating a Job Using Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-scripting.md). It provides a detailed example of how to create a job using Bash and a job template. This example demonstrates how to use a job template to pass user options on to the newly created job. ## Task 1: Configure NAS devices (if applicable) Any NAS devices used for jobs need to be preconfigured in the Peer Management Center (PMC) user interface. Step 1. Open the PMC, select **Tools** , and then select **Open Preferences** from the main menu. ![1-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_f12c330ec36b6b62fd04b6354e818a588e9ccf9c246479b0afc724874fafb849/1-Create%20job-PowerShell.png?cb=9725f1ef04898167423eb24a8ed12c47) Step 2. In the **NAS Configuration** section, select a platform and configure the NAS devices. ![2-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_6f605d60cb2fc7df4d7b8b29df83b06576c14fd43dfb71cf85cc3f682ea09544/2-Create%20job-PowerShell.png?cb=d91320495f68bbfa9b9f0a6bb242ed87) For more detailed guidance on setting up NAS devices, see the *PeerGFS User Guide*.. ## Task 2: Create a template job Creating a template job is useful when using the API to create jobs regularly. The template allows you to set parameters that are not default or available through the API. To create the template job, run the following API command in a Bash terminal: ./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" createJob jobName="TemplateJob" jobType=FILE_REPLICATION The `JobType` parameter can be set to `FILE_COLLABORATION`, `SYNCHRONIZATION_ONLY`, or `FILE_REPLICATION`. ![image-20250519-104011.png](https://kb.peersoftware.com/__attachments/a_52aa24df141ea33e626e1926dab0cb693c1a915ffca69965fc015ef20cae638b/image-20250519-104011.png?cb=ab09cae8d9afc46e82541ceddf6117e2) Once created, the job will appear in the user interface with a unique icon, indicating that it has no participants. ![3-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_b6fc6a5152c24b45b7635c734b8b45d6c8a65a502499d9398da72fcb8e8d349b/3-Create%20job-PowerShell.png?cb=053f4fc93bffd2c16123c9f37e6eca3f) ## Task 3: Edit options to be passed on to new jobs Step 1. Right-click the job and select **Edit Job**. ![4-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_e4b0e198d55d37b29ccbf63f3e723dd6c87dd72c3bc6d8d662beaa830420c955/4-Create%20job-PowerShell.png?cb=a6a9c78179cd853af613147cd1fb1766) Step 2. Make the necessary changes to the job. In this example, we are adjusting the transfer size. ![Edit General.png](https://kb.peersoftware.com/__attachments/a_2b3d7fbdfa44d41516e7c81b7b1cb6f89198158d359e56a09b3138acdf5dd91b/Edit%20General.png?cb=073ceba354be8a81d7c1d21dde324720) Step 3. Click **OK** to save the changes. ## Task 4: Create the job Once the previous tasks are complete, production jobs can be created via the API without further UI interaction. To create the production job, run the following command using PowerShell: PowerShell ./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" createJob jobName=LinuxJob jobType=FILE_REPLICATION refJobId=106 Where `RefJobId` is the job ID of the template job. ![image-20250519-135417.png](https://kb.peersoftware.com/__attachments/a_0a701eb325098f7379ddbdb363fadda1b19ef3a88ca99db71656b7c0e5755586/image-20250519-135417.png?cb=8662bd7dcf93b4bd8c52887308855ef8) If the returned job ID was not recorded, it can be retrieved by listing all jobs: PowerShell jobs=`./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" getJobs` echo $jobs | python -m json.tool ![image-20250519-135902.png](https://kb.peersoftware.com/__attachments/a_894e4ffc27449026c7ac8d1de9c3570082e125ef18ac3362f1f01b1a1e3b8b04/image-20250519-135902.png?cb=fb44462aae6c9759331a515fd06a76cf) For scripting purposes, the job ID returned in the JSON-formatted response can be stored in a variable. For example: PowerShell export jobID=107 ## Task 5: Add participants to the job Now that the job is created, participants need to be added. Participants are paths within storage volumes (either NAS or local to Agents) for data movement to occur. Step 1. List available storage devices Run the following command to list available storage devices: PowerShell storage=`./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" getStorage` echo $storage | python -m json.tool ![image-20250519-144936.png](https://kb.peersoftware.com/__attachments/a_a3868605a4c6148a09cf264351d479d84c097549d5a3af96404a7af0c322ba18/image-20250519-144936.png?cb=2f2055e0c12da05a1c0b532d69ab68c3) Storage volumes are returned as a JSON list, which can be processed logically or manually inspected. If volumes of a specific type are needed, the `StorageDeviceType` option can be used: PowerShell storage=`./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" getStorage storageDeviceType=DELL_POWERSCALE` echo $storage | python -m json.tool Example output (filtered for DELL_POWERSCALE): ![image-20250519-145201.png](https://kb.peersoftware.com/__attachments/a_3693ff17f688f3718589fde6c3e5ec9d6e22012854cfc5472002d3cedcdce57d/image-20250519-145201.png?cb=eaa65f7b6e585b8db284e4d585edfb6d) Step 2. Add Participants Each participant must be added in turn. For replication jobs, there will only be one source participant. The following command adds the source participant: PowerShell ./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" addParticipant jobId=$jobID storageDeviceId=LinuxAgent1:CLUSTER1 path=CLUSTER1:/ifs/workspace ![image-20250519-145409.png](https://kb.peersoftware.com/__attachments/a_b3d8904397168c9981c1da0274a3d3ec97be4191eee23505410ecf7ff8b4de82/image-20250519-145409.png?cb=21d7b5f6145fecf8c7f639d24e9186a7) For all other participants, the `-SeedingTarget $true` option must be added: ./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" addParticipant jobId=$jobID storageDeviceId=LinuxAgent2:CLUSTER2 path=CLUSTER2:/ifs/workspace seedingTarget=true Once all participants have been added, you can retrieve and view the job details: PowerShell ./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" getJobs jobIds=$jobID | python -m json.tool ![image-20250519-145655.png](https://kb.peersoftware.com/__attachments/a_82841fb75a02857746df7b5cb8773ef6216d987e17bf3c6bd0b64cf267b2f96c/image-20250519-145655.png?cb=a1a5a09ec3d7e2f058888727afacbe0d) ## Task 6: Start the job Once the job has been fully configured, it needs to be started manually. To start the job, run the following command: PowerShell ./PeerGFS-cli.sh --insecure --host "https://$address:$port" -u "$username:$password" startJob jobIds=$jobID ![image-20250519-144106.png](https://kb.peersoftware.com/__attachments/a_4a5d66628cb15fcd219fedbbe654cc92d60280f20ca82dbb0f642812e65e429e/image-20250519-144106.png?cb=a82b6ad8f8b431a1af77bbce4a3c978d) After executing the command, the job will be in a running state. You can confirm this by checking the UI, where the job will now appear as running. ![6-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_ce7a04631eafc0eaa0706acfec12fd932aa5c5bd92b8669a79aa409689bc1e95/6-Create%20job-PowerShell.png?cb=58cba606366dd2136e76541e9b4de0b8) ## Related articles * [Check .pc-trash_bin date stored times for target protection](https://kb.peersoftware.com/kb/check-pc-trash_bin-date-stored-times-for-target-pr.md) * [Creating a Job Using Bash Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-bash-scripting.md) * [Creating a Job Using PowerShell Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-powershell-scripting.md) * [Creating a Job Using Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-scripting.md) * [Does the EOA of NetApp ONTAPI impact PeerGFS?](https://kb.peersoftware.com/kb/does-the-eoa-of-netapp-ontapi-impact-peergfs.md) * [Generating Client Code for PeerGFS API with Swagger.io](https://kb.peersoftware.com/kb/generating-client-code-for-peergfs-api-with-swagge.md) * [Getting Started with the PeerGFS REST API](https://kb.peersoftware.com/kb/getting-started-with-the-peergfs-rest-api.md) * [Performing API Operations Using Bash](https://kb.peersoftware.com/kb/performing-api-operations-using-bash.md) * [Performing API Operations Using cURL](https://kb.peersoftware.com/kb/performing-api-operations-using-curl.md) * [Performing API Operations Using PowerShell](https://kb.peersoftware.com/kb/performing-api-operations-using-powershell.md) * [Scripting Methods for API Operations](https://kb.peersoftware.com/kb/scripting-methods-for-api-operations.md) * [Use PowerShell to connect to the PeerGFS API](https://kb.peersoftware.com/kb/use-powershell-to-connect-to-the-peergfs-api.md) --- language: "en" --- # Creating a Job Using PowerShell Scripting Applies to PeerGFS v6.1.0 and later ## Overview This article expands on the workflow and high-level tasks described in [Creating a Job Using Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-scripting.md). It provides a detailed example of how to create a job using PowerShell and a job template. This example demonstrates how to use a job template to pass user options on to the newly created job. ## Task 1: Configure NAS devices (if applicable) Any NAS devices used for jobs need to be preconfigured in the Peer Management Center (PMC) user interface. Step 1. Open the PMC, select **Tools** , and then select **Open Preferences** from the menu. ![1-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_4307a35c4a19cc899db6b96db2639f8c734daf381300b2e6e8d4aada7f8fae76/1-Create%20job-PowerShell.png?cb=9725f1ef04898167423eb24a8ed12c47) Step 2. In the **NAS Configuration** section, select a platform and configure the NAS devices. ![2-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_52a2515901ff98166aa114441acdc7506c91ec7a760c76bb5befd014e0d6a17d/2-Create%20job-PowerShell.png?cb=d91320495f68bbfa9b9f0a6bb242ed87) For more detailed guidance on setting up NAS devices, see the *PeerGFS User Guide*. ## Task 2: Create a template job Creating a template job is useful when using the API to create jobs regularly. The template allows you to set parameters that are not default or available through the API. To create the template job, run the following API command in a PowerShell terminal: PowerShell .\ConfigurePeerGFSToolkit.ps1 'C:\Users\Administrator\Documents\settings.ini' New-PeerGFSJob -JobName TemplateJob -JobType FILE_REPLICATION The `JobType` parameter can be set to `FILE_COLLABORATION`, `SYNCHRONIZATION_ONLY`, or `FILE_REPLICATION`. ![image-20250518-184506.png](https://kb.peersoftware.com/__attachments/a_52fb69f8eb21b209c5ff20051127ff49972c736479d4284cf8db9c69655eaad1/image-20250518-184506.png?cb=9f791fd27082d63a4cfb850d763e2f7f) Once created, the job will appear in the user interface with a unique icon, indicating that it has no participants. ![3-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_dca85d97d7481548e1cd82067237c0ab30e3f1bdb30d8f00978668a52dafb9a9/3-Create%20job-PowerShell.png?cb=053f4fc93bffd2c16123c9f37e6eca3f) ## Task 3: Edit options to be passed on to new jobs Step 1. Right-click the job and select **Edit Job**. ![4-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_297e947b1026582ed16e972f8ed41594bd039ebe761fe1a035b4aae7e118ed45/4-Create%20job-PowerShell.png?cb=a6a9c78179cd853af613147cd1fb1766) Step 2. Make the necessary changes to the job. In this example, we are adjusting the transfer size. ![Edit General.png](https://kb.peersoftware.com/__attachments/a_94ef8b6070088d869a1327ea1a5069ddab6c7d6dcef546a9235f55da4110cfde/Edit%20General.png?cb=073ceba354be8a81d7c1d21dde324720) Step 3. Click **OK** to save the changes. ## Task 4: Create the job Once the previous tasks are complete, production jobs can be created via the API without further UI interaction. To create the production job, run the following command using PowerShell: PowerShell .\ConfigurePeerGFSToolkit.ps1 'C:\Users\Administrator\Documents\settings.ini' New-PeerGFSJob -JobName WindowsRepla2 -RefJobId 101 -JobType FILE_REPLICATION Where `RefJobId` is the job ID of the template job. ![image-20250518-184434.png](https://kb.peersoftware.com/__attachments/a_af47cb6a03bdca1651866e08602ecaef27ccbdffb04888461951842cb1192929/image-20250518-184434.png?cb=c98f9d30ad202e104751e432f831124d) If the job ID was not recorded, it can be retrieved by listing all jobs: PowerShell $jobs = Get-PeerGFSJobs $jobs.jobs | ft ![image-20250518-184901.png](https://kb.peersoftware.com/__attachments/a_0dd008350d13da94a5cfe0a2a406ba63cfa3af0497a638cf1d17024a306a7ed3/image-20250518-184901.png?cb=dd6fb3038c739600caf5679867894ce1) For scripting purposes, the job ID can be stored in a variable: PowerShell $newJob = New-PeerGFSJob -JobName WindowsRepla2 -RefJobId 101 -JobType FILE_REPLICATION $newJob.id ![image-20250518-185336.png](https://kb.peersoftware.com/__attachments/a_62e4d472ec5cca2f1094cc6b41a37b53bc99fe44b3f4ebc05c80de5ba88bed6c/image-20250518-185336.png?cb=a0c314c6ecc3c57d36cbc71e92e43bc2) ## Task 5: Add participants to the job Now that the job is created, participants need to be added. A participant consists of an **Agent** and the **volume, share, export, or folder** to be replicated. Step 1. List available storage devices Run the following command to list available storage devices: PowerShell $storage = Get-PeerGFSStorage $storage.storages | ft ![image-20250519-085845.png](https://kb.peersoftware.com/__attachments/a_330a01cb60dcf08467735706828d66b42b3ff276ac616a5d1fdaec94c9967238/image-20250519-085845.png?cb=ec48776979f3a64c8d3febefcadc95ca) Storage volumes are returned as a JSON list, which can be processed logically or manually inspected. If volumes of a specific type are needed, the `StorageDeviceType` option can be used: PowerShell $storage = Get-PeerGFSStorage -StorageDeviceType DELL_POWERSCALE $storage.storages | ft Example output (filtered for DELL_POWERSCALE): ![image-20250519-090041.png](https://kb.peersoftware.com/__attachments/a_5fbec3d0efdd58811e51b4fa3be8b4ea2ef131e11a921c3878dc6b5a129bd5bd/image-20250519-090041.png?cb=4983e3c0d21bd854368a16352ab75509) Step 2. Add participants Each participant must be added in turn. For replication jobs, there will only be one source participant. The following command adds the source participant: PowerShell Add-PeerGFSParticipant -JobId $newJob.id -StorageDeviceId WindowsAgent1:CLUSTER1 -Path \\CLUSTER1\Data ![image-20250519-090249.png](https://kb.peersoftware.com/__attachments/a_b93ceae4429b611162f5ba0c52a280ccd6f0ca6c13786ba0e0cfbaf5f3e5de0a/image-20250519-090249.png?cb=13aac4978cd9c0cc04a01c09aec5e61a) For all other participants, the `-SeedingTarget $true` option must be added: Add-PeerGFSParticipant -JobId $newJob.id -StorageDeviceId WindowsAgent2 -Path E:\Data -SeedingTarget $true Once all participants have been successfully added to the job, you can check the job status by running the following command: PowerShell $job = Get-PeerGFSJobs -JobIds $newJob.id $job.jobs ![image-20250519-090600.png](https://kb.peersoftware.com/__attachments/a_d67c2f3f61de4bc65bb329869a9955d0490d2e54321b138d3d4fd5b3280c1484/image-20250519-090600.png?cb=3653ea82d917ab8ea43eac3ab07a8819) ## Task 6: Start the job Once the job has been fully configured, it needs to be started manually. To start the job, run the following command: PowerShell Start-PeerGFSJob -JobID $newJob.id After executing the command, the job will be in a running state. You can confirm this by checking the UI, where the job will now appear as running. ![image-20250519-083612.png](https://kb.peersoftware.com/__attachments/a_bcb50d604bf5beecedec363ecc09d6880c2f8c0622a5224587a9ddb5677e74e0/image-20250519-083612.png?cb=a025cd14e104053b2f2fc3e43e7c979d) ![6-Create job-PowerShell.png](https://kb.peersoftware.com/__attachments/a_37109917ee7299cda005ea4c59fb72d1e21b7fb37e544165a3aee9d308ca9a82/6-Create%20job-PowerShell.png?cb=58cba606366dd2136e76541e9b4de0b8) ## Related articles * [Check .pc-trash_bin date stored times for target protection](https://kb.peersoftware.com/kb/check-pc-trash_bin-date-stored-times-for-target-pr.md) * [Creating a Job Using Bash Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-bash-scripting.md) * [Creating a Job Using PowerShell Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-powershell-scripting.md) * [Creating a Job Using Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-scripting.md) * [Does the EOA of NetApp ONTAPI impact PeerGFS?](https://kb.peersoftware.com/kb/does-the-eoa-of-netapp-ontapi-impact-peergfs.md) * [Generating Client Code for PeerGFS API with Swagger.io](https://kb.peersoftware.com/kb/generating-client-code-for-peergfs-api-with-swagge.md) * [Getting Started with the PeerGFS REST API](https://kb.peersoftware.com/kb/getting-started-with-the-peergfs-rest-api.md) * [Performing API Operations Using Bash](https://kb.peersoftware.com/kb/performing-api-operations-using-bash.md) * [Performing API Operations Using cURL](https://kb.peersoftware.com/kb/performing-api-operations-using-curl.md) * [Performing API Operations Using PowerShell](https://kb.peersoftware.com/kb/performing-api-operations-using-powershell.md) * [Scripting Methods for API Operations](https://kb.peersoftware.com/kb/scripting-methods-for-api-operations.md) * [Use PowerShell to connect to the PeerGFS API](https://kb.peersoftware.com/kb/use-powershell-to-connect-to-the-peergfs-api.md) --- language: "en" --- # Creating a Job Using Scripting This article provides an overview of the process for creating a job using the API and scripting. For detailed instructions, see: * [Creating a Job Using PowerShell Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-powershell-scripting.md) * [Creating a Job Using Bash Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-bash-scripting.md) ## Overview: Job Creation Process Most actions performed using the PeerGFS API are one-shot processes, requiring only a single call to execute. However, creating a new job may required additional steps, such as configuring a NAS storage device or creating a job template. If an existing job is used as a template, creating a new job template is unnecessary. The job creation process is as follows: * **Task 1:** Configure storage settings. * **Task 2:** Create a template job (if needed). * **Task 3:** Create a new job via the API. ## Task 1: Configure storage settings If the new job requires a NAS storage device, configure its settings in Peer Management Center. This step establishes the connection details and parameters for the NAS device. Once configured, you don't need to repeat this step for the same device when creating additional jobs. For more detailed guidance on setting up NAS devices, see the *PeerGFS User Guide*. **Note:**Skip this task if the new job does not include a NAS storage device. ## Task 2: Create a template job A **template job** acts as a reusable blueprint, simplifying the configuration of similar jobs by duplicating and modifying the template. When creating a template job, you can import configuration settings from an existing job by providing its job ID. This is particularly useful for settings that cannot be configured through the API. Once created, a template job enables efficient job creation and management. **Steps to create a template job**: 1. **Create the job** : Use either the Peer Management Center (PMC) user interface or the API to create a template job. A template job can be created without assigning participants initially. 2. **Modify job settings**: After creating the job, use the PMC user interface to modify any desired settings. This step is required for customizing the template job, as some settings cannot be configured through the API. **Note:**Skip this task if either of the following applies: * You are using an existing job (with participants) as the basis for your new jobs. * You plan to use the default settings for a job. ## Task 3: Create the new job via the API Once the first two tasks are complete (if required), follow the flow diagram below to create the new job. ![image2024-7-25_12-50-47.png](https://kb.peersoftware.com/__attachments/a_4d5ec5f231bef94f37e09e764a0c6fdb8ad326e004aac87c291f2ea3e364901f/image2024-7-25_12-50-47.png?cb=64577415de42bcc3275e29f3be8d59f2) 1. **Create the new job**: Make an API call to create the job and store the returned JobID. You can include the JobID of the template job in the API call to import non-default configuration settings. 2. **Retrieve storage items**: Retrieve the available storage devices and note the storage IDs for the devices you want to use in the new job. The returned array will include both built-in (local) and configured NAS storage devices. 3. **Add participants to the job**: Use the storage devices from Step 2 to add participants to the job. Repeat this step for each storage device you wish to include. 4. **Start the newly created job.** For more detailed instructions, refer to the articles that expand on each of these tasks. ## Related articles * [Check .pc-trash_bin date stored times for target protection](https://kb.peersoftware.com/kb/check-pc-trash_bin-date-stored-times-for-target-pr.md) * [Creating a Job Using Bash Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-bash-scripting.md) * [Creating a Job Using PowerShell Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-powershell-scripting.md) * [Creating a Job Using Scripting](https://kb.peersoftware.com/kb/creating-a-job-using-scripting.md) * [Does the EOA of NetApp ONTAPI impact PeerGFS?](https://kb.peersoftware.com/kb/does-the-eoa-of-netapp-ontapi-impact-peergfs.md) * [Generating Client Code for PeerGFS API with Swagger.io](https://kb.peersoftware.com/kb/generating-client-code-for-peergfs-api-with-swagge.md) * [Getting Started with the PeerGFS REST API](https://kb.peersoftware.com/kb/getting-started-with-the-peergfs-rest-api.md) * [Performing API Operations Using Bash](https://kb.peersoftware.com/kb/performing-api-operations-using-bash.md) * [Performing API Operations Using cURL](https://kb.peersoftware.com/kb/performing-api-operations-using-curl.md) * [Performing API Operations Using PowerShell](https://kb.peersoftware.com/kb/performing-api-operations-using-powershell.md) * [Scripting Methods for API Operations](https://kb.peersoftware.com/kb/scripting-methods-for-api-operations.md) * [Use PowerShell to connect to the PeerGFS API](https://kb.peersoftware.com/kb/use-powershell-to-connect-to-the-peergfs-api.md) --- language: "en" --- # Dell PowerScale | EMC Isilon Configuration Guide |------------------|------------------| | **Last Updated** | 15 February 2024 | ## Overview Starting with PeerGFS v5.2, we have a new connection mechanism for recent OneFS environments based on syslog. If you are running OneFS v9.5 or later and are interested in our syslog-based integration, see [Dell PowerScale Syslog Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-syslog-configuration-guide.md) for more information. If you are interested in using NFS workloads with PeerGFS v6.0 and above, you must use the syslog-based integration. This guide steps you through configuring your environment to work with a Dell EMC storage platform in preparation for installing Peer Software solutions. The last section of this guide provides troubleshooting information. During the configuration process, you will be installing and configuring software on the server that will host Peer Software solutions. This server is hereafter referred to as the **CEE server**. The software you will be installing and configuring includes: * CEE (Common Event Enabler) framework -- Required to receive real-time notifications from Dell EMC storage platforms. * .NET Framework -- Core Windows software needed to run the CEE framework. * RabbitMQ Server -- Message broker required by Peer Software solutions to receive real-time notifications from CEE. * Erlang -- Required by Rabbit MQ Server. ## Requirements * Your Dell PowerScale or EMC Isilon storage device must be running OneFS v8.1.0 or later. * Local administrator rights are required for most of the installation and configuration tasks. * See [Dell PowerScale Prerequisites](https://kb.peersoftware.com/kb/dell-powerscale-prerequisites.md) for other requirements. * You are only interested in SMB workload support. * If you are running OneFS v9.5 or later and are interested in our syslog-based integration, see [Dell PowerScale Syslog Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-syslog-configuration-guide.md) for more information. ## Terminology * **Common Event Enabler** **(CEE)** **framework** -- A Dell EMC software product required to obtain real-time event notifications from PowerScale and Isilon storage platforms. Used to be called Celerra Event Enabler. * **CEE server** -- A Windows server hosting CEE framework and your Peer Software solutions. * **Isilon** -- Legacy name of the scale-out EMC clustered storage platform. * **isi** -- The PowerScale and Isilon command line interface. * **OneFS** -- The operating system of both PowerScale and Isilon storage clusters. * **PowerScale** - The current name of the scale-out Dell clustered storage platform. * **SMB/CIFS** -- The Server Message Block (SMB) Protocol is a network file-sharing protocol; it supersedes Common Internet File System (CIFS), an earlier protocol. SMB is used in this document to refer to both protocols. * **URI (Uniform Resource Identifier)** -- An URI is a sequence of characters that unambiguously identifies a logical (e.g., web page address) or physical resource (e.g., server location). ## Configuration Tasks ### Task 1. Confirming Configuration Readiness 1. Ensure that the Dell PowerScale \| EMC Isilon prerequisites are met for the Peer Software solution you will be using. 2. If your storage platform (e.g., Unity and VNX) requires licensing for the Common Event Enabler (CEE) framework, ensure that CEE is licensed. 3. Ensure that the PowerScale or Isilon storage device is already configured to serve data via SMB. You should be able to access an SMB share from a Windows client BEFORE attempting to continue. 4. Ensure that the date and time on the PowerScale or Isilon storage device are synchronized with any associated domains and the CEE server. ### Task 2. Installing the .NET Framework on the CEE Server 1. Run Windows PowerShell as an administrator. 2. Enter the following command to install .NET Framework v3.5: `Install-WindowsFeature Net-Framework-Core` After the installation is complete, the results are displayed in the PowerShell window. ![Task 2 - PowerShell window.png](https://kb.peersoftware.com/__attachments/a_b553bb6aa9d1220339dbf0d1834aa71d715ccdf48731231920782c0e39ac84fc/Task%202%20-%20PowerShell%20window.png?cb=90c616f575f6f9ca2e5de97c5c9ae829) 3. Close the PowerShell window. ### Task 3. Installing CEE Framework on the CEE Server 1. If any versions of CEE framework software earlier than v8.6 (including stand-alone CAVA or CEPA) are already installed on the CEE server, uninstall them before continuing. 2. Download and stage the 64-bit CEE framework installer on the CEE server. 1. If deploying for use with Isilon, we require **v8.7.0** of the CEE framework. To obtain one of these versions, please contact Dell EMC technical support or your Peer Software technical contact. 2. If deploying for use with Unity or VNX, we support **v8.9.1** of the CEE framework. CEE v8.9.1 can be found here: . Note that this download requires a Dell EMC support login. 3. Install the CEE framework software: 1. Run the CEE framework installer as an administrator. The **Welcome** page of the CEE Install wizard appears. 2. Click **Next** . The **License Agreement** page appears. 3. Accept the terms of the license agreement, and then click **Next** . The **Customer Information** page appears. 4. Enter your user name and organization, select **Anyone who uses this computer (all users)** , and then click **Next** . The **Setup Type** page appears. 5. Select **Complete** , and then click **Next** . The **Symantec SAV for NAS** page appears. ![Task 3 - Symantec SAV for NAS.png](/__attachments/a_d2e01297816be274a0192760161d0a04edc640577e170e9ed5c0544ca6357d75/Task%203%20-%20Symantec%20SAV%20for%20NAS.png?cb=2133368898e02cc41d264aaa21ad6e32) 6. Ensure that the **Work with Symantec SAV for NAS/Protection Engine** checkbox is not selected, and then click **Next** . The **Ready to Install the Program** page appears. 7. Click **Install** . When the installation is complete, the **InstallShield Wizard Completed** page appears. 8. Click **Finish** . A dialog prompting you to restart the system appears. ![Task 3 - Restart System dialog.png](/__attachments/a_8d8265915400eb42583522686e535d2b13ba02bd466e6ede235942c8b7cf7f30/Task%203%20-%20Restart%20System%20dialog.png?cb=9d98770309cb67467d61385175e08a07) 9. Click **No**. You will restart the system later. ### Task 4. Configuring CEE on the CEE Server 1. Modify the registry value to instruct CEE framework to send events to RabbitMQ: 1. Open the Registry Editor as an administrator. 2. Navigate to the following location: **HKEY_LOCAL_MACHINE \> Software \> EMC \> CEE \> CEPP \> CQM \> Configuration** . ![Task 4 - Registry Editor.png](/__attachments/a_880e84e83f4a17e36287f1563651694871e22e06da228bc757ce7bdeaa9e3d39/Task%204%20-%20Registry%20Editor.png?cb=706373616af3416aed457fd7c1150c51) 3. Double-click the **Enabled** registry key. The **Edit DWORD (32-bit) Value** dialog appears. 4. Change the number in **Value data** to **0** , and then click **OK** . ![Task 4 - Edit DWORD Value dialog.png](/__attachments/a_54c1972c2e1d655cc56bfa2ad97026853ab4d6fc6890fb7c162b52bc444466b6/Task%204%20-%20Edit%20DWORD%20Value%20dialog.png?cb=c93ef6e8431dabe81c222fa33cf28d5f) 5. Close the Registry Editor. 2. Set the login credentials for the **EMC CAVA** service. The credentials should be the same as the ones you will use for the Peer Software service. 1. Open the Windows **Services** manager as an administrator. 2. Find the service named **EMC CAVA** . ![Task 4 - Find EMC CAVA Service.png](/__attachments/a_f2f6f55c4b2f7ad3b198e9928e68d4a4a4e0245a89872b57dc69154f9bc05790/Task%204%20-%20Find%20EMC%20CAVA%20Service.png?cb=2f6c4b78cab8c2559b5e79b59d370c82) 3. Double-click **EMC CAVA** . The **EMC CAVA Properties (Local Computer)** dialog appears. 4. Click the **Log On** tab. ![Task 4 - EMC CAVA Properties dialog.png](/__attachments/a_85faffcd13178c50e94c92ddfda8fb91c4c3a77809d8c3635cf447bbb555af28/Task%204%20-%20EMC%20CAVA%20Properties%20dialog.png?cb=dd9034d8aa537b0cd835bcf8a871b8ab) 5. Enter the account name and password, and then click **OK** . A **Services** dialog appears, confirming that log-on rights have been granted. 6. Click **OK**. 3. Restart the **EMC CAVA** service: 1. Select the **EMC CAVA** service. 2. Click the **Restart** link. (If the service is not already running, click the **Start** link instead.) ![Task 4 - Restart EMC CAVA Service.png](/__attachments/a_ec94a6e2f0ff2903b98e8b09d862f8ad29c4898286e4fdb9b1b1cf6b33032daa/Task%204%20-%20Restart%20EMC%20CAVA%20Service.png?cb=e9cb8575512a94bf6524b754f40ab4ed) 3. Close the **Services** manager window. ### Task 5. Installing Erlang on the CEE Server 1. Download and stage the 64-bit Erlang installer on the CEE server. 1. If deploying for use with Isilon, we require **v20.3** of Erlang. Erlang v20.3 can be found here: . 2. If deploying for use with Unity or VNX, we support **v25.x** versions of Erlang (such as **v25.2** ). Erlang v25.2 can be found here: 2. Install the Erlang software: 1. Run the Erlang installer as an administrator. The **Erlang Setup** wizard appears. The **Choose Components** page is displayed. 2. Do not make any changes to the default selections. ![Task 5 - Choose Components page.png](/__attachments/a_c1e55c78a2bf19c6e0dc89a4feda01c6fb208f045b7d824d516920c90c9064f9/Task%205%20-%20Choose%20Components%20page.png?cb=8d8985bd3726bd3893a6b416b17eae9e) 3. Click **Next** . The **Choose Installation Location** page appears. 4. Accept the default location by clicking **Next** . The **Choose Start Menu Folder** page appears. 5. Do not make any changes to the default location. 6. Click **Install** . If the system does not have the correct C++ runtime installed, the **Microsoft Visual C++ installer** dialog appears. Continue with **Step 2g** if the dialog appears; otherwise, skip to step **2i.** 7. Click the checkbox to agree to the license terms and condition, and then click **Install** . After the Visual C++ installation is completed, the dialog displays a message confirming the success of the installation. 8. Click **Close** to close the confirmation dialog. The **Erlang Setup** wizard displays a status dialog while installing Erlang. 9. Click **Close** when the installation has completed. ### Task 6. Installing and Configuring RabbitMQ Server on the CEE Server 1. Download and stage the 64-bit RabbitMQ Server installer on the CEE server. 1. If deploying for use with Isilon, we require **v3.7.4** of RabbitMQ. RabbitMQ v3.7.4 can be found here: . 2. If deploying for use with Unity or VNX, we support **v3.11.x** versions of RabbitMQ (such as **v3.11.10** ). RabbitMQ v3.11.10 can be found here: . 2. Install the RabbitMQ Server software: 1. Run the RabbitMQ Server installer as an administrator. The **RabbitMQ Server Setup** wizard appears. The **Choose Components** page is displayed. 2. Do not make any changes to the default selections. ![Task 6 - Choose Components page.png](/__attachments/a_17176b316d0c7bd7faafe0f10b111d9f3da9106046bf724e506ba8b36e29bfeb/Task%206%20-%20Choose%20Components%20page.png?cb=4f7d53617528d81cb1698f318f854a81) 3. Click **Next** . The **Choose** **Install Location** page appears. 4. Accept the default location by clicking **Install** . The **Setup** wizard displays a status dialog while installing RabbitMQ Server. 5. Click **Next** when the installation is complete. 6. Click **Finish** to close the setup wizard. 3. Enable the RabbitMQ Server management plugin: 1. Open a command prompt as an administrator. 2. In the command prompt window, change to the directory that the RabbitMQ Server is installed (typically C:\\Program Files\\RabbitMQ Server\\rabbitmq_server-*X.X.X* \\sbin, where *X.X.X* is the version number). 3. Enter the following command in the command prompt window: `rabbitmq-plugins enable rabbitmq_management` The command prompt window displays confirmations that the plug-ins have been configured and enabled. ![Task 6 - Confirm plug-in configured.png](/__attachments/a_55e8411534b53cd40f3979590ec6ac6cdfc1fc4b3d81024cf9d0cef5039e0b72/Task%206%20-%20Confirm%20plug-in%20configured.png?cb=87e28d9c575ea217bf229a9385291ea4) 4. Close the command prompt window. 4. Restart the RabbitMQ service: 1. Reopen the **Services** manager as an administrator. 2. Select the **Rabbit MQ** service. 3. Click the **Restart** link. ![Task 6 - Restart RabbitMQ Service.png](/__attachments/a_44a584f65325df8278ce1b1e1c6b910c42999d8bb165f715785fd27b9a7526e8/Task%206%20-%20Restart%20RabbitMQ%20Service.png?cb=bc6c858808f68b27dfed5aaeed26bd66) 4. Close the **Services** manager. 5. Enable the RabbitMQ Server to receive messages: 1. Open **Notepad** as an administrator. 2. Open the file **MsgSys.xml** in Notepad. This file should be located in the installation directory of CEE framework (for example, C:\\Program Files\\EMC\\CEE). Tip To locate the **MsgSys.xml** file, change the file filter drop-down list from **Text Document** (.txt)\* to **All Files** ; otherwise, only text files will be displayed in the **Open** dialog. ![Task 6 - Locate MsgSys XML file.png](/__attachments/a_cbaf647c4d0fd1340ad318c6f9835e8672119c8c7dea7ce543bd58306d3e1a76/Task%206%20-%20Locate%20MsgSys%20XML%20file.png?cb=6286feb52970f9c090022e2d4fdf212e) The **MsgSys.xml** file is displayed in a Notepad window. ![Task 6 - Display MsgSys XML file.png](/__attachments/a_c76385c30574ee913fc5fdbbd44027ce7f13573174ee6124c72959767eccd579/Task%206%20-%20Display%20MsgSys%20XML%20file.png?cb=ed356c59508b1f38b80623f5f933e375) 3. Make the following changes to the file: 1. Find the following line: \ and set **MsgBus enabled** to **"1"**. 2. Find the following line and set **Host name** to **"localhost"** : \ The file now appears as follows: ![Task 6 - Edit MsgSys XML file.png](/__attachments/a_4bdcdbf135caa52c937b1ef6bfb49b6ce2ec20eff2ae1a0700e371f7d6dc7dfa/Task%206%20-%20Edit%20MsgSys%20XML%20file.png?cb=b52fc6699196782880a925c1dc607dbc) 4. Save your changes to **MsgSys.xml**, and then close the file. 6. Ensure that the RabbitMQ Service is installed and running: 1. Reopen the **Services** manager as an administrator. 2. Find the service named **RabbitMQ**. 3. Confirm that the service is running. ![Task 6 - Confirm RabbitMQ Service running.png](/__attachments/a_3d23e61cc8410813bcc04fde063dab4f68e0d61e3c32109bd49f02dd3ad53021/Task%206%20-%20Confirm%20RabbitMQ%20Service%20running.png?cb=84c2df76d65a577eb728b908d93b9a5d) 4. Close the **Services** manager. ### Task 7. Configuring the Audit Settings and Access Zones on PowerScale and Isilon Storage Clusters The auditing system on both PowerScale and Isilon clusters is responsible for sending event and client activity notifications to the Peer Software solutions. You must be an admin user of the storage cluster to perform the configuration steps. 1. Open an SSH session to your PowerScale or Isilon storage cluster using an administrator account. 2. Enter the following command to enable auditing and specify the access zones: `isi audit setting global modify --protocol-auditing-enabled true --add-audited-zones `**` --cee-server-uris http://`**`:12228/cee --hostname `** where: *\* is the name of the access zone you want to audit. To enable auditing for multiple access zones, separate the zone names with commas. In some multi-access zone environments, you may also need to audit the System access zone in addition to the other zones you are auditing. *\* is the fully qualified domain name of the CEE server. *\* is part of the URI for the CEE server. Do not enter multiple URIs. Using multiple URIs will result in events being sent in a round-robin fashion to configured CEE URIs, and as such, not all events will be received by all CEE servers. **12228** is the default CEE HTTP port. You must choose a port number that is the same as the one configured in the registry on the computer where CEE is installed. *\* is the name of the PowerScale or Isilon storage platform used in the watch set path in PeerGFS or PeerSync. This path is used by our software to read and write data over SMB. Depending on how the cluster is configured, this could be a SmartConnect Zone name or some other DNS name. 3. For each access zone that you are auditing, enter one of the following commands to enable notifications for specific audit events. The appropriate command is based on the version of OneFS that you are running. Audit Settings for OneFS v8.2.x and later isi audit settings modify --zone \ --audit-success close_file_modified,close_file_unmodified,create_directory,create_file,delete_directory,delete_file,open_file_noaccess,open_file_read,open_file_write,rename_directory,rename_file,set_security_directory,set_security_file,write_file isi audit settings modify --zone \ --clear-audit-failure isi audit settings modify --zone \ --clear-syslog-audit-events Audit Settings for OneFS v8.1.x isi audit settings modify --zone \ --audit-success create,delete,rename,set_security,write,close where: *\* is the name of the access zone that you are auditing. In some multi-access zone environments, you may also need to enable notifications for the System access zone in addition to the other zones you are auditing. 4. Enter the following commands to confirm that these settings were applied: isi audit settings global view isi audit settings view The SSH window displays confirmations that the settings were applied. The following example is for OneFS versions prior to 8.2. ![worddav2902e6a57908baea925a903c0a5292e0.png](https://kb.peersoftware.com/__attachments/a_897d4415a8c331c2d67fe1b367658bc734446d05ac686f4c764721801d8a7e8c/worddav2902e6a57908baea925a903c0a5292e0.png?cb=2902e6a57908baea925a903c0a5292e0) 5. Restart the CEE server. The setup of your PowerScale or Isilon storage device is now complete. ## Troubleshooting The request failed and the interceptors did not return an alternative response The request failed and the interceptors did not return an alternative response The request failed and the interceptors did not return an alternative response ### CEE Sending Old Events Since CEE support within OneFS is designed for auditing, there are occasions where inbound events from the CEE are old and no longer applicable. If the CEE is sending events that are old and no longer applicable, you can configure the auditing system built into OneFS to send events *starting* from a specific point in time. 1. Open an SSH session on the PowerScale or Isilon storage cluster as an administrator. 2. Enter the following command, replacing the date and time after the @ sign with the current date and time. For example: isi audit settings global modify --cee-log-time "Protocol@2020-07-26 16:25:00" ## Technical Support [Peer Software Service Desk](https://servicedesk.jira.peersoftware.com/) USA +1 703-763-7700 EMEA +49 89 2620763-22 UK/IE +44 20 777 098 22 ## Related Articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Configuration Guides](https://kb.peersoftware.com/kb/configuration-guides.md) * [Configure PeerSync to synchronize in a clustered environment](https://kb.peersoftware.com/kb/configure-peersync-to-synchronize-in-a-clustered-e.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Dell PowerScale Syslog Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-syslog-configuration-guide.md) * [Dell PowerScale \| EMC Isilon Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-emc-isilon-configuration-guide.md) * [Dell PowerStore Configuration Guide](https://kb.peersoftware.com/kb/dell-powerstore-configuration-guide.md) * [Dell Unity Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-configuration-guide.md) * [Dell Unity Legacy Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-legacy-configuration-guide.md) * [How do I install Health Checker on a remote server?](https://kb.peersoftware.com/kb/installing-health-checker-on-a-remote-server.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) --- language: "en" --- # Dell PowerScale Prerequisites |------------------|--------------| | **Last Updated** | 24 June 2026 | 1. **OneFS Version Requirements:** 1. ***For SMB workloads using CEE with RabbitMQ***, the minimum required version of OneFS is **v8.1.0.x**. 2. ***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. 3. ***For NFS and multi-protocol workloads using syslog***, the minimum required version of OneFS is v**9.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. 2. 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. 3. **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. 4. **Server OS Version Requirements:** 1. ***For SMB workloads*** , the minimum version of Windows required for PowerScale support with the Peer Agent or PeerSync is Windows Server 2016. 2. ***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. 5. 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). 6. **Messaging Infrastructure Restrictions:** 1. ***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. 2. ***For environments using syslog***, any other audit vendors utilizing syslog with OneFS must employ TLS for secure communication. 7. **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 8. 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. 9. The PowerScale cluster's Management IP ***must***be within the System access zone. 10. **Privileges and Permissions for SMB Workloads:** 1. 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. 2. Share-level security settings vary depending on the version of PeerGFS being used. 1. For customers running PeerGFS v6.4 and above, a role with **Backup Operator** privileges is required. To create this role and add the Peer Agent service account to the it, run the following console/SSH commands: isi auth roles create --name=PeerAgent --description="Role for Peer Agent Data Access" --zone= isi auth roles modify PeerAgent --add-priv-read=ISI_PRIV_IFS_BACKUP --zone= isi auth roles modify PeerAgent --add-priv-read=ISI_PRIV_IFS_RESTORE --zone= isi auth roles modify PeerAgent --add-user= --zone= The service account for the Peer Agent must also have full access to all shares that it will be monitoring. To add a new account permission with full, non-root access to a share, run the following console/SSH command: isi smb shares permission create --permission full To change an existing account permission on a share to full, non-root access, run the following console/SSH command: isi smb shares permission modify --permission full 2. For customers running PeerSync or versions of PeerGFS prior to v6.4, the service account for Peer Agent or PeerSync ***must*** be granted **root** access to all 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 --run-as-root To change an existing account permission on a share to root access, run the following console/SSH command: isi smb shares permission modify --run-as-root 3. 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=\\ 11. **Privileges and Permissions for NFS Workloads** ***:*** 1. The Peer Agent server IP needs to be granted read/write and root access to the exports that this Agent will be monitoring. 2. NFSv4 ACL support requires: 1. Name Mapping to be enabled. 2. The Peer Agent server to be in the same DNS domain as its associated PowerScale cluster. 12. **Privileges and Permissions for Multi-Protocol Workloads:** 1. When replicating Windows-style or Mixed permissions, share-level security settings vary depending on the version of PeerGFS being used. 1. For customers running PeerGFS v6.4 and above, a role with Backup Operator privileges is required. To create this role and add the domain account used by the Peer Agent's Samba connection to it, run the following console/SSH commands: isi auth roles create --name=PeerAgent --description="Role for Peer Agent Data Access" --zone= isi auth roles modify PeerAgent --add-priv-read=ISI_PRIV_IFS_BACKUP --zone= isi auth roles modify PeerAgent --add-priv-read=ISI_PRIV_IFS_RESTORE --zone= isi auth roles modify PeerAgent --add-user= --zone= The domain account used by the Peer Agent's Samba connection must also have full access to all shares that it will be monitoring. To add a new account permission with full, non-root access to a share, run the following console/SSH command: isi smb shares permission create --permission full To change an existing account permission on a share to full, non-root access, run the following console/SSH command: isi smb shares permission modify --permission full 2. For customers running PeerSync or versions of PeerGFS prior to v6.4, 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 --run-as-root To change an existing account permission on a share to root access, run the following console/SSH command: isi smb shares permission modify --run-as-root 2. 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=\\ 3. The Peer Agent server IP needs to be granted read/write and root access to the exports that this Agent will be monitoring. 4. When replicating Linux-style or Mixed permissions, NFSv4 ACL support requires: 1. Name Mapping to be enabled. 2. The Peer Agent server to be in the same DNS domain as its associated PowerScale cluster. 13. The use of NFS aliases is currently ***not*** supported. 14. **API Account Requirements for PeerSync ONLY:** To connect PeerSync to an access zone other than the default **System** zone, an API user account in OneFS is necessary. 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 --add-user= 15. 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](https://kb.peersoftware.com/kb/firewall-requirements.md) 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](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Amazon FSx for NetApp ONTAP Prerequisites](https://kb.peersoftware.com/kb/amazon-fsx-for-netapp-ontap-prerequisites.md) * [Dell PowerScale Prerequisites](https://kb.peersoftware.com/kb/dell-powerscale-prerequisites.md) * [Dell PowerStore Prerequisites](https://kb.peersoftware.com/kb/dell-powerstore-prerequisites.md) * [Dell Unity Prerequisites](https://kb.peersoftware.com/kb/dell-unity-prerequisites.md) * [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) * [Getting Started with Multi-Protocol for PeerGFS](https://kb.peersoftware.com/kb/getting-started-with-multi-protocol-for-peergfs.md) * [Issues runing PeerSync as a service](https://kb.peersoftware.com/kb/issues-runing-peersync-as-a-service.md) * [NetApp ONTAP Prerequisites](https://kb.peersoftware.com/kb/netapp-ontap-prerequisites.md) * [Nutanix Files Prerequisites](https://kb.peersoftware.com/kb/nutanix-files-prerequisites.md) * [Peer Global File Service - Environmental Requirements](https://kb.peersoftware.com/kb/peergfs-environmental-requirements.md) * [PeerGFS jobs fail to start after initial job due to NetAPP ONTAP v9.15.1 upgrade](https://kb.peersoftware.com/kb/job-start-issues-with-ontap-9.15.1.md) --- language: "en" --- # Dell PowerScale Syslog Configuration Guide |------------------|---------------| | **Last Updated** | 02 April 2024 | ## Overview This syslog-based integration requires a minimum of PeerGFS v5.2 and OneFS v9.5. PeerSync does not yet support this syslog-based integration. If your environment does not meet these requirements, you will need to use the CEE-based integration. See [Dell PowerScale \| EMC Isilon Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-emc-isilon-configuration-guide.md) for more information. This guide steps you through configuring your environment to work with a Dell PowerScale storage platform in preparation for installing Peer Software solutions. Unlike previous integrations with Dell EMC Isilon that leveraged the Common Event Enabler, this guide covers using a new syslog-based connection. This new connection mechanism removes the need to install the Common Event Enabler, RabbitMQ, and supporting libraries, though it does require the use of TLS certificates. ## Requirements * You are using PeerGFS v5.2 or later for SMB workloads or you are using PeerGFS v6.0 or later for NFS workloads. PeerSync is not currently supported. * Your Dell PowerScale storage device must be running OneFS v9.5.0 or later. * Local administrator rights are required for most of the installation and configuration tasks. * See [Dell PowerScale Prerequisites](https://kb.peersoftware.com/kb/dell-powerscale-prerequisites.md) for other requirements. ## Terminology * **isi** -- The PowerScale command line interface. * **OneFS** -- The operating system of PowerScale storage clusters. * **PowerScale** - The current name of the scale-out Dell clustered storage platform. * **SMB/CIFS** -- The Server Message Block (SMB) protocol is a network file-sharing protocol typically used by Windows-based clients. It supersedes Common Internet File System (CIFS), an earlier protocol. SMB is used in this document to refer to both protocols. * **NFS** - The Network File System protocol is a network file-sharing protocol typically used by Linux-based clients. Common versions include v3 and v4. * **syslog** -- A messaging protocol commonly used for logging. With PowerScale, syslog is used to forward audit events to third-party servers. ## Configuration Tasks ### Task 1. Confirming Configuration Readiness 1. Ensure that the [Dell PowerScale Prerequisites](https://kb.peersoftware.com/kb/dell-powerscale-prerequisites.md) are met for the Peer Software solution you will be using. 2. Ensure that the PowerScale storage device is already configured to serve data via SMB or NFS. You should be able to access an SMB share or a NFS export from a client BEFORE attempting to continue. 3. Ensure that the date and time on the PowerScale storage device are synchronized with any associated domains and the server running the Peer Agent. ### Task 2. Setting up TLS Certificates In order to use syslog with OneFS, TLS certificates are required. Three main files are required: * A Certificate Authority (CA) certificate in PEM format. This is used to create server certificates and is uploaded into OneFS's web interface to help validate certificates. * A Certificate Signing Request (CSR) in PEM format. This is used by the CA to create a server certificate and is used as the private key on the Agent server to establish TLS connectivity. * A server certificate generated by the CA using the CSR, also in PEM format. This is also used by the Agent server to establish TLS connectivity. The following steps will walk you through creating a CA, CSR, and server certificate using OpenSSL v1.1.1t. These steps are meant as guidelines and may vary depending on your CA, as well as the version of OpenSSL that you use. They are meant to be run from a workstation or server, NOT from within OneFS. 1. Generate a Certificate Authority using the following command: Bash openssl req -x509 -newkey rsa:4096 -nodes -days 3650 -keyout ca-key.pem -out ca-cert.pem -subj '/C=<2 LETTER COUNTRY CODE>/ST=/L=/O=/OU=/CN=CA/' Modify the **-subj** parameter to include appropriate details about your organization. We suggest including CN=CA at the end of the **-subj** parameter. Expiration length can be set as desired using the **-days** parameter. 2. Create an unencrypted Certificate Signing Request and key for the Peer Agent server using the following command. If you wish to use an encrypted CSR, skip this step and and continue with Step 3. Bash openssl req -new -nodes -out server.csr -newkey rsa:4096 -keyout server-key.pem -subj '/C=<2 LETTER COUNTRY CODE>/ST=/L=/O=/OU=/CN=/' Modify the **-subj** parameter to include appropriate details about your organization but make sure they are not identical to the CA above. We suggest including CN=\ at the end of the **-subj** parameter. 3. **\[OPTIONAL\]** If you wish to encrypt your server key as part of creating the CSR, you first need to generate the key using the following command: openssl genrsa -aes256 -passout pass:"" -out server-key.pem 4096 After creating the key, create the CSR for the Peer Agent server using the following command: Bash openssl req -new -out server.csr -key server-key.pem -subj '/C=<2 LETTER COUNTRY CODE>/ST=/L=/O=/OU=/CN=/' -passin pass:"passphrase" Note: The **-passin** parameter can be omitted. If you leave it off the command line, you will be prompted for it later. 4. With v1.1.1t of OpenSSL, we've noticed that Subject Alterative Name (SAN) information was lost when adding it to the CSR using the **-config** parameter in Step 2. To compensate for this, you can add it to the certificate during signing by adding a new SAN section to the bottom of a ***openssl.cnf*** file. On Linux-based systems, you can make a copy of the cnf file found at ***/etc/ssl/openssl.cnf***to use as a template. Make sure that the IP address of the Peer Agent server is correctly entered into the new \[SAN\] section. Bash [SAN] subjectAltName=IP: 5. Sign the CSR for the Peer Agent server using the following command: Bash openssl x509 -req -in server.csr -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial -out server-cert.pem -days 1095 -extensions SAN -extfile 6. Copy the resulting ***server-cert.pem*** and ***server-key.pem*** files to the Peer Agent server, and then upload the ***ca-cert.pem*** file to the PowerScale web interface. If you created an encrypted CSR and server key, you will also need the passphrase from optional Step 3 above. That information will be requested in PeerGFS when you are setting up a new PowerScale-connected participant. 7. If you are creating certificates for multiple Peer Agent servers, repeat steps 2 through 6. Be sure to keep unique ***server-cert.pem*** , ***server.csr*** , and ***openssl.cnf***files for each Peer Agent. ### Task 3. Uploading the CA to OneFS 1. Copy the CA certificate (***ca-cert.pem*** ) to the cluster. 2. Log in into the OneFS web UI. 3. From the **Access** menu, select **TLS Certificates.** ![image-2023-4-20_14-28-3.png](https://kb.peersoftware.com/__attachments/a_91e1f7a9806c5053b2593cfd116cc271d3f3255795c3f100cf5f97d739c78b99/image-2023-4-20_14-28-3.png?cb=66338d364e87c83b2199da7e9734034e) 4. Using the **Authority** tab, click the **Import authority** button. ![image-2023-4-20_14-28-51.png](https://kb.peersoftware.com/__attachments/a_760dc09f78d2078b2f3132aa56a109f80d447eb3b5fc7a5dc6af407a8c73a6d2/image-2023-4-20_14-28-51.png?cb=835144d969b4c795451e225f93e6a159) 5. Find the certificate on the cluster using the **Browse** button, give it an alias unique to each Peer Agent, then click **Save** . ![image-2023-4-20_14-30-11.png](https://kb.peersoftware.com/__attachments/a_e685bce8ab940e690181c0af103b18afc267804718e3c66bae6382b9113b42c8/image-2023-4-20_14-30-11.png?cb=90359f01e6005e2aa7d6d92d6cffd4cb) ## Troubleshooting ### PowerScale Failing to Connect PowerScale will refuse to connect to the Peer Agent server if SAN information is not correct. When that happens, you will see an error like the following in***/var/log/isi_audit_syslog.log***. Failed to connect to:172.20.48.1:514, err:[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: IP address mismatch, certificate is not valid for '172.20.48.1'. (_ssl.c:1136), ca:/ifs/.ifsvar/modules/isi_certs/system/ca/zone_1/certs, crt:None To check the certificate, run the following command: Bash openssl x509 -text -noout -in server-cert.pem Verify that the certificate has a section like the following: Bash X509v3 extensions: X509v3 Subject Alternative Name: IP Address:172.20.48.1 You can also verify the server certificate against the CA using: Bash openssl verify -CAfile ca-cert.pem server-cert.pem ### Syslog Sending Old Events Since syslog support within OneFS is designed for auditing, there are occasions where inbound events from the cluster are old and no longer applicable. If the cluster is sending events that are old and no longer applicable, you can configure the auditing system built into OneFS to send events *starting* from a specific point in time. 1. Open an SSH session on the PowerScale storage cluster as an administrator. 2. Enter the following command, replacing the date and time after the @ sign with the current date and time. For example: isi audit settings global modify --syslog-log-time "Protocol@2023-07-01 12:00:00" ## Technical Support [Peer Software Service Desk](https://servicedesk.jira.peersoftware.com/) USA +1 703-763-7700 EMEA +49 89 2620763-22 UK/IE +44 20 777 098 22 ## Related Articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Configuration Guides](https://kb.peersoftware.com/kb/configuration-guides.md) * [Configure PeerSync to synchronize in a clustered environment](https://kb.peersoftware.com/kb/configure-peersync-to-synchronize-in-a-clustered-e.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Dell PowerScale Syslog Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-syslog-configuration-guide.md) * [Dell PowerScale \| EMC Isilon Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-emc-isilon-configuration-guide.md) * [Dell PowerStore Configuration Guide](https://kb.peersoftware.com/kb/dell-powerstore-configuration-guide.md) * [Dell Unity Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-configuration-guide.md) * [Dell Unity Legacy Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-legacy-configuration-guide.md) * [How do I install Health Checker on a remote server?](https://kb.peersoftware.com/kb/installing-health-checker-on-a-remote-server.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) --- language: "en" --- # Dell PowerStore Configuration Guide |------------------|-----------------| | **Last Updated** | 07 October 2025 | ## Overview This guide steps you through configuring your environment to work with a Dell storage platform in preparation for installing Peer Software solutions. The last section of this guide provides troubleshooting information. The components covered in this guide may be installed on the same server as Peer Software components (like the Peer Agent) or they may be installed on a dedicated server. The software you will be installing and configuring includes: * Dell CEE (Common Event Enabler) framework -- Required to receive real-time notifications from specific Dell storage platforms. ## Requirements * Your Dell PowerStore storage device must be running PowerStoreOS v4.1 or later. * If you are installing the CEE on Red Hat, it requires Red Hat Enterprise Linux v9.x or later. CEE does not support Rocky Linux. * Local administrator rights are required for most of the installation and configuration tasks. * See [Dell PowerStore Prerequisites](https://kb.peersoftware.com/kb/dell-powerstore-prerequisites.md) for other requirements. ## Terminology * **CEE server** -- A Windows or Red Hat server hosting CEE framework and optionally, your Peer Software solutions. * **Common AntiVirus Agent (CAVA)** -- A software service that provides anti-virus services for Dell storage platforms. * **Common Event Enabler** **(CEE)** **framework** -- A Dell software product required to obtain real-time event notifications from a PowerStore storage device. Used to be called Celerra Event Enabler. * **Common Event Publishing Agent (CEPA)** -- A software service that provides event publishing services for Dell storage platforms. * **PowerStore**-- All-flash unified storage platform. * **Multi-Protocol** -- Multi-protocol allows workloads where some clients use SMB and others use NFS to access the same data set on the same storage system. This enables mixed environments (e.g., Windows and Linux) to access and modify common files without maintaining separate copies. * **NAS Server** -- A Dell PowerStore storage server that uses the SMB and/or NFS protocols to catalog, organize, and transfer files within designated file systems. * **NFS**-- The Network File System (NFS) protocol is a network file-sharing protocol typically used by Linux-based clients. Common versions include v3 and v4. * **SMB/CIFS** -- The Server Message Block (SMB) Protocol is a network file-sharing protocol; it supersedes Common Internet File System (CIFS), an earlier protocol. SMB is used in this document to refer to both protocols. SMB is widely used in Windows environments, but it is supported across multiple operating systems. ## Configuration Tasks ### Task 1. Confirming Configuration Readiness 1. Ensure that the Dell PowerStore prerequisites are met for the Peer Software solution you will be using. 2. If your storage platform (e.g., PowerStore and Unity) requires licensing for the Common Event Enabler (CEE) framework, ensure that CEE is licensed. 3. Ensure that the PowerStore storage device is already configured to serve data via SMB and optionally, NFS. SMB is required for event publishing with CEE. You should be able to access an SMB share and optional NFS export from a client BEFORE attempting to continue. 4. Ensure that the date and time on the PowerStore storage device are synchronized with any associated domains, as well as the servers hosting the Peer Software solution and the CEE. ### Task 2. Installing the Common Event Enabler Installing the Common Event Enabler on Red Hat Enterprise Linux (RHEL) 1. SSH into the CEE server (can be either the Agent server itself or a separate CEE server). 2. Download the CEE installer. You can download the software from Dell's support site (requires a Dell account): The minimum CEE version required is v9.2. wget --user-agent=Mozilla -O emc_cee_RHEL-9.2.0.0.x86_64.rpm https://dl.dell.com/downloads/93PD1_Common-Event-Enabler-9.2.0.0-for-Red-Hat-Enterprise-Linux---64-bit.rpm 3. Start the CEE installation using dnf or yum. The RPM name should look something like **emc_cee_RHEL-9.2.0.0.x86_64.rpm**. sudo dnf install emc_cee_RHEL-9.2.0.0.x86_64.rpm 4. If you are installing CEE for the first time, you will be prompted to install CEE. ![image-20251007-162931.png](https://kb.peersoftware.com/__attachments/a_475be210f5272b68c63ddf94bff6aac3aea2a3176aa129af2d6fe45220223b7c/image-20251007-162931.png?cb=bbb7f7d116a1536a6791c205e9939d64) If you have already have a previous version of CEE installed on this server, you will be prompted to upgrade. ![image-20251007-163236.png](https://kb.peersoftware.com/__attachments/a_bc7b3006ffb394462a905b87eff9b91899d5a1528351e6f3e7168566663b8ad8/image-20251007-163236.png?cb=7ed68fb471e56e3498aa5d9aa0488989) In either case, type **y** then press the enter key to start. 5. When complete, the install script will automatically exit. ![image-20251007-162422.png](https://kb.peersoftware.com/__attachments/a_665f5cad63892fce85b7fe218851686431688b77123cc1632120ba06f88335e1/image-20251007-162422.png?cb=2df182b149e016b633878543d923ba7c) Installing the Common Event Enabler on Windows 1. RDP into the CEE server (can be either the Agent server itself or a separate CEE server) 2. Download the latest Microsoft Visual C++ runtime from 3. Install the latest Microsoft Visual C++ runtime. 4. Download the CEE installer. You can download the software from Dell's support site (requires a Dell account): The minimum CEE version required is v9.2. 5. Run the CEE installer. 6. As part of the initial setup process, you may be asked to install Microsoft .NET Framework v4.8. This will be handled automatically by the CEE installer. If prompted to reboot the server, do not do so. However, you will need to restart the CEE installer once the .NET installation is complete. 7. Once in the CEE installer's wizard, take the defaults until you get to the **Configure CEE Security Settings** page. On this page, make sure **Enable HTTP Server.** is checked and **Enable AccessList** is unchecked. ![image-20251007-163536.png](https://kb.peersoftware.com/__attachments/a_01b6403a547dccda01754c73d708d12ed8a374e8f61252cb3a05f2de096b4bca/image-20251007-163536.png?cb=078465029f33bd7eaa7f3417caf2aef6) 8. On the **Symantec SAV for NAS** page, ensure that no options are checked. ![image-20251007-163608.png](https://kb.peersoftware.com/__attachments/a_a31f18a2f69276b88d688a6e07ca912919dd36dc1ab6aea019298726f6f09a78/image-20251007-163608.png?cb=8017437781a8f0cfeba64cc3d22a23a6) 9. Complete and close the installer wizard. If prompted to reboot the server, do not do so. You will reboot after configuring CEE in the next task. ### Task 3. Configuring the Common Event Enabler Configuring the Common Event Enabler on Red Hat Enterprise Linux (RHEL) 1. Navigate to the install directory for the CEE (typically /opt/CEEPack). 2. Open **emc_cee_config.xml** using your preferred editor. 3. In the CEPP/Audit/Configuration section... Set **Enabled** to 1 Set **EndPoint** to: PeerSoftwareCollector@http://: Set \ to the appropriate IP of the Agent server and \ to 9843. If you are installing the CEE on the same server as the Agent itself, do ***NOT*** use the local loopback address (127.0.0.1) for the Agent server's IP. For example: ![image-20250826-152305.png](https://kb.peersoftware.com/__attachments/a_a1914e9eca93111932d017915ff3ec4e173dbd0ffe6fe70f6c4469cbaf929fd9/image-20250826-152305.png?cb=92314f42db98950c6b259ae6c151db95) 4. Navigate to the bottom of the xml file and find the Configuration/Security section... Set **Access/AccessListEnabled** to 0 Set **Http/ServerEnabled** to 1 ![image2025-8-25_11-20-34.png](https://kb.peersoftware.com/__attachments/a_d7c2204c65de9b2243534b738a16fb4b0d7afc6fcaa0913ed3be4deaf4853dd1/image2025-8-25_11-20-34.png?cb=085f61204fd483da5a4a140d9a8f6da4) 5. Save and close the xml file. 6. Restart the CEE service sudo systemctl restart emc_cee Configuring the Common Event Enabler on Windows 1. Open the Windows Registry Editor (regedit.exe) 2. Navigate to: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\EMC\CEE\CEPP\Audit\Configuration 3. Set **Enabled**to 1 Set **EndPoint** to: PeerSoftwareCollector@http://: Set \ to the appropriate IP of the Agent server and \ to 9843. If you are installing the CEE on the same server as the Agent itself, do ***NOT***use the local loopback address (127.0.0.1) for the Agent server's IP. For example: ![image-20250826-152129.png](https://kb.peersoftware.com/__attachments/a_083c692db32c8d2bffdd2d8dcb5b5c3a3ac07ee64b9995df72494cc74670cb66/image-20250826-152129.png?cb=efe18a7210cc320bd39fd5374b618482) 4. If in Task #2, you did not enable HTTP Server or you did not disable the AccessList feature of the CEE, refer to the Troubleshooting section below on how to change these settings in the registry. 5. Close the Registry Editor and reboot the server. ### Task 4. Configuring the PowerStore Storage Device The event publishing system on the Dell PowerStore storage device is responsible for sending event and client activity notifications to the Common Event Enabler (CEE), which then sends notifications to Peer Software solutions. You can configure the event publishing settings on a PowerStore storage device using its web interface. You must be an admin user of the PowerStore storage device to configure these settings. 1. Open a browser window. 2. Enter the IP address of the PowerStore storage device in the browser's address bar. 3. Enter your user name and password, and then click **OK** . The **Dashboard** page is displayed. 4. Click on the **Storage** menu, then **NAS Servers** . The **NAS Servers** page that appears displays a list of the configured NAS Servers. 5. Select the NAS Server which you would like to configure then click on the **Security \& Events** tab. ![image-20250825-165038.png](https://kb.peersoftware.com/__attachments/a_8d7863b5bddb7637ad7df941ee4d04026f04a8dbb762113b32f6a2b544c6bc3a/image-20250825-165038.png?cb=0a25e51781911f90f47b40527b1c164b) 6. Click on the **Events Publishing** sub-tab and set to **Enabled**. 7. If you do not have an Events Publisher already assigned to this NAS Server, click **Create new event publisher.** If you already have an Events Publisher that is assigned to this NAS Server (because, for example, you are using software from another vendor that leverages CEE), you will need to add a new Publishing Pool to this Events Publisher. To modify an existing Events Publisher, click on the **Storage** menu, then **NAS Servers** and select the **NAS Settings** tab. On the **Events Publishing** page, select the appropriate Events Publisher and press **Modify**. Skip to Step # 11 to add a new pool. 8. If you clicked on **Create new event publisher**, the following is displayed. ![image-20250825-174046.png](https://kb.peersoftware.com/__attachments/a_9ac92c90f6bf054c0d63e25e55b958da645b0c3272249a4891e7a4805a9fadeb/image-20250825-174046.png?cb=5dc1ff574d7204c0658c762ace47c2bd) 9. Click **Create** to create an Events Publisher. ![image-20250825-174236.png](https://kb.peersoftware.com/__attachments/a_92158179b8cc623cb1e889e9672370a8cf458c96044c385f9a7a4cd6a370bdd0/image-20250825-174236.png?cb=22bfa4f9c9a9cfc918e47c53f3a17332) 10. Give the events publisher a name. Note this name as you will need it when configuring your Peer Software solution. 11. Click **Create** to create a new publishing pool. 12. Set the **Pool Name** to an appropriate name. Note this name as you will need it when configuring your Peer Software solution. You will need to add at least one FQDN or IP address to the **Event Publishing (CEPA) Server** list. 1. If you installed the CEE on the same server as the Peer Agent, add a single IP address or FQDN of the Agent server and nothing else. There should be only one entry in the list. 2. If you are installing the CEE on a separate server(s) from the Peer Agent, add the IP address(es) or FQDN(s) of the appropriate servers. 13. Under **Event Configuration** , select the **Post-Events** tab, and select the items shown below (check **Select** **all** , then uncheck **CloseDir** , **OpenDir, FileRead** , **OpenFileReadOffline** , and **OpenFileWriteOffline** ). The **Pre-Events** and **Post-Error-Events**pages should not have anything checked. ![image-20251001-155853.png](/__attachments/a_d447f58bd844c37c58b3d23fb9bf2f263ad27d2b2df920f8e1343683f696a03c/image-20251001-155853.png?cb=8c4dc94a0185610770f4159c66d7acc6) 14. Click **Apply**. 15. Check the newly created publishing pool then click **Next**. 16. On the **Configure Events Publisher** page, match the settings shown here (defaults). ![image-20250825-181933.png](/__attachments/a_b71a6347ed6746901d87d12f99dc31f748139313fa83d85ba0c955d201f55ad0/image-20250825-181933.png?cb=39a4584e1ff03acaad3939c2a0d9e2d0) 17. Click **Create Events Publisher** or **Modify Events Publisher**, depending on if you are creating a new Events Publisher or are modifying an existing one. 18. Navigate back to the **Events Publishing** sub-tab from Step #6 above, ensure that it is **Enabled** , and select the newly created or modified Events Publisher from the list. Ensure that **Enable for all existing file systems under this NAS server** is ***NOT***checked unless you explicitly want to monitor the entire NAS server and not individual file systems. ![image-20250825-182755.png](/__attachments/a_dc678deceefa5c92c6da922013e97b39f95f807c78293a09abaf75e42ffc8c0a/image-20250825-182755.png?cb=ec20181cd7e79d3d47bce03c20ca7864) 19. Click **Apply**. 20. Click on the **Storage** menu, then **File Systems** . The **File Systems** page that appears displays a list of the configured file systems. ![image-20250825-164256.png](/__attachments/a_5f4729865b034c5bab08857a0f76e017abefc0c04e21f22d0bacf9868fa5e44a/image-20250825-164256.png?cb=5820111ba0712e89930b7f9e8818a9c7) 21. For each file systems you want to monitor, enable the tracking of end-user activity: 1. Select the name of the file system. The **Capacity** page appears 2. Click the **Security \& Events**tab. ![image-20250825-164524.png](/__attachments/a_d4ad9196bb05cb3fe718ba327f7d8e8a405a507f90cb382727512ef95ec397a9/image-20250825-164524.png?cb=6b47217fe8e2d20c149d659a7316170e) 3. Ensure that **Events Publishing** is **Enabled**. 4. Select the appropriate protocols to monitor. If you are setting up a multi-protocol environment, be sure to check both **SMB** and **NFS**. 5. Click the **Apply** button. 6. Repeat Step #21 for each file system you want to monitor. ### Task 5. Installing and Configuring the Dell NAS Management Tool This task is for SMB and multi-protocol workloads only. The Dell NAS Management Tool allows you to set up SMB user filters on the Dell storage device. In the context of Peer Software solutions, these user filters allow the storage device to not track activity generated by Peer Software services. While this activity is automatically ignored by Peer Software services, filtering this activity out on the storage side reduces overhead on both the storage device and the CEE service. The NAS Management Tool can also be used to grant backup operator-related privileges to Peer Software services in order to avoid being blocked from files and folders for permission reasons. 1. RDP into a Windows server that will run the NAS Management tool. This can be a server hosting the Peer Software solution or the CEE service. 2. Download the Dell NAS Management tool. You can download the software from Dell's support site (requires a Dell account): 3. Install the NAS Management tool software: 1. Run the NAS Management installer as an administrator. The **Dell NAS Management Setup** wizard appears. ![92155b9c-4119-45e3-a314-18e3c454a8a2.jpg](/__attachments/a_348a25c7c987ba270937d1f41c7c1704d484d98700629b464c34a8b437f9e889/92155b9c-4119-45e3-a314-18e3c454a8a2.jpg?cb=48530c80e5283d72576676580ca1f13f) 2. Take the defaults through the wizard until you see a notice about installing the 32-bit version. ![image2025-8-29_8-14-23.png](/__attachments/a_e4b68cc972110ddbf4c56207162b0b981a28df6d953af945a8cc1d3adadf41c4/image2025-8-29_8-14-23.png?cb=da264545268889fc990590b1701ff0b5) 3. Click **OK**. The **Select Installation Folder** page appears. ![image2025-8-29_8-14-59.png](/__attachments/a_96f418efb9ad1ad8da1cbc11fcab208846625165e11bb078090cf7f7bfeda046/image2025-8-29_8-14-59.png?cb=8bd784348f1ec331b9b7930678274402) 4. Click **Next** to accept the default location. The **Select Features** page appears. ![image2025-8-29_8-15-42.png](/__attachments/a_fbbd7b7ed8d8d00a34a69b6be4dcccc82e013dd393f54de490f56fa00072d2a0/image2025-8-29_8-15-42.png?cb=76aa029fadd607eb22514eff10f3f7a5) 5. Click **Next** to install all the features then **Next**again to start the installation. Click **Finished** when the installation has completed. 4. Open the **Dell NAS Management** console. 1. In the start menu, search for and open **Administrative Tools**. ![image-20250829-122100.png](/__attachments/a_7337842af846387e42cbe85366386662db87763794abd97fdcf8cad9e70bbe48/image-20250829-122100.png?cb=b07e2d1ef1ea780c9bbaff64d17d9624) 2. Open **Dell EMC NAS Management** as an administrator. 3. If the **Initialize Active Directory?** dialog appears, click **OK**. ![image-20250829-122251.png](/__attachments/a_45a47e3a0be9ca0259f9c2c1bbb59ac71f1bf42655f6d4a131408ce8d638b273/image-20250829-122251.png?cb=6928dea0575e8051d41e29e0217b9b6c) 5. Connect to the appropriate NAS Server: 1. In the navigation pane, right-click the **Data Mover/NAS Server Management** folder, and then select **Connect to Data Mover/NAS Server...** from the shortcut menu. ![image-20250829-122523.png](/__attachments/a_41ad0cba996225cd797de9d4513dd0c61a6c63427c40b4d469c85d0e02f48959/image-20250829-122523.png?cb=deec8f83256400c3aef652376a25faa7) 2. In the **Select Data Mover/NAS Server** dialog that appears, select the appropriate Unity or PowerStore NAS Server, and then click **OK**. ![image-20250829-122554.png](/__attachments/a_848d8c28d0461e03a824bf7176ae8b1e4280cd645fd9918d58f626b07df77c7f/image-20250829-122554.png?cb=f383929d1abf27ac43f1f1d33a6524fd) 6. Add the Peer Agent service account or SMB Access account (if using multi-protocol) to the **EMC Event Notification Bypass** and**EMC Virus Checking** security policies: 1. Navigate to the **Data Mover/NAS Server Management \> Data Mover/NAS Server Security Settings \>User Rights Assignment** folder. The list of user rights assignment settings appears in the details pane and includes their current setting and effective setting. ![Install Unity Mgmt Tool - Data Mover-3.png](/__attachments/a_20aaed94074000b7b35a2e7046e2f30f1c696f169ec1973f3a1d7f29ed04604e/Install%20Unity%20Mgmt%20Tool%20-%20Data%20Mover-3.png?cb=5e5a96fe1cec113a9ffd1ee602e1fc7f) 2. In the details pane, right-click the **EMC Event Notification Bypass** policy, and then select **Security** from the shortcut menu. The **Security Policy Setting** dialog appears and lists users or groups that are already assigned to the selected user rights assignment. If no assignments exist, the list is blank. ![Install Unity Mgmt Tool - Data Mover-4.png](/__attachments/a_83769caebf8fd607c242ad595777a737c93239a4291eea9748501131dc3ecb74/Install%20Unity%20Mgmt%20Tool%20-%20Data%20Mover-4.png?cb=149bc46188af64911f17f3fd8400fc4e) 3. Click **Add**. The **Select User or Groups** dialog appears. 4. In the **Look in** box, select the domain in which the Agent service or SMB Access account is located. 5. In the upper pane, select the Peer Agent service or SMB access account, and then click **Add**. The account appears in the lower pane. 6. Click **OK**. The account is now listed in the **Security Policy Setting** dialog. 7. Click **OK**. The account is now assigned to the **EMC Event Notification Bypass** policy. ![Install Unity Mgmt Tool - Data Mover-7.png](/__attachments/a_042a5a4b9394f97684e2f8aa5c30c5e3b054c926d44ddf72ef8d0bd429907113/Install%20Unity%20Mgmt%20Tool%20-%20Data%20Mover-7.png?cb=4f09a688e8154a1b643737d12aa3aade) 8. Repeat Steps 6b-g for for each of the following policies: 1. **EMC Virus Checking** 2. **Back up files and directories** 3. **Restore files and directories** 4. **Take ownership of files or other objects** 5. **Manage auditing and security log** 7. Restart the **EMC CAVA** and **EMC CEPA** services on your CEE server. **Note:** Once these settings are in place, no testing should be performed with this service account. ## Troubleshooting ### Windows: Error 1053 When Starting CAVA Service If you get Error 1053 when you try to start the EMC CAVA service, ensure that the .NET 4.8 Framework is installed on the CEE server, and then restart the EMC CAVA service on the CEE server. ### Windows: EMC CAVA and/or CEPA Services are Constantly Restarting Check that the latest Microsoft Visual C++ runtime is installed. The installer can be obtained from . Restart the EMC CAVA and CEPA services after installation. ### Windows or RHEL: CEE is not receiving events from storage device A number of issues can result in this behavior. Be sure to check the following items: 1. Make sure the CEE server is configured for HTTP. 1. To enable HTTP on Windows CEE servers: 1. RDP into the CEE server and open regedit.exe. 2. Navigate to **HKLM\\SOFTWARE\\EMC\\CEE\\CEPP\\Configuration\\Security\\Http** 3. Make sure that **ServerEnabled** is set to 1. 4. Restart the EMC CEPA service after making this change. 2. To enable HTTP on RHEL CEE servers: 1. SSH into the CEE server. 2. Navigate to the install directory for the CEE (typically /opt/CEEPack). 3. Open **emc_cee_config.xml** using your preferred editor. 4. Navigate to the bottom of the xml file, find the Configuration/Security section and set **Http/ServerEnabled** to 1 5. Save and close the xml file 6. Restart the CEE service sudo systemctl restart emc_cee 2. Ensure that AccessList is disabled. If AccessList support is a requirement for your environment, refer to the Dell documentation on how to configure the IP address(es) of the storage devices that will communicate with CEE. 1. To turn off AccessList on Windows CEE servers: 1. RDP into the CEE server and open regedit.exe 2. Navigate to **HKLM\\SOFTWARE\\EMC\\CEE\\CEPP\\Configuration\\Security\\Access** 3. Make sure that **AccessListEnabled** is set to 0 4. Restart the EMC CEPA service after making this change. 2. To turn off AccessList on RHEL CEE servers: 1. SSH into the CEE server. 2. Navigate to the install directory for the CEE (typically /opt/CEEPack). 3. Open **emc_cee_config.xml** using your preferred editor. 4. Navigate to the bottom of the xml file, find the Configuration/Security section and set **Access/AccessListEnabled** to 0 5. Save and close the xml file 6. Restart the CEE service sudo systemctl restart emc_cee 3. Make sure the CEE server has no firewalls enabled. If firewalls are a must, make sure that inbound port 12228 (by default) is open. Refer to Dell documentation if you need to change this port as it needs to be changed on the CEE server as well as on the storage device. ## Technical Support [Peer Software Service Desk](https://servicedesk.jira.peersoftware.com/) USA +1 703-763-7700 EMEA +49 89 2620763-22 UK/IE +44 20 777 098 22 ## Related Articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Configuration Guides](https://kb.peersoftware.com/kb/configuration-guides.md) * [Configure PeerSync to synchronize in a clustered environment](https://kb.peersoftware.com/kb/configure-peersync-to-synchronize-in-a-clustered-e.md) * [Configure the Agent installer to run unattended](https://kb.peersoftware.com/kb/configure-the-agent-installer-to-run-unattended.md) * [Configure the PeerSync Listener installer to run unattended](https://kb.peersoftware.com/kb/configure-the-peersync-listener-installer-to-run-u.md) * [Dell PowerScale Syslog Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-syslog-configuration-guide.md) * [Dell PowerScale \| EMC Isilon Configuration Guide](https://kb.peersoftware.com/kb/dell-powerscale-emc-isilon-configuration-guide.md) * [Dell PowerStore Configuration Guide](https://kb.peersoftware.com/kb/dell-powerstore-configuration-guide.md) * [Dell Unity Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-configuration-guide.md) * [Dell Unity Legacy Configuration Guide](https://kb.peersoftware.com/kb/dell-unity-legacy-configuration-guide.md) * [How do I install Health Checker on a remote server?](https://kb.peersoftware.com/kb/installing-health-checker-on-a-remote-server.md) * [Move a Peer Agent to another Windows server](https://kb.peersoftware.com/kb/peergfs-move-an-agent-to-another-windows-server.md) --- language: "en" --- # Dell PowerStore Prerequisites |------------------|--------------| | **Last Updated** | 24 June 2026 | 1. **PowerStore OS Version Requirements** : The minimum version of PowerStore OS is v4.1. PeerSync is ***not*** supported. 2. The PowerStore storage device must be licensed for NAS/file operations and the Dell Common Event Enabler (CEE) Framework. 3. Any server that will be interfacing with a PowerStore device through the Peer Agent ***must*** be on the same domain, the same network segment, and the same subnet as the PowerStore device. Additionally, this network connection between the PowerStore device and the Agent ***must*** operate at speeds of at least 1 Gbit/sec with sub-millisecond latency. 4. **Time Synchronization** : The PowerStore storage platform, as well as the server hosting the Peer Agent, ***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. 5. **Server OS Version Requirements:** 1. ***For SMB workloads***, the minimum version of Windows required for PowerStore support with the Peer Agent is Windows Server 2016. 2. ***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. 6. The server hosting the Peer Agent should 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). 7. **Dell Common Event Enabler (CEE) Requirements**: 1. The minimum version of the Dell Common Event Enabler (CEE) is v9.2. 2. If you are installing the CEE on Red Hat, it requires Red Hat Enterprise Linux v9.x or later. Rocky Linux is ***not***supported by CEE. 3. The CEE framework allows up to three different applications to consume events from a PowerStore NAS Server. As such, no more than two other CEE-based applications can be in use with a single NAS Server when adding Peer Software products. 4. The CEE can only be installed on Windows, Red Hat Enterprise Linux (RHEL), and SUSE Linux (SLES) servers. CEE does ***not***support Ubuntu so it cannot be installed on the Peer Agent Virtual Appliance (which is based on Ubuntu). 5. The Peer Agent does not support SLES; therefore, if you want to have CEE and the Agent on a single Linux-based server, it ***must*** be running RHEL. Otherwise, the CEE and Agent services can be installed on two different servers. 6. A CEE server ***must***be configured to send events to a single Peer Agent server. Multiple EndPoints are not supported. If using multiple CEE servers in a pool, all must point to the same single Peer Agent server. 7. SMB must be enabled on the NAS Server as it is required by the Event Publishing system in PowerStore. 8. **Privileges and Permissions for SMB Workloads:** 1. The service account for the Peer Agent ***must***have local administrator privileges on the Windows Server where the Peer Agent will be hosted. 2. The service account for the Peer Agent ***must***be included as a local administrator on the NAS Server. 9. **Privileges and Permissions for NFS Workloads** ***:*** 1. The Peer Agent server IP needs to be granted read/write and root access to the exports that this Agent will be monitoring. 2. NFSv4 ACL support requires: 1. The Peer Agent server to be in the same DNS domain as its associated NAS Server. The Agent server's search domain and the domain portion of its FQDN (viewable by running `hostname -f`) should match the domain of its associated NAS Server. 10. **Privileges and Permissions for Multi-Protocol Workloads:** 1. When replicating Windows-style permissions, the domain account used by the Samba connection of the Peer Agent ***must***be included as a local administrator on the NAS Server. 2. The Peer Agent server IP needs to be granted read/write and root access to the exports that this Agent will be monitoring. 3. When replicating Linux-style permissions, NFSv4 ACL support requires: 1. The Peer Agent server to be in the same DNS domain as its associated NAS Server. The Agent server's search domain and the domain portion of its FQDN (viewable by running `hostname -f`) should match the domain of its associated NAS Server. 11. PowerStore Management logon credentials are required to connect to the PowerStore device's REST API. 12. Do not use the Agent service account when testing file activity - it is automatically filtered. 13. No firewalls (software or hardware) should be enabled between the server hosting Peer Agent and the PowerStore device. If the CEE service is installed on a server other than the one hosting the Peer Agent, firewalls between the PowerStore device and the CEE server, as well as between the CEE server and the server hosting the Peer Agent should be disabled. If firewalls cannot be disabled, review the [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) guide for details on the specific ports that ***must***be opened. ## Related articles * [Achieving high availability for the PMC through active-passive configuration](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc.md) * [Achieving high availability for the PMC through active-passive configuration (v4.7.0 - v5.1.1)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-pre-5.2.md) * [Achieving high availability for the PMC through active-passive configuration (v5.2 only)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-5.2-only.md) * [Achieving high availability for the PMC through active-passive configuration (v6.0 and later)](https://kb.peersoftware.com/kb/achieving-high-availability-for-the-pmc-latest.md) * [Amazon FSx for NetApp ONTAP Prerequisites](https://kb.peersoftware.com/kb/amazon-fsx-for-netapp-ontap-prerequisites.md) * [Dell PowerScale Prerequisites](https://kb.peersoftware.com/kb/dell-powerscale-prerequisites.md) * [Dell PowerStore Prerequisites](https://kb.peersoftware.com/kb/dell-powerstore-prerequisites.md) * [Dell Unity Prerequisites](https://kb.peersoftware.com/kb/dell-unity-prerequisites.md) * [Firewall Requirements](https://kb.peersoftware.com/kb/firewall-requirements.md) * [Getting Started with Multi-Protocol for PeerGFS](https://kb.peersoftware.com/kb/getting-started-with-multi-protocol-for-peergfs.md) * [Issues runing PeerSync as a service](https://kb.peersoftware.com/kb/issues-runing-peersync-as-a-service.md) * [NetApp ONTAP Prerequisites](https://kb.peersoftware.com/kb/netapp-ontap-prerequisites.md) * [Nutanix Files Prerequisites](https://kb.peersoftware.com/kb/nutanix-files-prerequisites.md) * [Peer Global File Service - Environmental Requirements](https://kb.peersoftware.com/kb/peergfs-environmental-requirements.md) * [PeerGFS jobs fail to start after initial job due to NetAPP ONTAP v9.15.1 upgrade](https://kb.peersoftware.com/kb/job-start-issues-with-ontap-9.15.1.md) [Next Page](https://kb.peersoftware.com/llms-full.txt/1)