Managing Components

About the Component RPM Packages


Note

Beginning with Cisco Nexus NX-OS 7.0(3)I7(1), the NX-OS Programmable Interface Base Component RPM packages (agents, the Cisco native model, the majority of other required models, and infrastructure) are included in the NX-OS image. As a result, nearly all the required software is installed automatically when the image is loaded. This means that there is no need to download and install the bulk of the software from the Cisco Artifactory. The exception is the OpenConfig model, which is required. You must explicitly download the OpenConfig models from the Cisco Artifactory.

However, for Cisco Nexus NX-OS 7.0(3)I6(1) and earlier releases, or for the purpose of upgrading, the following sections describing downloading and installing the packages are required.

NX-OS Programmable Interface Component RPM packages may be downloaded from the Cisco Artifactory. Three types of component RPM packages are needed:

  • NX-OS Programmable Interface Infrastructure Components

  • Common Model Components

  • Agent Components

NX-OS Programmable Interface Infrastructure Components

The NX-OS Programmable Interface Infrastructure comprises two RPM packages:

  • mtx-infra — This RPM is platform-independent.

  • mtx-device-model — This RPM is platform-dependent and must be selected to match the installed NX-OS image at the time of Cisco Artifactory download.

Common Model Components

Common Model component RPMs provides support for Openconfig and IETF defined models. In order to enable support for one or more desired Common Models, the associated Common Model component RPMs must be downloaded and installed. As with the mtx-device-model RPM, Common Model components are also platform-dependent and must be selected to match the installed NX-OS image at the time of Cisco Artifactory download.

Following is the list of supported RPMs:

  • mtx-openconfig-bgp

  • mtx-openconfig-bgp-multiprotocol

  • mtx-openconfig-if-ip

  • mtx-openconfig-interfaces

  • mtx-openconfig-local-routing

  • mtx-openconfig-routing-policy

  • mtx-openconfig-vlan

Agent Components

Three agent packages are available: NETCONF, RESTConf and gRPC. At least one agent must be installed in order to have access to the modeled NX-OS interface.


Note

Beginning with Cisco Nexus NX-OS 7.0(3)I7(3), you can enable the agents using the feature netconf and feature restconf commmands. However, these commands are not included in prior releases, so for releases Cisco Nexus NX-OS 7.0(3)I7(1) to 7.0(3)I7(3), you must enter the bash shell using the instructions in the "Opening the Bash Shell on the Device" section in Preparing For Installation, then run the netconfctl start and restconfctl start commands.

Preparing For Installation

This section contains installation preparation and other useful information for managing NX-OS Programmable Interface components.

Opening the Bash Shell on the Device

RPM installation on the switch is performed in the bash shell. Make sure feature bash is configured on the device. 

Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# feature bash-shell
Switch(config)# end
Switch# run bash sudo su
bash-4.2#

To return to the device CLI prompt from bash, type exit or Ctrl-D .

Verify Device Readiness

You can use the following CLI show commands to confirm the readiness of the device before installation of an RPM.

  • show module — Indicates whether all modules are up. 

    Switch# show module

  • show system redundancy status — Indicates whether the standby device is up and running and in HA mode. If a standby sync in progress, the RPM installation may fail. 

    Switch# show system redundancy status

If the line cards have failed to come up, enter the createrepo /rpms command in the bash shell. 

bash-4.2# createrepo /rpms

Copying Files to the Device

You can use SCP to copy files to the device, using a command in this form.

copy scp://username@source_ip/path_to_agent_rpm bootflash: vrf management

Example:


Switch# copy scp://jdoe@192.0.20.123//myrpms/mtx-infra.1.0.0.r082616.x86_64.rpm bootflash: vrf management

Displaying Installed NX-OS Programmable Interface RPMs

To show all installed NXOS Programmable Interface RPMs, issue the following command on the device: 


bash-4.2# yum list installed | grep mtx

Downloading Components from the Cisco Artifactory

