Primeur Online Docs
Data Mover 1.20
Data Mover 1.20
  • 🚀GETTING STARTED
    • What is Primeur Data Mover
    • Main features of Primeur Data Mover
    • Primeur Data Mover deployment
    • Navigate through Primeur Data Mover
  • 📚INFRASTRUCTURE
    • STENG, clusters and servers
      • Adding a cluster and a STENG
      • Deleting a STENG
    • DMZ Gateways
      • Blocking users automatically at the DMZ level 🚀
    • DMZ Clusters
      • Load balancing across active DMZ clusters for outbound file transfers 🚀
  • 👥Actors
    • Who are the actors
    • Create your first actor
    • Configure an actor 🚀
      • Users Tab
      • Groups Tab
      • VFS Tab
      • File Resource Tab
      • Connection Contract Tab
      • Client Connections Tab
    • Search files by actor
    • Actor Lineage 🚀
      • Aggregation of flows by protocol 🚀
      • Lineage with connection contracts 🚀
      • Lineage with input, mediation and output contracts 🚀
      • Lineage with any contract type 🚀
  • 🗄️VIRTUAL FILE SYSTEMS
    • Virtual File Systems (VFS) 🚀
      • Creating a VFS 🚀
      • Configuring a VFS
      • Adding Virtual Paths
      • Modifying and Deleting a VFS
    • Searching files in all VFS
    • Storage Classes 🚀
      • Storage Class: SMB v3 or later versions 🚀
      • Storage Class: Azure Blob Storage 🚀
      • Storage Class: Amazon S3 🚀
      • Storage Class: Google Storage 🚀
      • Storage Class: Local File System 🚀
    • Retention Classes
  • 📝Contracts
    • What is a contract
    • Create your first contract
      • Create an Input Contract
        • Define the contract info
        • Associate the contract with the actor
        • Define the contract actions
        • Set the contract variables
      • Create a Mediation Contract
      • Create an Output Contract
      • Create a Connection Contract
        • Create a contract clause
        • Associate the VFS with file processing rules
        • File Processing Rules
    • Managing contracts 🚀
    • File Resources
      • Creating File Resources
      • Navigating File Resources
      • How to use File Resources
  • 🧱Workflows
    • What is a workflow
    • Create your first workflow template
    • Trigger types
      • Trigger types for input contracts
      • Trigger types for mediation and output contracts
    • Service tasks
      • Standard service tasks
      • Triggerable service tasks 🚀
      • Spazio selectors and filebox metadata management
      • Error management
    • Variables
      • Variables in workflows and contracts
      • Handling process variables
    • Workflow templates
      • System workflow templates
        • Workflow templates for input contracts
        • Workflow templates for mediation contracts
        • Workflow templates for output contracts
      • Custom workflow templates
        • Workflow template toolbar
        • Workflow template Shape repository panel
        • Workflow template working area
        • Workflow template BPMN-diagram panel
      • Error workflow templates
    • Editing workflow templates
    • DataFlow Instance Context (DFIC) 🚀
  • 🛸TRANSPORT PROTOCOLS AND CONNECTORS
    • Data Mover client and server roles
    • Client Connections
      • Client Connection: FTP
      • Client Connection: FTPS
      • Client Connection: SFTP
      • Client Connection: HTTP
      • Client Connection: HTTPS
      • Client Connection: PESIT
      • Client Connection: SMB v3 or later versions
      • Client Connection: POP3 or IMAP
      • Client Connection: SMTP
      • Client Connection: PR4/PR4S
      • Client Connection: PR5
      • Client Connection: PR5S
      • Client Connection: HDFS
      • Client Connection: HDFSS
      • Client Connection: Amazon S3 🚀
      • Client Connection: Google Cloud Storage
        • Credentials
      • Client Connection: Azure Blob Storage
      • Client Connection: IBM Sterling Connect:Direct
      • Client Connections retry settings
    • Server Connections 🚀
      • Server Connection: FTP
      • Server Connection: FTPS
      • Server Connection: SFTP
      • Server Connection: HTTP
      • Server Connection: HTTPS
      • Server Connection: PeSIT
      • Server Connection: PR4
      • Server Connection: PR5
      • Server Connection: PR5S 🚀
      • Server Connection: IBM Sterling Connect:Direct
    • Protocol Connections Reference
    • Stopping all servers in one go
  • 💻API
    • HTTP MFT Rest API
    • Job Manager APIs 🚀
    • SFTP Server sessions APIs 🚀
    • Audit Logs APIs 🚀
  • 🔓Security
    • Identity and Access Management
    • Users & Groups
      • Setting the password policy
      • Creating Internal Users 🚀
      • Creating Internal Groups
      • Creating External Users
      • Creating External Groups
    • Key Stores and Trust Stores
      • Key Store 🚀
        • Creating a Key 🚀
        • Creating a Certificate 🚀
        • Importing a Key or a Certificate
        • Creating a Symmetric key
        • Examples
      • Trust Store 🚀
        • Importing Keys 🚀
        • Importing Certificates
      • Untrusted Cache 🚀
      • Trusting Keys and Certificates
      • PGP Key Store and PGP Trust Store
        • PGP Key Store
        • Importing keys into the PGP Trust Store
    • ICAP
      • Configuring ICAP
      • Defining an ICAP rule
  • 🎧FILE EVENT LISTENER
    • What is the File Event Listener
    • Configuring File Event Listeners
      • Setting the File Event Listener Engine
      • Defining a contract for the File Event Listener
      • Setting events to be monitored 🚀
    • RegEx Rules 🚀
    • Monitoring File Event Listeners
  • 👑FILE MANAGER
    • What is the File Manager
    • Logging into File Manager
    • Managing the File Manager 🚀
      • The list of results
      • Creating new folders
      • Uploading files
      • Downloading files 🚀
      • Searching for files and folders
      • Deleting files 🚀
      • Bulk actions 🚀
    • File Manager and VFS
    • Customizing File Manager externals
      • The configuration-wui.json file 🚀
      • How to customize the Login window and the logo
      • How to customize the footer
      • How to configure the Upload with Metadata option
      • How to customize bulk actions 🚀
  • 🧑‍⚖️FILE ROUTING
    • What is File Routing 🚀
    • Routing Rules
      • The Rules tab
      • The Categories tab
      • The Output tab
    • How to create a rule 🚀
      • Add metadata 🚀
      • Select ACTIONS
      • Select OUTPUTS
      • Policy for the selection of metadata rules
    • Configuration of the environment in Data One
      • Set up Storage Classes
      • Set up Retention Classes
      • Configure the Actor
      • Set up File Resources
    • Associate the Routing Rule with a Contract
    • Example
  • 📩NOTIFICATION CHANNELS
    • What are Notification Channels
    • Configuring the default Email Notification Channel
    • Configuring a new Email Notification Channel
    • Trusting Certificates
    • Managing Templates
      • Data Watcher Macros
      • Contract Macros
      • ICAP Macros
      • Central Log Macros
      • Email Templates
      • Editing default templates
      • Loading a new template
  • 💬LOGS & AUDIT
    • Logs 🚀
      • Logs options 🚀
      • Troubleshooting error analysis in Logs
    • Audit Options 🚀
      • Export audit logs 🚀
      • List of Audit entity types 🚀
      • Audit message codes 🚀
    • Log Notifiers 🚀
      • FEL message codes
  • 🕒MONITORING
    • Jobs
      • Details about Jobs 🚀
      • jobman.sh CLI
    • Job Manager
    • Job Queues
      • Managing Job Queues
    • File Transfers
      • Ongoing
      • Finished
      • Reports
    • File Transfers Rules
      • Configuring Rules
  • 🧐HOW TO...
    • ... use different DNS names 🚀
    • ... configure a Cron Expression
    • ... configure an application
    • ... customize the header
    • ... run searches in Data Watcher 🚀
    • ... use Data Shaper graphs in Data Mover contracts
    • ... modify DMCFG and deploy it
    • ... tune Data One data retention
    • ... fine tune Data Mover
      • Email sender for the Notification Channel
  • 🗒️RELEASE NOTES
    • Data One 1.20.10
    • Data One 1.20.9
    • Data One 1.20.8
    • Data One 1.20.7
      • Data One 1.20.7.1
    • Data One 1.20.6
    • Data One 1.20.5
    • Data One 1.20.4
    • Data One 1.20.3
    • Data One 1.20.2
    • Data One 1.20.1
    • Data One 1.20.0
