Help Docs

Start or Stop an SFTP Server

Using Site24x7's IT Automation framework, you can create an action profile to start or stop an SFTP server. You can also configure the automation to be triggered when there's a change in the status of the monitor or in individual attributes.

Required permissions

Ensure that the IAM role assumed by Site24x7 or the IAM user created for Site24x7 has the following partial write actions in the attached policy document to perform the actions:

  • "transfer:StartServer",
  • "transfer:StopServer"

Create an automation

  1. Log in to the Site24x7 web console and go to Admin > IT Automation Templates > Add Automation Templates.
  2. Click the drop-down and select the action to be performed: Start/Stop SFTP Server.
  3. Enter a Display Name.
  4. Action to be performed: Choose Start SFTP server or Stop SFTP server from the drop-down menu.
  5. Next, select the instances where the action should be performed.
    • Max Allowed Action Execution Time: The maximum number of seconds Site24x7 should wait before the request times out. The execution time is set to 15 seconds by default. You can define an execution time between one and 90 seconds.
    • Send the Automation Result via Email: You can choose to receive an email regarding the automation result by toggling this setting to Yes. Automation results can be shared via email to your User Alert Group configured in the Notification Profile. This email will contain parameters including the automation name, type of automation, incident reason, destination hosts, and more.
  6. Save the profile.

Simulate the automation

Before mapping the action profile, you can test its functionality by invoking the operational task manually within the Site24x7 console or by using our REST APIs. This is done to check whether the appropriate write-level permissions required to execute the reboot action are in place. To test the profile, navigate back to the IT Automation summary page (Admin > IT Automation) and click the play icon Test automation icon next to the appropriate template to execute a dry run.

Map the action profile

To execute the automation, map the action profile to the desired alert event. You can either map the profile to a predefined monitor-level event type or to a custom attribute-level event type.

Monitor-level mapping

Navigate to the Edit page of the monitored SFTP server, and map the action profile to any of the following monitor status changes:

  • Execute on Down
  • Execute on Up
  • Execute on Trouble
  • Execute on Critical
  • Execute on any Status change

Attribute-level mapping

You can also associate the action profile to any monitored AWS resource or application-related metric data points, like Bytes In or Bytes Out.

To map the profile to any desired attribute, navigate to the Edit Threshold Profile page of the monitored SFTP server and click Select Automation to Execute.

Was this document helpful?

Would you like to help us improve our documents? Tell us what you think we could do better.

We're sorry to hear that you're not satisfied with the document. We'd love to learn what we could do to improve the experience.

Thanks for taking the time to share your feedback. We'll use your feedback to improve our online help resources.

Shortlink has been copied!