The NX-OS Programmable Interface Component RPMs can be downloaded from the Cisco Artifactory at the following URL:

https://devhub.cisco.com/artifactory/open-nxos-agents

The NX-OS Programmable Interface Component RPMs adhere to the following naming convention:

mtx-name.ma.mi.ma.rYYYYYY.x86_64.rpm

or

mtx-name-XXXX.ma.mi.ma.rYYYYYY.x86_64.rpm

where

  • name — MTX component name (such as infra, device-model, openconfig-interface, netconf, etc)

  • ma.mi.ma — RPM Version Number (major.minor.maintenance)

  • XXXX — NX-OS Image ID

  • rYYYYYY — RPM build ID

Select and download the desired NX-OS Programmable Interface Component RPM packages to a local server for installation on the device as described in the following sections.

Installing RPM Packages

Installing the Programmable Interface Infrastructure RPM Packages

Before you begin

  • From the Cisco Artifactory, download the following packages:

    • mtx-infra.ma.mi.ma.rYYYYYY.x86_64.rpm (Infrastructure)

    • mtx-device-XXXX.ma.mi.ma.rYYYYYY.x86_64.rpm RPM (Device Model)

  • Using the CLI commands in Verify Device Readiness, confirm that all line cards in the active and standby devices are up and ready.

Procedure

Step 1

Copy the downloaded RPMs to the device.

Example:


Switch# copy scp://jdoe@192.0.20.123//myrpms/mtx-infra.1.0.0.r082616.x86_64.rpm bootflash: vrf management
Switch# copy scp://jdoe@192.0.20.123//myrpms/mtx-device.1.0.0.r082616.x86_64.rpm bootflash: vrf management
Step 2

From the bash shell, install the MTX Infra RPM.

Example:


bash-4.2# cd /bootflash 
bash-4.2# yum install mtx-infra.1.0.0.r082616.x86_64.rpm
Step 3

From the bash shell, install the MTX Device Model RPM.

Example:


bash-4.2# cd /bootflash 
bash-4.2# yum install mtx-device.1.0.0.r082616.x86_64.rpm
Step 4

From the bash shell, verify the installation.

Example:


bash-4.2# yum list installed | grep mtx

What to do next

Install one or more Common Model RPM Packages.

Installing Common Model RPM Packages

Before you begin

  • Install the Programmable Interface Infrastructure RPM packages.

  • Download the Common Model RPM packages from the Cisco Artifactory.

Procedure

Step 1

Copy the downloaded Common Model RPMs to the device.

Example:


bash-4.2# copy scp://jdoe@192.0.20.123//myrpms/mtx-openconfig_interfaces.1.0.0.r082616.x86_64.rpm bootflash: vrf management
Step 2

From the bash shell, install each Common Model RPM.

Example:


bash-4.2# cd /bootflash 
bash-4.2# yum install mtx-openconfig_interfaces.1.0.0.r082616.x86_64.rpm
Step 3

From the bash shell, verify the installation.

Example:


bash-4.2# yum list installed | grep mtx

What to do next

Install one or more NX-OS Programmable Interface Agent RPM Packages.

Installing Agent RPM Packages

Before you begin

  • Install the Programmable Interface Infrastructure RPM packages.

  • Install one or more Common Model RPM packages.

  • Download the Agent RPM packages from the Cisco Artifactory.

Procedure

Step 1

Copy the downloaded Agent RPMs to the device.

Example:


bash-4.2# copy scp://jdoe@192.0.20.123//myrpms/myrpms/mtx-netconf.1.0.0.r082616.x86_64.rpm bootflash: vrf management
Step 2

From the bash shell, install the Agent RPM.

Example:


bash-4.2# cd /bootflash 
bash-4.2# yum install mtx-netconf.1.0.0.r082616.x86_64.rpm
Step 3

From the bash shell, verify the installation.

Example:


bash-4.2# yum list installed | grep mtx

What to do next

Configure the Agent.