Adding or editing a remote file server


This topic provides instructions on adding and editing remote file servers.

To understand how remote file servers are used to manage the OS images that are stored outside the TrueSight Network Automation database, see Managing-remote-file-servers.

Use the following procedures to add attributes and modify the attributes of a previously defined remote file server or edit the attributes of multiple remote file servers simultaneously.

Adding or editing a single remote file server

On Admin > Network Admin > Remote File Servers page, do the following:

  1. Click Add to create a remote file server, or click Edit to modify an existing remote file server.
  2. Add or edit the information in the following fields:

    Field Name

    Description

    Name

    Specify a unique name for the remote file server.

    Address

    Specify the host name or IP address of the remote file server, as it is known to the devices that will access it.

    Read-Only File System

    (Optional) Indicates whether files can be written to the server. When unchecked, you will not be able to make OS image snapshots to this remote file server, but will be able to read image files for OS image deploy actions.

    TFTP Transfer Enabled

    (Optional) Indicates whether the remote file server has a TFTP server running on it, thus allowing devices to use TFTP to send files to and receive files from this remote file server.

    FTP Transfer Enabled

    (Optional) Indicates whether the remote file server has an FTP server running on it.

    FTP Transfer Account Username

    (Required when FTP is enabled) The username to be used when making an FTP connection from a device to this server.

    FTP Transfer Account Password

    (Required when FTP is enabled) The password to be used when making an FTP connection from a device to this server.

    Confirm FTP Transfer Account Password

    (Required when FTP is enabled) Re-enter the FTP password.

    FTP Transfer Home Directory

    (Optional) FTP user's home directory where files land when device does an FTP put operation during an OS image snapshot action and where files are expected to be found when device does an FTP get operation during an OS image deploy action.

    FTP User Restricted to Home Directory

    (Optional) Specify whether or not the FTP server that is running with this remote file server is configured to restrict users to the specific home or root directory. This flag can be used in the adapter XML code. When enabled, the ftpRestrictedPathAccess property will exist. When disabled, the property will not exist.

    For example, IIS FTP can restrict users to accessing files within a user-defined root directory such as C:\inetpub\ftproot, or vsftpd, whose chroot_local_user setting can restrict users to accessing files within their home directories.

    This option controls whether or not certain path-aware devices (for example, Cisco Nexus and Juniper WX) include a full path in the FTP copy commands.

    If the FTP server is unrestricted: A full path is included to ensure the file lands where the remote file server expects to find it.

    If the FTP server is restricted: No full path appears in FTP commands (because files are in the relative / or root directory as restricted by the FTP server).

    SCP Transfer Enabled

    (Optional) Indicates whether the remote file server has an SCP server running on it.

    SCP Transfer Account Username

    (Required when SCP is enabled) The username to be used when making an SCP connection from a device to this server.

    SCP Transfer Account Password

    (Required when SCP is enabled) The password to be used when making an SCP connection from a device to this server.

    Confirm SCP Transfer Account Password

    (Required when SCP is enabled) Re-enter the SCP password.

  3. Click Save.

Editing multiple remote file servers

On Admin > Network Admin > Remote File Servers page, do the following:

  1. Select multiple remote file servers by using the check box to the left of each remote file server name.
  2. Click the Edit menu option above the list of remote file server names. 
  3. On the Edit Multiple Remote File Servers page, edit the necessary fields.
  4. Click Save.
    The Remote File Server Edit Results window confirms whether or not the remote file servers were edited successfully. The Failed section shows the error code and error message for the failure if any of the selected servers could not be edited. The Succeeded section confirms that the servers were edited successfully. When you filter items in this window by a particular string, items that contain the string are also displayed along with the items having the exact string. If you use asterisk (*) in the search string, it is considered as an exact character to be searched for, not as a wildcard character.
  5. Click OK.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Network Automation 24.3