{"id":226,"date":"2021-07-23T12:25:54","date_gmt":"2021-07-23T12:25:54","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/how-to-create-a-custom-transport-script-for-backups\/"},"modified":"2021-07-23T12:25:54","modified_gmt":"2021-07-23T12:25:54","slug":"how-to-create-a-custom-transport-script-for-backups","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/how-to-create-a-custom-transport-script-for-backups\/","title":{"rendered":"How to Create a Custom Transport Script for Backups"},"content":{"rendered":"<\/p>\n
\n
\n
\n

Valid for versions 82 through the latest version<\/em><\/p>\n<\/div>\n

\n

Version:<\/h4>\n

82<\/h4>\n<\/div><\/div>\n
\n

Overview<\/h2>\n
\n
Warning:<\/div>\n
\n

Only<\/strong> advanced users should create custom transport scripts. Other users can try one of WHM\u2019s other options:<\/p>\n

    \n
  • A local directory<\/li>\n
  • Amazon S3\u2122<\/li>\n
  • Backblaze B2<\/li>\n
  • FTP<\/li>\n
  • Google Drive\u2122<\/li>\n
  • Rsync<\/li>\n
  • S3 Compatible<\/li>\n
  • SFTP<\/li>\n
  • WebDAV<\/li>\n<\/ul><\/div>\n<\/div>\n

    The Backup Configuration<\/em> feature allows users to create a custom destination for their backups.<\/p>\n

    Create a custom transport script<\/h2>\n

    The custom transport script is a script that you must provide for each custom backup destination that you set up in WHM\u2019s Backup Configuration<\/em> interface (WHM >> Home >> Backups >> Backup Configuration<\/em>). You can enter the transport script\u2019s absolute path via the Script<\/em> setting for the Custom<\/em> destination type in the Additional Destinations<\/em> section.<\/p>\n

    Script operation<\/h3>\n

    The following rules affect how the script interacts with the system:<\/p>\n

      \n
    • The script runs once per command.<\/li>\n
    • The script cannot<\/strong> save state information between commands.<\/li>\n
    • The system does not<\/em> reuse the connection between commands. Instead, each time that the script runs, the system creates the connection to the remote custom destination, and then drops it after the script runs.<\/li>\n<\/ul>\n

      The system passes information to the script, through the command line, in the following order:<\/p>\n

        \n
      1. Command name.<\/li>\n
      2. Current directory.<\/li>\n
      3. Command specific parameters.<\/li>\n
      4. Host.<\/li>\n
      5. Username.<\/li>\n<\/ol>\n

        The system passes the password information to the script through the environment.<\/p>\n

        Script commands<\/h3>\n

        The script must implement the following commands:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
        Command<\/th>\nDescription<\/th>\nParameters<\/th>\n<\/tr>\n<\/thead>\n
        chdir<\/code><\/td>\nThis command changes directories on the remote destination. It is equivalent to the cd<\/code> command on the command line.<\/td>\n$path<\/code> \u2014 A file path.<\/td>\n<\/tr>\n
        delete<\/code><\/td>\nThis command deletes an individual file on the remote destination.<\/td>\n$path<\/code> \u2014 A file path.<\/td>\n<\/tr>\n
        get<\/code><\/td>\nThis command copies a remote file to a local destination.<\/td>\n\n
          \n
        • $dest_root_dir<\/code> \u2014 The remote directory.<\/li>\n
        • $dest_file<\/code> \u2014 The remote file name.<\/li>\n
        • $local_file<\/code> \u2014 The full path to the local file.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
        ls<\/code><\/td>\nThis command prints identical output to the ls -l<\/code> command.<\/td>\n$path<\/code> \u2014 A file path.<\/td>\n<\/tr>\n
        mkdir<\/code><\/td>\nThis command creates a directory on the remote destination.<\/td>\n$path<\/code> \u2014 A file path.<\/td>\n<\/tr>\n
        put<\/code><\/td>\nThis command copies a local file to a remote destination.<\/td>\n\n
          \n
        • $dest_root_dir<\/code> \u2014 The remote directory.<\/li>\n
        • $dest_file<\/code> \u2014 The remote file name.<\/li>\n
        • $local_file<\/code> \u2014 The full path to the local file.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
        rmdir<\/code><\/td>\nThis command deletes a directory on the remote destination. We strongly<\/strong> recommend that you verify the path that you plan to delete. If you pass the root directory (\/<\/code>) as the path to delete, your system will experience serious<\/strong> problems.<\/td>\n$path<\/code> \u2014 A file path.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        Backups run each of these commands individually while the system transports the backup file and validates the destination.<\/p>\n

        Your script should return any output to STDOUT<\/code> to return data to the user.<\/p>\n

        \n
        Note:<\/div>\n
        \n

        If the script fails, it prints the output to STDERR<\/code>. The system logs any data that the script returns to STDERR<\/code> as part of the failure.<\/p>\n<\/p><\/div>\n<\/div>\n

        Templates<\/h2>\n

        You can use the \/usr\/local\/cpanel\/scripts\/custom_backup_destination.pl.skeleton<\/code> script in cPanel & WHM as a template to create your own custom_backup_destination.pl<\/code> script. For a sample backup transport script, see the \/usr\/local\/cpanel\/scripts\/custom_backup_destination.pl.sample<\/code> script.<\/p>\n

        \n

        Click to view…<\/p>\n

        \n
        \n
        \n
        \n\n\n
        \n
          1\n<\/span>  2\n<\/span>  3\n<\/span>  4\n<\/span>  5\n<\/span>  6\n<\/span>  7\n<\/span>  8\n<\/span>  9\n<\/span> 10\n<\/span> 11\n<\/span> 12\n<\/span> 13\n<\/span> 14\n<\/span> 15\n<\/span> 16\n<\/span> 17\n<\/span> 18\n<\/span> 19\n<\/span> 20\n<\/span> 21\n<\/span> 22\n<\/span> 23\n<\/span> 24\n<\/span> 25\n<\/span> 26\n<\/span> 27\n<\/span> 28\n<\/span> 29\n<\/span> 30\n<\/span> 31\n<\/span> 32\n<\/span> 33\n<\/span> 34\n<\/span> 35\n<\/span> 36\n<\/span> 37\n<\/span> 38\n<\/span> 39\n<\/span> 40\n<\/span> 41\n<\/span> 42\n<\/span> 43\n<\/span> 44\n<\/span> 45\n<\/span> 46\n<\/span> 47\n<\/span> 48\n<\/span> 49\n<\/span> 50\n<\/span> 51\n<\/span> 52\n<\/span> 53\n<\/span> 54\n<\/span> 55\n<\/span> 56\n<\/span> 57\n<\/span> 58\n<\/span> 59\n<\/span> 60\n<\/span> 61\n<\/span> 62\n<\/span> 63\n<\/span> 64\n<\/span> 65\n<\/span> 66\n<\/span> 67\n<\/span> 68\n<\/span> 69\n<\/span> 70\n<\/span> 71\n<\/span> 72\n<\/span> 73\n<\/span> 74\n<\/span> 75\n<\/span> 76\n<\/span> 77\n<\/span> 78\n<\/span> 79\n<\/span> 80\n<\/span> 81\n<\/span> 82\n<\/span> 83\n<\/span> 84\n<\/span> 85\n<\/span> 86\n<\/span> 87\n<\/span> 88\n<\/span> 89\n<\/span> 90\n<\/span> 91\n<\/span> 92\n<\/span> 93\n<\/span> 94\n<\/span> 95\n<\/span> 96\n<\/span> 97\n<\/span> 98\n<\/span> 99\n<\/span>100\n<\/span>101\n<\/span>102\n<\/span>103\n<\/span>104\n<\/span>105\n<\/span>106\n<\/span>107\n<\/span>108\n<\/span>109\n<\/span>110\n<\/span>111\n<\/span>112\n<\/span>113\n<\/span>114\n<\/span>115\n<\/span>116\n<\/span>117\n<\/span>118\n<\/span>119\n<\/span>120\n<\/span>121\n<\/span>122\n<\/span>123\n<\/span>124\n<\/span>125\n<\/span><\/code><\/pre>\n<\/td>\n
        		\n
        #!\/usr\/local\/cpanel\/3rdparty\/bin\/perl<\/span>\n\n# cpanel - scripts\/custom_backup_destination.pl.skeleton      Copyright 2021 cPanel, L.L.C<\/span>\n#                                                           All rights Reserved.<\/span>\n# copyright@cpanel.net                                         http:\/\/cpanel.net<\/span>\n# This code is subject to the cPanel license. Unauthorized copying is prohibited<\/span>\n\nuse<\/span> strict;\nuse<\/span> warnings;\n\n# These are the commands that a custom destination script must process<\/span>\nmy<\/span> %commands =<\/span> (\n    put    =><\/span> &<\/span>my_put,\n    get    =><\/span> &<\/span>my_get,\n    ls     =><\/span> &<\/span>my_ls,\n    mkdir  =><\/span> &<\/span>my_mkdir,\n    chdir  =><\/span> &<\/span>my_chdir,\n    rmdir  =><\/span> &<\/span>my_rmdir,\n    delete =><\/span> &<\/span>my_delete,\n);\n\n# There must be at least the command and the local directory<\/span>\nusage() if<\/span> ( @ARGV <<\/span> 2<\/span> );\n\n#<\/span>\n# The command line arguments passed to the script will be in the following order:<\/span>\n# command, local_directory, command arguments, and optionally, host, user password<\/span>\n# The local directory is passed in so we know from which directory to run the command<\/span>\n# We need to pass this in each time since we start the script fresh for each command<\/span>\n#<\/span>\nmy<\/span> ( $cmd, $local_dir, @args ) =<\/span> @ARGV;\n\n# complain if the command does not exist<\/span>\nusage() unless<\/span> exists $commands{$cmd};\n\n# Run our command<\/span>\n$commands{$cmd}-><\/span>(@args);\n\n#<\/span>\n# This script should only really be executed by the custom backup destination type<\/span>\n# If someone executes it directly out of curiosity, give them usage info<\/span>\n#<\/span>\nsub<\/span> usage<\/span> {\n    my<\/span> @cmds =<\/span> sort keys %commands;\n    print<\/span> STDERR \"This script is for implementing a custom backup destinationn\"<\/span>;\n    print<\/span> STDERR \"It requires the following arguments:  cmd, local_dir, cmd_argsn\"<\/span>;\n    print<\/span> STDERR \"These are the valid commands:  @cmdsn\"<\/span>;\n    exit 1<\/span>;\n}\n\n#<\/span>\n# This portion contains the implementations for the various commands<\/span>\n# that the script needs to support in order to implement a custom destination<\/span>\n#<\/span>\n\n#<\/span>\n# Copy a local file to a remote destination<\/span>\n#<\/span>\nsub<\/span> my_put<\/span> {\n    my<\/span> ( $local, $remote, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}\n\n#<\/span>\n# Copy a remote file to a local destination<\/span>\n#<\/span>\nsub<\/span> my_get<\/span> {\n    my<\/span> ( $remote, $local, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}\n\n#<\/span>\n# Print out the results of doing an ls operation<\/span>\n# The calling program will expect the data to be<\/span>\n# in the format supplied by 'ls -l' and have it<\/span>\n# printed to STDOUT<\/span>\n#<\/span>\nsub<\/span> my_ls<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}\n\n#<\/span>\n# Create a directory on the remote destination<\/span>\n#<\/span>\nsub<\/span> my_mkdir<\/span> {\n    my<\/span> ( $path, $recurse, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}\n\n#<\/span>\n# Change into a directory on the remote destination<\/span>\n# This does not have the same meaning as it normally would since the script<\/span>\n# is run anew for each command call.<\/span>\n# This needs to do the operation to ensure it doesn't fail<\/span>\n# then print the new resulting directory that the calling program<\/span>\n# will pass in as the local directory for subsequent calls<\/span>\n#<\/span>\nsub<\/span> my_chdir<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}\n\n#<\/span>\n# Recursively delete a directory on the remote destination<\/span>\n#<\/span>\nsub<\/span> my_rmdir<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}\n\n#<\/span>\n# Delete an individual file on the remote destination<\/span>\n#<\/span>\nsub<\/span> my_delete<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div><\/div>\n<\/p><\/div>\n<\/div>\n
        \n
                View the custom_backup_destination.pl.sample script…<\/p>\n
        \n
        \n
        \n
        \n\n\n
        \n
          1\n<\/span>  2\n<\/span>  3\n<\/span>  4\n<\/span>  5\n<\/span>  6\n<\/span>  7\n<\/span>  8\n<\/span>  9\n<\/span> 10\n<\/span> 11\n<\/span> 12\n<\/span> 13\n<\/span> 14\n<\/span> 15\n<\/span> 16\n<\/span> 17\n<\/span> 18\n<\/span> 19\n<\/span> 20\n<\/span> 21\n<\/span> 22\n<\/span> 23\n<\/span> 24\n<\/span> 25\n<\/span> 26\n<\/span> 27\n<\/span> 28\n<\/span> 29\n<\/span> 30\n<\/span> 31\n<\/span> 32\n<\/span> 33\n<\/span> 34\n<\/span> 35\n<\/span> 36\n<\/span> 37\n<\/span> 38\n<\/span> 39\n<\/span> 40\n<\/span> 41\n<\/span> 42\n<\/span> 43\n<\/span> 44\n<\/span> 45\n<\/span> 46\n<\/span> 47\n<\/span> 48\n<\/span> 49\n<\/span> 50\n<\/span> 51\n<\/span> 52\n<\/span> 53\n<\/span> 54\n<\/span> 55\n<\/span> 56\n<\/span> 57\n<\/span> 58\n<\/span> 59\n<\/span> 60\n<\/span> 61\n<\/span> 62\n<\/span> 63\n<\/span> 64\n<\/span> 65\n<\/span> 66\n<\/span> 67\n<\/span> 68\n<\/span> 69\n<\/span> 70\n<\/span> 71\n<\/span> 72\n<\/span> 73\n<\/span> 74\n<\/span> 75\n<\/span> 76\n<\/span> 77\n<\/span> 78\n<\/span> 79\n<\/span> 80\n<\/span> 81\n<\/span> 82\n<\/span> 83\n<\/span> 84\n<\/span> 85\n<\/span> 86\n<\/span> 87\n<\/span> 88\n<\/span> 89\n<\/span> 90\n<\/span> 91\n<\/span> 92\n<\/span> 93\n<\/span> 94\n<\/span> 95\n<\/span> 96\n<\/span> 97\n<\/span> 98\n<\/span> 99\n<\/span>100\n<\/span>101\n<\/span>102\n<\/span>103\n<\/span>104\n<\/span>105\n<\/span>106\n<\/span>107\n<\/span>108\n<\/span>109\n<\/span>110\n<\/span>111\n<\/span>112\n<\/span>113\n<\/span>114\n<\/span>115\n<\/span>116\n<\/span>117\n<\/span>118\n<\/span>119\n<\/span>120\n<\/span>121\n<\/span>122\n<\/span>123\n<\/span>124\n<\/span>125\n<\/span>126\n<\/span>127\n<\/span>128\n<\/span>129\n<\/span>130\n<\/span>131\n<\/span>132\n<\/span>133\n<\/span>134\n<\/span>135\n<\/span>136\n<\/span>137\n<\/span>138\n<\/span>139\n<\/span>140\n<\/span>141\n<\/span>142\n<\/span>143\n<\/span>144\n<\/span>145\n<\/span>146\n<\/span>147\n<\/span>148\n<\/span>149\n<\/span>150\n<\/span>151\n<\/span>152\n<\/span>153\n<\/span>154\n<\/span>155\n<\/span>156\n<\/span>157\n<\/span>158\n<\/span>159\n<\/span>160\n<\/span>161\n<\/span>162\n<\/span>163\n<\/span>164\n<\/span>165\n<\/span>166\n<\/span>167\n<\/span>168\n<\/span>169\n<\/span>170\n<\/span>171\n<\/span>172\n<\/span>173\n<\/span>174\n<\/span>175\n<\/span>176\n<\/span>177\n<\/span>178\n<\/span>179\n<\/span>180\n<\/span>181\n<\/span>182\n<\/span>183\n<\/span>184\n<\/span>185\n<\/span>186\n<\/span>187\n<\/span>188\n<\/span>189\n<\/span>190\n<\/span>191\n<\/span>192\n<\/span>193\n<\/span>194\n<\/span>195\n<\/span>196\n<\/span>197\n<\/span>198\n<\/span>199\n<\/span>200\n<\/span>201\n<\/span>202\n<\/span>203\n<\/span>204\n<\/span>205\n<\/span>206\n<\/span>207\n<\/span>208\n<\/span>209\n<\/span>210\n<\/span>211\n<\/span>212\n<\/span>213\n<\/span>214\n<\/span>215\n<\/span><\/code><\/pre>\n<\/td>\n
        		\n
        #!\/usr\/local\/cpanel\/3rdparty\/bin\/perl<\/span>\n\n# cpanel - scripts\/custom_backup_destination.pl.sample      Copyright 2013 cPanel, L.L.C<\/span>\n#                                                           All rights Reserved.<\/span>\n# copyright@cpanel.net                                         http:\/\/cpanel.net<\/span>\n# This code is subject to the cPanel license. Unauthorized copying is prohibited<\/span>\n\nuse<\/span> strict;\nuse<\/span> warnings;\nuse<\/span> Cwd qw(getcwd abs_path)<\/span>;\nuse<\/span> File::Spec;\nuse<\/span> File::Copy;\nuse<\/span> File::Path qw(make_path remove_tree)<\/span>;\nuse<\/span> autodie qw(:all copy)<\/span>;\n\n# These are the commands that a custom destination script must process<\/span>\nmy<\/span> %commands =<\/span> (\n    put    =><\/span> &<\/span>my_put,\n    get    =><\/span> &<\/span>my_get,\n    ls     =><\/span> &<\/span>my_ls,\n    mkdir  =><\/span> &<\/span>my_mkdir,\n    chdir  =><\/span> &<\/span>my_chdir,\n    rmdir  =><\/span> &<\/span>my_rmdir,\n    delete =><\/span> &<\/span>my_delete,\n);\n\n# There must be at least the command and the local directory<\/span>\nusage() if<\/span> ( @ARGV <<\/span> 2<\/span> );\n\n#<\/span>\n# The command line arguments passed to the script will be in the following order:<\/span>\n# command, local_directory, command arguments, and optionally, host and user<\/span>\n# The local directory is passed in so we know from which directory to run the command<\/span>\n# we need to pass this in each time since we start the script fresh for each command<\/span>\n#<\/span>\nmy<\/span> ( $cmd, $local_dir, @args ) =<\/span> @ARGV;\n\n# complain if the command does not exist<\/span>\nusage() unless<\/span> exists $commands{$cmd};\n\n# For this example transport, we are going to simply copy everything under this directory<\/span>\nmy<\/span> $dest_root_dir =<\/span> '\/custom_transport_demo'<\/span>;\nmkdir $dest_root_dir unless<\/span> -<\/span>d $dest_root_dir;\n\n# Step into the local directory<\/span>\n# This will be under the directory that we have as the file destination<\/span>\n$local_dir =<\/span> File::Spec-><\/span>catdir( $dest_root_dir, $local_dir );\nmake_path($local_dir) unless<\/span> -<\/span>d $local_dir;\nchdir $local_dir;\n\n# Run our command<\/span>\n$commands{$cmd}-><\/span>(@args);\n\n#<\/span>\n# This script should only really be executed by the custom backup destination type<\/span>\n# If someone executes it directly out of curiosity, give them usage info<\/span>\n#<\/span>\nsub<\/span> usage<\/span> {\n    my<\/span> @cmds =<\/span> sort keys %commands;\n    print<\/span> STDERR \"This script is for implementing a custom backup destinationn\"<\/span>;\n    print<\/span> STDERR \"It requires the following arguments:  cmd, local_dir, cmd_argsn\"<\/span>;\n    print<\/span> STDERR \"These are the valid commands:  @cmdsn\"<\/span>;\n    exit 1<\/span>;\n}\n\n#<\/span>\n# Convert a path to be under our destination directory<\/span>\n# Absolute paths will be directly under it,<\/span>\n# relative paths will be relative to the local directory<\/span>\n#<\/span>\nsub<\/span> convert_path<\/span> {\n    my<\/span> ($path) =<\/span> @_;\n\n    if<\/span> ( $path =~<\/span> m|^\/|<\/span> ) {\n        $path =<\/span> File::Spec-><\/span>catdir( $dest_root_dir, $path );\n    }\n    else<\/span> {\n        $path =<\/span> File::Spec-><\/span>catdir( $local_dir, $path );\n    }\n\n    return<\/span> $path;\n}\n\n#<\/span>\n# Convert a full path to the path under the the directory<\/span>\n# where we copy all the files<\/span>\n#<\/span>\nsub<\/span> get_sub_directory<\/span> {\n    my<\/span> ($path) =<\/span> @_;\n\n    # The first part will be the destination root directory,<\/span>\n    # Remove that part of the path and we will have the subdirectory<\/span>\n    $path =~<\/span> s|^<\/span>$dest_root_dir||<\/span>;\n\n    return<\/span> $path;\n}\n\n#<\/span>\n# This portion contains the implementations for the various commands<\/span>\n# that the script needs to support in order to implement a custom destination<\/span>\n#<\/span>\n\n#<\/span>\n# Copy a local file to a remote destination<\/span>\n#<\/span>\nsub<\/span> my_put<\/span> {\n    my<\/span> ( $local, $remote, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $remote =<\/span> convert_path($remote);\n\n    # Make sure the full destination directory exists<\/span>\n    my<\/span> ( undef, $dir, undef ) =<\/span> File::Spec-><\/span>splitpath($remote);\n    make_path($dir) unless<\/span> ( $dir and<\/span> -<\/span>d $dir );\n    copy( $local, $remote );\n    return<\/span>;\n}\n\n#<\/span>\n# Copy a remote file to a local destination<\/span>\n#<\/span>\nsub<\/span> my_get<\/span> {\n    my<\/span> ( $remote, $local, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $remote =<\/span> convert_path($remote);\n\n    copy( $remote, $local );\n    return<\/span>;\n}\n\n#<\/span>\n# Print out the results of doing an ls operation<\/span>\n# The calling program will expect the data to be<\/span>\n# in the format supplied by 'ls -l' and have it<\/span>\n# printed to STDOUT<\/span>\n#<\/span>\nsub<\/span> my_ls<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    # Cheesy, but this is a demo<\/span>\n    my<\/span> $ls =<\/span> `ls -al $path`<\/span>;\n\n    # Remove the annoying 'total' line<\/span>\n    $ls =~<\/span> s|^<\/span>total[^<\/span>n]*<\/span>n||<\/span>;\n\n    print<\/span> $ls;\n    return<\/span>;\n}\n\n#<\/span>\n# Create a directory on the remote destination<\/span>\n#<\/span>\nsub<\/span> my_mkdir<\/span> {\n    my<\/span> ( $path, $recurse, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    make_path($path);\n\n    die \"Failed to create $path\"<\/span> unless<\/span> -<\/span>d $path;\n    return<\/span>;\n}\n\n#<\/span>\n# Change into a directory on the remote destination<\/span>\n# This does not have the same meaning as it normally would since the script<\/span>\n# is run anew for each command call.<\/span>\n# This needs to do the operation to ensure it doesn't fail<\/span>\n# then print the new resulting directory that the calling program<\/span>\n# will pass in as the local directory for subsequent calls<\/span>\n#<\/span>\n\nsub<\/span> my_chdir<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n    chdir $path;\n\n    print<\/span> get_sub_directory( getcwd() ) .<\/span> \"n\"<\/span>;\n    return<\/span>;\n}\n\n#<\/span>\n# Recursively delete a directory on the remote destination<\/span>\n#<\/span>\nsub<\/span> my_rmdir<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    remove_tree($path);\n\n    die \"$path still exists\"<\/span> if<\/span> -<\/span>d $path;\n    return<\/span>;\n}\n\n#<\/span>\n# Delete an individual file on the remote destination<\/span>\n#<\/span>\nsub<\/span> my_delete<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    unlink $path;\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div><\/div>\n<\/p><\/div>\n<\/div>\n
        The system passes most variables as arguments to the command line. If your script does not<\/strong> pass one of the hardcoded arguments to the core functions, the system will display all valid arguments in the global %commands<\/code> hash.<\/p>\n
        Code examples<\/h2>\n
        Use statements<\/h4>\n
        Begin the script with the standard use<\/code> statements. Include any modules that you may need for your transport:<\/p>\n
        \n
        \n\n\n
        \n
        1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span>6\n<\/span>7\n<\/span><\/code><\/pre>\n<\/td>\n
        		\n
        use<\/span> strict;\nuse<\/span> warnings;\nuse<\/span> Cwd qw(getcwd abs_path)<\/span>;\nuse<\/span> File::Spec;\nuse<\/span> File::Copy;\nuse<\/span> File::Path qw(make_path remove_tree)<\/span>;\nuse<\/span> autodie qw(:all copy)<\/span>;<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
        The %commands list<\/h4>\n
        \n
        Note:<\/div>\n
        \n
        The script can only process the following commands.<\/p>\n<\/p><\/div>\n<\/div>\n
        \n
        \n\n\n
        \n
        1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span>6\n<\/span>7\n<\/span>8\n<\/span>9\n<\/span><\/code><\/pre>\n<\/td>\n
        		\n
        my<\/span> %commands =<\/span> (\n    put    =><\/span> &<\/span>my_put,\n    get    =><\/span> &<\/span>my_get,\n    ls     =><\/span> &<\/span>my_ls,\n    mkdir  =><\/span> &<\/span>my_mkdir,\n    chdir  =><\/span> &<\/span>my_chdir,\n    rmdir  =><\/span> &<\/span>my_rmdir,\n    delete =><\/span> &<\/span>my_delete,\n);<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
        The %command subroutines<\/h3>\n
        Every call to the script begins with a command and a local directory. You must<\/strong> pass the command line arguments in the following order:<\/p>\n
          \n
        • $cmd<\/code> \u2014 The command.<\/li>\n
        • $local_dir<\/code> \u2014 The local directory.<\/li>\n
        • @args<\/code> \u2014 The command\u2019s arguments.<\/li>\n
        • $host<\/code> \u2014 Optional. The remote destination\u2019s hostname or IP address.<\/li>\n
        • $user<\/code> \u2014 Optional. The remote destination\u2019s account username.<\/li>\n
        • $password<\/code> \u2014 Optional. The remote destination\u2019s password.<\/li>\n<\/ul>\n
          Use the arguments that are specific to each of the commands and variables.<\/p>\n
          \n
          Note:<\/div>\n
          \n
            \n
          • You should only include the optional $host<\/code>, $user<\/code>, and $password<\/code> values if you configured them in the transport.<\/li>\n
          • If you include the $password<\/code> value, you must<\/strong> use the ENV<\/code> hash.<\/li>\n
          • You must<\/strong> include the $local_dir<\/code> variable in every command subroutine that you create because the script calls each command individually.<\/li>\n<\/ul><\/div>\n<\/div>\n
            \n
            \n\n\n
            \n
            1\n<\/span>2\n<\/span>3\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            my<\/span> ( $cmd, $local_dir, @args, $host, $user ) =<\/span> @ARGV;\nmy<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n usage() unless<\/span> exists $commands{$cmd};<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The put functions<\/h3>\n
            The put<\/code> function directs the script to upload or copy a local file to a remote destination. This function works similarly to the FTP put<\/code> command.<\/p>\n
            \n
            Note:<\/div>\n
            \n
            For more robust transports, we strongly<\/strong> recommend that you perform several error checks for each step to ensure that the system reports all errors back properly.<\/p>\n<\/p><\/div>\n<\/div>\n
            \n
            \n\n\n
            \n
             1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span>11\n<\/span>12\n<\/span>13\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_put<\/span> {\n    my<\/span> ( $local, $remote, $host, $user ) =<\/span> @_;   # Required argument order<\/span>\n\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};     # Enclose the password in the ENV hash<\/span>\n\n    $remote =<\/span> convert_path($remote);     # the remote file's variable<\/span>\n\n    my<\/span> ( undef, $dir, undef ) =<\/span> File::Spec-><\/span>splitpath($remote); # Make sure the full destination directory exists<\/span>\n    make_path($dir) unless<\/span> ( $dir and<\/span> -<\/span>d $dir );\n\n    copy( $local, $remote ); # copy the local file to the remote file<\/span>\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The get function<\/h3>\n
            The get<\/code> function directs the script to download or retrieve a local file from a remote destination. This function works similarly to the FTP get<\/code> command.<\/p>\n
            \n
            \n\n\n
            \n
            1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span>6\n<\/span>7\n<\/span>8\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_get<\/span> {\n    my<\/span> ( $remote, $local, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n    $remote =<\/span> convert_path($remote);\n\n    copy( $remote, $local );\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The ls function<\/h3>\n
            The ls<\/code> function pulls the listing of a remote file or directory, similar to FTP or a local ls<\/code> argument on the command line.<\/p>\n
            \n
            \n\n\n
            \n
             1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span>11\n<\/span>12\n<\/span>13\n<\/span>14\n<\/span>15\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_ls<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    my<\/span> $ls =<\/span> `ls -al $path`<\/span>;\n\n    # Remove the annoying 'total' line<\/span>\n    $ls =~<\/span> s|^<\/span>total[^<\/span>n]*<\/span>n||<\/span>;\n\n    print<\/span> $ls;\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The mkdir function<\/h3>\n
            The mkdir<\/code> function ensures that a directory exists on the remote machine and that the system uploads the backup to a real path.<\/p>\n
            \n
            Note:<\/div>\n
            \n
            Not all transports use a feature like the mkdir<\/code> function, however, you must include this function in the script.<\/p>\n<\/p><\/div>\n<\/div>\n
            \n
            \n\n\n
            \n
             1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span>11\n<\/span>12\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_mkdir<\/span> {\n    my<\/span> ( $path, $recurse, $host, $user ) =<\/span> @_;\n\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    make_path($path);\n\n    die \"Failed to create $path\"<\/span> unless<\/span> -<\/span>d $path;\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The chdir function<\/h3>\n
            The chdir<\/code> function allows you to store the working directory and keep the session information between operations.<\/p>\n
            \n
            Note:<\/div>\n
            \n
            Because this is a custom transport script, the system will not<\/strong> keep session information between operations by a single active process.<\/p>\n<\/p><\/div>\n<\/div>\n
            \n
            \n\n\n
            \n
             1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_chdir<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n    chdir $path;\n\n    print<\/span> get_sub_directory( getcwd() ) .<\/span> \"n\"<\/span>;\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The rmdir function<\/h3>\n
            The rmdir<\/code> function removes a directory and recursively deletes everything below the given directory. Based on which transport you use, you may need to remove all the files and directories below the given directory before the system can execute this function.<\/p>\n
            \n
            Warning:<\/div>\n
            \n
            We strongly<\/strong> recommend that you verify the path that you plan to recursively delete. If you pass the root (\/<\/code>) directory as the path to delete, your system will experience serious issues.<\/p>\n<\/p><\/div>\n<\/div>\n
            \n
            \n\n\n
            \n
             1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span>11\n<\/span>12\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_rmdir<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    remove_tree($path);\n\n    die \"$path still exists\"<\/span> if<\/span> -<\/span>d $path;\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            The delete function<\/h3>\n
            The delete<\/code> function deletes a single file.<\/p>\n
            \n
            Note:<\/div>\n
            \n
            We strongly<\/strong> recommend that you ensure the path that you use, relative or full, is appropriate for the transport. If your transport does not<\/strong> provide an error status check, use the ls<\/code> function on the file to ensure the system deleted it.<\/p>\n<\/p><\/div>\n<\/div>\n
            \n
            \n\n\n
            \n
             1\n<\/span> 2\n<\/span> 3\n<\/span> 4\n<\/span> 5\n<\/span> 6\n<\/span> 7\n<\/span> 8\n<\/span> 9\n<\/span>10\n<\/span><\/code><\/pre>\n<\/td>\n
            		\n
            sub<\/span> my_delete<\/span> {\n    my<\/span> ( $path, $host, $user ) =<\/span> @_;\n\n    my<\/span> $password =<\/span> $ENV{'PASSWORD'<\/span>};\n\n    $path =<\/span> convert_path($path);\n\n    unlink $path;\n    return<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
            Basic error check<\/h3>\n
            \n
            Note:<\/div>\n
            \n
            We strongly<\/strong> recommend that you:<\/p>\n
              \n
            • Perform a basic error check to ensure that the script receives the proper arguments when the system calls it. At a minimum, you must<\/strong> pass the usage() if ( @ARGV < 2 )<\/code> command.<\/li>\n
            • Construct a built-in description of what the script is, what it does, and its purpose so that you can identify the script.<\/li>\n<\/ul><\/div>\n<\/div>\n
              \n
              \n\n\n
              \n
              1\n<\/span>2\n<\/span><\/code><\/pre>\n<\/td>\n
              		\n
              sub<\/span> my_delete<\/span> {\nusage() if<\/span> ( @ARGV <<\/span> 2<\/span> );<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
              \n
              \n\n\n
              \n
              1\n<\/span>2\n<\/span>3\n<\/span>4\n<\/span>5\n<\/span>6\n<\/span>7\n<\/span><\/code><\/pre>\n<\/td>\n
              		\n
              sub<\/span> usage<\/span> {\n    my<\/span> @cmds =<\/span> sort keys %commands;\n    print<\/span> STDERR \"This script is for implementing a custom backup destinationn\"<\/span>;\n    print<\/span> STDERR \"It requires the following arguments:  cmd, local_dir, cmd_argsn\"<\/span>;\n    print<\/span> STDERR \"These are the valid commands:  @cmdsn\"<\/span>;\n    exit 1<\/span>;\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/table>\n<\/div>\n<\/div>\n
              The $cmd command<\/h3>\n
              Use the %command<\/code> hash to call each command\u2019s specific code block.<\/p>\n
              \n
              $commands{$cmd}-><\/span>(@args);<\/code><\/pre>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
              Valid for versions 82 through the latest version Version: 82 Overview Warning: Only advanced users should create custom transport scripts. Other users can try one of WHM\u2019s other options: A local directory Amazon S3\u2122 Backblaze B2 FTP Google Drive\u2122 Rsync S3 Compatible SFTP WebDAV The Backup Configuration feature allows users to create a custom destination …<\/p>\n","protected":false},"author":1,"featured_media":227,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/226"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=226"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/226\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/227"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=226"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=226"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=226"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}