Skip to content

Commit

Permalink
N9kv docs refresh (#2227)
Browse files Browse the repository at this point in the history
* Update vr-n9kv.md

* refactor

---------

Co-authored-by: Rohit Saluja <rohsaluj@cisco.com>
  • Loading branch information
hellt and Rohit Saluja authored Oct 10, 2024
1 parent 3dea806 commit 81a6474
Showing 1 changed file with 67 additions and 32 deletions.
99 changes: 67 additions & 32 deletions docs/manual/kinds/vr-n9kv.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,77 @@
search:
boost: 4
kind_code_name: cisco_n9kv
kind_display_name: Cisco Nexus9000v
kind_display_name: Cisco Nexus 9000v
---
# Cisco Nexus 9000v
# [[[ kind_display_name ]]]

Cisco Nexus9000v virtualized router is identified with `[[[ kind_code_name ]]]` kind in the [topology file](../topo-def-file.md). It is built using [vrnetlab](../vrnetlab.md) project and essentially is a Qemu VM packaged in a docker container format.

Cisco Nexus 9000v nodes launched with containerlab comes up pre-provisioned with SSH, SNMP, NETCONF, NXAPI and gRPC services enabled.

## Managing Cisco Nexus 9000v nodes

!!!note
Containers with Nexus 9000v inside will take ~8-10min to fully boot.
You can monitor the progress with `docker logs -f <container-name>`.

Cisco Nexus 9000v node launched with containerlab can be managed via the following interfaces:

=== "bash"
to connect to a `bash` shell of a running Cisco Nexus 9000v container:
```bash
docker exec -it <container-name/id> bash
```
=== "CLI"
to connect to the Nexus 9000v CLI
```bash
ssh admin@<container-name/id>
```
=== "NETCONF"
NETCONF server is running over port 830
```bash
ssh admin@<container-name> -p 830 -s netconf
```
=== "gRPC"
gRPC server is running over port 50051

!!!info
Default user credentials: `admin:admin`
/// details | N9kv Lite
If you have a Nexus 9000v Lightweight variant, you can use the same `[[[ kind_code_name ]]]` to launch it

By default, Nexus 9kv image with require 10GB memory and 4 CPU. However `n9kv-lite` VM requires less resources, so you would want to tune the defaults down.

Following is sample for setting up lower memory and CPU for the `n9kv-lite`:

```yaml
topology:
nodes:
node:
kind: [[[ kind_code_name ]]]
env:
QEMU_MEMORY: 6144 # N9kv-lite requires minimum 6GB memory
QEMU_SMP: 2 # N9kv-lite requires minimum 2 CPUs
```
Please refer to ['tuning qemu parameters'](../vrnetlab.md#tuning-qemu-parameters) section for more details.
///
## Managing [[[ kind_display_name ]]] nodes
/// note
Containers with [[[ kind_display_name ]]] inside will take ~5min to fully boot.
You can monitor the progress with `docker logs -f <container-name>`.
///

[[[ kind_display_name ]]] node launched with containerlab can be managed via the following interfaces:

/// tab | bash
to connect to a `bash` shell of a running [[[ kind_display_name ]]] container:

```bash
docker exec -it <container-name/id> bash
```

///

/// tab | CLI
to connect to the [[[ kind_display_name ]]] CLI

```bash
ssh admin@<container-name/id>
```

///

/// tab | NETCONF
NETCONF server is running over port 830

```bash
ssh admin@<container-name> -p 830 -s netconf
```

///

/// tab | gRPC
gRPC server is running over port 50051
///

## Credentials

Default user credentials: `admin:admin`

## Interface naming

Expand Down Expand Up @@ -69,7 +104,7 @@ Data interfaces `Ethernet1/1+` need to be configured with IP addressing manually

### Node configuration

Cisco Nexus 9000v nodes come up with a basic configuration where only `admin` user and management interfaces such as NETCONF, NXAPI and GRPC provisioned.
[[[ kind_display_name ]]] nodes come up with a basic configuration where only `admin` user and management interfaces such as NETCONF, NXAPI and GRPC provisioned.

#### Startup configuration

Expand All @@ -79,7 +114,7 @@ It is possible to make n9kv nodes boot up with a user-defined startup-config ins
topology:
nodes:
node:
kind: cisco_n9kv
kind: [[[ kind_code_name ]]]
startup-config: myconfig.txt
```

Expand Down

0 comments on commit 81a6474

Please sign in to comment.