Creating a maintenance intent

Ensure that:

  • You have created and applied a maintenance label to the participating nodes. The system includes a "Maintenance" key that you can use to identify an object for maintenance. The value that you associate with that key can be whatever you like.
  • If this maintenance intent is for a software update, ensure that the target SR Linux software load is present in the system's software catalog.
  • If you are using an external DHCP server or file server for SR Linux Zero-touch provisioning (ZTP):
    • for software changes, update the ztp_provision.py file with the new software image details
    • for node replacement, update the dhcpd.conf file with the new serial number information
  • If you are performing a software update, ensure that the target node is in a Ready or Version Mismatch state. Attempting the update on a node in any other state results in an error.
  • If you are replacing a node, any state is acceptable but some states of the maintenance intent indicating its progress may be skipped depending on the original node state.

A maintenance intent indicates a type of change and the nodes this change affects.

  1. Click to open the main menu, then select Maintenance Intents.
  2. Click + CREATE A MAINTENANCE INTENT.
  3. Set the basic properties for the maintenance intent.
    Provide a name for the maintenance intent and an optional description. Then, select a region.
  4. Specify whether the maintenance intent is for a software update or a node replacement.
    To create a maintenance intent for:
    • a software update, set the Maintenance Intent Type drop-down list to Software Update, then go to step 5.
    • a node replacement, set the Maintenance Intent Type drop-down list to Replace Node, then go to step 6.
  5. Set the parameters for the software update.
    • In the Software Catalog/Image ID field, select the target SR Linux software load.
    • Update the default settings for the following timers:

      • Traffic Drain Timer: This timer starts when the SR Linux maintenance policy is applied to the node. The system reboots the node after the timer has expired. By default, the timer is set to 1 minute.

      • Convergence Timer: This timer starts when the node has come back up and is in the Ready state. When the timer expires, the SR Linux maintenance policy is removed from the node. By default, the timer is set to 2 minutes.

    • In the Node Label Selector panel, click and select the label corresponding to this maintenance action from the displayed list. You can select only one label as the target for the maintenance action.
    When you are finished, go to step 7.
  6. Set parameters for the node replacement.
    1. In the Node Label Selector panel, click and select the label that corresponds to this maintenance action from the displayed list.
      You can select only one label as the target for the maintenance action.

      The system updates the Nodes List panel to show the node bearing the selected label.

    2. Enter the replacement node's serial number in the New Serial Number field.
  7. Click to save the maintenance intent.
  8. Click GENERATE MAINTENANCE.
  9. Optional: Review the generated configuration code to confirm that it is satisfactory.
    1. Right-click the node that is the target of the maintenance intent and select Inspect Configuration from the pop-up menu.
    2. Review the code and verify that it is satisfactory.
    3. Click at the upper right to close the Configuration Inspector window.
Deploy the maintenance intent.