Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SFTPTarget

A 'sftp' target.

Hierarchy

Index

Properties

__cache

__cache: CacheProvider

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

The cache for that item.

__id

__id: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the ID of that item.

__index

__index: number

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the zero-based of that item.

__searchValue

__searchValue: any

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

A value for comparison.

__workspace

__workspace: Workspace

[INTERNAL] DO NOT DEFINE OR OVERWRITE THIS PROPERTY BY YOUR OWN!

Gets the underlying workspace.

Optional agent

agent: string

Name or path to ssh-agent for ssh-agent-based user authentication.

Optional agentForward

agentForward: boolean

Set to (true) to use OpenSSH agent forwarding (auth-agent@openssh.com) for the life of the connection. 'agent' property must also be set to use this feature.

Optional alwaysAskForPassword

alwaysAskForPassword: boolean

Always ask for password and do not cache, if no password is defined.

Optional alwaysAskForPrivateKeyPassphrase

alwaysAskForPrivateKeyPassphrase: boolean

Always ask for private key passphrase and do not cache.

Optional alwaysAskForUser

alwaysAskForUser: boolean

Always ask for uasername and do not cache, if no user is defined.

Optional applyValuesTo

applyValuesTo: object

A list of property names and their values that should be applied to that object.

Type declaration

  • [prop: string]: any

Optional askForPassword

askForPassword: boolean

Ask for password.

Optional askForPrivateKeyPassphrase

askForPrivateKeyPassphrase: boolean

Ask for private key passphrase.

Optional askForUser

askForUser: boolean

Ask for username.

Optional beforeDelete

One or more target operations that should be invoked BEFORE a deletion in that target starts.

Optional beforeDeploy

One or more target operations that should be invoked BEFORE a deployment to that target starts.

Optional beforePull

One or more target operations that should be invoked BEFORE a pullment from that target starts.

Optional beforeUpload

beforeUpload: string

The path to an (event) script, which is executed BEFORE a file is going to be uploaded.

Optional beforeUploadOptions

beforeUploadOptions: any

Options for the script defined in 'beforeUpload'.

Optional checkBeforeDeploy

checkBeforeDeploy: boolean

Check for newer files before a deploy operation starts or not.

Optional checkBeforePull

checkBeforePull: boolean

Check for older files before a pull operation starts or not.

Optional commands

Commands to execute.

Optional debug

debug: boolean

Show debug output or not.

Optional deleted

One or more target operations that should be invoked AFTER a deletion in that target has been done.

Optional deployed

One or more target operations that should be invoked AFTER a deployment to that target has been done.

Optional description

description: string

A description.

Optional dir

dir: string

The remote directory.

Optional encryptBy

encryptBy: string

The custom password algorithm to use.

Optional encryptWith

encryptWith: string

The password.

Optional hashAlgorithm

hashAlgorithm: string

The algorithm to use to verify the fingerprint of a host.

Optional hashes

hashes: string | string[]

One or more hashes to verify.

Optional hideIf

hideIf: string | string[]

A list of one or more package names that indicates if that target is hidden from GUI if one of the package(s) has been selected.

Optional host

host: string

The hostname

Optional if

if: string | string[]

One or more (JavaScript) conditions that check if that item is available or not.

Optional isHidden

isHidden: boolean

Is hidden or not.

Optional mappings

mappings: deploy_mappings.FolderMappings

Defines folder mappings.

Optional modes

modes: deploy_clients_sftp.SFTPFileModeSettings

Defines the modes for files, after they have been uploaded.

Optional name

name: string

The name.

Optional password

password: string

The password.

Optional platforms

platforms: string | string[]

One or more platform names, the object is available for.

Optional port

port: number

The custom TCP port.

Optional prepare

Operations which are executed even before the operations of 'beforeDeploy' and even if no file is going to be handled.

Optional privateKey

privateKey: string

Path to the private key file.

Optional privateKeyPassphrase

privateKeyPassphrase: string

The passphrase for the key file, if needed.

Optional pulled

One or more target operations that should be invoked AFTER a pullment from that target has been done.

Optional readyTimeout

readyTimeout: number

How long (in milliseconds) to wait for the SSH handshake to complete.

Optional showIf

showIf: string | string[]

A list of one or more package names that indicates if that target is only shown in GUI if one of the package(s) has been selected.

Optional supportsDeepDirectoryCreation

supportsDeepDirectoryCreation: boolean

Server supports deep directory creation or not.

Optional transformer

transformer: string

The path (or URI) to the transformer script.

Optional transformerOptions

transformerOptions: any

The options for the transformer script.

Optional tryKeyboard

tryKeyboard: boolean

Try keyboard-interactive user authentication if primary user authentication method fails.

Optional type

type: string

The type.

Optional uploaded

uploaded: string

The path to an (event) script, which is executed AFTER a file has been uploaded or tried to be uploaded.

Optional uploadedOptions

uploadedOptions: any

Options for the script defined in 'uploaded'.

Optional useFastGlob

useFastGlob: boolean

Use 'fast-glob' instead of 'node-glob' or not.

Optional user

user: string

The username.

Generated using TypeDoc