Device maintenance mode

Article
05/21/2024

Maintenance mode allows isolating a network fabric device from the network to perform various maintenance tasks. These tasks include troubleshooting, log collection, diagnostics, and executing supported commands via method D or method A.

When a user puts a device in maintenance mode, all processes running on the device are gracefully shut down, and all physical ports are disabled. During maintenance mode, traffic is redirected to the paired device. For example, if TOR1 undergoes maintenance, its paired device, TOR2, carries all traffic with minimal loss during the switch. No user intervention is required for the traffic switchover.

Key considerations

Only one device at a time can be in maintenance mode.

Fabric upgrades are restricted when device is in maintenance mode.

How to put a device into maintenance mode

This guide will walk you through the process of putting a device into maintenance mode and then returning it to normal operation.

Parameters required for maintenance mode

Before you begin, you need to understand the parameters required for managing the maintenance state of a device. Here is a quick reference table:

Parameter	Description	Example
`--resource-group`	Resource group name	resource-group-name
`--resource-name`	Name of the network device	AggrRack-CE1
`--state`	State of the device	UnderMaintenance or Enabled

Putting a device into maintenance mode

To place a device into maintenance mode, follow these steps:

Install the latest version of the az CLI extension
Open your command-line interface (CLI).
Use the az networkfabric device update-admin-state command with the appropriate parameters.

Command syntax

az networkfabric device update-admin-state --resource-group "resource-group-name" --resource-name "exampledevicename" --state UnderMaintenance

Example command

az networkfabric device update-admin-state --resource-group "resource-group-name" --resource-name "AggrRack-CE1" --state UnderMaintenance

Expected output

After executing the command, you can verify the state of the device using the az networkfabric device show command:

az networkfabric device show --resource-group "resource-group-name" --resource-name "exampledevicename"

Example output

{
  "administrativeState": "UnderMaintenance",
  "configurationState": "Succeeded",
  "hostName": "HOSTNAME",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource-group-name/providers/Microsoft.ManagedNetworkFabric/networkDevices/exampledevicename",
  "location": "eastus",
  "name": "exampledevicename",
  "networkDeviceRole": "CE",
  "networkDeviceSku": "DefaultSku",
  "networkRackId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource-group-name/providers/Microsoft.ManagedNetworkFabric/networkRacks/nffab100g-6-1-aggrack",
  "provisioningState": "Succeeded",
  "resourceGroup": "resource-group-name",
  "serialNumber": "Arista;DCS-7280CR3K;11.01;XXXXXXXXXXX",
  "systemData": {
    "createdAt": "2024-04-23T18:06:34.7467102Z",
    "createdBy": "cbe7d642-9e0a-475d-b2bf-2cb0a9825e13",
    "createdByType": "Application",
    "lastModifiedAt": "2024-05-14T06:50:32.7391425Z",
    "lastModifiedBy": "cbe7d642-9e0a-475d-b2bf-2cb0a9825e13",
    "lastModifiedByType": "Application"
  },
  "type": "microsoft.managednetworkfabric/networkdevices",
  "version": "3.0.0"
}

Returning a device to normal operation

Once the maintenance activities are complete, you can return the device to its normal operational state.

Command Syntax

az networkfabric device update-admin-state --resource-group "resource-group-name" --resource-name "exampledevicename" --state Enable

Example Command

az networkfabric device update-admin-state --resource-group "resource-group-name" --resource-name "AggrRack-CE1" --state Enable

Expected Output

Verify the state of the device using the az networkfabric device show command:

az networkfabric device show --resource-group "resource-group-name" --resource-name "exampledevicename"

Example Output

{
  "administrativeState": "Enabled",
  "configurationState": "Succeeded",
  "hostName": "HOSTNAME",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource-group-name/providers/Microsoft.ManagedNetworkFabric/networkDevices/exampledevicename",
  "location": "eastus",
  "name": "exampledevicename",
  "networkDeviceRole": "CE",
  "networkDeviceSku": "DefaultSku",
  "networkRackId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resource-group-name/providers/Microsoft.ManagedNetworkFabric/networkRacks/nffab100g-6-1-aggrack",
  "provisioningState": "Succeeded",
  "resourceGroup": "resource-group-name",
  "serialNumber": "Arista;DCS-728XXXX;11.01;XXXXXXXXXXX",
  "systemData": {
    "createdAt": "2024-04-23T18:06:34.7467102Z",
    "createdBy": "cbe7d642-9e0a-475d-b2bf-2cb0a9825e13",
    "createdByType": "Application",
    "lastModifiedAt": "2024-05-14T07:10:50.6839353Z",
    "lastModifiedBy": "cbe7d642-9e0a-475d-b2bf-2cb0a9825e13",
    "lastModifiedByType": "Application"
  },
  "type": "microsoft.managednetworkfabric/networkdevices",
  "version": "3.0.0"
}

By following these steps, you can efficiently manage the maintenance state of your network devices, ensuring minimal disruption to your network operations.

Share via