Creating a maintenance intent

Before you create a new maintenance intent, ensure that:

  • you have created and applied a maintenance label to the participating nodes as described in Labeling objects for maintenance. The system includes a "Maintenance" key that you can use to identify an object for maintenance. The particular value 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 as described in Software and image catalogs.
  • If you are using an external DHCP server or file server for SR Linux Zero-touch provisioning (ZTP):
    • for software changes, update the ztp-config.yml 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.

To create a maintenance intent:

  1. Click to open the main menu.
  2. From the menu, select Maintenance Intents.
  3. Click the + CREATE A MAINTENANCE INTENT button.
  4. Configure basic parameters for the maintenance intent:
    1. Select the Region to which the maintenance intent belongs
    2. Enter a Maintenance Intent Name.
    3. Optionally, enter a Description.
  5. Do one of the following:
    • If you are creating a maintenance intent for a software update, go to step 6.
    • If you are creating a maintenance intent to replace a node, go to step 7.
  6. Enter parameters for the software update:
    1. In the Maintenance Intent Type drop-down, select Software Update.
    2. In the Software Catalog/Image ID field, select the target SR Linux software load.
    3. In the Assign Labels panel, click the icon and select the label corresponding to this maintenance action from the displayed list.
      In the current release, you can select only one label as the target for the maintenance action.
    4. Go to step 9.
  7. Enter parameters for the node replacement:
    1. In the Maintenance Intent Type drop-down, select Replace Node.
    2. In the Assign Labels panel, click the icon and select the label corresponding to this maintenance action from the displayed list.
      In the current release, 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.
  8. Enter the replacement node's serial number in the New Serial Number field.
  9. Click the Save icon ( ) to save the maintenance intent.
  10. Click GENERATE MAINTENANCE.
  11. Optionally, review the generated configuration code to confirm that it is satisfactory by doing the following:
    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. Close the Configuration Inspector by clicking the X at the upper right of the overlay.
You are now ready to deploy the maintenance intent.