Powered by GitBook
On this page
  • 🚀 Graceful shutdown for STENG and DMZ components of SFTP servers
  • Stopping STENG and DMZ from Data One user interface: server.env timeout variables
  • Stopping STENG and DMZ from command line: jvm.options timeout variable
  1. TRANSPORT PROTOCOLS AND CONNECTORS

Stopping all servers in one go

PreviousProtocol Connections ReferenceNextHTTP MFT Rest API

Last updated 1 month ago

To stop all servers of the same peer in one go, click the STOP option.

If, for any reason, not all servers of the peer can be stopped, a Refresh option will appear. In this case, the STENG status will be shown in orange.

The Delete STENG option is available only when the STENG does not have any server associated.

🚀 When selecting STOP, a message will appear asking for confirmation. Servers that support graceful shutdown and have active sessions will shut down at the end of all sessions. To force them to shut down, you must stop the STENG peer again. This will force all servers to stop. Active sessions on the shutdown servers will be terminated.

When stopping non-SFTP servers, a page refresh is required to get the correct status of the servers.

🚀 Graceful shutdown for STENG and DMZ components of SFTP servers

Primeur Data One gracefully shuts down a server or peer, keeping SFTP sessions open before the system shuts down and preventing the opening of new connections. The graceful shutdown state lasts until the timeout expires, after which any open sessions are also terminated. See the sections below for details about timeout values and where to set them.

