https://github.com/tes3awy/register-fabric-nodes
Register Nodes to the ACI Fabric
https://github.com/tes3awy/register-fabric-nodes
apic cisco-aci cobra datacenter datacenter-automation fabric-api network-automation python requests rest-api
Last synced: 6 days ago
JSON representation
Register Nodes to the ACI Fabric
- Host: GitHub
- URL: https://github.com/tes3awy/register-fabric-nodes
- Owner: Tes3awy
- License: bsd-3-clause
- Created: 2022-06-04T22:18:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-23T06:17:11.000Z (about 3 years ago)
- Last Synced: 2025-02-28T20:45:51.141Z (over 1 year ago)
- Topics: apic, cisco-aci, cobra, datacenter, datacenter-automation, fabric-api, network-automation, python, requests, rest-api
- Language: Python
- Homepage: https://developer.cisco.com/codeexchange/github/repo/Tes3awy/register-fabric-nodes
- Size: 273 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://developer.cisco.com/codeexchange/github/repo/Tes3awy/register-fabric-nodes)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
# Register Nodes to ACI Fabric
> When you run the application, the system determines if the node exists and, if not, adds it. If the node exists, the system registers it.
> The application uses the `APIC-Challenge token` for a stronger API session security. To learn more about the challenge token, see [Requiring a Challenge Token for an API Session](https://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/2-x/rest_cfg/2_1_x/b_Cisco_APIC_REST_API_Configuration_Guide/b_Cisco_APIC_REST_API_Configuration_Guide_chapter_01.html#ariaid-title33).
## Table of Contents
1. [Directory Structure](#directory-structure)
2. [Overview](#overview)
3. [Fabric Node Discovery Statuses](#fabric-node-discovery-statuses)
4. [Installation](#installation)
5. [Register Fabric Nodes](#register-fabric-nodes)
6. [Bonus (Cobra SDK)](#bonus)
## Directory Structure
The directory contains the following files:
```
│ main.py
│ apic.py
│ nodes.py
│ apic_cobra.py
│ Fabric-Nodes.xlsx
| requirements.txt
│ README.md
│ LICENSE
│ .gitignore
├───assets
│ apic_nodes.jpg
│ registered_nodes.jpg
└───
```
1. `apic.py` module contains the APIC functions to connect and have access to the APIC Controller.
2. `nodes.py` module contains the functions to read nodes to be registered and register those nodes.
3. `main.py` module contains the main function to run the application.
4. `Fabric-Nodes.xlsx` is an MS Excel spreadsheet with four nodes to be registered _(All Columns are validated using [Excel data validation](https://support.microsoft.com/en-us/office/apply-data-validation-to-cells-29fecbcc-d1b9-42c1-9d76-eff3ce5f7249) feature to restrict duplicate or invalid data and to show an error alert even before registering the nodes)_.
5. For `apic_cobra.py` module, check [Bonus](#bonus) section.
## Overview
After a switch/node is registered with the APIC, the switch is a part of the APIC-managed fabric inventory. With the
ACI fabric, the APIC is the single point of provisioning, management, and monitoring for switches in the infrastructure.
Switches in the `Nodes Pending Registration` tab table can have the following conditions:
- A newly discovered but unregistered node has a node ID of 0 and has no assigned IP address.
- A manually entered (in APIC) but unregistered switch has an original status of `Undiscovered` until it is physically connected to the network. Once connected, the status changes to `Discovered`.
**Note:** After the node ID is assigned, it cannot be updated/edited.
## Fabric Node Discovery Statuses
| Status | Description |
| ------------ | ------------------------------------------------------- |
| Unknown | Node is discovered but no Node ID policy is configured. |
| Undiscovered | Node ID configured but is not yet discovered. |
| Discovering | Node is discovered but IP is not yet assigned. |
| Unsupported | Node is not a supported model. |
| Disabled | Node has been decommissioned. |
| Inactive | No IP connectivity. |
| Active | Node is active. |
## Installation
### Option A
1. Download the repo from GitHub using `Code` button.
2. Unzip the repo.
3. Create a Python virtual environment and activate it.
4. Install requirements.
```powershell
register-fabric-nodes-main> python -m venv .venv --upgrade-deps
register-fabric-nodes-main> .\.venv\Scripts\Activate.ps1
register-fabric-nodes-main> python -m pip install wheel
register-fabric-nodes-main> python -m pip install -r requirements.txt
```
### Option B
1. Clone the repo from GitHub.
2. Create a Python virtual environment and activate it.
3. Install requirements.
```bash
$ git clone https://github.com/Tes3awy/register-fabric-nodes.git
$ cd register-fabric-nodes
$ python3 -m venv .venv --upgrade-deps
$ source .venv/bin/activate
$ python3 -m pip install wheel
$ python3 -m pip install -r requirements.txt
```
## Register Fabric Nodes
> An Excel file is already attached in the repo and is prepopulated with two leafs and two spines from [Getting Started with Cisco ACI 5.2 v1](https://dcloud2-lon.cisco.com/content/demo/505213?returnPathTitleKey=content-view) from Cisco dCloud.
> **For non Cisco partners, you can use the application with the [ACI Simulator 5.2](https://devnetsandbox.cisco.com/RM/Diagram/Index/740f912b-e9c8-4c7b-a1d7-691649dfa0dd) from Cisco DevNet Sandbox. (Requires reservation)**
Add your ACI fabric nodes to `Fabric-Nodes.xlsx`.
In `Node Type` column (Column A), you can select only one of the following _four_ valid node types:
1. `unspecified`
2. `tier-2-leaf`
3. `remote-wan-leaf`
4. `virtual`
> If you don't know which value to select from the `Node Type` column, choose `unspecified`.
In `Node Role` column (Column B), you can select only one of the following _three_ valid node roles:
1. `spine`
2. `leaf`
3. `unspecified`
After filling out all columns in `Fabric-Nodes.xlsx`, double check your entries, save the Excel file, and exit MS Excel.
Finally, run the application.
**Windows**
```powershell
> py main.py
# or
> py -m main
```
**Nix or macOS**
```bash
$ python3 main.py
# or
$ python3 -m main
```
You will be prompted to enter Excel file, APIC URL, username, and password.
Example:
```bash
Nodes Excel file: Fabric-Nodes.xlsx
APIC IP Address: sandboxapicdc.cisco.com
Username: admin
Password:
```
> **Note:** After a successful run, the node is removed from the `Nodes Pending Registration` tab table to `Registered Nodes` tab table and you cannot by any means update/edit neither the `node type` nor the `node id`.
---
## Bonus
If you have downloaded and installed the Cobra SDK _(i.e., `acicobra` and `acimodel` wheel files)_, you can run the application using `apic_cobra.py`. It's faster than the regular application (Around 1.8x faster).
```bash
$ python apic_cobra.py
# or
$ python -m apic_cobra
```