apiopenstudio/transport_sftp

Transport for ApiOpenStudio output over the SFTP protocol.

v1.0.0-BETA 2022-06-21 05:13 UTC

This package is auto-updated.

Last update: 2022-11-21 21:47:24 UTC


README

Transport for ApiOpenStudio output over the SFTP protocol.

Adding to your project

Composer

$ composer require apiopenstudio/transport_sftp

Configuration

Add a remote output processor to your resource.

The output section example below will return the output in the response as well as upload the response to a server using SFTP:

output:
    -
        processor: xml_remote
        id: example XML Remote output
        filename: example.xml
        transport: ApiOpenStudio\Plugins\TransportSftp
        parameters:
            host:
            username:
            root_path:
            password:
            private_key:
            passphrase:
            port:
            user_agent:
            timeout:
            max_tries:
            fingerprint_string:
    - 
        response

Note: the value for the transport is the full namespace path.

Parameters

Required

  • host
  • username
  • root_path

Optional

  • password
  • private_key
  • passphrase
  • port
  • user_agent
  • timeout
  • max_tries
  • fingerprint_string

Further information

See FlySystem documentation and The League GitHub for more details.