Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Software Upgrades

 

Software Upgrade RPC Functions

The ACX6160 uses the following RPC functions for software upgrades:

  • Pending software container — specifies the software version.

    .

  • Software stage RPC — stages the specified software package into the in-active software bank. This is done to prepare for software activation when the in-active bank is activated and for the new software package to take effect.

  • Software activate RPC — activates the software previously staged to the in-active bank by switching the role of the software banks and reboots the device.

  • Software cancel validation timer RPC — cancels the validation timer. The input parameter accept determines whether the load is committed or if the device reverts back to the previous load (cancel-validation-timer).

  • Software stage notification — returns a success or fail notification.

  • Software activate notification — returns the following notifications:

    • Activate — software image has been activated. This is sent upon successful completion of the sw-activate request.

    • Commit — software load has been committed. This is sent after a cancel-validation-timer request has been sent with accept = true.

    • Cancel — software load has been cancelled. This is sent after a cancel-validation-timer request has been sent with accept = false or expiration of the cancel-validation-timer.

Manifest Files

Per the Open ROADM MSA, the ACX6160 uses manifest files to describe how the ACX6160 performs a software download, database backup, and database restore operations. This allows the controller to adapt to variations in how devices handle these operations. For each operation the manifest file provides a basic set of attributes and then an instruction set that describes the sequence of RPC requests required to perform the operation.

This section describes the various manifest files used for the ACX6160.

The columns in Table 1, Table 2, Table 3, Table 4, Table 5Table 6are 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.

Open ROADM Pending Software YANG Model Support

Table 1 describes ACX6160 compliance with the content of the Open ROADM RPC pending software YANG model..

Table 1: Open ROADM Pending Software YANG Model Support

YANG Node

Access

Supported

Supported Values

Pending-software

ro

yes

container

- sw-version

ro

yes

Package version in this bank

- sw-validation-timer

ro

yes

String: value of validation timer hh-mm-ss

- activation-date-time

ro

yes

date-and-time: Activation date and time

Open ROADM Software Stage YANG Model Support

The software stage RPC function stages (installs) the specified software package into the in-active software bank. This is done to prepare for software activation when the in-active bank is activated and for the new software package to take effect.

The software package is validated prior to writing to the software bank to avoid installation of corrupted software into the in-active bank. If this operation fails an error is returned and no change is made to the contents of the in-active software bank or the device state.

Table 2 describes ACX6160 compliance with the content of the Open ROADM RPC software stage YANG model.

Table 2: Open ROADM Software Stage YANG Model Support

YANG Node

Access

Supported

Supported Values

Software-stage

x

yes

Stages software package into the in-active software bank

- input

w

yes

-- filename

w

yes

String: name of package file to be staged.

- output

ro

yes

-- status

ro

yes

Returns: Successful, Failed

-- status-message

ro

yes

String: provides more detail on status

Open ROADM Software Activate YANG Model Support

This RPC activates the software previously staged to the in-active bank by switching the role of the software banks and reboots the device. The device comes up with the banks switched so that the software from the previously in-active bank takes effect.

If this operation fails an error is returned and the device is not be rebooted and no change is made to the ACX6160 device state.

describes ACX6160 compliance with the content of the Open ROADM RPC software activate YANG model.

Table 3: Open ROADM Software Activate YANG Model Support

YANG Node

Access

Supported

Supported Values

activate

x

yes

Activates software previously staged to the in-active bank.

- input

w

yes

-- version

w

yes

String: version of the software to be activated

-- validationTimer

w

yes

String: specifies time hh-mm-ss the user has to validate the software and cancel this timer.

- output

ro

yes

-- status

ro

yes

Returns: Successful, Failed

-- status-message

ro

yes

String: provides more detail on status

Open ROADM Software Cancel-Validation-Timer YANG Model Support

Table 4 describes the software cancel-validation-timer RPC YANG Model. This RPC cancels the validation timer on the ACX6160. The input parameter: accept, determines if the software load is committed or if the device reverts back to the previous load.

If this operation fails, you can try again, the ACX6160 software does not prevent subsequent attempts. Failure to complete this operation results in the cancel-validation-timer expiry at which time the ACX6160 reverts back to the previous software load.

Table 4 describes ACX6160 compliance with the content of the Open ROADM RPC software cancel-validation-timer YANG model.

Table 4: Open ROADM Software Cancel-Validation-Timer YANG Model Support

YANG Node

Access

Supported

Supported Values

cancel-validation-timer

x

yes

Cancels the validation timer

- input

w

yes

-- accept

w

yes

True - to accept the software load

False - to reject the software load, this reverts the software back to the previously installed version by switching the roles of the software banks and rebooting the device.

- output

ro

yes

-- status

ro

yes

Returns: Successful, Failed

-- status-message

ro

yes

String: provides more detail on status

Open ROADM Software Stage Notification YANG Model Support

Table 5 describes ACX6160 compliance with the content of the Open ROADM RPC software stage notification YANG model. This RPC function returns a success or fail notification (sw-stage notification).

Table 5: Open ROADM Software Stage Notification YANG Model Support

YANG Node

Access

Supported

Supported Values

sw-stage-notification

n

yes

Notification

- status

ro

yes

Returns: Successful, Failed

- status-message

ro

yes

String: provides more detail on status

Open ROADM Software Activate Notification YANG Model Support

Table 6 describes ACX6160 compliance with the content of the Open ROADM RPC software activate notification YANG model.

Table 6: Open ROADM Software Activate Notification YANG Model Support

YANG node

Access

Support

Description

sw-stage-notification

n

yes

Notification

sw-active-notification-type

ro

yes

Returns:

  • activate – Notification that the software image has been activated. This is sent upon successful completion of the sw-activate request.

  • commit – Notification that software load has been committed. This is sent after a cancel-validation-timer request has been sent with accept = true.

  • cancel – Notification that software load has been cancelled. This is sent after a cancel-validation-timer request has been sent with accept = false or expiration of the cancel-validation-timer.

- status

ro

yes

Returns: Successful, Failed, or In-progress

- status-message

ro

yes

String: provides more detail on status