Ações SFTP

As ações SFTP permitem que o Marvin interaja com servidores de arquivos SFTP.

Ações

sftp.change_dir

Altere o diretório atual no SFTP

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

directory - Caminho para o novo diretório. Este valor pode ser o caminho relativo ou completo para a nova pasta

Retorna:

current_folder - Caminho para a nova pasta selecionada

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.change_dir($sftp, '../newFolder')
sftp.change_dir($sftp, '/base_path/newFolder')

sftp.chdir

Altere o diretório atual no SFTP

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

directory - Caminho para o novo diretório. Este valor pode ser o caminho relativo ou completo para a nova pasta

Retorna:

current_folder - Caminho para a nova pasta selecionada

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.chdir($sftp, '../newFolder')
sftp.chdir($sftp, '/base_path/newFolder')

sftp.close

Fecha a conexão com o servidor SFTP

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

Retorna:

sftp - Será deletado de Marvin Vars

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.close($sftp)

sftp.create_folder

Cria uma nova pasta no servidor SFTP.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path - Caminho completo para a criação da pasta.

mode (opcional)- Modo de acesso a arquivo para nova pasta (padrão=777)

Retorna:

Esta ação não dá retorno

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.create_folder($sftp, '/base_folder/newFolder/')

sftp.connect

Abra uma nova conexão com o servidor SFTP

Parâmetros:

host - host do servidor SFTP

username - nome de usuário para conectar no servidor SFTP

password (opcional)- Senha para conectar no Servidor SFTP, se for necessário senha para conectar (padrão=sem senha)

port (opcional)- Porta do servidor SFTP para conexão (padrão=22)

default_path (opcional)- Caminho onde o cliente SFTP deve estar após a conexão (default=root)

private_key (opcional)- Caminho para a chave privada usada para conectar (padrão=nenhuma chave privada necessária)

private_key_pass=None - Senha para a chave privada usada para conectar (padrão=nenhuma senha de chave privada necessária)

Retorna:

sftp - cliente SFTP

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.connect('test.rebex.net', 'demo', 'password', 22)

sftp.current_folder

Retorna o caminho da pasta atual.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

Retorna:

current_folder - Caminho para a nova pasta selecionada

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.current_folder($sftp)
prompt.alert($current_folder)

sftp.delete

Exclui o arquivo ou pasta fornecido

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path - Caminho para o arquivo ou pasta a ser excluído.

Retorna:

Esta ação não dá retorno

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.delete($sftp, '../newFolder/my-file.txt')

sftp.download

Baixa um arquivo do servidor SFTP.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path - Caminho para o arquivo ou pasta a ser excluído.

local_path - Caminho para a máquina local, onde o arquivo deve ser salvo

Dica

Não se esqueça de incluir o nome do arquivo em local_path

Retorna:

download_path - Caminho local para o arquivo baixado

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.download($sftp, 'readme.txt', 'tests/sftp_download.txt')

sftp.file_exists

Verifique se existe um arquivo no servidor SFTP.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path - Caminho remoto para o arquivo

Retorna:

exists - True se o arquivo existir no servidor False se não existir

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.file_exists($sftp, '/base_path/newFolder/my-file.txt')

sftp.folder_exists

Verifique se existe uma pasta no servidor SFTP.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path - Caminho remoto para a pasta

Retorna:

exists - True se a pasta existir no servidor False se não existir

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.folder_exists($sftp, '/base_path/newFolder')

sftp.list

Liste todos os arquivos e pastas no caminho atual ou no caminho remoto fornecido.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path (opcional)- Caminho remoto para a pasta cujos arquivos e pastas devem ser listados (padrão=caminho atual)

Retorna:

items - Nome de todos os arquivos e pastas dentro do caminho atual ou dado remote_path

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.list($sftp)
para item em $itens:
    prompt.alert(item)

sftp.list($sftp, '/base_path/newFolder')
para item em $itens:
    prompt.alert(item)

sftp.list_files

Liste todos os arquivos no caminho atual ou no caminho remoto fornecido.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path (opcional)- Caminho remoto para a pasta cujos arquivos devem ser listados (padrão=caminho atual)

Retorna:

files - Nome de todos os arquivos dentro do caminho atual ou dado remote_path

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.list_files($sftp)
para item em $files:
    prompt.alert(item)

sftp.list_files($sftp, '/base_path/newFolder')
para item em $files:
    prompt.alert(item)

sftp.list_folders

Liste todas as pastas no caminho atual ou no caminho remoto fornecido.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

remote_path (opcional)- Caminho remoto para a pasta cujas pastas devem ser listadas (padrão=caminho atual)

Retorna:

folders - Nome de todas as pastas dentro do caminho atual ou dado remote_path

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.list_folders($sftp)
para item em $folders:
    prompt.alert(item)

sftp.list_folders($sftp, '/base_path/newFolder')
para item em $folders:
    prompt.alert(item)

sftp.upload

Carrega um arquivo local para o servidor SFTP na pasta atual.

Parâmetros:

sftp - cliente SFTP criado por sftp.connect

local_path - Caminho local para o arquivo a ser carregado

Retorna:

Esta ação dada o retorno

Exceções:

Esta ação não dá exceções

Exemplo de uso

script.mvn

sftp.upload($sftp, 'c:/Temp/meu-arquivo.txt')