Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

File System Operations

 

This topic describes the device file management YANG model supported by the ACX6160.

Device File Management

The Open ROADM device model specifies a flat file structure on the device with no subdirectories that support simple file operations with the controller. When an operation generates multiple files, they are placed in a tarball and zipped in a single file which is stored locally in the flat file structure on the ACX6160. Examples of files that may reside in this flat file structure include debug, syslogs, database, software images, and so forth.

For Open ROADM a single directory or file system is created for the purpose of providing this flat directory structure. The controller accesses the ACX6160 flat directory structure through RPC calls. The ACX6160 supports the following RPC calls:

  • transfer — provides file upload and download using an asynchronous SFTP from or to the ACX6160 respectively

  • show-file — retrieves list of files from the ACX6160

  • delete-file — deletes the specified file from the ACX6160

SFTP Client

An asynchronous SFTP client is included that allows you to initiate long file transfers while allowing you to continue management of the device within the same session.

Open ROADM RPC File Transfer YANG Model Support

The columns in Table 1, Table 2, Table 3 and Table 4 are defined as:

  • YANG node — The node from the Open ROADM YANG model.

  • Access — Access properties of the node. Can be:

    • rw — read/write

    • ro — read-only

    • x — RPC function

    • n — notification

  • Supported — Indicates ACX6160 support for the node.

    • Yes — ACX6160 supports the node

    • No — ACX6160 does not support the node

    • N/A — Node is not applicable to transponder device

  • Supported Values — Describes the range of supported values on ACX6160.

Table 1 describes ACX6160 compliance with the content of the Open ROADM RPC file transfer YANG model.

Table 1: Open ROADM RPC File Transfer YANG Model Support

YANG Node

Access

Supported

Supported Values

transfer

x

yes

Action

- input

w

yes

action

w

yes

Enumeration: upload, download

-- local-file-path

w

yes

String: local file to be source of upload or destination of download.

Description: Local file path. Ex: /var/shared/example.txt

-- remote-file-path

w

yes

String: remote file to be destination of upload or source of download.

- output

ro

yes

-- status

ro

yes

Returns: Successful, Failed

-- status-message

ro

yes

String: provides more detail on status

Open ROADM Show Files YANG Model Support

Table 2 describes ACX6160 compliance with the content of the Open ROADM RPC show-files YANG model.

Table 2: Open ROADM Show Files YANG Model Support

YANG Node

Access

Supported

Supported Values

show-file

x

yes

Action

- input

w

yes

-- filename

w

yes

String: files to be listed (* is allowed wild-card)

-- remote-file-path

w

yes

String: remote file to be destination of upload or source of download.

- output

ro

yes

-- status

ro

yes

Successful, Failed

-- status-message

ro

yes

String: provides more detail on status

Open ROADM Delete Files YANG Model Support

Table 3 describes ACX6160 compliance with the content of the Open ROADM RPC delete-file YANG model.

Table 3: Open ROADM Delete Files YANG Model Support

YANG Node

Access

Supported

Supported Values

delete-file

x

yes

Action

- input

w

yes

-- filename

w

yes

String: local file to be deleted (* wild-card is not allowed).

- output

ro

yes

-- status

ro

yes

Successful, Failed

-- status-message

ro

yes

String: provides more detail on status

Open ROADM File Operation Notifications YANG Model Support

Table 4 describes ACX6160 compliance with the content of the Open ROADM RPC file operation notification YANG model.

Table 4: Open ROADM File Operation Notifications YANG Model Support

YANG Node

Access

Supported

Supported Values

transfer-notification

n

yes

Notification

- local-file-path

ro

yes

String: local file to be deleted.

- status

ro

yes

Successful, Failed, In-progress

- status-message

ro

yes

String: provides more detail on status

- progress

ro

yes

-- bytes-transferred

ro

yes

Count of bytes transferred

-- percentage-complete

ro

yes

Percent complete, 100% is done