Commissioning a Controller

This procedure shows you how to use the APIC REST API to replace a controller in an APIC cluster. The related GUI procedure, Commissioning a Controller, is available in the Cluster Management chapter of the Cisco APIC Getting Started Guide. This procedure assumes that you are replacing an active APIC. For a standby APIC, see the note at the end of the procedure.

Note For a physical APIC, configuring the CIMC is optional. If you do not want to configure the CIMC, you must use the console to connect to the APIC and enter the following information:

Out-of-band management configuration ...
Enter the IP Address [192.168.10.1/24]:
Enter the IP Address of default gateway [192.168.10.254]:

Procedure

Post with information that is similar to the following:

URL: /api/workflows/v1/controller/commission
Method: POST

For Physical APIC Layer 2 (directly connected to the ACI fabric), using CIMC:

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "physical",
        "serialNumber": "<to be filed by using verify api>",
        "nodeId": "<node_id>",
        "podId": 1,
        "cimc": {
            "address4": "<cimc_address>",
            "username": "admin",
            "password": "<password>"
        }
    }
}

For Physical APIC Layer 2 (directly connected to the ACI fabric), using out-of-band management:

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "physical",
        "serialNumber": "<to be filed by using verify api>",
        "nodeId": "<node_id>",
        "podId": 1,
        "oobNetwork": {
            "address4": "<ip_address>/<subnet_mask>",
            "gateway4": "<gateway_address>",
            "enableIPv4": true
        }
    }
}

For Physical APIC Layer 3 (remotely attached to the ACI fabric), using CIMC:

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "physical",
        "serialNumber": "<to be filed by using verify api>",
        "nodeId": "<node_id>",
        "cimc": {
            "address4": "<ip_address>",
            "username": "admin",
            "password": "<password>"
        },
        "infraNetwork": {
            "address4": "<ip_address>",
            "gateway4": "<gateway_address>",
            "vlan": 0,
            "enableIPv4": true
        }
    }
}

For Physical APIC Layer 3 (remotely attached to the ACI fabric), using out-of-band management:

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "physical",
        "serialNumber": "<to be filed by using verify api>",
        "nodeId": "<node_id>",
        "oobNetwork": {
            "address4": "<ip_address>/<subnet_mask>",
            "gateway4": "<gateway_address>",
            "enableIPv4": true
        },
        "infraNetwork": {
            "address4": "<ip_address>",
            "gateway4": "<gateway_address>",
            "vlan": 0,
            "enableIPv4": true
        }
    }
}

For Virtual APIC on ESXi Layer 2 (directly connected to the ACI fabric):

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "virtual",
        "serialNumber": "<To be filled using verify/platform API>",
        "nodeId": "<node_id>",
        "podId": 1,
        "oobNetwork": {
            "address4": "<ip_address>/<subnet_mask>",
            "gateway4": "<gateway_address>",
            "enableIPv4": true
        }
    }
}

For Virtual APIC on ESXi Layer 3 (remotely attached to the ACI fabric):

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "virtual",
        "serialNumber": "<To be filled using verify/platform API>",
        "nodeId": "<node_id>",
        "infraNetwork": {
            "address4": "<ip_address>",
            "gateway4": "<gateway_address>",
            "vlan": 104,
            "enableIPv4": true
        },
        "oobNetwork": {
            "address4": "<ip_address>/<subnet_mask>",
            "gateway4": "<gateway_address>",
            "enableIPv4": true
        }
    }
}

For Virtual APIC on AWS:

{
    "adminPassword": "<password>",
    "nodes": {
        "nodeName": "<node_name>",
        "controllerType": "virtual",
        "nodeId": "<node_id>",
        "oobNetwork": {
            "address4": "<ip_address>/<subnet_mask>",
            "mode": "auto",
            "enableIPv4": true
        },
        "serialNumber": "<to be filed by using verify api>"
    }
}

Note

For a standby APIC, add the following line in the nodes details section:

"standby": true,