How to Use SCP (put) Command in Configuration Jobs

You can use the Configuration Jobs feature of NetScaler MAS to create configuration jobs, send email notifications, and check execution logs of the jobs created. A job is a set of configuration commands that you can create and run on a single managed instance or on multiple managed instances. For example, you can use configuration jobs for device upgrades.

Configuration jobs in NetScaler MAS use Secure Shell (SSH) commands to configure instances, and you can configure a configuration job to use secure copy (SCP) to securely transfer files. SCP is based on the SSH protocol. One of the SCP commands that you can include in a configuration job is the “put” command. You can use the “put” command in configuration jobs to upload or transfer one or more files stored in a local directory on your system to NetScaler MAS and then to a directory on the NetScaler instance or instances.

Note: The file is uploaded to NetScaler MAS and it is later copied (put) to the selected NetScaler instances. The uploaded file is stored in NetScaler MAS and is deleted only when the job is deleted. This is necessary for jobs scheduled to execute at a later time.

The command has the following syntax:

put <local_filename> <remote_path/remote_filename>

where,

<local_filename> is the name of the local file to be uploaded.

<remote_path/ remote_filename> is the path to a remote directory, and the name to assign to the file when it is copied to that directory.

While creating the configuration job, you can convert the local and remote file name parameters into variables. This lets you assign different files to these parameters for the same set of NetScaler instances every time you execute the job. Also, when you use a file at multiple places in a job and if you want to rename the file, you can redefine the variable instead of changing the file name at all places.

To use the put command to upload files in a configuration job:

  1. In NetScaler MAS, navigate to Networks > Configuration Jobs.

  2. On the Jobs page, click Create Job.

  3. On the Create Job page, enter the name of the job in the Job name field, and in the Configuration Editor pane, enter the “put” command.

    For example, if you want to create a configuration job that copies a SSL certificate file saved on your local system to multiple NetScaler instances, you can add a “put” command that uses a variable instead of the name of a particular file, and define the variable type as “file”.

    put ssl-file /nsconfig/ssl-file
    

    In this example,

    • ssl-file - This is the name of the file that needs to be uploaded in the NetScaler instance.

    • /nsconfig/ssl-file - This is the destination folder on the instance where the ssl-file will be put after the execution of the task.

  4. In the command that you just entered, select the file name that you want to convert to a variable, and then click Convert to Variable, as shown in the following figure.

    localized image

  5. Verify that the file name has been enclosed by dollar signs (indicating that it is now a variable), and then click the variable.

  6. Specify the details of the variable, such as name, display name, and type.

  7. From the Type drop-down list, select File. Click Save.

    Declaring the variable as a “File” type allows you to upload files to NetScaler MAS.

    localized image

  8. Click Next and select the NetScaler instances to which to copy the files.

  9. On the Specify Variable Values tab, select Common Variables Values for all Instances section, select the file from the local storage on your system, click Upload to upload the file to NetScaler MAS, and click Next.

    localized image

  10. On the Job Preview tab, you can evaluate and verify the commands to be run on each instance or instance group.

  11. On the Execute tab, you can execute the job now or schedule it to be executed at a later time. You can also choose what action NetScaler MAS should take if the command fails. You can also create an Email notification to receive notification about the success or failure of the job, and other details. Click Finish.

  12. You can see the job details by navigating to NetworksConfiguration Jobs, and selecting the job that you just configured.  Click Details, and then click Variable Details to list the variables added to your job.

    localized image

How to Use SCP (put) Command in Configuration Jobs

In this article