System Setup and Software Installation Guide for Cisco NCS 1010, IOS XR Releases

PDF

Data model software upgrade method

Updated: June 17, 2026

Want to summarize with AI?

Log in

This section provides details about upgrading by using data models for Cisco NCS 1010. Use it to review programmatic configuration and operational data workflows.

Use this reference to review upgrade using data models.

The following information supports upgrade using data models:

  • Data models are a programmatic way of configuring and collecting operational data of a network device. They replace the process of manual configuration and can be used to automate configuration tasks across heterogeneous devices in a network.

Use this task to access install-related data models.

You can use YANG data models to install and upgrade NCS 1010. The data models are packaged with the release image in the

/pkg/yang

directory.

Before you begin

Follow these steps to access install-related data models.

Procedure

1.

Navigate to the directory in the release image where the YANG data models are available.

Example:

RP/0/RP0/CPU0:ios#run
[node_RP0_CPU0:~]$cd /pkg/yang
2.

View the list of install-related data models on NCS 1010.

Example:

node0_RP0_CPU0:/pkg/yang]$ls -ltr *install*
-rw-r--r--.    1    root    root    8646    Jul    2    01:59    Cisco-IOS-XR-install-act.yang
-rw-r--r--.    1    root    root    7267    Jul    2    01:59    Cisco-IOS-XR-install-search-act.yang
-rw-r--r--.    1    root    root    10664   Jul    2    01:59    Cisco-IOS-XR-install-augmented-act.yang
-rw-r--r--.    1    root    root    2511    Jul    2    02:00    Cisco-IOS-XR-um-install-cfg.yang
-rw-r--r--.    1    root    root    2270    Jul    2    02:04    Cisco-IOS-XR-install-cfg.yang
-rw-r--r--.    1    root    root    6222    Jul    2    02:04    Cisco-IOS-XR-install-oper.yang
-rw-r--r--.    1    root    root    14009   Jul    2    02:04    Cisco-IOS-XR-install-augmented-oper.yang

The following table describes the function of the install-related data models:

Date Model

Description

Cisco-IOS-XR-um-install-cfg

Unified data model that contains a collection of YANG definitions for Cisco IOS XR install package configuration, and augments the modules with configuration data.

Cisco-IOS-XR-install-oper

Operational data model to view details that are related to basic package information, active and committed packages, and fixes.

Cisco-IOS-XR-install-cfg

Configuration data model to specify the location of the install source.

Cisco-IOS-XR-install-act

Action model to perform basic install operations and software upgrade.

Cisco-IOS-XR-install-search-act

Action model that contains a collection of YANG definitions for install actions related to searching for package information.

Cisco-IOS-XR-install-augmented-oper

Augmented operational model that displays information aboutpackaging, atomic changes, and history of the install operation on the NCS 1010.

Cisco-IOS-XR-install-augmented-act

Action model to perform flexible install operations, includingcontrolling the exact timing of system reloads and rolling back to a previous commit.

Cisco-IOS-XR-shellutil-copy-act

Action model to copy files on the NCS 1010 from a source location.

You can also access the supported data models to install Cisco IOS XR software from the Github repository.

Manageability agent connections to Cisco NCS 1010

Use a manageability agent like NETCONF or gRPC to connect and communicate with NCS 1010. You can send Remote Procedure Calls (RPC) requests to configure or retrieve operational data from NCS 1010. NCS 1010 processes the request and responds to the request through an RPC response. You use the RPCs to send requests to install the software by populating the relevant parameters of a container and leaf in the data model. For more information about understanding the data model structure and using data models, see the Cisco NCS 1010 Data Models Configuration Guide .

Generate RPC messages to install an IOS XR image

Use this task to generate RPC messages to install IOS XR image​.

This task supports Cisco NCS 1010 setup, deployment, upgrade, or maintenance workflows.

Before you begin

Not all software versions are supported as the target upgrade software version. You must review the supported upgrade and downgrade paths, hardware or software limitations, and bridging SMUs required for the version. For more information about checking the release support between the current and target versions, see Supported upgrade and downgrade releases.

Follow these steps to generate RPC messages to install IOS XR image​.

Procedure

1.

Invoke the install-replace RPC on the Cisco-IOS-XR-install-act.yang data model to upgrade NCS 1010.
2.

Configure the values of the source-type, source, and file parameters.

3.

Send edit-config NETCONF RPC request using the data model to configure the repository. Edit the values in the repositories parameters and send this request to NCS 1010 from the client.
4.

Apply the changes to activate the ISO on NCS 1010 using RPCs by using the install-apply RPC on theCisco-IOS-XR-install-augmented-act.yang datamodel and send the RPC from the client to NCS 1010.

Example:

<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <install-apply xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-install-augmented-act">
   <apply-method>least-impactful</apply-method>
  </install-apply>
</rpc>

View the RPC response received from NCS 1010.

<?xml version="1.0"?>
  <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
   <op-id xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-install-augmented-act">2.1</op-id>
  </rpc-reply>

In the response, NCS 1010 sends an ID indicating that the changes are applied successfully.
5.

Verify that the software upgrade is successful. Use the getRPCon Cisco-IOS-XR-install-oper.yang data model. Edit the install parameter and send an RPC request from the client to NCS 1010.

Example:

<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="101">
  <get>
   <filter>
    <install xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-install-oper">  
     <request/>
    </install>
   </filter>
  </get>
</rpc>

View the RPC response received from NCS 1010.


<?xml version="1.0"?>
  <rpc-reply message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
   <data>
    <install xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-install-oper">
     <request>
      <request>install commit</request>
      <state>success</state>
     <timestamp>2022-06-27 T02:52:07Z</timestamp>
    <operation-id>26</operation-id>
   </request>
  </install>

The state of the install operation in the RPC response indicates that the software and the RPMs are upgraded successfully.

What to do next

Perform preliminary checks to verify that NCS 1010 is upgraded successfully.