ffdc/plugins/scp_execution.py

#!/usr/bin/env python3


import os
import sys

# ---------Set sys.path for pluqin execution----------------------------------
# Absolute path to this plugin
abs_path = os.path.abspath(os.path.dirname(sys.argv[0]))
# full_path to plugins parent directory
full_path = abs_path.split("plugins")[0]
sys.path.append(full_path)
# Walk path and append to sys.path
for root, dirs, files in os.walk(full_path):
    for found_dir in dirs:
        sys.path.append(os.path.join(root, found_dir))

# ssh_utility is in ../lib
from ssh_utility import SSHRemoteclient  # NOQA


def scp_remote_file(
    hostname, username, password, port_ssh, filename, local_dir_path
):
    r"""
    Copy a file from a remote host to the local host using SCP.

    This function copies a file from a remote host to the local host using the
    SCP protocol. The function takes the remote host details (hostname,
    username, password), the filename with its full path on the remote host,
    and the local directory path as arguments.

    The function uses wildcards to support copying multiple files if needed.

    Parameters:
        hostname (str):       Name or IP address of the remote host.
        username (str):       User on the remote host with access to files.
        password (str):       Password for the user on the remote host.
        port_ssh (int):       SSH/SCP port value. By default, 22.
        filename (str):       Filename with full path on the remote host.
                              Can contain wildcards for multiple files.
        local_dir_path (str): Location to store the file on the local host.

    Returns:
        None
    """
    ssh_remoteclient = SSHRemoteclient(hostname, username, password, port_ssh)

    if ssh_remoteclient.ssh_remoteclient_login():
        # Obtain scp connection.
        ssh_remoteclient.scp_connection()
        if ssh_remoteclient.scpclient:
            if isinstance(filename, list):
                for each_file in filename:
                    ssh_remoteclient.scp_file_from_remote(
                        each_file, local_dir_path
                    )
            else:
                ssh_remoteclient.scp_file_from_remote(filename, local_dir_path)

    # Close ssh/scp session
    if ssh_remoteclient:
        ssh_remoteclient.ssh_remoteclient_disconnect()