In this version of Data One, graceful shutdown for STENG and DMZ components is active only for SFTP servers.

Graceful shutdown can be applied to the single server or to the entire peer. Stopping the entire peer, the graceful shutdown is applied to all servers running on that peer supporting the feature.

The central log records that the server shutdown is in progress (terminating) and that the shutdown is successful (terminated).

If you press Stop the first time, graceful shutdown will be applied. If you press it again, the shutdown will be forced.

Different timeout values can be set depending on where the STENG and DMZ are stopped. Find below the details of the variables setting values applied when the STENG and DMZ are stopped from the Data One user interface and from the command line.

Stopping STENG and DMZ from Data One user interface: server.env timeout variables

  1. The SPENG_SHUTDOWN_TIMEOUT_SECONDS variable located in the server.env of the STENG determines how long the shutdown process will wait before terminating open sessions and forcing the shutdown. The default timeout value is set to 30 seconds. Adjusting this setting based on the specific needs of your environment can help ensure a safe shutdown process. Here are some general indications:

    1. 1800 seconds (30 minutes) as standard minimum.

    2. If you need to keep connections open longer or send large volume transfers, configure the value appropriately by increasing it according to your environment. After changing the value of the SPENG_SHUTDOWN_TIMEOUT_SECONDS variable, you must restart the STENG.

  2. The DMZ_SHUTDOWN_TIMEOUT_SECONDS variable located in the server.env of the DMZ component determines how long the shutdown process will wait before terminating open sessions and forcing the shutdown. The default timeout value is set to 30 seconds. It is suggested to set this variable to the same value as the SPENG_SHUTDOWN_TIMEOUT_SECONDS variable. After changing the value of the DMZ_SHUTDOWN_TIMEOUT_SECONDS variable, you must restart the DMZ.

Stopping STENG and DMZ from command line: jvm.options timeout variable

The -Dshutdown.graceful.timeout.seconds variable sets the timeout that applies after the STENG stop or the DMZGW stop shell command is invoked. The variable must be manually added to the jvm.options file of the STENG and of the DMZ. It specifies the number of seconds after which open or transferring connections can be abruptly terminated after the command is invoked.

The default timeout value is set to 10 seconds.

Warning! If you want graceful shutdown to be applied and you launch the STENG stop or the DMZGW stop shell command, it is suggested to set the value of the jvm.options -Dshutdown.graceful.timeout.seconds parameter equal to or greater than the corresponding server.env SPENG_SHUTDOWN_TIMEOUT_SECONDS or DMZ_SHUTDOWN_TIMEOUT_SECONDS.

After adding the -Dshutdown.graceful.timeout.seconds variable and changing the value, you must restart the STENG and the DMZ.

These shell commands are available for STENG and DMZ: start, stop, restart, status, and forceStop (this one stops the components without waiting for graceful shutdown).

🛸