How to Set Up an Alternate Management Interface on MS Devices

Step 1 – Enable AMI for network and associate management services 

1. Go to Network-wide > General. 

2. Locate the configuration options. Find them under the Alternate Management Interface section if the network type is Switch, or under Switch Alternate Management Interface if the network type is Combined. 
   
   

3. Specify the alternate management VLAN. 

4. Choose a combination of services from RADIUS, SNMP, and Syslog to which the Alternate Management Interface configuration applies. 

Step 2 – Configure the AMI IP addresses on switches

Once you enable the Alternate Management Interface, the AMI VLAN number populates as the ALT MGMT VLAN on all switches in the network that support AMI. 

1. Refer to the Switch details page for each switch. 

2. Assign the Alternate Management Interface IP statically per switch. 

The subnet of the AMI (the subnet mask for the AMI IP address) derives from the Layer-3 interface for the AMI VLAN, if one is configured on the switch. Without a Layer-3 interface for the AMI VLAN, each switch treats its AMI as a /32 network address. 

Step 3 – Configure switches with routes toward management servers

The switch relies on its routing table entries to determine the IP address of the next-hop device for exporting traffic for protocols mapped to AMI. 

1. Configure the required routes statically or through a dynamic routing protocol. 

2. Refer to Switch > Routing & DHCP on the Dashboard to set the routes. 

For details on routing configurations and their dependencies in MS switches, refer to the MS Layer 3 Switching and Routing document. 

GET Alternate Management Interface Configuration

The GET /networks/{networkId}/switch/alternateManagementInterface request is used to obtain the current Alternate Management Interface configuration of a Dashboard Network and on the switches in it. Some examples of response to these requests are as follows.

For details of the API request, check the API documentation.

Example response from Network Templates

Successful HTTP response code: 200

{ 
  "enabled": true,
  "vlanId": 100,
  "protocol": [
    "snmp",
    "radius",
    "syslog"
  ]
}

Example response from Networks when AMI is enabled

Successful HTTP response code: 200

{ 
  "enabled": true,
  "vlanId": 100,
  "protocols": ["radius","snmp","syslog"],
  "switches": [
    {
      "serial": "Q2AB-CDEF-GHIJ",
      "alternateManagementIp": "192.168.128.100"
    },
    {
      "serial": "Q2AB-CDEF-KLMN",
      "alternateManagementIp": "192.168.128.200"
    },
    .....
  ]
}

Example response from Networks when AMI is disabled

Successful HTTP response code: 200

{ 
  "enabled": false,
}

PUT Alternate Management Interface Configuration

Use the PUT /networks/{networkId}/switch/alternateManagementInterface request to configure AMI on a network. The following table provides some example configurations and their corresponding responses.

For details of the API request, check the API documentation.

PUT /networks/L_12345/switch/alternateManagementInterface

{
  "enabled": true,
  "vlanId": 100,
  "protocols": ["syslog"]
}

Successful HTTP response code: 200

{ 
  "enabled": true,
  "vlanId": 100,
  "protocols": ["syslog"],
  "switches": []

PUT /networks/L_12345/switch/alternateManagementInterface

{
  "switches": [
    {
      "serial": "Q2AB-CDEF-GHIJ",
      "alternateManagementIp": "192.168.128.100"
    },
    {
      "serial": "Q2AB-CDEF-KLMN",
      "alternateManagementIp": "192.168.128.200"
    }
  ]
}

Successful HTTP response code: 200

{ 
  "enabled": true,
  "vlanId": 100,
  "protocols": ["syslog"],
  "switches": [
    {
      "serial": "Q2AB-CDEF-GHIJ",
      "alternateManagementIp": "192.168.128.100",
    },
    {
      "serial": "Q2AB-CDEF-KLMN",
      "alternateManagementIp": "192.168.128.200"
    }
  ]
}

PUT /networks/L_12345/switch/alternateManagementInterface

{
  "enabled": true,
  "vlanId": 100,
  "protocols": ["syslog"],
  "switches": [
    {
      "serial": "Q2AB-CDEF-GHIJ",
      "alternateManagementIp": "192.168.128.100"
    }
  ]
}

Successful HTTP response code: 200

{ 
  "enabled": true,
  "vlanId": 100,
  "protocols": ["syslog"],
  "switches": [
    {
      "serial": "Q2AB-CDEF-GHIJ",
      "alternateManagementIp": "192.168.128.100"
    }
  ]
}

PUT /networks/L_12345/switch/alternateManagementInterface

{
  "enabled": false
}

Successful HTTP response code: 200

{ 
  "enabled": false
}